/*
 * Copyright (c) 2007-2016 Concurrent, Inc. All Rights Reserved.
 *
 * Project and contact information: http://www.cascading.org/
 *
 * This file is part of the Cascading project.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package cascading.stats;

import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;

import cascading.flow.FlowNode;
import cascading.management.state.ClientState;

/**
 *
 */
public abstract class BaseCachedNodeStats<Config, JobStatus, Counters> extends FlowNodeStats
  {
  protected final Map<String, FlowSliceStats> sliceStatsMap = new LinkedHashMap<>();
  protected CounterCache<Config, JobStatus, Counters> counterCache;

  protected boolean allChildrenFinished;

  /**
   * Constructor BaseHadoopNodeStats creates a new BaseHadoopNodeStats instance.
   *
   * @param flowNode
   * @param clientState
   */
  protected BaseCachedNodeStats( FlowNode flowNode, ClientState clientState )
    {
    super( flowNode, clientState );
    }

  @Override
  public long getLastSuccessfulCounterFetchTime()
    {
    if( counterCache != null )
      return counterCache.getLastSuccessfulFetch();

    return -1;
    }

  public boolean isAllChildrenFinished()
    {
    return allChildrenFinished;
    }

  /**
   * Method getCounterGroups returns all of the Hadoop counter groups.
   *
   * @return the counterGroups (type Collection<String>) of this HadoopStepStats object.
   */
  @Override
  public Collection<String> getCounterGroups()
    {
    return counterCache.getCounterGroups();
    }

  /**
   * Method getCounterGroupsMatching returns all the Hadoop counter groups that match the give regex pattern.
   *
   * @param regex of String
   * @return Collection<String>
   */
  @Override
  public Collection<String> getCounterGroupsMatching( String regex )
    {
    return counterCache.getCounterGroupsMatching( regex );
    }

  /**
   * Method getCountersFor returns the Hadoop counters for the given group.
   *
   * @param group of String
   * @return Collection<String>
   */
  @Override
  public Collection<String> getCountersFor( String group )
    {
    return counterCache.getCountersFor( group );
    }

  /**
   * Method getCounterValue returns the Hadoop counter value for the given counter enum.
   *
   * @param counter of Enum
   * @return long
   */
  @Override
  public long getCounterValue( Enum counter )
    {
    return counterCache.getCounterValue( counter );
    }

  /**
   * Method getCounterValue returns the Hadoop counter value for the given group and counter name.
   *
   * @param group   of String
   * @param counter of String
   * @return long
   */
  @Override
  public long getCounterValue( String group, String counter )
    {
    return counterCache.getCounterValue( group, counter );
    }

  protected synchronized Counters cachedCounters( boolean force )
    {
    return counterCache.cachedCounters( force );
    }

  @Override
  public Collection<FlowSliceStats> getChildren()
    {
    synchronized( sliceStatsMap )
      {
      return Collections.unmodifiableCollection( sliceStatsMap.values() );
      }
    }

  @Override
  public FlowSliceStats getChildWith( String id )
    {
    return sliceStatsMap.get( id );
    }

  @Override
  public final void captureDetail( Type depth )
    {
    boolean finished = isFinished();

    if( finished && hasCapturedFinalDetail() )
      return;

    synchronized( this )
      {
      if( !getType().isChild( depth ) || !isDetailStale() )
        return;

      boolean success = captureChildDetailInternal();

      markDetailCaptured(); // always mark to prevent double calls

      if( success )
        logDebug( "captured remote node statistic details" );

      hasCapturedFinalDetail = finished && success && allChildrenFinished;

      if( allChildrenFinished )
        logInfo( "all {} children are in finished state, have captured final details: {}", sliceStatsMap.size(), hasCapturedFinalDetail() );
      }
    }

  /**
   * Returns true if was able to capture/refresh the internal child stats cache.
   *
   * @return true if successful
   */
  protected abstract boolean captureChildDetailInternal();

  /** Synchronized to prevent state changes mid record, #stop may be called out of band */
  @Override
  public synchronized void recordChildStats()
    {
    try
      {
      cachedCounters( true );
      }
    catch( Exception exception )
      {
      // do nothing
      }

    if( !clientState.isEnabled() )
      return;

    captureDetail( Type.ATTEMPT );

    // FlowSliceStats are not full blown Stats types, but implementation specific
    // so we can't call recordStats/recordChildStats
    try
      {
      // must use the local ID as the stored id, not task id
      for( FlowSliceStats value : sliceStatsMap.values() )
        clientState.record( value.getID(), value );
      }
    catch( Exception exception )
      {
      logError( "unable to record node stats", exception );
      }
    }
  }