packages/jsii-pacmak/lib/packaging.ts

import * as fs from 'fs-extra';
import type { Assembly, TypeSystem } from 'jsii-reflect';
import * as path from 'path';

import { Scratch, shell } from './util';
import * as logging from '../lib/logging';

export const DEFAULT_PACK_COMMAND = 'npm pack';

export interface JsiiModuleOptions {
  /**
   * Name of the module
   */
  name: string;

  /**
   * The module directory
   */
  moduleDirectory: string;

  /**
   * Identifier of the targets to build
   */
  availableTargets: string[];

  /**
   * Output directory where to package everything
   */
  defaultOutputDirectory: string;

  /**
   * Names of packages this package depends on, if any
   */
  dependencyNames?: string[];
}
export class JsiiModule {
  public readonly name: string;
  public readonly dependencyNames: string[];
  public readonly moduleDirectory: string;
  public readonly availableTargets: string[];
  public outputDirectory: string;

  private _tarball?: Scratch<string>;
  public _assembly?: Assembly;

  public constructor(options: JsiiModuleOptions) {
    this.name = options.name;
    this.moduleDirectory = options.moduleDirectory;
    this.availableTargets = options.availableTargets;
    this.outputDirectory = options.defaultOutputDirectory;
    this.dependencyNames = options.dependencyNames ?? [];
  }

  /**
   * Prepare an NPM package from this source module
   */
  public async npmPack(packCommand = DEFAULT_PACK_COMMAND) {
    this._tarball = await Scratch.make(async (tmpdir) => {
      const args = [];

      if (packCommand === DEFAULT_PACK_COMMAND) {
        // Quoting (JSON-stringifying) the module directory in order to avoid
        // problems if there are spaces or other special characters in the path.
        args.push(JSON.stringify(this.moduleDirectory));

        if (logging.level.valueOf() >= logging.LEVEL_VERBOSE) {
          args.push('--loglevel=verbose');
        }
      } else {
        // Ensure module is copied to tmpdir to ensure parallel execution does not contend on generated tarballs
        await fs.copy(this.moduleDirectory, tmpdir, { dereference: true });
      }

      const out = await shell(packCommand, args, {
        cwd: tmpdir,
      });

      // Take only the last line of npm pack which should contain the
      // tarball name. otherwise, there can be a lot of extra noise there
      // from scripts that emit to STDOUT.
      // Since we are interested in the text *after* the last newline, splitting on '\n' is correct
      // both on Linux/Mac (EOL = '\n') and Windows (EOL = '\r\n'), and also for UNIX tools running
      // on Windows (expected EOL = '\r\n', actual EOL = '\n').
      const lines = out.trim().split('\n');
      const lastLine = lines[lines.length - 1].trim();

      if (!lastLine.endsWith('.tgz') && !lastLine.endsWith('.tar.gz')) {
        throw new Error(
          `${packCommand} did not produce tarball from ${
            this.moduleDirectory
          } into ${tmpdir} (output was ${JSON.stringify(lines.map((l) => l.trimEnd()))})`,
        );
      }

      return path.resolve(tmpdir, lastLine);
    });
  }

  public get tarball(): string {
    if (!this._tarball) {
      throw new Error('Tarball not available yet, call npmPack() first');
    }
    return this._tarball.object;
  }

  public async load(system: TypeSystem, validate = true) {
    return system
      .loadModule(this.moduleDirectory, { validate })
      .then((assembly) => (this._assembly = assembly));
  }

  public get assembly(): Assembly {
    if (!this._assembly) {
      throw new Error('Assembly not available yet, call load() first');
    }
    return this._assembly;
  }

  public async cleanup() {
    if (this._tarball) {
      await this._tarball.cleanup();
    }
  }
}