feat: Validate bundle name (#86)

Validate the provided bundle name to match how Sentry validates metric names via regex, as well as validate the other options for non-TypeScript users.

GH codecov/engineering-team#1255

Author: nsdeschenes

.changeset/flat-mails-buy.md

@@ -0,0 +1,8 @@
+---
+"@codecov/bundler-plugin-core": patch
+"@codecov/rollup-plugin": patch
+"@codecov/vite-plugin": patch
+"@codecov/webpack-plugin": patch
+---
+
+Normalize options to set default values as well as validate bundle names ensuring they follow the correct pattern.

.eslintrc.js

@@ -15,6 +15,7 @@ const config = {
     "**/node_modules/**",
     "**/test-apps/**",
     "**/integration-tests/**/*.cjs",
+    "**/integration-tests/test-api/**/*",
   ],
   parserOptions: {
     ecmaVersion: "latest",

integration-tests/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@codecov/plugin-integration-tests",
+  "name": "@codecov/integration-tests",
   "version": "1.0.0",
   "description": "",
   "private": true,

integration-tests/tsconfig.json

@@ -8,6 +8,6 @@
     "fixtures/**/*.cjs",
   ],
   "compilerOptions": {
-    "types": ["node", "jest"],
+    "types": ["node"],
   },
 }

package.json

@@ -10,9 +10,9 @@
     "build": "pnpm -r --filter='./packages/*' run build",
     "dev": "pnpm -r --parallel --filter='./packages/*' run dev",
     "clean": "pnpm -r --filter='./packages/*' clean && rm -rf node_modules",
-    "type-check": "pnpm -r --filter='./packages/*' --filter='integration-tests' run type-check",
-    "lint": "pnpm -r --filter='./packages/*' --filter='integration-tests' lint",
-    "lint:fix": "pnpm -r --filter='./packages/*' --filter='integration-tests' lint:fix",
+    "type-check": "pnpm -r --filter='./packages/*' run type-check",
+    "lint": "pnpm -r --filter='./packages/*' lint",
+    "lint:fix": "pnpm -r --filter='./packages/*' lint:fix",
     "format": "pnpm -r format && prettier --write '*.{cjs,json}' --ignore-unknown --no-error-on-unmatched-pattern",
     "format:check": "pnpm -r --filter='./packages/*' format:check && prettier --check '*.{cjs,json}' --ignore-unknown --no-error-on-unmatched-pattern",
     "test:unit": "pnpm -r --filter='./packages/*' run test:unit",

packages/bundler-plugin-core/src/bundle-analysis/__tests__/bundleAnalysisPluginFactory.test.ts

