@serve.zone/interfaces 31.8.0 → 32.0.0

package/ts/requests/service.ts

@@ -16,6 +16,12 @@ import type {
   IServiceDeploymentStatus,
 } from '../data/deploymentoperation.js';
 import type { TSha256Digest } from '../data/immutableimage.js';
+import type {
+  IServiceRuntimeAssignmentView,
+  IServiceRuntimeSpec,
+  IServiceRuntimeStatus,
+  TServiceRuntimeSpecWritableData,
+} from '../data/serviceruntime.js';
 import type {
   IServiceDeploymentAdoptionInput,
   IServiceDeploymentAdoptionImagePromotionInput,
@@ -370,3 +376,78 @@ extends plugins.typedrequestInterfaces.implementsTR<
     success: boolean;
   };
 }
+
+/**
+ * Writes the complete runtime spec of one service.
+ *
+ * `expectedRevision` is the revision the caller read, or `null` when the service has never had a
+ * spec; any other stored revision refuses the write. Cloudly copies the organization from the
+ * service and answers with the stored spec at its new revision.
+ */
+export interface IRequest_Any_Cloudly_SetServiceRuntimeSpec
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_SetServiceRuntimeSpec
+> {
+  method: 'setServiceRuntimeSpec';
+  request: {
+    identity: IIdentity;
+    serviceId: string;
+    expectedRevision: number | null;
+    spec: TServiceRuntimeSpecWritableData;
+  };
+  response: {
+    spec: IServiceRuntimeSpec;
+  };
+}
+
+/**
+ * A service's runtime spec and the producer's verdict on it. Both are `null` before the first spec;
+ * a spec's status is `null` until the producer first decides it.
+ */
+export interface IRequest_Any_Cloudly_GetServiceRuntimeSpec
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_GetServiceRuntimeSpec
+> {
+  method: 'getServiceRuntimeSpec';
+  request: {
+    identity: IIdentity;
+    serviceId: string;
+  };
+  response:
+    | { spec: null; status: null }
+    | { spec: IServiceRuntimeSpec; status: IServiceRuntimeStatus | null };
+}
+
+/** Every current runtime assignment of one service, one per replica slot. */
+export interface IRequest_Any_Cloudly_GetServiceRuntimeAssignments
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_GetServiceRuntimeAssignments
+> {
+  method: 'getServiceRuntimeAssignments';
+  request: {
+    identity: IIdentity;
+    serviceId: string;
+  };
+  response: {
+    assignments: IServiceRuntimeAssignmentView[];
+  };
+}
+
+/**
+ * Cloudly -> admin UIs: a service's runtime spec, status or assignments changed. It carries no
+ * state, so a late or repeated push can never overwrite a newer read; the UI reads the views again.
+ */
+export interface IReq_Cloudly_Any_PushServiceRuntimeChanged
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Cloudly_Any_PushServiceRuntimeChanged
+> {
+  method: 'pushServiceRuntimeChanged';
+  request: {
+    serviceId: string;
+  };
+  response: Record<string, never>;
+}

package/ts/runtime.corestore.databaseexportpackage.golden.ts

