@griffel/transform 3.0.5 → 3.0.6

package/src/evaluation/module.mts

@@ -1,271 +0,0 @@
-/**
- * Custom module system for evaluating code in a sandboxed VM context.
- * Copied from @linaria/babel-preset v3.0.0-beta.19, adapted to use `debug` package
- * and local imports instead of @linaria/* packages.
- *
- * This serves 2 purposes:
- * - Avoid leakage from evaluated code to module cache in current context, e.g. `babel-register`
- * - Allow us to invalidate the module cache without affecting other stuff, necessary for rebuilds
- *
- * We also use it to transpile the code with Babel by default.
- * We also store source maps for it to provide correct error stacktraces.
- */
-
-import fs from 'node:fs';
-import NativeModule from 'node:module';
-import path from 'node:path';
-import vm from 'node:vm';
-import createDebug from 'debug';
-
-import { ASSET_TAG_OPEN, ASSET_TAG_CLOSE } from '../constants.mjs';
-import { convertESMtoCJS } from '../utils/convertESMtoCJS.mjs';
-import * as EvalCache from './evalCache.mjs';
-import * as mockProcess from './process.mjs';
-import type { EvalRule } from './types.mjs';
-
-export type TransformResolver = (
-  id: string,
-  options: { filename: string; paths: readonly string[] },
-) => { path: string; builtin: boolean };
-
-const debug = createDebug('griffel:module');
-
-// Separate cache for evaluated modules
-let cache: Record<string, Module> = {};
-
-const NOOP = () => { /* noop */ };
-
-/** Checks if a value is an Error-like object (works across VM contexts where `instanceof Error` fails). */
-function isError(e: unknown): e is Error {
-  return e !== null && e !== undefined && typeof e === 'object' && 'message' in e && 'stack' in e;
-}
-
-const createCustomDebug =
-  (depth: number) =>
-  (namespaces: string, arg1: unknown, ...args: unknown[]) => {
-    const modulePrefix = depth === 0 ? 'module' : `sub-module-${depth}`;
-    debug(`${modulePrefix}:${namespaces}`, arg1, ...args);
-  };
-
-export class Module {
-  readonly id: string;
-  readonly filename: string;
-  declare readonly paths: readonly string[];
-  rules: EvalRule[];
-  imports: Map<string, string[]> | null = null;
-  dependencies: string[] | null = null;
-  transform: ((code: string, filename: string) => string) | null = null;
-  static readonly extensions = new Set(['.json', '.js', '.jsx', '.ts', '.tsx', '.cjs', '.mjs', '.mts', '.cts']);
-
-  exports: unknown = {};
-
-  private readonly resolveFilename: TransformResolver;
-  private debug: (namespaces: string, arg1: unknown, ...args: unknown[]) => void;
-  private debuggerDepth: number;
-
-  constructor(filename: string, rules: EvalRule[], resolveFilename: TransformResolver, debuggerDepth = 0) {
-    this.id = filename;
-    this.filename = filename;
-    this.rules = rules;
-    this.resolveFilename = resolveFilename;
-    this.debuggerDepth = debuggerDepth;
-    this.debug = createCustomDebug(debuggerDepth);
-
-    Object.defineProperties(this, {
-      id: {
-        value: filename,
-        writable: false,
-      },
-      filename: {
-        value: filename,
-        writable: false,
-      },
-      paths: {
-        value: Object.freeze(
-          (NativeModule as unknown as { _nodeModulePaths: (dir: string) => string[] })._nodeModulePaths(
-            path.dirname(filename),
-          ),
-        ),
-        writable: false,
-      },
-    });
-
-    this.exports = {};
-    this.debug('prepare', filename);
-  }
-
-  require: ((id: string) => unknown) & {
-    ensure: () => void;
-    cache: Record<string, Module>;
-    resolve: (id: string) => string;
-  } = Object.assign(
-    (id: string): unknown => {
-      this.debug('require', id);
-
-      // Resolve module id (and filename) relatively to parent module
-      const resolved = this.resolveFilename(id, this);
-
-      if (resolved.builtin) {
-        throw new Error(`Unable to import "${id}". Importing Node builtins is not supported in the sandbox.`);
-      }
-
-      const filename = resolved.path;
-
-      this.dependencies?.push(id);
-      let cacheKey = filename;
-      let only: string[] = [];
-
-      if (this.imports?.has(id)) {
-        // We know what exactly we need from this module. Let's shake it!
-        only = this.imports.get(id)!.sort();
-
-        if (only.length === 0) {
-          // Probably the module is used as a value itself
-          // like `'The answer is ' + require('./module')`
-          only = ['default'];
-        }
-
-        cacheKey += `:${only.join(',')}`;
-      }
-
-      let m = cache[cacheKey];
-
-      if (!m) {
-        this.debug('cached:not-exist', id);
-
-        // Create the module if cached module is not available
-        m = new Module(filename, this.rules, this.resolveFilename, this.debuggerDepth + 1);
-        m.transform = this.transform;
-        // Store it in cache at this point, otherwise
-        // we would end up in infinite loop with cyclic dependencies
-        cache[cacheKey] = m;
-
-        const ext = path.extname(filename).toLowerCase();
-
-        if (Module.extensions.has(ext)) {
-          // To evaluate the file, we need to read it first
-          const code = fs.readFileSync(filename, 'utf-8');
-
-          if (ext === '.json') {
-            // For JSON files, parse it to a JS object similar to Node
-            m.exports = JSON.parse(code);
-          } else {
-            // For JS/TS files, evaluate the module
-            // The module will be transpiled using provided transform
-            m.evaluate(code, only.includes('*') ? ['*'] : only);
-          }
-        } else {
-          // For non JS/JSON requires, export the resolved absolute path wrapped in asset tags.
-          // This allows downstream tools (e.g. webpack plugin) to resolve the path correctly
-          // when CSS is extracted to a different location.
-          m.exports = ASSET_TAG_OPEN + filename + ASSET_TAG_CLOSE;
-        }
-      } else {
-        this.debug('cached:exist', id);
-      }
-
-      return m.exports;
-    },
-    {
-      ensure: NOOP,
-      cache,
-      resolve: (id: string) => this.resolveFilename(id, this).path,
-    },
-  );
-
-  evaluate(text: string, only: string[] | null = null, useEvalCache = true): void {
-    const { filename } = this;
-    // Find last matching rule (iterate backwards, break on first match)
-    let action: EvalRule['action'] = 'ignore';
-
-    for (let i = this.rules.length - 1; i >= 0; i--) {
-      const { test } = this.rules[i];
-
-      if (!test || (typeof test === 'function' ? test(filename) : test.test(filename))) {
-        action = this.rules[i].action;
-        break;
-      }
-    }
-
-    const cacheKey = [this.filename, ...(only ?? [])];
-
-    if (useEvalCache && EvalCache.has(cacheKey, text)) {
-      this.exports = EvalCache.get(cacheKey, text);
-      return;
-    }
-
-    let code: string;
-
-    if (action === 'ignore') {
-      this.debug('ignore', `${filename}`);
-      code = text;
-    } else {
-      // For JavaScript files, we need to transpile it and to get the exports of the module
-      this.debug('prepare-evaluation', this.filename, 'using', action.name);
-
-      const result = action(this.filename, text, only);
-
-      code = result.code;
-      this.imports = result.imports;
-
-      // Convert ESM syntax to CJS so it can run inside a function wrapper in vm.Script
-      if (result.moduleKind === 'esm') {
-        code = convertESMtoCJS(code, this.filename);
-      }
-
-      this.debug('evaluate', `${this.filename} (only ${(only || []).join(', ')}):\n${code}`);
-    }
-
-    const script = new vm.Script(`(function (exports) { ${code}\n})(exports);`, {
-      filename: this.filename,
-    });
-
-    try {
-      script.runInContext(
-        vm.createContext({
-          clearImmediate: NOOP,
-          clearInterval: NOOP,
-          clearTimeout: NOOP,
-          setImmediate: NOOP,
-          setInterval: NOOP,
-          setTimeout: NOOP,
-          fetch: NOOP,
-          global,
-          process: mockProcess,
-          module: this,
-          exports: this.exports,
-          require: this.require,
-          __filename: this.filename,
-          __dirname: path.dirname(this.filename),
-        }),
-      );
-    } catch (vmError: unknown) {
-      // Errors thrown inside vm.runInContext() use the VM context's Error constructor,
-      // so they fail `instanceof Error` in the host context (e.g. webpack wraps them as NonErrorEmittedError).
-      // Re-create as a host Error with filename context.
-      const message = isError(vmError) ? vmError.message : String(vmError);
-      const hostError = new Error(message);
-
-      if (isError(vmError)) {
-        hostError.stack = vmError.stack;
-      }
-
-      throw hostError;
-    }
-
-    if (useEvalCache) {
-      EvalCache.set(cacheKey, text, this.exports);
-    }
-  }
-
-  static invalidate = (): void => {
-    cache = {};
-  };
-
-  static invalidateEvalCache = (): void => {
-    EvalCache.clear();
-  };
-
-  static _nodeModulePaths = (filename: string): string[] =>
-    (NativeModule as unknown as { _nodeModulePaths: (dir: string) => string[] })._nodeModulePaths(filename);
-}

