@catladder/cli 0.0.0-fix-changeset-hint-package-manager-20002c27 → 0.0.0-fix-github-gating-release-push-fbb576dc

package/dist/bundles/catenv/index.js

@@ -9632,9 +9632,14 @@ exports.GCLOUD_RUN_DEPLOY_TYPE = {
         // generation time. For review envs the service name part still
         // contains a runtime expression (the review slug), so the host stays
         // a bash expression there; the suffix is always a literal.
+        //
+        // The service name has to come from getRawServiceNameForEnvContext,
+        // not from fullName: it is shortened when the label would otherwise
+        // exceed what cloud run serves deterministically, and the url must
+        // name the service that is actually deployed.
         const HOSTNAME_INTERNAL = deployConfigRaw && envType !== "local"
             ? (0, bash_1.joinBashExpressions)([
-                fullName,
+                (0, getServiceName_1.getRawServiceNameForEnvContext)(ctx),
                 `${(0, store_1.getGcloudProjectNumber)(fullConfig, deployConfigRaw.projectId)}.${deployConfigRaw.region}.run.app`,
             ], "-").toLowerCase()
             : undefined;
@@ -9896,16 +9901,197 @@ exports.getCloudRunServiceOrJobArgsArg = getCloudRunServiceOrJobArgsArg;
 /***/ }),
 
 /***/ 33102:
