@webda/core 4.0.0-beta.8 → 4.0.0-beta.9

package/lib/test/legacy-types.d.ts

@@ -0,0 +1,146 @@
+import type { ModelClass } from "@webda/models";
+import { type MigrationReport } from "../stores/migration.js";
+import type { Store } from "../stores/store.js";
+/**
+ * `models` of a store holding the fixture: two models sharing one table, V3Animal its root
+ */
+export declare const LEGACY_TYPE_MODELS: string[];
+/**
+ * Rows as Webda 3 stored them: short, lower-case, upper-case, aliased, untyped and unknown types, and a type of an
+ * ancestor of the table root (`UuidModel`), which belongs to the root like an untyped row
+ */
+export declare const LEGACY_TYPE_ROWS: {
+    key: string;
+    data: Record<string, any>;
+}[];
+/**
+ * Row whose type matches two models (both declare the alias `Webda/Creature`): ambiguous, so left untouched
+ *
+ * Not part of {@link LEGACY_TYPE_ROWS}: only the migration check seeds it.
+ */
+export declare const LEGACY_TYPE_AMBIGUOUS_ROW: {
+    key: string;
+    data: {
+        uuid: string;
+        __type: string;
+        name: string;
+    };
+};
+/**
+ * Totals of a migration report, summed over the tables
+ */
+export interface LegacyTypeTotals {
+    /** Rows read */
+    scanned: number;
+    /** Rows rewritten */
+    updated: number;
+    /** Count by change */
+    byChange: Record<string, number>;
+    /** Untouched rows by stored type */
+    unknown: Record<string, number>;
+}
+/**
+ * Exact `types` migration totals over {@link LEGACY_TYPE_ROWS}
+ */
+export declare const LEGACY_TYPE_REPORT: LegacyTypeTotals;
+/**
+ * Register the fixture models in the current application (once), with the runtime Metadata the module loader sets
+ */
+export declare function registerLegacyTypeFixtures(): void;
+/**
+ * Sum a migration report over its tables
+ * @param report - the report
+ * @returns the totals
+ */
+export declare function sumMigrationReport(report: MigrationReport): LegacyTypeTotals;
+/**
+ * What a store package provides to run the legacy types conformance suite
+ */
+export interface LegacyTypesHarness {
+    /**
+     * Create, register in the Core, resolve and initialize an empty store of the type under test
+     * @param name - unique service name
+     * @param models - the `models` parameter
+     * @param parameters - extra store parameters (e.g. `table`, `tables`)
+     * @returns the store
+     */
+    createStore(name: string, models: string[], parameters?: Record<string, any>): Promise<Store>;
+    /**
+     * Write rows exactly as Webda 3 stored them (plain JSON, `__type` as given), bypassing the repositories
+     *
+     * Inserts or REPLACES any existing row with the same key (an upsert): the migration check re-seeds a row.
+     * @param store - the store
+     * @param table - the table, from {@link LegacyTypesHarness.tableOf}
+     * @param rows - rows by key
+     */
+    seedRaw(store: Store, table: string, rows: {
+        key: string;
+        data: Record<string, any>;
+    }[]): Promise<void>;
+    /**
+     * Table holding the rows of a model (default: the first raw table of the store)
+     * @param store - the store
+     * @param model - the model
+     * @returns the table name
+     */
+    tableOf?(store: Store, model: ModelClass): string;
+    /**
+     * Lease duration of the lease check, in ms: raise it for slow (remote) backends
+     *
+     * @default 1000
+     */
+    leaseDuration?: number;
+}
+/**
+ * Reads see exactly the rows of each model, as the right class; bulk statements and deletes too
+ * @param harness - the harness
+ */
+export declare function checkLegacyTypeVisibility(harness: LegacyTypesHarness): Promise<void>;
+/**
+ * Saving a legacy row writes its current identifier; a subclass row keeps its subclass identifier
+ * @param harness - the harness
+ */
+export declare function checkLegacyTypeNormalization(harness: LegacyTypesHarness): Promise<void>;
+/**
+ * The `types` report is exact; a dry run writes nothing; a second run updates nothing; a Webda 4 envelope keeps its
+ * value; an ambiguous type is counted and left alone
+ * @param harness - the harness
+ */
+export declare function checkLegacyTypeMigration(harness: LegacyTypesHarness): Promise<void>;
+/**
+ * A run interrupted after one page resumes and ends with the same totals
+ * @param harness - the harness
+ */
+export declare function checkLegacyTypeResume(harness: LegacyTypesHarness): Promise<void>;
+/**
+ * A second runner fails fast; an expired lease is taken over; the stale runner stops without writing
+ *
+ * Both runners use a patcher that always patches, so a stale runner that kept writing would be caught.
+ * @param harness - the harness
+ */
+export declare function checkLegacyTypeLease(harness: LegacyTypesHarness): Promise<void>;
+/**
+ * The startup check WARNs once with the counts; a clean store stays silent
+ * @param harness - the harness
+ */
+export declare function checkLegacyTypeStartup(harness: LegacyTypesHarness): Promise<void>;
+/**
+ * Every check of the suite, by name
+ */
+export declare const LEGACY_TYPE_CHECKS: {
+    name: string;
+    check: (harness: LegacyTypesHarness) => Promise<void>;
+}[];
+/**
+ * Run the whole suite
+ *
+ * A plain function rather than a test suite so store packages share it without duplicating test classes across
+ * module resolutions.
+ * @param harness - the harness
+ * @param options - names of the checks to skip, with a documented reason
+ * @param options.skip - check names
+ */
+export declare function checkLegacyTypes(harness: LegacyTypesHarness, options?: {
+    skip?: string[];
+}): Promise<void>;
+//# sourceMappingURL=legacy-types.d.ts.map

