more tests

Author: Antoine de Chevigné

pm2-server/tests/lib/pm2.test.js

@@ -106,4 +106,26 @@ describe('start', () => {
                 done();
             });
     });
-});
+});
+
+describe('startSafeBlockListener', () => {
+    it('Should resolve with started process', (done) => {
+        jest.spyOn(pm2, 'describe').mockImplementation((_, cb) => cb(null, [{ process: 1 }]));
+        pm2Lib.startSafeBlockListener('slug', 1)
+            .then(process => {
+                expect(process).toEqual({ process: 1 });
+                done();
+            });
+    });
+});
+
+describe('startLogListener', () => {
+    it('Should resolve with started process', (done) => {
+        jest.spyOn(pm2, 'describe').mockImplementation((_, cb) => cb(null, [{ process: 1 }]));
+        pm2Lib.startLogListener('slug', { arg1: 'value1' })
+            .then(process => {
+                expect(process).toEqual({ process: 1 });
+                done();
+            });
+    });
+});

run/jobs/finalizePendingOrbitBatches.js

@@ -1,3 +1,4 @@
+const logger = require('../lib/logger');
 const { OrbitBatch, OrbitChainConfig } = require('../models');
 const { Op } = require('sequelize');
 
@@ -15,14 +16,14 @@ module.exports = async () => {
     for (const config of orbitParentConfigs) {
         const parentWorkspace = await config.getTopParentWorkspace();
         const orbitChildConfigs = await parentWorkspace.getOrbitChildConfigs();
-        workspaces[parentWorkspace.id] = { ...parentWorkspace.toJSON(), orbitChildConfigs, client: parentWorkspace.getViemPublicClient() };
+        workspaces[parentWorkspace.id] = Object.assign({}, parentWorkspace.toJSON(), { orbitChildConfigs, client: parentWorkspace.getViemPublicClient() });
     }
 
-    let pendingBatches = [];
+    let allPendingBatches = [];
     for (const workspace of Object.values(workspaces)) {
         const block = await workspace.client.getBlock({ blockTag: 'safe' });
         for (const orbitChildConfig of workspace.orbitChildConfigs) {
-            console.log(`Validating batches posted on ${workspace.name} by config ${orbitChildConfig.workspaceId} with block number ${block.number}`);
+            logger.info(`Validating batches posted on ${workspace.name} by config ${orbitChildConfig.workspaceId} with block number ${block.number}`);
             const pendingBatches = await OrbitBatch.findAll({
                 where: {
                     workspaceId: orbitChildConfig.workspaceId,
@@ -36,8 +37,10 @@ module.exports = async () => {
             for (const batch of pendingBatches) {
                 await batch.confirm();
             }
+            
+            allPendingBatches = allPendingBatches.concat(pendingBatches);
         }
     }
 
-    return pendingBatches.map(batch => batch.id);
+    return allPendingBatches.map(batch => batch.id);
 };

run/jobs/index.js

@@ -3,15 +3,12 @@ module.exports = {
     blockSync: require('./blockSync'),
     processBlock: require('./processBlock'),
     batchBlockSync: require('./batchBlockSync'),
-    discoverOrbitBatches: require('./discoverOrbitBatches'),
-    indexOrbitNodes: require('./indexOrbitNodes'),
     sendResetPasswordEmail: require('./sendResetPasswordEmail'),
     updateExplorerSyncingProcess: require('./updateExplorerSyncingProcess'),
     receiptSync: require('./receiptSync'),
     removeStalledBlock: require('./removeStalledBlock'),
     increaseStripeBillingQuota: require('./increaseStripeBillingQuota'),
     finalizePendingOrbitBatches: require('./finalizePendingOrbitBatches'),
-    startSafeBlockListener: require('./startSafeBlockListener'),
     checkOrbitMessageDeliveredLogs: require('./checkOrbitMessageDeliveredLogs'),
     backfillOrbitMessageDeliveredLogs: require('./backfillOrbitMessageDeliveredLogs'),
     storeOrbitDeposit: require('./storeOrbitDeposit'),

run/jobs/receiptSync.js

@@ -76,8 +76,8 @@ module.exports = async job => {
     if (!workspace.explorer)
         return 'Inactive explorer';
 
-    // if (!workspace.explorer.shouldSync)
-    //     return 'Disabled sync';
+    if (!workspace.explorer.shouldSync)
+        return 'Disabled sync';
 
     if (workspace.rpcHealthCheck && workspace.rpcHealthCheckEnabled && !workspace.rpcHealthCheck.isReachable)
         return 'RPC is unreachable';

run/jobs/safeBlockListenerCheck.js

@@ -1,6 +1,7 @@
 const { Op } = require('sequelize');
+const { getPm2Host, getPm2Secret } = require('../lib/env');
 const { OrbitChainConfig } = require('../models');
-const { bulkEnqueue } = require('../lib/queue');
+const PM2 = require('../lib/pm2');
 
 module.exports = async () => {
     const orbitParentConfigs = await OrbitChainConfig.findAll({
@@ -11,25 +12,23 @@ module.exports = async () => {
         }
     });
 
-    const workspaceIds = [];
+    const pm2 = new PM2(getPm2Host(), getPm2Secret());
+
+    const existingProcesses = [];
+    const newProcesses = [];
     for (const config of orbitParentConfigs) {
         const parentWorkspace = await config.getTopParentWorkspace();
-        workspaceIds.push(parentWorkspace.id);
-    }
+        const explorer = await parentWorkspace.getExplorer();
 
-    const uniqueWorkspaceIds = [...new Set(workspaceIds)];
+        const { data: existingProcess } = await pm2.find(`safeBlockListener-${explorer.slug}`);
 
-    const jobs = [];
-    for (let i = 0; i < uniqueWorkspaceIds.length; i++) {
-        const workspaceId = uniqueWorkspaceIds[i];
-        console.log(workspaceId);
-        jobs.push({
-            name: `startSafeBlockListener-${workspaceId}`,
-            data: { workspaceId }
-        });
+        if (existingProcess)
+            existingProcesses.push(explorer.slug);
+        else {
+            await pm2.startSafeBlockListener(explorer.slug, parentWorkspace.id);
+            newProcesses.push(explorer.slug);
+        }
     }
 
-    await bulkEnqueue('startSafeBlockListener', jobs);
-
-    return true;
+    return { newProcesses, existingProcesses };
 };

run/jobs/startSafeBlockListener.js

@@ -38,6 +38,14 @@ const OrbitChainConfig = models.OrbitChainConfig;
 const OrbitWithdrawal = models.OrbitWithdrawal;
 const OrbitDeposit = models.OrbitDeposit;
 
+/**
+ * Retrieves a list of orbit deposits for a workspace
+ * @param {string} workspaceId - The workspace id
+ * @param {number} page - The page number
+ * @param {number} itemsPerPage - The number of items per page
+ * @param {string} order - The order to sort by
+ * @returns {Promise<Array>} - A list of orbit deposits
+ */
 const getWorkspaceOrbitDeposits = async (workspaceId, page, itemsPerPage, order) => {
     if (!workspaceId)
         throw new Error('Missing parameter');
@@ -54,6 +62,14 @@ const getWorkspaceOrbitDeposits = async (workspaceId, page, itemsPerPage, order)
     });
 }
 
+/**
+ * Retrieves the l2 transaction containing an orbit withdrawal
+ * Data will be used to build claim calldata
+ * @param {string} workspaceId - The workspace id
+ * @param {string} hash - The hash of the transaction
+ * @param {number} messsageNumber - The message number of the withdrawal
+ * @returns {Promise<Object>} - The orbit withdrawal
+ */
 const getL2TransactionForOrbitWithdrawalClaim = async (workspaceId, hash, messsageNumber) => {
     if (!workspaceId || !hash)
         throw new Error('Missing parameter');
@@ -248,17 +264,6 @@ const getOrbitBatch = async (workspaceId, batchNumber) => {
     return batch.toJSON();
 };
 
-const getWorkspaceByIdWithOrbitConfig = async (workspaceId) => {
-    if (!workspaceId)
-        throw new Error('Missing parameter');
-
-    const workspace = await Workspace.findByPk(workspaceId, {
-        include: 'orbitConfig'
-    });
-
-    return workspace.toJSON();
-};
-
 /**
  * Retrieves a list of orbit batches for a workspace
  * @param {string} workspaceId - The workspace id
@@ -3410,7 +3415,6 @@ module.exports = {
     getImportedAccounts: getImportedAccounts,
     getFilteredNativeAccounts: getFilteredNativeAccounts,
     getWorkspaceOrbitBatches: getWorkspaceOrbitBatches,
-    getWorkspaceByIdWithOrbitConfig: getWorkspaceByIdWithOrbitConfig,
     getOrbitBatch: getOrbitBatch,
     getOrbitBatchBlocks: getOrbitBatchBlocks,
     getWorkspaceOrbitBatchTransactions: getWorkspaceOrbitBatchTransactions,

run/lib/firebase.js

@@ -68,4 +68,4 @@ module.exports = {
     isOrbitNodeRejectedLog,
     getOrbitCreatedNodeData,
     getOrbitConfirmedNodeData
-};
+};

run/lib/orbitNodes.js

@@ -22,7 +22,6 @@ module.exports = {
 
       await queryInterface.dropTable('orbit_batch_block', { transaction });
 
-      await queryInterface.removeColumn('orbit_chain_configs', 'parentChainRpcServer', { transaction });
       await queryInterface.removeColumn('orbit_chain_configs', 'parentChainType', { transaction });
 
       await queryInterface.sequelize.query('DROP TYPE IF EXISTS "enum_orbit_chain_configs_parentChainType";', { transaction });