@serve.zone/interfaces 32.29.0 → 32.30.0

package/ts/data/serviceruntime.ts

@@ -33,7 +33,8 @@ export interface IServiceRuntimeProfile {
 
 /**
  * `isolated` gives the workload no network authority. `attached` joins the runtime network with
- * public egress on or off and the platform endpoints it may reach, by id: sorted and unique.
+ * public egress on or off and the platform endpoints it may reach, by id: sorted and unique. The
+ * service's `IServiceNetworkEgress` must state the same values, or the workload is not admitted.
  */
 export type TServiceRuntimeNetwork =
   | { mode: 'isolated' }
@@ -89,7 +90,7 @@ const serviceRuntimeRefusals = [
   'volume-driver-unsupported', 'volume-options-unsupported', 'volume-shared-unsupported',
   'volume-placement-unsupported', 'volume-initialization-unknown', 'volume-ownership-unknown',
   'objectstorage-endpoint-missing', 'objectstorage-binding-invalid', 'objectstorage-environment-conflict',
-  'database-endpoint-missing',
+  'objectstorage-endpoint-unselected', 'database-endpoint-missing', 'database-endpoint-unselected',
 ] as const;
 
 /**
@@ -114,7 +115,8 @@ export type TServiceRuntimeWaitingReason = typeof serviceRuntimeWaitingReasons[n
  * `port-protocol-unsupported` is about one port's protocol — and `node-authority-unsupported` is a
  * node whose session resolved fewer workload authorities than this spec needs, which the admit step
  * refuses rather than handing the node work it would silently park. An attached network needs an
- * explicit matching policy and a current workload address pool; neither is defaulted.
+ * explicit matching policy (`IServiceNetworkEgress`, written by `setServiceNetworkEgress`) and a
+ * current workload address pool; neither is defaulted.
  *
  * The volume refusals name what a local storage claim cannot express: `volume-driver-unsupported`
  * a volume of a driver other than a node-local directory, `volume-options-unsupported` driver or
@@ -133,6 +135,20 @@ export type TServiceRuntimeWaitingReason = typeof serviceRuntimeWaitingReasons[n
  * `database-endpoint-missing` is an enabled database binding placed on a node that states no valid
  * `corestoreDatabase`: its credential cannot be addressed to any host a workload reaches, so it is
  * neither granted nor published, and the workload is not started with a guessed one.
+ *
+ * The two `-unselected` refusals name a binding endpoint the workload's network cannot reach, so a
+ * workload is refused rather than started against a connection that stays dark. A workload reaches
+ * a platform endpoint only when its spec's attached network selects it (`platformEndpointIds`), and
+ * an `isolated` network selects none. `database-endpoint-unselected` is an enabled database binding
+ * whose node's valid `corestoreDatabase` is not a selected endpoint: none of the selected
+ * `IRuntimeNetworkProtectedAuthority.platformEndpoints` has the endpoint's `host` as its `address`,
+ * `tcp` as its `protocol` and the endpoint's `port` as its `port`. `objectstorage-endpoint-unselected`
+ * is the same for an enabled object-storage binding's node's valid `corestoreObjectStorage`, whose
+ * `endpoint` origin states the host and the port (the scheme's default, 80 for `http:` and 443 for
+ * `https:`, when it states none). Platform endpoints are IPv4, so an endpoint whose host is a DNS name
+ * or an IPv6 literal is never selected. Each is judged only for an endpoint that is valid: a node
+ * stating none, or an invalid one, stays `database-endpoint-missing` or `objectstorage-endpoint-missing`.
+ * `platform.findUnselectedCorestoreEndpoints` is this rule; a producer answers what it returns.
  */
 export type TServiceRuntimeRefusal = typeof serviceRuntimeRefusals[number];
 

package/ts/platform/corestoreendpointselection.ts

@@ -0,0 +1,79 @@
+import type { IRuntimeNetworkProtectedAuthority } from '../data/networkauthority.js';
+import type { TServiceRuntimeNetwork, TServiceRuntimeRefusal } from '../data/serviceruntime.js';
+import { isNetworkIpv4 } from '../private/networkcontract.js';
+import { validatePlatformDatabaseEndpoint, type IPlatformDatabaseEndpoint } from './database.js';
+import { validatePlatformObjectStorageEndpoint, type IPlatformObjectStorageEndpoint } from './objectstorage.js';
+
+/** The service runtime refusals a Corestore endpoint the workload's network does not select raises. */
+export type TCorestoreEndpointSelectionRefusal = Extract<TServiceRuntimeRefusal,
+  'database-endpoint-unselected' | 'objectstorage-endpoint-unselected'>;
+
+/** What `findUnselectedCorestoreEndpoints` judges for one node a service's bindings are placed on. */
+export interface ICorestoreEndpointSelection {
+  /**
+   * The node's `corestoreDatabase` when an enabled database binding of the service is placed on it,
+   * otherwise `null`. A node stating none is `database-endpoint-missing`, never judged here.
+   */
+  database: IPlatformDatabaseEndpoint | null;
+  /**
+   * The node's `corestoreObjectStorage` when an enabled object-storage binding of the service is
+   * placed on it, otherwise `null`. A node stating none is `objectstorage-endpoint-missing`.
+   */
+  objectStorage: IPlatformObjectStorageEndpoint | null;
+  /** The current protected authority's platform endpoints, which the selected ids resolve against. */
+  platformEndpoints: IRuntimeNetworkProtectedAuthority['platformEndpoints'];
+  /** The runtime spec's network: `attached` selects its `platformEndpointIds`, `isolated` selects none. */
+  network: TServiceRuntimeNetwork;
+}
+
+type TPlatformEndpoint = IRuntimeNetworkProtectedAuthority['platformEndpoints'][number];
+
+const selectedPlatformEndpoints = (selectionArg: ICorestoreEndpointSelection): TPlatformEndpoint[] => {
+  if (selectionArg.network.mode !== 'attached') return [];
+  const selectedIds = new Set(selectionArg.network.platformEndpointIds);
+  return selectionArg.platformEndpoints.filter((endpointArg) => selectedIds.has(endpointArg.id));
+};
+
+/** Platform endpoints are IPv4, so only a canonical IPv4 host can be one; a DNS name or IPv6 literal never is. */
+const selectsTcp = (endpointsArg: TPlatformEndpoint[], hostArg: string, portArg: number): boolean => (
+  isNetworkIpv4(hostArg) && endpointsArg.some((endpointArg) => endpointArg.address === hostArg
+    && endpointArg.protocol === 'tcp' && endpointArg.port === portArg)
+);
+
+/** The origin's port, or the scheme's default (80 for `http:`, 443 for `https:`) when it states none. */
+const objectStorageOriginPort = (originArg: URL): number => (
+  originArg.port === '' ? (originArg.protocol === 'https:' ? 443 : 80) : Number(originArg.port)
+);
+
+/**
+ * Which of a node's Corestore endpoints a service's workload would dial without its network
+ * selecting them, as the service runtime refusals that name them; empty when none.
+ *
+ * An endpoint is selected when one of the spec's selected platform endpoints has the endpoint's host
+ * as its `address`, `tcp` as its `protocol` and the endpoint's port as its `port`: the database
+ * endpoint's `host` and `port`, and the object-storage endpoint origin's host and port, or 80 for
+ * `http:` and 443 for `https:` when the origin states none. An `isolated` network selects nothing, a
+ * selected id the protected authority does not hold selects nothing, and a DNS-name or IPv6 host is
+ * never selected. Only a valid endpoint is judged: one `validatePlatformDatabaseEndpoint` or
+ * `validatePlatformObjectStorageEndpoint` refuses is the `-missing` refusal's, not this one's. The
+ * answer is sorted, so it does not depend on the order of the inputs.
+ */
+export const findUnselectedCorestoreEndpoints = (
+  selectionArg: ICorestoreEndpointSelection,
+): TCorestoreEndpointSelectionRefusal[] => {
+  const selected = selectedPlatformEndpoints(selectionArg);
+  const refusals: TCorestoreEndpointSelectionRefusal[] = [];
+  const database = selectionArg.database;
+  if (database !== null && validatePlatformDatabaseEndpoint(database).length === 0
+    && !selectsTcp(selected, database.host, database.port)) {
+    refusals.push('database-endpoint-unselected');
+  }
+  const objectStorage = selectionArg.objectStorage;
+  if (objectStorage !== null && validatePlatformObjectStorageEndpoint(objectStorage).length === 0) {
+    const origin = new URL(objectStorage.endpoint);
+    if (!selectsTcp(selected, origin.hostname, objectStorageOriginPort(origin))) {
+      refusals.push('objectstorage-endpoint-unselected');
+    }
+  }
+  return refusals;
+};

package/ts/platform/index.ts

@@ -1,5 +1,6 @@
 import * as ai from './ai.js';
 import * as backup from './backup.js';
+import * as corestoreendpointselection from './corestoreendpointselection.js';
 import * as database from './database.js';
 import * as email from './email.js';
 import * as letter from './letter.js';
@@ -17,6 +18,7 @@ import * as types from './types.js';
 export {
   ai,
   backup,
+  corestoreendpointselection,
   database,
   email,
   letter,
@@ -32,6 +34,7 @@ export {
   types,
 };
 
+export * from './corestoreendpointselection.js';
 export * from './database.js';
 export * from './storage.js';
 export * from './objectstorage.js';

package/ts/platform/objectstorage.ts

@@ -102,6 +102,10 @@ export const validatePlatformObjectStorageEndpoint = (
         errors.push(`${pathArg} endpoint must be a canonical origin without a path, query, `
           + 'fragment, trailing slash or default port');
       }
+      // A URL parser refuses a port above 65535 but reads port 0 as stated; no workload dials it.
+      if (parsedEndpoint.port !== '' && Number(parsedEndpoint.port) < 1) {
+        errors.push(`${pathArg} endpoint port must be from 1 to 65535`);
+      }
     }
   }
   if (typeof valueArg.region !== 'string'

package/ts/private/networkcontract.ts

@@ -209,10 +209,14 @@ export const networkHash = async (domain: string, value: { digest: TSha256Digest
   const { digest: omitted, ...payload } = value;
   return `sha256:${await createCanonicalJsonSha256Hex(networkCanonical({ domain, payload }), failNetwork)}`;
 };
-export const networkIpv4 = (value: unknown): string => {
-  requireNetwork(typeof value === 'string' && value.length <= 15);
+/** A canonical dotted-quad IPv4 literal: four decimal octets, no leading zeros. */
+export const isNetworkIpv4 = (value: unknown): value is string => {
+  if (typeof value !== 'string' || value.length > 15) return false;
   const parts = value.split('.');
-  requireNetwork(parts.length === 4 && parts.every(part => /^(?:0|[1-9][0-9]{0,2})$/.test(part) && Number(part) <= 255));
+  return parts.length === 4 && parts.every(part => /^(?:0|[1-9][0-9]{0,2})$/.test(part) && Number(part) <= 255);
+};
+export const networkIpv4 = (value: unknown): string => {
+  requireNetwork(isNetworkIpv4(value));
   return value;
 };
 export const networkIpv4Number = (value: string): number => value.split('.').reduce((sum, part) => sum * 256 + Number(part), 0);

package/ts/requests/network.ts

@@ -6,7 +6,9 @@ import type {
   IPrivateNetwork, IServicePrivateNetworks, ISetServicePrivateNetworks,
   TPrivateNetworkMutation,
 } from '../data/privatenetwork.js';
-import type { IServicePublishedPorts, ISetServicePublishedPorts } from '../data/networkprojection.js';
+import type {
+  IServiceNetworkEgress, IServicePublishedPorts, ISetServiceNetworkEgress, ISetServicePublishedPorts,
+} from '../data/networkprojection.js';
 
 /** Current organization picker data. Entries are never cached authorization grants. */
 export interface IReq_Cloudly_ListOwnedOrganizations extends plugins.typedrequestInterfaces.implementsTR<
@@ -71,7 +73,7 @@ export interface IReq_Cloudly_SetServicePrivateNetworks extends plugins.typedreq
   response: { membership: IServicePrivateNetworks; replayed: boolean };
 }
 
-/** null means the service has never had an authorized published-port policy. */
+/** null means the service has never had a policy document, neither published ports nor egress. */
 export interface IReq_Cloudly_GetServicePublishedPorts extends plugins.typedrequestInterfaces.implementsTR<
   plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_GetServicePublishedPorts
 > {
@@ -80,6 +82,17 @@ export interface IReq_Cloudly_GetServicePublishedPorts extends plugins.typedrequ
   response: { publishedPorts: IServicePublishedPorts | null };
 }
 
+/**
+ * Writes the published-port half of one service's policy document, carrying its egress forward.
+ *
+ * One document per service holds its published ports and its egress under one `revision`. The
+ * first accepted write of either (`expectedRevision: null`) creates it: `setServicePublishedPorts`
+ * with egress `publicEgress: false` and `platformEndpointIds: []`, `setServiceNetworkEgress` with
+ * no published ports. From then on both reads return it, never null. It is an explicit policy: an
+ * attached spec stating `publicEgress: false` and `platformEndpointIds: []` matches it and reaches
+ * no public address and no platform endpoint; `network-policy-missing` means the service has no
+ * document at all.
+ */
 export interface IReq_Cloudly_SetServicePublishedPorts extends plugins.typedrequestInterfaces.implementsTR<
   plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_SetServicePublishedPorts
 > {
@@ -93,6 +106,47 @@ export interface IReq_Cloudly_SetServicePublishedPorts extends plugins.typedrequ
   response: { publishedPorts: IServicePublishedPorts; replayed: boolean };
 }
 
+/**
+ * The egress half of one service's policy document; null means the service has never had a policy
+ * document. Only a verified administrator reads it: platform endpoints are platform authority.
+ */
+export interface IReq_Admin_Cloudly_GetServiceNetworkEgress extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest, IReq_Admin_Cloudly_GetServiceNetworkEgress
+> {
+  method: 'getServiceNetworkEgress';
+  request: { identity: IIdentityCredential; organizationId: string; serviceId: string };
+  response: { networkEgress: IServiceNetworkEgress | null };
+}
+
+/**
+ * Writes the egress half of one service's policy document, carrying its published ports forward.
+ *
+ * Only a verified administrator writes it, as only an administrator writes the runtime spec whose
+ * attached network must state the same values. `expectedRevision` is the revision of the one
+ * document shared with the published ports; any other stored revision refuses the write, and an id
+ * that names no current platform endpoint refuses it. A retry of the exact body under the same
+ * `mutationId` answers the stored document with `replayed: true`.
+ *
+ * One document per service holds its published ports and its egress under one `revision`. The
+ * first accepted write of either (`expectedRevision: null`) creates it: `setServicePublishedPorts`
+ * with egress `publicEgress: false` and `platformEndpointIds: []`, `setServiceNetworkEgress` with
+ * no published ports. From then on both reads return it, never null. It is an explicit policy: an
+ * attached spec stating `publicEgress: false` and `platformEndpointIds: []` matches it and reaches
+ * no public address and no platform endpoint; `network-policy-missing` means the service has no
+ * document at all.
+ */
+export interface IReq_Admin_Cloudly_SetServiceNetworkEgress extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest, IReq_Admin_Cloudly_SetServiceNetworkEgress
+> {
+  method: 'setServiceNetworkEgress';
+  request: { identity: IIdentityCredential; mutation: ISetServiceNetworkEgress };
+  /**
+   * The accepted document including its `revision`; historical on replay. Acceptance is neither an
+   * admitted workload nor applied packet state.
+   */
+  response: { networkEgress: IServiceNetworkEgress; replayed: boolean };
+}
+
 export interface IRequest_Any_Cloudly_GetNetworkNodes {
   method: 'getNetworkNodes';
   request: {};