@@ -3,7 +3,14 @@ import { bundleAnalysisPluginFactory } from "../bundleAnalysisPluginFactory";
 describe("bundleAnalysisPluginFactory", () => {
   it("returns a plugin functions", () => {
     const plugin = bundleAnalysisPluginFactory({
-      userOptions: { bundleName: "test" },
+      options: {
+        bundleName: "test",
+        apiUrl: "http://localhost",
+        dryRun: true,
+        enableBundleAnalysis: true,
+        retryCount: 3,
+        uploadToken: "test-token",
+      },
       bundleAnalysisUploadPlugin: () => ({
         version: "1",
         name: "plugin-name",

packages/bundler-plugin-core/src/bundle-analysis/bundleAnalysisPluginFactory.ts

@@ -1,32 +1,32 @@
-import { detectProvider } from "../utils/provider.ts";
+import { type UnpluginOptions } from "unplugin";
 import {
   type BundleAnalysisUploadPlugin,
-  type Options,
   type Output,
   type ProviderUtilInputs,
   type UploadOverrides,
 } from "../types.ts";
-import { type UnpluginOptions } from "unplugin";
 import { getPreSignedURL } from "../utils/getPreSignedURL.ts";
+import { type NormalizedOptions } from "../utils/normalizeOptions.ts";
+import { detectProvider } from "../utils/provider.ts";
 import { uploadStats } from "../utils/uploadStats.ts";
 
 interface BundleAnalysisUploadPluginArgs {
-  userOptions: Options;
+  options: NormalizedOptions;
   bundleAnalysisUploadPlugin: BundleAnalysisUploadPlugin;
 }
 
 export const bundleAnalysisPluginFactory = ({
-  userOptions,
+  options,
   bundleAnalysisUploadPlugin,
 }: BundleAnalysisUploadPluginArgs): UnpluginOptions => {
   const output: Output = {
     version: "1",
-    bundleName: userOptions.bundleName ?? "",
+    bundleName: options.bundleName,
   };
 
   const { pluginVersion, version, ...pluginOpts } = bundleAnalysisUploadPlugin({
     output,
-    userOptions,
+    options,
   });
 
   output.version = version;
@@ -45,23 +45,23 @@ export const bundleAnalysisPluginFactory = ({
     },
     writeBundle: async () => {
       // don't need to do anything here if dryRun is true
-      if (userOptions?.dryRun) return;
+      if (options.dryRun) return;
 
       // don't need to do anything if the bundle name is not present or empty
-      if (!userOptions.bundleName || userOptions.bundleName === "") return;
+      if (!options.bundleName || options.bundleName === "") return;
 
-      const args: UploadOverrides = userOptions.uploadOverrides ?? {};
+      const args: UploadOverrides = options.uploadOverrides ?? {};
       const envs = process.env;
       const inputs: ProviderUtilInputs = { envs, args };
       const provider = await detectProvider(inputs);
 
       let url = "";
       try {
         url = await getPreSignedURL({
-          apiURL: userOptions?.apiUrl ?? "https://api.codecov.io",
-          uploadToken: userOptions?.uploadToken,
+          apiURL: options?.apiUrl ?? "https://api.codecov.io",
+          uploadToken: options?.uploadToken,
           serviceParams: provider,
-          retryCount: userOptions?.retryCount,
+          retryCount: options?.retryCount,
         });
       } catch (error) {
         return;
@@ -72,7 +72,7 @@ export const bundleAnalysisPluginFactory = ({
           preSignedUrl: url,
           bundleName: output.bundleName,
           message: JSON.stringify(output),
-          retryCount: userOptions?.retryCount,
+          retryCount: options?.retryCount,
         });
       } catch {}
     },

packages/bundler-plugin-core/src/index.ts

@@ -14,6 +14,7 @@ import {
 import { red } from "./utils/logging.ts";
 import { normalizePath } from "./utils/normalizePath.ts";
 import { bundleAnalysisPluginFactory } from "./bundle-analysis/bundleAnalysisPluginFactory.ts";
+import { normalizeOptions } from "./utils/normalizeOptions.ts";
 
 const NODE_VERSION_RANGE = ">=18.18.0";
 
@@ -27,6 +28,15 @@ function codecovUnpluginFactory({
   return createUnplugin<Options, true>((userOptions, unpluginMetaContext) => {
     const plugins: UnpluginOptions[] = [];
 
+    const normalizedOptions = normalizeOptions(userOptions);
+
+    if (!normalizedOptions.success) {
+      for (const error of normalizedOptions.errors) {
+        red(error);
+      }
+      return [];
+    }
+
     if (!satisfies(process.version, NODE_VERSION_RANGE)) {
       red(
         `Codecov ${unpluginMetaContext.framework} bundler plugin requires Node.js ${NODE_VERSION_RANGE}. You are using Node.js ${process.version}. Please upgrade your Node.js version.`,
@@ -35,10 +45,11 @@ function codecovUnpluginFactory({
       return plugins;
     }
 
-    if (userOptions?.enableBundleAnalysis) {
+    const options = normalizedOptions.options;
+    if (options?.enableBundleAnalysis) {
       plugins.push(
         bundleAnalysisPluginFactory({
-          userOptions,
+          options,
           bundleAnalysisUploadPlugin,
         }),
       );

packages/bundler-plugin-core/src/types.ts

@@ -1,4 +1,5 @@
 import { type UnpluginOptions } from "unplugin";
+import { type NormalizedOptions } from "./utils/normalizeOptions";
 
 export interface Dependency {
   name: string;
@@ -47,7 +48,7 @@ export interface Output {
 
 export interface BundleAnalysisUploadPluginArgs {
   output: Output;
-  userOptions: Options;
+  options: NormalizedOptions;
 }
 
 export interface Options {
@@ -76,12 +77,6 @@ export interface Options {
    */
   retryCount?: number;
 
-  /** Whether you would like bundle analysis to be enabled. */
-  enableBundleAnalysis?: boolean;
-
-  /** Override values for passing custom information to API. */
-  uploadOverrides?: UploadOverrides;
-
   /**
    * When enabled information will not be uploaded to Codecov.
    *
@@ -94,9 +89,21 @@ export interface Options {
    *
    * Required for uploading bundle analysis information.
    *
-   * Example: `rollup-package`
+   * The name must match the pattern `/^[\w\d_:/@\.{}\[\]$-]+$/`.
+   *
+   * Example: `@codecov/rollup-plugin`
    */
   bundleName?: string;
+
+  /**
+   * Whether you would like bundle analysis to be enabled. *
+   *
+   * Defaults to `false`
+   */
+  enableBundleAnalysis?: boolean;
+
+  /** Override values for passing custom information to API. */
+  uploadOverrides?: UploadOverrides;
 }
 
 export type BundleAnalysisUploadPlugin = (