fix: add bnsImportUpdate to event emitter to fix BNS import test (#1491)

* fix: add bnsImportUpdate to event emitter to fix BNS import test

Author: BLuEScioN

src/datastore/pg-notifier.ts

@@ -1,5 +1,6 @@
 import * as postgres from 'postgres';
 import { logError, logger } from '../helpers';
+import { DbConfigState } from './common';
 import { connectPostgres, PgServer, PgSqlClient } from './connection';
 
 type PgNotificationType =
@@ -10,7 +11,8 @@ type PgNotificationType =
   | 'addressUpdate'
   | 'nameUpdate'
   | 'tokenMetadataUpdateQueued'
-  | 'tokensUpdate';
+  | 'tokensUpdate'
+  | 'configStateUpdate';
 
 export type PgTxNotificationPayload = {
   txId: string;
@@ -34,6 +36,8 @@ export type PgAddressNotificationPayload = {
   blockHeight: number;
 };
 
+export type PgConfigStateNotificationPayload = DbConfigState;
+
 export type PgTokenMetadataNotificationPayload = {
   queueId: number;
 };
@@ -54,7 +58,8 @@ type PgNotificationPayload =
   | PgNftEventNotificationPayload
   | PgTokenMetadataNotificationPayload
   | PgTokensNotificationPayload
-  | PgTxNotificationPayload;
+  | PgTxNotificationPayload
+  | PgConfigStateNotificationPayload;
 
 type PgNotification = {
   type: PgNotificationType;
@@ -127,6 +132,10 @@ export class PgNotifier {
     await this.notify({ type: 'tokensUpdate', payload: payload });
   }
 
+  public async sendConfigState(payload: PgConfigStateNotificationPayload) {
+    await this.notify({ type: 'configStateUpdate', payload });
+  }
+
   public async close() {
     await this.listener
       ?.unlisten()

src/datastore/pg-store-event-emitter.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'events';
 import StrictEventEmitter from 'strict-event-emitter-types';
-import { DbMempoolStats } from './common';
+import { DbConfigState, DbMempoolStats } from './common';
 
 type DataStoreEventEmitter = StrictEventEmitter<
   EventEmitter,
@@ -14,6 +14,7 @@ type DataStoreEventEmitter = StrictEventEmitter<
     tokensUpdate: (contractID: string) => void;
     tokenMetadataUpdateQueued: (queueId: number) => void;
     mempoolStatsUpdate: (mempoolStats: DbMempoolStats) => void;
+    configStateUpdate: (configState: DbConfigState) => void;
   }
 >;
 

src/datastore/pg-store.ts

@@ -28,6 +28,7 @@ import {
   DbBnsZoneFile,
   DbBurnchainReward,
   DbChainTip,
+  DbConfigState,
   DbEvent,
   DbEventTypeId,
   DbFtBalance,
@@ -91,6 +92,7 @@ import {
 import {
   PgAddressNotificationPayload,
   PgBlockNotificationPayload,
+  PgConfigStateNotificationPayload,
   PgMicroblockNotificationPayload,
   PgNameNotificationPayload,
   PgNftEventNotificationPayload,
@@ -239,6 +241,12 @@ export class PgStore {
           const nftEvent = notification.payload as PgNftEventNotificationPayload;
           this.eventEmitter.emit('nftEventUpdate', nftEvent.txId, nftEvent.eventIndex);
           break;
+        case 'configStateUpdate':
+          this.eventEmitter.emit(
+            'configStateUpdate',
+            notification.payload as PgConfigStateNotificationPayload
+          );
+          break;
       }
     });
   }

src/datastore/pg-write-store.ts

@@ -1683,6 +1683,7 @@ export class PgWriteStore extends PgStore {
         bns_subdomains_imported = ${configState.bns_subdomains_imported},
         token_offering_imported = ${configState.token_offering_imported}
     `;
+    await this.notifier?.sendConfigState(configState);
     if (queryResult.count !== 1) {
       throw new Error(`Unexpected config update row count: ${queryResult.count}`);
     }

src/tests-bns/event-server-tests.ts

@@ -17,7 +17,7 @@ describe('BNS event server tests', () => {
   beforeEach(async () => {
     process.env.PG_DATABASE = 'postgres';
     await cycleMigrations();
-    db = await PgWriteStore.connect({ usageName: 'tests', withNotifier: false });
+    db = await PgWriteStore.connect({ usageName: 'tests', withNotifier: true });
     client = db.sql;
     eventServer = await startEventServer({
       datastore: db,
@@ -1052,7 +1052,6 @@ describe('BNS event server tests', () => {
   })
 
   test('BNS middleware is async. /new_block posts return before importing BNS finishes', async () => {
-    jest.useRealTimers();
     process.env.BNS_IMPORT_DIR = 'src/tests-bns/import-test-files';
     const genesisBlock = await getGenesisBlockData('src/tests-event-replay/tsv/mainnet.tsv');
 
@@ -1069,15 +1068,15 @@ describe('BNS event server tests', () => {
     expect(configState.bns_names_onchain_imported).toBe(false)
     expect(configState.bns_subdomains_imported).toBe(false)
 
-    const timeoutId: NodeJS.Timeout = await new Promise(resolve => {
-      const timeoutId = setTimeout(async() => {
-        const configState = await db.getConfigState();
-        expect(configState.bns_names_onchain_imported).toBe(true)
-        expect(configState.bns_subdomains_imported).toBe(true)
-        resolve(timeoutId)
-      }, 2000)
+    await new Promise(resolve => {
+      db.eventEmitter.on('configStateUpdate', (configState) => {
+        if (configState.bns_names_onchain_imported && configState.bns_subdomains_imported) {
+          expect(configState.bns_names_onchain_imported).toBe(true)
+          expect(configState.bns_subdomains_imported).toBe(true);
+          resolve(undefined);
+        }
+      })
     })
-
-    clearTimeout(timeoutId);  
+    db.eventEmitter.removeAllListeners('configStateUpdate');
   })
 })