@@ -3,12 +3,12 @@ import type {
   ICorestoreDatabaseBackupReceipt,
 } from './runtime.corestore.js';
 import type {
-  ICorestoreDatabaseExportPackageCompletionV1,
-  ICorestoreDatabaseExportPackageReleaseCompletionV1,
-  ICorestoreDatabaseExportPackageReleaseRequestV1,
-  ICorestoreDatabaseExportPackageReleaseResponseV1,
-  ICorestoreDatabaseExportPackageRequestV1,
-  ICorestoreDatabaseExportPackageResponseV1,
+  ICorestoreDatabaseExportPackageCompletion,
+  ICorestoreDatabaseExportPackageReleaseCompletion,
+  ICorestoreDatabaseExportPackageReleaseRequest,
+  ICorestoreDatabaseExportPackageReleaseResponse,
+  ICorestoreDatabaseExportPackageRequest,
+  ICorestoreDatabaseExportPackageResponse,
 } from './runtime.corestore.databaseexportpackage.js';
 
 interface ICorestoreDatabaseExportPackageGoldenArtifact<TValue> {
@@ -18,32 +18,31 @@ interface ICorestoreDatabaseExportPackageGoldenArtifact<TValue> {
   sha256: string;
 }
 
-interface ICorestoreDatabaseExportPackageGoldenVectorsV1 {
-  version: 1;
+interface ICorestoreDatabaseExportPackageGoldenVectors {
   request: ICorestoreDatabaseExportPackageGoldenArtifact<
-    ICorestoreDatabaseExportPackageRequestV1
+    ICorestoreDatabaseExportPackageRequest
   >;
   receipt: ICorestoreDatabaseExportPackageGoldenArtifact<ICorestoreDatabaseBackupReceipt>;
   completion: ICorestoreDatabaseExportPackageGoldenArtifact<
-    ICorestoreDatabaseExportPackageCompletionV1
+    ICorestoreDatabaseExportPackageCompletion
   >;
   response: ICorestoreDatabaseExportPackageGoldenArtifact<
-    ICorestoreDatabaseExportPackageResponseV1
+    ICorestoreDatabaseExportPackageResponse
   >;
   replayResponse: ICorestoreDatabaseExportPackageGoldenArtifact<
-    ICorestoreDatabaseExportPackageResponseV1
+    ICorestoreDatabaseExportPackageResponse
   >;
   releaseRequest: ICorestoreDatabaseExportPackageGoldenArtifact<
-    ICorestoreDatabaseExportPackageReleaseRequestV1
+    ICorestoreDatabaseExportPackageReleaseRequest
   >;
   releaseCompletion: ICorestoreDatabaseExportPackageGoldenArtifact<
-    ICorestoreDatabaseExportPackageReleaseCompletionV1
+    ICorestoreDatabaseExportPackageReleaseCompletion
   >;
   releaseResponse: ICorestoreDatabaseExportPackageGoldenArtifact<
-    ICorestoreDatabaseExportPackageReleaseResponseV1
+    ICorestoreDatabaseExportPackageReleaseResponse
   >;
   replayReleaseResponse: ICorestoreDatabaseExportPackageGoldenArtifact<
-    ICorestoreDatabaseExportPackageReleaseResponseV1
+    ICorestoreDatabaseExportPackageReleaseResponse
   >;
 }
 
@@ -56,8 +55,7 @@ const allocation = {
   receiptSha256: '5'.repeat(64),
 };
 
-const request: ICorestoreDatabaseExportPackageRequestV1 = {
-  schemaVersion: 1,
+const request: ICorestoreDatabaseExportPackageRequest = {
   kind: 'corestore-database-export-package-request',
   packageAttemptId: 'offline-package-attempt-1',
   packageBackupId: 'package-cloudly-offline-1',
@@ -84,8 +82,7 @@ const request: ICorestoreDatabaseExportPackageRequestV1 = {
 };
 
 const receipt: ICorestoreDatabaseBackupReceipt = {
-  schemaVersion: 1,
-  format: 'corestore.database.backup.v1',
+  format: 'corestore.database.backup',
   backupId: request.packageBackupId,
   sourceServiceId: 'service-cloudly',
   createdAt: 1_700_000_201_000,
@@ -110,7 +107,6 @@ const receipt: ICorestoreDatabaseBackupReceipt = {
     databaseAllocation: allocation,
   },
   closure: {
-    formatVersion: 1,
     snapshotIds: ['snapshot-packaged-cloudly-1'],
     objectCount: 2,
     packCount: 1,
@@ -121,62 +117,57 @@ const receipt: ICorestoreDatabaseBackupReceipt = {
   },
 };
 
-const completion: ICorestoreDatabaseExportPackageCompletionV1 = {
-  schemaVersion: 1,
+const completion: ICorestoreDatabaseExportPackageCompletion = {
   kind: 'corestore-database-export-package-completion',
   packageAttemptId: request.packageAttemptId,
-  requestSha256: 'd9e63a397c066aaaec2904d20c1a12240e0a1a902ab388cdff2cebde6c9e1cec',
+  requestSha256: '688e29e07658ea4fea92738dc8e56502cb7e01ae609b471914180922225b8602',
   completedAt: 1_700_000_201_000,
   receipt,
-  receiptSha256: '081fc6e6cca7ab6c25a4583a6689821a01f1807942ac0259ba3394b8f34ef580',
+  receiptSha256: '53551692c49f3059dbb63d70f59dfc534a039b6296aae1158e3ba5490829ce55',
   closureByteLength: receipt.closure.archiveBytes,
   closureSha256: receipt.closure.sha256,
 };
 
-const response: ICorestoreDatabaseExportPackageResponseV1 = {
-  schemaVersion: 1,
+const response: ICorestoreDatabaseExportPackageResponse = {
   kind: 'corestore-database-export-package-response',
   completion,
   replayed: false,
 };
 
-const replayResponse: ICorestoreDatabaseExportPackageResponseV1 = {
+const replayResponse: ICorestoreDatabaseExportPackageResponse = {
   ...response,
   replayed: true,
 };
 
-const releaseRequest: ICorestoreDatabaseExportPackageReleaseRequestV1 = {
-  schemaVersion: 1,
+const releaseRequest: ICorestoreDatabaseExportPackageReleaseRequest = {
   kind: 'corestore-database-export-package-release-request',
   packageAttemptId: request.packageAttemptId,
   requestSha256: completion.requestSha256,
-  completionSha256: 'e771f6f674bc6b00295a38b191aa43cd731e2811f149d54d1fd6b7f14fbc81ce',
+  completionSha256: '5f0c38620cda8ceb71f3d9b308848892976040aa008d8d10155454df6e2817a2',
   callerFsyncedClosureByteLength: completion.closureByteLength,
   callerFsyncedClosureSha256: completion.closureSha256,
-  callerFsyncedReceiptByteLength: 1203,
+  callerFsyncedReceiptByteLength: 1164,
   callerFsyncedReceiptSha256: completion.receiptSha256,
   callerFsyncedAt: 1_700_000_201_001,
 };
 
-const releaseCompletion: ICorestoreDatabaseExportPackageReleaseCompletionV1 = {
-  schemaVersion: 1,
+const releaseCompletion: ICorestoreDatabaseExportPackageReleaseCompletion = {
   kind: 'corestore-database-export-package-release-completion',
   packageAttemptId: request.packageAttemptId,
   requestSha256: completion.requestSha256,
   completionSha256: releaseRequest.completionSha256,
   releaseRequestSha256:
-    '4dc5b3a803aa1e56fdeb74d45ccfa123781c6162a300333c31a85006d9a2d460',
+    '4c9632aa44dc979c61a72b13bbdf0e5e75499424f00dfe63d2c065947e0e9101',
   releasedAt: 1_700_000_201_002,
 };
 
-const releaseResponse: ICorestoreDatabaseExportPackageReleaseResponseV1 = {
-  schemaVersion: 1,
+const releaseResponse: ICorestoreDatabaseExportPackageReleaseResponse = {
   kind: 'corestore-database-export-package-release-response',
   release: releaseCompletion,
   replayed: false,
 };
 
-const replayReleaseResponse: ICorestoreDatabaseExportPackageReleaseResponseV1 = {
+const replayReleaseResponse: ICorestoreDatabaseExportPackageReleaseResponse = {
   ...releaseResponse,
   replayed: true,
 };
@@ -194,130 +185,121 @@ const requestCanonical =
   + '"backupReceiptSha256":"1111111111111111111111111111111111111111111111111111111111111111",'
   + '"snapshotId":"snapshot-cloudly-approved-1","sourceServiceId":"service-cloudly"},'
   + '"completeOutputReceiptSha256":"47eea07082fa86f8bac5af82397321cffc55924f4487866a7b147d9c256e39f5",'
-  + '"input":{"byteLength":4249,"databaseName":"cloudly",'
-  + '"format":"smartdb.database.export.v1","lineFeedTerminator":"single-lf",'
+  + '"input":{"byteLength":4249,"databaseName":"cloudly","format":"smartdb.database.export.v1",'
+  + '"lineFeedTerminator":"single-lf",'
   + '"sha256":"9321522806fa2957c169940990a4bb7072cec52fa65243eb5b4b570f9dbe9677"},'
   + '"kind":"corestore-database-export-package-request",'
-  + '"packageAttemptId":"offline-package-attempt-1",'
-  + '"packageBackupId":"package-cloudly-offline-1","schemaVersion":1}';
+  + '"packageAttemptId":"offline-package-attempt-1","packageBackupId":"package-cloudly-offline-1"}';
 
 const receiptCanonical =
-  '{"backupId":"package-cloudly-offline-1","closure":{"archiveBytes":2048,'
-  + '"chunkCount":3,"formatVersion":1,"objectCount":2,"packCount":1,"payloadBytes":4249,'
+  '{"backupId":"package-cloudly-offline-1","closure":{"archiveBytes":2048,"chunkCount":3,'
+  + '"objectCount":2,"packCount":1,"payloadBytes":4249,'
   + '"sha256":"7777777777777777777777777777777777777777777777777777777777777777",'
   + '"snapshotIds":["snapshot-packaged-cloudly-1"]},"createdAt":1700000201000,'
-  + '"format":"corestore.database.backup.v1","schemaVersion":1,'
-  + '"snapshot":{"capability":"database","createdAt":1700000201000,'
-  + `"databaseAllocation":${allocationCanonical},`
-  + '"databaseName":"cloudly","originalSize":4249,"resourceName":"cloudly",'
-  + '"snapshotId":"snapshot-packaged-cloudly-1",'
+  + '"format":"corestore.database.backup","snapshot":{"capability":"database",'
+  + `"createdAt":1700000201000,"databaseAllocation":${allocationCanonical},"databaseName":"cloudly",`
+  + '"originalSize":4249,"resourceName":"cloudly","snapshotId":"snapshot-packaged-cloudly-1",'
   + '"snapshotName":"package-cloudly-offline-1","storedSize":2048,'
-  + '"tags":{"backupId":"package-cloudly-offline-1","capability":"database",'
-  + '"corestore":"resource","resourceName":"cloudly","serviceId":"service-cloudly",'
-  + '"serviceName":"cloudly","snapshotName":"package-cloudly-offline-1"}},'
-  + '"sourceServiceId":"service-cloudly"}';
+  + '"tags":{"backupId":"package-cloudly-offline-1","capability":"database","corestore":"resource",'
+  + '"resourceName":"cloudly","serviceId":"service-cloudly","serviceName":"cloudly",'
+  + '"snapshotName":"package-cloudly-offline-1"}},"sourceServiceId":"service-cloudly"}';
 
 const completionCanonical =
   '{"closureByteLength":2048,'
   + '"closureSha256":"7777777777777777777777777777777777777777777777777777777777777777",'
   + '"completedAt":1700000201000,"kind":"corestore-database-export-package-completion",'
-  + '"packageAttemptId":"offline-package-attempt-1",'
-  + `"receipt":${receiptCanonical},`
-  + '"receiptSha256":"081fc6e6cca7ab6c25a4583a6689821a01f1807942ac0259ba3394b8f34ef580",'
-  + '"requestSha256":"d9e63a397c066aaaec2904d20c1a12240e0a1a902ab388cdff2cebde6c9e1cec",'
-  + '"schemaVersion":1}';
+  + `"packageAttemptId":"offline-package-attempt-1","receipt":${receiptCanonical},`
+  + '"receiptSha256":"53551692c49f3059dbb63d70f59dfc534a039b6296aae1158e3ba5490829ce55",'
+  + '"requestSha256":"688e29e07658ea4fea92738dc8e56502cb7e01ae609b471914180922225b8602"}';
 
 const responseCanonical =
-  `{"completion":${completionCanonical},`
-  + '"kind":"corestore-database-export-package-response","replayed":false,"schemaVersion":1}';
+  `{"completion":${completionCanonical},"kind":"corestore-database-export-package-response",`
+  + '"replayed":false}';
 
 const replayResponseCanonical =
-  `{"completion":${completionCanonical},`
-  + '"kind":"corestore-database-export-package-response","replayed":true,"schemaVersion":1}';
+  `{"completion":${completionCanonical},"kind":"corestore-database-export-package-response",`
+  + '"replayed":true}';
 
 const releaseRequestCanonical =
   '{"callerFsyncedAt":1700000201001,"callerFsyncedClosureByteLength":2048,'
   + '"callerFsyncedClosureSha256":"7777777777777777777777777777777777777777777777777777777777777777",'
-  + '"callerFsyncedReceiptByteLength":1203,'
-  + '"callerFsyncedReceiptSha256":"081fc6e6cca7ab6c25a4583a6689821a01f1807942ac0259ba3394b8f34ef580",'
-  + '"completionSha256":"e771f6f674bc6b00295a38b191aa43cd731e2811f149d54d1fd6b7f14fbc81ce",'
+  + '"callerFsyncedReceiptByteLength":1164,'
+  + '"callerFsyncedReceiptSha256":"53551692c49f3059dbb63d70f59dfc534a039b6296aae1158e3ba5490829ce55",'
+  + '"completionSha256":"5f0c38620cda8ceb71f3d9b308848892976040aa008d8d10155454df6e2817a2",'
   + '"kind":"corestore-database-export-package-release-request",'
   + '"packageAttemptId":"offline-package-attempt-1",'
-  + '"requestSha256":"d9e63a397c066aaaec2904d20c1a12240e0a1a902ab388cdff2cebde6c9e1cec",'
-  + '"schemaVersion":1}';
+  + '"requestSha256":"688e29e07658ea4fea92738dc8e56502cb7e01ae609b471914180922225b8602"}';
 
 const releaseCompletionCanonical =
-  '{"completionSha256":"e771f6f674bc6b00295a38b191aa43cd731e2811f149d54d1fd6b7f14fbc81ce",'
+  '{"completionSha256":"5f0c38620cda8ceb71f3d9b308848892976040aa008d8d10155454df6e2817a2",'
   + '"kind":"corestore-database-export-package-release-completion",'
   + '"packageAttemptId":"offline-package-attempt-1",'
-  + '"releaseRequestSha256":"4dc5b3a803aa1e56fdeb74d45ccfa123781c6162a300333c31a85006d9a2d460",'
+  + '"releaseRequestSha256":"4c9632aa44dc979c61a72b13bbdf0e5e75499424f00dfe63d2c065947e0e9101",'
   + '"releasedAt":1700000201002,'
-  + '"requestSha256":"d9e63a397c066aaaec2904d20c1a12240e0a1a902ab388cdff2cebde6c9e1cec",'
-  + '"schemaVersion":1}';
+  + '"requestSha256":"688e29e07658ea4fea92738dc8e56502cb7e01ae609b471914180922225b8602"}';
 
 const releaseResponseCanonical =
-  '{"kind":"corestore-database-export-package-release-response",'
-  + `"release":${releaseCompletionCanonical},"replayed":false,"schemaVersion":1}`;
+  '{"kind":"corestore-database-export-package-release-response","release":'
+  + `${releaseCompletionCanonical},"replayed":false}`;
 
 const replayReleaseResponseCanonical =
-  '{"kind":"corestore-database-export-package-release-response",'
-  + `"release":${releaseCompletionCanonical},"replayed":true,"schemaVersion":1}`;
+  '{"kind":"corestore-database-export-package-release-response","release":'
+  + `${releaseCompletionCanonical},"replayed":true}`;
 
 export const corestoreDatabaseExportPackageGoldenVectors:
-Readonly<ICorestoreDatabaseExportPackageGoldenVectorsV1> = deepFreezeValue({
-  version: 1,
+Readonly<ICorestoreDatabaseExportPackageGoldenVectors> = deepFreezeValue({
   request: {
     input: request,
     canonical: requestCanonical,
-    byteLength: 1084,
-    sha256: 'd9e63a397c066aaaec2904d20c1a12240e0a1a902ab388cdff2cebde6c9e1cec',
+    byteLength: 1066,
+    sha256: '688e29e07658ea4fea92738dc8e56502cb7e01ae609b471914180922225b8602',
   },
   receipt: {
     input: receipt,
     canonical: receiptCanonical,
-    byteLength: 1203,
-    sha256: '081fc6e6cca7ab6c25a4583a6689821a01f1807942ac0259ba3394b8f34ef580',
+    byteLength: 1164,
+    sha256: '53551692c49f3059dbb63d70f59dfc534a039b6296aae1158e3ba5490829ce55',
   },
   completion: {
     input: completion,
     canonical: completionCanonical,
-    byteLength: 1636,
-    sha256: 'e771f6f674bc6b00295a38b191aa43cd731e2811f149d54d1fd6b7f14fbc81ce',
+    byteLength: 1579,
+    sha256: '5f0c38620cda8ceb71f3d9b308848892976040aa008d8d10155454df6e2817a2',
   },
   response: {
     input: response,
     canonical: responseCanonical,
-    byteLength: 1738,
-    sha256: 'b119c4c7b8747ac4ebadf8858be4cde362cf99be66d30a537148a3dcb25171c1',
+    byteLength: 1663,
+    sha256: 'b5434103c7ced4a2f2e36814ff663a9987eee16d6d1e662de5df3a12bb908393',
   },
   replayResponse: {
     input: replayResponse,
     canonical: replayResponseCanonical,
-    byteLength: 1737,
-    sha256: '3666c3ff9e9da23617c810dc86f27787909b487fd836045c50250c566379ddd2',
+    byteLength: 1662,
+    sha256: 'd2f77abe1319cf3f0bf197b71686209c348a045723e07f93f91131e7e108f5a2',
   },
   releaseRequest: {
     input: releaseRequest,
     canonical: releaseRequestCanonical,
-    byteLength: 594,
-    sha256: '4dc5b3a803aa1e56fdeb74d45ccfa123781c6162a300333c31a85006d9a2d460',
+    byteLength: 576,
+    sha256: '4c9632aa44dc979c61a72b13bbdf0e5e75499424f00dfe63d2c065947e0e9101',
   },
   releaseCompletion: {
     input: releaseCompletion,
     canonical: releaseCompletionCanonical,
-    byteLength: 414,
-    sha256: '7a06c6a571586a94c363880b68aa59d144ba75a3bfaeb6137725183c5b99a19c',
+    byteLength: 396,
+    sha256: 'e77b63c8db4659973e7545488bf58c3f3aafb3834a36d1de2b2a9e857d031794',
   },
   releaseResponse: {
     input: releaseResponse,
     canonical: releaseResponseCanonical,
-    byteLength: 521,
-    sha256: '1529914cb60ac561f09bfcc5d0a123d4e676515789ec3859b3e2e84ef6c19afc',
+    byteLength: 485,
+    sha256: 'f33f1df9b9b5726c324d017c287e6a1ee36d65d7ea20f636195d7345dd83ace9',
   },
   replayReleaseResponse: {
     input: replayReleaseResponse,
     canonical: replayReleaseResponseCanonical,
-    byteLength: 520,
-    sha256: 'fa4413657a3ee9f77ca4d1852a6627faa0282712113a07cf6a57e7dd3d0266e9',
+    byteLength: 484,
+    sha256: '8613993f7975b390be6f662d250d460ab22df54e4b14ee046c4709232a17fd21',
   },
 });