@proteinjs/db-settings 1.3.45 → 1.3.47

package/dist/test/util/TestSession.js

@@ -0,0 +1,49 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestSession = void 0;
+var reflection_1 = require("@proteinjs/reflection");
+var server_api_1 = require("@proteinjs/server-api");
+var user_1 = require("@proteinjs/user");
+/**
+ * The one session a suite's calls run in: a process-wide session store (the async-context store a
+ * server uses does not survive jest's hook and test boundaries), registered where `Session` looks
+ * for one, carrying the user the scoped db reads its scope from. `as(user)` re-seats the session
+ * on another user, so a suite can act as two people.
+ */
+var TestSession = /** @class */ (function () {
+    function TestSession() {
+        this.environment = 'node';
+        this.priority = 1;
+    }
+    /** Act as `user` from here on: the session's user, and the scope every scoped write and query carries. */
+    TestSession.as = function (user) {
+        TestSession.register();
+        server_api_1.Session.setData({ sessionId: 'settings-test', user: user.email, data: {} });
+        new user_1.UserRepo().setUser(__assign(__assign({}, user), { roles: [] }));
+    };
+    TestSession.prototype.setData = function (data) {
+        TestSession.data = data;
+    };
+    TestSession.prototype.getData = function () {
+        return TestSession.data;
+    };
+    TestSession.register = function () {
+        var repository = reflection_1.SourceRepository.get();
+        repository.objectCache['@proteinjs/server-api/SessionDataStorage'] = [new TestSession()];
+    };
+    TestSession.data = { sessionId: 'settings-test', user: undefined, data: {} };
+    return TestSession;
+}());
+exports.TestSession = TestSession;
+//# sourceMappingURL=TestSession.js.map

package/dist/test/util/TestSession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestSession.js","sourceRoot":"","sources":["../../../test/util/TestSession.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,oDAAyD;AACzD,oDAAiF;AACjF,wCAA2C;AAE3C;;;;;GAKG;AACH;IAAA;QACE,gBAAW,GAAG,MAAe,CAAC;QAC9B,aAAQ,GAAG,CAAC,CAAC;IAsBf,CAAC;IAnBC,0GAA0G;IACnG,cAAE,GAAT,UAAU,IAAiD;QACzD,WAAW,CAAC,QAAQ,EAAE,CAAC;QACvB,oBAAO,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAC5E,IAAI,eAAQ,EAAE,CAAC,OAAO,CAAC,sBAAK,IAAI,KAAE,KAAK,EAAE,EAAE,GAAmD,CAAC,CAAC;IAClG,CAAC;IAED,6BAAO,GAAP,UAAQ,IAAiB;QACvB,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED,6BAAO,GAAP;QACE,OAAO,WAAW,CAAC,IAAI,CAAC;IAC1B,CAAC;IAEc,oBAAQ,GAAvB;QACE,IAAM,UAAU,GAAG,6BAAgB,CAAC,GAAG,EAA+D,CAAC;QACvG,UAAU,CAAC,WAAW,CAAC,0CAA0C,CAAC,GAAG,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC;IAC3F,CAAC;IApBc,gBAAI,GAAgB,EAAE,SAAS,EAAE,eAAe,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,EAAE,AAAzE,CAA0E;IAqB/F,kBAAC;CAAA,AAxBD,IAwBC;AAxBY,kCAAW"}

package/generated/index.ts

@@ -8,15 +8,17 @@ import '@proteinjs/user';
 /** Generate Source Graph */
 
 const sourceGraph =
-  '{"options":{"directed":true,"multigraph":false,"compound":false},"nodes":[{"v":"@proteinjs/db-settings/Settings","value":{"packageName":"@proteinjs/db-settings","name":"Settings","filePath":"src/Settings.ts","qualifiedName":"@proteinjs/db-settings/Settings","isAbstract":false,"isStatic":false,"visibility":"public","properties":[{"name":"logger","type":null,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"private"},{"name":"serviceMetadata","type":null,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"}],"methods":[{"name":"get","returnType":null,"isAsync":true,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public","parameters":[{"name":"name","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}},{"name":"defaultValue","type":{"packageName":"","name":"T","filePath":null,"qualifiedName":"/T","typeParameters":null,"directParents":null}}]},{"name":"set","returnType":null,"isAsync":true,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public","parameters":[{"name":"name","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}},{"name":"value","type":{"packageName":"","name":"any","filePath":null,"qualifiedName":"/any","typeParameters":null,"directParents":null}}]}],"typeParameters":[],"directParentInterfaces":[{"packageName":"@proteinjs/db-settings","name":"SettingsService","filePath":null,"qualifiedName":"@proteinjs/db-settings/SettingsService","properties":[],"methods":[],"typeParameters":[],"directParents":[]}],"directParentClasses":[],"sourceType":2}},{"v":"@proteinjs/db-settings/SettingsService","value":{"packageName":"@proteinjs/db-settings","name":"SettingsService","filePath":"src/services/SettingsService.ts","qualifiedName":"@proteinjs/db-settings/SettingsService","properties":[],"methods":[{"name":"get","returnType":{"packageName":"","name":"Promise<T>","filePath":null,"qualifiedName":"/Promise<T>","typeParameters":null,"directParents":null},"isAsync":false,"isOptional":false,"isAbstract":true,"isStatic":false,"visibility":"public","parameters":[{"name":"name","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}},{"name":"defaultValue","type":{"packageName":"","name":"T","filePath":null,"qualifiedName":"/T","typeParameters":null,"directParents":null}}]},{"name":"set","returnType":{"packageName":"","name":"Promise<void>","filePath":null,"qualifiedName":"/Promise<void>","typeParameters":null,"directParents":null},"isAsync":false,"isOptional":false,"isAbstract":true,"isStatic":false,"visibility":"public","parameters":[{"name":"name","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}},{"name":"value","type":{"packageName":"","name":"any","filePath":null,"qualifiedName":"/any","typeParameters":null,"directParents":null}}]}],"typeParameters":[],"directParents":[{"packageName":"@proteinjs/service","name":"Service","filePath":null,"qualifiedName":"@proteinjs/service/Service","properties":[],"methods":[],"typeParameters":[],"directParents":[]}],"sourceType":3}},{"v":"@proteinjs/service/Service"},{"v":"@proteinjs/db-settings/Setting","value":{"packageName":"@proteinjs/db-settings","name":"Setting","filePath":"src/tables/SettingTable.ts","qualifiedName":"@proteinjs/db-settings/Setting","properties":[{"name":"name","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"value","type":{"packageName":"","name":"any","filePath":null,"qualifiedName":"/any","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"}],"methods":[],"typeParameters":[],"directParents":[{"packageName":"@proteinjs/user","name":"ScopedRecord","filePath":null,"qualifiedName":"@proteinjs/user/ScopedRecord","properties":[],"methods":[],"typeParameters":[],"directParents":[]}],"sourceType":3}},{"v":"@proteinjs/user/ScopedRecord"},{"v":"@proteinjs/db-settings/SettingTable","value":{"packageName":"@proteinjs/db-settings","name":"SettingTable","filePath":"src/tables/SettingTable.ts","qualifiedName":"@proteinjs/db-settings/SettingTable","isAbstract":false,"isStatic":false,"visibility":"public","properties":[{"name":"name","type":null,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"auth","type":{"packageName":"","name":"Table<Setting>[\'auth\']","filePath":null,"qualifiedName":"/Table<Setting>[\'auth\']","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"columns","type":null,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"}],"methods":[],"typeParameters":[],"directParentInterfaces":[],"directParentClasses":[{"packageName":"@proteinjs/db","name":"Table","filePath":null,"qualifiedName":"@proteinjs/db/Table","isAbstract":false,"isStatic":false,"visibility":"public","properties":[],"methods":[],"typeParameters":["@proteinjs/db-settings/Setting"],"directParentInterfaces":[],"directParentClasses":[]}],"sourceType":2}},{"v":"@proteinjs/db/Table"}],"edges":[{"v":"@proteinjs/db-settings/Settings","w":"@proteinjs/db-settings/SettingsService","value":"implements interface"},{"v":"@proteinjs/db-settings/SettingsService","w":"@proteinjs/service/Service","value":"extends interface"},{"v":"@proteinjs/db-settings/Setting","w":"@proteinjs/user/ScopedRecord","value":"extends interface"},{"v":"@proteinjs/db-settings/SettingTable","w":"@proteinjs/db/Table","value":"extends class"}]}';
+  '{"options":{"directed":true,"multigraph":false,"compound":false},"nodes":[{"v":"@proteinjs/db-settings/Settings","value":{"packageName":"@proteinjs/db-settings","name":"Settings","filePath":"src/Settings.ts","qualifiedName":"@proteinjs/db-settings/Settings","isAbstract":false,"isStatic":false,"visibility":"public","properties":[{"name":"serviceMetadata","type":null,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"}],"methods":[{"name":"get","returnType":null,"isAsync":true,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public","parameters":[{"name":"name","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}},{"name":"defaultValue","type":{"packageName":"","name":"T","filePath":null,"qualifiedName":"/T","typeParameters":null,"directParents":null}}]},{"name":"set","returnType":null,"isAsync":true,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public","parameters":[{"name":"name","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}},{"name":"value","type":{"packageName":"","name":"any","filePath":null,"qualifiedName":"/any","typeParameters":null,"directParents":null}}]}],"typeParameters":[],"directParentInterfaces":[{"packageName":"@proteinjs/db-settings","name":"SettingsService","filePath":null,"qualifiedName":"@proteinjs/db-settings/SettingsService","properties":[],"methods":[],"typeParameters":[],"directParents":[]}],"directParentClasses":[],"sourceType":2}},{"v":"@proteinjs/db-settings/SettingsService","value":{"packageName":"@proteinjs/db-settings","name":"SettingsService","filePath":"src/services/SettingsService.ts","qualifiedName":"@proteinjs/db-settings/SettingsService","properties":[],"methods":[{"name":"get","returnType":{"packageName":"","name":"Promise<T>","filePath":null,"qualifiedName":"/Promise<T>","typeParameters":null,"directParents":null},"isAsync":false,"isOptional":false,"isAbstract":true,"isStatic":false,"visibility":"public","parameters":[{"name":"name","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}},{"name":"defaultValue","type":{"packageName":"","name":"T","filePath":null,"qualifiedName":"/T","typeParameters":null,"directParents":null}}]},{"name":"set","returnType":{"packageName":"","name":"Promise<void>","filePath":null,"qualifiedName":"/Promise<void>","typeParameters":null,"directParents":null},"isAsync":false,"isOptional":false,"isAbstract":true,"isStatic":false,"visibility":"public","parameters":[{"name":"name","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null}},{"name":"value","type":{"packageName":"","name":"any","filePath":null,"qualifiedName":"/any","typeParameters":null,"directParents":null}}]}],"typeParameters":[],"directParents":[{"packageName":"@proteinjs/service","name":"Service","filePath":null,"qualifiedName":"@proteinjs/service/Service","properties":[],"methods":[],"typeParameters":[],"directParents":[]}],"sourceType":3}},{"v":"@proteinjs/db-settings/DeduplicateSettingRows","value":{"packageName":"@proteinjs/db-settings","name":"DeduplicateSettingRows","filePath":"src/migrations/DeduplicateSettingRows.ts","qualifiedName":"@proteinjs/db-settings/DeduplicateSettingRows","isAbstract":false,"isStatic":false,"visibility":"public","properties":[{"name":"DELETE_BATCH","type":null,"isOptional":false,"isAbstract":false,"isStatic":true,"visibility":"private"},{"name":"table","type":null,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"record","type":null,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"}],"methods":[{"name":"surplusRowIds","returnType":{"packageName":"","name":"Promise<string[]>","filePath":null,"qualifiedName":"/Promise<string[]>","typeParameters":null,"directParents":null},"isAsync":true,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"private","parameters":[]},{"name":"newestFirst","returnType":{"packageName":"","name":"number","filePath":null,"qualifiedName":"/number","typeParameters":null,"directParents":null},"isAsync":false,"isOptional":false,"isAbstract":false,"isStatic":true,"visibility":"private","parameters":[{"name":"a","type":{"packageName":"@proteinjs/db-settings","name":"Setting","filePath":null,"qualifiedName":"@proteinjs/db-settings/Setting","typeParameters":null,"directParents":null}},{"name":"b","type":{"packageName":"@proteinjs/db-settings","name":"Setting","filePath":null,"qualifiedName":"@proteinjs/db-settings/Setting","typeParameters":null,"directParents":null}}]}],"typeParameters":[],"directParentInterfaces":[{"packageName":"@proteinjs/db","name":"SourceRecordLoader","filePath":null,"qualifiedName":"@proteinjs/db/SourceRecordLoader","properties":[],"methods":[],"typeParameters":["@proteinjs/db/Migration"],"directParents":[]}],"directParentClasses":[],"sourceType":2}},{"v":"@proteinjs/db/SourceRecordLoader"},{"v":"@proteinjs/db-settings/Setting","value":{"packageName":"@proteinjs/db-settings","name":"Setting","filePath":"src/tables/SettingTable.ts","qualifiedName":"@proteinjs/db-settings/Setting","properties":[{"name":"name","type":{"packageName":"","name":"string","filePath":null,"qualifiedName":"/string","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"value","type":{"packageName":"","name":"any","filePath":null,"qualifiedName":"/any","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"}],"methods":[],"typeParameters":[],"directParents":[{"packageName":"@proteinjs/user","name":"ScopedRecord","filePath":null,"qualifiedName":"@proteinjs/user/ScopedRecord","properties":[],"methods":[],"typeParameters":[],"directParents":[]}],"sourceType":3}},{"v":"@proteinjs/user/ScopedRecord"},{"v":"@proteinjs/db-settings/SettingTable","value":{"packageName":"@proteinjs/db-settings","name":"SettingTable","filePath":"src/tables/SettingTable.ts","qualifiedName":"@proteinjs/db-settings/SettingTable","isAbstract":false,"isStatic":false,"visibility":"public","properties":[{"name":"name","type":null,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"indexes","type":{"packageName":"","name":"Table<Setting>[\'indexes\']","filePath":null,"qualifiedName":"/Table<Setting>[\'indexes\']","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"auth","type":{"packageName":"","name":"Table<Setting>[\'auth\']","filePath":null,"qualifiedName":"/Table<Setting>[\'auth\']","typeParameters":null,"directParents":null},"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"},{"name":"columns","type":null,"isOptional":false,"isAbstract":false,"isStatic":false,"visibility":"public"}],"methods":[],"typeParameters":[],"directParentInterfaces":[],"directParentClasses":[{"packageName":"@proteinjs/db","name":"Table","filePath":null,"qualifiedName":"@proteinjs/db/Table","isAbstract":false,"isStatic":false,"visibility":"public","properties":[],"methods":[],"typeParameters":["@proteinjs/db-settings/Setting"],"directParentInterfaces":[],"directParentClasses":[]}],"sourceType":2}},{"v":"@proteinjs/db/Table"},{"v":"@proteinjs/service/Service"}],"edges":[{"v":"@proteinjs/db-settings/Settings","w":"@proteinjs/db-settings/SettingsService","value":"implements interface"},{"v":"@proteinjs/db-settings/DeduplicateSettingRows","w":"@proteinjs/db/SourceRecordLoader","value":"implements interface"},{"v":"@proteinjs/db-settings/Setting","w":"@proteinjs/user/ScopedRecord","value":"extends interface"},{"v":"@proteinjs/db-settings/SettingTable","w":"@proteinjs/db/Table","value":"extends class"},{"v":"@proteinjs/db-settings/SettingsService","w":"@proteinjs/service/Service","value":"extends interface"}]}';
 
 /** Generate Source Links */
 
 import { Settings } from '../src/Settings';
