InternalHeftSession.ts

// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.

import { Async, InternalError } from '@rushstack/node-core-library';

import { Constants } from '../utilities/Constants';
import { HeftLifecycle } from './HeftLifecycle';
import { HeftPhaseSession } from './HeftPhaseSession';
import { HeftPhase } from './HeftPhase';
import {
  CoreConfigFiles,
  type IHeftConfigurationJson,
  type IHeftConfigurationJsonActionReference
} from '../utilities/CoreConfigFiles';
import type { MetricsCollector } from '../metrics/MetricsCollector';
import type { LoggingManager } from './logging/LoggingManager';
import type { HeftConfiguration } from '../configuration/HeftConfiguration';
import type { HeftPluginDefinitionBase } from '../configuration/HeftPluginDefinition';
import type { HeftTask } from './HeftTask';
import type { HeftParameterManager } from './HeftParameterManager';
import type { IHeftParsedCommandLine } from './HeftTaskSession';

export interface IInternalHeftSessionOptions {
  heftConfiguration: HeftConfiguration;
  loggingManager: LoggingManager;
  metricsCollector: MetricsCollector;

  debug: boolean;
}

function* getAllTasks(phases: Iterable<HeftPhase>): IterableIterator<HeftTask> {
  for (const phase of phases) {
    yield* phase.tasks;
  }
}

export class InternalHeftSession {
  readonly #phaseSessionsByPhase: Map<HeftPhase, HeftPhaseSession> = new Map();
  readonly #heftConfigurationJson: IHeftConfigurationJson;
  #actionReferencesByAlias: ReadonlyMap<string, IHeftConfigurationJsonActionReference> | undefined;
  #lifecycle: HeftLifecycle | undefined;
  #phases: Set<HeftPhase> | undefined;
  #phasesByName: Map<string, HeftPhase> | undefined;
  #parameterManager: HeftParameterManager | undefined;

  public readonly heftConfiguration: HeftConfiguration;

  public readonly loggingManager: LoggingManager;

  public readonly metricsCollector: MetricsCollector;

  public parsedCommandLine: IHeftParsedCommandLine | undefined;

  public readonly debug: boolean;

  private constructor(heftConfigurationJson: IHeftConfigurationJson, options: IInternalHeftSessionOptions) {
    this.heftConfiguration = options.heftConfiguration;
    this.loggingManager = options.loggingManager;
    this.metricsCollector = options.metricsCollector;
    this.debug = options.debug;
    this.#heftConfigurationJson = heftConfigurationJson;
  }

  public static async initializeAsync(options: IInternalHeftSessionOptions): Promise<InternalHeftSession> {
    // Initialize the rig. Must be done before the HeftConfiguration.rigConfig is used.
    await options.heftConfiguration._checkForRigAsync();

    const heftConfigurationJson: IHeftConfigurationJson =
      await CoreConfigFiles.loadHeftConfigurationFileForProjectAsync(
        options.heftConfiguration.globalTerminal,
        options.heftConfiguration.buildFolderPath,
        options.heftConfiguration.rigConfig
      );

    const internalHeftSession: InternalHeftSession = new InternalHeftSession(heftConfigurationJson, options);

    // Initialize the lifecycle and the tasks. This will ensure that we throw an error if a plugin is improperly
    // specified, or if the options provided to a plugin are invalid. We will avoid loading the actual plugins
    // until they are needed.
    await internalHeftSession.lifecycle.ensureInitializedAsync();
    const tasks: Iterable<HeftTask> = getAllTasks(internalHeftSession.phases);
    await Async.forEachAsync(
      tasks,
      async (task: HeftTask) => {
        await task.ensureInitializedAsync();
      },
      { concurrency: Constants.maxParallelism }
    );

    function* getAllPluginDefinitions(): IterableIterator<HeftPluginDefinitionBase> {
      yield* internalHeftSession.lifecycle.pluginDefinitions;
      for (const task of getAllTasks(internalHeftSession.phases)) {
        yield task.pluginDefinition;
      }
    }

    const loadedPluginPathsByName: Map<string, Set<string>> = new Map();
    for (const { pluginName, entryPoint } of getAllPluginDefinitions()) {
      let existingPluginPaths: Set<string> | undefined = loadedPluginPathsByName.get(pluginName);
      if (!existingPluginPaths) {
        existingPluginPaths = new Set();
        loadedPluginPathsByName.set(pluginName, existingPluginPaths);
      }

      existingPluginPaths.add(entryPoint);
    }

    for (const [pluginName, pluginPaths] of loadedPluginPathsByName) {
      if (pluginPaths.size > 1) {
        throw new Error(
          `Multiple plugins named ${JSON.stringify(pluginName)} were loaded from different paths: ` +
            `${Array.from(pluginPaths, (x) => JSON.stringify(x)).join(', ')}. Plugins must have unique names.`
        );
      }
    }

    return internalHeftSession;
  }

  public get parameterManager(): HeftParameterManager {
    if (!this.#parameterManager) {
      throw new InternalError('A parameter manager for the session has not been provided.');
    }
    return this.#parameterManager;
  }

  public set parameterManager(value: HeftParameterManager) {
    this.#parameterManager = value;
  }

  public get actionReferencesByAlias(): ReadonlyMap<string, IHeftConfigurationJsonActionReference> {
    if (!this.#actionReferencesByAlias) {
      this.#actionReferencesByAlias = new Map(
        Object.entries(this.#heftConfigurationJson.aliasesByName || {})
      );
    }
    return this.#actionReferencesByAlias;
  }

  public get lifecycle(): HeftLifecycle {
    if (!this.#lifecycle) {
      this.#lifecycle = new HeftLifecycle(this, this.#heftConfigurationJson.heftPlugins || []);
    }
    return this.#lifecycle;
  }

  public get phases(): ReadonlySet<HeftPhase> {
    this.#ensurePhases();
    return this.#phases!;
  }

  public get phasesByName(): ReadonlyMap<string, HeftPhase> {
    this.#ensurePhases();
    return this.#phasesByName!;
  }

  public getSessionForPhase(phase: HeftPhase): HeftPhaseSession {
    let phaseSession: HeftPhaseSession | undefined = this.#phaseSessionsByPhase.get(phase);
    if (!phaseSession) {
      phaseSession = new HeftPhaseSession({ internalHeftSession: this, phase });
      this.#phaseSessionsByPhase.set(phase, phaseSession);
    }
    return phaseSession;
  }

  #ensurePhases(): void {
    if (!this.#phases || !this.#phasesByName) {
      this.#phasesByName = new Map();
      for (const [phaseName, phaseSpecifier] of Object.entries(
        this.#heftConfigurationJson.phasesByName || {}
      )) {
        const phase: HeftPhase = new HeftPhase(this, phaseName, phaseSpecifier);
        this.#phasesByName.set(phaseName, phase);
      }
      this.#phases = new Set(this.#phasesByName.values());
    }
  }
}