feat: Add in Provider Utils to Grab Env Vars (#9)

Add in some util functions that grab provider env values that will be sent in the post request, alongside tests for the first time.

Author: nsdeschenes

package.json

@@ -27,7 +27,7 @@
     "eslint-plugin-isaacscript": "^3.5.6",
     "eslint-plugin-prettier": "^5.0.1",
     "prettier": "^3.0.3",
-    "typescript": "^5.2.2"
+    "typescript": "^5.3.2"
   },
   "volta": {
     "node": "20.9.0"

packages/bundler-plugin-core/jest.config.ts

@@ -0,0 +1,38 @@
+import { type Config } from "jest";
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const packageJson = require("./package.json") as { version: string };
+
+const config: Config = {
+  testEnvironment: "node",
+  collectCoverageFrom: [
+    "src/**/*.ts",
+    "src/**/*.tsx",
+    "!**/node_modules/**",
+    "!test/helpers.ts",
+  ],
+  moduleNameMapper: {
+    "^@/(.*)$": "<rootDir>/src/$1",
+    "^@test-utils/(.*)$": "<rootDir>/test-utils/$1",
+  },
+  transform: {
+    "^.+\\.(t|j)sx?$": [
+      "@swc/jest",
+      {
+        jsc: {
+          transform: {
+            optimizer: {
+              globals: {
+                vars: {
+                  __PACKAGE_VERSION__: packageJson.version,
+                },
+              },
+            },
+          },
+        },
+      },
+    ],
+  },
+};
+
+export default config;

packages/bundler-plugin-core/package.json

@@ -29,20 +29,30 @@
     "lint": "eslint . --ext .ts,.tsx",
     "lint:fix": "pnpm lint --fix",
     "format": "prettier '**/*.{cjs,mjs,ts,tsx,md,json}' --ignore-path ../.gitignore --ignore-unknown --no-error-on-unmatched-pattern --write",
-    "format:check": "prettier '**/*.{cjs,mjs,ts,tsx,md,json}' --ignore-path ../.gitignore --ignore-unknown --no-error-on-unmatched-pattern --check"
+    "format:check": "prettier '**/*.{cjs,mjs,ts,tsx,md,json}' --ignore-path ../.gitignore --ignore-unknown --no-error-on-unmatched-pattern --check",
+    "test:unit": "jest",
+    "test:unit:ci": "jest --coverage"
   },
   "keywords": [],
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
     "chalk": "4.1.2",
     "semver": "^7.5.4",
+    "testdouble": "^3.20.1",
+    "testdouble-jest": "^2.0.0",
     "unplugin": "^1.5.0",
     "zod": "^3.22.4"
   },
   "devDependencies": {
+    "@swc/core": "^1.3.99",
+    "@swc/jest": "^0.2.29",
+    "@types/jest": "^29.5.10",
     "@types/node": "^20.8.6",
     "@types/semver": "^7.5.5",
+    "jest": "^29.7.0",
+    "msw": "^2.0.8",
+    "ts-node": "^10.9.1",
     "typescript": "^5.0.4",
     "unbuild": "^2.0.0"
   },

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

@@ -9,10 +9,10 @@ import {
   type Module,
   type Options,
   type Output,
-} from "./types.js";
+} from "./types.ts";
 
-import { jsonSchema } from "./schemas.js";
-import { red } from "./utils/logging.js";
+import { jsonSchema } from "./schemas.ts";
+import { red } from "./utils/logging.ts";
 
 const NODE_VERSION_RANGE = ">=18.18.0";
 
