fix: Add missing output path (#63)

nsdeschenes · web-flow · commit c755a5c08d44 · 2024-01-31T14:31:03.000-04:00
Add in outputPath to the outputted stats file, as this was missing.
diff --git a/.changeset/tasty-adults-design.md b/.changeset/tasty-adults-design.md
@@ -0,0 +1,8 @@
+---
+"@codecov/bundler-plugin-core": patch
+"@codecov/webpack-plugin": patch
+"@codecov/rollup-plugin": patch
+"@codecov/vite-plugin": patch
+---
+
+Add missing outputPath to output stats file
diff --git a/integration-tests/fixtures/generate-bundle-stats/rollup/__snapshots__/rollup-v3-plugin.test.ts.snap b/integration-tests/fixtures/generate-bundle-stats/rollup/__snapshots__/rollup-v3-plugin.test.ts.snap
@@ -60,6 +60,7 @@ exports[`Generating rollup stats version 3 matches the snapshot 1`] = `
       "size": 168,
     },
   ],
+  "outputPath": StringContaining "/distV3",
   "plugin": {
     "name": "codecov-rollup-bundle-analysis-plugin",
     "version": "1.0.0",
diff --git a/integration-tests/fixtures/generate-bundle-stats/rollup/__snapshots__/rollup-v4-plugin.test.ts.snap b/integration-tests/fixtures/generate-bundle-stats/rollup/__snapshots__/rollup-v4-plugin.test.ts.snap
@@ -60,6 +60,7 @@ exports[`Generating rollup stats version 4 matches the snapshot 1`] = `
       "size": 168,
     },
   ],
+  "outputPath": StringContaining "/distV4",
   "plugin": {
     "name": "codecov-rollup-bundle-analysis-plugin",
     "version": "1.0.0",
diff --git a/integration-tests/fixtures/generate-bundle-stats/rollup/rollup-v3-plugin.test.ts b/integration-tests/fixtures/generate-bundle-stats/rollup/rollup-v3-plugin.test.ts
@@ -54,6 +54,7 @@ describe("Generating rollup stats", () => {
       expect(stats).toMatchSnapshot({
         builtAt: expect.any(Number),
         duration: expect.any(Number),
+        outputPath: expect.stringContaining("/distV3"),
       });
     });
   });
diff --git a/integration-tests/fixtures/generate-bundle-stats/rollup/rollup-v4-plugin.test.ts b/integration-tests/fixtures/generate-bundle-stats/rollup/rollup-v4-plugin.test.ts
@@ -62,6 +62,7 @@ describe("Generating rollup stats", () => {
       expect(stats).toMatchSnapshot({
         builtAt: expect.any(Number),
         duration: expect.any(Number),
+        outputPath: expect.stringContaining("/distV4"),
       });
     });
   });
diff --git a/integration-tests/fixtures/generate-bundle-stats/vite/__snapshots__/vite-v4-plugin.test.ts.snap b/integration-tests/fixtures/generate-bundle-stats/vite/__snapshots__/vite-v4-plugin.test.ts.snap
@@ -81,6 +81,7 @@ exports[`Generating vite stats version 4 matches the snapshot 1`] = `
       "size": 0,
     },
   ],
+  "outputPath": StringContaining "/distV4",
   "plugin": {
     "name": "codecov-vite-bundle-analysis-plugin",
     "version": "1.0.0",
diff --git a/integration-tests/fixtures/generate-bundle-stats/vite/__snapshots__/vite-v5-plugin.test.ts.snap b/integration-tests/fixtures/generate-bundle-stats/vite/__snapshots__/vite-v5-plugin.test.ts.snap
@@ -81,6 +81,7 @@ exports[`Generating vite stats version 5 matches the snapshot 1`] = `
       "size": 0,
     },
   ],
+  "outputPath": StringContaining "/distV5",
   "plugin": {
     "name": "codecov-vite-bundle-analysis-plugin",
     "version": "1.0.0",
diff --git a/integration-tests/fixtures/generate-bundle-stats/vite/vite-v4-plugin.test.ts b/integration-tests/fixtures/generate-bundle-stats/vite/vite-v4-plugin.test.ts
@@ -53,6 +53,7 @@ describe("Generating vite stats", () => {
       expect(stats).toMatchSnapshot({
         builtAt: expect.any(Number),
         duration: expect.any(Number),
+        outputPath: expect.stringContaining("/distV4"),
       });
     });
   });
diff --git a/integration-tests/fixtures/generate-bundle-stats/vite/vite-v5-plugin.test.ts b/integration-tests/fixtures/generate-bundle-stats/vite/vite-v5-plugin.test.ts
@@ -53,6 +53,7 @@ describe("Generating vite stats", () => {
       expect(stats).toMatchSnapshot({
         builtAt: expect.any(Number),
         duration: expect.any(Number),
+        outputPath: expect.stringContaining("/distV5"),
       });
     });
   });