-/***/ ((__unused_webpack_module, exports) => {
+/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
 
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.getServiceNameForEnvContext = exports.getServiceName = void 0;
-const getServiceName = (context) => context.environment.fullName.toLowerCase();
+exports.getRawServiceNameForEnvContext = exports.getServiceNameForEnvContext = exports.getServiceName = exports.resolveCloudRunComponentPart = exports.REVIEW_SLUG_LENGTH_BUDGET = exports.CLOUD_RUN_DNS_SEGMENT_LIMIT = void 0;
+const bash_1 = __nccwpck_require__(94143);
+const store_1 = __nccwpck_require__(2789);
+/**
+ * cloud run only serves its deterministic url
+ * `https://<service>-<projectNumber>.<region>.run.app` while that first dns
+ * label stays within the 63 characters a dns label allows — the label holds
+ * the service name, the project number and any traffic tag together.
+ *
+ * Beyond it cloud run silently switches to a legacy url built from a random
+ * identifier that nothing can recompute. The url catladder generates would
+ * then be a hostname that can never resolve, and everything consuming
+ * ROOT_URL/ROOT_URL_INTERNAL (cloud tasks targets, service-to-service
+ * calls) fails with a dns error instead of a helpful one — which is why the
+ * component part is shortened to stay under the limit rather than left to
+ * overflow.
+ *
+ * https://cloud.google.com/run/docs/triggering/https-request
+ */
+exports.CLOUD_RUN_DNS_SEGMENT_LIMIT = 63;
+/**
+ * review environments resolve their slug at runtime (`mr<iid>` on gitlab,
+ * `pr<number>` on github), so its exact length is unknown while generating.
+ * Budget for a six digit number so that service names — and with them the
+ * urls of already deployed services — do not start changing years later
+ * just because a project's merge request numbers grew a digit.
+ */
+exports.REVIEW_SLUG_LENGTH_BUDGET = "mr123456".length;
+/**
+ * a service name shortened past this point is no longer recognizable. When
+ * even this does not fit, the fixed parts (customer name, app name, env,
+ * project number) are what needs to shrink — only the user can do that.
+ */
+const MIN_COMPONENT_PART_LENGTH = 6;
+const quote = (name) => `"${name}"`;
+/**
+ * a trailing dash would end up in the hostname as `...-foo-.run.app`
+ */
+const shortenTo = (name, maxLength) => name.slice(0, maxLength).replace(/-+$/, "");
+/**
+ * the component-name part of a cloud run service name, shortened just
+ * enough to keep the deterministic url resolvable.
+ *
+ * Only the component part is shortened: the env and review slug parts have
+ * to stay intact (they are what makes the name unique per environment), the
+ * project number is fixed, and customerName/appName are shared by every
+ * service of the project.
+ */
+const resolveCloudRunComponentPart = ({ customerName, appName, env, isReviewEnv, componentName, projectNumber, otherComponentNames, }) => {
+    const fixedParts = [
+        customerName,
+        appName,
+        env,
+        ...(isReviewEnv ? ["_".repeat(exports.REVIEW_SLUG_LENGTH_BUDGET)] : []),
+        projectNumber,
+    ];
+    // + 1 for the dash that joins the component part to the rest
+    const fixedLength = fixedParts.join("-").length + 1;
+    const available = exports.CLOUD_RUN_DNS_SEGMENT_LIMIT - fixedLength;
+    if (componentName.length <= available) {
+        return {
+            value: componentName,
+            dropped: 0,
+            dnsSegmentLength: fixedLength + componentName.length,
+        };
+    }
+    if (available < MIN_COMPONENT_PART_LENGTH) {
+        throw new Error(`Cannot build a resolvable cloud run url for component ${quote(componentName)} in env ${quote(env)}.\n` +
+            `Everything but the component name already takes ${fixedLength} of the ${exports.CLOUD_RUN_DNS_SEGMENT_LIMIT} characters ` +
+            `a dns label allows (${fixedParts.join("-")}-<component>), leaving only ${available} for the component name.\n` +
+            `Shorten appName (${quote(appName)}) or customerName (${quote(customerName)}) by at least ` +
+            `${MIN_COMPONENT_PART_LENGTH - available} character(s).` +
+            (isReviewEnv
+                ? `\nReview environments also carry a runtime slug, for which ${exports.REVIEW_SLUG_LENGTH_BUDGET} characters are reserved.`
+                : ""));
+    }
+    const value = shortenTo(componentName, available);
+    const colliding = otherComponentNames.filter((other) => shortenTo(other, available) === value);
+    if (colliding.length > 0) {
+        throw new Error(`Cloud run service names collide in env ${quote(env)}: ${quote(componentName)} and ` +
+            `${colliding.map(quote).join(", ")} all shorten to ${quote(value)}, so they would deploy over each other.\n` +
+            `The deterministic cloud run url allows ${exports.CLOUD_RUN_DNS_SEGMENT_LIMIT} characters, which leaves ${available} ` +
+            `for the component name here — rename the components so their first ${available} characters differ.`);
+    }
+    return {
+        value,
+        dropped: componentName.length - value.length,
+        dnsSegmentLength: fixedLength + value.length,
+    };
+};
+exports.resolveCloudRunComponentPart = resolveCloudRunComponentPart;
+/**
+ * one note per shortened service name instead of one per generated job:
+ * service names are resolved again for every job that references them
+ */
+const reportedTruncations = new Set();
+const reportTruncation = (env, componentName, { value, dnsSegmentLength }) => {
+    const key = `${env}/${componentName}`;
+    if (reportedTruncations.has(key)) {
+        return;
+    }
+    reportedTruncations.add(key);
+    console.warn(`ℹ️ component "${componentName}" deploys to cloud run as "...-${value}" in env "${env}": ` +
+        `the full name would push the url past the ${exports.CLOUD_RUN_DNS_SEGMENT_LIMIT} characters cloud run ` +
+        `serves deterministically, so the component part is shortened ` +
+        `(${dnsSegmentLength} of ${exports.CLOUD_RUN_DNS_SEGMENT_LIMIT} characters used).`);
+};
+/**
+ * the cloud run service name before lowercasing, so that callers keep
+ * lowercasing the whole expression exactly like they did before.
+ *
+ * Returns `fullName` unchanged unless the component part had to be
+ * shortened — every project whose url already fits generates byte-identical
+ * output.
+ *
+ * Note that the composition below has to match the one `fullName` is built
+ * from in getEnvironmentContext; the tests pin that they agree.
+ */
+const getRawServiceName = ({ fullName, environmentSlugPrefix, componentName, env, isReviewEnv, deployConfig, config, }) => {
+    const projectNumber = deployConfig
+        ? (0, store_1.readGcloudProjectNumber)(config, deployConfig.projectId)
+        : null;
+    if (!projectNumber) {
+        // without the project number there is no deterministic url to keep
+        // resolvable — generating the url itself fails with a store error that
+        // says how to fix it, so don't second-guess the name here
+        return fullName;
+    }
+    const componentPart = (0, exports.resolveCloudRunComponentPart)({
+        customerName: config.customerName,
+        appName: config.appName,
+        env,
+        isReviewEnv,
+        componentName,
+        projectNumber,
+        otherComponentNames: Object.keys(config.components).filter((name) => name !== componentName),
+    });
+    if (componentPart.dropped === 0) {
+        return fullName;
+    }
+    reportTruncation(env, componentName, componentPart);
+    return (0, bash_1.joinBashExpressions)([
+        config.customerName,
+        config.appName,
+        environmentSlugPrefix,
+        componentPart.value,
+    ], "-");
+};
+const fromComponentContext = (context) => {
+    var _a;
+    const deployConfig = (_a = context.deploy) === null || _a === void 0 ? void 0 : _a.config;
+    return {
+        fullName: context.environment.fullName,
+        environmentSlugPrefix: context.environment.slugPrefix,
+        componentName: context.name,
+        env: context.env,
+        isReviewEnv: context.environment.envType === "review",
+        deployConfig: deployConfig && deployConfig.type === "google-cloudrun"
+            ? deployConfig
+            : null,
+        config: context.fullConfig,
+    };
+};
+const fromEnvironmentContext = (context) => ({
+    fullName: context.fullName,
+    environmentSlugPrefix: context.environmentSlugPrefix,
+    componentName: context.componentName,
+    env: context.env,
+    isReviewEnv: context.envType === "review",
+    deployConfig: context.deployConfigRaw || null,
+    config: context.fullConfig,
+});
+/**
+ * the cloud run service name as it is passed to `gcloud run` — lowercased,
+ * and shortened when the deterministic url would otherwise not fit.
+ */
+const getServiceName = (context) => getRawServiceName(fromComponentContext(context)).toLowerCase();
 exports.getServiceName = getServiceName;
-const getServiceNameForEnvContext = (context) => context.fullName.toLowerCase();
+const getServiceNameForEnvContext = (context) => getRawServiceName(fromEnvironmentContext(context)).toLowerCase();
 exports.getServiceNameForEnvContext = getServiceNameForEnvContext;
+/**
+ * the service name part of the deterministic url, still to be lowercased
+ * together with the rest of the hostname by the caller.
+ */
+const getRawServiceNameForEnvContext = (context) => getRawServiceName(fromEnvironmentContext(context));
+exports.getRawServiceNameForEnvContext = getRawServiceNameForEnvContext;
 //# sourceMappingURL=getServiceName.js.map
 
 /***/ }),
