@samchon/ts-patch 3.2.2 → 3.4.0

package/projects/core/src/ts-package.ts

@@ -0,0 +1,99 @@
+import fs from 'fs';
+import path from 'path';
+import resolve from 'resolve';
+import { PackageError } from './system';
+import { TsModule } from './module';
+
+
+/* ****************************************************************************************************************** */
+// region: Types
+/* ****************************************************************************************************************** */
+
+export interface TsPackage {
+  majorVer: number
+  minorVer: number
+  version: string
+  packageFile: string
+  packageDir: string
+  cacheDir: string
+  libDir: string
+
+  moduleNames: TsModule.Name[]
+
+  /** @internal */
+  moduleCache: Map<TsModule.Name, TsModule>
+
+  getModulePath: (name: TsModule.Name) => string
+}
+
+// endregion
+
+
+/* ****************************************************************************************************************** */
+// region: Utils
+/* ****************************************************************************************************************** */
+
+/**
+ * Get TypeScript package info - Resolve from dir, throws if not cannot find TS package
+ */
+export function getTsPackage(dir: string = process.cwd()): TsPackage {
+  if (!fs.existsSync(dir)) throw new PackageError(`${dir} is not a valid directory`);
+
+  const possiblePackageDirs = [ dir, () => path.dirname(resolve.sync(`typescript/package.json`, { basedir: dir })) ];
+
+  for (const d of possiblePackageDirs) {
+    let packageDir: string;
+    try {
+      packageDir = typeof d === 'function' ? d() : d;
+    } catch {
+      break;
+    }
+
+    /* Parse package.json data */
+    const packageFile = path.join(packageDir, 'package.json');
+    if (!fs.existsSync(packageFile)) continue;
+
+    const { name, version } = (() => {
+      try {
+        return JSON.parse(fs.readFileSync(packageFile, 'utf8'));
+      }
+      catch (e) {
+        throw new PackageError(`Could not parse json data in ${packageFile}`);
+      }
+    })();
+
+    /* Validate */
+    if (name === 'typescript') {
+      const [ sMajor, sMinor ] = version.split('.')
+      const libDir = path.join(packageDir, 'lib');
+      const cacheDir = path.resolve(packageDir, '../.tsp/cache/');
+
+      /* Get all available module names in libDir */
+      const moduleNames: TsModule.Name[] = [];
+      for (const fileName of fs.readdirSync(libDir))
+        if ((<string[]><unknown>TsModule.names).includes(fileName)) moduleNames.push(fileName as TsModule.Name);
+
+      const res: TsPackage = {
+        version,
+        majorVer: +sMajor,
+        minorVer: +sMinor,
+        packageFile,
+        packageDir,
+        moduleNames,
+        cacheDir,
+        libDir,
+        moduleCache: new Map(),
+
+        getModulePath: (moduleName: TsModule.Name) => {
+          return path.join(libDir, moduleName as string);
+        }
+      }
+
+      return res;
+    }
+  }
+
+  throw new PackageError(`Could not find typescript package from ${dir}`);
+}
+
+// endregion

package/projects/core/src/utils/file-utils.ts