+import { DeduplicateSettingRows } from '../src/migrations/DeduplicateSettingRows';
 import { SettingTable } from '../src/tables/SettingTable';
 
 const sourceLinks = {
   '@proteinjs/db-settings/Settings': Settings,
+  '@proteinjs/db-settings/DeduplicateSettingRows': DeduplicateSettingRows,
   '@proteinjs/db-settings/SettingTable': SettingTable,
 };
 

package/index.ts

@@ -2,4 +2,6 @@ export * from './src/Settings';
 
 export * from './src/tables/tables';
 
+export * from './src/migrations/DeduplicateSettingRows';
+
 export * from './src/services/SettingsService';

package/jest.config.js

@@ -6,4 +6,6 @@ module.exports = {
   testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$',
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
   testEnvironment: 'node',
+  testTimeout: 30000,
+  setupFiles: ['./test/setup'],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proteinjs/db-settings",
-  "version": "1.3.45",
+  "version": "1.3.47",
   "description": "Db settings",
   "publishConfig": {
     "access": "public"
@@ -18,18 +18,22 @@
   "scripts": {
     "clean": "rm -rf dist/ node_modules/ generated/",
     "build": "reflection-build && tsc",
-    "watch": "reflection-watch"
+    "watch": "reflection-watch",
+    "test": "jest --runInBand --passWithNoTests"
   },
   "dependencies": {
-    "@proteinjs/db": "^1.51.0",
+    "@proteinjs/db": "^1.53.0",
     "@proteinjs/logger": "^1.0.21",
     "@proteinjs/reflection": "^1.2.0",
     "@proteinjs/service": "^1.6.0",
-    "@proteinjs/user": "^1.7.1",
+    "@proteinjs/user": "^1.8.0",
     "moment": "2.29.4"
   },
   "devDependencies": {
+    "@proteinjs/db-driver-spanner": "^1.34.0",
+    "@proteinjs/db-transaction-context": "^0.5.44",
     "@proteinjs/reflection-build": "^2.0.1",
+    "@proteinjs/server-api": "^3.0.11",
     "@types/jest": "29.5.5",
     "@types/node": "14.0.27",
     "@typescript-eslint/eslint-plugin": "7.8.0",
@@ -43,5 +47,5 @@
   },
   "main": "./dist/generated/index.js",
   "types": "./dist/generated/index.d.ts",
-  "gitHead": "1128b1e6374c7f52cd5de172620b619b8f92e119"
+  "gitHead": "480320d415088dd0d378bd0e9863dc70353fa92f"
 }

package/src/Settings.ts

@@ -1,12 +1,21 @@
-import { Logger } from '@proteinjs/logger';
+import { isDuplicateKeyError } from '@proteinjs/db';
 import { SettingsService, getSettingsService } from './services/SettingsService';
 import { tables } from './tables/tables';
 import { getScopedDb } from '@proteinjs/user';
 
 export const getSettings = () => (typeof self === 'undefined' ? new Settings() : (getSettingsService() as Settings));
 
+/**
+ * The caller's named settings: one row per name within their scope (`SettingTable`'s unique
+ * index), so `get` reads the one row. `set` is one write that cannot mint a second row: it
+ * updates the row; when there is none it inserts; and when the index refuses that insert because
+ * another writer landed the row in between (the typed `DuplicateKeyError` — the race's only path)
+ * it updates the one row — the last writer's value is what the row holds. The update comes first
+ * because a rewrite of an existing name is the common act: insert-first made every rewrite a
+ * refused statement the driver reports as a failure. Without the index, two concurrent writers
+ * each updated nothing and each inserted, two rows of one name.
+ */
 export class Settings implements SettingsService {
-  private logger = new Logger({ name: this.constructor.name });
   public serviceMetadata = {
     auth: {
       allUsers: true,
@@ -25,10 +34,16 @@ export class Settings implements SettingsService {
 
   async set(name: string, value: any) {
     const db = getScopedDb();
-    const rowsUpdated = await db.update(tables.Setting, { value }, { name });
-    if (rowsUpdated == 0) {
-      this.logger.info({ message: `Creating new setting`, obj: { name, value } });
+    if ((await db.update(tables.Setting, { value }, { name })) > 0) {
+      return;
+    }
+    try {
       await db.insert(tables.Setting, { name, value });
+    } catch (error) {
+      if (!isDuplicateKeyError(error)) {
+        throw error;
+      }
+      await db.update(tables.Setting, { value }, { name });
     }
   }
 }

package/src/migrations/DeduplicateSettingRows.ts

@@ -0,0 +1,78 @@
+import { Migration, QueryBuilderFactory, SourceRecordLoader, getDbAsSystem, tables as dbTables } from '@proteinjs/db';
+import { Logger } from '@proteinjs/logger';
+import { Setting } from '../tables/SettingTable';
+import { tables } from '../tables/tables';
+
+/**
+ * The data step a database that predates the one-row-per-name invariant takes: before the unique
+ * index over (scope, name) lands (schema sync's preflight refuses the index over duplicate rows),
+ * keep ONE row of every (scope, name) — the newest, by `updated`, then `created`, then id — and
+ * delete the rest. The surplus rows are the ones an update-then-insert `set` created under
+ * concurrent writers; the newest holds the last value written, which is what the one row keeps.
+ *
+ * Pre-schema-sync (runs at `Db.init`, before the DDL), so by that contract: idempotent (a second
+ * run finds no duplicates), tolerant of concurrent duplicate runs (every actor computes the same
+ * survivors and deletes by id; a row already gone deletes nothing), and a no-op on a fresh
+ * database whose setting table does not exist yet.
+ */
+export class DeduplicateSettingRows implements SourceRecordLoader<Migration> {
+  /** Spanner binds at most 950 parameters to one statement; a delete names fewer ids than that. */
+  private static readonly DELETE_BATCH = 500;
+
+  table = dbTables.Migration;
+  record = {
+    id: 'a95d9f1d-3760-43d3-af75-15b0f7964eb6',
+    description: 'Keep one setting row per scope and name (the newest) ahead of the unique index over them',
+    preSchemaSync: true,
+    estimate: async () => ({ units: (await this.surplusRowIds()).length, unit: 'rows' }),
+    run: async () => {
+      const surplus = await this.surplusRowIds();
+      const db = getDbAsSystem<Setting>();
+      for (let start = 0; start < surplus.length; start += DeduplicateSettingRows.DELETE_BATCH) {
+        const batch = surplus.slice(start, start + DeduplicateSettingRows.DELETE_BATCH);
+        const qb = new QueryBuilderFactory().getQueryBuilder(tables.Setting);
+        qb.condition({ field: 'id', operator: 'IN', value: batch });
+        await db.delete(tables.Setting, qb);
+      }
+      new Logger({ name: this.constructor.name }).info({
+        message: 'Deleted the surplus setting rows',
+        obj: { deleted: surplus.length },
+      });
+      return { deleted: surplus.length };
+    },
+  };
+
+  /** The ids of every row that is not the newest of its (scope, name) — none when the table does not exist. */
+  private async surplusRowIds(): Promise<string[]> {
+    const db = getDbAsSystem<Setting>();
+    if (!(await db.tableExists(tables.Setting))) {
+      return [];
+    }
+
+    const rowsByKey: { [key: string]: Setting[] } = {};
+    for (const row of await db.query(tables.Setting, {})) {
+      const key = JSON.stringify([row.scope ?? null, row.name]);
+      rowsByKey[key] = [...(rowsByKey[key] ?? []), row];
+    }
+
+    const surplus: string[] = [];
+    for (const key of Object.keys(rowsByKey)) {
+      const rows = rowsByKey[key];
+      if (rows.length < 2) {
+        continue;
+      }
+      rows.sort(DeduplicateSettingRows.newestFirst);
+      surplus.push(...rows.slice(1).map((row) => row.id));
+    }
+
+    return surplus;
+  }
+
+  private static newestFirst(a: Setting, b: Setting): number {
+    return (
+      b.updated.valueOf() - a.updated.valueOf() ||
+      b.created.valueOf() - a.created.valueOf() ||
+      (b.id > a.id ? 1 : b.id < a.id ? -1 : 0)
+    );
+  }
+}

package/src/tables/SettingTable.ts

@@ -1,13 +1,23 @@
 import { Table, StringColumn, ObjectColumn } from '@proteinjs/db';
-import { ScopedRecord, withScopedRecordColumns } from '@proteinjs/user';
+import { ScopedRecord, createScopedIndex, withScopedRecordColumns } from '@proteinjs/user';
 
 export interface Setting extends ScopedRecord {
   name: string;
   value: any;
 }
 
+/**
+ * One row per name within a scope, by declaration: the unique index over (scope, name) is what
+ * keeps two writers from creating two rows of one name — `Settings.set` inserts, the index refuses
+ * the second writer's insert, and that writer updates the one row. The same name in another scope
+ * is another person's setting, its own row. A database that predates the index reaches the
+ * invariant through `DeduplicateSettingRows`, which runs before the index is added.
+ */
 export class SettingTable extends Table<Setting> {
   public name = 'setting';
+  public indexes: Table<Setting>['indexes'] = [
+    createScopedIndex<Setting>({ columns: ['name'], name: 'setting_scope_name_unique', unique: true }),
+  ];
   public auth: Table<Setting>['auth'] = {
     db: {
       all: 'authenticated',

package/test/DeduplicateSettingRows.test.ts

@@ -0,0 +1,83 @@
+import { Db, DuplicateValuesForUniqueIndexError, Record, Table, getDbAsSystem } from '@proteinjs/db';
+import { SpannerDriver } from '@proteinjs/db-driver-spanner';
+import { SpannerEmulatorProvisioner, getDropTestTable } from '@proteinjs/db-driver-spanner/test';
+import moment from 'moment';
+import { DeduplicateSettingRows } from '../src/migrations/DeduplicateSettingRows';
+import { Setting, SettingTable } from '../src/tables/SettingTable';
+import { tables } from '../src/tables/tables';
+import '@proteinjs/db-transaction-context';
+import '../generated/index';
+
+/**
+ * The data step that carries a live database to one row per name: over a setting table as it
+ * stood before the unique index (duplicate rows of a (scope, name) in it), schema sync refuses to
+ * add the index; the migration keeps the newest row of every (scope, name) — by `updated`, then
+ * `created` — and deletes the rest, touching no other row; a second run deletes nothing; the index
+ * then lands. On a database without the table it does nothing.
+ */
+
+const emulator = { projectId: 'proteinjs-test', instanceName: 'proteinjs-test', databaseName: 'test' };
+
+describe('keeping one setting row per scope and name ahead of the unique index', () => {
+  const systemDb = getDbAsSystem();
+  const migration = new DeduplicateSettingRows().record;
+  let driver: SpannerDriver;
+  let dropTable: (table: Table<any>) => Promise<void>;
+
+  const minutesAgo = (minutes: number) => moment().subtract(minutes, 'minutes');
+  const seed = (row: Partial<Setting>) => systemDb.insert(tables.Setting, row as Omit<Setting, keyof Record>);
+  const valuesLeft = async () =>
+    (await systemDb.query(tables.Setting, {})).map((row) => `${row.scope}/${row.name}=${row.value}`).sort();
+
+  beforeAll(async () => {
+    await SpannerEmulatorProvisioner.ensureProvisioned(emulator);
+    driver = Db.getDefaultDbDriver() as SpannerDriver;
+    dropTable = getDropTestTable(driver);
+    await dropTable(tables.Setting);
+    // The table as a database that predates the invariant holds it: no unique index.
+    const beforeTheIndex = new SettingTable();
+    beforeTheIndex.indexes = [];
+    await driver.getTableManager().loadTable(beforeTheIndex);
+  }, 120000);
+
+  afterAll(async () => {
+    await dropTable(tables.Setting);
+    SpannerEmulatorProvisioner.release();
+  }, 120000);
+
+  test('keeps the newest row of each (scope, name), deletes the rest, and the index then lands', async () => {
+    // ada/theme three times over: the newest by `updated` is the one written last, not the one created last.
+    await seed({ scope: 'ada', name: 'theme', value: 'first', created: minutesAgo(30), updated: minutesAgo(30) });
+    await seed({ scope: 'ada', name: 'theme', value: 'newest', created: minutesAgo(20), updated: minutesAgo(5) });
+    await seed({ scope: 'ada', name: 'theme', value: 'middle', created: minutesAgo(10), updated: minutesAgo(10) });
+    // ada/font twice with one `updated`: the later `created` is the newest.
+    await seed({ scope: 'ada', name: 'font', value: 'serif', created: minutesAgo(20), updated: minutesAgo(1) });
+    await seed({ scope: 'ada', name: 'font', value: 'sans', created: minutesAgo(15), updated: minutesAgo(1) });
+    // One row each: untouched.
+    await seed({ scope: 'ada', name: 'lang', value: 'en' });
+    await seed({ scope: 'grace', name: 'theme', value: 'green' });
+
+    await expect(driver.getTableManager().loadTable(tables.Setting)).rejects.toThrow(
+      DuplicateValuesForUniqueIndexError
+    );
+
+    expect(await migration.estimate!()).toEqual({ units: 3, unit: 'rows' });
+    expect(await migration.run()).toEqual({ deleted: 3 });
+    expect(await valuesLeft()).toEqual(['ada/font=sans', 'ada/lang=en', 'ada/theme=newest', 'grace/theme=green']);
+
+    expect(await migration.estimate!()).toEqual({ units: 0, unit: 'rows' });
+    expect(await migration.run()).toEqual({ deleted: 0 });
+    expect(await valuesLeft()).toEqual(['ada/font=sans', 'ada/lang=en', 'ada/theme=newest', 'grace/theme=green']);
+
+    await driver.getTableManager().loadTable(tables.Setting);
+    expect(await driver.getTableManager().schemaMetadata.getIndexes(tables.Setting)).toMatchObject({
+      setting_scope_name_unique: ['scope', 'name'],
+    });
+  });
+
+  test('a database without the table: nothing to do', async () => {
+    await dropTable(tables.Setting);
+    expect(await migration.estimate!()).toEqual({ units: 0, unit: 'rows' });
+    expect(await migration.run()).toEqual({ deleted: 0 });
+  });
+});

package/test/SettingsOneRowPerName.test.ts

@@ -0,0 +1,104 @@
+import { Db, Table, getDbAsSystem, isDuplicateKeyError } from '@proteinjs/db';
+import { SpannerDriver } from '@proteinjs/db-driver-spanner';
+import { SpannerEmulatorProvisioner, getDropTestTable } from '@proteinjs/db-driver-spanner/test';
+import { Logger } from '@proteinjs/logger';
+import { Settings } from '../src/Settings';
+import { tables } from '../src/tables/tables';
+import { HeldFirstWriteDriver } from './util/HeldFirstWriteDriver';
+import { TestSession } from './util/TestSession';
+import '@proteinjs/db-transaction-context';
+import '../generated/index';
+
+/**
+ * One setting row per name within a scope, on the real stack (the Spanner emulator, the default
+ * driver and transaction context resolved through reflection — the path `getScopedDb` takes in
+ * production): two concurrent `set`s of a fresh name — each observing no row before either
+ * writes, the interleaving that created two rows — leave ONE row, `get` reads its value, a later
+ * `set` rewrites that row without the driver reporting a refused statement (the common act stays
+ * quiet), the table's unique index refuses a second row of the name in the scope by its typed
+ * error, and the same name in another scope is another person's row.
+ */
+
+const emulator = { projectId: 'proteinjs-test', instanceName: 'proteinjs-test', databaseName: 'test' };
+const ada = { id: 'settings-test-ada', email: 'ada@settings.test', name: 'Ada' };
+const grace = { id: 'settings-test-grace', email: 'grace@settings.test', name: 'Grace' };
+
+describe('one setting row per name within a scope', () => {
+  const settings = new Settings();
+  const systemDb = getDbAsSystem();
+  let driver: SpannerDriver;
+  let dropTable: (table: Table<any>) => Promise<void>;
+
+  const rowsOf = (scope: string, name: string) => systemDb.query(tables.Setting, { scope, name });
+
+  beforeAll(async () => {
+    await SpannerEmulatorProvisioner.ensureProvisioned(emulator);
+    driver = Db.getDefaultDbDriver() as SpannerDriver;
+    dropTable = getDropTestTable(driver);
+    await dropTable(tables.Setting);
+    await driver.getTableManager().loadTable(tables.Setting);
+    TestSession.as(ada);
+  }, 120000);
+
+  afterAll(async () => {
+    await dropTable(tables.Setting);
+    SpannerEmulatorProvisioner.release();
+  }, 120000);
+
+  test('two concurrent sets of a fresh name, each observing no row before either writes, leave one row', async () => {
+    // Every `set` builds its db on the default driver: both writers' first writes are held until
+    // both have reached one, then run — neither can see the other's row before it writes.
+    const held = new HeldFirstWriteDriver(driver, 2);
+    const defaultDriver = jest.spyOn(Db, 'getDefaultDbDriver').mockImplementation(() => held);
+    try {
+      await Promise.all([settings.set('theme', 'dark'), settings.set('theme', 'light')]);
+    } finally {
+      defaultDriver.mockRestore();
+    }
+    const rows = await rowsOf(ada.id, 'theme');
+    expect(rows.length).toBe(1);
+    expect(['dark', 'light']).toContain(rows[0].value);
+    expect(await settings.get('theme')).toBe(rows[0].value);
+  });
+
+  test('a later set rewrites the one row, and the driver writes no error line for it', async () => {
+    // The driver's log lines, captured at its writer for the rewrite: a rewrite of an existing
+    // name is the common act (a setting written on every change) and must not be a refused
+    // statement the driver reports as a failure.
+    const internals = driver as unknown as { logger: Logger };
+    const driverLogger = internals.logger;
+    const lines: { logLevel: string; message?: string }[] = [];
+    internals.logger = new Logger({
+      name: 'SpannerDriver',
+      logLevel: 'info',
+      logWriter: { write: (line: { logLevel: string; message?: string }) => lines.push(line) } as any,
+    });
+    try {
+      await settings.set('theme', 'blue');
+    } finally {
+      internals.logger = driverLogger;
+    }
+    expect(lines.filter((line) => line.logLevel === 'error' || line.logLevel === 'warn')).toEqual([]);
+    expect((await rowsOf(ada.id, 'theme')).map((row) => row.value)).toEqual(['blue']);
+    expect(await settings.get('theme')).toBe('blue');
+  });
+
+  test('the unique index refuses a second row of the name in the scope by its typed error', async () => {
+    let refusal: unknown;
+    try {
+      await systemDb.insert(tables.Setting, { scope: ada.id, name: 'theme', value: 'red' });
+    } catch (error) {
+      refusal = error;
+    }
+    expect(isDuplicateKeyError(refusal)).toBe(true);
+    expect((await rowsOf(ada.id, 'theme')).map((row) => row.value)).toEqual(['blue']);
+  });
+
+  test('the same name in another scope is another row', async () => {
+    TestSession.as(grace);
+    await settings.set('theme', 'green');
+    expect(await settings.get('theme')).toBe('green');
+    expect((await rowsOf(grace.id, 'theme')).map((row) => row.value)).toEqual(['green']);
+    expect((await rowsOf(ada.id, 'theme')).map((row) => row.value)).toEqual(['blue']);
+  });
+});

package/test/setup.js

@@ -0,0 +1,2 @@
+process.env.SPANNER_EMULATOR_HOST = process.env.SPANNER_EMULATOR_HOST || 'localhost:9010';
+process.env.DB_LOG_LEVEL = 'error';

package/test/util/HeldFirstWriteDriver.ts

@@ -0,0 +1,110 @@
+import {
+  DbDriver,
+  DbDriverDmlStatementConfig,
+  DbDriverQueryStatementConfig,
+  SerializedRecord,
+  Statement,
+  TableManager,
+} from '@proteinjs/db';
+
+/**
+ * The real driver, with `writers` concurrent writers held in lockstep at their first write: each
+ * writer's first write is held until every writer has reached one, then all run; every later
+ * write waits until every first write has settled. The interleaving under which concurrent
+ * writers of one fresh name each observe no row before any of them writes one — what two requests
+ * produce when they write one setting at the same moment — made exact, so the suite does not
+ * rest on timing (the emulator serializes concurrent transactions with aborts and retries, which
+ * on their own let one writer's second write slip in before the other's first has settled).
+ * Reads go straight through. A barrier that never fills fails the held writers with a named
+ * error instead of hanging the suite.
+ */
+export class HeldFirstWriteDriver implements DbDriver {
+  private arrivals = 0;
+  private release!: () => void;
+  private readonly released: Promise<void>;
+  private readonly firstWrites: Promise<void>[] = [];
+
+  constructor(
+    private readonly driver: DbDriver,
+    private readonly writers: number
+  ) {
+    this.released = new Promise<void>((resolve, reject) => {
+      this.release = resolve;
+      setTimeout(
+        () => reject(new Error(`Only ${this.arrivals} of ${writers} writers reached their first write`)),
+        10000
+      ).unref();
+    });
+  }
+
+  async runDml(
+    generateStatement: (config: DbDriverDmlStatementConfig) => Statement,
+    transaction?: unknown
+  ): Promise<number> {
+    if (this.arrivals < this.writers) {
+      this.arrivals += 1;
+      if (this.arrivals === this.writers) {
+        this.release();
+      }
+      await this.released;
+      const write = this.driver.runDml(generateStatement, transaction);
+      this.firstWrites.push(
+        write.then(
+          () => undefined,
+          () => undefined
+        )
+      );
+      return await write;
+    }
+    await Promise.all(this.firstWrites);
+    return await this.driver.runDml(generateStatement, transaction);
+  }
+
+  runQuery(
+    generateStatement: (config: DbDriverQueryStatementConfig) => Statement,
+    transaction?: unknown
+  ): Promise<SerializedRecord[]> {
+    return this.driver.runQuery(generateStatement, transaction);
+  }
+
+  runTransaction<T>(fn: (transaction: unknown) => Promise<T>): Promise<T> {
+    return this.driver.runTransaction(fn);
+  }
+
+  isDuplicateKeyError(error: unknown): boolean {
+    return this.driver.isDuplicateKeyError?.(error) ?? false;
+  }
+
+  getDbName(): string {
+    return this.driver.getDbName();
+  }
+
+  createDbIfNotExists(): Promise<void> {
+    return this.driver.createDbIfNotExists();
+  }
+
+  createDb(name: string, options?: { ddl?: string[] }): Promise<void> {
+    return this.driver.createDb(name, options);
+  }
+
+  dropDb(name: string): Promise<void> {
+    return this.driver.dropDb(name);
+  }
+
+  getTableManager(): TableManager {
+    return this.driver.getTableManager();
+  }
+
+  getOperationDeadlineMs(): number {
+    return this.driver.getOperationDeadlineMs();
+  }
+
+  /** Forwarded; a driver that declares no bound would leave this undeclared, which a wrapper cannot express. */
+  getStatementParameterLimit(): number {
+    const limit = this.driver.getStatementParameterLimit?.();
+    if (limit === undefined) {
+      throw new Error('The wrapped driver declares no statement parameter limit');
+    }
+    return limit;
+  }
+}