@softure-ai/backup 0.0.0-stage → 0.1.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 +18 -0
- package/LICENSE +21 -0
- package/README.md +223 -2
- package/dist/cli/main.d.ts +3 -0
- package/dist/cli/main.d.ts.map +1 -0
- package/dist/cli/main.js +16 -0
- package/dist/cli/main.js.map +1 -0
- package/dist/cli/run.d.ts +12 -0
- package/dist/cli/run.d.ts.map +1 -0
- package/dist/cli/run.js +335 -0
- package/dist/cli/run.js.map +1 -0
- package/dist/contract.d.ts +41 -0
- package/dist/contract.d.ts.map +1 -0
- package/dist/contract.js +14 -0
- package/dist/contract.js.map +1 -0
- package/dist/index.d.ts +21 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +30 -0
- package/dist/index.js.map +1 -0
- package/dist/messages/en.d.ts +16 -0
- package/dist/messages/en.d.ts.map +1 -0
- package/dist/messages/en.js +16 -0
- package/dist/messages/en.js.map +1 -0
- package/dist/messages/index.d.ts +21 -0
- package/dist/messages/index.d.ts.map +1 -0
- package/dist/messages/index.js +4 -0
- package/dist/messages/index.js.map +1 -0
- package/dist/offsite/config.d.ts +43 -0
- package/dist/offsite/config.d.ts.map +1 -0
- package/dist/offsite/config.js +130 -0
- package/dist/offsite/config.js.map +1 -0
- package/dist/offsite/crypto.d.ts +22 -0
- package/dist/offsite/crypto.d.ts.map +1 -0
- package/dist/offsite/crypto.js +48 -0
- package/dist/offsite/crypto.js.map +1 -0
- package/dist/offsite/index.d.ts +11 -0
- package/dist/offsite/index.d.ts.map +1 -0
- package/dist/offsite/index.js +13 -0
- package/dist/offsite/index.js.map +1 -0
- package/dist/offsite/lifecycle.d.ts +17 -0
- package/dist/offsite/lifecycle.d.ts.map +1 -0
- package/dist/offsite/lifecycle.js +45 -0
- package/dist/offsite/lifecycle.js.map +1 -0
- package/dist/offsite/objects.d.ts +19 -0
- package/dist/offsite/objects.d.ts.map +1 -0
- package/dist/offsite/objects.js +44 -0
- package/dist/offsite/objects.js.map +1 -0
- package/dist/offsite/postgres.d.ts +32 -0
- package/dist/offsite/postgres.d.ts.map +1 -0
- package/dist/offsite/postgres.js +97 -0
- package/dist/offsite/postgres.js.map +1 -0
- package/dist/offsite/restore.d.ts +54 -0
- package/dist/offsite/restore.d.ts.map +1 -0
- package/dist/offsite/restore.js +67 -0
- package/dist/offsite/restore.js.map +1 -0
- package/dist/offsite/s3.d.ts +34 -0
- package/dist/offsite/s3.d.ts.map +1 -0
- package/dist/offsite/s3.js +119 -0
- package/dist/offsite/s3.js.map +1 -0
- package/dist/offsite/sigv4.d.ts +19 -0
- package/dist/offsite/sigv4.d.ts.map +1 -0
- package/dist/offsite/sigv4.js +69 -0
- package/dist/offsite/sigv4.js.map +1 -0
- package/dist/offsite/status-sql.d.ts +10 -0
- package/dist/offsite/status-sql.d.ts.map +1 -0
- package/dist/offsite/status-sql.js +37 -0
- package/dist/offsite/status-sql.js.map +1 -0
- package/dist/offsite/upload.d.ts +33 -0
- package/dist/offsite/upload.d.ts.map +1 -0
- package/dist/offsite/upload.js +98 -0
- package/dist/offsite/upload.js.map +1 -0
- package/dist/offsite/verify.d.ts +32 -0
- package/dist/offsite/verify.d.ts.map +1 -0
- package/dist/offsite/verify.js +75 -0
- package/dist/offsite/verify.js.map +1 -0
- package/dist/schema.d.ts +150 -0
- package/dist/schema.d.ts.map +1 -0
- package/dist/schema.js +15 -0
- package/dist/schema.js.map +1 -0
- package/dist/server/index.d.ts +28 -0
- package/dist/server/index.d.ts.map +1 -0
- package/dist/server/index.js +98 -0
- package/dist/server/index.js.map +1 -0
- package/examples/backup-verify.yml +84 -0
- package/migrations/0001_create_runs.sql +21 -0
- package/module.json +12 -0
- package/package.json +67 -4
- package/src/cli/main.ts +16 -0
- package/src/cli/run.ts +338 -0
- package/src/contract.ts +46 -0
- package/src/index.ts +41 -0
- package/src/messages/en.ts +15 -0
- package/src/messages/index.ts +6 -0
- package/src/offsite/config.ts +157 -0
- package/src/offsite/crypto.ts +53 -0
- package/src/offsite/index.ts +31 -0
- package/src/offsite/lifecycle.ts +47 -0
- package/src/offsite/objects.ts +54 -0
- package/src/offsite/postgres.ts +115 -0
- package/src/offsite/restore.ts +108 -0
- package/src/offsite/s3.ts +144 -0
- package/src/offsite/sigv4.ts +84 -0
- package/src/offsite/status-sql.ts +45 -0
- package/src/offsite/upload.ts +116 -0
- package/src/offsite/verify.ts +97 -0
- package/src/schema.ts +17 -0
- package/src/server/index.ts +111 -0
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
// AWS Signature Version 4 for the three S3 requests this package sends (PUT, GET, ListObjectsV2), path style, so it
|
|
2
|
+
// works the same with Cloudflare R2, Backblaze B2, Hetzner Object Storage, MinIO and AWS. The payload hash is the
|
|
3
|
+
// real sha256 of the body (the empty body's for GET and list), never UNSIGNED-PAYLOAD.
|
|
4
|
+
import { createHash, createHmac } from "node:crypto";
|
|
5
|
+
export const EMPTY_SHA256 = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855";
|
|
6
|
+
/** RFC 3986 encoding of every byte except the unreserved ones, as SigV4 wants; `/` kept when `keepSlash`. */
|
|
7
|
+
export function encodeRfc3986(text, keepSlash = false) {
|
|
8
|
+
let encoded = "";
|
|
9
|
+
for (const byte of Buffer.from(text, "utf8")) {
|
|
10
|
+
const char = String.fromCharCode(byte);
|
|
11
|
+
if (/[A-Za-z0-9\-._~]/.test(char) || (keepSlash && char === "/"))
|
|
12
|
+
encoded += char;
|
|
13
|
+
else
|
|
14
|
+
encoded += `%${byte.toString(16).toUpperCase().padStart(2, "0")}`;
|
|
15
|
+
}
|
|
16
|
+
return encoded;
|
|
17
|
+
}
|
|
18
|
+
/** `20130524T000000Z` */
|
|
19
|
+
export function formatAmzDate(now) {
|
|
20
|
+
return now.toISOString().replace(/[-:]/g, "").replace(/\.\d{3}Z$/, "Z");
|
|
21
|
+
}
|
|
22
|
+
function sha256Hex(text) {
|
|
23
|
+
return createHash("sha256").update(text, "utf8").digest("hex");
|
|
24
|
+
}
|
|
25
|
+
function hmac(key, text) {
|
|
26
|
+
return createHmac("sha256", key).update(text, "utf8").digest();
|
|
27
|
+
}
|
|
28
|
+
function getCanonicalQuery(url) {
|
|
29
|
+
return [...url.searchParams.entries()]
|
|
30
|
+
.map(([key, value]) => [encodeRfc3986(key), encodeRfc3986(value)])
|
|
31
|
+
.sort(([left, leftValue], [right, rightValue]) => (left === right ? (leftValue < rightValue ? -1 : 1) : left < right ? -1 : 1))
|
|
32
|
+
.map(([key, value]) => `${key}=${value}`)
|
|
33
|
+
.join("&");
|
|
34
|
+
}
|
|
35
|
+
/** The headers to send, the `Authorization` one included. */
|
|
36
|
+
export function signRequest(input) {
|
|
37
|
+
const amzDate = formatAmzDate(input.now);
|
|
38
|
+
const day = amzDate.slice(0, 8);
|
|
39
|
+
const headers = {
|
|
40
|
+
host: input.url.host,
|
|
41
|
+
"x-amz-content-sha256": input.payloadSha256,
|
|
42
|
+
"x-amz-date": amzDate,
|
|
43
|
+
};
|
|
44
|
+
for (const [name, value] of Object.entries(input.headers ?? {}))
|
|
45
|
+
headers[name.toLowerCase()] = value.trim().replace(/\s+/g, " ");
|
|
46
|
+
const names = Object.keys(headers).sort();
|
|
47
|
+
const canonicalHeaders = names.map((name) => `${name}:${headers[name] ?? ""}\n`).join("");
|
|
48
|
+
const signedHeaders = names.join(";");
|
|
49
|
+
// The path as the URL holds it is already percent-encoded once; S3 signs it without a second encoding.
|
|
50
|
+
const canonicalRequest = [
|
|
51
|
+
input.method,
|
|
52
|
+
input.url.pathname,
|
|
53
|
+
getCanonicalQuery(input.url),
|
|
54
|
+
canonicalHeaders,
|
|
55
|
+
signedHeaders,
|
|
56
|
+
input.payloadSha256,
|
|
57
|
+
].join("\n");
|
|
58
|
+
const scope = `${day}/${input.region}/s3/aws4_request`;
|
|
59
|
+
const stringToSign = ["AWS4-HMAC-SHA256", amzDate, scope, sha256Hex(canonicalRequest)].join("\n");
|
|
60
|
+
const signingKey = hmac(hmac(hmac(hmac(`AWS4${input.secretAccessKey}`, day), input.region), "s3"), "aws4_request");
|
|
61
|
+
const signature = createHmac("sha256", signingKey).update(stringToSign, "utf8").digest("hex");
|
|
62
|
+
// fetch sets Host itself from the URL.
|
|
63
|
+
const sent = Object.fromEntries(Object.entries(headers).filter(([name]) => name !== "host"));
|
|
64
|
+
return {
|
|
65
|
+
...sent,
|
|
66
|
+
authorization: `AWS4-HMAC-SHA256 Credential=${input.accessKeyId}/${scope}, SignedHeaders=${signedHeaders}, Signature=${signature}`,
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
//# sourceMappingURL=sigv4.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sigv4.js","sourceRoot":"","sources":["../../src/offsite/sigv4.ts"],"names":[],"mappings":"AAAA,oHAAoH;AACpH,kHAAkH;AAClH,uFAAuF;AACvF,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAErD,MAAM,CAAC,MAAM,YAAY,GAAG,kEAAkE,CAAC;AAc/F,6GAA6G;AAC7G,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,SAAS,GAAG,KAAK;IAC3D,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;QAC7C,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,KAAK,GAAG,CAAC;YAAE,OAAO,IAAI,IAAI,CAAC;;YAC7E,OAAO,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;IACzE,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,yBAAyB;AACzB,MAAM,UAAU,aAAa,CAAC,GAAS;IACrC,OAAO,GAAG,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;AAC1E,CAAC;AAED,SAAS,SAAS,CAAC,IAAY;IAC7B,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,IAAI,CAAC,GAAoB,EAAE,IAAY;IAC9C,OAAO,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC;AACjE,CAAC;AAED,SAAS,iBAAiB,CAAC,GAAQ;IACjC,OAAO,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;SACnC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,aAAa,CAAC,KAAK,CAAC,CAAU,CAAC;SAC1E,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC9H,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;SACxC,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED,6DAA6D;AAC7D,MAAM,UAAU,WAAW,CAAC,KAAgB;IAC1C,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzC,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAChC,MAAM,OAAO,GAA2B;QACtC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI;QACpB,sBAAsB,EAAE,KAAK,CAAC,aAAa;QAC3C,YAAY,EAAE,OAAO;KACtB,CAAC;IACF,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC;QAAE,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjI,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;IAC1C,MAAM,gBAAgB,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1F,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtC,uGAAuG;IACvG,MAAM,gBAAgB,GAAG;QACvB,KAAK,CAAC,MAAM;QACZ,KAAK,CAAC,GAAG,CAAC,QAAQ;QAClB,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC;QAC5B,gBAAgB;QAChB,aAAa;QACb,KAAK,CAAC,aAAa;KACpB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACb,MAAM,KAAK,GAAG,GAAG,GAAG,IAAI,KAAK,CAAC,MAAM,kBAAkB,CAAC;IACvD,MAAM,YAAY,GAAG,CAAC,kBAAkB,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClG,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,eAAe,EAAE,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,CAAC;IACnH,MAAM,SAAS,GAAG,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9F,uCAAuC;IACvC,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC;IAC7F,OAAO;QACL,GAAG,IAAI;QACP,aAAa,EAAE,+BAA+B,KAAK,CAAC,WAAW,IAAI,KAAK,mBAAmB,aAAa,eAAe,SAAS,EAAE;KACnI,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { RunRecord } from "./upload.js";
|
|
2
|
+
/** Rows of `backup.runs` older than this before the newest run are removed with it: a year and a month of history. */
|
|
3
|
+
export declare const STATUS_RETENTION_DAYS = 400;
|
|
4
|
+
/** A standard SQL string literal (`standard_conforming_strings` is on since Postgres 9.1); NUL is dropped. */
|
|
5
|
+
export declare function quoteLiteral(text: string): string;
|
|
6
|
+
/** The time before which `backup.runs` rows are pruned when a run that started at `startedAt` is recorded. */
|
|
7
|
+
export declare function getPruneBefore(startedAt: Date): Date;
|
|
8
|
+
/** One transaction: the run's row, then the prune of rows older than the retention. */
|
|
9
|
+
export declare function buildStatusSql(record: RunRecord): string;
|
|
10
|
+
//# sourceMappingURL=status-sql.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"status-sql.d.ts","sourceRoot":"","sources":["../../src/offsite/status-sql.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,sHAAsH;AACtH,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAIzC,8GAA8G;AAC9G,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEjD;AAMD,8GAA8G;AAC9G,wBAAgB,cAAc,CAAC,SAAS,EAAE,IAAI,GAAG,IAAI,CAEpD;AAED,uFAAuF;AACvF,wBAAgB,cAAc,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAmBxD"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/** Rows of `backup.runs` older than this before the newest run are removed with it: a year and a month of history. */
|
|
2
|
+
export const STATUS_RETENTION_DAYS = 400;
|
|
3
|
+
const MAX_ERROR_MESSAGE = 500;
|
|
4
|
+
const DAY_MS = 24 * 60 * 60 * 1000;
|
|
5
|
+
/** A standard SQL string literal (`standard_conforming_strings` is on since Postgres 9.1); NUL is dropped. */
|
|
6
|
+
export function quoteLiteral(text) {
|
|
7
|
+
return `'${text.replace(/\0/g, "").replace(/'/g, "''")}'`;
|
|
8
|
+
}
|
|
9
|
+
function quoteTime(date) {
|
|
10
|
+
return `${quoteLiteral(date.toISOString())}::timestamptz`;
|
|
11
|
+
}
|
|
12
|
+
/** The time before which `backup.runs` rows are pruned when a run that started at `startedAt` is recorded. */
|
|
13
|
+
export function getPruneBefore(startedAt) {
|
|
14
|
+
return new Date(startedAt.getTime() - STATUS_RETENTION_DAYS * DAY_MS);
|
|
15
|
+
}
|
|
16
|
+
/** One transaction: the run's row, then the prune of rows older than the retention. */
|
|
17
|
+
export function buildStatusSql(record) {
|
|
18
|
+
const objects = JSON.stringify(record.objects.map(({ kind, key, bytes, sha256 }) => ({ kind, key, bytes, sha256 })));
|
|
19
|
+
const error = record.error;
|
|
20
|
+
const values = [
|
|
21
|
+
quoteTime(record.startedAt),
|
|
22
|
+
quoteTime(record.finishedAt),
|
|
23
|
+
quoteLiteral(record.result),
|
|
24
|
+
`${quoteLiteral(objects)}::jsonb`,
|
|
25
|
+
String(Math.max(0, Math.trunc(record.sizeBytes))),
|
|
26
|
+
error === null ? "NULL" : quoteLiteral(error.code),
|
|
27
|
+
error === null ? "NULL" : quoteLiteral(error.message.slice(0, MAX_ERROR_MESSAGE)),
|
|
28
|
+
];
|
|
29
|
+
return [
|
|
30
|
+
"BEGIN;",
|
|
31
|
+
`INSERT INTO backup.runs (started_at, finished_at, result, objects, size_bytes, error_code, error_message) VALUES (${values.join(", ")});`,
|
|
32
|
+
`DELETE FROM backup.runs WHERE started_at < ${quoteTime(getPruneBefore(record.startedAt))};`,
|
|
33
|
+
"COMMIT;",
|
|
34
|
+
"",
|
|
35
|
+
].join("\n");
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=status-sql.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"status-sql.js","sourceRoot":"","sources":["../../src/offsite/status-sql.ts"],"names":[],"mappings":"AAKA,sHAAsH;AACtH,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,CAAC;AACzC,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAC9B,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAEnC,8GAA8G;AAC9G,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC;AAC5D,CAAC;AAED,SAAS,SAAS,CAAC,IAAU;IAC3B,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC;AAC5D,CAAC;AAED,8GAA8G;AAC9G,MAAM,UAAU,cAAc,CAAC,SAAe;IAC5C,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,qBAAqB,GAAG,MAAM,CAAC,CAAC;AACxE,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,cAAc,CAAC,MAAiB;IAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IACrH,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;IAC3B,MAAM,MAAM,GAAG;QACb,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC;QAC3B,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC;QAC5B,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC;QAC3B,GAAG,YAAY,CAAC,OAAO,CAAC,SAAS;QACjC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QACjD,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC;QAClD,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;KAClF,CAAC;IACF,OAAO;QACL,QAAQ;QACR,qHAAqH,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;QAC1I,8CAA8C,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG;QAC5F,SAAS;QACT,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import type { BackupErrorCode, BackupObject, BackupResult } from "../contract.js";
|
|
2
|
+
import type { UploadConfig } from "./config.js";
|
|
3
|
+
import { type S3Options } from "./s3.js";
|
|
4
|
+
export interface RunRecord {
|
|
5
|
+
readonly startedAt: Date;
|
|
6
|
+
readonly finishedAt: Date;
|
|
7
|
+
readonly result: BackupResult;
|
|
8
|
+
readonly objects: readonly BackupObject[];
|
|
9
|
+
readonly sizeBytes: number;
|
|
10
|
+
readonly error: {
|
|
11
|
+
readonly code: BackupErrorCode;
|
|
12
|
+
readonly message: string;
|
|
13
|
+
} | null;
|
|
14
|
+
}
|
|
15
|
+
export interface UploadOptions {
|
|
16
|
+
readonly config: UploadConfig;
|
|
17
|
+
/** Local backup files: the run's dump, and its data archive when there is one. */
|
|
18
|
+
readonly files: readonly string[];
|
|
19
|
+
readonly now?: () => Date;
|
|
20
|
+
readonly s3?: S3Options;
|
|
21
|
+
/** Called after each uploaded object (for a log line). */
|
|
22
|
+
readonly onUploaded?: (object: BackupObject) => void;
|
|
23
|
+
}
|
|
24
|
+
/** sha256 (hex) and size of a file, streamed. */
|
|
25
|
+
export declare function hashFile(path: string): Promise<{
|
|
26
|
+
sha256: string;
|
|
27
|
+
bytes: number;
|
|
28
|
+
}>;
|
|
29
|
+
/** Uploads every file in order; the first failure ends the run (already uploaded objects stay listed). */
|
|
30
|
+
export declare function uploadBackups(options: UploadOptions): Promise<RunRecord>;
|
|
31
|
+
/** A run that did nothing because the host has no off-site configuration. */
|
|
32
|
+
export declare function buildNotConfiguredRecord(now: Date): RunRecord;
|
|
33
|
+
//# sourceMappingURL=upload.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"upload.d.ts","sourceRoot":"","sources":["../../src/offsite/upload.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAClF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAGhD,OAAO,EAAiC,KAAK,SAAS,EAAE,MAAM,SAAS,CAAC;AAExE,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,SAAS,YAAY,EAAE,CAAC;IAC1C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;QAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;CACrF;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,kFAAkF;IAClF,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,IAAI,CAAC;IAC1B,QAAQ,CAAC,EAAE,CAAC,EAAE,SAAS,CAAC;IACxB,0DAA0D;IAC1D,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAC;CACtD;AAWD,iDAAiD;AACjD,wBAAsB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,CAIvF;AAoCD,0GAA0G;AAC1G,wBAAsB,aAAa,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,SAAS,CAAC,CA2B9E;AAED,6EAA6E;AAC7E,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,IAAI,GAAG,SAAS,CAE7D"}
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
// The nightly off-site copy: each file is encrypted to the recipient into a temporary file next to it (0600),
|
|
2
|
+
// hashed, PUT under the prefix and removed again. Nothing remote is ever listed, read or deleted, so a write-only
|
|
3
|
+
// token is enough. The result is a run record with safe error codes; secrets never reach its message.
|
|
4
|
+
import { createHash } from "node:crypto";
|
|
5
|
+
import { createReadStream, existsSync, rmSync, statSync } from "node:fs";
|
|
6
|
+
import { basename, dirname, join } from "node:path";
|
|
7
|
+
import { pipeline } from "node:stream/promises";
|
|
8
|
+
import { encryptFile } from "./crypto.js";
|
|
9
|
+
import { buildObjectKey, parseBackupFileName } from "./objects.js";
|
|
10
|
+
import { putObjectFile, S3RequestError } from "./s3.js";
|
|
11
|
+
class UploadFailure extends Error {
|
|
12
|
+
code;
|
|
13
|
+
constructor(code, message) {
|
|
14
|
+
super(message);
|
|
15
|
+
this.code = code;
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
/** sha256 (hex) and size of a file, streamed. */
|
|
19
|
+
export async function hashFile(path) {
|
|
20
|
+
const hash = createHash("sha256");
|
|
21
|
+
await pipeline(createReadStream(path), hash);
|
|
22
|
+
return { sha256: hash.digest("hex"), bytes: statSync(path).size };
|
|
23
|
+
}
|
|
24
|
+
function describeS3Error(error, key) {
|
|
25
|
+
if (error instanceof S3RequestError) {
|
|
26
|
+
if (error.isDenied)
|
|
27
|
+
return new UploadFailure("upload_denied", `the store refused ${key}: ${error.message}`);
|
|
28
|
+
if (error.status === null)
|
|
29
|
+
return new UploadFailure("network_error", error.message);
|
|
30
|
+
return new UploadFailure("upload_failed", error.message);
|
|
31
|
+
}
|
|
32
|
+
return new UploadFailure("upload_failed", `uploading ${key} failed (${error instanceof Error ? error.message : String(error)})`);
|
|
33
|
+
}
|
|
34
|
+
async function uploadFile(config, path, options) {
|
|
35
|
+
const name = basename(path);
|
|
36
|
+
const parsed = parseBackupFileName(name);
|
|
37
|
+
if (parsed === null)
|
|
38
|
+
throw new UploadFailure("file_missing", `${name} is not a backup file name (db-<time>.dump or data-<time>.tar.gz)`);
|
|
39
|
+
if (!existsSync(path) || !statSync(path).isFile())
|
|
40
|
+
throw new UploadFailure("file_missing", `${name} is not in ${dirname(path)}`);
|
|
41
|
+
const encrypted = join(dirname(path), `.offsite-${String(process.pid)}-${name}.age`);
|
|
42
|
+
try {
|
|
43
|
+
try {
|
|
44
|
+
await encryptFile(path, encrypted, config.recipient);
|
|
45
|
+
}
|
|
46
|
+
catch (error) {
|
|
47
|
+
throw new UploadFailure("encrypt_failed", `encrypting ${name} failed (${error instanceof Error ? error.message : String(error)})`);
|
|
48
|
+
}
|
|
49
|
+
const { sha256, bytes } = await hashFile(encrypted);
|
|
50
|
+
const key = buildObjectKey(config.store.prefix, name);
|
|
51
|
+
try {
|
|
52
|
+
await putObjectFile(config.store, { key, path: encrypted, bytes, sha256 }, options.s3);
|
|
53
|
+
}
|
|
54
|
+
catch (error) {
|
|
55
|
+
throw describeS3Error(error, key);
|
|
56
|
+
}
|
|
57
|
+
return { kind: parsed.kind, key, bytes, sha256 };
|
|
58
|
+
}
|
|
59
|
+
finally {
|
|
60
|
+
rmSync(encrypted, { force: true });
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
/** Uploads every file in order; the first failure ends the run (already uploaded objects stay listed). */
|
|
64
|
+
export async function uploadBackups(options) {
|
|
65
|
+
const now = options.now ?? (() => new Date());
|
|
66
|
+
const startedAt = now();
|
|
67
|
+
const objects = [];
|
|
68
|
+
let error = null;
|
|
69
|
+
for (const file of options.files) {
|
|
70
|
+
try {
|
|
71
|
+
const object = await uploadFile(options.config, file, options);
|
|
72
|
+
objects.push(object);
|
|
73
|
+
options.onUploaded?.(object);
|
|
74
|
+
}
|
|
75
|
+
catch (caught) {
|
|
76
|
+
error =
|
|
77
|
+
caught instanceof UploadFailure
|
|
78
|
+
? { code: caught.code, message: caught.message }
|
|
79
|
+
: { code: "upload_failed", message: caught instanceof Error ? caught.message : String(caught) };
|
|
80
|
+
break;
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
if (options.files.length === 0)
|
|
84
|
+
error = { code: "file_missing", message: "no backup file was given" };
|
|
85
|
+
return {
|
|
86
|
+
startedAt,
|
|
87
|
+
finishedAt: now(),
|
|
88
|
+
result: error === null ? "ok" : "failed",
|
|
89
|
+
objects,
|
|
90
|
+
sizeBytes: objects.reduce((sum, object) => sum + object.bytes, 0),
|
|
91
|
+
error,
|
|
92
|
+
};
|
|
93
|
+
}
|
|
94
|
+
/** A run that did nothing because the host has no off-site configuration. */
|
|
95
|
+
export function buildNotConfiguredRecord(now) {
|
|
96
|
+
return { startedAt: now, finishedAt: now, result: "not_configured", objects: [], sizeBytes: 0, error: null };
|
|
97
|
+
}
|
|
98
|
+
//# sourceMappingURL=upload.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"upload.js","sourceRoot":"","sources":["../../src/offsite/upload.ts"],"names":[],"mappings":"AAAA,8GAA8G;AAC9G,kHAAkH;AAClH,sGAAsG;AACtG,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAGhD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAkB,MAAM,SAAS,CAAC;AAqBxE,MAAM,aAAc,SAAQ,KAAK;IACtB,IAAI,CAAkB;IAE/B,YAAY,IAAqB,EAAE,OAAe;QAChD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,iDAAiD;AACjD,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,IAAY;IACzC,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;IAClC,MAAM,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;IAC7C,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;AACpE,CAAC;AAED,SAAS,eAAe,CAAC,KAAc,EAAE,GAAW;IAClD,IAAI,KAAK,YAAY,cAAc,EAAE,CAAC;QACpC,IAAI,KAAK,CAAC,QAAQ;YAAE,OAAO,IAAI,aAAa,CAAC,eAAe,EAAE,qBAAqB,GAAG,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAC5G,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI;YAAE,OAAO,IAAI,aAAa,CAAC,eAAe,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QACpF,OAAO,IAAI,aAAa,CAAC,eAAe,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,IAAI,aAAa,CAAC,eAAe,EAAE,aAAa,GAAG,YAAY,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACnI,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,MAAoB,EAAE,IAAY,EAAE,OAAsB;IAClF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,MAAM,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACzC,IAAI,MAAM,KAAK,IAAI;QAAE,MAAM,IAAI,aAAa,CAAC,cAAc,EAAE,GAAG,IAAI,mEAAmE,CAAC,CAAC;IACzI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE;QAAE,MAAM,IAAI,aAAa,CAAC,cAAc,EAAE,GAAG,IAAI,cAAc,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjI,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,YAAY,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,MAAM,CAAC,CAAC;IACrF,IAAI,CAAC;QACH,IAAI,CAAC;YACH,MAAM,WAAW,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QACvD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,aAAa,CAAC,gBAAgB,EAAE,cAAc,IAAI,YAAY,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrI,CAAC;QACD,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpD,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACtD,IAAI,CAAC;YACH,MAAM,aAAa,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QACzF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IACnD,CAAC;YAAS,CAAC;QACT,MAAM,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACrC,CAAC;AACH,CAAC;AAED,0GAA0G;AAC1G,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAsB;IACxD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IAC9C,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC;IACxB,MAAM,OAAO,GAAmB,EAAE,CAAC;IACnC,IAAI,KAAK,GAAuB,IAAI,CAAC;IACrC,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QACjC,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;YAC/D,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACrB,OAAO,CAAC,UAAU,EAAE,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;QAAC,OAAO,MAAM,EAAE,CAAC;YAChB,KAAK;gBACH,MAAM,YAAY,aAAa;oBAC7B,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;oBAChD,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,YAAY,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YACpG,MAAM;QACR,CAAC;IACH,CAAC;IACD,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,KAAK,GAAG,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,0BAA0B,EAAE,CAAC;IACtG,OAAO;QACL,SAAS;QACT,UAAU,EAAE,GAAG,EAAE;QACjB,MAAM,EAAE,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ;QACxC,OAAO;QACP,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QACjE,KAAK;KACN,CAAC;AACJ,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,wBAAwB,CAAC,GAAS;IAChD,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAC/G,CAAC"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { type RowCounts } from "@softure-ai/deploy";
|
|
2
|
+
import type { StoreConfig } from "./config.js";
|
|
3
|
+
import { type OffsiteResult } from "./restore.js";
|
|
4
|
+
import { type S3Options } from "./s3.js";
|
|
5
|
+
export declare const DEFAULT_MAX_AGE_HOURS = 26;
|
|
6
|
+
export interface VerifyOptions {
|
|
7
|
+
readonly store: StoreConfig;
|
|
8
|
+
readonly identities: readonly string[];
|
|
9
|
+
/** A superuser's URL on a scratch server (or the operator's own); a throwaway database is created there. */
|
|
10
|
+
readonly adminUrl: string;
|
|
11
|
+
/** Tables that must exist in the restored copy. */
|
|
12
|
+
readonly tables: readonly string[];
|
|
13
|
+
/** The app's exported migrations (the image's softure-migrations folder): the schema guard runs when set. */
|
|
14
|
+
readonly migrationsDir?: string;
|
|
15
|
+
readonly maxAgeHours?: number;
|
|
16
|
+
readonly pgRestore: string;
|
|
17
|
+
readonly env: Readonly<Record<string, string | undefined>>;
|
|
18
|
+
readonly now?: Date;
|
|
19
|
+
readonly s3?: S3Options;
|
|
20
|
+
/** A fixed name instead of a random one (tests). */
|
|
21
|
+
readonly database?: string;
|
|
22
|
+
}
|
|
23
|
+
export interface VerifyOutcome {
|
|
24
|
+
readonly key: string;
|
|
25
|
+
readonly ageHours: number;
|
|
26
|
+
readonly counts: RowCounts;
|
|
27
|
+
readonly schemaGuard: "passed" | "skipped";
|
|
28
|
+
}
|
|
29
|
+
/** The tables to check: rowCountTables less excludeTableData. */
|
|
30
|
+
export declare function selectVerifyTables(rowCountTables: readonly string[] | undefined, excludeTableData: readonly string[] | undefined): string[];
|
|
31
|
+
export declare function verifyBackup(options: VerifyOptions): Promise<OffsiteResult<VerifyOutcome>>;
|
|
32
|
+
//# sourceMappingURL=verify.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"verify.d.ts","sourceRoot":"","sources":["../../src/offsite/verify.ts"],"names":[],"mappings":"AAKA,OAAO,EAAwC,KAAK,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC1F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAG/C,OAAO,EAAc,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAmB,KAAK,SAAS,EAAE,MAAM,SAAS,CAAC;AAE1D,eAAO,MAAM,qBAAqB,KAAK,CAAC;AAGxC,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAC5B,QAAQ,CAAC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IACvC,4GAA4G;IAC5G,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,mDAAmD;IACnD,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,6GAA6G;IAC7G,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;IAC3D,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,EAAE,CAAC,EAAE,SAAS,CAAC;IACxB,oDAAoD;IACpD,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,QAAQ,CAAC,WAAW,EAAE,QAAQ,GAAG,SAAS,CAAC;CAC5C;AAED,iEAAiE;AACjE,wBAAgB,kBAAkB,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,EAAE,gBAAgB,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,GAAG,MAAM,EAAE,CAG3I;AAiBD,wBAAsB,YAAY,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAmChG"}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
// Verify the newest off-site copy end to end: it is recent enough, it decrypts, pg_restore takes it whole into a
|
|
2
|
+
// throwaway database, the deploy's schema guard accepts it against the app's migrations, and every table of
|
|
3
|
+
// deploy.json's rowCountTables (less excludeTableData, whose rows the dump leaves out) is there; then the database is
|
|
4
|
+
// dropped, also after a failure. It needs the private key, so it runs on the operator's machine or in a CI job,
|
|
5
|
+
// never on the server.
|
|
6
|
+
import { countRows, guardSchema, withPgClient } from "@softure-ai/deploy";
|
|
7
|
+
import { decryptStream } from "./crypto.js";
|
|
8
|
+
import { createDatabase, createVerifyDatabaseName, dropDatabase, runPgRestore, withDatabase } from "./postgres.js";
|
|
9
|
+
import { resolveKey } from "./restore.js";
|
|
10
|
+
import { getObjectStream } from "./s3.js";
|
|
11
|
+
export const DEFAULT_MAX_AGE_HOURS = 26;
|
|
12
|
+
const HOUR_MS = 60 * 60 * 1000;
|
|
13
|
+
/** The tables to check: rowCountTables less excludeTableData. */
|
|
14
|
+
export function selectVerifyTables(rowCountTables, excludeTableData) {
|
|
15
|
+
const excluded = new Set(excludeTableData ?? []);
|
|
16
|
+
return (rowCountTables ?? []).filter((table) => !excluded.has(table));
|
|
17
|
+
}
|
|
18
|
+
async function checkRestored(url, options) {
|
|
19
|
+
return withPgClient(url, async (client) => {
|
|
20
|
+
let schemaGuard = "skipped";
|
|
21
|
+
if (options.migrationsDir !== undefined) {
|
|
22
|
+
const guard = await guardSchema(client, options.migrationsDir);
|
|
23
|
+
if (!guard.ok)
|
|
24
|
+
return { ok: false, problem: `the schema guard refused the restored copy: ${guard.problems.join("; ")}` };
|
|
25
|
+
schemaGuard = "passed";
|
|
26
|
+
}
|
|
27
|
+
const counts = await countRows(client, options.tables);
|
|
28
|
+
const missing = Object.entries(counts).filter(([, count]) => count === null).map(([table]) => table);
|
|
29
|
+
if (missing.length > 0)
|
|
30
|
+
return { ok: false, problem: `the restored copy lacks ${missing.join(", ")}` };
|
|
31
|
+
return { ok: true, value: { counts, schemaGuard } };
|
|
32
|
+
});
|
|
33
|
+
}
|
|
34
|
+
export async function verifyBackup(options) {
|
|
35
|
+
const now = options.now ?? new Date();
|
|
36
|
+
const resolved = await resolveKey(options.store, "database", undefined, options.s3);
|
|
37
|
+
if (!resolved.ok)
|
|
38
|
+
return resolved;
|
|
39
|
+
const ageHours = (now.getTime() - resolved.value.takenAt.getTime()) / HOUR_MS;
|
|
40
|
+
const maxAgeHours = options.maxAgeHours ?? DEFAULT_MAX_AGE_HOURS;
|
|
41
|
+
if (ageHours > maxAgeHours) {
|
|
42
|
+
return { ok: false, problem: `the newest off-site copy ${resolved.value.key} is ${ageHours.toFixed(1)} h old, more than ${String(maxAgeHours)} h` };
|
|
43
|
+
}
|
|
44
|
+
const encrypted = await getObjectStream(options.store, resolved.value.key, options.s3);
|
|
45
|
+
let dump;
|
|
46
|
+
try {
|
|
47
|
+
dump = await decryptStream(encrypted, options.identities);
|
|
48
|
+
}
|
|
49
|
+
catch (error) {
|
|
50
|
+
await encrypted.cancel().catch(() => undefined);
|
|
51
|
+
return { ok: false, problem: `cannot decrypt ${resolved.value.key} with this identity (${error instanceof Error ? error.message : String(error)})` };
|
|
52
|
+
}
|
|
53
|
+
const database = options.database ?? createVerifyDatabaseName();
|
|
54
|
+
await createDatabase(options.adminUrl, database);
|
|
55
|
+
try {
|
|
56
|
+
const restored = await runPgRestore({
|
|
57
|
+
adminUrl: options.adminUrl,
|
|
58
|
+
database,
|
|
59
|
+
flags: ["--no-owner", "--no-acl"],
|
|
60
|
+
dump,
|
|
61
|
+
pgRestore: options.pgRestore,
|
|
62
|
+
env: options.env,
|
|
63
|
+
});
|
|
64
|
+
if (!restored.ok)
|
|
65
|
+
return { ok: false, problem: `${resolved.value.key} does not restore: ${restored.problem}` };
|
|
66
|
+
const checked = await checkRestored(withDatabase(options.adminUrl, database), options);
|
|
67
|
+
if (!checked.ok)
|
|
68
|
+
return checked;
|
|
69
|
+
return { ok: true, value: { key: resolved.value.key, ageHours, ...checked.value } };
|
|
70
|
+
}
|
|
71
|
+
finally {
|
|
72
|
+
await dropDatabase(options.adminUrl, database);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
//# sourceMappingURL=verify.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"verify.js","sourceRoot":"","sources":["../../src/offsite/verify.ts"],"names":[],"mappings":"AAAA,iHAAiH;AACjH,4GAA4G;AAC5G,sHAAsH;AACtH,gHAAgH;AAChH,uBAAuB;AACvB,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAkB,MAAM,oBAAoB,CAAC;AAE1F,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACnH,OAAO,EAAE,UAAU,EAAsB,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAkB,MAAM,SAAS,CAAC;AAE1D,MAAM,CAAC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACxC,MAAM,OAAO,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AA2B/B,iEAAiE;AACjE,MAAM,UAAU,kBAAkB,CAAC,cAA6C,EAAE,gBAA+C;IAC/H,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC;IACjD,OAAO,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,GAAW,EAAE,OAAsB;IAC9D,OAAO,YAAY,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QACxC,IAAI,WAAW,GAAyB,SAAS,CAAC;QAClD,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;YACxC,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;YAC/D,IAAI,CAAC,KAAK,CAAC,EAAE;gBAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,+CAA+C,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACzH,WAAW,GAAG,QAAQ,CAAC;QACzB,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;QACrG,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,2BAA2B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;QACvG,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,CAAC;IACtD,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAsB;IACvD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC;IACtC,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;IACpF,IAAI,CAAC,QAAQ,CAAC,EAAE;QAAE,OAAO,QAAQ,CAAC;IAClC,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC;IAC9E,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,qBAAqB,CAAC;IACjE,IAAI,QAAQ,GAAG,WAAW,EAAE,CAAC;QAC3B,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,4BAA4B,QAAQ,CAAC,KAAK,CAAC,GAAG,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,qBAAqB,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;IACtJ,CAAC;IACD,MAAM,SAAS,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;IACvF,IAAI,IAAgC,CAAC;IACrC,IAAI,CAAC;QACH,IAAI,GAAG,MAAM,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC5D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,SAAS,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAChD,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,kBAAkB,QAAQ,CAAC,KAAK,CAAC,GAAG,wBAAwB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;IACvJ,CAAC;IACD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,wBAAwB,EAAE,CAAC;IAChE,MAAM,cAAc,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACjD,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC;YAClC,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,QAAQ;YACR,KAAK,EAAE,CAAC,YAAY,EAAE,UAAU,CAAC;YACjC,IAAI;YACJ,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,GAAG,EAAE,OAAO,CAAC,GAAG;SACjB,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,sBAAsB,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC;QAC/G,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC;QACvF,IAAI,CAAC,OAAO,CAAC,EAAE;YAAE,OAAO,OAAO,CAAC;QAChC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;IACtF,CAAC;YAAS,CAAC;QACT,MAAM,YAAY,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;AACH,CAAC"}
|
package/dist/schema.d.ts
ADDED
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
import type { BackupObject } from "./contract.js";
|
|
2
|
+
export declare const backupSchema: import("drizzle-orm/pg-core").PgSchema<"backup">;
|
|
3
|
+
export declare const runs: import("drizzle-orm/pg-core").PgTableWithColumns<{
|
|
4
|
+
name: "runs";
|
|
5
|
+
schema: "backup";
|
|
6
|
+
columns: {
|
|
7
|
+
id: import("drizzle-orm/pg-core").PgColumn<{
|
|
8
|
+
name: "id";
|
|
9
|
+
tableName: "runs";
|
|
10
|
+
dataType: "number";
|
|
11
|
+
columnType: "PgBigInt53";
|
|
12
|
+
data: number;
|
|
13
|
+
driverParam: string | number;
|
|
14
|
+
notNull: true;
|
|
15
|
+
hasDefault: false;
|
|
16
|
+
isPrimaryKey: true;
|
|
17
|
+
isAutoincrement: false;
|
|
18
|
+
hasRuntimeDefault: false;
|
|
19
|
+
enumValues: undefined;
|
|
20
|
+
baseColumn: never;
|
|
21
|
+
identity: undefined;
|
|
22
|
+
generated: undefined;
|
|
23
|
+
}, {}, {}>;
|
|
24
|
+
startedAt: import("drizzle-orm/pg-core").PgColumn<{
|
|
25
|
+
name: "started_at";
|
|
26
|
+
tableName: "runs";
|
|
27
|
+
dataType: "date";
|
|
28
|
+
columnType: "PgTimestamp";
|
|
29
|
+
data: Date;
|
|
30
|
+
driverParam: string;
|
|
31
|
+
notNull: true;
|
|
32
|
+
hasDefault: false;
|
|
33
|
+
isPrimaryKey: false;
|
|
34
|
+
isAutoincrement: false;
|
|
35
|
+
hasRuntimeDefault: false;
|
|
36
|
+
enumValues: undefined;
|
|
37
|
+
baseColumn: never;
|
|
38
|
+
identity: undefined;
|
|
39
|
+
generated: undefined;
|
|
40
|
+
}, {}, {}>;
|
|
41
|
+
finishedAt: import("drizzle-orm/pg-core").PgColumn<{
|
|
42
|
+
name: "finished_at";
|
|
43
|
+
tableName: "runs";
|
|
44
|
+
dataType: "date";
|
|
45
|
+
columnType: "PgTimestamp";
|
|
46
|
+
data: Date;
|
|
47
|
+
driverParam: string;
|
|
48
|
+
notNull: true;
|
|
49
|
+
hasDefault: false;
|
|
50
|
+
isPrimaryKey: false;
|
|
51
|
+
isAutoincrement: false;
|
|
52
|
+
hasRuntimeDefault: false;
|
|
53
|
+
enumValues: undefined;
|
|
54
|
+
baseColumn: never;
|
|
55
|
+
identity: undefined;
|
|
56
|
+
generated: undefined;
|
|
57
|
+
}, {}, {}>;
|
|
58
|
+
result: import("drizzle-orm/pg-core").PgColumn<{
|
|
59
|
+
name: "result";
|
|
60
|
+
tableName: "runs";
|
|
61
|
+
dataType: "string";
|
|
62
|
+
columnType: "PgText";
|
|
63
|
+
data: "ok" | "failed" | "not_configured";
|
|
64
|
+
driverParam: string;
|
|
65
|
+
notNull: true;
|
|
66
|
+
hasDefault: false;
|
|
67
|
+
isPrimaryKey: false;
|
|
68
|
+
isAutoincrement: false;
|
|
69
|
+
hasRuntimeDefault: false;
|
|
70
|
+
enumValues: [string, ...string[]];
|
|
71
|
+
baseColumn: never;
|
|
72
|
+
identity: undefined;
|
|
73
|
+
generated: undefined;
|
|
74
|
+
}, {}, {
|
|
75
|
+
$type: "ok" | "failed" | "not_configured";
|
|
76
|
+
}>;
|
|
77
|
+
objects: import("drizzle-orm/pg-core").PgColumn<{
|
|
78
|
+
name: "objects";
|
|
79
|
+
tableName: "runs";
|
|
80
|
+
dataType: "json";
|
|
81
|
+
columnType: "PgJsonb";
|
|
82
|
+
data: BackupObject[];
|
|
83
|
+
driverParam: unknown;
|
|
84
|
+
notNull: true;
|
|
85
|
+
hasDefault: false;
|
|
86
|
+
isPrimaryKey: false;
|
|
87
|
+
isAutoincrement: false;
|
|
88
|
+
hasRuntimeDefault: false;
|
|
89
|
+
enumValues: undefined;
|
|
90
|
+
baseColumn: never;
|
|
91
|
+
identity: undefined;
|
|
92
|
+
generated: undefined;
|
|
93
|
+
}, {}, {
|
|
94
|
+
$type: BackupObject[];
|
|
95
|
+
}>;
|
|
96
|
+
sizeBytes: import("drizzle-orm/pg-core").PgColumn<{
|
|
97
|
+
name: "size_bytes";
|
|
98
|
+
tableName: "runs";
|
|
99
|
+
dataType: "number";
|
|
100
|
+
columnType: "PgBigInt53";
|
|
101
|
+
data: number;
|
|
102
|
+
driverParam: string | number;
|
|
103
|
+
notNull: true;
|
|
104
|
+
hasDefault: false;
|
|
105
|
+
isPrimaryKey: false;
|
|
106
|
+
isAutoincrement: false;
|
|
107
|
+
hasRuntimeDefault: false;
|
|
108
|
+
enumValues: undefined;
|
|
109
|
+
baseColumn: never;
|
|
110
|
+
identity: undefined;
|
|
111
|
+
generated: undefined;
|
|
112
|
+
}, {}, {}>;
|
|
113
|
+
errorCode: import("drizzle-orm/pg-core").PgColumn<{
|
|
114
|
+
name: "error_code";
|
|
115
|
+
tableName: "runs";
|
|
116
|
+
dataType: "string";
|
|
117
|
+
columnType: "PgText";
|
|
118
|
+
data: string;
|
|
119
|
+
driverParam: string;
|
|
120
|
+
notNull: false;
|
|
121
|
+
hasDefault: false;
|
|
122
|
+
isPrimaryKey: false;
|
|
123
|
+
isAutoincrement: false;
|
|
124
|
+
hasRuntimeDefault: false;
|
|
125
|
+
enumValues: [string, ...string[]];
|
|
126
|
+
baseColumn: never;
|
|
127
|
+
identity: undefined;
|
|
128
|
+
generated: undefined;
|
|
129
|
+
}, {}, {}>;
|
|
130
|
+
errorMessage: import("drizzle-orm/pg-core").PgColumn<{
|
|
131
|
+
name: "error_message";
|
|
132
|
+
tableName: "runs";
|
|
133
|
+
dataType: "string";
|
|
134
|
+
columnType: "PgText";
|
|
135
|
+
data: string;
|
|
136
|
+
driverParam: string;
|
|
137
|
+
notNull: false;
|
|
138
|
+
hasDefault: false;
|
|
139
|
+
isPrimaryKey: false;
|
|
140
|
+
isAutoincrement: false;
|
|
141
|
+
hasRuntimeDefault: false;
|
|
142
|
+
enumValues: [string, ...string[]];
|
|
143
|
+
baseColumn: never;
|
|
144
|
+
identity: undefined;
|
|
145
|
+
generated: undefined;
|
|
146
|
+
}, {}, {}>;
|
|
147
|
+
};
|
|
148
|
+
dialect: "pg";
|
|
149
|
+
}>;
|
|
150
|
+
//# sourceMappingURL=schema.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAgB,MAAM,eAAe,CAAC;AAEhE,eAAO,MAAM,YAAY,kDAAqB,CAAC;AAE/C,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASf,CAAC"}
|
package/dist/schema.js
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
// Drizzle view of the module's table (migrations/0001_create_runs.sql). The migration is the source of truth; this
|
|
2
|
+
// file only types the queries.
|
|
3
|
+
import { bigint, jsonb, pgSchema, text, timestamp } from "drizzle-orm/pg-core";
|
|
4
|
+
export const backupSchema = pgSchema("backup");
|
|
5
|
+
export const runs = backupSchema.table("runs", {
|
|
6
|
+
id: bigint("id", { mode: "number" }).primaryKey(),
|
|
7
|
+
startedAt: timestamp("started_at", { withTimezone: true }).notNull(),
|
|
8
|
+
finishedAt: timestamp("finished_at", { withTimezone: true }).notNull(),
|
|
9
|
+
result: text("result").$type().notNull(),
|
|
10
|
+
objects: jsonb("objects").$type().notNull(),
|
|
11
|
+
sizeBytes: bigint("size_bytes", { mode: "number" }).notNull(),
|
|
12
|
+
errorCode: text("error_code"),
|
|
13
|
+
errorMessage: text("error_message"),
|
|
14
|
+
});
|
|
15
|
+
//# sourceMappingURL=schema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,mHAAmH;AACnH,+BAA+B;AAC/B,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAG/E,MAAM,CAAC,MAAM,YAAY,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAE/C,MAAM,CAAC,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE;IAC7C,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,UAAU,EAAE;IACjD,SAAS,EAAE,SAAS,CAAC,YAAY,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE;IACpE,UAAU,EAAE,SAAS,CAAC,aAAa,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE;IACtE,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAgB,CAAC,OAAO,EAAE;IACtD,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,KAAK,EAAkB,CAAC,OAAO,EAAE;IAC3D,SAAS,EAAE,MAAM,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IAC7D,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC;IAC7B,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC;CACpC,CAAC,CAAC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { type Meter } from "@opentelemetry/api";
|
|
2
|
+
import { type HealthCheck } from "@softure-ai/core";
|
|
3
|
+
import type { Queryable } from "@softure-ai/db";
|
|
4
|
+
import type { BackupRun, BackupStatus } from "../contract.js";
|
|
5
|
+
/** The newest runs, newest first: `limit` from 1 to 100 (default 10). */
|
|
6
|
+
export declare function listBackupRuns(db: Queryable, options?: {
|
|
7
|
+
limit?: number;
|
|
8
|
+
}): Promise<BackupRun[]>;
|
|
9
|
+
/** The status for a settings screen: the newest run and the newest successful one. */
|
|
10
|
+
export declare function getLastBackup(db: Queryable): Promise<BackupStatus>;
|
|
11
|
+
/** Seconds since the newest successful run finished; null when none ever succeeded. */
|
|
12
|
+
export declare function getLastSuccessAgeSeconds(status: BackupStatus, now: Date): number | null;
|
|
13
|
+
export interface BackupMetricsOptions {
|
|
14
|
+
readonly db: Queryable;
|
|
15
|
+
/** The meter to register on; `metrics.getMeter("@softure-ai/backup")` by default. */
|
|
16
|
+
readonly meter?: Meter;
|
|
17
|
+
readonly now?: () => Date;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Observable gauges over the newest runs, exported with the app's metrics (`startObservability`):
|
|
21
|
+
* `softure.backup.last_success.age` (s, absent until a run succeeded; alert when above 93600, i.e. 26 h),
|
|
22
|
+
* `softure.backup.last_run.ok` (1 or 0), `softure.backup.last_run.size` (By), `softure.backup.last_run.duration` (s).
|
|
23
|
+
* Nothing is reported while no run is recorded. Returns a function that unregisters them.
|
|
24
|
+
*/
|
|
25
|
+
export declare function registerBackupMetrics(options: BackupMetricsOptions): () => void;
|
|
26
|
+
/** For `GET /api/health` of `@softure-ai/ops`: the runs table exists and answers, i.e. `softure migrate` ran. */
|
|
27
|
+
export declare const checkRunsTable: HealthCheck;
|
|
28
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/server/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAW,KAAK,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAM,KAAK,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAqB9D,yEAAyE;AACzE,wBAAsB,cAAc,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,GAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAAO,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAI1G;AAED,sFAAsF;AACtF,wBAAsB,aAAa,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO,CAAC,YAAY,CAAC,CAOxE;AAED,uFAAuF;AACvF,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAGvF;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC;IACvB,qFAAqF;IACrF,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACvB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,IAAI,CAAC;CAC3B;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,oBAAoB,GAAG,MAAM,IAAI,CAoC/E;AAED,iHAAiH;AACjH,eAAO,MAAM,cAAc,EAAE,WAK5B,CAAC"}
|