@@ -0,0 +1,104 @@
+import path from 'path';
+import fs from 'fs';
+import { getTsPackage } from '../ts-package';
+import { getLockFilePath, PackageError } from '../system';
+import { getHash } from './general';
+
+
+/* ****************************************************************************************************************** */
+// region: Config
+/* ****************************************************************************************************************** */
+
+const lockFileWaitMs = 2_000;
+
+// endregion
+
+
+/* ****************************************************************************************************************** */
+// region: Helpers
+/* ****************************************************************************************************************** */
+
+function waitForLockRelease(lockFilePath: string) {
+  const start = Date.now();
+  while (fs.existsSync(lockFilePath)) {
+    sleep(100);
+
+    if ((Date.now() - start) > lockFileWaitMs)
+      throw new Error(
+        `Could not acquire lock to write file. If problem persists, run ts-patch clear-cache and try again.
+      `);
+  }
+
+  function sleep(ms: number) {
+    const wakeUpTime = Date.now() + ms;
+    while (Date.now() < wakeUpTime) {}
+  }
+}
+
+// endregion
+
+
+/* ****************************************************************************************************************** */
+// region: Utils
+/* ****************************************************************************************************************** */
+
+/**
+ * Attempts to locate global installation of TypeScript
+ */
+export function getGlobalTsDir() {
+  const errors = [];
+  const dir = require('global-prefix');
+  const check = (dir: string) => {
+    try { return getTsPackage(dir) }
+    catch (e) {
+      errors.push(e);
+      return <any>{};
+    }
+  };
+
+  const { packageDir } = (check(dir) || check(path.join(dir, 'lib')));
+
+  if (!packageDir)
+    throw new PackageError(`Could not find global TypeScript installation! Are you sure it's installed globally?`);
+
+  return packageDir;
+}
+
+
+export const mkdirIfNotExist = (dir: string) => !fs.existsSync(dir) && fs.mkdirSync(dir, { recursive: true });
+
+export function withFileLock<T>(filePath: string, fn: () => T): T {
+  const lockFileName = getHash(filePath) + '.lock';
+  const lockFilePath = getLockFilePath(lockFileName);
+  try {
+    const lockFileDir = path.dirname(lockFilePath);
+    if (!fs.existsSync(lockFileDir)) fs.mkdirSync(lockFileDir, { recursive: true });
+    waitForLockRelease(lockFilePath);
+    fs.writeFileSync(lockFilePath, '');
+    return fn();
+  } finally {
+    if (fs.existsSync(lockFilePath)) fs.rmSync(lockFilePath, { force: true });
+  }
+}
+
+export function writeFileWithLock(filePath: string, content: string): void {
+  withFileLock(filePath, () => {
+    fs.writeFileSync(filePath, content);
+  });
+}
+
+export function readFileWithLock(filePath: string): string {
+  return withFileLock(filePath, () => {
+    return fs.readFileSync(filePath, 'utf8');
+  });
+}
+
+export function copyFileWithLock(src: string, dest: string): void {
+  withFileLock(src, () => {
+    withFileLock(dest, () => {
+      fs.copyFileSync(src, dest);
+    });
+  });
+}
+
+// endregion

package/projects/core/src/utils/find-cache-dir.ts

@@ -0,0 +1,122 @@
+/**
+ * @credit https://github.com/sindresorhus/find-cache-di
+ * @license MIT
+ * @author Sindre Sorhus
+ * @author James Talmage
+ *
+ * MIT License
+ *
+ * Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+ * Copyright (c) James Talmage <james@talmage.io> (https://github.com/jamestalmage)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+import process from 'node:process';
+import path from 'node:path';
+import fs from 'node:fs';
+
+
+/* ****************************************************************************************************************** */
+// region: Types
+/* ****************************************************************************************************************** */
+
+export interface FindCacheDirOptions {
+  name: string;
+  cwd?: string; // Default: process.cwd()
+  create?: boolean; // Default: false
+}
+
+// endregion
+
+
+/* ****************************************************************************************************************** */
+// region: Helpers
+/* ****************************************************************************************************************** */
+
+const isWritable = (path: string) => {
+  try {
+    fs.accessSync(path, fs.constants.W_OK);
+    return true;
+  }
+  catch {
+    return false;
+  }
+};
+
+function useDirectory(directory: string, options: any) {
+  if (options.create) {
+    fs.mkdirSync(directory, { recursive: true });
+  }
+
+  return directory;
+}
+
+function getNodeModuleDirectory(directory: string) {
+  const nodeModules = path.join(directory, 'node_modules');
+
+  if (
+    !isWritable(nodeModules)
+    && (fs.existsSync(nodeModules) || !isWritable(path.join(directory)))
+  ) {
+    return;
+  }
+
+  return nodeModules;
+}
+
+function findNearestPackageDir(startPath: string): string | null {
+  const visitedDirs = new Set<string>();
+  let currentPath = path.resolve(startPath);
+
+  while (true) {
+    const packageJsonPath = path.join(currentPath, 'package.json');
+
+    if (fs.existsSync(packageJsonPath)) {
+      return path.dirname(packageJsonPath);
+    }
+
+    // Mark the current directory as visited
+    visitedDirs.add(currentPath);
+
+    // Move to the parent directory
+    const parentPath = path.dirname(currentPath);
+
+    // Check for a circular loop
+    if (visitedDirs.has(parentPath) || parentPath === currentPath) {
+      return null;
+    }
+
+    currentPath = parentPath;
+  }
+}
+
+// endregion
+
+
+/* ****************************************************************************************************************** */
+// region: Utils
+/* ****************************************************************************************************************** */
+
+export function findCacheDirectory(options: FindCacheDirOptions) {
+  /* Use ENV Cache Dir if present */
+  if (process.env.CACHE_DIR && ![ 'true', 'false', '1', '0' ].includes(process.env.CACHE_DIR))
+    return useDirectory(path.join(process.env.CACHE_DIR, options.name), options);
+
+  /* Find Package Dir */
+  const startDir = options.cwd || process.cwd();
+  const pkgDir = findNearestPackageDir(startDir);
+  if (!pkgDir) return undefined;
+
+  /* Find Node Modules Dir */
+  const nodeModules = getNodeModuleDirectory(pkgDir);
+  if (!nodeModules) return undefined;
+
+  return useDirectory(path.join(pkgDir, 'node_modules', '.cache', options.name), options);
+}
+
+// endregion

