@serve.zone/dcrouter 32.0.0 → 32.0.1

package/ts/opsserver/handlers/gatewayclient.handler.ts

@@ -11,6 +11,12 @@ import {
   normalizeGatewayTargetHost,
   requireGatewayMachineAuth,
 } from '../helpers/gateway-client-auth.js';
+import {
+  buildGatewayClientHostRouteKey,
+  buildGatewayClientRouteName,
+  parseGatewayClientHostRouteKey,
+} from '../helpers/gateway-client-route-key.js';
+import { logger } from '../../logger.js';
 
 type TResolvedGatewayClientOwnership = Required<Pick<plugins.servezoneInterfaces.data.IGatewayClientOwnership,
   'gatewayClientType' | 'gatewayClientId' | 'appId'
@@ -1171,15 +1177,22 @@ export class GatewayClientHandler {
     const routeKey = metadata.externalKey?.startsWith(prefix)
       ? metadata.externalKey.slice(prefix.length)
       : '';
-    const combinedOwnership = this.parseCombinedGatewayClientRouteKey(routeKey);
+    const combinedOwnership = parseGatewayClientHostRouteKey(routeKey);
     if (combinedOwnership) {
       ownership.hostname = combinedOwnership.hostname;
       ownership.routeRef = combinedOwnership.routeRef;
-    } else if (routeKey.startsWith('v2:host-route:')) {
-      // A malformed versioned key must not be exposed as a hostname.
-      ownership.hostname = this.getRouteHostnames(routeArg.route)[0];
     } else if (routeKey.startsWith('route:')) {
       ownership.routeRef = routeKey.slice('route:'.length);
+    } else if (routeKey.includes(':')) {
+      // A hostname carries no colon, so a colon-bearing key that parses as neither of the two
+      // other forms states ownership this router cannot prove. Report what the route actually
+      // serves rather than the key, and say so instead of dropping the key silently.
+      logger.log(
+        'warn',
+        `Gateway client route ${routeArg.id} carries a malformed route key '${routeKey}'; listing it with its route hostname only.`,
+        { routeId: routeArg.id },
+      );
+      ownership.hostname = this.getRouteHostnames(routeArg.route)[0];
     } else if (routeKey) {
       ownership.hostname = routeKey;
     } else {
@@ -1659,8 +1672,7 @@ export class GatewayClientHandler {
     const routeRef = ownership.routeRef?.trim();
     let routeKey: string;
     if (hostname && routeRef) {
-      const payload = Buffer.from(JSON.stringify([hostname, routeRef]), 'utf8').toString('base64url');
-      routeKey = `v2:host-route:${payload}`;
+      routeKey = buildGatewayClientHostRouteKey(hostname, routeRef);
     } else if (hostname) {
       routeKey = hostname;
     } else {
@@ -1674,35 +1686,6 @@ export class GatewayClientHandler {
     ].map((part) => part.trim()).join(':');
   }
 
-  private parseCombinedGatewayClientRouteKey(
-    routeKeyArg: string,
-  ): { hostname: string; routeRef: string } | undefined {
-    const prefix = 'v2:host-route:';
-    if (!routeKeyArg.startsWith(prefix)) {
-      return undefined;
-    }
-    const payload = routeKeyArg.slice(prefix.length);
-    if (!payload || !/^[A-Za-z0-9_-]+$/.test(payload)) {
-      return undefined;
-    }
-    try {
-      const parsed = JSON.parse(Buffer.from(payload, 'base64url').toString('utf8'));
-      if (
-        !Array.isArray(parsed)
-        || parsed.length !== 2
-        || parsed.some((value) => typeof value !== 'string' || !value.trim())
-      ) {
-        return undefined;
-      }
-      return {
-        hostname: parsed[0].trim().toLowerCase(),
-        routeRef: parsed[1].trim(),
-      };
-    } catch {
-      return undefined;
-    }
-  }
-
   private validateGatewayRouteConfig(
     routeArg: unknown,
   ): plugins.servezoneInterfaces.data.IGatewayRouteConfig {
@@ -1882,7 +1865,7 @@ export class GatewayClientHandler {
       } as any;
     }
     if (!normalizedRoute.name) {
-      normalizedRoute.name = `gateway-client-${externalKey.replace(/[^a-zA-Z0-9-]+/g, '-').slice(0, 80)}`;
+      normalizedRoute.name = buildGatewayClientRouteName(externalKey);
     }
     return normalizedRoute;
   }

package/ts/opsserver/helpers/gateway-client-route-key.ts

@@ -0,0 +1,64 @@
+/**
+ * The route-key half of a gateway-client route's `externalKey`, owned here so the composer,
+ * the parser, the generated route name and the migration that rewrote stored keys all read
+ * one spelling.
+ *
+ * A stored key is `<gatewayClientType>:<gatewayClientId>:<appId>:<routeKey>`, and the route key
+ * is one of three forms: a bare hostname, `route:<routeRef>` when the client owns a route
+ * reference without a hostname, and the combined form below when it owns one hostname under a
+ * specific route reference. The combined payload is base64url so the whole key stays one opaque
+ * segment, and neither other form can be mistaken for it: a hostname carries no colon, and the
+ * route-reference form has a different prefix.
+ */
+export const gatewayClientHostRouteKeyPrefix = 'host-route:';
+
+export interface IGatewayClientHostRouteKey {
+  hostname: string;
+  routeRef: string;
+}
+
+export function buildGatewayClientHostRouteKey(
+  hostnameArg: string,
+  routeRefArg: string,
+): string {
+  const payload = Buffer.from(JSON.stringify([hostnameArg, routeRefArg]), 'utf8').toString('base64url');
+  return `${gatewayClientHostRouteKeyPrefix}${payload}`;
+}
+
+/**
+ * Read a combined route key back. Returns undefined for every key that is not one — including a
+ * key that carries the prefix but no decodable payload, so a malformed key can never be served
+ * as ownership it does not state.
+ */
+export function parseGatewayClientHostRouteKey(
+  routeKeyArg: string,
+): IGatewayClientHostRouteKey | undefined {
+  if (!routeKeyArg.startsWith(gatewayClientHostRouteKeyPrefix)) {
+    return undefined;
+  }
+  const payload = routeKeyArg.slice(gatewayClientHostRouteKeyPrefix.length);
+  if (!payload || !/^[A-Za-z0-9_-]+$/.test(payload)) {
+    return undefined;
+  }
+  try {
+    const parsed = JSON.parse(Buffer.from(payload, 'base64url').toString('utf8'));
+    if (
+      !Array.isArray(parsed)
+      || parsed.length !== 2
+      || parsed.some((value) => typeof value !== 'string' || !value.trim())
+    ) {
+      return undefined;
+    }
+    return {
+      hostname: parsed[0].trim().toLowerCase(),
+      routeRef: parsed[1].trim(),
+    };
+  } catch {
+    return undefined;
+  }
+}
+
+/** The route name generated for a gateway-client route whose producer sent none. */
+export function buildGatewayClientRouteName(externalKeyArg: string): string {
+  return `gateway-client-${externalKeyArg.replace(/[^a-zA-Z0-9-]+/g, '-').slice(0, 80)}`;
+}

package/ts_web/00_commitinfo_data.ts

@@ -2,7 +2,7 @@
  * autocreated commitinfo by @push.rocks/commitinfo
  */
 export const commitinfo = {
-  name: "@serve.zone/dcrouter",
-  version: "32.0.0",
-  description: "A multifaceted routing service handling mail and SMS delivery functions."
+  name: '@serve.zone/dcrouter',
+  version: '32.0.1',
+  description: 'A multifaceted routing service handling mail and SMS delivery functions.'
 }