@catladder/pipeline 0.0.0-node16-ddfae617 → 0.0.0-refactor-env-context-9e652b63

package/dist/deploy/types/googleCloudRun.d.ts

@@ -0,0 +1,39 @@
+import type { DeployConfigBase } from "./base";
+export declare type Gcloudregion = "asia-east1" | "asia-northeast1" | "asia-northeast2" | "europe-north1" | "europe-southwest1" | "europe-west1" | "europe-west4" | "europe-west8" | "europe-west9" | "me-west1" | "us-central1" | "us-east1" | "us-east4" | "us-east5" | "us-south1" | "us-west1" | "asia-east2" | "asia-northeast3" | "asia-southeast1" | "asia-southeast2" | "asia-south1" | "asia-south2" | "australia-southeast1" | "australia-southeast2" | "europe-central2" | "europe-west2" | "europe-west3" | "europe-west6" | "northamerica-northeast1" | "northamerica-northeast2" | "southamerica-east1" | "southamerica-west1" | "us-west2" | "us-west3" | "us-west4";
+export declare type DeployConfigCloudRunBase = {
+  /**
+   * the google cloud porject id
+   */
+  projectId: string;
+  /**
+   * the region. Set to europe-west6 for switzerland
+   */
+
+  region: Gcloudregion;
+  /**
+   * command / entrypoint, fallsback to buildConfig.startcommand
+   */
+
+  command?: string;
+} & DeployConfigBase;
+export declare type DeployConfigCloudRunService = {
+  /**
+   * EXPERIMENTAL cloud run deployment.
+   *
+   * This will deploy a cloud run service.
+   *
+   * Requires that cloud run is enabled on the project, as well as cloud run api and artifacts registry.
+   */
+  type: "google-cloudrun";
+} & DeployConfigCloudRunBase;
+export declare type DeployConfigCloudRunJob = {
+  /**
+   * EXPERIMENTAL cloud run job.
+   *
+   * This will deploy a cloud run job. This does not do much currently, but will be later used for cronjobs
+   *
+   * Requires that cloud run is enabled on the project, as well as cloud run api and artifacts registry.
+   */
+  type: "google-cloudrun-job";
+} & DeployConfigCloudRunBase;
+export declare type DeployConfigCloudRun = DeployConfigCloudRunService | DeployConfigCloudRunJob;

package/dist/deploy/types/googleCloudRun.js

@@ -0,0 +1,3 @@
+"use strict";
+
+exports.__esModule = true;

package/dist/deploy/types/index.d.ts

@@ -0,0 +1,24 @@
+import type { DeployConfigCustom } from "./custom";
+import type { DeployConfigDockerTag } from "./dockerTag";
+import type { DeployConfigCloudRun } from "./googleCloudRun";
+import type { DeployConfigKubernetes } from "./kubernetes";
+export * from "./custom";
+export * from "./googleCloudRun";
+export * from "./kubernetes";
+export * from "./dockerTag";
+export declare type DeployConfig = DeployConfigKubernetes | DeployConfigCustom | DeployConfigCloudRun | DeployConfigDockerTag;
+export declare type DeployConfigType = DeployConfig["type"];
+export declare type DeployConfigGeneric<T extends DeployConfigType> = Extract<DeployConfig, {
+  type: T;
+}>;
+export declare const isOfDeployType: <T extends ("custom" | "dockerTag" | "google-cloudrun" | "google-cloudrun-job" | "kubernetes")[]>(t: DeployConfig | false, ...types: T) => t is Extract<DeployConfigCustom, {
+  type: T[number];
+}> | Extract<DeployConfigDockerTag, {
+  type: T[number];
+}> | Extract<import("./googleCloudRun").DeployConfigCloudRunService, {
+  type: T[number];
+}> | Extract<import("./googleCloudRun").DeployConfigCloudRunJob, {
+  type: T[number];
+}> | Extract<DeployConfigKubernetes, {
+  type: T[number];
+}>;

package/dist/deploy/types/index.js