package/projects/core/src/utils/general.ts

@@ -0,0 +1,24 @@
+import crypto from "crypto";
+
+
+/* ****************************************************************************************************************** */
+// region: Type Utils
+/* ****************************************************************************************************************** */
+
+/**
+ * Make certain properties partial
+ */
+export type PartialSome<T, K extends keyof T> = Omit<T, K> & Pick<Partial<T>, K>
+
+// endregion
+
+
+/* ****************************************************************************************************************** */
+// region: Crypto Utils
+/* ****************************************************************************************************************** */
+
+export function getHash(fileContent: string) {
+  return crypto.createHash('md5').update(fileContent).digest('hex');
+}
+
+// endregion

package/projects/core/src/utils/index.ts

@@ -0,0 +1,3 @@
+export * from './general';
+export * from './file-utils';
+export * from './find-cache-dir';

package/projects/core/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "extends" : "../../tsconfig.base.json",
+  "include" : [ "shared", "src" ],
+
+  "compilerOptions" : {
+    "rootDirs" : [ "src", "shared" ],
+    "outDir" : "../../dist",
+    "sourceMap" : true,
+    "composite" : true,
+    "declaration" : true,
+    "types" : [ "node" ],
+
+    "plugins" : [
+      {
+        "transform" : "./plugin.ts",
+        "transformProgram" : true
+      }
+    ]
+  }
+}

package/projects/patch/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@tsp/patch",
+  "version": "0.0.0",
+  "private": true,
+  "dependencies": {
+    "typescript": "link:../../node_modules/typescript"
+  }
+}

package/projects/patch/plugin.ts

