From 3d53bba7a7a524bc7a715ef95b04ad0552bd2be7 Mon Sep 17 00:00:00 2001 From: Yousif Ahmed Date: Tue, 9 Apr 2024 15:30:47 +0100 Subject: [PATCH] test: add unit tests for preserving path separators in source maps --- .../__test__/StripProjectRoot.test.ts | 22 ++++++ .../fixtures/typescript-windows/.gitignore | 1 + .../fixtures/typescript-windows/dist/out.js | 18 +++++ .../typescript-windows/dist/out.js.map | 1 + .../fixtures/typescript-windows/index.ts | 3 + .../fixtures/typescript-windows/lib/a.ts | 3 + .../fixtures/typescript-windows/tsconfig.json | 69 +++++++++++++++++++ 7 files changed, 117 insertions(+) create mode 100644 src/transformers/__test__/fixtures/typescript-windows/.gitignore create mode 100644 src/transformers/__test__/fixtures/typescript-windows/dist/out.js create mode 100644 src/transformers/__test__/fixtures/typescript-windows/dist/out.js.map create mode 100644 src/transformers/__test__/fixtures/typescript-windows/index.ts create mode 100644 src/transformers/__test__/fixtures/typescript-windows/lib/a.ts create mode 100644 src/transformers/__test__/fixtures/typescript-windows/tsconfig.json diff --git a/src/transformers/__test__/StripProjectRoot.test.ts b/src/transformers/__test__/StripProjectRoot.test.ts index 048c4c3..e109efe 100644 --- a/src/transformers/__test__/StripProjectRoot.test.ts +++ b/src/transformers/__test__/StripProjectRoot.test.ts @@ -54,4 +54,26 @@ test('StripProjectRoot transformer: webpack example with namespace', async () => 'webpack://this-package-name-is-used-in-the-source-paths/webpack/bootstrap', 'index.js' ]) +}) + +test('StripProjectRoot transformer: preserves path separators (posix)', async () => { + const projectRoot = path.join(__dirname, 'fixtures', 'typescript') + const absolutePath = path.join(projectRoot, 'dist', 'out.js.map') + const sourceMapJson = JSON.parse(await fs.readFile(absolutePath, 'utf-8')) + await StripProjectRoot(absolutePath, sourceMapJson, projectRoot, noopLogger) + expect(sourceMapJson.sources).toStrictEqual([ + path.join('lib/a.ts'), + 'index.ts' + ]) +}) + +test('StripProjectRoot transformer: preserves path separators (windows)', async () => { + const projectRoot = path.join(__dirname, 'fixtures', 'typescript-windows') + const absolutePath = path.join(projectRoot, 'dist', 'out.js.map') + const sourceMapJson = JSON.parse(await fs.readFile(absolutePath, 'utf-8')) + await StripProjectRoot(absolutePath, sourceMapJson, projectRoot, noopLogger) + expect(sourceMapJson.sources).toStrictEqual([ + path.join('lib\\a.ts'), + 'index.ts' + ]) }) \ No newline at end of file diff --git a/src/transformers/__test__/fixtures/typescript-windows/.gitignore b/src/transformers/__test__/fixtures/typescript-windows/.gitignore new file mode 100644 index 0000000..586e3d7 --- /dev/null +++ b/src/transformers/__test__/fixtures/typescript-windows/.gitignore @@ -0,0 +1 @@ +!dist \ No newline at end of file diff --git a/src/transformers/__test__/fixtures/typescript-windows/dist/out.js b/src/transformers/__test__/fixtures/typescript-windows/dist/out.js new file mode 100644 index 0000000..efca62f --- /dev/null +++ b/src/transformers/__test__/fixtures/typescript-windows/dist/out.js @@ -0,0 +1,18 @@ +var __importDefault = (this && this.__importDefault) || function (mod) { + return (mod && mod.__esModule) ? mod : { "default": mod }; +}; +define("lib/a", ["require", "exports"], function (require, exports) { + "use strict"; + Object.defineProperty(exports, "__esModule", { value: true }); + function a() { + console.log('hi from a'); + } + exports.default = a; +}); +define("index", ["require", "exports", "lib/a"], function (require, exports, a_1) { + "use strict"; + Object.defineProperty(exports, "__esModule", { value: true }); + a_1 = __importDefault(a_1); + a_1.default(); +}); +//# sourceMappingURL=out.js.map \ No newline at end of file diff --git a/src/transformers/__test__/fixtures/typescript-windows/dist/out.js.map b/src/transformers/__test__/fixtures/typescript-windows/dist/out.js.map new file mode 100644 index 0000000..70474ca --- /dev/null +++ b/src/transformers/__test__/fixtures/typescript-windows/dist/out.js.map @@ -0,0 +1 @@ +{"version":3,"file":"out.js","sourceRoot":"","sources":["..\\lib\\a.ts","..\\index.ts"],"names":[],"mappings":";;;;;;IAAA,SAAwB,CAAC;QACvB,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IAC1B,CAAC;IAFD,oBAEC;;;;;;ICAD,WAAC,EAAE,CAAA"} \ No newline at end of file diff --git a/src/transformers/__test__/fixtures/typescript-windows/index.ts b/src/transformers/__test__/fixtures/typescript-windows/index.ts new file mode 100644 index 0000000..4ef49d7 --- /dev/null +++ b/src/transformers/__test__/fixtures/typescript-windows/index.ts @@ -0,0 +1,3 @@ +import a from './lib/a' + +a() \ No newline at end of file diff --git a/src/transformers/__test__/fixtures/typescript-windows/lib/a.ts b/src/transformers/__test__/fixtures/typescript-windows/lib/a.ts new file mode 100644 index 0000000..8da1a0a --- /dev/null +++ b/src/transformers/__test__/fixtures/typescript-windows/lib/a.ts @@ -0,0 +1,3 @@ +export default function a(): void { + console.log('hi from a') +} \ No newline at end of file diff --git a/src/transformers/__test__/fixtures/typescript-windows/tsconfig.json b/src/transformers/__test__/fixtures/typescript-windows/tsconfig.json new file mode 100644 index 0000000..431a7ab --- /dev/null +++ b/src/transformers/__test__/fixtures/typescript-windows/tsconfig.json @@ -0,0 +1,69 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig.json to read more about this file */ + + /* Basic Options */ + // "incremental": true, /* Enable incremental compilation */ + "target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */ + "module": "amd", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */ + // "lib": [], /* Specify library files to be included in the compilation. */ + // "allowJs": true, /* Allow javascript files to be compiled. */ + // "checkJs": true, /* Report errors in .js files. */ + // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ + // "declaration": true, /* Generates corresponding '.d.ts' file. */ + // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + "sourceMap": true, /* Generates corresponding '.map' file. */ + "outFile": "./dist/out.js", /* Concatenate and emit output to single file. */ + // "outDir": "./", /* Redirect output structure to the directory. */ + // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + // "composite": true, /* Enable project compilation */ + // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ + // "removeComments": true, /* Do not emit comments to output. */ + // "noEmit": true, /* Do not emit outputs. */ + // "importHelpers": true, /* Import emit helpers from 'tslib'. */ + // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ + // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ + + /* Strict Type-Checking Options */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* Enable strict null checks. */ + // "strictFunctionTypes": true, /* Enable strict checking of function types. */ + // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ + // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ + // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ + // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ + + /* Additional Checks */ + // "noUnusedLocals": true, /* Report errors on unused locals. */ + // "noUnusedParameters": true, /* Report errors on unused parameters. */ + // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ + // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ + + /* Module Resolution Options */ + // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ + // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ + // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ + // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ + // "typeRoots": [], /* List of folders to include type definitions from. */ + // "types": [], /* Type declaration files to be included in compilation. */ + // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ + "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ + // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + + /* Source Map Options */ + // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ + // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ + + /* Experimental Options */ + // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ + // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ + + /* Advanced Options */ + "skipLibCheck": true, /* Skip type checking of declaration files. */ + "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */ + } +}