Merge pull request #186 from DataDog/yoann/fix-vite-outdir-sourcemaps

[fix] Vite outDir for sourcemaps upload (take 2)

Author: yoannmoinet

packages/plugins/bundler-report/package.json

@@ -22,6 +22,7 @@
         "@dd/core": "workspace:*"
     },
     "devDependencies": {
+        "rollup": "4.24.2",
         "typescript": "5.4.3"
     }
 }

packages/plugins/bundler-report/src/helpers/rollup.test.ts

@@ -0,0 +1,168 @@
+// Unless explicitly stated otherwise all files in this repository are licensed under the MIT License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2019-Present Datadog, Inc.
+
+import { addFixtureFiles } from '@dd/tests/_jest/helpers/mocks';
+import type { InputOptions } from 'rollup';
+
+import { computeCwd, getOutDirFromOutputs } from './rollup';
+
+jest.mock('@dd/core/helpers/fs', () => {
+    const original = jest.requireActual('@dd/core/helpers/fs');
+    return {
+        ...original,
+        existsSync: jest.fn(),
+    };
+});
+
+describe('Rollup Helpers', () => {
+    describe('getOutDirFromOutputs', () => {
+        const cases = [
+            {
+                description: 'extract dir from single output object with dir',
+                outputOptions: { dir: 'dist' },
+                expected: 'dist',
+            },
+            {
+                description: 'extract dir from single output object with file',
+                outputOptions: { file: 'dist/bundle.js' },
+                expected: 'dist',
+            },
+            {
+                description: 'extract dir from array of outputs with dir',
+                outputOptions: [{ dir: 'dist' }, { dir: 'dist2' }],
+                expected: 'dist',
+            },
+            {
+                description: 'extract dir from array of outputs with file',
+                outputOptions: [{ file: 'dist/bundle.js' }, { file: 'dist2/bundle.js' }],
+                expected: 'dist',
+            },
+            {
+                description: 'prefer dir over file in same output',
+                outputOptions: { dir: 'dist', file: 'other/bundle.js' },
+                expected: 'dist',
+            },
+            {
+                description: 'handle nested file paths',
+                outputOptions: { file: 'dist/assets/js/bundle.js' },
+                expected: 'dist/assets/js',
+            },
+            {
+                description: 'return undefined for no outputOptions',
+                outputOptions: undefined,
+                expected: undefined,
+            },
+            {
+                description: 'return undefined for empty array',
+                outputOptions: [],
+                expected: undefined,
+            },
+            {
+                description: 'return undefined when no dir or file specified',
+                outputOptions: [{ format: 'esm' }, { format: 'cjs' }],
+                expected: undefined,
+            },
+        ];
+
+        test.each(cases)('Should $description', ({ outputOptions, expected }) => {
+            // Rollup doesn't type InputOptions['output'], yet it exists.
+            expect(getOutDirFromOutputs({ output: outputOptions } as InputOptions)).toBe(expected);
+        });
+    });
+
+    describe('computeCwd', () => {
+        beforeAll(() => {
+            jest.spyOn(process, 'cwd').mockReturnValue('/base/cwd');
+        });
+
+        beforeEach(() => {
+            // Set up virtual file system for package.json files
+            addFixtureFiles({
+                '/project/package.json': '',
+                '/project/src/package.json': '',
+                '/project/lib/package.json': '',
+                '/base/cwd/package.json': '',
+            });
+        });
+
+        const cases = [
+            {
+                description: 'handle string input',
+                options: { input: '/project/src/index.js' },
+                expected: '/project',
+            },
+            {
+                description: 'handle array input',
+                options: {
+                    input: ['/project/src/index.js', '/project/lib/util.js'],
+                },
+                expected: '/project',
+            },
+            {
+                description: 'handle object input',
+                options: {
+                    input: {
+                        main: '/project/src/index.js',
+                        util: '/project/lib/util.js',
+                    },
+                },
+                expected: '/project',
+            },
+            {
+                description: 'throw error for invalid input type in object',
+                options: { input: { main: 123 } },
+                shouldThrow: 'Invalid input type',
+            },
+            {
+                description: 'throw error for invalid input type in array',
+                options: { input: [123] },
+                shouldThrow: 'Invalid input type',
+            },
+            {
+                description: 'include absolute output directory in cwd computation',
+                options: {
+                    input: '/project/src/index.js',
+                    output: { dir: '/project/dist' },
+                },
+                expected: '/project',
+            },
+            {
+                description: 'ignore relative output directory',
+                options: {
+                    input: '/project/src/index.js',
+                    output: { dir: 'dist' },
+                },
+                expected: '/project',
+            },
+            {
+                description: 'fallback to process.cwd when no input',
+                options: {},
+                expected: '/base/cwd',
+            },
+            {
+                description: 'fallback to process.cwd with relative input',
+                options: { input: 'index.js' },
+                expected: '/base/cwd',
+            },
+        ];
+
+        test.each(cases)('Should $description', ({ options, expected, shouldThrow }) => {
+            const errors = [];
+            const results = [];
+            const expectedResults = expected ? [expected] : [];
+            const expectedErrors = shouldThrow ? [shouldThrow] : [];
+
+            try {
+                // Rollup doesn't type InputOptions['output'], yet it exists.
+                const result = computeCwd(options as InputOptions);
+                results.push(result);
+            } catch (error: any) {
+                errors.push(error.message);
+            }
+
+            expect(errors).toEqual(expectedErrors);
+            expect(results).toEqual(expectedResults);
+        });
+    });
+});