@@ -0,0 +1,128 @@
+import type * as ts from 'typescript'
+import type { ProgramTransformerExtras } from 'ts-patch';
+import * as fs from 'fs';
+import * as path from 'path';
+
+
+/* ****************************************************************************************************************** */
+// region: Config
+/* ****************************************************************************************************************** */
+
+const srcTypesFileName = path.resolve(__dirname, '../core/shared/plugin-types.ts');
+const destTypesFileName = path.resolve(__dirname, 'src/types/plugin-types.ts');
+
+// endregion
+
+
+/* ****************************************************************************************************************** */
+// region: Transformers
+/* ****************************************************************************************************************** */
+
+function transformPatchDeclarationsFile(this: typeof ts, ctx: ts.TransformationContext) {
+  const { factory } = ctx;
+  const moduleName = factory.createIdentifier('ts');
+
+  return (sourceFile: ts.SourceFile) => {
+    const statements = sourceFile
+      .statements
+      .filter(node =>
+        this.isModuleDeclaration(node) && this.getJSDocTags(node).some(t => t.tagName.text === 'build-types')
+      )
+      .map((node: ts.ModuleDeclaration) =>
+        factory.updateModuleDeclaration(node, node.modifiers, moduleName, node.body)
+      );
+
+    return factory.updateSourceFile(
+      sourceFile,
+      statements,
+      sourceFile.isDeclarationFile
+    );
+  }
+}
+
+function transformPluginTypes(this: typeof ts, ctx: ts.TransformationContext) {
+  const { factory } = ctx;
+  return (sourceFile: ts.SourceFile) => {
+    const moduleDeclaration =
+      factory.createModuleDeclaration(
+        [ factory.createModifier(this.SyntaxKind.DeclareKeyword) ],
+        factory.createIdentifier('tsp'),
+        factory.createModuleBlock(
+          sourceFile
+            .statements
+            // TODO - remove the casting once we have tsei again
+            .filter(node => (<any>this).isDeclaration(node) && this.getCombinedModifierFlags(node as unknown as ts.Declaration))
+        ),
+        // TODO - remove the casting once we have tsei again
+        this.NodeFlags.Namespace | this.NodeFlags.ExportContext | (<any>this.NodeFlags).Ambient | this.NodeFlags.ContextFlags
+      );
+
+    return factory.updateSourceFile(sourceFile, [ moduleDeclaration ]);
+  }
+}
+
+// endregion
+
+
+/* ****************************************************************************************************************** *
+ * Program Transformer - Build and insert plugin-types.ts
+ * ****************************************************************************************************************** */
+
+export function transformProgram(
+  program: ts.Program,
+  host: ts.CompilerHost,
+  opt: any,
+  { ts }: ProgramTransformerExtras
+)
+{
+  host ??= ts.createCompilerHost(program.getCompilerOptions(), true);
+  const printer = ts.createPrinter({
+    removeComments: true,
+    newLine: ts.NewLineKind.LineFeed
+  });
+  // TODO - remove the casting once we have tsei again
+  const srcFileName = (<any>ts).normalizePath(srcTypesFileName);
+  const destFileName = (<any>ts).normalizePath(destTypesFileName);
+
+  hookWriteFile();
+  generatePluginTypesAndInjectToProgram();
+
+  return ts.createProgram(
+    program.getRootFileNames().concat([ destFileName ]),
+    program.getCompilerOptions(),
+    host,
+    program
+  );
+
+  function hookWriteFile() {
+    const originalWriteFile = host.writeFile;
+    host.writeFile = (fileName: string, data: string, ...args: any[]) => {
+      /* Transform declarations */
+      if (/module-patch.d.ts$/.test(fileName)) {
+        let sourceFile = ts.createSourceFile(fileName, data, ts.ScriptTarget.ES2016, true, ts.ScriptKind.TS);
+        sourceFile = ts.transform(sourceFile, [ transformPatchDeclarationsFile.bind(ts) ]).transformed[0];
+        return (<any>originalWriteFile)(fileName, printer.printFile(sourceFile), ...args);
+      }
+
+      /* Strip comments from js */
+      if (/module-patch.js$/.test(fileName)) {
+        /* Wrap file in closure */
+        data = `var tsp = (function() {\n${data}\nreturn tsp;})();`;
+
+        const sourceFile = ts.createSourceFile(fileName, data, ts.ScriptTarget.ES2016, false, ts.ScriptKind.JS);
+        return (<any>originalWriteFile)(fileName, printer.printFile(sourceFile), ...args);
+      }
+
+      return (<any>originalWriteFile)(fileName, data, ...args);
+    }
+  }
+
+  function generatePluginTypesAndInjectToProgram() {
+    let sourceFile = ts.createSourceFile(srcFileName, fs.readFileSync(srcFileName, 'utf8'), ts.ScriptTarget.ES2015, true);
+    sourceFile = ts.transform(sourceFile, [ transformPluginTypes.bind(ts) ]).transformed[0];
+
+    const moduleBody = `// @ts-nocheck\n/** AUTO-GENERATED - DO NOT EDIT */\n\n/** @build-types */\n` + printer.printFile(sourceFile);
+
+    fs.writeFileSync(destFileName, moduleBody);
+  }
+}

package/projects/patch/src/plugin/esm-intercept.ts

