@travetto/pack 4.0.0-rc.4 → 4.0.0-rc.5

package/README.md

@@ -39,7 +39,7 @@ Options:
   -sm, --sourcemap                     Bundle source maps (default: false)
   -is, --include-sources               Include source with source maps (default: false)
   -x, --eject-file <string>            Eject commands to file
-  -r, --rollup-configuration <string>  Rollup configuration file (default: "@travetto/pack/support/bin/rollup")
+  -r, --rollup-configuration <string>  Rollup configuration file (default: "@travetto/pack/support/rollup/build")
   --env-file <string>                  Env Flag File Name (default: ".env")
   --manifest-file <string>             Manifest File Name (default: "manifest.json")
   -m, --module <module>                Module to run for
@@ -103,7 +103,7 @@ Options:
   -sm, --sourcemap                     Bundle source maps (default: false)
   -is, --include-sources               Include source with source maps (default: false)
   -x, --eject-file <string>            Eject commands to file
-  -r, --rollup-configuration <string>  Rollup configuration file (default: "@travetto/pack/support/bin/rollup")
+  -r, --rollup-configuration <string>  Rollup configuration file (default: "@travetto/pack/support/rollup/build")
   --env-file <string>                  Env Flag File Name (default: ".env")
   --manifest-file <string>             Manifest File Name (default: "manifest.json")
   -m, --module <module>                Module to run for
@@ -130,7 +130,7 @@ Options:
   -sm, --sourcemap                       Bundle source maps (default: false)
   -is, --include-sources                 Include source with source maps (default: false)
   -x, --eject-file <string>              Eject commands to file
-  -r, --rollup-configuration <string>    Rollup configuration file (default: "@travetto/pack/support/bin/rollup")
+  -r, --rollup-configuration <string>    Rollup configuration file (default: "@travetto/pack/support/rollup/build")
   --env-file <string>                    Env Flag File Name (default: ".env")
   --manifest-file <string>               Manifest File Name (default: "manifest.json")
   -df, --docker-factory <string>         Docker Factory source  (default: "@travetto/pack/support/pack.dockerfile")
@@ -195,7 +195,7 @@ echo "Writing entry scripts todo-app.sh args=(run:rest)"
 
 echo "#!/bin/sh" > $DIST/todo-app.sh
 echo "cd \$(dirname \"\$0\")" >> $DIST/todo-app.sh
-echo "node --env-file=.env todo-app.js run:rest \$@" >> $DIST/todo-app.sh
+echo "node todo-app.js run:rest \$@" >> $DIST/todo-app.sh
 chmod 755 $DIST/todo-app.sh
 
 # Writing entry scripts todo-app.cmd args=(run:rest) 
@@ -204,7 +204,7 @@ echo "Writing entry scripts todo-app.cmd args=(run:rest)"
 
 echo "" > $DIST/todo-app.cmd
 echo "cd %~p0" >> $DIST/todo-app.cmd
-echo "node --env-file=.env todo-app.js run:rest %*" >> $DIST/todo-app.cmd
+echo "node todo-app.js run:rest %*" >> $DIST/todo-app.cmd
 chmod 755 $DIST/todo-app.cmd
 
 # Copying over resources 
@@ -233,7 +233,7 @@ export BUNDLE_FORMAT=commonjs
 export BUNDLE_ENV_FILE=.env
 export TRV_MANIFEST=$TRV_OUT/node_modules/$MOD
 cd $TRV_OUT
-npx rollup -c $TRV_OUT/node_modules/@travetto/pack/support/bin/rollup.js
+npx rollup -c $TRV_OUT/node_modules/@travetto/pack/support/rollup/build.js
 cd $ROOT
 
 # Generating Docker File $DIST/Dockerfile @travetto/pack/support/pack.dockerfile 

package/__index__.ts

@@ -1,2 +1,2 @@
-export type { CommonPackConfig, DockerPackFactory, DockerPackConfig } from './support/bin/types';
-export { PackConfigUtil } from './support/bin/config-util';
+export type { CommonPackConfig, DockerPackFactory, DockerPackConfig } from './src/types';
+export { PackConfigUtil } from './src/config-util';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/pack",
-  "version": "4.0.0-rc.4",
+  "version": "4.0.0-rc.5",
   "description": "Code packing utilities",
   "keywords": [
     "travetto",
@@ -17,6 +17,7 @@
   "main": "__index__.ts",
   "files": [
     "__index__.ts",
+    "src",
     "support"
   ],
   "repository": {
@@ -28,12 +29,12 @@
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
-    "@travetto/base": "^4.0.0-rc.3",
-    "@travetto/terminal": "^4.0.0-rc.3",
+    "@travetto/base": "^4.0.0-rc.4",
+    "@travetto/terminal": "^4.0.0-rc.4",
     "rollup": "^4.9.6"
   },
   "peerDependencies": {
-    "@travetto/cli": "^4.0.0-rc.3"
+    "@travetto/cli": "^4.0.0-rc.4"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/{support/bin → src}/types.ts

@@ -1,3 +1,6 @@
+import { type OutputOptions } from 'rollup';
+import type terser from '@rollup/plugin-terser';
+
 export type CommonPackConfig = {
   workspace: string;
   output: string;
@@ -57,4 +60,13 @@ export type ShellCommandImpl = {
 };
 
 export type DockerPackFactory = (cfg: DockerPackConfig) => (string | Promise<string>);
-export type DockerPackFactoryModule = { factory: DockerPackFactory };
+export type DockerPackFactoryModule = { factory: DockerPackFactory };
+
+export type CoreRollupConfig = {
+  envFile?: string;
+  output: OutputOptions;
+  entry: string;
+  files: string[];
+  ignore: Set<string>;
+  minify: Parameters<typeof terser>[0];
+};

package/support/bin/docker-operation.ts

@@ -4,7 +4,7 @@ import { path, RuntimeIndex } from '@travetto/manifest';
 import { cliTpl } from '@travetto/cli';
 
 import { ActiveShellCommand } from './shell';
-import { DockerPackConfig, DockerPackFactoryModule } from './types';
+import { DockerPackConfig, DockerPackFactoryModule } from '../../src/types';
 import { PackOperation } from './operation';
 import { PackUtil } from './util';
 

package/support/bin/operation.ts

@@ -4,7 +4,7 @@ import { path, RuntimeIndex, RuntimeContext } from '@travetto/manifest';
 import { cliTpl } from '@travetto/cli';
 import { Env } from '@travetto/base';
 
-import { CommonPackConfig } from './types';
+import { CommonPackConfig } from '../../src/types';
 import { PackUtil } from './util';
 import { ActiveShellCommand, ShellCommands } from './shell';
 
@@ -160,7 +160,7 @@ export class PackOperation {
         text: [
           ShellCommands[type].scriptOpen(),
           ShellCommands[type].chdirScript(),
-          ShellCommands[type].callCommandWithAllArgs('node', `--env-file=${cfg.envFile}`, cfg.mainFile, ...cfg.entryArguments),
+          ShellCommands[type].callCommandWithAllArgs('node', cfg.mainFile, ...cfg.entryArguments),
         ].map(x => x.join(' '))
       }));
 

package/support/bin/preamble.ts

@@ -0,0 +1,18 @@
+import { readFileSync as readSyncPreamble } from 'node:fs';
+
+// @ts-expect-error -- Lock to prevent __proto__ pollution in JSON
+const objectProto = Object.prototype.__proto__;
+Object.defineProperty(Object.prototype, '__proto__', {
+  get() { return objectProto; },
+  set(val) { Object.setPrototypeOf(this, val); }
+});
+
+if (!process.env.TRV_MODULE && '%%ENV_FILE%%') {
+  try {
+    readSyncPreamble('%%ENV_FILE%%', 'utf8')
+      .split('\n')
+      .map(x => x.match(/\s*(?<key>[^ =]+)\s*=\s*(?<value>\S+)/)?.groups)
+      .filter((x): x is Exclude<typeof x, null | undefined> => !!x)
+      .forEach(x => process.env[x.key] = x.value);
+  } catch { }
+}

package/support/bin/shell.ts

@@ -1,7 +1,7 @@
 import { path } from '@travetto/manifest';
 import { StyleUtil } from '@travetto/terminal';
 
-import { ShellCommandImpl } from './types';
+import { ShellCommandImpl } from '../../src/types';
 
 const escape = (text: string): string =>
   text

package/support/cli.pack_docker.ts

@@ -4,7 +4,7 @@ import { Ignore, Required } from '@travetto/schema';
 
 import { DockerPackOperation } from './bin/docker-operation';
 import { BasePackCommand, PackOperationShape } from './pack.base';
-import { DockerPackConfig } from './bin/types';
+import { DockerPackConfig } from '../src/types';
 
 const NODE_MAJOR = +process.version.match(/\d+/)![0];
 const DEFAULT_USER_ID = 2000;

package/support/pack.base.ts

@@ -60,7 +60,7 @@ export abstract class BasePackCommand implements CliCommandShape {
   ejectFile?: string;
 
   @CliFlag({ desc: 'Rollup configuration file', short: 'r' })
-  rollupConfiguration = '@travetto/pack/support/bin/rollup';
+  rollupConfiguration = '@travetto/pack/support/rollup/build';
 
   @CliFlag({ desc: 'Env Flag File Name' })
   envFile = '.env';

package/support/pack.dockerfile.ts

@@ -1,4 +1,4 @@
-import { DockerPackFactory } from './bin/types';
-import { PackConfigUtil } from './bin/config-util';
+import { DockerPackFactory } from '../src/types';
+import { PackConfigUtil } from '../src/config-util';
 
 export const factory: DockerPackFactory = cfg => PackConfigUtil.dockerStandardFile(cfg);

package/support/rollup/build.ts

@@ -0,0 +1,29 @@
+import commonjsRequire from '@rollup/plugin-commonjs';
+import nodeResolve from '@rollup/plugin-node-resolve';
+import terser from '@rollup/plugin-terser';
+import jsonImport from '@rollup/plugin-json';
+import type { RollupOptions } from 'rollup';
+
+import { getCoreConfig } from './config';
+import { travettoImportPlugin } from './rollup-travetto-import';
+import { travettoSourcemaps } from './rollup-travetto-sourcemaps';
+import { travettoEntryPlugin } from './rollup-travetto-entry';
+
+export default function buildConfig(): RollupOptions {
+  // Load up if not defined
+  const config = getCoreConfig();
+
+  return {
+    input: [config.entry],
+    output: config.output,
+    plugins: [
+      jsonImport(),
+      travettoEntryPlugin(config),
+      travettoImportPlugin(config),
+      commonjsRequire({ ignore: id => config.ignore.has(id) }),
+      nodeResolve({ preferBuiltins: true }),
+      travettoSourcemaps(config),
+      ...(config.output.compact ? [terser(config.minify)] : [])
+    ]
+  };
+}

package/support/{bin → rollup}/config.ts

@@ -1,38 +1,10 @@
-import type fs from 'node:fs';
 import type { OutputOptions } from 'rollup';
 
 import type terser from '@rollup/plugin-terser';
 
 import { ManifestModule, ManifestModuleUtil, NodeModuleType, path, RuntimeIndex, RuntimeContext } from '@travetto/manifest';
 import { EnvProp } from '@travetto/base';
-
-// eslint-disable-next-line @typescript-eslint/naming-convention
-function __init(mod: typeof fs, file?: string, freezeProto?: boolean): void {
-  if (freezeProto !== false) {
-    // @ts-expect-error -- Lock to prevent __proto__ pollution in JSON
-    const objectProto = Object.prototype.__proto__;
-    Object.defineProperty(Object.prototype, '__proto__', {
-      get() { return objectProto; },
-      set(val) { Object.setPrototypeOf(this, val); }
-    });
-  }
-
-  if (file) {
-    if (process.env.TRV_MODULE) { return; }
-    try {
-      mod.readFileSync(file, 'utf8')
-        .split('\n')
-        .map(x => x.match(/\s*(?<key>[^ =]+)\s*=\s*(?<value>\S+)/)?.groups)
-        .filter((x): x is Exclude<typeof x, null | undefined> => !!x)
-        .forEach(x => process.env[x.key] = x.value);
-    } catch { }
-  }
-}
-
-const INTRO = (envFile: string | undefined, sourceMap?: boolean): Record<NodeModuleType, string> => ({
-  commonjs: `(${__init.toString()})(require('node:fs'), '${envFile}', ${!!sourceMap})`,
-  module: `(${__init.toString()})(await import('node:fs'), '${envFile}', ${!!sourceMap})`
-});
+import { CoreRollupConfig } from '../../src/types';
 
 function getFilesFromModule(m: ManifestModule): string[] {
   return [
@@ -41,7 +13,7 @@ function getFilesFromModule(m: ManifestModule): string[] {
     ...(m.files.bin ?? [])
       .filter(f => !(/bin\/trv[.]js$/.test(f[0]) && m.name === '@travetto/cli')),
     ...(m.files.support ?? [])
-      .filter(f => !/support\/(test|doc)/.test(f[0]))
+      .filter(f => !/support\/(test|doc|pack)/.test(f[0]))
   ]
     .filter(([, t]) => t === 'ts' || t === 'js' || t === 'json')
     .map(([f]) => ManifestModuleUtil.sourceToOutputExt(path.resolve(m.outputFolder, f)));
@@ -55,9 +27,8 @@ export function getOutput(): OutputOptions {
   return {
     format,
     interop: format === 'commonjs' ? 'auto' : undefined,
-    intro: INTRO(new EnvProp('BUNDLE_ENV_FILE').val)[format],
     sourcemapPathTransform: (src, map): string =>
-      path.resolve(path.dirname(map), src).replace(`${RuntimeContext.workspace.path}/`, ''),
+      RuntimeContext.stripWorkspacePath(path.resolve(path.dirname(map), src)),
     sourcemap: new EnvProp('BUNDLE_SOURCEMAP').bool ?? false,
     sourcemapExcludeSources: !(new EnvProp('BUNDLE_SOURCES').bool ?? false),
     compact: new EnvProp('BUNDLE_COMPRESS').bool ?? true,
@@ -70,21 +41,21 @@ export function getEntry(): string {
   return process.env.BUNDLE_ENTRY!;
 }
 
-export function getFiles(): string[] {
+export function getFiles(entry?: string): string[] {
   return [...RuntimeIndex.getModuleList('all')]
     .map(x => RuntimeIndex.getManifestModule(x))
     .filter(m => m.prod)
-    .flatMap(getFilesFromModule);
+    .flatMap(getFilesFromModule)
+    .filter(x => (!entry || !x.endsWith(entry)) && !x.includes('@travetto/pack/support'));
 }
 
-export function getIgnoredModules(): string[] {
+export function getIgnoredModules(): ManifestModule[] {
   return [...RuntimeIndex.getModuleList('all')]
     .map(x => RuntimeIndex.getManifestModule(x))
-    .filter(m => !m.prod)
-    .map(m => m.name);
+    .filter(m => !m.prod);
 }
 
-export function getTerserConfig(): Parameters<typeof terser>[0] {
+export function getMinifyConfig(): Parameters<typeof terser>[0] {
   return {
     mangle: true,
     keep_classnames: true,
@@ -97,3 +68,18 @@ export function getTerserConfig(): Parameters<typeof terser>[0] {
     }
   };
 }
+
+export function getCoreConfig(): CoreRollupConfig {
+  const output = getOutput();
+  const entry = getEntry();
+  const files = getFiles(entry);
+  const ignoreModules = getIgnoredModules();
+  const ignoreFiles = ignoreModules.flatMap(getFilesFromModule);
+  const minify = getMinifyConfig();
+  const envFile = new EnvProp('BUNDLE_ENV_FILE').val;
+
+  return {
+    output, entry, files, envFile, minify,
+    ignore: new Set([...ignoreModules.map(x => x.name), ...ignoreFiles]),
+  };
+}

package/support/rollup/rollup-travetto-entry.ts

@@ -0,0 +1,43 @@
+import { readFileSync } from 'node:fs';
+import { Plugin } from 'rollup';
+
+import { RuntimeIndex } from '@travetto/manifest';
+
+import { CoreRollupConfig } from '../../src/types';
+
+export const GLOBAL_IMPORT = '__trv_imp';
+
+export function travettoEntryPlugin(config: CoreRollupConfig): Plugin {
+  const imports = config.files
+    .map(x => x.split('node_modules/').pop()!)
+    .flatMap(x => x.endsWith('/__index__.js') ? [x.replace('/__index__.js', ''), x] : [x]);
+
+  const op = config.output.format === 'module' ? 'import' : 'require';
+  const importer = `
+function trvImp(path) {
+  switch (path) {
+${imports.map(x => `    case '${x}': return ${op}('${x}')`).join('\n')}
+    default: return ${op}(path); // Fall back for built-ins
+  }
+}
+globalThis.${GLOBAL_IMPORT} = trvImp;
+`;
+
+  const out: Plugin = {
+    name: 'travetto-entry',
+
+    intro() {
+      return readFileSync(RuntimeIndex.getFromImport('@travetto/pack/support/bin/preamble')!.outputFile, 'utf8')
+        .replaceAll('%%ENV_FILE%%', config.envFile ?? '')
+        .replace(/\/\/# source.*$/m, '');
+    },
+
+    load(id) {
+      if (id.endsWith(config.entry)) {
+        return `${importer}${readFileSync(id, 'utf8')}`;
+      }
+    }
+  };
+
+  return out;
+}

package/support/rollup/rollup-travetto-import.ts

@@ -0,0 +1,60 @@
+import { AstNode, Plugin } from 'rollup';
+import { walk } from 'estree-walker';
+import magicString from 'magic-string';
+
+import { GLOBAL_IMPORT } from './rollup-travetto-entry';
+import { CoreRollupConfig } from '../../src/types';
+
+type TNode = AstNode & { source?: { type: string }, callee?: TNode & { name?: string }, args?: TNode[] };
+
+export function travettoImportPlugin(config: CoreRollupConfig): Plugin {
+  const fileSet = new Set(config.files);
+
+  const out: Plugin = {
+    name: 'travetto-import',
+
+    resolveDynamicImport(specifier, importer, options) {
+      const key = typeof specifier === 'string' ? specifier : '';
+      if (config.ignore.has(key)) {
+        return false;
+      }
+    },
+
+    transform(code, id) {
+      const parsed = this.parse(code);
+
+      if (id.includes('support/entry') || (!fileSet.has(id) && !id.includes('@travetto'))) {
+        return;
+      }
+
+      let ms: magicString | undefined;
+
+      walk(parsed, {
+        enter: (node) => {
+          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+          const impNode = node as TNode;
+          if (impNode.type === 'ImportExpression' && impNode.source?.type !== 'Literal') {
+            if (!/["']/.test(code.substring(impNode.start, impNode.end))) {
+              (ms ??= new magicString(code)).overwrite(impNode.start, impNode.start + 6, GLOBAL_IMPORT);
+            }
+          } else if (impNode.type === 'CallExpression' && impNode.callee?.type === 'Identifier' && impNode.callee.name === 'require') {
+            if (!/["']/.test(code.substring(impNode.start, impNode.end))) {
+              (ms ??= new magicString(code)).overwrite(impNode.start, impNode.start + 7, GLOBAL_IMPORT);
+            }
+          }
+        }
+      });
+
+      if (ms !== undefined) {
+        return {
+          code: ms.toString(),
+          map: ms.generateMap({ file: id, includeContent: true, hires: true })
+        };
+      } else {
+        return null;
+      }
+    }
+  };
+
+  return out;
+}

package/support/{bin/rollup-sourcemaps.ts → rollup/rollup-travetto-sourcemaps.ts}

@@ -2,14 +2,18 @@ import path from 'node:path';
 import fs from 'node:fs/promises';
 
 import { LoadResult, Plugin, PluginContext } from 'rollup';
+import { CoreRollupConfig } from '../../src/types';
 
 function toString(error: unknown): string {
   return error instanceof Error ? error.stack ?? error.toString() : JSON.stringify(error);
 }
 // Pulled from https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/dev-tool/src/config/rollup.base.config.ts#L128
-export function sourcemaps(): Plugin {
+export function travettoSourcemaps(config: CoreRollupConfig): Plugin {
+  if (config.output.sourcemap === 'hidden' || config.output.sourcemap === false) {
+    return { name: 'travetto-source-maps' };
+  }
   return {
-    name: 'load-source-maps',
+    name: 'travetto-source-maps',
     async load(this: PluginContext, id: string): Promise<LoadResult> {
       if (!id.endsWith('.js')) {
         return null;

package/support/bin/rollup-esm-dynamic-import.ts

@@ -1,55 +0,0 @@
-import { AstNode, Plugin } from 'rollup';
-import { walk } from 'estree-walker';
-import magicString from 'magic-string';
-
-const BRAND = '__imp';
-
-const DYNAMIC_IMPORT = (imports: string[]): string => `
-function ${BRAND}(path) { 
-  switch (path) {
-    ${imports.map(p => `  case '${p}': return import('${p}');`).join('\n')}
-    default: return import(path); // Fall back for built-ins
-  } 
-}
-globalThis.${BRAND} = ${BRAND}`;
-
-export function travettoImportPlugin(entry: string, files: string[]): Plugin {
-  const imports = files
-    .map(x => x.split('node_modules/').pop()!)
-    .flatMap(x => x.endsWith('__index__.js') ? [x.replace('__index__.js', ''), x] : [x]);
-
-  const out: Plugin = {
-    name: 'travetto-import',
-    transform(code, id) {
-      const parsed = this.parse(code);
-
-      let ms: magicString | undefined;
-
-      if (id.includes(entry)) {
-        (ms ??= new magicString(code).append(DYNAMIC_IMPORT(imports)));
-      }
-
-      walk(parsed, {
-        enter: (node) => {
-          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-          const impNode = node as AstNode & { source?: { type: string } };
-          if (impNode.type !== 'ImportExpression' || impNode.source?.type === 'Literal') {
-            return;
-          }
-          (ms ??= new magicString(code)).overwrite(impNode.start, impNode.start + 6, BRAND);
-        }
-      });
-
-      if (ms !== undefined) {
-        return {
-          code: ms.toString(),
-          map: ms.generateMap({ file: id, includeContent: true, hires: true })
-        };
-      } else {
-        return null;
-      }
-    }
-  };
-
-  return out;
-}

package/support/bin/rollup.ts

@@ -1,38 +0,0 @@
-import commonjsRequire from '@rollup/plugin-commonjs';
-import nodeResolve from '@rollup/plugin-node-resolve';
-import terser from '@rollup/plugin-terser';
-import jsonImport from '@rollup/plugin-json';
-import type { RollupOptions } from 'rollup';
-
-import { RuntimeContext } from '@travetto/manifest';
-
-import { getEntry, getOutput, getTerserConfig, getFiles, getIgnoredModules } from './config';
-import { travettoImportPlugin } from './rollup-esm-dynamic-import';
-import { sourcemaps } from './rollup-sourcemaps';
-
-const NEVER_INCLUDE = new Set<string>([]);
-
-export default function buildConfig(): RollupOptions {
-  const output = getOutput();
-  const entry = getEntry();
-  const files = getFiles();
-  const ignore = getIgnoredModules();
-  const ignoreRe = new RegExp(`^(${ignore.join('|')})`);
-
-  return {
-    input: [entry],
-    output,
-    plugins: [
-      jsonImport(),
-      commonjsRequire({
-        ignore: id => ignoreRe.test(id) || NEVER_INCLUDE.has(id),
-        dynamicRequireRoot: RuntimeContext.workspace.path,
-        dynamicRequireTargets: (output.format === 'commonjs' ? files : [])
-      }),
-      ...(output.format === 'module' ? [travettoImportPlugin(entry, files)] : []),
-      nodeResolve({ preferBuiltins: true }),
-      ...(output.sourcemap !== 'hidden' && output.sourcemap !== false ? [sourcemaps()] : []),
-      ...(output.compact ? [terser(getTerserConfig())] : [])
-    ]
-  };
-}