@@ -0,0 +1,41 @@
+"use strict";
+
+var __createBinding = this && this.__createBinding || (Object.create ? function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  Object.defineProperty(o, k2, {
+    enumerable: true,
+    get: function () {
+      return m[k];
+    }
+  });
+} : function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  o[k2] = m[k];
+});
+
+var __exportStar = this && this.__exportStar || function (m, exports) {
+  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+
+exports.__esModule = true;
+exports.isOfDeployType = void 0;
+
+__exportStar(require("./custom"), exports);
+
+__exportStar(require("./googleCloudRun"), exports);
+
+__exportStar(require("./kubernetes"), exports);
+
+__exportStar(require("./dockerTag"), exports);
+
+var isOfDeployType = function (t) {
+  var types = [];
+
+  for (var _i = 1; _i < arguments.length; _i++) {
+    types[_i - 1] = arguments[_i];
+  }
+
+  return t && types.includes(t.type);
+};
+
+exports.isOfDeployType = isOfDeployType;

package/dist/deploy/{types.d.ts → types/kubernetes.d.ts}

@@ -1,12 +1,4 @@
-export declare type DeployConfigBase = {
-  /**
-   * whether to deploy automatically or manual. If not defined, these rules apply:
-   * - prod: manual
-   * - all other envs: auto
-   */
-  when?: "manual" | "auto";
-};
-declare type AllowUnknownProps<T extends Record<string, unknown>> = T & Record<string, unknown>;
+import type { AllowUnknownProps, DeployConfigBase } from "./base";
 export declare type DeployConfigKubernetesClusterGCloud = {
   type: "gcloud";
   /**
@@ -54,6 +46,16 @@ export declare type KubernetesAutoscale = {
 
   metrics: KubernetesAutoscaleMetric[];
 };
+export declare type KubernetesResourcesDef = {
+  limits?: {
+    cpu?: string;
+    memory?: string;
+  };
+  requests?: {
+    cpu?: string;
+    memory?: string;
+  };
+};
 declare type KubernetesHealthDef = {
   httpGet?: {
     path?: string;
@@ -68,6 +70,63 @@ declare type KubernetesHealthDef = {
     successThreshold?: number;
   };
 };
+export declare type KubernetesUpdateStrategy = {
+  rollingUpdate: {
+    /**
+     * how many pods can be created additionally to the target number
+     * can be absolute number or percentage.
+     * defaults to 1 (kube default is 25%)
+     */
+    maxSurge: number | string;
+    /**
+     * how many pods are allowed to be unavailable
+     * can be absolute number or percentage
+     * defaults to 0 (kube default is 25%)
+     */
+
+    maxUnavailable: number | string;
+  };
+  type: "RollingUpdate";
+};
+export declare type KubernetesWorkerDef = {
+  enabled: boolean;
+  /**
+   * which command to run. defaults to `yarn start`
+   */
+
+  command?: string;
+  resources?: KubernetesResourcesDef;
+  service?: {
+    enabled?: boolean;
+  };
+};
+export declare type DeployConfigMongodbBase = {
+  enabled?: boolean;
+  dbName?: string;
+  persistence?: {
+    /**
+     * set premium-rwo for ssd
+     */
+    storageClass?: "standard-rwo" | "premium-rwo";
+    /**
+     * size of the volume, defaults to 8Gi
+     */
+
+    size?: string;
+  };
+};
+export declare type DeployConfigMongodbStandalone = {
+  architecture: "standalone";
+};
+export declare type DeployConfigMongodbReplicaset = {
+  architecture: "replicaset";
+  /**
+   * defaults to 2
+   */
+
+  replicaCount?: number;
+};
+export declare type DeployConfigMongodb = DeployConfigMongodbBase & (DeployConfigMongodbStandalone | DeployConfigMongodbReplicaset);
 export declare type DeployConfigKubernetesValues = AllowUnknownProps<{
   /**
    * enable cloudsql db. Currently you have to manually set it up
@@ -80,12 +139,10 @@ export declare type DeployConfigKubernetesValues = AllowUnknownProps<{
   };
   /**
    * enable mongodb. The mongodb is deployed using a helm chart.
-   * Consider using external services instead of this.
+   * See https://github.com/bitnami/charts/tree/master/bitnami/mongodb
    */
 
-  mongodb?: AllowUnknownProps<{
-    enabled: boolean;
-  }>;
+  mongodb?: DeployConfigMongodb;
   /**
    * enable mailhog. Mailhog is a virtual mail server that catches all outgoing mailsl and show them in a mailbox.
    * This is great for development as it prevents to accidentially send out real emails and helps with debugging outgoing mails.
@@ -104,7 +161,17 @@ export declare type DeployConfigKubernetesValues = AllowUnknownProps<{
    */
 
   jobs?: Record<string, AllowUnknownProps<{
+    /**
+     * the command to execute
+     */
     command: string;
+    /**
+     * comma-separated list of helm hooks, see https://helm.sh/docs/topics/charts_hooks/
+     *
+     * defaults to post-install,post-upgrade
+     */
+
+    hook?: string;
   }>>;
   /**
    * cronjobs that run periodically. These use the app image have all env vars available.
@@ -119,13 +186,23 @@ export declare type DeployConfigKubernetesValues = AllowUnknownProps<{
    * configuration for the application ("Deployment" in kubernetes)
    */
 
-  application?: AllowUnknownProps<{
+  application?: false | AllowUnknownProps<{
+    /**
+     * enable, disable app deployment, defaults to true
+     */
+    enabled?: boolean;
     /**
      * redirects
      */
+
     redirects?: AllowUnknownProps<{
       host: string;
     }>[];
+    /**
+     * Host aliases
+     */
+
+    hostAliases?: string[];
     /**
      * how many pods will be started
      */
@@ -136,28 +213,55 @@ export declare type DeployConfigKubernetesValues = AllowUnknownProps<{
      */
 
     autoscale?: KubernetesAutoscale;
+    /**
+     * the update strategy, see https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#rolling-update-deployment
+     */
+
+    updateStrategy?: KubernetesUpdateStrategy;
     /**
      * kubernetes resources
      */
 
-    resources?: {
-      limits?: {
-        cpu?: string;
-        memory?: string;
-      };
-      requests?: {
-        cpu?: string;
-        memory?: string;
-      };
-    };
+    resources?: KubernetesResourcesDef;
     healthRoute?: string;
     startupProbe?: KubernetesHealthDef;
     readinessProbe?: KubernetesHealthDef;
     livenessProbe?: KubernetesHealthDef;
+    /**
+     * specify a worker. A worker is a separate deployment that runs continously in the background.
+     * The worker pod can use the same entry point as the app or a different one (specify command).
+     * It has the same environment variables as the application and an additional IS_WORKER="true" variable
+     */
+
+    worker?: KubernetesWorkerDef;
   }>;
+  /**
+   * load secrets from other components.
+   * Use this only in cases where the secret is not known on pipeline-time
+   * and only if the component is also in the same cluster.
+   *
+   * a typical case is reusing mongo_url from other component
+   *
+   * also make sure that the other component deploys first
+   *
+   * in all other cases use normal env var handling
+   */
+
+  secretsFromOtherComponent?: {
+    [envVar: string]: string;
+  };
+  /**
+   * map another services internal endpoint into a env var.
+   */
+
+  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[];
@@ -181,16 +285,4 @@ export declare type DeployConfigKubernetes = {
 
   values?: DeployConfigKubernetesValues;
 } & DeployConfigBase;
-declare type DeployConfigCustom = {
-  type: "custom";
-  requiresDocker: boolean;
-  script: string[];
-  stopScript?: string[];
-} & DeployConfigBase;
-export declare type DeployConfig = DeployConfigKubernetes | DeployConfigCustom;
-export declare const isOfDeployType: <T extends ("kubernetes" | "custom")[]>(t: DeployConfig | false, ...types: T) => t is Extract<DeployConfigKubernetes, {
-  type: T[number];
-}> | Extract<DeployConfigCustom, {
-  type: T[number];
-}>;
 export {};

package/dist/deploy/types/kubernetes.js

@@ -0,0 +1,3 @@
+"use strict";
+
+exports.__esModule = true;

package/dist/deploy/utils.d.ts

@@ -1,5 +1,5 @@
-import { Config, Context } from "../types";
-import { DeployConfigKubernetesCluster } from "./types";
+import type { Config, Context } from "../types";
+import type { DeployConfigKubernetesCluster } from "./types";
 export declare const getFullKubernetesClusterName: (cluster: DeployConfigKubernetesCluster) => string | undefined;
 export declare const getKubernetesNamespace: (config: Pick<Config, "customerName" | "appName">, env: string) => string;
 export declare const contextIsStoppable: (context: Context) => boolean;

package/dist/deploy/utils.js

@@ -26,6 +26,10 @@ var contextIsStoppable = function (context) {
     return true;
   }
 
+  if ((0, types_1.isOfDeployType)(deployConfig, "google-cloudrun")) {
+    return true;
+  }
+
   if ((0, types_1.isOfDeployType)(deployConfig, "custom") && deployConfig.stopScript) {
     return true;
   }

package/dist/pipeline/createChildPipeline.d.ts

@@ -1,3 +1,3 @@
-import { Pipeline } from "../types";
-import { Config, PipelineTrigger } from "../types/config";
+import type { Pipeline } from "../types";
+import type { Config, PipelineTrigger } from "../types/config";
 export declare const createChildPipeline: <T extends "gitlab">(type: T, trigger: PipelineTrigger, config: Config) => Promise<Pipeline<T>>;

package/dist/pipeline/createChildPipeline.js

@@ -199,9 +199,9 @@ var rules_1 = require("../rules");
 
 var runner_1 = require("../runner");
 
-var createJobs_1 = require("./createJobs");
+var jobs_1 = require("../types/jobs");
 
-var baseStages = ["setup", "test", "build", "deploy", "verify", "stop"];
+var createJobs_1 = require("./createJobs");
 
 var createChildPipeline = function (type, trigger, config) {
   return __awaiter(void 0, void 0, void 0, function () {
@@ -243,7 +243,7 @@ var createChildPipeline = function (type, trigger, config) {
         case 1:
           jobs = _a.sent();
           allEnvs = (0, config_1.getAllEnvsInAllComponents)(config);
-          stages = baseStages.reduce(function (acc, baseStage) {
+          stages = jobs_1.BASE_STAGES.reduce(function (acc, baseStage) {
             return __spreadArray(__spreadArray(__spreadArray([], __read(acc), false), [baseStage], false), __read(allEnvs.map(function (e) {
               return "".concat(baseStage, " ").concat(e);
             })), false);

package/dist/pipeline/createJobs.d.ts

@@ -1,3 +1,3 @@
-import { PipelineJob } from "../types";
-import { Config, PipelineTrigger } from "../types/config";
+import type { PipelineJob } from "../types";
+import type { Config, PipelineTrigger } from "../types/config";
 export declare const createJobs: <T extends "gitlab">(type: T, envs: string[], config: Config, componentName: string, trigger: PipelineTrigger) => Promise<Record<string, PipelineJob<T>>>;

package/dist/pipeline/createJobs.js

@@ -277,18 +277,28 @@ var getFullReferencedJobName = function (referencedJobName, componentName, env,
 
 
 var replaceReferences = function (job, componentName, env, allRawJobs) {
-  var _a, _b;
+  var _a, _b, _c;
 
   var stage = job.envMode === "stagePerEnv" ? "".concat(job.stage, " ").concat(env) : job.stage;
+  var needsFromNeeds = (_a = job.needs) === null || _a === void 0 ? void 0 : _a.map(function (n) {
+    return (0, lodash_1.isObject)(n) ? {
+      job: getFullReferencedJobName(n.job, componentName, env, allRawJobs),
+      artifacts: n.artifacts
+    } : getFullReferencedJobName(n, componentName, env, allRawJobs);
+  });
+  var needsFromOtherComponents = (_b = job.needsOtherComponent) === null || _b === void 0 ? void 0 : _b.map(function (other) {
+    return {
+      artifacts: other.artifacts,
+      job: getFullReferencedJobName(other.job, other.componentName, env, allRawJobs)
+    };
+  });
+
+  var needs = __spreadArray(__spreadArray([], __read(needsFromNeeds !== null && needsFromNeeds !== void 0 ? needsFromNeeds : []), false), __read(needsFromOtherComponents !== null && needsFromOtherComponents !== void 0 ? needsFromOtherComponents : []), false);
+
   return __assign(__assign({}, job), {
     stage: stage,
-    needs: (_a = job.needs) === null || _a === void 0 ? void 0 : _a.map(function (n) {
-      return (0, lodash_1.isObject)(n) ? {
-        job: getFullReferencedJobName(n.job, componentName, env, allRawJobs),
-        artifacts: n.artifacts
-      } : getFullReferencedJobName(n, componentName, env, allRawJobs);
-    }),
-    environment: ((_b = job.environment) === null || _b === void 0 ? void 0 : _b.on_stop) ? __assign(__assign({}, job.environment), {
+    needs: needs,
+    environment: ((_c = job.environment) === null || _c === void 0 ? void 0 : _c.on_stop) ? __assign(__assign({}, job.environment), {
       on_stop: getFullReferencedJobName(job.environment.on_stop, componentName, env, allRawJobs)
     }) : job.environment
   });
@@ -357,23 +367,51 @@ var createJobs = function (type, envs, config, componentName, trigger) {
           return [2
           /*return*/
           , envs.reduce(function (acc, env) {
-            var context = (0, context_1.createContext)(config, componentName, env, commitInfo, packageManagerInfo);
-            var jobs = addStageNeeds(createRawJobs(context));
-
-            var result = __assign(__assign({}, acc), jobs.reduce(function (acc, job) {
-              var _a;
-
-              var jobWithResolvedReferences = replaceReferences(job, componentName, env, jobs);
-              var jobName = getFullJobName(job.name, componentName, job.envMode !== "none" ? env : undefined);
-
-              if (type === "gitlab") {
-                return __assign(__assign({}, acc), (_a = {}, _a[jobName] = (0, makeGitlabJob_1.makeGitlabJob)(jobWithResolvedReferences), _a));
-              }
-
-              throw new Error("not supported");
-            }, {}));
-
-            return result;
+            return __awaiter(void 0, void 0, void 0, function () {
+              var context, jobs, result, _a, _b, _c, _d, _e;
+
+              return __generator(this, function (_f) {
+                switch (_f.label) {
+                  case 0:
+                    return [4
+                    /*yield*/
+                    , (0, context_1.createContext)(config, componentName, env, commitInfo, packageManagerInfo)];
+
+                  case 1:
+                    context = _f.sent();
+                    jobs = addStageNeeds(createRawJobs(context));
+                    _a = [{}];
+                    return [4
+                    /*yield*/
+                    , acc];
+
+                  case 2:
+                    _b = [__assign.apply(void 0, _a.concat([_f.sent()]))];
+                    _d = (_c = jobs).reduce;
+                    _e = [function (acc, job) {
+                      var _a;
+
+                      var jobWithResolvedReferences = replaceReferences(job, componentName, env, jobs);
+                      var jobName = getFullJobName(job.name, componentName, job.envMode !== "none" ? env : undefined);
+
+                      if (type === "gitlab") {
+                        return __assign(__assign({}, acc), (_a = {}, _a[jobName] = (0, makeGitlabJob_1.makeGitlabJob)(jobWithResolvedReferences), _a));
+                      }
+
+                      throw new Error("not supported");
+                    }];
+                    return [4
+                    /*yield*/
+                    , Promise.resolve({})];
+
+                  case 3:
+                    result = __assign.apply(void 0, _b.concat([_d.apply(_c, _e.concat([_f.sent()]))]));
+                    return [2
+                    /*return*/
+                    , result];
+                }
+              });
+            });
           }, {})];
       }
     });

package/dist/pipeline/gitlab/makeGitlabJob.d.ts

@@ -1,8 +1,9 @@
-import { GitlabJobDef } from "../../types";
-import { CatladderJob } from "../../types/jobs";
+import type { GitlabJobDef } from "../../types";
+import type { CatladderJob } from "../../types/jobs";
 export declare const makeGitlabJob: ({
   envMode,
   needsStages,
+  needsOtherComponent,
   name,
   ...rest
 }: CatladderJob<string>) => GitlabJobDef;

package/dist/pipeline/gitlab/makeGitlabJob.js

@@ -33,8 +33,9 @@ var defaults_1 = require("../../defaults");
 var makeGitlabJob = function (_a) {
   var envMode = _a.envMode,
       needsStages = _a.needsStages,
+      needsOtherComponent = _a.needsOtherComponent,
       name = _a.name,
-      rest = __rest(_a, ["envMode", "needsStages", "name"]);
+      rest = __rest(_a, ["envMode", "needsStages", "needsOtherComponent", "name"]);
 
   return __assign(__assign({}, rest), {
     retry: defaults_1.BASE_RETRY,

package/dist/pipeline/packageManager.d.ts

@@ -1,2 +1,2 @@
-import { Config, PackageManagerInfo } from "../types";
+import type { Config, PackageManagerInfo } from "../types";
 export declare const getPackageManagerInfo: (config: Config, componentName: string) => Promise<PackageManagerInfo>;

package/dist/rules/index.d.ts

@@ -1,3 +1,3 @@
-import { GitlabRule } from "../types";
+import type { GitlabRule } from "../types";
 export declare const RULES_ALWAYS: GitlabRule[];
 export declare const RULES_RELEASE: GitlabRule[];

package/dist/runner/index.d.ts

@@ -1,3 +1,2 @@
-declare type RunnerImageName = "jobs-default" | "jobs-meteor" | "jobs-testing-chrome" | "kubernetes" | "base-pipeline" | "docker-build" | "semantic-release";
-export declare const getRunnerImage: (imageName: RunnerImageName) => string;
-export {};
+export declare type RunnerImageName = "jobs-default" | "jobs-meteor" | "jobs-testing-chrome" | "kubernetes" | "base-pipeline" | "docker-build" | "gcloud" | "semantic-release";
+export declare const getRunnerImage: (imageName: RunnerImageName) => string;