@@ -0,0 +1,141 @@
+namespace tsp {
+  const Module = require('module');
+  const path = require('path');
+  const fs = require('fs');
+  const crypto = require('crypto');
+
+  /* ********************************************************* */
+  // region: Helpers
+  /* ********************************************************* */
+
+  function getEsmLibrary() {
+    try {
+      return require('esm') as typeof import('esm');
+    } catch (e) {
+      if (e.code === 'MODULE_NOT_FOUND')
+        throw new TsPatchError(
+          `Plugin is an ESM module. To enable experimental ESM support, ` +
+          `install the 'esm' package as a (dev)-dependency or global.`
+        );
+      else throw e;
+    }
+  }
+
+  // endregion
+
+  /* ********************************************************* */
+  // region: Utils
+  /* ********************************************************* */
+
+  export function registerEsmIntercept(registerConfig: RegisterConfig): () => void {
+    const originalRequire = Module.prototype.require;
+    const builtFiles = new Map<string, string>();
+
+    const getHash = () => {
+      let hash: string;
+      do {
+        hash = crypto.randomBytes(16).toString('hex');
+      } while (builtFiles.has(hash));
+
+      return hash;
+    }
+
+    /* Create cleanup function */
+    const cleanup = () => {
+      /* Cleanup temp ESM files */
+      for (const { 1: filePath } of builtFiles) {
+        delete require.cache[filePath];
+        try {
+          fs.rmSync(filePath, { force: true, maxRetries: 3 });
+        } catch (e) {
+          if (process.env.NODE_ENV !== 'production')
+            console.warn(`[ts-patch] Warning: Failed to delete temporary esm cache file: ${filePath}.`);
+        }
+      }
+
+      builtFiles.clear();
+      Module.prototype.require = originalRequire;
+    }
+
+    /* Set Hooks */
+    try {
+      Module.prototype.require = wrappedRequire;
+    } catch (e) {
+      cleanup();
+    }
+
+    /* ********************************************************* *
+     * Helpers
+     * ********************************************************* */
+
+    function wrappedRequire(this: unknown, request: string) {
+      try {
+        return originalRequire.apply(this, arguments);
+      } catch (e) {
+        if (e.code === 'ERR_REQUIRE_ESM') {
+          const resolvedPath = Module._resolveFilename(request, this, false);
+          const resolvedPathExt = path.extname(resolvedPath);
+
+          if (Module._cache[resolvedPath]) return Module._cache[resolvedPath].exports;
+
+          /* Compile TS */
+          let targetFilePath: string;
+          if (tsExtensions.includes(resolvedPathExt)) {
+            if (!builtFiles.has(resolvedPath)) {
+              const tsCode = fs.readFileSync(resolvedPath, 'utf8');
+
+              // NOTE - I don't know why, but if you supply a *.ts file to tsNode.compile it will be output as cjs,
+              //  regardless of the tsConfig properly specifying ESNext for module and target. Notably, this issue seems
+              //  to have started with TS v5.5,
+              //
+              //  To work around, we will tell ts-node that it's an "mts" file.
+              const newPath = resolvedPath.replace(/\.ts$/, '.mts');
+
+              const jsCode = registerConfig.tsNodeInstance!.compile(tsCode, newPath);
+              const outputFileName = getHash() + '.mjs';
+              const outputFilePath = path.join(getTmpDir('esm'), outputFileName);
+              fs.writeFileSync(outputFilePath, jsCode, 'utf8');
+
+              builtFiles.set(resolvedPath, outputFilePath);
+              targetFilePath = outputFilePath;
+            } else {
+              targetFilePath = builtFiles.get(resolvedPath)!;
+            }
+          } else {
+            targetFilePath = resolvedPath;
+          }
+
+          /* Setup new module */
+          const newModule = new Module(request, this);
+          newModule.filename = resolvedPath;
+          newModule.paths = Module._nodeModulePaths(resolvedPath);
+
+          /* Add to cache */
+          Module._cache[resolvedPath] = newModule;
+
+          /* Load ESM module — try native require first (Node.js 22.12.0+), fall back to esm library */
+          let res;
+          try {
+            res = originalRequire.call(this, targetFilePath);
+            newModule.exports = res;
+          } catch (loadErr: any) {
+            if (loadErr?.code === 'ERR_REQUIRE_ESM') {
+              res = getEsmLibrary()(newModule)(targetFilePath);
+              newModule.filename = resolvedPath;
+            } else {
+              throw loadErr;
+            }
+          }
+
+          return res;
+        }
+
+        throw e;
+      }
+    }
+
+    return cleanup;
+  }
+
+  // endregion
+}