@axinom/mosaic-db-common 0.26.0 → 0.27.0

package/dist/replication/ensure-replication-slot-and-publication-exist.d.ts

@@ -52,7 +52,7 @@ export interface EnsureReplicationSlotAndPublicationExistParams {
 }
 /**
  * Checks if specified replication slot and publication exist. If at least one
- * does not exists - idempotently (re)creates both.
+ * does not exists, or tables have changed - idempotently (re)creates both.
  *
  * It is preferable to run this helper on startup instead of defining the
  * replication slot and publication in context of migrations, because in cases

package/dist/replication/ensure-replication-slot-and-publication-exist.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ensure-replication-slot-and-publication-exist.d.ts","sourceRoot":"","sources":["../../src/replication/ensure-replication-slot-and-publication-exist.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAE1B,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,8CAA8C;IAC7D;;;;;;OAMG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,iBAAiB,EAAE,IAAI,CAAC;IACxB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,2BAA2B,EAAE,CAAC;IAClD;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,MAAM,CAAC,EAAE,QAAQ,CAAC;CACnB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,wCAAwC,gIASlD,8CAA8C,KAAG,QAAQ,IAAI,CAsD/D,CAAC"}
+{"version":3,"file":"ensure-replication-slot-and-publication-exist.d.ts","sourceRoot":"","sources":["../../src/replication/ensure-replication-slot-and-publication-exist.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAE1B,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,8CAA8C;IAC7D;;;;;;OAMG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,iBAAiB,EAAE,IAAI,CAAC;IACxB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,2BAA2B,EAAE,CAAC;IAClD;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,MAAM,CAAC,EAAE,QAAQ,CAAC;CACnB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,wCAAwC,gIASlD,8CAA8C,KAAG,QAAQ,IAAI,CAsE/D,CAAC"}

package/dist/replication/ensure-replication-slot-and-publication-exist.js

@@ -4,7 +4,7 @@ exports.ensureReplicationSlotAndPublicationExist = void 0;
 const db_1 = require("zapatos/db");
 /**
  * Checks if specified replication slot and publication exist. If at least one
- * does not exists - idempotently (re)creates both.
+ * does not exists, or tables have changed - idempotently (re)creates both.
  *
  * It is preferable to run this helper on startup instead of defining the
  * replication slot and publication in context of migrations, because in cases
@@ -21,7 +21,13 @@ const ensureReplicationSlotAndPublicationExist = async ({ replicationSlotName, p
                     AND slot_name = ${slotName}) AS "slotExists",
             EXISTS (SELECT FROM pg_publication 
                     WHERE pubname = ${pubName}) AS "pubExists";`.run(replicationPgPool);
-    if (slotExists && pubExists) {
+    const pubTables = await (0, db_1.sql) `SELECT schemaname, tablename FROM pg_publication_tables 
+              WHERE pubname = ${pubName}`.run(replicationPgPool);
+    const assignedTables = new Set(pubTables.map((t) => `${t.schemaname}.${t.tablename}`));
+    const expectedTables = new Set(tableNames.map((name) => `${schemaName}.${name}`));
+    const tablesRemainTheSame = assignedTables.size === expectedTables.size &&
+        [...assignedTables].every((assignedTable) => expectedTables.has(assignedTable));
+    if (slotExists && pubExists && tablesRemainTheSame) {
         (logger !== null && logger !== void 0 ? logger : console).log(`The replication slot "${replicationSlotName}" and publication "${publicationName}" already exist.`);
         return;
     }

package/dist/replication/ensure-replication-slot-and-publication-exist.js.map

@@ -1 +1 @@
-{"version":3,"file":"ensure-replication-slot-and-publication-exist.js","sourceRoot":"","sources":["../../src/replication/ensure-replication-slot-and-publication-exist.ts"],"names":[],"mappings":";;;AACA,mCAAqE;AAsDrE;;;;;;;;;GASG;AACI,MAAM,wCAAwC,GAAG,KAAK,EAAE,EAC7D,mBAAmB,EACnB,eAAe,EACf,iBAAiB,EACjB,UAAU,EACV,UAAU,EACV,iBAAiB,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAClD,UAAU,GAAG,UAAU,EACvB,MAAM,GACyC,EAAiB,EAAE;IAClE,MAAM,QAAQ,GAAG,IAAA,UAAK,EAAC,mBAAmB,CAAC,CAAC;IAC5C,MAAM,OAAO,GAAG,IAAA,UAAK,EAAC,eAAe,CAAC,CAAC;IACvC,MAAM,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,GAAG,MAAM,IAAA,QAAG,EAAA;;;sCAGT,QAAQ;;sCAER,OAAO,mBAAmB,CAAC,GAAG,CAChE,iBAAiB,CAClB,CAAC;IACF,IAAI,UAAU,IAAI,SAAS,EAAE;QAC3B,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,OAAO,CAAC,CAAC,GAAG,CACrB,yBAAyB,mBAAmB,sBAAsB,eAAe,kBAAkB,CACpG,CAAC;QACF,OAAO;KACR;IAED,MAAM,UAAU,GAAG,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,MAAM,MAAM,GAAG,IAAA,UAAK,EAAC,UAAU,CAAC,CAAC;IACjC,MAAM,IAAA,gBAAW,EACf,iBAAiB,EACjB,mBAAc,CAAC,YAAY,EAC3B,KAAK,EAAE,GAAG,EAAE,EAAE;QACZ,MAAM,IAAA,QAAG,EAAA,8BAA8B,eAAe,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACnE,MAAM,IAAA,QAAG,EAAA,sBAAsB,eAAe,oBAAoB,UAAU,IAAI,CAAC,GAAG,CAClF,GAAG,CACJ,CAAC;QACF,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;YAClC,MAAM,IAAA,QAAG,EAAA,qBAAqB,eAAe,cAAc,UAAU,IAAI,SAAS,GAAG,CAAC,GAAG,CACvF,GAAG,CACJ,CAAC;YACF,MAAM,IAAA,QAAG,EAAA,eAAe,UAAU,IAAI,SAAS,yBAAyB,CAAC,GAAG,CAC1E,GAAG,CACJ,CAAC;SACH;IACH,CAAC,CACF,CAAC;IACF,MAAM,IAAA,gBAAW,EACf,iBAAiB,EACjB,mBAAc,CAAC,YAAY,EAC3B,KAAK,EAAE,GAAG,EAAE,EAAE;QACZ,MAAM,IAAA,QAAG,EAAA,mCAAmC,QAAQ;;oCAEtB,QAAQ;8DACkB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClE,MAAM,IAAA,QAAG,EAAA,6CAA6C,QAAQ,KAAK,MAAM,IAAI,CAAC,GAAG,CAC/E,GAAG,CACJ,CAAC;IACJ,CAAC,CACF,CAAC;IACF,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,OAAO,CAAC,CAAC,GAAG,CACrB,yBAAyB,mBAAmB,sBAAsB,eAAe,6BAA6B,CAC/G,CAAC;AACJ,CAAC,CAAC;AA/DW,QAAA,wCAAwC,4CA+DnD"}
+{"version":3,"file":"ensure-replication-slot-and-publication-exist.js","sourceRoot":"","sources":["../../src/replication/ensure-replication-slot-and-publication-exist.ts"],"names":[],"mappings":";;;AACA,mCAA0E;AAsD1E;;;;;;;;;GASG;AACI,MAAM,wCAAwC,GAAG,KAAK,EAAE,EAC7D,mBAAmB,EACnB,eAAe,EACf,iBAAiB,EACjB,UAAU,EACV,UAAU,EACV,iBAAiB,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAClD,UAAU,GAAG,UAAU,EACvB,MAAM,GACyC,EAAiB,EAAE;IAClE,MAAM,QAAQ,GAAG,IAAA,UAAK,EAAC,mBAAmB,CAAC,CAAC;IAC5C,MAAM,OAAO,GAAG,IAAA,UAAK,EAAC,eAAe,CAAC,CAAC;IACvC,MAAM,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,GAAG,MAAM,IAAA,QAAG,EAAA;;;sCAGT,QAAQ;;sCAER,OAAO,mBAAmB,CAAC,GAAG,CAChE,iBAAiB,CAClB,CAAC;IACF,MAAM,SAAS,GAAG,MAAM,IAAA,QAAG,EAG1B;gCAC6B,OAAO,EAAE,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAC/D,MAAM,cAAc,GAAG,IAAI,GAAG,CAC5B,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC,CACvD,CAAC;IACF,MAAM,cAAc,GAAG,IAAI,GAAG,CAC5B,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,UAAU,IAAI,IAAI,EAAE,CAAC,CAClD,CAAC;IACF,MAAM,mBAAmB,GACvB,cAAc,CAAC,IAAI,KAAK,cAAc,CAAC,IAAI;QAC3C,CAAC,GAAG,cAAc,CAAC,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,EAAE,CAC1C,cAAc,CAAC,GAAG,CAAC,aAAa,CAAC,CAClC,CAAC;IACJ,IAAI,UAAU,IAAI,SAAS,IAAI,mBAAmB,EAAE;QAClD,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,OAAO,CAAC,CAAC,GAAG,CACrB,yBAAyB,mBAAmB,sBAAsB,eAAe,kBAAkB,CACpG,CAAC;QACF,OAAO;KACR;IAED,MAAM,UAAU,GAAG,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,MAAM,MAAM,GAAG,IAAA,UAAK,EAAC,UAAU,CAAC,CAAC;IACjC,MAAM,IAAA,gBAAW,EACf,iBAAiB,EACjB,mBAAc,CAAC,YAAY,EAC3B,KAAK,EAAE,GAAG,EAAE,EAAE;QACZ,MAAM,IAAA,QAAG,EAAA,8BAA8B,eAAe,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACnE,MAAM,IAAA,QAAG,EAAA,sBAAsB,eAAe,oBAAoB,UAAU,IAAI,CAAC,GAAG,CAClF,GAAG,CACJ,CAAC;QACF,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;YAClC,MAAM,IAAA,QAAG,EAAA,qBAAqB,eAAe,cAAc,UAAU,IAAI,SAAS,GAAG,CAAC,GAAG,CACvF,GAAG,CACJ,CAAC;YACF,MAAM,IAAA,QAAG,EAAA,eAAe,UAAU,IAAI,SAAS,yBAAyB,CAAC,GAAG,CAC1E,GAAG,CACJ,CAAC;SACH;IACH,CAAC,CACF,CAAC;IACF,MAAM,IAAA,gBAAW,EACf,iBAAiB,EACjB,mBAAc,CAAC,YAAY,EAC3B,KAAK,EAAE,GAAG,EAAE,EAAE;QACZ,MAAM,IAAA,QAAG,EAAA,mCAAmC,QAAQ;;oCAEtB,QAAQ;8DACkB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClE,MAAM,IAAA,QAAG,EAAA,6CAA6C,QAAQ,KAAK,MAAM,IAAI,CAAC,GAAG,CAC/E,GAAG,CACJ,CAAC;IACJ,CAAC,CACF,CAAC;IACF,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,OAAO,CAAC,CAAC,GAAG,CACrB,yBAAyB,mBAAmB,sBAAsB,eAAe,6BAA6B,CAC/G,CAAC;AACJ,CAAC,CAAC;AA/EW,QAAA,wCAAwC,4CA+EnD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axinom/mosaic-db-common",
-  "version": "0.26.0",
+  "version": "0.27.0",
   "description": "This library encapsulates database-related functionality to develop Mosaic based services.",
   "author": "Axinom",
   "license": "PROPRIETARY",
@@ -52,5 +52,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5b53d10a1d949514b827708182e3aee192fc2a36"
+  "gitHead": "7eb762e7cec90f882c2fe11f5c294c44fc2c3bc3"
 }

package/src/replication/ensure-replication-slot-and-publication-exist.spec.ts

@@ -0,0 +1,173 @@
+import { stub } from 'jest-auto-stub';
+import { Pool } from 'pg';
+import { SQLFragment } from 'zapatos/db';
+import { ensureReplicationSlotAndPublicationExist } from './ensure-replication-slot-and-publication-exist';
+
+const slotName = 'test_slot_name';
+const pubName = 'test_pub_name';
+let existsResult: () => unknown = () => undefined;
+let tablesResult: () => unknown = () => undefined;
+jest.mock('zapatos/db', () => {
+  return {
+    ...jest.requireActual('zapatos/db'),
+    sql: jest.fn().mockImplementation((_query, firstParam) => {
+      return stub<SQLFragment>({
+        run: jest.fn().mockImplementation(() => {
+          if (firstParam.value === slotName) {
+            return existsResult();
+          }
+          if (firstParam.value === pubName) {
+            return tablesResult();
+          }
+        }),
+      });
+    }),
+    transaction: jest.fn().mockImplementation(() => {
+      return;
+    }),
+  };
+});
+
+describe('ensureReplicationSlotAndPublicationExist', () => {
+  let consoleOverride: jest.SpyInstance;
+  beforeEach(() => {
+    consoleOverride = jest
+      .spyOn(console, 'log')
+      .mockImplementation((log) => log);
+  });
+
+  afterEach(() => {
+    existsResult = () => undefined;
+    tablesResult = () => undefined;
+    jest.restoreAllMocks();
+  });
+
+  it.each([
+    [true, false],
+    [false, true],
+    [false, false],
+  ])(
+    'call when slot and/or publication does not exist -> pass, %p, %p',
+    async (slotExists, pubExists) => {
+      // Arrange
+      existsResult = () => [{ slotExists, pubExists }];
+      tablesResult = () =>
+        pubExists
+          ? [
+              { schemaname: 'app_public', tablename: 'table_one' },
+              { schemaname: 'app_public', tablename: 'table_two' },
+              { schemaname: 'app_public', tablename: 'table_three' },
+            ]
+          : [];
+
+      // Act
+      await ensureReplicationSlotAndPublicationExist({
+        replicationPgPool: stub<Pool>(),
+        replicationSlotName: slotName,
+        publicationName: pubName,
+        tableNames: ['table_one', 'table_two', 'table_three'],
+        schemaName: 'app_public',
+      });
+
+      // Assert
+      expect(consoleOverride.mock.results[0].value).toBe(
+        'The replication slot "test_slot_name" and publication "test_pub_name" successfully (re)created.',
+      );
+    },
+  );
+
+  it('call when slot and publication exist and new table is added -> pass', async () => {
+    // Arrange
+    existsResult = () => [{ slotExists: true, pubExists: true }];
+    tablesResult = () => [
+      { schemaname: 'app_public', tablename: 'table_one' },
+      { schemaname: 'app_public', tablename: 'table_two' },
+    ];
+
+    // Act
+    await ensureReplicationSlotAndPublicationExist({
+      replicationPgPool: stub<Pool>(),
+      replicationSlotName: slotName,
+      publicationName: pubName,
+      tableNames: ['table_one', 'table_two', 'table_three'],
+      schemaName: 'app_public',
+    });
+
+    // Assert
+    expect(consoleOverride.mock.results[0].value).toBe(
+      'The replication slot "test_slot_name" and publication "test_pub_name" successfully (re)created.',
+    );
+  });
+
+  it('call when slot and publication exist and old table is removed -> pass', async () => {
+    // Arrange
+    existsResult = () => [{ slotExists: true, pubExists: true }];
+    tablesResult = () => [
+      { schemaname: 'app_public', tablename: 'table_one' },
+      { schemaname: 'app_public', tablename: 'table_two' },
+      { schemaname: 'app_public', tablename: 'table_three' },
+    ];
+
+    // Act
+    await ensureReplicationSlotAndPublicationExist({
+      replicationPgPool: stub<Pool>(),
+      replicationSlotName: slotName,
+      publicationName: pubName,
+      tableNames: ['table_one', 'table_two'],
+      schemaName: 'app_public',
+    });
+
+    // Assert
+    expect(consoleOverride.mock.results[0].value).toBe(
+      'The replication slot "test_slot_name" and publication "test_pub_name" successfully (re)created.',
+    );
+  });
+
+  it('call when slot and publication exist and one table is replaced by another -> pass', async () => {
+    // Arrange
+    existsResult = () => [{ slotExists: true, pubExists: true }];
+    tablesResult = () => [
+      { schemaname: 'app_public', tablename: 'table_one' },
+      { schemaname: 'app_public', tablename: 'table_two' },
+      { schemaname: 'app_public', tablename: 'table_three' },
+    ];
+
+    // Act
+    await ensureReplicationSlotAndPublicationExist({
+      replicationPgPool: stub<Pool>(),
+      replicationSlotName: slotName,
+      publicationName: pubName,
+      tableNames: ['table_one', 'table_two', 'table_four'],
+      schemaName: 'app_public',
+    });
+
+    // Assert
+    expect(consoleOverride.mock.results[0].value).toBe(
+      'The replication slot "test_slot_name" and publication "test_pub_name" successfully (re)created.',
+    );
+  });
+
+  it('call when slot and publication exist and tables are in sync -> skip', async () => {
+    // Arrange
+    existsResult = () => [{ slotExists: true, pubExists: true }];
+    tablesResult = () => [
+      { schemaname: 'app_public', tablename: 'table_one' },
+      { schemaname: 'app_public', tablename: 'table_two' },
+      { schemaname: 'app_public', tablename: 'table_three' },
+    ];
+
+    // Act
+    await ensureReplicationSlotAndPublicationExist({
+      replicationPgPool: stub<Pool>(),
+      replicationSlotName: slotName,
+      publicationName: pubName,
+      tableNames: ['table_one', 'table_two', 'table_three'],
+      schemaName: 'app_public',
+    });
+
+    // Assert
+    expect(consoleOverride.mock.results[0].value).toBe(
+      'The replication slot "test_slot_name" and publication "test_pub_name" already exist.',
+    );
+  });
+});

package/src/replication/ensure-replication-slot-and-publication-exist.ts

@@ -1,5 +1,5 @@
 import { Pool } from 'pg';
-import { IsolationLevel, param, sql, transaction } from 'zapatos/db';
+import { IsolationLevel, SQL, param, sql, transaction } from 'zapatos/db';
 import { DbLogger } from '../common';
 import { LogicalReplicationOperation } from './create-logical-replication-service';
 
@@ -55,7 +55,7 @@ export interface EnsureReplicationSlotAndPublicationExistParams {
 
 /**
  * Checks if specified replication slot and publication exist. If at least one
- * does not exists - idempotently (re)creates both.
+ * does not exists, or tables have changed - idempotently (re)creates both.
  *
  * It is preferable to run this helper on startup instead of defining the
  * replication slot and publication in context of migrations, because in cases
@@ -83,7 +83,23 @@ export const ensureReplicationSlotAndPublicationExist = async ({
                     WHERE pubname = ${pubName}) AS "pubExists";`.run(
     replicationPgPool,
   );
-  if (slotExists && pubExists) {
+  const pubTables = await sql<
+    SQL,
+    { schemaname: string; tablename: string }[]
+  >`SELECT schemaname, tablename FROM pg_publication_tables 
+              WHERE pubname = ${pubName}`.run(replicationPgPool);
+  const assignedTables = new Set(
+    pubTables.map((t) => `${t.schemaname}.${t.tablename}`),
+  );
+  const expectedTables = new Set(
+    tableNames.map((name) => `${schemaName}.${name}`),
+  );
+  const tablesRemainTheSame =
+    assignedTables.size === expectedTables.size &&
+    [...assignedTables].every((assignedTable) =>
+      expectedTables.has(assignedTable),
+    );
+  if (slotExists && pubExists && tablesRemainTheSame) {
     (logger ?? console).log(
       `The replication slot "${replicationSlotName}" and publication "${publicationName}" already exist.`,
     );