@@ -49,6 +49,7 @@ export function codecovUnpluginFactory({
         bundleAnalysisUploadPlugin({
           output,
           statsFileName,
+          uploaderOverrides: userOptions?.uploaderOverrides,
         });
 
       plugins.push({

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

@@ -47,12 +47,13 @@ export interface Output {
 export interface BundleAnalysisUploadPluginArgs {
   output: Output;
   statsFileName?: string;
+  uploaderOverrides?: UploadOverrides;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface Options {
   statsFileName?: string;
   enableBundleAnalysis?: boolean;
+  uploaderOverrides?: UploadOverrides;
 }
 
 export type BundleAnalysisUploadPlugin = (
@@ -61,3 +62,54 @@ export type BundleAnalysisUploadPlugin = (
   pluginVersion: string;
   version: string;
 };
+
+export interface UploadOverrides {
+  /** Specify the branch manually. */
+  branch?: string;
+  /** Specify the build number manually. */
+  build?: string;
+  /** The commit SHA of the parent for which you are uploading coverage. */
+  parent?: string;
+  /** Specify the pull request number manually. */
+  pr?: string;
+  /** Specify the commit SHA manually. */
+  sha?: string;
+  /** Specify the slug manually. */
+  slug?: string;
+  /** Specify the tag manually. */
+  tag?: string;
+  /** Change the upload host (Enterprise use). */
+  url?: string;
+}
+
+export type ProviderEnvs = NodeJS.Dict<string>;
+
+export interface ProviderUtilInputs {
+  envs: ProviderEnvs;
+  args: Options["uploaderOverrides"];
+}
+
+export interface ProviderUtil {
+  detect: (arg0: ProviderEnvs) => boolean;
+  getServiceName: () => string;
+  getServiceParams: (
+    arg0: ProviderUtilInputs,
+  ) => Promise<ProviderServiceParams>;
+  getEnvVarNames: () => string[];
+}
+
+export interface ProviderServiceParams {
+  branch: string;
+  build: string;
+  buildURL: string;
+  commit: string;
+  job: string;
+  pr: string;
+  service: string;
+  slug: string;
+  name?: string;
+  tag?: string;
+  parent?: string;
+  project?: string;
+  server_uri?: string;
+}

packages/bundler-plugin-core/src/utils/constants.ts

@@ -0,0 +1 @@
+export const SPAWN_PROCESS_BUFFER_SIZE = 1_048_576 * 100; // 100 MiB

packages/bundler-plugin-core/src/utils/git.ts

@@ -0,0 +1,42 @@
+import { runExternalProgram } from "./runExternalProgram.ts";
+
+export function parseSlug(slug: unknown): string {
+  // origin    https://github.com/torvalds/linux.git (fetch)
+  // git@github.com: codecov / uploader.git
+  if (typeof slug !== "string") {
+    return "";
+  }
+
+  if (slug.match(/^(ssh|https?):/)) {
+    // Type is http(s) or ssh
+    const phaseOne = slug.split("//")[1]?.replace(".git", "") ?? "";
+    const phaseTwo = phaseOne?.split("/") ?? "";
+    const cleanSlug =
+      phaseTwo.length > 2 ? `${phaseTwo[1]}/${phaseTwo[2]}` : "";
+    return cleanSlug;
+  }
+
+  if (slug.match("@")) {
+    // Type is git
+    const cleanSlug = slug.split(":")[1]?.replace(".git", "");
+    return cleanSlug ?? "";
+  }
+
+  throw new Error(`Unable to parse slug URL: ${slug}`);
+}
+
+export function parseSlugFromRemoteAddr(remoteAddr?: string): string {
+  const addr =
+    remoteAddr ??
+    runExternalProgram("git", ["config", "--get", "remote.origin.url"]) ??
+    "";
+  if (!addr) {
+    return "";
+  }
+
+  const slug = parseSlug(addr);
+  if (slug === "/") {
+    return "";
+  }
+  return slug;
+}

packages/bundler-plugin-core/src/utils/isProgramInstalled.ts

@@ -0,0 +1,5 @@
+import childprocess from "child_process";
+
+export function isProgramInstalled(programName: string): boolean {
+  return !childprocess.spawnSync(programName).error;
+}

packages/bundler-plugin-core/src/utils/provider.ts

@@ -0,0 +1,20 @@
+export function setSlug(
+  slugArg: string | undefined,
+  orgEnv: string | undefined,
+  repoEnv: string | undefined,
+) {
+  if (typeof slugArg !== "undefined" && slugArg !== "") {
+    return slugArg;
+  }
+
+  if (
+    typeof orgEnv !== "undefined" &&
+    typeof repoEnv !== "undefined" &&
+    orgEnv !== "" &&
+    repoEnv !== ""
+  ) {
+    return `${orgEnv}/${repoEnv}`;
+  }
+
+  return "";
+}

packages/bundler-plugin-core/src/utils/providers/AppVeyorCI.ts

@@ -0,0 +1,112 @@
+import {
+  type ProviderEnvs,
+  type ProviderServiceParams,
+  type ProviderUtilInputs,
+} from "@/types.ts";
+
+export function detect(envs: ProviderEnvs): boolean {
+  return (
+    (envs?.CI === "true" || envs?.CI === "True") &&
+    (envs?.APPVEYOR === "true" || envs?.APPVEYOR === "True")
+  );
+}
+
+function _getBuild(inputs: ProviderUtilInputs) {
+  const { args, envs } = inputs;
+  return args?.build ?? envs?.APPVEYOR_JOB_ID ?? "";
+}
+
+function _getBuildURL(inputs: ProviderUtilInputs) {
+  const { envs } = inputs;
+  if (
+    envs?.APPVEYOR_URL &&
+    envs?.APPVEYOR_REPO_NAME &&
+    envs?.APPVEYOR_BUILD_ID &&
+    envs?.APPVEYOR_JOB_ID
+  ) {
+    return `${envs?.APPVEYOR_URL}/project/${envs?.APPVEYOR_REPO_NAME}/builds/${envs?.APPVEYOR_BUILD_ID}/job/${envs?.APPVEYOR_JOB_ID}`;
+  }
+  return "";
+}
+
+function _getBranch(inputs: ProviderUtilInputs) {
+  const { args, envs } = inputs;
+  if (args?.branch && args?.branch !== "") {
+    return args?.branch;
+  }
+
+  return envs?.APPVEYOR_REPO_BRANCH ?? "";
+}
+
+function _getJob(envs: ProviderEnvs) {
+  if (
+    envs?.APPVEYOR_ACCOUNT_NAME &&
+    envs?.APPVEYOR_PROJECT_SLUG &&
+    envs?.APPVEYOR_BUILD_VERSION
+  ) {
+    return `${envs?.APPVEYOR_ACCOUNT_NAME}/${envs?.APPVEYOR_PROJECT_SLUG}/${envs?.APPVEYOR_BUILD_VERSION}`;
+  }
+  return "";
+}
+
+function _getPR(inputs: ProviderUtilInputs): string {
+  const { args, envs } = inputs;
+  return args?.pr ?? envs?.APPVEYOR_PULL_REQUEST_NUMBER ?? "";
+}
+
+function _getService() {
+  return "appveyor";
+}
+
+export function getServiceName(): string {
+  return "Appveyor CI";
+}
+
+function _getSHA(inputs: ProviderUtilInputs) {
+  const { args, envs } = inputs;
+  return (
+    args?.sha ??
+    envs?.APPVEYOR_PULL_REQUEST_HEAD_COMMIT ??
+    envs?.APPVEYOR_REPO_COMMIT ??
+    ""
+  );
+}
+
+function _getSlug(inputs: ProviderUtilInputs) {
+  const { args, envs } = inputs;
+  return args?.slug ?? envs?.APPVEYOR_REPO_NAME ?? "";
+}
+
+// eslint-disable-next-line @typescript-eslint/require-await
+export async function getServiceParams(
+  inputs: ProviderUtilInputs,
+): Promise<ProviderServiceParams> {
+  return {
+    branch: _getBranch(inputs),
+    build: _getBuild(inputs),
+    buildURL: _getBuildURL(inputs),
+    commit: _getSHA(inputs),
+    job: _getJob(inputs.envs),
+    pr: _getPR(inputs),
+    service: _getService(),
+    slug: _getSlug(inputs),
+  };
+}
+
+export function getEnvVarNames(): string[] {
+  return [
+    "APPVEYOR",
+    "APPVEYOR_ACCOUNT_NAME",
+    "APPVEYOR_BUILD_ID",
+    "APPVEYOR_BUILD_VERSION",
+    "APPVEYOR_JOB_ID",
+    "APPVEYOR_PROJECT_SLUG",
+    "APPVEYOR_PULL_REQUEST_HEAD_COMMIT",
+    "APPVEYOR_PULL_REQUEST_NUMBER",
+    "APPVEYOR_REPO_BRANCH",
+    "APPVEYOR_REPO_COMMIT",
+    "APPVEYOR_REPO_NAME",
+    "APPVEYOR_URL",
+    "CI",
+  ];
+}