fix pg test bug, naming convention, and error message reliance (#134)

Author: PatrickNercessian

observer/lib/observer.js

@@ -10,27 +10,21 @@ export const observeTransferEvents = async (pgPool, ieContract, provider) => {
   const { rows } = await pgPool.query(
     'SELECT MAX(last_checked_block) FROM daily_reward_transfers'
   )
-  const lastCheckedBlock = rows[0].last_checked_block
+  let queryFromBlock = rows[0].last_checked_block
+  const currentBlockNumber = await provider.getBlockNumber()
 
-  console.log('Querying impact evaluator Transfer events after block', lastCheckedBlock)
-  let events
-  try {
-    events = await ieContract.queryFilter(ieContract.filters.Transfer(), lastCheckedBlock)
-  } catch (error) {
-    console.error('Error querying impact evaluator Transfer events', error)
-    if (error.message.includes('bad tipset height')) {
-      console.log('Block number too old, GLIF only provides last 2000 blocks, querying from -1900')
-      events = await ieContract.queryFilter(ieContract.filters.Transfer(), -1900)
-    } else {
-      throw error
-    }
+  if (!queryFromBlock || queryFromBlock < currentBlockNumber - 1900) {
+    queryFromBlock = currentBlockNumber - 1900
+    console.log('Block number too old, GLIF only provides last 2000 blocks, querying from -1900')
   }
-  const currentBlockNumber = await provider.getBlockNumber()
-  console.log('Current block number:', currentBlockNumber)
+
+  console.log('Querying impact evaluator Transfer events after block', queryFromBlock)
+  const events = await ieContract.queryFilter(ieContract.filters.Transfer(), queryFromBlock)
+
   console.log(`Found ${events.length} Transfer events`)
   for (const event of events) {
     const transferEvent = {
-      to_address: event.args.to,
+      toAddress: event.args.to,
       amount: event.args.amount
     }
     console.log('Transfer event:', transferEvent)

observer/lib/platform-stats.js

@@ -1,7 +1,7 @@
 /**
  * @param {import('pg').Client} pgClient
  * @param {Object} transferEvent
- * @param {string} transferEvent.to_address
+ * @param {string} transferEvent.toAddress
  * @param {number} transferEvent.amount
  * @param {number} currentBlockNumber
  */
@@ -12,5 +12,5 @@ export const updateDailyTransferStats = async (pgClient, transferEvent, currentB
     ON CONFLICT (day, to_address) DO UPDATE SET
       amount = daily_reward_transfers.amount + EXCLUDED.amount,
       last_checked_block = EXCLUDED.last_checked_block
-  `, [transferEvent.to_address, transferEvent.amount, currentBlockNumber])
+  `, [transferEvent.toAddress, transferEvent.amount, currentBlockNumber])
 }

observer/test/platform-stats.test.js

@@ -6,40 +6,46 @@ import { DATABASE_URL } from '../lib/config.js'
 import { updateDailyTransferStats } from '../lib/platform-stats.js'
 import { migrateWithPgClient } from '@filecoin-station/spark-stats-db-migrations'
 
+const createPgClient = async () => {
+  const pgClient = new pg.Client({ connectionString: DATABASE_URL })
+  await pgClient.connect()
+  return pgClient
+}
+
 describe('platform-stats-generator', () => {
-  /** @type {pg.Pool} */
-  let pgPool
+  /** @type {pg.Client} */
+  let pgClient
 
   before(async () => {
-    pgPool = new pg.Pool({ connectionString: DATABASE_URL })
-    await migrateWithPgClient(pgPool)
+    pgClient = await createPgClient()
+    await migrateWithPgClient(pgClient)
   })
 
   let today
   beforeEach(async () => {
-    await pgPool.query('DELETE FROM daily_reward_transfers')
+    await pgClient.query('DELETE FROM daily_reward_transfers')
 
     // Run all tests inside a transaction to ensure `now()` always returns the same value
     // See https://dba.stackexchange.com/a/63549/125312
     // This avoids subtle race conditions when the tests are executed around midnight.
-    await pgPool.query('BEGIN TRANSACTION')
+    await pgClient.query('BEGIN TRANSACTION')
     today = await getCurrentDate()
   })
 
   afterEach(async () => {
-    await pgPool.query('END TRANSACTION')
+    await pgClient.query('END TRANSACTION')
   })
 
   after(async () => {
-    await pgPool.end()
+    await pgClient.end()
   })
 
   describe('updateDailyTransferStats', () => {
     it('should correctly update daily Transfer stats with new transfer events', async () => {
-      await updateDailyTransferStats(pgPool, { to_address: 'address1', amount: 100 }, 1)
-      await updateDailyTransferStats(pgPool, { to_address: 'address1', amount: 200 }, 2)
+      await updateDailyTransferStats(pgClient, { toAddress: 'address1', amount: 100 }, 1)
+      await updateDailyTransferStats(pgClient, { toAddress: 'address1', amount: 200 }, 2)
 
-      const { rows } = await pgPool.query(`
+      const { rows } = await pgClient.query(`
         SELECT day::TEXT, to_address, amount, last_checked_block FROM daily_reward_transfers
         `)
       assert.strictEqual(rows.length, 1)
@@ -49,10 +55,10 @@ describe('platform-stats-generator', () => {
     })
 
     it('should handle multiple addresses in daily Transfer stats', async () => {
-      await updateDailyTransferStats(pgPool, { to_address: 'address1', amount: 50 }, 1)
-      await updateDailyTransferStats(pgPool, { to_address: 'address2', amount: 150 }, 1)
+      await updateDailyTransferStats(pgClient, { toAddress: 'address1', amount: 50 }, 1)
+      await updateDailyTransferStats(pgClient, { toAddress: 'address2', amount: 150 }, 1)
 
-      const { rows } = await pgPool.query(`
+      const { rows } = await pgClient.query(`
         SELECT day::TEXT, to_address, amount, last_checked_block FROM daily_reward_transfers
         ORDER BY to_address
       `)
@@ -66,7 +72,7 @@ describe('platform-stats-generator', () => {
   })
 
   const getCurrentDate = async () => {
-    const { rows: [{ today }] } = await pgPool.query('SELECT now()::DATE::TEXT as today')
+    const { rows: [{ today }] } = await pgClient.query('SELECT now()::DATE::TEXT as today')
     return today
   }
 })

stats/test/platform-routes.test.js

@@ -55,17 +55,17 @@ describe('Platform Routes HTTP request handler', () => {
   describe('GET /stations/daily', () => {
     it('returns daily station metrics for the given date range', async () => {
       await givenDailyStationMetrics(pgPoolEvaluateDb, '2024-01-10', [
-        { station_id: 'station1', accepted_measurement_count: 1 }
+        { stationId: 'station1', acceptedMeasurementCount: 1 }
       ])
       await givenDailyStationMetrics(pgPoolEvaluateDb, '2024-01-11', [
-        { station_id: 'station2', accepted_measurement_count: 1 }
+        { stationId: 'station2', acceptedMeasurementCount: 1 }
       ])
       await givenDailyStationMetrics(pgPoolEvaluateDb, '2024-01-12', [
-        { station_id: 'station2', accepted_measurement_count: 2 },
-        { station_id: 'station3', accepted_measurement_count: 1 }
+        { stationId: 'station2', acceptedMeasurementCount: 2 },
+        { stationId: 'station3', acceptedMeasurementCount: 1 }
       ])
       await givenDailyStationMetrics(pgPoolEvaluateDb, '2024-01-13', [
-        { station_id: 'station1', accepted_measurement_count: 1 }
+        { stationId: 'station1', acceptedMeasurementCount: 1 }
       ])
 
       const res = await fetch(
@@ -89,25 +89,25 @@ describe('Platform Routes HTTP request handler', () => {
     it('returns monthly station metrics for the given date range ignoring the day number', async () => {
       // before the date range
       await givenDailyStationMetrics(pgPoolEvaluateDb, '2023-12-31', [
-        { station_id: 'station1', accepted_measurement_count: 1 }
+        { stationId: 'station1', acceptedMeasurementCount: 1 }
       ])
       // in the date range
       await givenDailyStationMetrics(pgPoolEvaluateDb, '2024-01-10', [
-        { station_id: 'station1', accepted_measurement_count: 1 }
+        { stationId: 'station1', acceptedMeasurementCount: 1 }
       ])
       await givenDailyStationMetrics(pgPoolEvaluateDb, '2024-01-11', [
-        { station_id: 'station2', accepted_measurement_count: 1 }
+        { stationId: 'station2', acceptedMeasurementCount: 1 }
       ])
       await givenDailyStationMetrics(pgPoolEvaluateDb, '2024-01-12', [
-        { station_id: 'station2', accepted_measurement_count: 2 },
-        { station_id: 'station3', accepted_measurement_count: 1 }
+        { stationId: 'station2', acceptedMeasurementCount: 2 },
+        { stationId: 'station3', acceptedMeasurementCount: 1 }
       ])
       await givenDailyStationMetrics(pgPoolEvaluateDb, '2024-02-13', [
-        { station_id: 'station1', accepted_measurement_count: 1 }
+        { stationId: 'station1', acceptedMeasurementCount: 1 }
       ])
       // after the date range
       await givenDailyStationMetrics(pgPoolEvaluateDb, '2024-03-01', [
-        { station_id: 'station1', accepted_measurement_count: 1 }
+        { stationId: 'station1', acceptedMeasurementCount: 1 }
       ])
 
       const res = await fetch(
@@ -130,17 +130,17 @@ describe('Platform Routes HTTP request handler', () => {
   describe('GET /measurements/daily', () => {
     it('returns daily total accepted measurement count for the given date range', async () => {
       await givenDailyStationMetrics(pgPoolEvaluateDb, '2024-01-10', [
-        { station_id: 'station1', accepted_measurement_count: 1 }
+        { stationId: 'station1', acceptedMeasurementCount: 1 }
       ])
       await givenDailyStationMetrics(pgPoolEvaluateDb, '2024-01-11', [
-        { station_id: 'station2', accepted_measurement_count: 1 }
+        { stationId: 'station2', acceptedMeasurementCount: 1 }
       ])
       await givenDailyStationMetrics(pgPoolEvaluateDb, '2024-01-12', [
-        { station_id: 'station2', accepted_measurement_count: 2 },
-        { station_id: 'station3', accepted_measurement_count: 1 }
+        { stationId: 'station2', acceptedMeasurementCount: 2 },
+        { stationId: 'station3', acceptedMeasurementCount: 1 }
       ])
       await givenDailyStationMetrics(pgPoolEvaluateDb, '2024-01-13', [
-        { station_id: 'station1', accepted_measurement_count: 1 }
+        { stationId: 'station1', acceptedMeasurementCount: 1 }
       ])
 
       const res = await fetch(
@@ -163,17 +163,17 @@ describe('Platform Routes HTTP request handler', () => {
   describe('GET /transfers/daily', () => {
     it('returns daily total Rewards sent for the given date range', async () => {
       await givenDailyRewardTransferMetrics(pgPoolStatsDb, '2024-01-10', [
-        { to_address: 'to1', amount: 100, last_checked_block: 1 }
+        { toAddress: 'to1', amount: 100, lastCheckedBlock: 1 }
       ])
       await givenDailyRewardTransferMetrics(pgPoolStatsDb, '2024-01-11', [
-        { to_address: 'to2', amount: 150, last_checked_block: 1 }
+        { toAddress: 'to2', amount: 150, lastCheckedBlock: 1 }
       ])
       await givenDailyRewardTransferMetrics(pgPoolStatsDb, '2024-01-12', [
-        { to_address: 'to2', amount: 300, last_checked_block: 1 },
-        { to_address: 'to3', amount: 250, last_checked_block: 1 }
+        { toAddress: 'to2', amount: 300, lastCheckedBlock: 1 },
+        { toAddress: 'to3', amount: 250, lastCheckedBlock: 1 }
       ])
       await givenDailyRewardTransferMetrics(pgPoolStatsDb, '2024-01-13', [
-        { to_address: 'to1', amount: 100, last_checked_block: 1 }
+        { toAddress: 'to1', amount: 100, lastCheckedBlock: 1 }
       ])
 
       const res = await fetch(
@@ -201,8 +201,8 @@ const givenDailyStationMetrics = async (pgPoolEvaluateDb, day, stationStats) =>
     ON CONFLICT DO NOTHING
     `, [
     day,
-    stationStats.map(s => s.station_id),
-    stationStats.map(s => s.accepted_measurement_count)
+    stationStats.map(s => s.stationId),
+    stationStats.map(s => s.acceptedMeasurementCount)
   ])
 }
 
@@ -213,8 +213,8 @@ const givenDailyRewardTransferMetrics = async (pgPoolStatsDb, day, transferStats
     ON CONFLICT DO NOTHING
     `, [
     day,
-    transferStats.map(s => s.to_address),
+    transferStats.map(s => s.toAddress),
     transferStats.map(s => s.amount),
-    transferStats.map(s => s.last_checked_block)
+    transferStats.map(s => s.lastCheckedBlock)
   ])
 }