@catladder/pipeline 0.0.0-next-e2e4f00a → 0.0.0-next-de346530

package/examples/{workspace-api-www-custom-cache.test.ts → cloud-run-nextjs.test.ts}

@@ -1,11 +1,11 @@
 import { createYamlLocalPipeline } from "./__utils__/helpers";
-import config from "./workspace-api-www-custom-cache";
+import config from "./cloud-run-nextjs";
 
 /**
  * This test is auto-generated.
  * Modifications will be overwritten on every `yarn test` run!
  */
 
-it("matches snapshot for workspace-api-www-custom-cache local pipeline YAML", async () => {
+it("matches snapshot for cloud-run-nextjs local pipeline YAML", async () => {
   expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
 });

package/examples/cloud-run-nextjs.ts

@@ -0,0 +1,29 @@
+import type { Config } from "../src";
+
+const config: Config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    www: {
+      dotEnv: true,
+      dir: "www",
+      build: {
+        type: "node",
+        cache: {
+          paths: [".next/cache"],
+        },
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+      },
+    },
+  },
+};
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: With SQL",
+};

package/examples/native-app.ts

@@ -28,9 +28,11 @@ const config: Config = {
         ],
       },
       build: {
-        extraVars: {
-          LC_A: "L=en_US.UTF-8",
-          LANG: "en_US.UTF-8",
+        jobVars: {
+          public: {
+            LC_A: "L=en_US.UTF-8",
+            LANG: "en_US.UTF-8",
+          },
         },
         type: "node",
         buildCommand: [
@@ -46,9 +48,11 @@ const config: Config = {
 
       deploy: {
         type: "custom",
-        extraVars: {
-          LC_A: "L=en_US.UTF-8",
-          LANG: "en_US.UTF-8",
+        jobVars: {
+          public: {
+            LC_A: "L=en_US.UTF-8",
+            LANG: "en_US.UTF-8",
+          },
         },
         requiresDocker: false,
         script: [

package/examples/rails-k8s-with-worker.ts

@@ -44,7 +44,11 @@ const config: Config = {
           domainCanonical: "panter.cloud",
         },
         values: {
-          cloudsql: { enabled: true, projectId: "some-project-id" },
+          cloudsql: {
+            enabled: true,
+            type: "unmanaged",
+            instanceConnectionName: "myproject:europe-west6:instance-name",
+          },
           application: {
             // if deployed to Google Cloud Run use a gem like cloudtasker instead of a permanently running expensive worker
             worker: {

package/examples/{kubernetes-with-cloud-sql-legacy.test.ts → workspace-api-www-turbo-cache.test.ts}

@@ -1,11 +1,11 @@
 import { createYamlLocalPipeline } from "./__utils__/helpers";
-import config from "./kubernetes-with-cloud-sql-legacy";
+import config from "./workspace-api-www-turbo-cache";
 
 /**
  * This test is auto-generated.
  * Modifications will be overwritten on every `yarn test` run!
  */
 
-it("matches snapshot for kubernetes-with-cloud-sql-legacy local pipeline YAML", async () => {
+it("matches snapshot for workspace-api-www-turbo-cache local pipeline YAML", async () => {
   expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
 });

package/examples/{workspace-api-www-custom-cache.ts → workspace-api-www-turbo-cache.ts}

@@ -12,7 +12,7 @@ const config: Config = {
     myWorkspace: {
       type: "node",
       cache: {
-        paths: [".my-cache"],
+        paths: [".turbo"],
       },
     },
   },
@@ -33,6 +33,9 @@ const config: Config = {
       dir: "www",
       build: {
         from: "myWorkspace",
+        cache: {
+          paths: [".next/cache"],
+        },
       },
       deploy: DEPLOY_CONFIG,
       vars: {

package/examples/workspace-api-www.ts

@@ -27,6 +27,9 @@ const config: Config = {
       dir: "www",
       build: {
         from: "myWorkspace",
+        cache: {
+          paths: [".next/cache"],
+        },
       },
       deploy: DEPLOY_CONFIG,
       vars: {

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "0.0.0-next-e2e4f00a",
+  "version": "0.0.0-next-de346530",
   "stableVersion": "0.1.0",
   "scripts": {
     "build:tsc": "yarn tsc",

package/src/build/base/createAppBuildJob.ts

@@ -40,7 +40,6 @@ export const createAppBuildJob = (
           ? {
               ...context.environment.envVars,
               ...context.environment.jobOnlyVars.build.envVars,
-              ...(context.build.config.extraVars ?? {}),
             }
           : {}),
       },

package/src/build/custom/testJob.ts

@@ -31,7 +31,6 @@ export const createCustomTestJobs = (
     variables: {
       APP_PATH: context.build.dir,
       ...context.environment.jobOnlyVars.build.envVars,
-      ...(buildConfig.extraVars ?? {}),
     },
     runnerVariables: RUNNER_CUSTOM_TEST_VARIABLES,
     services: buildConfig.jobServices,

package/src/build/node/buildJob.ts

@@ -13,7 +13,7 @@ import { createBuildJobDefinition } from "../base/createBuildJobDefinition";
 import type { DockerBuildJobDefinition } from "../docker";
 import { getDockerBuildScriptWithBuiltInDockerFile } from "../docker";
 import type { BuildConfigDocker } from "../types";
-import { getNextCache, getNodeCache, getYarnCache } from "./cache";
+import { getNodeCache, getYarnCache } from "./cache";
 import { getDockerAppCopyAndBuildScript, getYarnInstall } from "./yarn";
 
 export const createNodeBuildJobs = (
@@ -41,7 +41,7 @@ export const createNodeBuildJobDefinition = (
   const yarnInstall = getYarnInstall(context);
   return createBuildJobDefinition(context, buildConfig, {
     prescript: yarnInstall,
-    cache: [...getNodeCache(context), ...getNextCache(context)],
+    cache: getNodeCache(context),
   });
 };
 

package/src/build/node/cache.ts

@@ -63,34 +63,5 @@ export const getNodeCache = (
   return [
     ...getYarnCache(context, policy),
     ...getNodeModulesCache(context, policy),
-    ...(context.type === "workspace" ? getWorkspaceDefaultCaches(context) : []),
-  ];
-};
-
-export const getNextCache = (context: Context): CacheConfig[] => {
-  const paths = context.build
-    .getComponentDirs("direct")
-    .map((c) => join(c, ".next/cache"));
-
-  return [
-    {
-      pathMode: "absolute",
-      key: "next-cache",
-      policy: "pull-push",
-      paths,
-    },
-  ];
-};
-
-export const getWorkspaceDefaultCaches = (
-  context: WorkspaceContext,
-): CacheConfig[] => {
-  return [
-    {
-      // turbo repo
-      key: "turbo",
-      policy: "pull-push",
-      paths: [".turbo"],
-    },
   ];
 };

package/src/build/node/testJob.ts

@@ -35,7 +35,6 @@ export const createNodeTestJobs = (
       ...(context.type === "component"
         ? {
             ...context.environment.jobOnlyVars.build.envVars,
-            ...(context.build.config.extraVars ?? {}),
           }
         : {}),
     },

package/src/build/rails/build.ts

@@ -47,7 +47,6 @@ export const createRailsBuildJobs = (
     dockerBuild: {
       variables: {
         ...context.environment.jobOnlyVars.build.envVars,
-        ...context.build.config.extraVars,
       },
       // custom script
       script: [

package/src/build/rails/test.ts

@@ -24,7 +24,6 @@ export const createRailsTestJobs = (
   const base: Omit<CatladderJob, "script" | "name"> = {
     variables: {
       ...context.environment.jobOnlyVars.build.envVars,
-      ...(buildConfig.extraVars ?? {}),
     },
     stage: "test",
     needs: [],

package/src/build/types.ts

@@ -82,12 +82,6 @@ export type BuildConfigBase = {
    * Can curently not reference other variables from other components
    */
   jobVars?: EnvVars;
-  /**
-   * additional env vars for the buid jobs
-   *
-   * @deprecated use jobVars or runnerVariables
-   */
-  extraVars?: Record<string, string>;
 
   /**
    * additional vars only for the runner.
@@ -232,13 +226,6 @@ export type BuildConfigDocker =
   | BuildConfigDockerBuiltIn
   | BuildConfigDockerCustom;
 
-/**
- * @deprecated this type is no longer used. Use {@link BuildConfigDocker} instead.
- */
-export type BuildConfigCustomDocker =
-  | BuildConfigDockerCustom
-  | BuildConfigDockerBuiltInNgninx;
-
 export type BuildConfigCustom = Omit<
   BuildConfigBase,
   "lint" | "test" | "audit"

package/src/context/__tests__/resolveReferences.test.ts

@@ -1,8 +1,5 @@
 import type { BashExpression } from "../../bash/BashExpression";
-import {
-  resolveReferences,
-  translateLegacyFromComponents,
-} from "../resolveReferences";
+import { resolveReferences } from "../resolveReferences";
 
 const unpackBashExpressions = (obj: Record<string, string | BashExpression>) =>
   Object.fromEntries(
@@ -123,26 +120,3 @@ describe("resolveReferences", () => {
     });
   });
 });
-
-describe("translateLegacyFromComponents", () => {
-  it("translatetes the old `fromComponents` approach to ${componentName:variableName}", () => {
-    const fromComponents = {
-      api: {
-        API_FOO: "FOO",
-        API_BAR: "BAR",
-      },
-      www: {
-        WWW_X: "X",
-        WWW_Y: "Y",
-      },
-    };
-
-    const result = translateLegacyFromComponents(fromComponents);
-    expect(result).toEqual({
-      API_FOO: "${api:FOO}",
-      API_BAR: "${api:BAR}",
-      WWW_X: "${www:X}",
-      WWW_Y: "${www:Y}",
-    });
-  });
-});

package/src/context/createComponentContext.ts

@@ -108,7 +108,6 @@ export const createComponentContext = async (
   const context: Omit<ComponentContext, "customJobs"> = {
     type: "component",
     name: ctx.componentName,
-    componentName: ctx.componentName,
     env: ctx.env,
     fullConfig: ctx.config,
     componentConfig,

package/src/context/getEnvironment.ts

@@ -20,7 +20,7 @@ export const getEnvironment = async (
     slugPrefix: envContext.environmentSlugPrefix,
     reviewSlug: envContext.reviewSlug,
     slug: envContext.environmentSlug,
-    shortName: env,
+
     ...variables,
   };
 };

package/src/context/getEnvironmentVariables.ts

@@ -1,4 +1,3 @@
-import { merge } from "lodash";
 import { DEPLOY_TYPES } from "../deploy";
 import type {
   ComponentContext,
@@ -13,10 +12,7 @@ import { isStandaloneBuildConfig } from "../build/types";
 import type { EnvironmentContext } from "../types/environmentContext";
 import { getBuildInfoVariables } from "./getBuildInfoVariables";
 import { getEnvironmentContext } from "./getEnvironmentContext";
-import {
-  resolveReferences,
-  translateLegacyFromComponents,
-} from "./resolveReferences";
+import { resolveReferences } from "./resolveReferences";
 import { transformJobOnlyVars } from "./transformJobOnlyVars";
 import {
   makeSecretEnvVarMapping,
@@ -43,12 +39,9 @@ type BasePredefinedVariables = ReturnType<typeof getBasePredefinedVariables>;
 
 // we export so that we have later nice autocomplete
 export type PredefinedVariables = BasePredefinedVariables & {
-  /**
-   * undefined in rails, Rails before 6.1 (mis)uses the `HOST` environment variable to specify the IP to bind to
-   */
-  HOST?: StringOrBashExpression;
+  HOSTNAME?: StringOrBashExpression;
   ROOT_URL: StringOrBashExpression;
-  HOST_INTERNAL: StringOrBashExpression;
+  HOSTNAME_INTERNAL: StringOrBashExpression;
   ROOT_URL_INTERNAL: StringOrBashExpression;
 };
 
@@ -78,12 +71,8 @@ export const getEnvironmentVariables = async (
       ...basePredefinedVariables,
       ENV_SHORT: "local",
       ROOT_URL: url,
-      // Rails before 6.1 (mis)uses the `HOST` environment variable to specify the IP to bind to
-      ...(isStandaloneBuildConfig(buildConfigRaw) &&
-      buildConfigRaw.type === "rails"
-        ? {}
-        : { HOST: host }),
-      HOST_INTERNAL: host,
+      HOSTNAME: host,
+      HOSTNAME_INTERNAL: host,
       ROOT_URL_INTERNAL: "http://" + host,
       PORT: port.toString(),
     };
@@ -94,10 +83,10 @@ export const getEnvironmentVariables = async (
         )
       : {};
 
-    const HOST_INTERNAL =
-      additionalEnvVars.HOST_INTERNAL ?? "unknown-host.example.com";
+    const HOSTNAME_INTERNAL =
+      additionalEnvVars.HOSTNAME_INTERNAL ?? "unknown-host.example.com";
 
-    host = envConfigRaw?.host ?? HOST_INTERNAL;
+    host = envConfigRaw?.host ?? HOSTNAME_INTERNAL;
     url = joinBashExpressions(["https://", host]);
 
     predefinedVariables = {
@@ -106,12 +95,11 @@ export const getEnvironmentVariables = async (
       ...(isStandaloneBuildConfig(buildConfigRaw) &&
       buildConfigRaw.type === "rails"
         ? {}
-        : { HOST: host }),
+        : { HOSTNAME: host }),
       ROOT_URL: url,
-      HOST_INTERNAL,
-      /**@deprecated */
-      HOST_CANONICAL: HOST_INTERNAL, // legacy alias for HOST_INTERNAL
-      ROOT_URL_INTERNAL: joinBashExpressions(["https://", HOST_INTERNAL]),
+      HOSTNAME_INTERNAL,
+
+      ROOT_URL_INTERNAL: joinBashExpressions(["https://", HOSTNAME_INTERNAL]),
       ...additionalEnvVars,
     };
   }
@@ -132,17 +120,8 @@ export const getEnvironmentVariables = async (
     componentName,
     secretEnvVarKeys,
   );
-  // this is deprecated, we now support: $componentname:FOO
-  const legacyFromComponents = envConfigRaw.vars?.fromComponents ?? {};
-  const publicEnvVarsRawWithLegacyFromComponents = merge(
-    {},
-    translateLegacyFromComponents(legacyFromComponents),
-    publicEnvVarsRaw,
-  );
 
-  const publicEnvVarsRawSanitized = stringifyValues(
-    publicEnvVarsRawWithLegacyFromComponents,
-  );
+  const publicEnvVarsRawSanitized = stringifyValues(publicEnvVarsRaw);
 
   const envVarsRaw = addIndexVar({
     ...predefinedVariables,

package/src/context/resolveReferences.ts

@@ -78,16 +78,3 @@ export const resolveReferences = async (
     ),
   ) as Record<string, BashExpression>;
 };
-
-export const translateLegacyFromComponents = (
-  fromComponents: Record<string, Record<string, string>>,
-) => {
-  return Object.fromEntries(
-    Object.entries(fromComponents).flatMap(([componentName, variables]) => {
-      return Object.entries(variables).map(([ourName, otherName]) => [
-        ourName,
-        "${" + componentName + ":" + otherName + "}",
-      ]);
-    }),
-  );
-};

package/src/deploy/base/deploy.ts

@@ -117,7 +117,7 @@ export const createDeployJob = (
       ...context.environment.envVars,
       ...(hasDocker ? getDockerImageVariables(context) : {}),
       ...context.environment.jobOnlyVars.deploy.envVars,
-      ...(deployConfig ? deployConfig.extraVars ?? {} : {}),
+
       ...jobDefinition.variables,
     },
     runnerVariables: {

package/src/deploy/cloudRun/index.ts

@@ -85,7 +85,7 @@ export const GCLOUD_RUN_DEPLOY_TYPE: DeployTypeDefinition<DeployConfigCloudRun>
     getAdditionalEnvVars: (ctx) => {
       const { fullName, env, componentName, deployConfigRaw } = ctx;
 
-      const HOST_INTERNAL = joinBashExpressions(
+      const HOSTNAME_INTERNAL = joinBashExpressions(
         [
           fullName,
           getBashVariable(
@@ -113,7 +113,7 @@ export const GCLOUD_RUN_DEPLOY_TYPE: DeployTypeDefinition<DeployConfigCloudRun>
           : {};
 
       return {
-        HOST_INTERNAL,
+        HOSTNAME_INTERNAL,
         ...getCloudSqlVariables(ctx),
         ...jobTriggers,
         DEPLOY_CLOUD_RUN_PROJECT_ID: deployConfigRaw

package/src/deploy/kubernetes/cloudSql/index.ts

@@ -41,21 +41,7 @@ export const createKubernetesCloudsqlBaseValues = (
     context,
     "cloudsqlProxyCredentials",
   )}`;
-  if (config?.type !== "unmanaged") {
-    const instanceConnectionName = `${config.projectId ?? "skynet-164509"}:${
-      config.region ?? "europe-west6"
-    }:${config.instanceId ?? context.environment.envVars.KUBE_NAMESPACE}`;
-
-    return {
-      cloudsql: {
-        enabled: config.enabled,
-        dbUser: "postgres",
-        instanceConnectionName,
-        proxyCredentials,
-        fullDbName: context.environment.envVars.KUBE_APP_NAME ?? "",
-      },
-    };
-  } else if (config.type === "unmanaged") {
+  if (config.type === "unmanaged") {
     return {
       cloudsql: {
         enabled: config.enabled,

package/src/deploy/kubernetes/deployJob.ts

@@ -47,8 +47,6 @@ export const createKubernetesDeployJobs = (
         ...(deployConfig.additionalHelmArgs ?? []),
       ].join(" "),
       COMPONENT_NAME: context.name,
-      /** @deprecated */
-      BUILD_ID: context.environment.envVars.BUILD_INFO_BUILD_ID,
     },
   };
 

package/src/deploy/kubernetes/index.ts

@@ -29,7 +29,7 @@ export const KUBERNETES_DEPLOY_TYPE: DeployTypeDefinition<DeployConfigKubernetes
         fullConfig.domainCanonical ||
         "panter.cloud";
 
-      const HOST_INTERNAL = joinBashExpressions(
+      const HOSTNAME_INTERNAL = joinBashExpressions(
         [
           componentSlug,
           ...(envType === "review" && reviewSlug ? [reviewSlug] : []),
@@ -44,7 +44,7 @@ export const KUBERNETES_DEPLOY_TYPE: DeployTypeDefinition<DeployConfigKubernetes
         KUBE_NAMESPACE,
         KUBE_APP_NAME,
         KUBE_APP_NAME_PREFIX,
-        HOST_INTERNAL,
+        HOSTNAME_INTERNAL,
       };
     },
   };

package/src/deploy/kubernetes/kubeValues.ts

@@ -11,7 +11,6 @@ import {
 
 import { createKubeEnv } from "./kubeEnv";
 import { createMongodbBaseConfig } from "./mongodb";
-import { processSecretsAsFiles } from "./processSecretsAsFiles";
 
 const createAppConfig = (
   context: ComponentContext,
@@ -87,14 +86,12 @@ export const createKubeValues = (context: ComponentContext) => {
       : {},
   );
 
-  const kubeValues = processSecretsAsFiles(
-    mergeWithMergingArrays(defaultKubeValues, {
-      jobs: removeFalsy(jobs),
-      cronjobs: removeFalsy(cronjobs),
+  const kubeValues = mergeWithMergingArrays(defaultKubeValues, {
+    jobs: removeFalsy(jobs),
+    cronjobs: removeFalsy(cronjobs),
 
-      ...rest,
-    }),
-  );
+    ...rest,
+  });
 
   return kubeValues;
 };

package/src/deploy/types/base.ts

@@ -25,12 +25,6 @@ export type DeployConfigBase = {
    */
   jobVars?: EnvVars;
 
-  /**
-   * additional env vars for the deploy job
-   *
-   * @deprecated use deploy.jobVars for deploy job specific variables
-   */
-  extraVars?: Record<string, string>;
   /**
    * additional vars only for the runner.
    * Also if you use services: that require env vars, you need to set them here.

package/src/deploy/types/kubernetes.ts

@@ -164,33 +164,6 @@ export type DeployConfigMongodbReplicaset = {
 export type DeployConfigMongodb = DeployConfigMongodbBase &
   (DeployConfigMongodbStandalone | DeployConfigMongodbReplicaset);
 
-/**
- * @deprecated use config with instanceConnectionName
- */
-type DeployConfigKubernetesValuesCloudSQLLegacy = {
-  enabled: boolean;
-  /**
-   * @deprecated use config with instanceConnectionName
-   */
-  instanceId?: string;
-  /**
-   * @deprecated use config with instanceConnectionName
-   */
-  projectId?: string;
-  /**
-   * @deprecated use config with instanceConnectionName
-   */
-  region?: string;
-  /**
-   * @deprecated use type "unmanaged".
-   *
-   * Be aware that "unmanaged" is not fully backward compatible with "legacy".
-   *
-   *
-   */
-  type?: "legacy";
-};
-
 export type DeployConfigKubernetesValuesCloudSQLUnmanaged = {
   enabled: boolean;
   instanceConnectionName: string;
@@ -220,8 +193,7 @@ export type DeployConfigKubernetesValuesCloudSQLUnmanaged = {
   dbBaseName?: string;
 };
 export type DeployConfigKubernetesValuesCloudSQL =
-  | DeployConfigKubernetesValuesCloudSQLLegacy
-  | DeployConfigKubernetesValuesCloudSQLUnmanaged;
+  DeployConfigKubernetesValuesCloudSQLUnmanaged;
 export type DeployConfigKubernetesValues = AllowUnknownProps<{
   /**
    * enable cloudsql db. Currently you have to manually set it up
@@ -358,13 +330,6 @@ export type DeployConfigKubernetesValues = AllowUnknownProps<{
   mapServiceUrlToEnv?: {
     [envVar: string]: string;
   };
-  /**
-   * Mount secrets as files in the filesystem.
-   * These secrets are still available as env vars, but will contain the path of the file instead
-   *
-   * @deprecated this will be removed in the future, because its very niche and not used
-   */
-  secretsAsFile?: string[];
 }>;
 
 export type DeployConfigKubernetes = {

package/src/pipeline/gitlab/createGitlabJobs.ts

@@ -106,7 +106,6 @@ export const makeGitlabJob = (
     environment,
     envMode,
     needsStages,
-    needsOtherComponent,
     name,
     needs,
     jobTags,
@@ -310,7 +309,7 @@ function deduplicateNeeds(needs: GitlabJobDef["needs"]): GitlabJobDef["needs"] {
 
 function getGitlabNeedsForComponentJob(
   context: ComponentContext,
-  { needsStages, needs, needsOtherComponent }: CatladderJob<string>,
+  { needsStages, needs }: CatladderJob<string>,
   allJobs: AllCatladderJobs,
 ): GitlabJobDef["needs"] {
   const needsFromStages = needsStages?.flatMap<CatladderJobNeed>((n) => {
@@ -353,8 +352,6 @@ function getGitlabNeedsForComponentJob(
   const cleanedNeeds: CatladderJob["needs"] = [
     ...(needsFromStages ?? []),
     ...(needs ?? []),
-    // pull in legacy needs from other component, which is now identical to needs
-    ...(needsOtherComponent ?? []),
   ];
 
   return cleanedNeeds

package/src/types/config.ts

@@ -73,14 +73,6 @@ export type EnvVars = {
    * secret env vars. These vars can be managed with catladder/cli
    */
   secret?: string[];
-  /**
-   * @deprecated, use ${componentName:variableName} instead
-   *
-   * With fromComponents you can inject env vars from other components.
-   */
-  fromComponents?: {
-    [otherApp: string]: Record<string, string>;
-  };
 };
 
 export type DefaultEnvConfig = {