@@ -12322,7 +12508,7 @@ exports.getRunnerImage = getRunnerImage;
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.getGcloudProjectNumber = exports.readCatladderStore = exports.getCatladderStorePath = exports.catladderStoreSchema = exports.CATLADDER_STORE_FILE = exports.CATLADDER_STORE_FILE_NAME = exports.CATLADDER_STORE_DIR = void 0;
+exports.getGcloudProjectNumber = exports.readGcloudProjectNumber = exports.readCatladderStore = exports.getCatladderStorePath = exports.catladderStoreSchema = exports.CATLADDER_STORE_FILE = exports.CATLADDER_STORE_FILE_NAME = exports.CATLADDER_STORE_DIR = void 0;
 const fs_1 = __nccwpck_require__(79896);
 const path_1 = __nccwpck_require__(16928);
 const yaml_1 = __nccwpck_require__(99292);
@@ -12374,6 +12560,13 @@ const readCatladderStore = (directory = process.cwd()) => {
     }
 };
 exports.readCatladderStore = readCatladderStore;
+/**
+ * gcloud project number from the store, or null when it has not been
+ * fetched yet. Use this where a missing number is not itself the problem —
+ * `getGcloudProjectNumber` is the one that reports it.
+ */
+const readGcloudProjectNumber = (config, projectId) => { var _a, _b, _c, _d; return (_d = (_c = (_b = (_a = config.store) === null || _a === void 0 ? void 0 : _a.gcloudProjects) === null || _b === void 0 ? void 0 : _b[projectId]) === null || _c === void 0 ? void 0 : _c.projectNumber) !== null && _d !== void 0 ? _d : null; };
+exports.readGcloudProjectNumber = readGcloudProjectNumber;
 /**
  * gcloud project number from the store — needed to compute deterministic
  * cloud run urls (`<service>-<projectNumber>.<region>.run.app`) at
@@ -12383,8 +12576,7 @@ exports.readCatladderStore = readCatladderStore;
  * catenv fail until `catladder project setup` has stored it.
  */
 const getGcloudProjectNumber = (config, projectId) => {
-    var _a, _b, _c;
-    const projectNumber = (_c = (_b = (_a = config.store) === null || _a === void 0 ? void 0 : _a.gcloudProjects) === null || _b === void 0 ? void 0 : _b[projectId]) === null || _c === void 0 ? void 0 : _c.projectNumber;
+    const projectNumber = (0, exports.readGcloudProjectNumber)(config, projectId);
     if (!projectNumber) {
         throw new Error(`Missing gcloud project number for project "${projectId}" in ${exports.CATLADDER_STORE_FILE}.\n` +
             `Run "catladder project setup" to fetch and store it.`);