@serve.zone/interfaces 32.70.0 → 32.72.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/changelog.md +12 -0
- package/dist_ts/00_commitinfo_data.js +1 -1
- package/dist_ts/data/backup.d.ts +12 -1
- package/dist_ts/data/backup.js +1 -1
- package/dist_ts/data/backuprestorerefusal.d.ts +100 -0
- package/dist_ts/data/backuprestorerefusal.js +247 -0
- package/dist_ts/data/index.d.ts +1 -0
- package/dist_ts/data/index.js +2 -1
- package/package.json +1 -1
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/data/backup.ts +12 -1
- package/ts/data/backuprestorerefusal.ts +354 -0
- package/ts/data/index.ts +1 -0
package/changelog.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 2026-11-05 - 32.72.0
|
|
4
|
+
|
|
5
|
+
### Features
|
|
6
|
+
|
|
7
|
+
- Restore operation refusal (Linus 2026-11-05 ruling): `data.backupRestoreRefusalNames` adds `restore-operation-unavailable` (`data.IBackupRestoreOperationUnavailableRefusal`, exactly `{ name }`, built by `data.buildBackupRestoreOperationUnavailableRefusal`). Cloudly answers it for every in-place restore while a restore is not yet an operation the node owns (a restore relayed as one request is cut at the transport timeout); it names the missing capability, not a version. `data.validateBackupRestoreRefusal`, `data.isBackupRestoreRefusal`, `data.readBackupRestoreRefusal` and `data.validateBackupRestoreEvent` accept it as the refusal of a `refused` restore event, and it stays in the contract because stored restore events carry it. A reader built before this version refuses it as an unnamed refusal; Cloudly, its only producer, reads its own restore history, so readers of restore events upgrade before Cloudly and Cloudly is not rolled back below a release that stored it. Spec: `test.backuprestorerefusal`.
|
|
8
|
+
|
|
9
|
+
## 2026-11-05 - 32.71.0
|
|
10
|
+
|
|
11
|
+
### Features
|
|
12
|
+
|
|
13
|
+
- All-or-nothing backup restore refusals (AGL-1501, Linus 2026-11-05 ruling): `data.backupRestoreRefusalNames` freezes the three reasons an in-place restore is refused before it writes anything: `restore-snapshot-unavailable` (`missing`, a non-empty list of `data.IBackupRestoreMissingSnapshot`: `snapshotId`, `capability` (`data.TBackupResourceType`) and an optional `resourceName`), `restore-preflight-unsupported` (the node's Corestore offers no restore check) and `restore-relay-contract-behind` (`relayInterfacesVersion`, a release version or `null`, below `minimumInterfacesVersion`). `data.TBackupRestoreRefusal` is discriminated by `name`; `data.validateBackupRestoreRefusal`, `data.isBackupRestoreRefusal` and `data.readBackupRestoreRefusal` judge untrusted `errorData` against each exact schema, and `data.buildBackupRestoreSnapshotUnavailableRefusal`, `data.buildBackupRestorePreflightUnsupportedRefusal` and `data.buildBackupRestoreRelayContractBehindRefusal` build them; bounds are `data.backupRestoreRefusalContract`. A restore event (`data.IBackupRestoreEvent`) adds the status `refused`, meaning nothing was written, with its `refusal`; `data.validateBackupRestoreEvent` judges only `status` and `refusal`, requiring `refusal` exactly when the status is `refused`. Additive: every existing restore event stays valid, including the unjudged `resourceTypes` and null `errorText` Cloudly already stores. Spec: `test.backuprestorerefusal`.
|
|
14
|
+
|
|
3
15
|
## 2026-11-05 - 32.70.0
|
|
4
16
|
|
|
5
17
|
### Features
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@serve.zone/interfaces',
|
|
6
|
-
version: '32.
|
|
6
|
+
version: '32.72.0',
|
|
7
7
|
description: 'Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.'
|
|
8
8
|
};
|
|
9
9
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSx3QkFBd0I7SUFDOUIsT0FBTyxFQUFFLFNBQVM7SUFDbEIsV0FBVyxFQUFFLHVGQUF1RjtDQUNyRyxDQUFBIn0=
|
package/dist_ts/data/backup.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { TBackupRestoreRefusal } from './backuprestorerefusal.js';
|
|
1
2
|
import type { ICorestoreDatabaseAllocationReference } from './corestore.js';
|
|
2
3
|
export type TBackupStatus = 'pending' | 'running' | 'replicating' | 'replicated' | 'ready' | 'failed' | 'restoring' | 'restored';
|
|
3
4
|
export type TBackupTrigger = 'manual' | 'scheduled';
|
|
@@ -83,9 +84,17 @@ export type TBackupFailure = {
|
|
|
83
84
|
} | {
|
|
84
85
|
kind: 'archive-unreadable';
|
|
85
86
|
};
|
|
87
|
+
/**
|
|
88
|
+
* One restore of a backup, appended to its `restoreHistory`; `validateBackupRestoreEvent` judges its
|
|
89
|
+
* `status` and `refusal`.
|
|
90
|
+
*
|
|
91
|
+
* `refused`: the restore was refused before it wrote anything (`refusal` says why), so the service
|
|
92
|
+
* keeps the data it had. `failed`: it failed after it began writing.
|
|
93
|
+
*/
|
|
86
94
|
export interface IBackupRestoreEvent {
|
|
95
|
+
/** When the restore ended, or when it was refused. */
|
|
87
96
|
restoredAt: number;
|
|
88
|
-
status: 'restored' | 'failed';
|
|
97
|
+
status: 'restored' | 'failed' | 'refused';
|
|
89
98
|
errorText?: string;
|
|
90
99
|
/** The resource types the restore was limited to; absent when it restored every snapshot. */
|
|
91
100
|
resourceTypes?: TBackupResourceType[];
|
|
@@ -94,6 +103,8 @@ export interface IBackupRestoreEvent {
|
|
|
94
103
|
* none of the backup's `failure.uncaptured`.
|
|
95
104
|
*/
|
|
96
105
|
partial?: true;
|
|
106
|
+
/** Why a `refused` restore wrote nothing; present exactly when `status` is `refused`. */
|
|
107
|
+
refusal?: TBackupRestoreRefusal;
|
|
97
108
|
}
|
|
98
109
|
/**
|
|
99
110
|
* Durable retention hold owned by one isolated restore. An entry is active
|
package/dist_ts/data/backup.js
CHANGED
|
@@ -13,4 +13,4 @@ export const readPartialRestoreResourceTypes = (backupArg) => {
|
|
|
13
13
|
const uncapturedTypes = new Set(failure.uncaptured.map((resourceArg) => resourceArg.type));
|
|
14
14
|
return ['database', 'objectstorage'].filter((typeArg) => (!uncapturedTypes.has(typeArg) && backupArg.snapshots.some((snapshotArg) => snapshotArg.type === typeArg)));
|
|
15
15
|
};
|
|
16
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
16
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFja3VwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvZGF0YS9iYWNrdXAudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBK0tBOzs7Ozs7O0dBT0c7QUFDSCxNQUFNLENBQUMsTUFBTSwrQkFBK0IsR0FBRyxDQUM3QyxTQUFrSCxFQUNuRSxFQUFFO0lBQ2pELE1BQU0sT0FBTyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7SUFDbEMsSUFBSSxTQUFTLENBQUMsTUFBTSxLQUFLLFFBQVEsSUFBSSxPQUFPLEVBQUUsSUFBSSxLQUFLLFlBQVk7UUFBRSxPQUFPLEVBQUUsQ0FBQztJQUMvRSxNQUFNLGVBQWUsR0FBRyxJQUFJLEdBQUcsQ0FBc0IsT0FBTyxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsQ0FBQyxXQUFXLEVBQUUsRUFBRSxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDO0lBQ2hILE9BQVEsQ0FBQyxVQUFVLEVBQUUsZUFBZSxDQUFXLENBQUMsTUFBTSxDQUFDLENBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQyxDQUNsRSxDQUFDLGVBQWUsQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDLElBQUksU0FBUyxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxXQUFXLEVBQUUsRUFBRSxDQUFDLFdBQVcsQ0FBQyxJQUFJLEtBQUssT0FBTyxDQUFDLENBQ3pHLENBQUMsQ0FBQztBQUNMLENBQUMsQ0FBQyJ9
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import type { TBackupResourceType } from './backup.js';
|
|
2
|
+
/**
|
|
3
|
+
* Why an in-place restore of a backup (`IReq_Any_Cloudly_RestoreServiceBackup`) was refused before
|
|
4
|
+
* it wrote anything. A restore is all-or-nothing: Corestore checks that it can read every snapshot
|
|
5
|
+
* the restore names before it replaces any data, and Cloudly dispatches the restore only to a relay
|
|
6
|
+
* whose contract carries that check. A refusal therefore always means nothing was written; the
|
|
7
|
+
* service keeps the data it had.
|
|
8
|
+
*
|
|
9
|
+
* - `restore-snapshot-unavailable`: the node's Corestore cannot read one or more snapshots the
|
|
10
|
+
* restore names; `missing` names each of them.
|
|
11
|
+
* - `restore-preflight-unsupported`: the node's Corestore does not offer the restore check (a
|
|
12
|
+
* Corestore built before it answers the check route with HTTP 404), so it cannot prove the
|
|
13
|
+
* restore would be whole and nothing is restored.
|
|
14
|
+
* - `restore-relay-contract-behind`: the cluster relay speaks an interfaces release below the one
|
|
15
|
+
* that carries the restore check, so Cloudly does not dispatch the restore; the relay states
|
|
16
|
+
* `relayInterfacesVersion` (`null` when it stated none) and the restore needs
|
|
17
|
+
* `minimumInterfacesVersion`.
|
|
18
|
+
* - `restore-operation-unavailable`: Cloudly refuses every in-place restore because a restore is not
|
|
19
|
+
* yet an operation the node owns: a restore relayed as one request is cut at the transport
|
|
20
|
+
* timeout, so Cloudly cannot learn whether it finished. It names the missing capability, not a
|
|
21
|
+
* version, and stays in this contract permanently because stored restore events carry it.
|
|
22
|
+
* Cloudly is its only producer and reads its own restore history, so it carries this reader
|
|
23
|
+
* itself: readers of restore events upgrade before Cloudly, and Cloudly is not rolled back below
|
|
24
|
+
* a release that stored it.
|
|
25
|
+
*
|
|
26
|
+
* It travels as `TypedResponseError.errorData` of a refused restore and is recorded as the
|
|
27
|
+
* `refusal` of the backup's `refused` restore event (`IBackupRestoreEvent`). Each refusal is
|
|
28
|
+
* exactly its schema: `readBackupRestoreRefusal` refuses any other member, so a producer never adds
|
|
29
|
+
* one without gating it on the reader's interfaces version.
|
|
30
|
+
*/
|
|
31
|
+
export declare const backupRestoreRefusalNames: readonly ["restore-snapshot-unavailable", "restore-preflight-unsupported", "restore-relay-contract-behind", "restore-operation-unavailable"];
|
|
32
|
+
export type TBackupRestoreRefusalName = typeof backupRestoreRefusalNames[number];
|
|
33
|
+
export declare const backupRestoreRefusalContract: Readonly<{
|
|
34
|
+
/** At most this many snapshots are named in one `restore-snapshot-unavailable`. */
|
|
35
|
+
readonly maximumMissingSnapshots: 256;
|
|
36
|
+
/** A snapshot id or resource name is printable ASCII without spaces, at most this long. */
|
|
37
|
+
readonly maximumNameLength: 255;
|
|
38
|
+
}>;
|
|
39
|
+
/** One snapshot a restore names that the node's Corestore cannot read. */
|
|
40
|
+
export interface IBackupRestoreMissingSnapshot {
|
|
41
|
+
snapshotId: string;
|
|
42
|
+
/** The snapshot's resource type (`TBackupSnapshot['type']`). */
|
|
43
|
+
capability: TBackupResourceType;
|
|
44
|
+
/** The Corestore resource of a database or object-storage snapshot, when it is known. */
|
|
45
|
+
resourceName?: string;
|
|
46
|
+
}
|
|
47
|
+
export interface IBackupRestoreSnapshotUnavailableRefusal {
|
|
48
|
+
name: 'restore-snapshot-unavailable';
|
|
49
|
+
/** Non-empty; each snapshot once. */
|
|
50
|
+
missing: IBackupRestoreMissingSnapshot[];
|
|
51
|
+
}
|
|
52
|
+
export interface IBackupRestorePreflightUnsupportedRefusal {
|
|
53
|
+
name: 'restore-preflight-unsupported';
|
|
54
|
+
}
|
|
55
|
+
export interface IBackupRestoreRelayContractBehindRefusal {
|
|
56
|
+
name: 'restore-relay-contract-behind';
|
|
57
|
+
/** The interfaces release the relay speaks, or `null` when it stated none. */
|
|
58
|
+
relayInterfacesVersion: string | null;
|
|
59
|
+
/** The lowest interfaces release a relay must speak to carry a restore. */
|
|
60
|
+
minimumInterfacesVersion: string;
|
|
61
|
+
}
|
|
62
|
+
export interface IBackupRestoreOperationUnavailableRefusal {
|
|
63
|
+
name: 'restore-operation-unavailable';
|
|
64
|
+
}
|
|
65
|
+
/** A refused restore, discriminated by `name` (`backupRestoreRefusalNames`). */
|
|
66
|
+
export type TBackupRestoreRefusal = IBackupRestoreSnapshotUnavailableRefusal | IBackupRestorePreflightUnsupportedRefusal | IBackupRestoreRelayContractBehindRefusal | IBackupRestoreOperationUnavailableRefusal;
|
|
67
|
+
/** Validates one restore refusal against its exact schema and names every reason it is refused. */
|
|
68
|
+
export declare const validateBackupRestoreRefusal: (valueArg: unknown, pathArg?: string) => string[];
|
|
69
|
+
/** Whether a value is exactly one restore refusal. */
|
|
70
|
+
export declare const isBackupRestoreRefusal: (valueArg: unknown) => valueArg is TBackupRestoreRefusal;
|
|
71
|
+
/**
|
|
72
|
+
* The restore refusal inside an error payload or a stored restore event, as an inert frozen copy,
|
|
73
|
+
* or `null` when the value is not exactly one. It reads own data properties only, so a refusal
|
|
74
|
+
* read here carries nothing that runs.
|
|
75
|
+
*/
|
|
76
|
+
export declare const readBackupRestoreRefusal: (valueArg: unknown) => TBackupRestoreRefusal | null;
|
|
77
|
+
/** `restore-snapshot-unavailable` naming each snapshot the node's Corestore cannot read. */
|
|
78
|
+
export declare const buildBackupRestoreSnapshotUnavailableRefusal: (missingArg: IBackupRestoreMissingSnapshot[]) => IBackupRestoreSnapshotUnavailableRefusal;
|
|
79
|
+
/** `restore-preflight-unsupported`: the node's Corestore offers no restore check. */
|
|
80
|
+
export declare const buildBackupRestorePreflightUnsupportedRefusal: () => IBackupRestorePreflightUnsupportedRefusal;
|
|
81
|
+
/**
|
|
82
|
+
* `restore-relay-contract-behind`: the relay speaks an interfaces release below the minimum.
|
|
83
|
+
*
|
|
84
|
+
* Throws when a stated version is not a release version or is not below the minimum, so a caller
|
|
85
|
+
* passes `null` for a relay whose stated version it cannot read.
|
|
86
|
+
*/
|
|
87
|
+
export declare const buildBackupRestoreRelayContractBehindRefusal: (relayInterfacesVersionArg: string | null, minimumInterfacesVersionArg: string) => IBackupRestoreRelayContractBehindRefusal;
|
|
88
|
+
/**
|
|
89
|
+
* `restore-operation-unavailable`: Cloudly refuses the in-place restore because a restore is not
|
|
90
|
+
* yet a node-owned operation.
|
|
91
|
+
*/
|
|
92
|
+
export declare const buildBackupRestoreOperationUnavailableRefusal: () => IBackupRestoreOperationUnavailableRefusal;
|
|
93
|
+
/**
|
|
94
|
+
* Validates what this contract adds to a restore event of a backup's `restoreHistory` and names
|
|
95
|
+
* every reason it is refused: `status` is `restored`, `failed` or `refused`, and `refusal` is
|
|
96
|
+
* present exactly when `status` is `refused`, as one restore refusal. Every other member is left as
|
|
97
|
+
* it was written (records Cloudly already stores keep any `restoredAt`, `errorText`, `partial` and
|
|
98
|
+
* `resourceTypes` they hold), so every stored event stays valid.
|
|
99
|
+
*/
|
|
100
|
+
export declare const validateBackupRestoreEvent: (valueArg: unknown, pathArg?: string) => string[];
|
|
@@ -0,0 +1,247 @@
|
|
|
1
|
+
import { hasExactKeys, readDataElements, readDataProperties, readExactDataRecord, } from '../private/dataproperties.js';
|
|
2
|
+
import { compareReleaseVersions, parseReleaseVersion } from './releaseversion.js';
|
|
3
|
+
/**
|
|
4
|
+
* Why an in-place restore of a backup (`IReq_Any_Cloudly_RestoreServiceBackup`) was refused before
|
|
5
|
+
* it wrote anything. A restore is all-or-nothing: Corestore checks that it can read every snapshot
|
|
6
|
+
* the restore names before it replaces any data, and Cloudly dispatches the restore only to a relay
|
|
7
|
+
* whose contract carries that check. A refusal therefore always means nothing was written; the
|
|
8
|
+
* service keeps the data it had.
|
|
9
|
+
*
|
|
10
|
+
* - `restore-snapshot-unavailable`: the node's Corestore cannot read one or more snapshots the
|
|
11
|
+
* restore names; `missing` names each of them.
|
|
12
|
+
* - `restore-preflight-unsupported`: the node's Corestore does not offer the restore check (a
|
|
13
|
+
* Corestore built before it answers the check route with HTTP 404), so it cannot prove the
|
|
14
|
+
* restore would be whole and nothing is restored.
|
|
15
|
+
* - `restore-relay-contract-behind`: the cluster relay speaks an interfaces release below the one
|
|
16
|
+
* that carries the restore check, so Cloudly does not dispatch the restore; the relay states
|
|
17
|
+
* `relayInterfacesVersion` (`null` when it stated none) and the restore needs
|
|
18
|
+
* `minimumInterfacesVersion`.
|
|
19
|
+
* - `restore-operation-unavailable`: Cloudly refuses every in-place restore because a restore is not
|
|
20
|
+
* yet an operation the node owns: a restore relayed as one request is cut at the transport
|
|
21
|
+
* timeout, so Cloudly cannot learn whether it finished. It names the missing capability, not a
|
|
22
|
+
* version, and stays in this contract permanently because stored restore events carry it.
|
|
23
|
+
* Cloudly is its only producer and reads its own restore history, so it carries this reader
|
|
24
|
+
* itself: readers of restore events upgrade before Cloudly, and Cloudly is not rolled back below
|
|
25
|
+
* a release that stored it.
|
|
26
|
+
*
|
|
27
|
+
* It travels as `TypedResponseError.errorData` of a refused restore and is recorded as the
|
|
28
|
+
* `refusal` of the backup's `refused` restore event (`IBackupRestoreEvent`). Each refusal is
|
|
29
|
+
* exactly its schema: `readBackupRestoreRefusal` refuses any other member, so a producer never adds
|
|
30
|
+
* one without gating it on the reader's interfaces version.
|
|
31
|
+
*/
|
|
32
|
+
export const backupRestoreRefusalNames = Object.freeze([
|
|
33
|
+
'restore-snapshot-unavailable',
|
|
34
|
+
'restore-preflight-unsupported',
|
|
35
|
+
'restore-relay-contract-behind',
|
|
36
|
+
'restore-operation-unavailable',
|
|
37
|
+
]);
|
|
38
|
+
export const backupRestoreRefusalContract = Object.freeze({
|
|
39
|
+
/** At most this many snapshots are named in one `restore-snapshot-unavailable`. */
|
|
40
|
+
maximumMissingSnapshots: 256,
|
|
41
|
+
/** A snapshot id or resource name is printable ASCII without spaces, at most this long. */
|
|
42
|
+
maximumNameLength: 255,
|
|
43
|
+
});
|
|
44
|
+
/** Every resource type, keyed so a new `TBackupResourceType` member fails to compile here. */
|
|
45
|
+
const backupResourceTypeKeys = Object.freeze({
|
|
46
|
+
volume: true,
|
|
47
|
+
database: true,
|
|
48
|
+
objectstorage: true,
|
|
49
|
+
});
|
|
50
|
+
const isBackupResourceType = (valueArg) => (typeof valueArg === 'string' && Object.hasOwn(backupResourceTypeKeys, valueArg));
|
|
51
|
+
const printableNamePattern = /^[\x21-\x7e]+$/;
|
|
52
|
+
const isRestoreName = (valueArg) => (typeof valueArg === 'string'
|
|
53
|
+
&& valueArg.length <= backupRestoreRefusalContract.maximumNameLength
|
|
54
|
+
&& printableNamePattern.test(valueArg));
|
|
55
|
+
const nameRule = 'must be printable ASCII without spaces, at most '
|
|
56
|
+
+ `${backupRestoreRefusalContract.maximumNameLength} characters`;
|
|
57
|
+
const isRefusalName = (valueArg) => (typeof valueArg === 'string'
|
|
58
|
+
&& backupRestoreRefusalNames.includes(valueArg));
|
|
59
|
+
const validateMissingSnapshot = (valueArg, pathArg) => {
|
|
60
|
+
const snapshot = readDataProperties(valueArg);
|
|
61
|
+
if (snapshot === null || !hasExactKeys(snapshot, ['snapshotId', 'capability'], ['resourceName'])) {
|
|
62
|
+
return [`${pathArg} must use its exact schema`];
|
|
63
|
+
}
|
|
64
|
+
const errors = [];
|
|
65
|
+
if (!isRestoreName(snapshot.snapshotId)) {
|
|
66
|
+
errors.push(`${pathArg}.snapshotId ${nameRule}`);
|
|
67
|
+
}
|
|
68
|
+
if (!isBackupResourceType(snapshot.capability)) {
|
|
69
|
+
errors.push(`${pathArg}.capability must be volume, database or objectstorage`);
|
|
70
|
+
}
|
|
71
|
+
if (Object.hasOwn(snapshot, 'resourceName') && !isRestoreName(snapshot.resourceName)) {
|
|
72
|
+
errors.push(`${pathArg}.resourceName ${nameRule}`);
|
|
73
|
+
}
|
|
74
|
+
return errors;
|
|
75
|
+
};
|
|
76
|
+
const validateMissingSnapshots = (valueArg, pathArg) => {
|
|
77
|
+
const elements = readDataElements(valueArg, backupRestoreRefusalContract.maximumMissingSnapshots);
|
|
78
|
+
if (elements === null) {
|
|
79
|
+
return [`${pathArg} must be a list of at most `
|
|
80
|
+
+ `${backupRestoreRefusalContract.maximumMissingSnapshots} snapshots`];
|
|
81
|
+
}
|
|
82
|
+
if (elements.length === 0) {
|
|
83
|
+
return [`${pathArg} must name at least one snapshot`];
|
|
84
|
+
}
|
|
85
|
+
const errors = elements.flatMap((elementArg, indexArg) => (validateMissingSnapshot(elementArg, `${pathArg}[${indexArg}]`)));
|
|
86
|
+
if (errors.length > 0) {
|
|
87
|
+
return errors;
|
|
88
|
+
}
|
|
89
|
+
const snapshotIds = elements.map((elementArg) => elementArg.snapshotId);
|
|
90
|
+
if (new Set(snapshotIds).size !== snapshotIds.length) {
|
|
91
|
+
errors.push(`${pathArg} must name each snapshot once`);
|
|
92
|
+
}
|
|
93
|
+
return errors;
|
|
94
|
+
};
|
|
95
|
+
const validateRelayContractBehind = (refusalArg, pathArg) => {
|
|
96
|
+
const relay = refusalArg.relayInterfacesVersion === null
|
|
97
|
+
? null
|
|
98
|
+
: parseReleaseVersion(refusalArg.relayInterfacesVersion);
|
|
99
|
+
const minimum = parseReleaseVersion(refusalArg.minimumInterfacesVersion);
|
|
100
|
+
const errors = [];
|
|
101
|
+
if (refusalArg.relayInterfacesVersion !== null && relay === null) {
|
|
102
|
+
errors.push(`${pathArg} relayInterfacesVersion must be a release version or null`);
|
|
103
|
+
}
|
|
104
|
+
if (minimum === null) {
|
|
105
|
+
errors.push(`${pathArg} minimumInterfacesVersion must be a release version`);
|
|
106
|
+
}
|
|
107
|
+
if (relay !== null && minimum !== null && compareReleaseVersions(relay, minimum) >= 0) {
|
|
108
|
+
errors.push(`${pathArg} relayInterfacesVersion must be below minimumInterfacesVersion`);
|
|
109
|
+
}
|
|
110
|
+
return errors;
|
|
111
|
+
};
|
|
112
|
+
/** The exact keys of each refusal. */
|
|
113
|
+
const refusalKeys = Object.freeze({
|
|
114
|
+
'restore-snapshot-unavailable': Object.freeze(['name', 'missing']),
|
|
115
|
+
'restore-preflight-unsupported': Object.freeze(['name']),
|
|
116
|
+
'restore-relay-contract-behind': Object.freeze([
|
|
117
|
+
'name', 'relayInterfacesVersion', 'minimumInterfacesVersion',
|
|
118
|
+
]),
|
|
119
|
+
'restore-operation-unavailable': Object.freeze(['name']),
|
|
120
|
+
});
|
|
121
|
+
/** Validates one restore refusal against its exact schema and names every reason it is refused. */
|
|
122
|
+
export const validateBackupRestoreRefusal = (valueArg, pathArg = 'backup restore refusal') => {
|
|
123
|
+
const properties = readDataProperties(valueArg);
|
|
124
|
+
if (properties === null || !isRefusalName(properties.name)) {
|
|
125
|
+
return [`${pathArg} name must be one of ${backupRestoreRefusalNames.join(', ')}`];
|
|
126
|
+
}
|
|
127
|
+
const refusal = readExactDataRecord(valueArg, refusalKeys[properties.name]);
|
|
128
|
+
if (refusal === null) {
|
|
129
|
+
return [`${pathArg} must use the exact schema of ${properties.name}`];
|
|
130
|
+
}
|
|
131
|
+
switch (properties.name) {
|
|
132
|
+
case 'restore-snapshot-unavailable':
|
|
133
|
+
return validateMissingSnapshots(refusal.missing, `${pathArg} missing`);
|
|
134
|
+
case 'restore-preflight-unsupported':
|
|
135
|
+
return [];
|
|
136
|
+
case 'restore-relay-contract-behind':
|
|
137
|
+
return validateRelayContractBehind(refusal, pathArg);
|
|
138
|
+
case 'restore-operation-unavailable':
|
|
139
|
+
return [];
|
|
140
|
+
}
|
|
141
|
+
};
|
|
142
|
+
/** Whether a value is exactly one restore refusal. */
|
|
143
|
+
export const isBackupRestoreRefusal = (valueArg) => (validateBackupRestoreRefusal(valueArg).length === 0);
|
|
144
|
+
const freezeMissingSnapshot = (snapshotArg) => Object.freeze({
|
|
145
|
+
snapshotId: snapshotArg.snapshotId,
|
|
146
|
+
capability: snapshotArg.capability,
|
|
147
|
+
...(snapshotArg.resourceName === undefined ? {} : { resourceName: snapshotArg.resourceName }),
|
|
148
|
+
});
|
|
149
|
+
const copySnapshotUnavailableRefusal = (refusalArg) => {
|
|
150
|
+
const missing = refusalArg.missing.map(freezeMissingSnapshot);
|
|
151
|
+
Object.freeze(missing);
|
|
152
|
+
return Object.freeze({ name: refusalArg.name, missing });
|
|
153
|
+
};
|
|
154
|
+
const copyPreflightUnsupportedRefusal = (refusalArg) => Object.freeze({ name: refusalArg.name });
|
|
155
|
+
const copyRelayContractBehindRefusal = (refusalArg) => Object.freeze({
|
|
156
|
+
name: refusalArg.name,
|
|
157
|
+
relayInterfacesVersion: refusalArg.relayInterfacesVersion,
|
|
158
|
+
minimumInterfacesVersion: refusalArg.minimumInterfacesVersion,
|
|
159
|
+
});
|
|
160
|
+
const copyOperationUnavailableRefusal = (refusalArg) => Object.freeze({ name: refusalArg.name });
|
|
161
|
+
/** An inert frozen copy of a refusal that passed `validateBackupRestoreRefusal`. */
|
|
162
|
+
const copyRefusal = (refusalArg) => {
|
|
163
|
+
switch (refusalArg.name) {
|
|
164
|
+
case 'restore-snapshot-unavailable':
|
|
165
|
+
return copySnapshotUnavailableRefusal(refusalArg);
|
|
166
|
+
case 'restore-preflight-unsupported':
|
|
167
|
+
return copyPreflightUnsupportedRefusal(refusalArg);
|
|
168
|
+
case 'restore-relay-contract-behind':
|
|
169
|
+
return copyRelayContractBehindRefusal(refusalArg);
|
|
170
|
+
case 'restore-operation-unavailable':
|
|
171
|
+
return copyOperationUnavailableRefusal(refusalArg);
|
|
172
|
+
}
|
|
173
|
+
};
|
|
174
|
+
/**
|
|
175
|
+
* The restore refusal inside an error payload or a stored restore event, as an inert frozen copy,
|
|
176
|
+
* or `null` when the value is not exactly one. It reads own data properties only, so a refusal
|
|
177
|
+
* read here carries nothing that runs.
|
|
178
|
+
*/
|
|
179
|
+
export const readBackupRestoreRefusal = (valueArg) => (
|
|
180
|
+
// A value that passed holds own data properties of exactly the refusal's schema at every level,
|
|
181
|
+
// so the copy reads the same data the validation judged.
|
|
182
|
+
isBackupRestoreRefusal(valueArg) ? copyRefusal(valueArg) : null);
|
|
183
|
+
/** The refusal a builder composed, unchanged, or an error naming every reason it is refused. */
|
|
184
|
+
const requireRefusal = (refusalArg) => {
|
|
185
|
+
const errors = validateBackupRestoreRefusal(refusalArg);
|
|
186
|
+
if (errors.length > 0) {
|
|
187
|
+
throw new Error(errors.join('; '));
|
|
188
|
+
}
|
|
189
|
+
return refusalArg;
|
|
190
|
+
};
|
|
191
|
+
/** `restore-snapshot-unavailable` naming each snapshot the node's Corestore cannot read. */
|
|
192
|
+
export const buildBackupRestoreSnapshotUnavailableRefusal = (missingArg) => copySnapshotUnavailableRefusal(requireRefusal({
|
|
193
|
+
name: 'restore-snapshot-unavailable',
|
|
194
|
+
missing: missingArg.map((snapshotArg) => ({ ...snapshotArg })),
|
|
195
|
+
}));
|
|
196
|
+
/** `restore-preflight-unsupported`: the node's Corestore offers no restore check. */
|
|
197
|
+
export const buildBackupRestorePreflightUnsupportedRefusal = () => (copyPreflightUnsupportedRefusal(requireRefusal({ name: 'restore-preflight-unsupported' })));
|
|
198
|
+
/**
|
|
199
|
+
* `restore-relay-contract-behind`: the relay speaks an interfaces release below the minimum.
|
|
200
|
+
*
|
|
201
|
+
* Throws when a stated version is not a release version or is not below the minimum, so a caller
|
|
202
|
+
* passes `null` for a relay whose stated version it cannot read.
|
|
203
|
+
*/
|
|
204
|
+
export const buildBackupRestoreRelayContractBehindRefusal = (relayInterfacesVersionArg, minimumInterfacesVersionArg) => copyRelayContractBehindRefusal(requireRefusal({
|
|
205
|
+
name: 'restore-relay-contract-behind',
|
|
206
|
+
relayInterfacesVersion: relayInterfacesVersionArg,
|
|
207
|
+
minimumInterfacesVersion: minimumInterfacesVersionArg,
|
|
208
|
+
}));
|
|
209
|
+
/**
|
|
210
|
+
* `restore-operation-unavailable`: Cloudly refuses the in-place restore because a restore is not
|
|
211
|
+
* yet a node-owned operation.
|
|
212
|
+
*/
|
|
213
|
+
export const buildBackupRestoreOperationUnavailableRefusal = () => (copyOperationUnavailableRefusal(requireRefusal({ name: 'restore-operation-unavailable' })));
|
|
214
|
+
const restoreEventStatuses = Object.freeze([
|
|
215
|
+
'restored', 'failed', 'refused',
|
|
216
|
+
]);
|
|
217
|
+
/**
|
|
218
|
+
* Validates what this contract adds to a restore event of a backup's `restoreHistory` and names
|
|
219
|
+
* every reason it is refused: `status` is `restored`, `failed` or `refused`, and `refusal` is
|
|
220
|
+
* present exactly when `status` is `refused`, as one restore refusal. Every other member is left as
|
|
221
|
+
* it was written (records Cloudly already stores keep any `restoredAt`, `errorText`, `partial` and
|
|
222
|
+
* `resourceTypes` they hold), so every stored event stays valid.
|
|
223
|
+
*/
|
|
224
|
+
export const validateBackupRestoreEvent = (valueArg, pathArg = 'backup restore event') => {
|
|
225
|
+
const event = readDataProperties(valueArg);
|
|
226
|
+
if (event === null) {
|
|
227
|
+
return [`${pathArg} must be a plain record of data properties`];
|
|
228
|
+
}
|
|
229
|
+
const errors = [];
|
|
230
|
+
if (!restoreEventStatuses.includes(event.status)) {
|
|
231
|
+
errors.push(`${pathArg} status must be one of ${restoreEventStatuses.join(', ')}`);
|
|
232
|
+
}
|
|
233
|
+
const hasRefusal = Object.hasOwn(event, 'refusal');
|
|
234
|
+
if (event.status === 'refused') {
|
|
235
|
+
if (!hasRefusal) {
|
|
236
|
+
errors.push(`${pathArg} refusal is required when status is refused`);
|
|
237
|
+
}
|
|
238
|
+
else {
|
|
239
|
+
errors.push(...validateBackupRestoreRefusal(event.refusal, `${pathArg} refusal`));
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
else if (hasRefusal) {
|
|
243
|
+
errors.push(`${pathArg} refusal is allowed only when status is refused`);
|
|
244
|
+
}
|
|
245
|
+
return errors;
|
|
246
|
+
};
|
|
247
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"backuprestorerefusal.js","sourceRoot":"","sources":["../../ts/data/backuprestorerefusal.ts"],"names":[],"mappings":"AACA,OAAO,EACL,YAAY,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,mBAAmB,GACxE,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC,MAAM,CAAC;IACrD,8BAA8B;IAC9B,+BAA+B;IAC/B,+BAA+B;IAC/B,+BAA+B;CACvB,CAAC,CAAC;AAIZ,MAAM,CAAC,MAAM,4BAA4B,GAAG,MAAM,CAAC,MAAM,CAAC;IACxD,mFAAmF;IACnF,uBAAuB,EAAE,GAAG;IAC5B,2FAA2F;IAC3F,iBAAiB,EAAE,GAAG;CACd,CAAC,CAAC;AAwCZ,8FAA8F;AAC9F,MAAM,sBAAsB,GAAgD,MAAM,CAAC,MAAM,CAAC;IACxF,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,IAAI;IACd,aAAa,EAAE,IAAI;CACpB,CAAC,CAAC;AAEH,MAAM,oBAAoB,GAAG,CAAC,QAAiB,EAAmC,EAAE,CAAC,CACnF,OAAO,QAAQ,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAChF,CAAC;AAEF,MAAM,oBAAoB,GAAG,gBAAgB,CAAC;AAE9C,MAAM,aAAa,GAAG,CAAC,QAAiB,EAAsB,EAAE,CAAC,CAC/D,OAAO,QAAQ,KAAK,QAAQ;OACzB,QAAQ,CAAC,MAAM,IAAI,4BAA4B,CAAC,iBAAiB;OACjE,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CACvC,CAAC;AAEF,MAAM,QAAQ,GAAG,kDAAkD;MAC/D,GAAG,4BAA4B,CAAC,iBAAiB,aAAa,CAAC;AAEnE,MAAM,aAAa,GAAG,CAAC,QAAiB,EAAyC,EAAE,CAAC,CAClF,OAAO,QAAQ,KAAK,QAAQ;OACxB,yBAA+C,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACvE,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,QAAiB,EAAE,OAAe,EAAY,EAAE;IAC/E,MAAM,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAC9C,IAAI,QAAQ,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,YAAY,EAAE,YAAY,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;QACjG,OAAO,CAAC,GAAG,OAAO,4BAA4B,CAAC,CAAC;IAClD,CAAC;IACD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QACxC,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,eAAe,QAAQ,EAAE,CAAC,CAAC;IACnD,CAAC;IACD,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/C,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,uDAAuD,CAAC,CAAC;IACjF,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;QACrF,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,iBAAiB,QAAQ,EAAE,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,QAAiB,EAAE,OAAe,EAAY,EAAE;IAChF,MAAM,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,EAAE,4BAA4B,CAAC,uBAAuB,CAAC,CAAC;IAClG,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtB,OAAO,CAAC,GAAG,OAAO,6BAA6B;kBAC3C,GAAG,4BAA4B,CAAC,uBAAuB,YAAY,CAAC,CAAC;IAC3E,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,CAAC,GAAG,OAAO,kCAAkC,CAAC,CAAC;IACxD,CAAC;IACD,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,QAAQ,EAAE,EAAE,CAAC,CACxD,uBAAuB,CAAC,UAAU,EAAE,GAAG,OAAO,IAAI,QAAQ,GAAG,CAAC,CAC/D,CAAC,CAAC;IACH,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAE,UAA4C,CAAC,UAAU,CAAC,CAAC;IAC3G,IAAI,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,IAAI,KAAK,WAAW,CAAC,MAAM,EAAE,CAAC;QACrD,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,+BAA+B,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAClC,UAAmC,EACnC,OAAe,EACL,EAAE;IACZ,MAAM,KAAK,GAAG,UAAU,CAAC,sBAAsB,KAAK,IAAI;QACtD,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,mBAAmB,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC;IAC3D,MAAM,OAAO,GAAG,mBAAmB,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC;IACzE,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,UAAU,CAAC,sBAAsB,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACjE,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,2DAA2D,CAAC,CAAC;IACrF,CAAC;IACD,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACrB,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,qDAAqD,CAAC,CAAC;IAC/E,CAAC;IACD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,IAAI,IAAI,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACtF,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,gEAAgE,CAAC,CAAC;IAC1F,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,sCAAsC;AACtC,MAAM,WAAW,GAAmE,MAAM,CAAC,MAAM,CAAC;IAChG,8BAA8B,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAClE,+BAA+B,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;IACxD,+BAA+B,EAAE,MAAM,CAAC,MAAM,CAAC;QAC7C,MAAM,EAAE,wBAAwB,EAAE,0BAA0B;KAC7D,CAAC;IACF,+BAA+B,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;CACzD,CAAC,CAAC;AAEH,mGAAmG;AACnG,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,QAAiB,EACjB,OAAO,GAAG,wBAAwB,EACxB,EAAE;IACZ,MAAM,UAAU,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAChD,IAAI,UAAU,KAAK,IAAI,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3D,OAAO,CAAC,GAAG,OAAO,wBAAwB,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACpF,CAAC;IACD,MAAM,OAAO,GAAG,mBAAmB,CAAC,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5E,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACrB,OAAO,CAAC,GAAG,OAAO,iCAAiC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;IACxE,CAAC;IACD,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;QACxB,KAAK,8BAA8B;YACjC,OAAO,wBAAwB,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,OAAO,UAAU,CAAC,CAAC;QACzE,KAAK,+BAA+B;YAClC,OAAO,EAAE,CAAC;QACZ,KAAK,+BAA+B;YAClC,OAAO,2BAA2B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACvD,KAAK,+BAA+B;YAClC,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,sDAAsD;AACtD,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,QAAiB,EAAqC,EAAE,CAAC,CAC9F,4BAA4B,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC,CACpD,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAC5B,WAA0C,EACX,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC;IAChD,UAAU,EAAE,WAAW,CAAC,UAAU;IAClC,UAAU,EAAE,WAAW,CAAC,UAAU;IAClC,GAAG,CAAC,WAAW,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,WAAW,CAAC,YAAY,EAAE,CAAC;CAC9F,CAAC,CAAC;AAEH,MAAM,8BAA8B,GAAG,CACrC,UAAoD,EACV,EAAE;IAC5C,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IAC9D,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACvB,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;AAC3D,CAAC,CAAC;AAEF,MAAM,+BAA+B,GAAG,CACtC,UAAqD,EACV,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;AAEzF,MAAM,8BAA8B,GAAG,CACrC,UAAoD,EACV,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC;IAC3D,IAAI,EAAE,UAAU,CAAC,IAAI;IACrB,sBAAsB,EAAE,UAAU,CAAC,sBAAsB;IACzD,wBAAwB,EAAE,UAAU,CAAC,wBAAwB;CAC9D,CAAC,CAAC;AAEH,MAAM,+BAA+B,GAAG,CACtC,UAAqD,EACV,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;AAEzF,oFAAoF;AACpF,MAAM,WAAW,GAAG,CAAC,UAAiC,EAAyB,EAAE;IAC/E,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;QACxB,KAAK,8BAA8B;YACjC,OAAO,8BAA8B,CAAC,UAAU,CAAC,CAAC;QACpD,KAAK,+BAA+B;YAClC,OAAO,+BAA+B,CAAC,UAAU,CAAC,CAAC;QACrD,KAAK,+BAA+B;YAClC,OAAO,8BAA8B,CAAC,UAAU,CAAC,CAAC;QACpD,KAAK,+BAA+B;YAClC,OAAO,+BAA+B,CAAC,UAAU,CAAC,CAAC;IACvD,CAAC;AACH,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,QAAiB,EAAgC,EAAE,CAAC;AAC3F,gGAAgG;AAChG,yDAAyD;AACzD,sBAAsB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAChE,CAAC;AAEF,gGAAgG;AAChG,MAAM,cAAc,GAAG,CAAkC,UAAa,EAAK,EAAE;IAC3E,MAAM,MAAM,GAAG,4BAA4B,CAAC,UAAU,CAAC,CAAC;IACxD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACrC,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,4FAA4F;AAC5F,MAAM,CAAC,MAAM,4CAA4C,GAAG,CAC1D,UAA2C,EACD,EAAE,CAAC,8BAA8B,CAAC,cAAc,CAAC;IAC3F,IAAI,EAAE,8BAA8B;IACpC,OAAO,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC;CAC/D,CAAC,CAAC,CAAC;AAEJ,qFAAqF;AACrF,MAAM,CAAC,MAAM,6CAA6C,GAAG,GAA8C,EAAE,CAAC,CAC5G,+BAA+B,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,+BAA+B,EAAE,CAAC,CAAC,CAC3F,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,4CAA4C,GAAG,CAC1D,yBAAwC,EACxC,2BAAmC,EACO,EAAE,CAAC,8BAA8B,CAAC,cAAc,CAAC;IAC3F,IAAI,EAAE,+BAA+B;IACrC,sBAAsB,EAAE,yBAAyB;IACjD,wBAAwB,EAAE,2BAA2B;CACtD,CAAC,CAAC,CAAC;AAEJ;;;GAGG;AACH,MAAM,CAAC,MAAM,6CAA6C,GAAG,GAA8C,EAAE,CAAC,CAC5G,+BAA+B,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,+BAA+B,EAAE,CAAC,CAAC,CAC3F,CAAC;AAEF,MAAM,oBAAoB,GAA6C,MAAM,CAAC,MAAM,CAAC;IACnF,UAAU,EAAE,QAAQ,EAAE,SAAS;CAChC,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,QAAiB,EACjB,OAAO,GAAG,sBAAsB,EACtB,EAAE;IACZ,MAAM,KAAK,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAC3C,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,CAAC,GAAG,OAAO,4CAA4C,CAAC,CAAC;IAClE,CAAC;IACD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,CAAE,oBAA2C,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACzE,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,0BAA0B,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACrF,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IACnD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,6CAA6C,CAAC,CAAC;QACvE,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,GAAG,4BAA4B,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,OAAO,UAAU,CAAC,CAAC,CAAC;QACpF,CAAC;IACH,CAAC;SAAM,IAAI,UAAU,EAAE,CAAC;QACtB,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,iDAAiD,CAAC,CAAC;IAC3E,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}
|
package/dist_ts/data/index.d.ts
CHANGED
|
@@ -75,6 +75,7 @@ export * from './secret.js';
|
|
|
75
75
|
export * from './baremetal.js';
|
|
76
76
|
export * from './baseos.js';
|
|
77
77
|
export * from './backup.js';
|
|
78
|
+
export * from './backuprestorerefusal.js';
|
|
78
79
|
export * from './clusternode.js';
|
|
79
80
|
export * from './clusternodehostname.js';
|
|
80
81
|
export * from './settings.js';
|
package/dist_ts/data/index.js
CHANGED
|
@@ -70,6 +70,7 @@ export * from './secret.js';
|
|
|
70
70
|
export * from './baremetal.js';
|
|
71
71
|
export * from './baseos.js';
|
|
72
72
|
export * from './backup.js';
|
|
73
|
+
export * from './backuprestorerefusal.js';
|
|
73
74
|
export * from './clusternode.js';
|
|
74
75
|
export * from './clusternodehostname.js';
|
|
75
76
|
export * from './settings.js';
|
|
@@ -91,4 +92,4 @@ export * from './user.js';
|
|
|
91
92
|
export * from './version.js';
|
|
92
93
|
export * from './webpush.js';
|
|
93
94
|
export * from './workloadreplicaidentity.js';
|
|
94
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
95
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9kYXRhL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsb0JBQW9CLENBQUM7QUFDbkMsY0FBYyxjQUFjLENBQUM7QUFDN0IsY0FBYyxxQkFBcUIsQ0FBQztBQUNwQyxjQUFjLGlCQUFpQixDQUFDO0FBQ2hDLGNBQWMscUJBQXFCLENBQUM7QUFDcEMsY0FBYyxnQ0FBZ0MsQ0FBQztBQUMvQyxjQUFjLDZCQUE2QixDQUFDO0FBQzVDLGNBQWMsYUFBYSxDQUFDO0FBQzVCLGNBQWMsZ0JBQWdCLENBQUM7QUFDL0IsY0FBYyw0QkFBNEIsQ0FBQztBQUMzQyxjQUFjLDhCQUE4QixDQUFDO0FBQzdDLGNBQWMsMEJBQTBCLENBQUM7QUFDekMsY0FBYyxlQUFlLENBQUM7QUFDOUIsY0FBYyx1QkFBdUIsQ0FBQztBQUN0QyxjQUFjLGlCQUFpQixDQUFDO0FBQ2hDLGNBQWMseUJBQXlCLENBQUM7QUFDeEMsY0FBYyw2QkFBNkIsQ0FBQztBQUM1QyxjQUFjLDRCQUE0QixDQUFDO0FBQzNDLGNBQWMsMEJBQTBCLENBQUM7QUFDekMsY0FBYywwQkFBMEIsQ0FBQztBQUN6QyxjQUFjLGdDQUFnQyxDQUFDO0FBQy9DLGNBQWMsZ0JBQWdCLENBQUM7QUFDL0IsY0FBYyxVQUFVLENBQUM7QUFDekIsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYyxZQUFZLENBQUM7QUFDM0IsY0FBYyx1QkFBdUIsQ0FBQztBQUN0QyxjQUFjLG1CQUFtQixDQUFDO0FBQ2xDLGNBQWMsY0FBYyxDQUFDO0FBQzdCLGNBQWMsZ0JBQWdCLENBQUM7QUFDL0IsY0FBYyxZQUFZLENBQUM7QUFDM0IsY0FBYyxxQkFBcUIsQ0FBQztBQUNwQyxjQUFjLHNCQUFzQixDQUFDO0FBQ3JDLGNBQWMsNkJBQTZCLENBQUM7QUFDNUMsY0FBYyxXQUFXLENBQUM7QUFDMUIsY0FBYyxxQkFBcUIsQ0FBQztBQUNwQyxjQUFjLHFCQUFxQixDQUFDO0FBQ3BDLGNBQWMseUJBQXlCLENBQUM7QUFDeEMsY0FBYyxxQkFBcUIsQ0FBQztBQUNwQyxjQUFjLHlCQUF5QixDQUFDO0FBQ3hDLGNBQWMseUJBQXlCLENBQUM7QUFDeEMsY0FBYyx1QkFBdUIsQ0FBQztBQUN0QyxjQUFjLHdCQUF3QixDQUFDO0FBQ3ZDLGNBQWMsc0JBQXNCLENBQUM7QUFDckMsY0FBYyw4QkFBOEIsQ0FBQztBQUM3QyxjQUFjLG1CQUFtQixDQUFDO0FBQ2xDLGNBQWMsa0JBQWtCLENBQUM7QUFDakMsY0FBYyx3QkFBd0IsQ0FBQztBQUl2QyxPQUFPLEVBQUUsMEJBQTBCLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUc5RCxPQUFPLEVBQUUscUNBQXFDLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUVwRixPQUFPLEVBQUUsMENBQTBDLEVBQUUsMENBQTBDLEVBQUUsTUFBTSxrQ0FBa0MsQ0FBQztBQUMxSSxjQUFjLHdCQUF3QixDQUFDO0FBQ3ZDLGNBQWMscUJBQXFCLENBQUM7QUFDcEMsY0FBYyxxQkFBcUIsQ0FBQztBQUNwQyxjQUFjLGVBQWUsQ0FBQztBQUM5QixjQUFjLHFCQUFxQixDQUFDO0FBQ3BDLGNBQWMsd0JBQXdCLENBQUM7QUFDdkMsY0FBYyw0QkFBNEIsQ0FBQztBQUMzQyxjQUFjLDRCQUE0QixDQUFDO0FBQzNDLGNBQWMsNkJBQTZCLENBQUM7QUFDNUMsY0FBYyxvQkFBb0IsQ0FBQztBQUNuQyxjQUFjLDBCQUEwQixDQUFDO0FBQ3pDLGNBQWMsK0JBQStCLENBQUM7QUFDOUMsY0FBYyxnQ0FBZ0MsQ0FBQztBQUMvQyxjQUFjLHFCQUFxQixDQUFDO0FBQ3BDLGNBQWMseUJBQXlCLENBQUM7QUFDeEMsY0FBYyw0QkFBNEIsQ0FBQztBQUMzQyxjQUFjLDZCQUE2QixDQUFDO0FBQzVDLGNBQWMsYUFBYSxDQUFDO0FBQzVCLGNBQWMsZ0JBQWdCLENBQUM7QUFDL0IsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYywyQkFBMkIsQ0FBQztBQUMxQyxjQUFjLGtCQUFrQixDQUFDO0FBQ2pDLGNBQWMsMEJBQTBCLENBQUM7QUFDekMsY0FBYyxlQUFlLENBQUM7QUFDOUIsY0FBYyw0QkFBNEIsQ0FBQztBQUMzQyxjQUFjLHNCQUFzQixDQUFDO0FBQ3JDLGNBQWMsaUJBQWlCLENBQUM7QUFDaEMsY0FBYyx1QkFBdUIsQ0FBQztBQUN0QyxjQUFjLGNBQWMsQ0FBQztBQUM3QixjQUFjLHdCQUF3QixDQUFDO0FBQ3ZDLGNBQWMsK0JBQStCLENBQUM7QUFDOUMsY0FBYyxtQkFBbUIsQ0FBQztBQUNsQyxjQUFjLHFCQUFxQixDQUFDO0FBQ3BDLGNBQWMsMEJBQTBCLENBQUM7QUFDekMsY0FBYyxrQ0FBa0MsQ0FBQztBQUNqRCxjQUFjLGFBQWEsQ0FBQztBQUM1QixjQUFjLG9CQUFvQixDQUFDO0FBQ25DLGNBQWMsY0FBYyxDQUFDO0FBQzdCLGNBQWMsV0FBVyxDQUFDO0FBQzFCLGNBQWMsY0FBYyxDQUFDO0FBQzdCLGNBQWMsY0FBYyxDQUFDO0FBQzdCLGNBQWMsOEJBQThCLENBQUMifQ==
|
package/package.json
CHANGED
package/ts/00_commitinfo_data.ts
CHANGED
package/ts/data/backup.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { TBackupRestoreRefusal } from './backuprestorerefusal.js';
|
|
1
2
|
import type { ICorestoreDatabaseAllocationReference } from './corestore.js';
|
|
2
3
|
|
|
3
4
|
export type TBackupStatus =
|
|
@@ -101,9 +102,17 @@ export type TBackupFailure =
|
|
|
101
102
|
| { kind: 'incomplete'; uncaptured: TBackupUncapturedResource[] }
|
|
102
103
|
| { kind: 'archive-unreadable' };
|
|
103
104
|
|
|
105
|
+
/**
|
|
106
|
+
* One restore of a backup, appended to its `restoreHistory`; `validateBackupRestoreEvent` judges its
|
|
107
|
+
* `status` and `refusal`.
|
|
108
|
+
*
|
|
109
|
+
* `refused`: the restore was refused before it wrote anything (`refusal` says why), so the service
|
|
110
|
+
* keeps the data it had. `failed`: it failed after it began writing.
|
|
111
|
+
*/
|
|
104
112
|
export interface IBackupRestoreEvent {
|
|
113
|
+
/** When the restore ended, or when it was refused. */
|
|
105
114
|
restoredAt: number;
|
|
106
|
-
status: 'restored' | 'failed';
|
|
115
|
+
status: 'restored' | 'failed' | 'refused';
|
|
107
116
|
errorText?: string;
|
|
108
117
|
/** The resource types the restore was limited to; absent when it restored every snapshot. */
|
|
109
118
|
resourceTypes?: TBackupResourceType[];
|
|
@@ -112,6 +121,8 @@ export interface IBackupRestoreEvent {
|
|
|
112
121
|
* none of the backup's `failure.uncaptured`.
|
|
113
122
|
*/
|
|
114
123
|
partial?: true;
|
|
124
|
+
/** Why a `refused` restore wrote nothing; present exactly when `status` is `refused`. */
|
|
125
|
+
refusal?: TBackupRestoreRefusal;
|
|
115
126
|
}
|
|
116
127
|
|
|
117
128
|
/**
|
|
@@ -0,0 +1,354 @@
|
|
|
1
|
+
import type { IBackupRestoreEvent, TBackupResourceType } from './backup.js';
|
|
2
|
+
import {
|
|
3
|
+
hasExactKeys, readDataElements, readDataProperties, readExactDataRecord,
|
|
4
|
+
} from '../private/dataproperties.js';
|
|
5
|
+
import { compareReleaseVersions, parseReleaseVersion } from './releaseversion.js';
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Why an in-place restore of a backup (`IReq_Any_Cloudly_RestoreServiceBackup`) was refused before
|
|
9
|
+
* it wrote anything. A restore is all-or-nothing: Corestore checks that it can read every snapshot
|
|
10
|
+
* the restore names before it replaces any data, and Cloudly dispatches the restore only to a relay
|
|
11
|
+
* whose contract carries that check. A refusal therefore always means nothing was written; the
|
|
12
|
+
* service keeps the data it had.
|
|
13
|
+
*
|
|
14
|
+
* - `restore-snapshot-unavailable`: the node's Corestore cannot read one or more snapshots the
|
|
15
|
+
* restore names; `missing` names each of them.
|
|
16
|
+
* - `restore-preflight-unsupported`: the node's Corestore does not offer the restore check (a
|
|
17
|
+
* Corestore built before it answers the check route with HTTP 404), so it cannot prove the
|
|
18
|
+
* restore would be whole and nothing is restored.
|
|
19
|
+
* - `restore-relay-contract-behind`: the cluster relay speaks an interfaces release below the one
|
|
20
|
+
* that carries the restore check, so Cloudly does not dispatch the restore; the relay states
|
|
21
|
+
* `relayInterfacesVersion` (`null` when it stated none) and the restore needs
|
|
22
|
+
* `minimumInterfacesVersion`.
|
|
23
|
+
* - `restore-operation-unavailable`: Cloudly refuses every in-place restore because a restore is not
|
|
24
|
+
* yet an operation the node owns: a restore relayed as one request is cut at the transport
|
|
25
|
+
* timeout, so Cloudly cannot learn whether it finished. It names the missing capability, not a
|
|
26
|
+
* version, and stays in this contract permanently because stored restore events carry it.
|
|
27
|
+
* Cloudly is its only producer and reads its own restore history, so it carries this reader
|
|
28
|
+
* itself: readers of restore events upgrade before Cloudly, and Cloudly is not rolled back below
|
|
29
|
+
* a release that stored it.
|
|
30
|
+
*
|
|
31
|
+
* It travels as `TypedResponseError.errorData` of a refused restore and is recorded as the
|
|
32
|
+
* `refusal` of the backup's `refused` restore event (`IBackupRestoreEvent`). Each refusal is
|
|
33
|
+
* exactly its schema: `readBackupRestoreRefusal` refuses any other member, so a producer never adds
|
|
34
|
+
* one without gating it on the reader's interfaces version.
|
|
35
|
+
*/
|
|
36
|
+
export const backupRestoreRefusalNames = Object.freeze([
|
|
37
|
+
'restore-snapshot-unavailable',
|
|
38
|
+
'restore-preflight-unsupported',
|
|
39
|
+
'restore-relay-contract-behind',
|
|
40
|
+
'restore-operation-unavailable',
|
|
41
|
+
] as const);
|
|
42
|
+
|
|
43
|
+
export type TBackupRestoreRefusalName = typeof backupRestoreRefusalNames[number];
|
|
44
|
+
|
|
45
|
+
export const backupRestoreRefusalContract = Object.freeze({
|
|
46
|
+
/** At most this many snapshots are named in one `restore-snapshot-unavailable`. */
|
|
47
|
+
maximumMissingSnapshots: 256,
|
|
48
|
+
/** A snapshot id or resource name is printable ASCII without spaces, at most this long. */
|
|
49
|
+
maximumNameLength: 255,
|
|
50
|
+
} as const);
|
|
51
|
+
|
|
52
|
+
/** One snapshot a restore names that the node's Corestore cannot read. */
|
|
53
|
+
export interface IBackupRestoreMissingSnapshot {
|
|
54
|
+
snapshotId: string;
|
|
55
|
+
/** The snapshot's resource type (`TBackupSnapshot['type']`). */
|
|
56
|
+
capability: TBackupResourceType;
|
|
57
|
+
/** The Corestore resource of a database or object-storage snapshot, when it is known. */
|
|
58
|
+
resourceName?: string;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
export interface IBackupRestoreSnapshotUnavailableRefusal {
|
|
62
|
+
name: 'restore-snapshot-unavailable';
|
|
63
|
+
/** Non-empty; each snapshot once. */
|
|
64
|
+
missing: IBackupRestoreMissingSnapshot[];
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export interface IBackupRestorePreflightUnsupportedRefusal {
|
|
68
|
+
name: 'restore-preflight-unsupported';
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export interface IBackupRestoreRelayContractBehindRefusal {
|
|
72
|
+
name: 'restore-relay-contract-behind';
|
|
73
|
+
/** The interfaces release the relay speaks, or `null` when it stated none. */
|
|
74
|
+
relayInterfacesVersion: string | null;
|
|
75
|
+
/** The lowest interfaces release a relay must speak to carry a restore. */
|
|
76
|
+
minimumInterfacesVersion: string;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export interface IBackupRestoreOperationUnavailableRefusal {
|
|
80
|
+
name: 'restore-operation-unavailable';
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
/** A refused restore, discriminated by `name` (`backupRestoreRefusalNames`). */
|
|
84
|
+
export type TBackupRestoreRefusal =
|
|
85
|
+
| IBackupRestoreSnapshotUnavailableRefusal
|
|
86
|
+
| IBackupRestorePreflightUnsupportedRefusal
|
|
87
|
+
| IBackupRestoreRelayContractBehindRefusal
|
|
88
|
+
| IBackupRestoreOperationUnavailableRefusal;
|
|
89
|
+
|
|
90
|
+
/** Every resource type, keyed so a new `TBackupResourceType` member fails to compile here. */
|
|
91
|
+
const backupResourceTypeKeys: Readonly<Record<TBackupResourceType, true>> = Object.freeze({
|
|
92
|
+
volume: true,
|
|
93
|
+
database: true,
|
|
94
|
+
objectstorage: true,
|
|
95
|
+
});
|
|
96
|
+
|
|
97
|
+
const isBackupResourceType = (valueArg: unknown): valueArg is TBackupResourceType => (
|
|
98
|
+
typeof valueArg === 'string' && Object.hasOwn(backupResourceTypeKeys, valueArg)
|
|
99
|
+
);
|
|
100
|
+
|
|
101
|
+
const printableNamePattern = /^[\x21-\x7e]+$/;
|
|
102
|
+
|
|
103
|
+
const isRestoreName = (valueArg: unknown): valueArg is string => (
|
|
104
|
+
typeof valueArg === 'string'
|
|
105
|
+
&& valueArg.length <= backupRestoreRefusalContract.maximumNameLength
|
|
106
|
+
&& printableNamePattern.test(valueArg)
|
|
107
|
+
);
|
|
108
|
+
|
|
109
|
+
const nameRule = 'must be printable ASCII without spaces, at most '
|
|
110
|
+
+ `${backupRestoreRefusalContract.maximumNameLength} characters`;
|
|
111
|
+
|
|
112
|
+
const isRefusalName = (valueArg: unknown): valueArg is TBackupRestoreRefusalName => (
|
|
113
|
+
typeof valueArg === 'string'
|
|
114
|
+
&& (backupRestoreRefusalNames as readonly string[]).includes(valueArg)
|
|
115
|
+
);
|
|
116
|
+
|
|
117
|
+
const validateMissingSnapshot = (valueArg: unknown, pathArg: string): string[] => {
|
|
118
|
+
const snapshot = readDataProperties(valueArg);
|
|
119
|
+
if (snapshot === null || !hasExactKeys(snapshot, ['snapshotId', 'capability'], ['resourceName'])) {
|
|
120
|
+
return [`${pathArg} must use its exact schema`];
|
|
121
|
+
}
|
|
122
|
+
const errors: string[] = [];
|
|
123
|
+
if (!isRestoreName(snapshot.snapshotId)) {
|
|
124
|
+
errors.push(`${pathArg}.snapshotId ${nameRule}`);
|
|
125
|
+
}
|
|
126
|
+
if (!isBackupResourceType(snapshot.capability)) {
|
|
127
|
+
errors.push(`${pathArg}.capability must be volume, database or objectstorage`);
|
|
128
|
+
}
|
|
129
|
+
if (Object.hasOwn(snapshot, 'resourceName') && !isRestoreName(snapshot.resourceName)) {
|
|
130
|
+
errors.push(`${pathArg}.resourceName ${nameRule}`);
|
|
131
|
+
}
|
|
132
|
+
return errors;
|
|
133
|
+
};
|
|
134
|
+
|
|
135
|
+
const validateMissingSnapshots = (valueArg: unknown, pathArg: string): string[] => {
|
|
136
|
+
const elements = readDataElements(valueArg, backupRestoreRefusalContract.maximumMissingSnapshots);
|
|
137
|
+
if (elements === null) {
|
|
138
|
+
return [`${pathArg} must be a list of at most `
|
|
139
|
+
+ `${backupRestoreRefusalContract.maximumMissingSnapshots} snapshots`];
|
|
140
|
+
}
|
|
141
|
+
if (elements.length === 0) {
|
|
142
|
+
return [`${pathArg} must name at least one snapshot`];
|
|
143
|
+
}
|
|
144
|
+
const errors = elements.flatMap((elementArg, indexArg) => (
|
|
145
|
+
validateMissingSnapshot(elementArg, `${pathArg}[${indexArg}]`)
|
|
146
|
+
));
|
|
147
|
+
if (errors.length > 0) {
|
|
148
|
+
return errors;
|
|
149
|
+
}
|
|
150
|
+
const snapshotIds = elements.map((elementArg) => (elementArg as IBackupRestoreMissingSnapshot).snapshotId);
|
|
151
|
+
if (new Set(snapshotIds).size !== snapshotIds.length) {
|
|
152
|
+
errors.push(`${pathArg} must name each snapshot once`);
|
|
153
|
+
}
|
|
154
|
+
return errors;
|
|
155
|
+
};
|
|
156
|
+
|
|
157
|
+
const validateRelayContractBehind = (
|
|
158
|
+
refusalArg: Record<string, unknown>,
|
|
159
|
+
pathArg: string,
|
|
160
|
+
): string[] => {
|
|
161
|
+
const relay = refusalArg.relayInterfacesVersion === null
|
|
162
|
+
? null
|
|
163
|
+
: parseReleaseVersion(refusalArg.relayInterfacesVersion);
|
|
164
|
+
const minimum = parseReleaseVersion(refusalArg.minimumInterfacesVersion);
|
|
165
|
+
const errors: string[] = [];
|
|
166
|
+
if (refusalArg.relayInterfacesVersion !== null && relay === null) {
|
|
167
|
+
errors.push(`${pathArg} relayInterfacesVersion must be a release version or null`);
|
|
168
|
+
}
|
|
169
|
+
if (minimum === null) {
|
|
170
|
+
errors.push(`${pathArg} minimumInterfacesVersion must be a release version`);
|
|
171
|
+
}
|
|
172
|
+
if (relay !== null && minimum !== null && compareReleaseVersions(relay, minimum) >= 0) {
|
|
173
|
+
errors.push(`${pathArg} relayInterfacesVersion must be below minimumInterfacesVersion`);
|
|
174
|
+
}
|
|
175
|
+
return errors;
|
|
176
|
+
};
|
|
177
|
+
|
|
178
|
+
/** The exact keys of each refusal. */
|
|
179
|
+
const refusalKeys: Readonly<Record<TBackupRestoreRefusalName, readonly string[]>> = Object.freeze({
|
|
180
|
+
'restore-snapshot-unavailable': Object.freeze(['name', 'missing']),
|
|
181
|
+
'restore-preflight-unsupported': Object.freeze(['name']),
|
|
182
|
+
'restore-relay-contract-behind': Object.freeze([
|
|
183
|
+
'name', 'relayInterfacesVersion', 'minimumInterfacesVersion',
|
|
184
|
+
]),
|
|
185
|
+
'restore-operation-unavailable': Object.freeze(['name']),
|
|
186
|
+
});
|
|
187
|
+
|
|
188
|
+
/** Validates one restore refusal against its exact schema and names every reason it is refused. */
|
|
189
|
+
export const validateBackupRestoreRefusal = (
|
|
190
|
+
valueArg: unknown,
|
|
191
|
+
pathArg = 'backup restore refusal',
|
|
192
|
+
): string[] => {
|
|
193
|
+
const properties = readDataProperties(valueArg);
|
|
194
|
+
if (properties === null || !isRefusalName(properties.name)) {
|
|
195
|
+
return [`${pathArg} name must be one of ${backupRestoreRefusalNames.join(', ')}`];
|
|
196
|
+
}
|
|
197
|
+
const refusal = readExactDataRecord(valueArg, refusalKeys[properties.name]);
|
|
198
|
+
if (refusal === null) {
|
|
199
|
+
return [`${pathArg} must use the exact schema of ${properties.name}`];
|
|
200
|
+
}
|
|
201
|
+
switch (properties.name) {
|
|
202
|
+
case 'restore-snapshot-unavailable':
|
|
203
|
+
return validateMissingSnapshots(refusal.missing, `${pathArg} missing`);
|
|
204
|
+
case 'restore-preflight-unsupported':
|
|
205
|
+
return [];
|
|
206
|
+
case 'restore-relay-contract-behind':
|
|
207
|
+
return validateRelayContractBehind(refusal, pathArg);
|
|
208
|
+
case 'restore-operation-unavailable':
|
|
209
|
+
return [];
|
|
210
|
+
}
|
|
211
|
+
};
|
|
212
|
+
|
|
213
|
+
/** Whether a value is exactly one restore refusal. */
|
|
214
|
+
export const isBackupRestoreRefusal = (valueArg: unknown): valueArg is TBackupRestoreRefusal => (
|
|
215
|
+
validateBackupRestoreRefusal(valueArg).length === 0
|
|
216
|
+
);
|
|
217
|
+
|
|
218
|
+
const freezeMissingSnapshot = (
|
|
219
|
+
snapshotArg: IBackupRestoreMissingSnapshot,
|
|
220
|
+
): IBackupRestoreMissingSnapshot => Object.freeze({
|
|
221
|
+
snapshotId: snapshotArg.snapshotId,
|
|
222
|
+
capability: snapshotArg.capability,
|
|
223
|
+
...(snapshotArg.resourceName === undefined ? {} : { resourceName: snapshotArg.resourceName }),
|
|
224
|
+
});
|
|
225
|
+
|
|
226
|
+
const copySnapshotUnavailableRefusal = (
|
|
227
|
+
refusalArg: IBackupRestoreSnapshotUnavailableRefusal,
|
|
228
|
+
): IBackupRestoreSnapshotUnavailableRefusal => {
|
|
229
|
+
const missing = refusalArg.missing.map(freezeMissingSnapshot);
|
|
230
|
+
Object.freeze(missing);
|
|
231
|
+
return Object.freeze({ name: refusalArg.name, missing });
|
|
232
|
+
};
|
|
233
|
+
|
|
234
|
+
const copyPreflightUnsupportedRefusal = (
|
|
235
|
+
refusalArg: IBackupRestorePreflightUnsupportedRefusal,
|
|
236
|
+
): IBackupRestorePreflightUnsupportedRefusal => Object.freeze({ name: refusalArg.name });
|
|
237
|
+
|
|
238
|
+
const copyRelayContractBehindRefusal = (
|
|
239
|
+
refusalArg: IBackupRestoreRelayContractBehindRefusal,
|
|
240
|
+
): IBackupRestoreRelayContractBehindRefusal => Object.freeze({
|
|
241
|
+
name: refusalArg.name,
|
|
242
|
+
relayInterfacesVersion: refusalArg.relayInterfacesVersion,
|
|
243
|
+
minimumInterfacesVersion: refusalArg.minimumInterfacesVersion,
|
|
244
|
+
});
|
|
245
|
+
|
|
246
|
+
const copyOperationUnavailableRefusal = (
|
|
247
|
+
refusalArg: IBackupRestoreOperationUnavailableRefusal,
|
|
248
|
+
): IBackupRestoreOperationUnavailableRefusal => Object.freeze({ name: refusalArg.name });
|
|
249
|
+
|
|
250
|
+
/** An inert frozen copy of a refusal that passed `validateBackupRestoreRefusal`. */
|
|
251
|
+
const copyRefusal = (refusalArg: TBackupRestoreRefusal): TBackupRestoreRefusal => {
|
|
252
|
+
switch (refusalArg.name) {
|
|
253
|
+
case 'restore-snapshot-unavailable':
|
|
254
|
+
return copySnapshotUnavailableRefusal(refusalArg);
|
|
255
|
+
case 'restore-preflight-unsupported':
|
|
256
|
+
return copyPreflightUnsupportedRefusal(refusalArg);
|
|
257
|
+
case 'restore-relay-contract-behind':
|
|
258
|
+
return copyRelayContractBehindRefusal(refusalArg);
|
|
259
|
+
case 'restore-operation-unavailable':
|
|
260
|
+
return copyOperationUnavailableRefusal(refusalArg);
|
|
261
|
+
}
|
|
262
|
+
};
|
|
263
|
+
|
|
264
|
+
/**
|
|
265
|
+
* The restore refusal inside an error payload or a stored restore event, as an inert frozen copy,
|
|
266
|
+
* or `null` when the value is not exactly one. It reads own data properties only, so a refusal
|
|
267
|
+
* read here carries nothing that runs.
|
|
268
|
+
*/
|
|
269
|
+
export const readBackupRestoreRefusal = (valueArg: unknown): TBackupRestoreRefusal | null => (
|
|
270
|
+
// A value that passed holds own data properties of exactly the refusal's schema at every level,
|
|
271
|
+
// so the copy reads the same data the validation judged.
|
|
272
|
+
isBackupRestoreRefusal(valueArg) ? copyRefusal(valueArg) : null
|
|
273
|
+
);
|
|
274
|
+
|
|
275
|
+
/** The refusal a builder composed, unchanged, or an error naming every reason it is refused. */
|
|
276
|
+
const requireRefusal = <T extends TBackupRestoreRefusal>(refusalArg: T): T => {
|
|
277
|
+
const errors = validateBackupRestoreRefusal(refusalArg);
|
|
278
|
+
if (errors.length > 0) {
|
|
279
|
+
throw new Error(errors.join('; '));
|
|
280
|
+
}
|
|
281
|
+
return refusalArg;
|
|
282
|
+
};
|
|
283
|
+
|
|
284
|
+
/** `restore-snapshot-unavailable` naming each snapshot the node's Corestore cannot read. */
|
|
285
|
+
export const buildBackupRestoreSnapshotUnavailableRefusal = (
|
|
286
|
+
missingArg: IBackupRestoreMissingSnapshot[],
|
|
287
|
+
): IBackupRestoreSnapshotUnavailableRefusal => copySnapshotUnavailableRefusal(requireRefusal({
|
|
288
|
+
name: 'restore-snapshot-unavailable',
|
|
289
|
+
missing: missingArg.map((snapshotArg) => ({ ...snapshotArg })),
|
|
290
|
+
}));
|
|
291
|
+
|
|
292
|
+
/** `restore-preflight-unsupported`: the node's Corestore offers no restore check. */
|
|
293
|
+
export const buildBackupRestorePreflightUnsupportedRefusal = (): IBackupRestorePreflightUnsupportedRefusal => (
|
|
294
|
+
copyPreflightUnsupportedRefusal(requireRefusal({ name: 'restore-preflight-unsupported' }))
|
|
295
|
+
);
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* `restore-relay-contract-behind`: the relay speaks an interfaces release below the minimum.
|
|
299
|
+
*
|
|
300
|
+
* Throws when a stated version is not a release version or is not below the minimum, so a caller
|
|
301
|
+
* passes `null` for a relay whose stated version it cannot read.
|
|
302
|
+
*/
|
|
303
|
+
export const buildBackupRestoreRelayContractBehindRefusal = (
|
|
304
|
+
relayInterfacesVersionArg: string | null,
|
|
305
|
+
minimumInterfacesVersionArg: string,
|
|
306
|
+
): IBackupRestoreRelayContractBehindRefusal => copyRelayContractBehindRefusal(requireRefusal({
|
|
307
|
+
name: 'restore-relay-contract-behind',
|
|
308
|
+
relayInterfacesVersion: relayInterfacesVersionArg,
|
|
309
|
+
minimumInterfacesVersion: minimumInterfacesVersionArg,
|
|
310
|
+
}));
|
|
311
|
+
|
|
312
|
+
/**
|
|
313
|
+
* `restore-operation-unavailable`: Cloudly refuses the in-place restore because a restore is not
|
|
314
|
+
* yet a node-owned operation.
|
|
315
|
+
*/
|
|
316
|
+
export const buildBackupRestoreOperationUnavailableRefusal = (): IBackupRestoreOperationUnavailableRefusal => (
|
|
317
|
+
copyOperationUnavailableRefusal(requireRefusal({ name: 'restore-operation-unavailable' }))
|
|
318
|
+
);
|
|
319
|
+
|
|
320
|
+
const restoreEventStatuses: readonly IBackupRestoreEvent['status'][] = Object.freeze([
|
|
321
|
+
'restored', 'failed', 'refused',
|
|
322
|
+
]);
|
|
323
|
+
|
|
324
|
+
/**
|
|
325
|
+
* Validates what this contract adds to a restore event of a backup's `restoreHistory` and names
|
|
326
|
+
* every reason it is refused: `status` is `restored`, `failed` or `refused`, and `refusal` is
|
|
327
|
+
* present exactly when `status` is `refused`, as one restore refusal. Every other member is left as
|
|
328
|
+
* it was written (records Cloudly already stores keep any `restoredAt`, `errorText`, `partial` and
|
|
329
|
+
* `resourceTypes` they hold), so every stored event stays valid.
|
|
330
|
+
*/
|
|
331
|
+
export const validateBackupRestoreEvent = (
|
|
332
|
+
valueArg: unknown,
|
|
333
|
+
pathArg = 'backup restore event',
|
|
334
|
+
): string[] => {
|
|
335
|
+
const event = readDataProperties(valueArg);
|
|
336
|
+
if (event === null) {
|
|
337
|
+
return [`${pathArg} must be a plain record of data properties`];
|
|
338
|
+
}
|
|
339
|
+
const errors: string[] = [];
|
|
340
|
+
if (!(restoreEventStatuses as readonly unknown[]).includes(event.status)) {
|
|
341
|
+
errors.push(`${pathArg} status must be one of ${restoreEventStatuses.join(', ')}`);
|
|
342
|
+
}
|
|
343
|
+
const hasRefusal = Object.hasOwn(event, 'refusal');
|
|
344
|
+
if (event.status === 'refused') {
|
|
345
|
+
if (!hasRefusal) {
|
|
346
|
+
errors.push(`${pathArg} refusal is required when status is refused`);
|
|
347
|
+
} else {
|
|
348
|
+
errors.push(...validateBackupRestoreRefusal(event.refusal, `${pathArg} refusal`));
|
|
349
|
+
}
|
|
350
|
+
} else if (hasRefusal) {
|
|
351
|
+
errors.push(`${pathArg} refusal is allowed only when status is refused`);
|
|
352
|
+
}
|
|
353
|
+
return errors;
|
|
354
|
+
};
|
package/ts/data/index.ts
CHANGED
|
@@ -76,6 +76,7 @@ export * from './secret.js';
|
|
|
76
76
|
export * from './baremetal.js';
|
|
77
77
|
export * from './baseos.js';
|
|
78
78
|
export * from './backup.js';
|
|
79
|
+
export * from './backuprestorerefusal.js';
|
|
79
80
|
export * from './clusternode.js';
|
|
80
81
|
export * from './clusternodehostname.js';
|
|
81
82
|
export * from './settings.js';
|