diff --git a/integration-tests/fixtures/generate-bundle-stats/webpack/__snapshots__/webpack-v5-plugin.test.ts.snap b/integration-tests/fixtures/generate-bundle-stats/webpack/__snapshots__/webpack-v5-plugin.test.ts.snap
@@ -65,6 +65,7 @@ exports[`Generating webpack stats version 5 matches the snapshot 1`] = `
       "size": 123,
     },
   ],
+  "outputPath": StringContaining "/dist",
   "plugin": {
     "name": "codecov-webpack-bundle-analysis-plugin",
     "version": "1.0.0",
diff --git a/integration-tests/fixtures/generate-bundle-stats/webpack/webpack-v5-plugin.test.ts b/integration-tests/fixtures/generate-bundle-stats/webpack/webpack-v5-plugin.test.ts
@@ -60,6 +60,7 @@ describe("Generating webpack stats", () => {
       expect(stats).toMatchSnapshot({
         builtAt: expect.any(Number),
         duration: expect.any(Number),
+        outputPath: expect.stringContaining("/dist"),
       });
     });
   });
diff --git a/packages/bundler-plugin-core/src/bundle-analysis/__tests__/__snapshots__/bundleAnalysisPluginFactory.test.ts.snap b/packages/bundler-plugin-core/src/bundle-analysis/__tests__/__snapshots__/bundleAnalysisPluginFactory.test.ts.snap
@@ -0,0 +1,10 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`bundleAnalysisPluginFactory returns a plugin functions 1`] = `
+{
+  "buildEnd": [Function],
+  "buildStart": [Function],
+  "name": "plugin-name",
+  "writeBundle": [Function],
+}
+`;
diff --git a/packages/bundler-plugin-core/src/bundle-analysis/__tests__/bundleAnalysisPluginFactory.test.ts b/packages/bundler-plugin-core/src/bundle-analysis/__tests__/bundleAnalysisPluginFactory.test.ts
@@ -1,7 +1,7 @@
 import { bundleAnalysisPluginFactory } from "../bundleAnalysisPluginFactory";
 
 describe("bundleAnalysisPluginFactory", () => {
-  it("returns a build start function", () => {
+  it("returns a plugin functions", () => {
     const plugin = bundleAnalysisPluginFactory({
       userOptions: { bundleName: "test" },
       bundleAnalysisUploadPlugin: () => ({
@@ -11,32 +11,6 @@ describe("bundleAnalysisPluginFactory", () => {
       }),
     });
 
-    expect(plugin.buildStart).toEqual(expect.any(Function));
-  });
-
-  it("returns a build end function", () => {
-    const plugin = bundleAnalysisPluginFactory({
-      userOptions: { bundleName: "test" },
-      bundleAnalysisUploadPlugin: () => ({
-        version: "1",
-        name: "plugin-name",
-        pluginVersion: "1.0.0",
-      }),
-    });
-
-    expect(plugin.buildEnd).toEqual(expect.any(Function));
-  });
-
-  it("returns a write bundle function", () => {
-    const plugin = bundleAnalysisPluginFactory({
-      userOptions: { bundleName: "test" },
-      bundleAnalysisUploadPlugin: () => ({
-        version: "1",
-        name: "plugin-name",
-        pluginVersion: "1.0.0",
-      }),
-    });
-
-    expect(plugin.writeBundle).toEqual(expect.any(Function));
+    expect(plugin).toMatchSnapshot();
   });
 });
diff --git a/packages/rollup-plugin/src/rollup-bundle-analysis/__tests__/__snapshots__/rollupBundleAnalysisPlugin.test.ts.snap b/packages/rollup-plugin/src/rollup-bundle-analysis/__tests__/__snapshots__/rollupBundleAnalysisPlugin.test.ts.snap
@@ -0,0 +1,12 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`rollupBundleAnalysisPlugin when called returns a plugin object 1`] = `
+{
+  "name": "codecov-rollup-bundle-analysis-plugin",
+  "pluginVersion": "1.0.0",
+  "rollup": {
+    "generateBundle": [Function],
+  },
+  "version": "1",
+}
+`;
diff --git a/packages/rollup-plugin/src/rollup-bundle-analysis/__tests__/rollupBundleAnalysisPlugin.test.ts b/packages/rollup-plugin/src/rollup-bundle-analysis/__tests__/rollupBundleAnalysisPlugin.test.ts
@@ -12,10 +12,7 @@ describe("rollupBundleAnalysisPlugin", () => {
         },
       });
 
-      expect(plugin.version).toEqual("1");
-      expect(plugin.name).toEqual("codecov-rollup-bundle-analysis-plugin");
-      expect(plugin.pluginVersion).toEqual("1.0.0");
-      expect(plugin.rollup?.generateBundle).toEqual(expect.any(Function));
+      expect(plugin).toMatchSnapshot();
     });
   });
 });
diff --git a/packages/rollup-plugin/src/rollup-bundle-analysis/rollupBundleAnalysisPlugin.ts b/packages/rollup-plugin/src/rollup-bundle-analysis/rollupBundleAnalysisPlugin.ts
@@ -144,6 +144,7 @@ export const rollupBundleAnalysisPlugin: BundleAnalysisUploadPlugin = ({
       output.assets = assets;
       output.chunks = chunks;
       output.modules = modules;
+      output.outputPath = options.dir ?? "";
 
       // only output file if running dry run
       if (userOptions?.dryRun) {
diff --git a/packages/vite-plugin/src/vite-bundle-analysis/__tests__/__snapshots__/viteBundleAnalysisPlugin.test.ts.snap b/packages/vite-plugin/src/vite-bundle-analysis/__tests__/__snapshots__/viteBundleAnalysisPlugin.test.ts.snap
@@ -0,0 +1,12 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`viteBundleAnalysisPlugin when called returns a plugin object 1`] = `
+{
+  "name": "codecov-vite-bundle-analysis-plugin",
+  "pluginVersion": "1.0.0",
+  "version": "1",
+  "vite": {
+    "generateBundle": [Function],
+  },
+}
+`;
diff --git a/packages/vite-plugin/src/vite-bundle-analysis/__tests__/viteBundleAnalysisPlugin.test.ts b/packages/vite-plugin/src/vite-bundle-analysis/__tests__/viteBundleAnalysisPlugin.test.ts
@@ -12,10 +12,7 @@ describe("viteBundleAnalysisPlugin", () => {
         },
       });
 
-      expect(plugin.version).toEqual("1");
-      expect(plugin.name).toEqual("codecov-vite-bundle-analysis-plugin");
-      expect(plugin.pluginVersion).toEqual("1.0.0");
-      expect(plugin.vite?.generateBundle).toEqual(expect.any(Function));
+      expect(plugin).toMatchSnapshot();
     });
   });
 });
diff --git a/packages/vite-plugin/src/vite-bundle-analysis/viteBundleAnalysisPlugin.ts b/packages/vite-plugin/src/vite-bundle-analysis/viteBundleAnalysisPlugin.ts
@@ -146,6 +146,7 @@ export const viteBundleAnalysisPlugin: BundleAnalysisUploadPlugin = ({
       output.assets = assets;
       output.chunks = chunks;
       output.modules = modules;
+      output.outputPath = options.dir ?? "";
 
       // only output file if running dry run
       if (userOptions?.dryRun) {
diff --git a/packages/webpack-plugin/src/webpack-bundle-analysis/__tests__/__snapshots__/webpackBundleAnalysisPlugin.test.ts.snap b/packages/webpack-plugin/src/webpack-bundle-analysis/__tests__/__snapshots__/webpackBundleAnalysisPlugin.test.ts.snap
@@ -0,0 +1,10 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`webpackBundleAnalysisPlugin when called returns a plugin object 1`] = `
+{
+  "name": "codecov-webpack-bundle-analysis-plugin",
+  "pluginVersion": "1.0.0",
+  "version": "1",
+  "webpack": [Function],
+}
+`;
diff --git a/packages/webpack-plugin/src/webpack-bundle-analysis/__tests__/webpackBundleAnalysisPlugin.test.ts b/packages/webpack-plugin/src/webpack-bundle-analysis/__tests__/webpackBundleAnalysisPlugin.test.ts
@@ -12,10 +12,7 @@ describe("webpackBundleAnalysisPlugin", () => {
         },
       });
 
-      expect(plugin.version).toEqual("1");
-      expect(plugin.name).toEqual("codecov-webpack-bundle-analysis-plugin");
-      expect(plugin.pluginVersion).toEqual("1.0.0");
-      expect(plugin.webpack).toEqual(expect.any(Function));
+      expect(plugin).toMatchSnapshot();
     });
   });
 });
diff --git a/packages/webpack-plugin/src/webpack-bundle-analysis/webpackBundleAnalysisPlugin.ts b/packages/webpack-plugin/src/webpack-bundle-analysis/webpackBundleAnalysisPlugin.ts
@@ -131,6 +131,7 @@ export const webpackBundleAnalysisPlugin: BundleAnalysisUploadPlugin = ({
           }
 
           output.duration = Date.now() - (output.builtAt ?? 0);
+          output.outputPath = outputOptions.path ?? "";
 
           // only output file if running dry run
           if (userOptions?.dryRun) {