packages/plugins/bundler-report/src/helpers/rollup.ts

@@ -0,0 +1,82 @@
+// Unless explicitly stated otherwise all files in this repository are licensed under the MIT License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2019-Present Datadog, Inc.
+
+import { getHighestPackageJsonDir, getNearestCommonDirectory } from '@dd/core/helpers/paths';
+import path from 'path';
+import type { InputOptions } from 'rollup';
+
+// Compute the CWD based on a list of directories.
+const getCwd = (dirs: Set<string>) => {
+    const dirsToUse: Set<string> = new Set(dirs);
+    for (const dir of dirs) {
+        const highestPackage = getHighestPackageJsonDir(dir);
+        if (highestPackage && !dirs.has(highestPackage)) {
+            dirsToUse.add(highestPackage);
+        }
+    }
+
+    // Fall back to the nearest common directory.
+    const nearestDir = getNearestCommonDirectory(Array.from(dirsToUse));
+    if (nearestDir === path.sep) {
+        return undefined;
+    }
+    return nearestDir;
+};
+
+export const getOutDirFromOutputs = (options: InputOptions) => {
+    const hasOutput = 'output' in options && options.output;
+    if (!hasOutput) {
+        return undefined;
+    }
+
+    const outputOptions = options.output;
+    const normalizedOutputOptions = Array.isArray(outputOptions) ? outputOptions : [outputOptions];
+
+    // FIXME: This is an oversimplification, we should handle builds with multiple outputs.
+    // Ideally, `outDir` should only be computed for the build-report.
+    // And build-report should also handle multiple outputs.
+    for (const output of normalizedOutputOptions) {
+        if (output.dir) {
+            return output.dir;
+        }
+        if (output.file) {
+            return path.dirname(output.file);
+        }
+    }
+};
+
+export const computeCwd = (options: InputOptions) => {
+    const directoriesForCwd: Set<string> = new Set();
+
+    if (options.input) {
+        const normalizedInput = Array.isArray(options.input)
+            ? options.input
+            : typeof options.input === 'object'
+              ? Object.values(options.input)
+              : [options.input];
+
+        for (const input of normalizedInput) {
+            if (typeof input !== 'string') {
+                throw new Error('Invalid input type');
+            }
+            directoriesForCwd.add(path.dirname(input));
+        }
+    }
+
+    // In case an absolute path has been provided in the output options,
+    // we include it in the directories list for CWD computation.
+    const outDirFromOutputs = getOutDirFromOutputs(options);
+    if (outDirFromOutputs && path.isAbsolute(outDirFromOutputs)) {
+        directoriesForCwd.add(outDirFromOutputs);
+    }
+
+    const cwd = getCwd(directoriesForCwd);
+
+    if (cwd) {
+        return cwd;
+    }
+
+    // Fallback to process.cwd() as would Vite and Rollup do in their own process.
+    return process.cwd();
+};