package/src/evaluation/module.test.mts

@@ -1,133 +0,0 @@
-import * as fs from 'node:fs';
-import NativeModule from 'node:module';
-import * as os from 'node:os';
-import * as path from 'node:path';
-import { afterEach, describe, expect, it } from 'vitest';
-
-import { ASSET_TAG_OPEN, ASSET_TAG_CLOSE } from '../constants.mjs';
-import { Module } from './module.mjs';
-import type { TransformResolver } from './module.mjs';
-
-const defaultRules = [{ action: 'ignore' as const }];
-const defaultResolve: TransformResolver = (id, opts) => ({
-  path: (NativeModule as unknown as { _resolveFilename: (id: string, options: unknown) => string })._resolveFilename(
-    id,
-    opts,
-  ),
-  builtin: false,
-});
-
-describe('Module', () => {
-  let tmpDir: string;
-
-  afterEach(() => {
-    Module.invalidate();
-
-    if (tmpDir) {
-      fs.rmSync(tmpDir, { recursive: true, force: true });
-    }
-  });
-
-  describe('evaluate', () => {
-    it('wraps VM errors as host Error with filename context', () => {
-      tmpDir = fs.realpathSync(fs.mkdtempSync(path.join(os.tmpdir(), 'griffel-module-test-')));
-
-      const childFile = path.join(tmpDir, 'child.js');
-      fs.writeFileSync(childFile, 'const x = undefined;\nx.foo;');
-
-      const entryFile = path.join(tmpDir, 'entry.js');
-      fs.writeFileSync(entryFile, '');
-
-      const m = new Module(entryFile, defaultRules, defaultResolve);
-
-      try {
-        m.evaluate(`const child = require("./child.js");`, ['child']);
-        expect.unreachable('should have thrown');
-      } catch (e) {
-        // Must be a proper host Error instance (not a VM context Error that webpack wraps as NonErrorEmittedError)
-        expect(e).toBeInstanceOf(Error);
-
-        const err = e as Error;
-        // Replace machine-specific paths and line numbers so snapshots are stable across environments
-        const repoRoot = path.resolve(__dirname, '../../../..');
-        const normalize = (s: string) =>
-          s
-            .split(tmpDir).join('<tmpDir>')
-            .split(repoRoot).join('<repo>')
-            .replace(/:\d+(:\d+)?/g, ':<line>');
-
-        expect(normalize(err.message)).toMatchInlineSnapshot(
-          `"Cannot read properties of undefined (reading 'foo')"`,
-        );
-        expect(normalize(err.stack!)).toMatchInlineSnapshot(`
-          "<repo>/packages/transform/src/evaluation/module.mts:<line>
-          			throw hostError;
-          			^
-
-          <tmpDir>/child.js:<line>
-          x.foo;
-            ^
-
-          TypeError: Cannot read properties of undefined (reading 'foo')
-              at <tmpDir>/child.js:<line>
-              at <tmpDir>/child.js:<line>
-              at Script.runInContext (node:vm:<line>)
-              at Module.evaluate (<repo>/packages/transform/src/evaluation/module.mts:<line>)
-              at require.Object.assign.ensure (<repo>/packages/transform/src/evaluation/module.mts:<line>)
-              at <tmpDir>/entry.js:<line>
-              at <tmpDir>/entry.js:<line>
-              at Script.runInContext (node:vm:<line>)
-              at Module.evaluate (<repo>/packages/transform/src/evaluation/module.mts:<line>)
-              at <repo>/packages/transform/src/evaluation/module.test.mts:<line>"
-        `);
-      }
-    });
-  });
-
-  describe('require (asset handling)', () => {
-    it('wraps non-JS/JSON requires with asset tags containing absolute path', () => {
-      tmpDir = fs.realpathSync(fs.mkdtempSync(path.join(os.tmpdir(), 'griffel-module-test-')));
-
-      const jpgFile = path.join(tmpDir, 'test.jpg');
-      fs.writeFileSync(jpgFile, '');
-
-      const entryFile = path.join(tmpDir, 'entry.js');
-      fs.writeFileSync(entryFile, '');
-
-      const m = new Module(entryFile, defaultRules, defaultResolve);
-      const result = m.require('./test.jpg');
-
-      expect(result).toBe(ASSET_TAG_OPEN + jpgFile + ASSET_TAG_CLOSE);
-    });
-
-    it('wraps .png requires with asset tags', () => {
-      tmpDir = fs.realpathSync(fs.mkdtempSync(path.join(os.tmpdir(), 'griffel-module-test-')));
-
-      const pngFile = path.join(tmpDir, 'icon.png');
-      fs.writeFileSync(pngFile, '');
-
-      const entryFile = path.join(tmpDir, 'entry.js');
-      fs.writeFileSync(entryFile, '');
-
-      const m = new Module(entryFile, defaultRules, defaultResolve);
-      const result = m.require('./icon.png');
-
-      expect(result).toBe(ASSET_TAG_OPEN + pngFile + ASSET_TAG_CLOSE);
-    });
-
-    it('does not wrap .json requires with asset tags', () => {
-      tmpDir = fs.realpathSync(fs.mkdtempSync(path.join(os.tmpdir(), 'griffel-module-test-')));
-
-      const jsonFile = path.join(tmpDir, 'data.json');
-      fs.writeFileSync(jsonFile, '{"key": "value"}');
-
-      const entryFile = path.join(tmpDir, 'entry.js');
-      fs.writeFileSync(entryFile, '');
-
-      const m = new Module(entryFile, defaultRules, defaultResolve);
-      const result = m.require('./data.json');
-
-      expect(result).toEqual({ key: 'value' });
-    });
-  });
-});

package/src/evaluation/types.mts

@@ -1,49 +0,0 @@
-import type { Node, Program } from 'oxc-parser';
-
-// Types from @linaria/babel-preset, internalized to remove the dependency
-
-export type EvaluatorResult = {
-  code: string;
-  imports: Map<string, string[]> | null;
-  moduleKind: 'esm' | 'cjs';
-};
-
-export type EvalRule = {
-  test?: RegExp | ((path: string) => boolean);
-  action: Evaluator | 'ignore';
-};
-
-export type Evaluator = (
-  filename: string,
-  text: string,
-  only: string[] | null,
-) => EvaluatorResult;
-
-// Griffel-specific types
-
-export interface TransformPerfIssue {
-  type: 'cjs-module' | 'barrel-export-star';
-  /** The dependency file that caused the issue */
-  dependencyFilename: string;
-}
-
-export interface EvaluationResult {
-  confident: boolean;
-  value?: unknown;
-  error?: Error;
-}
-
-export interface AstEvaluatorContext {
-  /** Full program AST */
-  programAst: Program;
-  /** Recursive evaluator callback (goes through base + all plugins) */
-  evaluateNode: (node: Node) => unknown;
-}
-
-export interface AstEvaluatorPlugin {
-  name: string;
-  /**
-   * Evaluate an AST node. Return DEOPT symbol to signal "can't handle this".
-   */
-  evaluateNode: (node: Node, context: AstEvaluatorContext) => unknown;
-}

package/src/evaluation/vmEvaluator.mts

@@ -1,45 +0,0 @@
-import { Module } from './module.mjs';
-import type { TransformResolver } from './module.mjs';
-import type { EvalRule, EvaluationResult } from './types.mjs';
-
-function isError(e: unknown): e is Error {
-  return Object.prototype.toString.call(e) === '[object Error]';
-}
-
-export function vmEvaluator(
-  sourceCode: string,
-  filename: string,
-  expressionCode: string,
-  evaluationRules: EvalRule[],
-  resolveFilename: TransformResolver,
-): EvaluationResult {
-  // Create a simple wrapper program for evaluation
-  const codeForEvaluation = `
-${sourceCode}
-
-export const __mkPreval = (() => {
-  try {
-    return ([${expressionCode}]);
-  } catch (e) {
-    return e;
-  }
-})();
-`;
-
-  try {
-    const mod = new Module(filename, evaluationRules, resolveFilename);
-    // useEvalCache=false: each source file produces unique codeForEvaluation (different sourceCode +
-    // expressionCode), so the eval cache would never hit — skip the unnecessary hashing and map storage.
-    mod.evaluate(codeForEvaluation, ['__mkPreval'], /* useEvalCache */ false);
-
-    const result = (mod.exports as { __mkPreval: unknown }).__mkPreval;
-
-    if (isError(result)) {
-      return { confident: false, error: result };
-    }
-
-    return { confident: true, value: result };
-  } catch (err) {
-    return { confident: false, error: err as Error };
-  }
-}

package/src/evaluation/vmEvaluator.test.mts

@@ -1,30 +0,0 @@
-import NativeModule from 'node:module';
-import { describe, expect, it } from 'vitest';
-import shakerEvaluator from '@griffel/transform-shaker';
-import { vmEvaluator } from './vmEvaluator.mjs';
-import type { TransformResolver } from './module.mjs';
-
-const evaluationRules = [
-  {
-    test: /[/\\]node_modules[/\\]/,
-    action: 'ignore' as const,
-  },
-  {
-    action: shakerEvaluator,
-  },
-];
-
-const defaultResolve: TransformResolver = (id, opts) => ({
-  path: (NativeModule as unknown as { _resolveFilename: (id: string, options: unknown) => string })._resolveFilename(id, opts),
-  builtin: false,
-});
-
-describe('evaluateStyleExpression', () => {
-  it('evaluates expressions with source code context', () => {
-    const sourceCode = 'const color = "blue"; const size = 16;';
-    const result = vmEvaluator(sourceCode, '/test.ts', '{ color, fontSize: size }', evaluationRules, defaultResolve);
-
-    expect(result.confident).toBe(true);
-    expect(result.value).toEqual([{ color: 'blue', fontSize: 16 }]);
-  });
-});