@catladder/pipeline 1.45.0 → 1.47.0

package/src/context/index.ts

@@ -1,214 +1,13 @@
-import { isObject, merge } from "lodash";
-import slugify from "slugify";
 import { BUILD_TYPES } from "../build";
 import type { BuildConfig } from "../build/types";
-import {
-  GCLOUD_RUN_CANONICAL_HOST_SUFFIX,
-  DEPLOY_TYPES,
-  getKubernetesNamespace,
-} from "../deploy";
+import { DEPLOY_TYPES } from "../deploy";
 import type { DeployConfig } from "../deploy/types";
-import { isOfDeployType } from "../deploy/types";
-import type { Config, DevLocalEnvConfig } from "../types/config";
-import { isKnowEnvType } from "../types/config";
-import type {
-  CommitInfo,
-  Context,
-  Environment,
-  PackageManagerInfo,
-} from "../types/context";
+import type { Config } from "../types/config";
+import type { CommitInfo, Context, PackageManagerInfo } from "../types/context";
 import { mergeWithMergingArrays } from "../utils";
-import {
-  resolveReferences,
-  translateLegacyFromComponents,
-} from "./resolveReferences";
+import { getEnvironment } from "./getEnvironment";
 
-const sanitizeForEnVar = (s: string) => s.replace(/-/g, "_");
-export const getSecretVarName = (
-  env: string,
-  componentName: string,
-  key: string
-) => `CL_${sanitizeForEnVar(env)}_${sanitizeForEnVar(componentName)}_${key}`; // remove dash from component name
-
-const addIndexVar = (vars: Record<string, unknown>) => ({
-  ...vars,
-  _ALL_ENV_VAR_KEYS: JSON.stringify(Object.keys(vars)),
-});
-
-export const getSecretVarNameForContext = (context: Context, key: string) =>
-  getSecretVarName(context.environment.shortName, context.componentName, key);
-export const getEnvironment = async (
-  config: Config,
-  componentName: string,
-  env: string,
-  commitInfo?: CommitInfo,
-  alreadyVisited: Record<string, Record<string, boolean>> = {} // to prevent endless loop
-): Promise<Environment> => {
-  const defaultConfig = config.components[componentName];
-  if (!defaultConfig) {
-    throw new Error("unknown component " + componentName);
-  }
-
-  const envConfig = defaultConfig.env?.[env] ?? {};
-  if (envConfig === false) {
-    throw new Error("env is disabled: " + env);
-  }
-
-  const mergedConfig = mergeWithMergingArrays(defaultConfig, envConfig);
-
-  // env type: if its set manually, use that, otherwise use the known env types
-
-  const envType = envConfig?.type ?? (isKnowEnvType(env) ? env : null);
-
-  if (!envType) {
-    throw new Error(
-      "Missing type in environment " + env + " in component " + componentName
-    );
-  }
-
-  const basePredefinedVariables = {
-    ENV_SHORT: env,
-    APP_DIR: mergedConfig.dir,
-    ENV_TYPE: envType,
-  };
-
-  const environmentName =
-    envType === "review" && commitInfo
-      ? `${env}/${commitInfo.refName}/${componentName}`
-      : `${env}/${componentName}`;
-
-  const environmentSlug =
-    envType === "review" && commitInfo
-      ? `${env}-${commitInfo.reviewSlug}-${componentName}`
-      : `${env}-${componentName}`;
-
-  let predefinedVariables: Record<string, string>;
-  let host: string;
-  let url: string;
-  if (envType === "local") {
-    const devLocalConfig: DevLocalEnvConfig = mergedConfig;
-    const port = devLocalConfig.port ?? 3000;
-    host = "localhost:" + port;
-    url = "http://" + host;
-    predefinedVariables = {
-      ENV_SHORT: "local",
-      ROOT_URL: url,
-      PORT: port.toString(),
-    };
-  } else {
-    const RELEASE_NAME = `${config.customerName}-${config.appName}-${environmentSlug}`;
-
-    const componentSlug = slugify(componentName);
-    const envInUrl =
-      envType === "review" && commitInfo
-        ? `${commitInfo.reviewSlug}.${env}`
-        : env;
-
-    const domainCanonical =
-      (mergedConfig?.deploy &&
-        mergedConfig?.deploy.type === "kubernetes" &&
-        mergedConfig.deploy.cluster?.domainCanonical) || // for convenience, we allow clusters to define a canonical domain, because a cluster has a fixed ip and you will usually have a domain pointing to that cluster
-      config.domainCanonical ||
-      "panter.cloud";
-
-    const HOST_CANONICAL = isOfDeployType(mergedConfig.deploy, "kubernetes")
-      ? `${componentSlug}.${envInUrl}.${config.appName}.${config.customerName}.${domainCanonical}`
-      : isOfDeployType(mergedConfig.deploy, "google-cloudrun")
-      ? environmentSlug +
-        "-" +
-        process.env[
-          getSecretVarName(env, componentName, GCLOUD_RUN_CANONICAL_HOST_SUFFIX)
-        ]
-      : "";
-    host = mergedConfig?.host ?? HOST_CANONICAL;
-    const url = `https://${host}`;
-
-    // FIXME: move to kube specific jobs
-    const KUBE_APP_NAME_PREFIX =
-      envType === "review" && commitInfo ? `${commitInfo.reviewSlug}-` : "";
-
-    const KUBE_APP_NAME = `${KUBE_APP_NAME_PREFIX}${componentName}`;
-    const KUBE_NAMESPACE = getKubernetesNamespace(config, env);
-
-    predefinedVariables = {
-      ...basePredefinedVariables,
-      HOST_CANONICAL,
-      HOST: host,
-      ROOT_URL: url,
-      KUBE_NAMESPACE,
-      KUBE_APP_NAME,
-      KUBE_APP_NAME_PREFIX,
-      RELEASE_NAME,
-    };
-  }
-  const publicEnvVarsRaw = mergedConfig.vars?.public ?? {};
-
-  const additionalSecretKeys = mergedConfig.deploy
-    ? DEPLOY_TYPES[mergedConfig.deploy.type].additionalSecretKeys(
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        mergedConfig.deploy as any
-      )
-    : [];
-
-  const secretEnvVarKeys = [
-    ...(mergedConfig.vars?.secret ?? []),
-    ...additionalSecretKeys,
-  ];
-  const secretEnvVars = Object.fromEntries(
-    secretEnvVarKeys.map((key) => [
-      key,
-      `$${getSecretVarName(env, componentName, key)}`,
-    ])
-  );
-
-  // this is deprecated, we now support: $componentname:FOO
-  const legacyFromComponents = mergedConfig.vars?.fromComponents ?? {};
-  const publicEnvVarsRawWithLegasyFromComponents = merge(
-    {},
-    translateLegacyFromComponents(legacyFromComponents),
-    publicEnvVarsRaw
-  );
-
-  const publicEnvVarsRawSanitized = Object.fromEntries(
-    Object.entries(publicEnvVarsRawWithLegasyFromComponents).map(
-      ([key, value]) => [
-        key,
-        isObject(value) ? JSON.stringify(value) : `${value}`,
-      ]
-    )
-  );
-
-  const envVarsRaw = addIndexVar({
-    ...predefinedVariables,
-    ...secretEnvVars,
-    ...publicEnvVarsRawSanitized,
-  });
-
-  const envVars = await resolveReferences(
-    envVarsRaw,
-    async (componentName, variableName, alreadyVisited) => {
-      const { envVars } = await getEnvironment(
-        config,
-        componentName,
-        env,
-        commitInfo,
-        alreadyVisited
-      );
-      return envVars[variableName];
-    },
-    alreadyVisited
-  );
-  return {
-    envType,
-    host,
-    fullName: environmentName,
-    slug: environmentSlug,
-    shortName: env,
-    url: predefinedVariables.ROOT_URL,
-    envVars,
-    secretEnvVarKeys,
-  };
-};
+export * from "./getEnvironment";
 
 export const createContext = async (
   config: Config,

package/src/deploy/base.ts

@@ -1,6 +1,7 @@
 import { getDockerImageVariables, requiresDockerBuild } from "../build/docker";
 import type { Context } from "../types";
 import type { CatladderJob } from "../types/jobs";
+import { isOfDeployType } from "./types";
 import { contextIsStoppable } from "./utils";
 
 export const DEPLOY_JOB_NAME = "🚀 Deploy";
@@ -15,20 +16,16 @@ const DEPLOY_RUNNER_VARIABLES = {
 };
 type JobWithoutScript = Omit<CatladderJob, "script">;
 export const getBaseDeploymentJob = (context: Context): JobWithoutScript => {
-  const environment = {
-    name: context.environment.fullName,
-    url: context.environment.url,
-  };
-
   const hasDocker = requiresDockerBuild(context);
   const isStoppable = contextIsStoppable(context);
 
   const autoStop =
     context.environment.envType === "review"
-      ? "3 days" // auto stop is not working properly when branch is merged, so we do
+      ? "2 week"
       : context.environment.envType === "dev"
-      ? "3 weeks"
+      ? "4 weeks"
       : undefined;
+
   // if auto or manual is configured explicitly, use that
   const whenDeployDefined =
     context.componentConfig.deploy && context.componentConfig.deploy.when
@@ -82,7 +79,7 @@ export const getBaseDeploymentJob = (context: Context): JobWithoutScript => {
       ...(hasDocker ? getDockerImageVariables(context) : {}),
     },
     environment: {
-      ...environment,
+      ...context.environment.gitlabEnvironment,
       ...(isStoppable
         ? {
             on_stop: STOP_JOB_NAME,
@@ -96,10 +93,6 @@ export const getBaseDeploymentJob = (context: Context): JobWithoutScript => {
 export const getBaseDeploymentStopJob = (
   context: Context
 ): JobWithoutScript => {
-  const environment = {
-    name: context.environment.fullName,
-    url: context.environment.url,
-  };
   return {
     name: STOP_JOB_NAME,
     envMode: "stagePerEnv", // makes it easier to run manual tasks er env
@@ -122,17 +115,13 @@ export const getBaseDeploymentStopJob = (
     },
     stage: "stop",
     environment: {
-      ...environment,
+      ...context.environment.gitlabEnvironment,
       action: "stop",
     },
   };
 };
 
 export const getBaseRollbackJob = (context: Context): JobWithoutScript => {
-  const environment = {
-    name: context.environment.fullName,
-    url: context.environment.url,
-  };
   return {
     name: ROLLBACK_JOB_NAME,
     envMode: "stagePerEnv", // makes it easier to run manual tasks er env
@@ -149,7 +138,7 @@ export const getBaseRollbackJob = (context: Context): JobWithoutScript => {
     },
     stage: "rollback",
     environment: {
-      ...environment,
+      ...context.environment.gitlabEnvironment,
       action: "access",
     },
   };

package/src/deploy/cloudRun/deployJob.ts

@@ -39,7 +39,7 @@ export const createDeployJob = (context: Context): CatladderJob[] => {
     GCLOUD_DEPLOY_CREDENTIALS_KEY
   );
 
-  const serviceName = context.environment.slug;
+  const serviceName = context.environment.fullName;
 
   const labelsString = Object.entries(getLabels(context))
     .map(([key, value]) => `${key}=${value}`)

package/src/deploy/kubernetes/deployJob.ts

@@ -32,6 +32,7 @@ export const createKubernetesDeployJobs = (
     image: getRunnerImage("kubernetes"),
     variables: {
       ...context.environment.envVars,
+      RELEASE_NAME: context.environment.fullName,
       HELM_EXPERIMENTAL_OCI: "1",
       KUBE_DOCKER_IMAGE_PULL_SECRET: `gitlab-registry-${context.componentName}`,
       KUBE_VALUES: dump(kubeValues, {

package/src/types/context.ts

@@ -1,11 +1,23 @@
-import type { PipelineTrigger, ComponentConfig, Config, EnvType } from "./config";
+import type {
+  PipelineTrigger,
+  ComponentConfig,
+  Config,
+  EnvType,
+} from "./config";
 
 export type Environment = {
   host: string;
+  url: string;
+  /**
+   * the full name of the app. We use this as RELEASE_NAME in kubernetes and the service name in google cloud run
+   */
   fullName: string;
+  gitlabEnvironment: {
+    name: string;
+    url: string;
+  };
   shortName: string;
   slug: string;
-  url: string;
   /**
    * env vars contain all build-time env vars. secrets have to be resolved (they are stored in gitlab)
    */