velocious 1.0.482 → 1.0.484
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/README.md +2 -0
- package/build/cli/commands/db/tenants/drop.js +34 -0
- package/build/cli/tenant-database-command-helper.js +8 -85
- package/build/database/tenants/data-copier.js +269 -0
- package/build/database/tenants/tenant-table-plan.js +20 -0
- package/build/src/cli/commands/db/tenants/drop.d.ts +13 -0
- package/build/src/cli/commands/db/tenants/drop.d.ts.map +1 -0
- package/build/src/cli/commands/db/tenants/drop.js +31 -0
- package/build/src/cli/tenant-database-command-helper.d.ts +0 -20
- package/build/src/cli/tenant-database-command-helper.d.ts.map +1 -1
- package/build/src/cli/tenant-database-command-helper.js +8 -73
- package/build/src/database/tenants/data-copier.d.ts +125 -0
- package/build/src/database/tenants/data-copier.d.ts.map +1 -0
- package/build/src/database/tenants/data-copier.js +232 -0
- package/build/src/database/tenants/tenant-table-plan.d.ts +30 -0
- package/build/src/database/tenants/tenant-table-plan.d.ts.map +1 -0
- package/build/src/database/tenants/tenant-table-plan.js +3 -0
- package/build/src/tenants/tenant-iterator.d.ts +52 -0
- package/build/src/tenants/tenant-iterator.d.ts.map +1 -0
- package/build/src/tenants/tenant-iterator.js +97 -0
- package/build/src/tenants/tenant.d.ts +61 -0
- package/build/src/tenants/tenant.d.ts.map +1 -0
- package/build/src/tenants/tenant.js +93 -0
- package/build/tenants/tenant-iterator.js +111 -0
- package/build/tenants/tenant.js +104 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/cli/commands/db/tenants/drop.js +34 -0
- package/src/cli/tenant-database-command-helper.js +8 -85
- package/src/database/tenants/data-copier.js +269 -0
- package/src/database/tenants/tenant-table-plan.js +20 -0
- package/src/tenants/tenant-iterator.js +111 -0
- package/src/tenants/tenant.js +104 -0
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Runs a callback once within each tenant's context for a tenant database identifier,
|
|
3
|
+
* optionally several tenants at a time. Each tenant is entered with `runWithTenant`, and a
|
|
4
|
+
* tenant whose database identifier is inactive throws rather than running the callback
|
|
5
|
+
* against the wrong connection. When iterating in parallel the per-tenant failures are
|
|
6
|
+
* collected and rethrown together as an `AggregateError` so one bad tenant does not hide the
|
|
7
|
+
* others. This is the iteration engine shared by the `db:tenants:*` CLI commands and the
|
|
8
|
+
* runtime {@link Tenant} façade; the caller is responsible for producing the tenant list.
|
|
9
|
+
*/
|
|
10
|
+
export default class TenantIterator {
|
|
11
|
+
/**
|
|
12
|
+
* Builds a human-readable label for a tenant for use in error messages.
|
|
13
|
+
* @param {?} tenant
|
|
14
|
+
* @returns {string}
|
|
15
|
+
*/
|
|
16
|
+
static tenantLabel(tenant: unknown): string;
|
|
17
|
+
/**
|
|
18
|
+
* Creates an iterator bound to a configuration and tenant database identifier.
|
|
19
|
+
* @param {{configuration: import("../configuration.js").default, identifier: string, parallelCount?: number}} args
|
|
20
|
+
*/
|
|
21
|
+
constructor({ configuration, identifier, parallelCount }: {
|
|
22
|
+
configuration: import("../configuration.js").default;
|
|
23
|
+
identifier: string;
|
|
24
|
+
parallelCount?: number;
|
|
25
|
+
});
|
|
26
|
+
configuration: import("../configuration.js").default;
|
|
27
|
+
identifier: string;
|
|
28
|
+
parallelCount: number;
|
|
29
|
+
/**
|
|
30
|
+
* Runs `callback` within each tenant's context and returns how many tenants were processed.
|
|
31
|
+
* @param {Array<?>} tenants
|
|
32
|
+
* @param {function({databaseConfiguration: import("../configuration-types.js").DatabaseConfigurationType, tenant: ?}) : Promise<void>} callback
|
|
33
|
+
* @returns {Promise<number>}
|
|
34
|
+
*/
|
|
35
|
+
run(tenants: Array<unknown>, callback: (arg0: {
|
|
36
|
+
databaseConfiguration: import("../configuration-types.js").DatabaseConfigurationType;
|
|
37
|
+
tenant: unknown;
|
|
38
|
+
}) => Promise<void>): Promise<number>;
|
|
39
|
+
/**
|
|
40
|
+
* Enters one tenant's context and runs the callback, asserting the database is active first.
|
|
41
|
+
* @param {{callback: function({databaseConfiguration: import("../configuration-types.js").DatabaseConfigurationType, tenant: ?}) : Promise<void>, tenant: ?}} args
|
|
42
|
+
* @returns {Promise<void>}
|
|
43
|
+
*/
|
|
44
|
+
runTenantCallback({ callback, tenant }: {
|
|
45
|
+
callback: (arg0: {
|
|
46
|
+
databaseConfiguration: import("../configuration-types.js").DatabaseConfigurationType;
|
|
47
|
+
tenant: unknown;
|
|
48
|
+
}) => Promise<void>;
|
|
49
|
+
tenant: unknown;
|
|
50
|
+
}): Promise<void>;
|
|
51
|
+
}
|
|
52
|
+
//# sourceMappingURL=tenant-iterator.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tenant-iterator.d.ts","sourceRoot":"","sources":["../../../src/tenants/tenant-iterator.js"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH;IAmFE;;;;OAIG;IACH,2BAHW,OAAC,GACC,MAAM,CAYlB;IAjGD;;;OAGG;IACH,0DAFW;QAAC,aAAa,EAAE,OAAO,qBAAqB,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAC,EAM5G;IAHC,qDAAkC;IAClC,mBAA4B;IAC5B,sBAAkC;IAGpC;;;;;OAKG;IACH,aAJW,KAAK,CAAC,OAAC,CAAC,YACR,CAAS,IAAiG,EAAjG;QAAC,qBAAqB,EAAE,OAAO,2BAA2B,EAAE,yBAAyB,CAAC;QAAC,MAAM,EAAE,OAAC,CAAA;KAAC,KAAI,OAAO,CAAC,IAAI,CAAC,GACzH,OAAO,CAAC,MAAM,CAAC,CAgD3B;IAED;;;;OAIG;IACH,wCAHW;QAAC,QAAQ,EAAE,CAAS,IAAiG,EAAjG;YAAC,qBAAqB,EAAE,OAAO,2BAA2B,EAAE,yBAAyB,CAAC;YAAC,MAAM,EAAE,OAAC,CAAA;SAAC,KAAI,OAAO,CAAC,IAAI,CAAC,CAAC;QAAC,MAAM,EAAE,OAAC,CAAA;KAAC,GAChJ,OAAO,CAAC,IAAI,CAAC,CAazB;CAkBF"}
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
// @ts-check
|
|
2
|
+
/**
|
|
3
|
+
* Runs a callback once within each tenant's context for a tenant database identifier,
|
|
4
|
+
* optionally several tenants at a time. Each tenant is entered with `runWithTenant`, and a
|
|
5
|
+
* tenant whose database identifier is inactive throws rather than running the callback
|
|
6
|
+
* against the wrong connection. When iterating in parallel the per-tenant failures are
|
|
7
|
+
* collected and rethrown together as an `AggregateError` so one bad tenant does not hide the
|
|
8
|
+
* others. This is the iteration engine shared by the `db:tenants:*` CLI commands and the
|
|
9
|
+
* runtime {@link Tenant} façade; the caller is responsible for producing the tenant list.
|
|
10
|
+
*/
|
|
11
|
+
export default class TenantIterator {
|
|
12
|
+
/**
|
|
13
|
+
* Creates an iterator bound to a configuration and tenant database identifier.
|
|
14
|
+
* @param {{configuration: import("../configuration.js").default, identifier: string, parallelCount?: number}} args
|
|
15
|
+
*/
|
|
16
|
+
constructor({ configuration, identifier, parallelCount = 1 }) {
|
|
17
|
+
this.configuration = configuration;
|
|
18
|
+
this.identifier = identifier;
|
|
19
|
+
this.parallelCount = parallelCount;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Runs `callback` within each tenant's context and returns how many tenants were processed.
|
|
23
|
+
* @param {Array<?>} tenants
|
|
24
|
+
* @param {function({databaseConfiguration: import("../configuration-types.js").DatabaseConfigurationType, tenant: ?}) : Promise<void>} callback
|
|
25
|
+
* @returns {Promise<number>}
|
|
26
|
+
*/
|
|
27
|
+
async run(tenants, callback) {
|
|
28
|
+
if (this.parallelCount <= 1) {
|
|
29
|
+
for (const tenant of tenants) {
|
|
30
|
+
await this.runTenantCallback({ callback, tenant });
|
|
31
|
+
}
|
|
32
|
+
return tenants.length;
|
|
33
|
+
}
|
|
34
|
+
/** @type {Array<{error: Error, tenant: ?}>} */
|
|
35
|
+
const failures = [];
|
|
36
|
+
const workers = [];
|
|
37
|
+
let tenantIndex = 0;
|
|
38
|
+
const workerCount = Math.min(this.parallelCount, tenants.length);
|
|
39
|
+
for (let workerIndex = 0; workerIndex < workerCount; workerIndex++) {
|
|
40
|
+
workers.push((async () => {
|
|
41
|
+
while (tenantIndex < tenants.length) {
|
|
42
|
+
const tenant = tenants[tenantIndex];
|
|
43
|
+
tenantIndex++;
|
|
44
|
+
try {
|
|
45
|
+
await this.runTenantCallback({ callback, tenant });
|
|
46
|
+
}
|
|
47
|
+
catch (error) {
|
|
48
|
+
failures.push({
|
|
49
|
+
error: error instanceof Error ? error : new Error(String(error)),
|
|
50
|
+
tenant
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
})());
|
|
55
|
+
}
|
|
56
|
+
await Promise.all(workers);
|
|
57
|
+
if (failures.length > 0) {
|
|
58
|
+
const failedTenantLabels = failures.map((failure) => TenantIterator.tenantLabel(failure.tenant)).join(", ");
|
|
59
|
+
throw new AggregateError(failures.map((failure) => failure.error), `Failed tenant database command for tenant(s): ${failedTenantLabels}`);
|
|
60
|
+
}
|
|
61
|
+
return tenants.length;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Enters one tenant's context and runs the callback, asserting the database is active first.
|
|
65
|
+
* @param {{callback: function({databaseConfiguration: import("../configuration-types.js").DatabaseConfigurationType, tenant: ?}) : Promise<void>, tenant: ?}} args
|
|
66
|
+
* @returns {Promise<void>}
|
|
67
|
+
*/
|
|
68
|
+
async runTenantCallback({ callback, tenant }) {
|
|
69
|
+
await this.configuration.runWithTenant(tenant, async () => {
|
|
70
|
+
if (!this.configuration.isDatabaseIdentifierActive(this.identifier)) {
|
|
71
|
+
throw new Error(`Tenant database identifier ${this.identifier} is inactive for tenant: ${TenantIterator.tenantLabel(tenant)}`);
|
|
72
|
+
}
|
|
73
|
+
await callback({
|
|
74
|
+
databaseConfiguration: this.configuration.resolveDatabaseConfiguration(this.identifier),
|
|
75
|
+
tenant
|
|
76
|
+
});
|
|
77
|
+
});
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Builds a human-readable label for a tenant for use in error messages.
|
|
81
|
+
* @param {?} tenant
|
|
82
|
+
* @returns {string}
|
|
83
|
+
*/
|
|
84
|
+
static tenantLabel(tenant) {
|
|
85
|
+
if (tenant && typeof tenant === "object") {
|
|
86
|
+
const tenantObject = /** @type {{id?: ?, name?: ?, slug?: ?}} */ (tenant);
|
|
87
|
+
if (tenantObject.slug)
|
|
88
|
+
return String(tenantObject.slug);
|
|
89
|
+
if (tenantObject.name)
|
|
90
|
+
return String(tenantObject.name);
|
|
91
|
+
if (tenantObject.id)
|
|
92
|
+
return String(tenantObject.id);
|
|
93
|
+
}
|
|
94
|
+
return JSON.stringify(tenant);
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"tenant-iterator.js","sourceRoot":"","sources":["../../../src/tenants/tenant-iterator.js"],"names":[],"mappings":"AAAA,YAAY;AAEZ;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC;;;OAGG;IACH,YAAY,EAAC,aAAa,EAAE,UAAU,EAAE,aAAa,GAAG,CAAC,EAAC;QACxD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;IACpC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ;QACzB,IAAI,IAAI,CAAC,aAAa,IAAI,CAAC,EAAE,CAAC;YAC5B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,MAAM,IAAI,CAAC,iBAAiB,CAAC,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAA;YAClD,CAAC;YAED,OAAO,OAAO,CAAC,MAAM,CAAA;QACvB,CAAC;QAED,+CAA+C;QAC/C,MAAM,QAAQ,GAAG,EAAE,CAAA;QACnB,MAAM,OAAO,GAAG,EAAE,CAAA;QAClB,IAAI,WAAW,GAAG,CAAC,CAAA;QACnB,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;QAEhE,KAAK,IAAI,WAAW,GAAG,CAAC,EAAE,WAAW,GAAG,WAAW,EAAE,WAAW,EAAE,EAAE,CAAC;YACnE,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,EAAE;gBACvB,OAAO,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;oBACpC,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;oBAEnC,WAAW,EAAE,CAAA;oBAEb,IAAI,CAAC;wBACH,MAAM,IAAI,CAAC,iBAAiB,CAAC,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAA;oBAClD,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,QAAQ,CAAC,IAAI,CAAC;4BACZ,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;4BAChE,MAAM;yBACP,CAAC,CAAA;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC,CAAC,EAAE,CAAC,CAAA;QACP,CAAC;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QAE1B,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,kBAAkB,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAE3G,MAAM,IAAI,cAAc,CACtB,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,EACxC,iDAAiD,kBAAkB,EAAE,CACtE,CAAA;QACH,CAAC;QAED,OAAO,OAAO,CAAC,MAAM,CAAA;IACvB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,iBAAiB,CAAC,EAAC,QAAQ,EAAE,MAAM,EAAC;QACxC,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE;YACxD,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,0BAA0B,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBACpE,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,CAAC,UAAU,4BAA4B,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YAChI,CAAC;YAED,MAAM,QAAQ,CAAC;gBACb,qBAAqB,EAAE,IAAI,CAAC,aAAa,CAAC,4BAA4B,CAAC,IAAI,CAAC,UAAU,CAAC;gBACvF,MAAM;aACP,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,MAAM;QACvB,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YACzC,MAAM,YAAY,GAAG,2CAA2C,CAAC,CAAC,MAAM,CAAC,CAAA;YAEzE,IAAI,YAAY,CAAC,IAAI;gBAAE,OAAO,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;YACvD,IAAI,YAAY,CAAC,IAAI;gBAAE,OAAO,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;YACvD,IAAI,YAAY,CAAC,EAAE;gBAAE,OAAO,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;QACrD,CAAC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IAC/B,CAAC;CACF","sourcesContent":["// @ts-check\n\n/**\n * Runs a callback once within each tenant's context for a tenant database identifier,\n * optionally several tenants at a time. Each tenant is entered with `runWithTenant`, and a\n * tenant whose database identifier is inactive throws rather than running the callback\n * against the wrong connection. When iterating in parallel the per-tenant failures are\n * collected and rethrown together as an `AggregateError` so one bad tenant does not hide the\n * others. This is the iteration engine shared by the `db:tenants:*` CLI commands and the\n * runtime {@link Tenant} façade; the caller is responsible for producing the tenant list.\n */\nexport default class TenantIterator {\n  /**\n   * Creates an iterator bound to a configuration and tenant database identifier.\n   * @param {{configuration: import(\"../configuration.js\").default, identifier: string, parallelCount?: number}} args\n   */\n  constructor({configuration, identifier, parallelCount = 1}) {\n    this.configuration = configuration\n    this.identifier = identifier\n    this.parallelCount = parallelCount\n  }\n\n  /**\n   * Runs `callback` within each tenant's context and returns how many tenants were processed.\n   * @param {Array<?>} tenants\n   * @param {function({databaseConfiguration: import(\"../configuration-types.js\").DatabaseConfigurationType, tenant: ?}) : Promise<void>} callback\n   * @returns {Promise<number>}\n   */\n  async run(tenants, callback) {\n    if (this.parallelCount <= 1) {\n      for (const tenant of tenants) {\n        await this.runTenantCallback({callback, tenant})\n      }\n\n      return tenants.length\n    }\n\n    /** @type {Array<{error: Error, tenant: ?}>} */\n    const failures = []\n    const workers = []\n    let tenantIndex = 0\n    const workerCount = Math.min(this.parallelCount, tenants.length)\n\n    for (let workerIndex = 0; workerIndex < workerCount; workerIndex++) {\n      workers.push((async () => {\n        while (tenantIndex < tenants.length) {\n          const tenant = tenants[tenantIndex]\n\n          tenantIndex++\n\n          try {\n            await this.runTenantCallback({callback, tenant})\n          } catch (error) {\n            failures.push({\n              error: error instanceof Error ? error : new Error(String(error)),\n              tenant\n            })\n          }\n        }\n      })())\n    }\n\n    await Promise.all(workers)\n\n    if (failures.length > 0) {\n      const failedTenantLabels = failures.map((failure) => TenantIterator.tenantLabel(failure.tenant)).join(\", \")\n\n      throw new AggregateError(\n        failures.map((failure) => failure.error),\n        `Failed tenant database command for tenant(s): ${failedTenantLabels}`\n      )\n    }\n\n    return tenants.length\n  }\n\n  /**\n   * Enters one tenant's context and runs the callback, asserting the database is active first.\n   * @param {{callback: function({databaseConfiguration: import(\"../configuration-types.js\").DatabaseConfigurationType, tenant: ?}) : Promise<void>, tenant: ?}} args\n   * @returns {Promise<void>}\n   */\n  async runTenantCallback({callback, tenant}) {\n    await this.configuration.runWithTenant(tenant, async () => {\n      if (!this.configuration.isDatabaseIdentifierActive(this.identifier)) {\n        throw new Error(`Tenant database identifier ${this.identifier} is inactive for tenant: ${TenantIterator.tenantLabel(tenant)}`)\n      }\n\n      await callback({\n        databaseConfiguration: this.configuration.resolveDatabaseConfiguration(this.identifier),\n        tenant\n      })\n    })\n  }\n\n  /**\n   * Builds a human-readable label for a tenant for use in error messages.\n   * @param {?} tenant\n   * @returns {string}\n   */\n  static tenantLabel(tenant) {\n    if (tenant && typeof tenant === \"object\") {\n      const tenantObject = /** @type {{id?: ?, name?: ?, slug?: ?}} */ (tenant)\n\n      if (tenantObject.slug) return String(tenantObject.slug)\n      if (tenantObject.name) return String(tenantObject.name)\n      if (tenantObject.id) return String(tenantObject.id)\n    }\n\n    return JSON.stringify(tenant)\n  }\n}\n"]}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Apartment-style runtime façade for multi-tenant apps. A "tenant" is whatever descriptor
|
|
3
|
+
* object the app's `tenantDatabaseResolver` understands (an account, a project, …); this
|
|
4
|
+
* class is the single discoverable home for switching into a tenant's context, reading the
|
|
5
|
+
* current one, iterating every tenant of a database identifier, and dropping a tenant's
|
|
6
|
+
* database. Switching delegates to {@link Current} (which owns the async-context tenant
|
|
7
|
+
* state) and additionally runs the callback inside `ensureConnections`, so entering a tenant
|
|
8
|
+
* makes its database immediately queryable — the apartment-style "switch" semantics — without
|
|
9
|
+
* the caller establishing connections itself; iteration and drop drive the app's tenant
|
|
10
|
+
* database provider hooks.
|
|
11
|
+
*/
|
|
12
|
+
export default class Tenant {
|
|
13
|
+
/**
|
|
14
|
+
* Runs `callback` with `tenant` as the current tenant, restoring the previous tenant after.
|
|
15
|
+
* The callback runs inside `ensureConnections`, so every database identifier the tenant
|
|
16
|
+
* activates (the global database plus the tenant's database) has a checked-out connection
|
|
17
|
+
* available for the callback's duration: switching into a tenant makes it queryable without
|
|
18
|
+
* the caller wiring up connections. Already-checked-out connections are reused, so nesting
|
|
19
|
+
* `Tenant.with` calls does not open redundant connections. The callback receives the active
|
|
20
|
+
* connections keyed by identifier, the same as `ensureConnections`.
|
|
21
|
+
* @param {object} tenant Descriptor understood by the app's tenantDatabaseResolver.
|
|
22
|
+
* @param {(connections: Record<string, import("../database/drivers/base.js").default>) => Promise<?>} callback
|
|
23
|
+
* @returns {Promise<?>}
|
|
24
|
+
*/
|
|
25
|
+
static with(tenant: object, callback: (connections: Record<string, import("../database/drivers/base.js").default>) => Promise<unknown>): Promise<unknown>;
|
|
26
|
+
/**
|
|
27
|
+
* The current tenant descriptor, or undefined when running outside any tenant context.
|
|
28
|
+
* @returns {Record<string, unknown> | undefined}
|
|
29
|
+
*/
|
|
30
|
+
static current(): Record<string, unknown> | undefined;
|
|
31
|
+
/**
|
|
32
|
+
* Lists the tenants for a database identifier through the provider and runs `callback`
|
|
33
|
+
* within each tenant's context, optionally filtered and several at a time. Like
|
|
34
|
+
* {@link Tenant.with}, the callback runs inside `ensureConnections` so each tenant's
|
|
35
|
+
* database is queryable without the caller wiring up connections. Returns how many tenants
|
|
36
|
+
* the callback ran for (after filtering).
|
|
37
|
+
* @param {{identifier: string, callback: function({databaseConfiguration: import("../configuration-types.js").DatabaseConfigurationType, tenant: ?}) : Promise<void>, parallel?: number, filter?: (tenant: ?) => boolean, configuration?: import("../configuration.js").default}} args
|
|
38
|
+
* @returns {Promise<number>}
|
|
39
|
+
*/
|
|
40
|
+
static each({ identifier, callback, parallel, filter, configuration }: {
|
|
41
|
+
identifier: string;
|
|
42
|
+
callback: (arg0: {
|
|
43
|
+
databaseConfiguration: import("../configuration-types.js").DatabaseConfigurationType;
|
|
44
|
+
tenant: unknown;
|
|
45
|
+
}) => Promise<void>;
|
|
46
|
+
parallel?: number;
|
|
47
|
+
filter?: (tenant: unknown) => boolean;
|
|
48
|
+
configuration?: import("../configuration.js").default;
|
|
49
|
+
}): Promise<number>;
|
|
50
|
+
/**
|
|
51
|
+
* Drops one tenant's database/schema through the provider's `dropDatabase` hook.
|
|
52
|
+
* @param {{identifier: string, tenant: object, configuration?: import("../configuration.js").default}} args
|
|
53
|
+
* @returns {Promise<void>}
|
|
54
|
+
*/
|
|
55
|
+
static drop({ identifier, tenant, configuration }: {
|
|
56
|
+
identifier: string;
|
|
57
|
+
tenant: object;
|
|
58
|
+
configuration?: import("../configuration.js").default;
|
|
59
|
+
}): Promise<void>;
|
|
60
|
+
}
|
|
61
|
+
//# sourceMappingURL=tenant.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tenant.d.ts","sourceRoot":"","sources":["../../../src/tenants/tenant.js"],"names":[],"mappings":"AAKA;;;;;;;;;;GAUG;AACH;IACE;;;;;;;;;;;OAWG;IACH,oBAJW,MAAM,YACN,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,6BAA6B,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,OAAC,CAAC,GACxF,OAAO,CAAC,OAAC,CAAC,CAMtB;IAED;;;OAGG;IACH,kBAFa,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAI/C;IAED;;;;;;;;OAQG;IACH,uEAHW;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,CAAS,IAAiG,EAAjG;YAAC,qBAAqB,EAAE,OAAO,2BAA2B,EAAE,yBAAyB,CAAC;YAAC,MAAM,EAAE,OAAC,CAAA;SAAC,KAAI,OAAO,CAAC,IAAI,CAAC,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,OAAC,KAAK,OAAO,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,qBAAqB,EAAE,OAAO,CAAA;KAAC,GACpQ,OAAO,CAAC,MAAM,CAAC,CAsB3B;IAED;;;;OAIG;IACH,mDAHW;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,qBAAqB,EAAE,OAAO,CAAA;KAAC,GACzF,OAAO,CAAC,IAAI,CAAC,CAyBzB;CACF"}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
// @ts-check
|
|
2
|
+
import Current from "../current.js";
|
|
3
|
+
import TenantIterator from "./tenant-iterator.js";
|
|
4
|
+
/**
|
|
5
|
+
* Apartment-style runtime façade for multi-tenant apps. A "tenant" is whatever descriptor
|
|
6
|
+
* object the app's `tenantDatabaseResolver` understands (an account, a project, …); this
|
|
7
|
+
* class is the single discoverable home for switching into a tenant's context, reading the
|
|
8
|
+
* current one, iterating every tenant of a database identifier, and dropping a tenant's
|
|
9
|
+
* database. Switching delegates to {@link Current} (which owns the async-context tenant
|
|
10
|
+
* state) and additionally runs the callback inside `ensureConnections`, so entering a tenant
|
|
11
|
+
* makes its database immediately queryable — the apartment-style "switch" semantics — without
|
|
12
|
+
* the caller establishing connections itself; iteration and drop drive the app's tenant
|
|
13
|
+
* database provider hooks.
|
|
14
|
+
*/
|
|
15
|
+
export default class Tenant {
|
|
16
|
+
/**
|
|
17
|
+
* Runs `callback` with `tenant` as the current tenant, restoring the previous tenant after.
|
|
18
|
+
* The callback runs inside `ensureConnections`, so every database identifier the tenant
|
|
19
|
+
* activates (the global database plus the tenant's database) has a checked-out connection
|
|
20
|
+
* available for the callback's duration: switching into a tenant makes it queryable without
|
|
21
|
+
* the caller wiring up connections. Already-checked-out connections are reused, so nesting
|
|
22
|
+
* `Tenant.with` calls does not open redundant connections. The callback receives the active
|
|
23
|
+
* connections keyed by identifier, the same as `ensureConnections`.
|
|
24
|
+
* @param {object} tenant Descriptor understood by the app's tenantDatabaseResolver.
|
|
25
|
+
* @param {(connections: Record<string, import("../database/drivers/base.js").default>) => Promise<?>} callback
|
|
26
|
+
* @returns {Promise<?>}
|
|
27
|
+
*/
|
|
28
|
+
static async with(tenant, callback) {
|
|
29
|
+
const configuration = Current.configuration();
|
|
30
|
+
return await Current.withTenant(tenant, async () => await configuration.ensureConnections(callback));
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* The current tenant descriptor, or undefined when running outside any tenant context.
|
|
34
|
+
* @returns {Record<string, unknown> | undefined}
|
|
35
|
+
*/
|
|
36
|
+
static current() {
|
|
37
|
+
return Current.tenant();
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Lists the tenants for a database identifier through the provider and runs `callback`
|
|
41
|
+
* within each tenant's context, optionally filtered and several at a time. Like
|
|
42
|
+
* {@link Tenant.with}, the callback runs inside `ensureConnections` so each tenant's
|
|
43
|
+
* database is queryable without the caller wiring up connections. Returns how many tenants
|
|
44
|
+
* the callback ran for (after filtering).
|
|
45
|
+
* @param {{identifier: string, callback: function({databaseConfiguration: import("../configuration-types.js").DatabaseConfigurationType, tenant: ?}) : Promise<void>, parallel?: number, filter?: (tenant: ?) => boolean, configuration?: import("../configuration.js").default}} args
|
|
46
|
+
* @returns {Promise<number>}
|
|
47
|
+
*/
|
|
48
|
+
static async each({ identifier, callback, parallel = 1, filter, configuration = Current.configuration() }) {
|
|
49
|
+
const provider = configuration.getTenantDatabaseProvider(identifier);
|
|
50
|
+
const listedTenants = await configuration.ensureConnections({ name: `Tenant.each: ${identifier}` }, async () => {
|
|
51
|
+
return await provider.listTenants({ configuration, identifier });
|
|
52
|
+
});
|
|
53
|
+
if (!Array.isArray(listedTenants)) {
|
|
54
|
+
throw new Error(`Tenant database provider for ${identifier} must return an array from listTenants`);
|
|
55
|
+
}
|
|
56
|
+
const tenants = filter ? listedTenants.filter(filter) : listedTenants;
|
|
57
|
+
const iterator = new TenantIterator({ configuration, identifier, parallelCount: parallel });
|
|
58
|
+
// Run each tenant's callback inside ensureConnections so the iterator stays
|
|
59
|
+
// connection-agnostic (the db:tenants:* CLI commands share TenantIterator and must run
|
|
60
|
+
// their callbacks, such as create, before the tenant database exists) while runtime
|
|
61
|
+
// iteration here gets the tenant's connections established the same way Tenant.with does.
|
|
62
|
+
return await iterator.run(tenants, async (callbackArgs) => {
|
|
63
|
+
await configuration.ensureConnections({ name: `Tenant.each: ${identifier}` }, async () => await callback(callbackArgs));
|
|
64
|
+
});
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Drops one tenant's database/schema through the provider's `dropDatabase` hook.
|
|
68
|
+
* @param {{identifier: string, tenant: object, configuration?: import("../configuration.js").default}} args
|
|
69
|
+
* @returns {Promise<void>}
|
|
70
|
+
*/
|
|
71
|
+
static async drop({ identifier, tenant, configuration = Current.configuration() }) {
|
|
72
|
+
const provider = configuration.getTenantDatabaseProvider(identifier);
|
|
73
|
+
if (typeof provider.dropDatabase !== "function") {
|
|
74
|
+
throw new Error(`Tenant database provider for ${identifier} must define dropDatabase to drop a tenant`);
|
|
75
|
+
}
|
|
76
|
+
await configuration.runWithTenant(tenant, async () => {
|
|
77
|
+
// Guard against an unresolved tenant. resolveDatabaseConfiguration falls back to the
|
|
78
|
+
// base (template/default) tenant database when the resolver returns nothing for this
|
|
79
|
+
// descriptor, so without this check a provider that drops by databaseConfiguration.name
|
|
80
|
+
// would drop the template database instead of rejecting the bad tenant.
|
|
81
|
+
if (!configuration.isDatabaseIdentifierActive(identifier)) {
|
|
82
|
+
throw new Error(`Tenant database identifier ${identifier} is inactive for tenant: ${TenantIterator.tenantLabel(tenant)}`);
|
|
83
|
+
}
|
|
84
|
+
await provider.dropDatabase?.({
|
|
85
|
+
configuration,
|
|
86
|
+
databaseConfiguration: configuration.resolveDatabaseConfiguration(identifier),
|
|
87
|
+
identifier,
|
|
88
|
+
tenant
|
|
89
|
+
});
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"tenant.js","sourceRoot":"","sources":["../../../src/tenants/tenant.js"],"names":[],"mappings":"AAAA,YAAY;AAEZ,OAAO,OAAO,MAAM,eAAe,CAAA;AACnC,OAAO,cAAc,MAAM,sBAAsB,CAAA;AAEjD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ;QAChC,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,EAAE,CAAA;QAE7C,OAAO,MAAM,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,aAAa,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAA;IACtG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAAO;QACZ,OAAO,OAAO,CAAC,MAAM,EAAE,CAAA;IACzB,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAC,UAAU,EAAE,QAAQ,EAAE,QAAQ,GAAG,CAAC,EAAE,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,EAAE,EAAC;QACrG,MAAM,QAAQ,GAAG,aAAa,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAA;QACpE,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,iBAAiB,CAAC,EAAC,IAAI,EAAE,gBAAgB,UAAU,EAAE,EAAC,EAAE,KAAK,IAAI,EAAE;YAC3G,OAAO,MAAM,QAAQ,CAAC,WAAW,CAAC,EAAC,aAAa,EAAE,UAAU,EAAC,CAAC,CAAA;QAChE,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,gCAAgC,UAAU,wCAAwC,CAAC,CAAA;QACrG,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAA;QACrE,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,EAAC,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,QAAQ,EAAC,CAAC,CAAA;QAEzF,4EAA4E;QAC5E,uFAAuF;QACvF,oFAAoF;QACpF,0FAA0F;QAC1F,OAAO,MAAM,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE;YACxD,MAAM,aAAa,CAAC,iBAAiB,CAAC,EAAC,IAAI,EAAE,gBAAgB,UAAU,EAAE,EAAC,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAA;QACvH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAC,UAAU,EAAE,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,EAAE,EAAC;QAC7E,MAAM,QAAQ,GAAG,aAAa,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAA;QAEpE,IAAI,OAAO,QAAQ,CAAC,YAAY,KAAK,UAAU,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CAAC,gCAAgC,UAAU,4CAA4C,CAAC,CAAA;QACzG,CAAC;QAED,MAAM,aAAa,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE;YACnD,qFAAqF;YACrF,qFAAqF;YACrF,wFAAwF;YACxF,wEAAwE;YACxE,IAAI,CAAC,aAAa,CAAC,0BAA0B,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC1D,MAAM,IAAI,KAAK,CAAC,8BAA8B,UAAU,4BAA4B,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YAC3H,CAAC;YAED,MAAM,QAAQ,CAAC,YAAY,EAAE,CAAC;gBAC5B,aAAa;gBACb,qBAAqB,EAAE,aAAa,CAAC,4BAA4B,CAAC,UAAU,CAAC;gBAC7E,UAAU;gBACV,MAAM;aACP,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;CACF","sourcesContent":["// @ts-check\n\nimport Current from \"../current.js\"\nimport TenantIterator from \"./tenant-iterator.js\"\n\n/**\n * Apartment-style runtime façade for multi-tenant apps. A \"tenant\" is whatever descriptor\n * object the app's `tenantDatabaseResolver` understands (an account, a project, …); this\n * class is the single discoverable home for switching into a tenant's context, reading the\n * current one, iterating every tenant of a database identifier, and dropping a tenant's\n * database. Switching delegates to {@link Current} (which owns the async-context tenant\n * state) and additionally runs the callback inside `ensureConnections`, so entering a tenant\n * makes its database immediately queryable — the apartment-style \"switch\" semantics — without\n * the caller establishing connections itself; iteration and drop drive the app's tenant\n * database provider hooks.\n */\nexport default class Tenant {\n  /**\n   * Runs `callback` with `tenant` as the current tenant, restoring the previous tenant after.\n   * The callback runs inside `ensureConnections`, so every database identifier the tenant\n   * activates (the global database plus the tenant's database) has a checked-out connection\n   * available for the callback's duration: switching into a tenant makes it queryable without\n   * the caller wiring up connections. Already-checked-out connections are reused, so nesting\n   * `Tenant.with` calls does not open redundant connections. The callback receives the active\n   * connections keyed by identifier, the same as `ensureConnections`.\n   * @param {object} tenant Descriptor understood by the app's tenantDatabaseResolver.\n   * @param {(connections: Record<string, import(\"../database/drivers/base.js\").default>) => Promise<?>} callback\n   * @returns {Promise<?>}\n   */\n  static async with(tenant, callback) {\n    const configuration = Current.configuration()\n\n    return await Current.withTenant(tenant, async () => await configuration.ensureConnections(callback))\n  }\n\n  /**\n   * The current tenant descriptor, or undefined when running outside any tenant context.\n   * @returns {Record<string, unknown> | undefined}\n   */\n  static current() {\n    return Current.tenant()\n  }\n\n  /**\n   * Lists the tenants for a database identifier through the provider and runs `callback`\n   * within each tenant's context, optionally filtered and several at a time. Like\n   * {@link Tenant.with}, the callback runs inside `ensureConnections` so each tenant's\n   * database is queryable without the caller wiring up connections. Returns how many tenants\n   * the callback ran for (after filtering).\n   * @param {{identifier: string, callback: function({databaseConfiguration: import(\"../configuration-types.js\").DatabaseConfigurationType, tenant: ?}) : Promise<void>, parallel?: number, filter?: (tenant: ?) => boolean, configuration?: import(\"../configuration.js\").default}} args\n   * @returns {Promise<number>}\n   */\n  static async each({identifier, callback, parallel = 1, filter, configuration = Current.configuration()}) {\n    const provider = configuration.getTenantDatabaseProvider(identifier)\n    const listedTenants = await configuration.ensureConnections({name: `Tenant.each: ${identifier}`}, async () => {\n      return await provider.listTenants({configuration, identifier})\n    })\n\n    if (!Array.isArray(listedTenants)) {\n      throw new Error(`Tenant database provider for ${identifier} must return an array from listTenants`)\n    }\n\n    const tenants = filter ? listedTenants.filter(filter) : listedTenants\n    const iterator = new TenantIterator({configuration, identifier, parallelCount: parallel})\n\n    // Run each tenant's callback inside ensureConnections so the iterator stays\n    // connection-agnostic (the db:tenants:* CLI commands share TenantIterator and must run\n    // their callbacks, such as create, before the tenant database exists) while runtime\n    // iteration here gets the tenant's connections established the same way Tenant.with does.\n    return await iterator.run(tenants, async (callbackArgs) => {\n      await configuration.ensureConnections({name: `Tenant.each: ${identifier}`}, async () => await callback(callbackArgs))\n    })\n  }\n\n  /**\n   * Drops one tenant's database/schema through the provider's `dropDatabase` hook.\n   * @param {{identifier: string, tenant: object, configuration?: import(\"../configuration.js\").default}} args\n   * @returns {Promise<void>}\n   */\n  static async drop({identifier, tenant, configuration = Current.configuration()}) {\n    const provider = configuration.getTenantDatabaseProvider(identifier)\n\n    if (typeof provider.dropDatabase !== \"function\") {\n      throw new Error(`Tenant database provider for ${identifier} must define dropDatabase to drop a tenant`)\n    }\n\n    await configuration.runWithTenant(tenant, async () => {\n      // Guard against an unresolved tenant. resolveDatabaseConfiguration falls back to the\n      // base (template/default) tenant database when the resolver returns nothing for this\n      // descriptor, so without this check a provider that drops by databaseConfiguration.name\n      // would drop the template database instead of rejecting the bad tenant.\n      if (!configuration.isDatabaseIdentifierActive(identifier)) {\n        throw new Error(`Tenant database identifier ${identifier} is inactive for tenant: ${TenantIterator.tenantLabel(tenant)}`)\n      }\n\n      await provider.dropDatabase?.({\n        configuration,\n        databaseConfiguration: configuration.resolveDatabaseConfiguration(identifier),\n        identifier,\n        tenant\n      })\n    })\n  }\n}\n"]}
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
// @ts-check
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Runs a callback once within each tenant's context for a tenant database identifier,
|
|
5
|
+
* optionally several tenants at a time. Each tenant is entered with `runWithTenant`, and a
|
|
6
|
+
* tenant whose database identifier is inactive throws rather than running the callback
|
|
7
|
+
* against the wrong connection. When iterating in parallel the per-tenant failures are
|
|
8
|
+
* collected and rethrown together as an `AggregateError` so one bad tenant does not hide the
|
|
9
|
+
* others. This is the iteration engine shared by the `db:tenants:*` CLI commands and the
|
|
10
|
+
* runtime {@link Tenant} façade; the caller is responsible for producing the tenant list.
|
|
11
|
+
*/
|
|
12
|
+
export default class TenantIterator {
|
|
13
|
+
/**
|
|
14
|
+
* Creates an iterator bound to a configuration and tenant database identifier.
|
|
15
|
+
* @param {{configuration: import("../configuration.js").default, identifier: string, parallelCount?: number}} args
|
|
16
|
+
*/
|
|
17
|
+
constructor({configuration, identifier, parallelCount = 1}) {
|
|
18
|
+
this.configuration = configuration
|
|
19
|
+
this.identifier = identifier
|
|
20
|
+
this.parallelCount = parallelCount
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* Runs `callback` within each tenant's context and returns how many tenants were processed.
|
|
25
|
+
* @param {Array<?>} tenants
|
|
26
|
+
* @param {function({databaseConfiguration: import("../configuration-types.js").DatabaseConfigurationType, tenant: ?}) : Promise<void>} callback
|
|
27
|
+
* @returns {Promise<number>}
|
|
28
|
+
*/
|
|
29
|
+
async run(tenants, callback) {
|
|
30
|
+
if (this.parallelCount <= 1) {
|
|
31
|
+
for (const tenant of tenants) {
|
|
32
|
+
await this.runTenantCallback({callback, tenant})
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return tenants.length
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/** @type {Array<{error: Error, tenant: ?}>} */
|
|
39
|
+
const failures = []
|
|
40
|
+
const workers = []
|
|
41
|
+
let tenantIndex = 0
|
|
42
|
+
const workerCount = Math.min(this.parallelCount, tenants.length)
|
|
43
|
+
|
|
44
|
+
for (let workerIndex = 0; workerIndex < workerCount; workerIndex++) {
|
|
45
|
+
workers.push((async () => {
|
|
46
|
+
while (tenantIndex < tenants.length) {
|
|
47
|
+
const tenant = tenants[tenantIndex]
|
|
48
|
+
|
|
49
|
+
tenantIndex++
|
|
50
|
+
|
|
51
|
+
try {
|
|
52
|
+
await this.runTenantCallback({callback, tenant})
|
|
53
|
+
} catch (error) {
|
|
54
|
+
failures.push({
|
|
55
|
+
error: error instanceof Error ? error : new Error(String(error)),
|
|
56
|
+
tenant
|
|
57
|
+
})
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
})())
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
await Promise.all(workers)
|
|
64
|
+
|
|
65
|
+
if (failures.length > 0) {
|
|
66
|
+
const failedTenantLabels = failures.map((failure) => TenantIterator.tenantLabel(failure.tenant)).join(", ")
|
|
67
|
+
|
|
68
|
+
throw new AggregateError(
|
|
69
|
+
failures.map((failure) => failure.error),
|
|
70
|
+
`Failed tenant database command for tenant(s): ${failedTenantLabels}`
|
|
71
|
+
)
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
return tenants.length
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* Enters one tenant's context and runs the callback, asserting the database is active first.
|
|
79
|
+
* @param {{callback: function({databaseConfiguration: import("../configuration-types.js").DatabaseConfigurationType, tenant: ?}) : Promise<void>, tenant: ?}} args
|
|
80
|
+
* @returns {Promise<void>}
|
|
81
|
+
*/
|
|
82
|
+
async runTenantCallback({callback, tenant}) {
|
|
83
|
+
await this.configuration.runWithTenant(tenant, async () => {
|
|
84
|
+
if (!this.configuration.isDatabaseIdentifierActive(this.identifier)) {
|
|
85
|
+
throw new Error(`Tenant database identifier ${this.identifier} is inactive for tenant: ${TenantIterator.tenantLabel(tenant)}`)
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
await callback({
|
|
89
|
+
databaseConfiguration: this.configuration.resolveDatabaseConfiguration(this.identifier),
|
|
90
|
+
tenant
|
|
91
|
+
})
|
|
92
|
+
})
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* Builds a human-readable label for a tenant for use in error messages.
|
|
97
|
+
* @param {?} tenant
|
|
98
|
+
* @returns {string}
|
|
99
|
+
*/
|
|
100
|
+
static tenantLabel(tenant) {
|
|
101
|
+
if (tenant && typeof tenant === "object") {
|
|
102
|
+
const tenantObject = /** @type {{id?: ?, name?: ?, slug?: ?}} */ (tenant)
|
|
103
|
+
|
|
104
|
+
if (tenantObject.slug) return String(tenantObject.slug)
|
|
105
|
+
if (tenantObject.name) return String(tenantObject.name)
|
|
106
|
+
if (tenantObject.id) return String(tenantObject.id)
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
return JSON.stringify(tenant)
|
|
110
|
+
}
|
|
111
|
+
}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
// @ts-check
|
|
2
|
+
|
|
3
|
+
import Current from "../current.js"
|
|
4
|
+
import TenantIterator from "./tenant-iterator.js"
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Apartment-style runtime façade for multi-tenant apps. A "tenant" is whatever descriptor
|
|
8
|
+
* object the app's `tenantDatabaseResolver` understands (an account, a project, …); this
|
|
9
|
+
* class is the single discoverable home for switching into a tenant's context, reading the
|
|
10
|
+
* current one, iterating every tenant of a database identifier, and dropping a tenant's
|
|
11
|
+
* database. Switching delegates to {@link Current} (which owns the async-context tenant
|
|
12
|
+
* state) and additionally runs the callback inside `ensureConnections`, so entering a tenant
|
|
13
|
+
* makes its database immediately queryable — the apartment-style "switch" semantics — without
|
|
14
|
+
* the caller establishing connections itself; iteration and drop drive the app's tenant
|
|
15
|
+
* database provider hooks.
|
|
16
|
+
*/
|
|
17
|
+
export default class Tenant {
|
|
18
|
+
/**
|
|
19
|
+
* Runs `callback` with `tenant` as the current tenant, restoring the previous tenant after.
|
|
20
|
+
* The callback runs inside `ensureConnections`, so every database identifier the tenant
|
|
21
|
+
* activates (the global database plus the tenant's database) has a checked-out connection
|
|
22
|
+
* available for the callback's duration: switching into a tenant makes it queryable without
|
|
23
|
+
* the caller wiring up connections. Already-checked-out connections are reused, so nesting
|
|
24
|
+
* `Tenant.with` calls does not open redundant connections. The callback receives the active
|
|
25
|
+
* connections keyed by identifier, the same as `ensureConnections`.
|
|
26
|
+
* @param {object} tenant Descriptor understood by the app's tenantDatabaseResolver.
|
|
27
|
+
* @param {(connections: Record<string, import("../database/drivers/base.js").default>) => Promise<?>} callback
|
|
28
|
+
* @returns {Promise<?>}
|
|
29
|
+
*/
|
|
30
|
+
static async with(tenant, callback) {
|
|
31
|
+
const configuration = Current.configuration()
|
|
32
|
+
|
|
33
|
+
return await Current.withTenant(tenant, async () => await configuration.ensureConnections(callback))
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* The current tenant descriptor, or undefined when running outside any tenant context.
|
|
38
|
+
* @returns {Record<string, unknown> | undefined}
|
|
39
|
+
*/
|
|
40
|
+
static current() {
|
|
41
|
+
return Current.tenant()
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Lists the tenants for a database identifier through the provider and runs `callback`
|
|
46
|
+
* within each tenant's context, optionally filtered and several at a time. Like
|
|
47
|
+
* {@link Tenant.with}, the callback runs inside `ensureConnections` so each tenant's
|
|
48
|
+
* database is queryable without the caller wiring up connections. Returns how many tenants
|
|
49
|
+
* the callback ran for (after filtering).
|
|
50
|
+
* @param {{identifier: string, callback: function({databaseConfiguration: import("../configuration-types.js").DatabaseConfigurationType, tenant: ?}) : Promise<void>, parallel?: number, filter?: (tenant: ?) => boolean, configuration?: import("../configuration.js").default}} args
|
|
51
|
+
* @returns {Promise<number>}
|
|
52
|
+
*/
|
|
53
|
+
static async each({identifier, callback, parallel = 1, filter, configuration = Current.configuration()}) {
|
|
54
|
+
const provider = configuration.getTenantDatabaseProvider(identifier)
|
|
55
|
+
const listedTenants = await configuration.ensureConnections({name: `Tenant.each: ${identifier}`}, async () => {
|
|
56
|
+
return await provider.listTenants({configuration, identifier})
|
|
57
|
+
})
|
|
58
|
+
|
|
59
|
+
if (!Array.isArray(listedTenants)) {
|
|
60
|
+
throw new Error(`Tenant database provider for ${identifier} must return an array from listTenants`)
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
const tenants = filter ? listedTenants.filter(filter) : listedTenants
|
|
64
|
+
const iterator = new TenantIterator({configuration, identifier, parallelCount: parallel})
|
|
65
|
+
|
|
66
|
+
// Run each tenant's callback inside ensureConnections so the iterator stays
|
|
67
|
+
// connection-agnostic (the db:tenants:* CLI commands share TenantIterator and must run
|
|
68
|
+
// their callbacks, such as create, before the tenant database exists) while runtime
|
|
69
|
+
// iteration here gets the tenant's connections established the same way Tenant.with does.
|
|
70
|
+
return await iterator.run(tenants, async (callbackArgs) => {
|
|
71
|
+
await configuration.ensureConnections({name: `Tenant.each: ${identifier}`}, async () => await callback(callbackArgs))
|
|
72
|
+
})
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Drops one tenant's database/schema through the provider's `dropDatabase` hook.
|
|
77
|
+
* @param {{identifier: string, tenant: object, configuration?: import("../configuration.js").default}} args
|
|
78
|
+
* @returns {Promise<void>}
|
|
79
|
+
*/
|
|
80
|
+
static async drop({identifier, tenant, configuration = Current.configuration()}) {
|
|
81
|
+
const provider = configuration.getTenantDatabaseProvider(identifier)
|
|
82
|
+
|
|
83
|
+
if (typeof provider.dropDatabase !== "function") {
|
|
84
|
+
throw new Error(`Tenant database provider for ${identifier} must define dropDatabase to drop a tenant`)
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
await configuration.runWithTenant(tenant, async () => {
|
|
88
|
+
// Guard against an unresolved tenant. resolveDatabaseConfiguration falls back to the
|
|
89
|
+
// base (template/default) tenant database when the resolver returns nothing for this
|
|
90
|
+
// descriptor, so without this check a provider that drops by databaseConfiguration.name
|
|
91
|
+
// would drop the template database instead of rejecting the bad tenant.
|
|
92
|
+
if (!configuration.isDatabaseIdentifierActive(identifier)) {
|
|
93
|
+
throw new Error(`Tenant database identifier ${identifier} is inactive for tenant: ${TenantIterator.tenantLabel(tenant)}`)
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
await provider.dropDatabase?.({
|
|
97
|
+
configuration,
|
|
98
|
+
databaseConfiguration: configuration.resolveDatabaseConfiguration(identifier),
|
|
99
|
+
identifier,
|
|
100
|
+
tenant
|
|
101
|
+
})
|
|
102
|
+
})
|
|
103
|
+
}
|
|
104
|
+
}
|