package/lib/test/legacy-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"legacy-types.d.ts","sourceRoot":"","sources":["../../src/test/legacy-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAIhD,OAAO,EAAyB,KAAK,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACrF,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAOhD;;GAEG;AACH,eAAO,MAAM,kBAAkB,UAAsC,CAAC;AAEtE;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAAE,EAaxE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,yBAAyB;IACpC,GAAG;IACH,IAAI;QAAI,IAAI;QAAQ,MAAM;QAAoB,IAAI;;CACnD,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,qBAAqB;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,sBAAsB;IACtB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,oCAAoC;IACpC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,gBAchC,CAAC;AAEF;;GAEG;AACH,wBAAgB,0BAA0B,IAAI,IAAI,CA6BjD;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,eAAe,GAAG,gBAAgB,CAa5E;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;OAMG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9F;;;;;;;OAOG;IACH,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxG;;;;;OAKG;IACH,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,GAAG,MAAM,CAAC;IAClD;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AA6ED;;;GAGG;AACH,wBAAsB,yBAAyB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CA2C1F;AAED;;;GAGG;AACH,wBAAsB,4BAA4B,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAmB7F;AAED;;;;GAIG;AACH,wBAAsB,wBAAwB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAoEzF;AAED;;;GAGG;AACH,wBAAsB,qBAAqB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAsBtF;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAoDrF;AAED;;;GAGG;AACH,wBAAsB,sBAAsB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CA8CvF;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CAAE,EAOvG,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,kBAAkB,EAAE,OAAO,GAAE;IAAE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAKpH"}

package/lib/test/legacy-types.fixture.model.d.ts

@@ -0,0 +1,38 @@
+import { UuidModel } from "@webda/models";
+/**
+ * Root model of the legacy types fixture: shares its table with {@link V3Plant}
+ *
+ * @WebdaIgnore
+ */
+export declare class V3Animal extends UuidModel {
+    /**
+     * Label
+     */
+    name: string;
+}
+/**
+ * Subclass of the legacy types fixture
+ *
+ * @WebdaIgnore
+ */
+export declare class V3Dog extends V3Animal {
+}
+/**
+ * Second-level subclass of the legacy types fixture
+ *
+ * @WebdaIgnore
+ */
+export declare class V3Puppy extends V3Dog {
+}
+/**
+ * Second model of the shared table, renamed from `Webda/Flora`
+ *
+ * @WebdaIgnore
+ */
+export declare class V3Plant extends UuidModel {
+    /**
+     * Label
+     */
+    name: string;
+}
+//# sourceMappingURL=legacy-types.fixture.model.d.ts.map

package/lib/test/legacy-types.fixture.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"legacy-types.fixture.model.d.ts","sourceRoot":"","sources":["../../src/test/legacy-types.fixture.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;GAIG;AACH,qBAAa,QAAS,SAAQ,SAAS;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,qBAAa,KAAM,SAAQ,QAAQ;CAAG;AAEtC;;;;GAIG;AACH,qBAAa,OAAQ,SAAQ,KAAK;CAAG;AAErC;;;;GAIG;AACH,qBAAa,OAAQ,SAAQ,SAAS;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}

package/lib/test/legacy-types.fixture.model.js

@@ -0,0 +1,38 @@
+import { UuidModel } from "@webda/models";
+/**
+ * Root model of the legacy types fixture: shares its table with {@link V3Plant}
+ *
+ * @WebdaIgnore
+ */
+export class V3Animal extends UuidModel {
+    /**
+     * Label
+     */
+    name;
+}
+/**
+ * Subclass of the legacy types fixture
+ *
+ * @WebdaIgnore
+ */
+export class V3Dog extends V3Animal {
+}
+/**
+ * Second-level subclass of the legacy types fixture
+ *
+ * @WebdaIgnore
+ */
+export class V3Puppy extends V3Dog {
+}
+/**
+ * Second model of the shared table, renamed from `Webda/Flora`
+ *
+ * @WebdaIgnore
+ */
+export class V3Plant extends UuidModel {
+    /**
+     * Label
+     */
+    name;
+}
+//# sourceMappingURL=legacy-types.fixture.model.js.map

package/lib/test/legacy-types.fixture.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"legacy-types.fixture.model.js","sourceRoot":"","sources":["../../src/test/legacy-types.fixture.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;GAIG;AACH,MAAM,OAAO,QAAS,SAAQ,SAAS;IACrC;;OAEG;IACH,IAAI,CAAS;CACd;AAED;;;;GAIG;AACH,MAAM,OAAO,KAAM,SAAQ,QAAQ;CAAG;AAEtC;;;;GAIG;AACH,MAAM,OAAO,OAAQ,SAAQ,KAAK;CAAG;AAErC;;;;GAIG;AACH,MAAM,OAAO,OAAQ,SAAQ,SAAS;IACpC;;OAEG;IACH,IAAI,CAAS;CACd"}