feat: Add HTTP-RSR to daily retrieval stats (#440)

* add: metric for successful http retrievals * add: metric for successful http retrievals daily * formatting * add: test for successful http retrievals * formatting * add: test for successful http retrievals daily * remove redundant tests * add check for undefined protocol * Update test/evaluate.js Co-authored-by: Miroslav Bajtoš <[email protected]> * use pointerize * add column migration * add EOF * add EOF * remove NL * make column nullable --------- Co-authored-by: Nikolas Haimerl <[email protected]> Co-authored-by: Miroslav Bajtoš <[email protected]>
filecoin-station · Jan 9, 2025 · 3ac022a · 3ac022a
1 parent 679265d
commit 3ac022a
Show file tree

Hide file tree

Showing 7 changed files with 85 additions and 25 deletions.
diff --git a/lib/preprocess.js b/lib/preprocess.js
@@ -27,7 +27,7 @@ export class Measurement {
     this.inet_group = pointerize(m.inet_group)
     this.finished_at = parseDateTime(m.finished_at)
     this.provider_address = pointerize(m.provider_address)
-    this.protocol = pointerize(m.protocol)
+    this.protocol = pointerize(m.protocol?.toLowerCase())
     this.byte_length = m.byte_length
     this.start_at = parseDateTime(m.start_at)
     this.first_byte_at = parseDateTime(m.first_byte_at)

diff --git a/lib/provider-retrieval-result-stats.js b/lib/provider-retrieval-result-stats.js
@@ -16,15 +16,18 @@ const withPgClient = fn => async ({ createPgClient, ...args }) => {
 }
 
 export const build = committees => {
-  /** @type {Map<string, {total: number, successful: number}>} */
+  /** @type {Map<string, {total: number, successful: number, successfulHttp:number}>} */
   const providerRetrievalResultStats = new Map()
   for (const c of committees) {
     // IMPORTANT: include minority results in the calculation
     for (const m of c.measurements) {
       const minerId = m.minerId
-      const retrievalStats = providerRetrievalResultStats.get(minerId) ?? { total: 0, successful: 0 }
+      const retrievalStats = providerRetrievalResultStats.get(minerId) ?? { total: 0, successful: 0, successfulHttp: 0 }
       retrievalStats.total++
-      if (m.retrievalResult === 'OK') retrievalStats.successful++
+      if (m.retrievalResult === 'OK') {
+        retrievalStats.successful++
+        if (m.protocol && m.protocol === 'http') { retrievalStats.successfulHttp++ }
+      }
       providerRetrievalResultStats.set(minerId, retrievalStats)
     }
   }

diff --git a/lib/public-stats.js b/lib/public-stats.js
@@ -38,21 +38,24 @@ export const updatePublicStats = async ({ createPgClient, committees, honestMeas
  * @param {object} stats
  * @param {number} stats.total
  * @param {number} stats.successful
+ * @param {number} stats.successfulHttp
  */
-const updateRetrievalStats = async (pgClient, minerId, { total, successful }) => {
-  debug('Updating public retrieval stats for miner %s: total += %s successful += %s', minerId, total, successful)
+const updateRetrievalStats = async (pgClient, minerId, { total, successful, successfulHttp }) => {
+  debug('Updating public retrieval stats for miner %s: total += %s successful += %s, successful_http += %s', minerId, total, successful, successfulHttp)
   await pgClient.query(`
     INSERT INTO retrieval_stats
-      (day, miner_id, total, successful)
+      (day, miner_id, total, successful, successful_http)
     VALUES
-      (now(), $1, $2, $3)
+      (now(), $1, $2, $3, $4)
     ON CONFLICT(day, miner_id) DO UPDATE SET
       total = retrieval_stats.total + $2,
-      successful = retrieval_stats.successful + $3
+      successful = retrieval_stats.successful + $3,
+      successful_http = retrieval_stats.successful_http + $4
   `, [
     minerId,
     total,
-    successful
+    successful,
+    successfulHttp
   ])
 }
 

diff --git a/migrations/021.do.sucessful-http-retrieval-stats.sql b/migrations/021.do.sucessful-http-retrieval-stats.sql
@@ -0,0 +1 @@
+ALTER TABLE retrieval_stats ADD COLUMN IF NOT EXISTS successful_http INT;
diff --git a/test/evaluate.js b/test/evaluate.js
@@ -96,10 +96,11 @@ describe('evaluate', async function () {
       day: today(),
       miner_id: VALID_TASK.minerId,
       total: 1,
-      successful: 1
+      successful: 1,
+      // None of the measurements use http
+      successful_http: 0
     }])
   })
-
   it('handles empty rounds', async () => {
     const round = new RoundData(0n)
     const setScoresCalls = []

diff --git a/test/provider-retrieval-result-stats.test.js b/test/provider-retrieval-result-stats.test.js
@@ -37,29 +37,33 @@ describe('Provider Retrieval Result Stats', () => {
           measurements: [
             {
               minerId: '0',
-              retrievalResult: 'OK'
+              retrievalResult: 'OK',
+              protocol: 'http'
             },
             {
               minerId: '1',
-              retrievalResult: 'TIMEOUT'
+              retrievalResult: 'TIMEOUT',
+              protocol: 'http'
             }
           ]
         }, {
           measurements: [
             {
               minerId: '0',
-              retrievalResult: 'OK'
+              retrievalResult: 'OK',
+              protocol: 'bitswap'
             },
             {
+              // Should be able to handle and reject undefined protocol
               minerId: '1',
               retrievalResult: 'TIMEOUT'
             }
           ]
         }
       ])
       assert.deepStrictEqual(stats, new Map([
-        ['0', { total: 2, successful: 2 }],
-        ['1', { total: 2, successful: 0 }]
+        ['0', { total: 2, successful: 2, successfulHttp: 1 }],
+        ['1', { total: 2, successful: 0, successfulHttp: 0 }]
       ]))
     })
   })
@@ -137,22 +141,26 @@ describe('Provider Retrieval Result Stats', () => {
             measurements: [
               {
                 minerId: '0',
-                retrievalResult: 'OK'
+                retrievalResult: 'OK',
+                protocol: 'http'
               },
               {
                 minerId: '1',
-                retrievalResult: 'TIMEOUT'
+                retrievalResult: 'TIMEOUT',
+                protocol: 'http'
               }
             ]
           }, {
             measurements: [
               {
                 minerId: '0',
-                retrievalResult: 'OK'
+                retrievalResult: 'OK',
+                protocol: 'bitswap'
               },
               {
                 minerId: '1',
-                retrievalResult: 'TIMEOUT'
+                retrievalResult: 'TIMEOUT',
+                protocol: 'bitswap'
               }
             ]
           }
@@ -168,8 +176,8 @@ describe('Provider Retrieval Result Stats', () => {
         contract_address: ieContractAddress,
         measurement_batches: round.measurementBatches,
         provider_retrieval_result_stats: {
-          0: { successful: 2, total: 2 },
-          1: { successful: 0, total: 2 }
+          0: { successful: 2, total: 2, successfulHttp: 1 },
+          1: { successful: 0, total: 2, successfulHttp: 0 }
         },
         round_details: 'baguqeerawg5jfpiy2g5xp5d422uwa3mpyzkmiguoeecesds7q65mn2hdoa4q',
         round_index: String(round.index),

diff --git a/test/public-stats.test.js b/test/public-stats.test.js
@@ -87,6 +87,50 @@ describe('public-stats', () => {
         { day: today, total: 2 + 3, successful: 1 + 1 }
       ])
     })
+    it('calculates successful http retrievals correctly', async () => {
+      /** @type {Measurement[]} */
+      const honestMeasurements = [
+        { ...VALID_MEASUREMENT, protocol: 'http', retrievalResult: 'OK' },
+        { ...VALID_MEASUREMENT, protocol: 'graphsync', retrievalResult: 'OK' },
+        { ...VALID_MEASUREMENT, protocol: 'http', retrievalResult: 'HTTP_500' },
+        { ...VALID_MEASUREMENT, protocol: 'graphsync', retrievalResult: 'LASSIE_500' }
+      ]
+      const allMeasurements = honestMeasurements
+      let committees = buildEvaluatedCommitteesFromMeasurements(honestMeasurements)
+
+      await updatePublicStats({
+        createPgClient,
+        committees,
+        honestMeasurements,
+        allMeasurements,
+        findDealClients: (_minerId, _cid) => ['f0client']
+      })
+
+      const { rows: created } = await pgClient.query(
+        'SELECT day::TEXT, total, successful, successful_http FROM retrieval_stats'
+      )
+      assert.deepStrictEqual(created, [
+        { day: today, total: 4, successful: 2, successful_http: 1 }
+      ])
+
+      // Let's add another successful http retrieval to make sure the updating process works as expected
+      honestMeasurements.push({ ...VALID_MEASUREMENT, retrievalResult: 'OK', protocol: 'http' })
+      committees = buildEvaluatedCommitteesFromMeasurements(honestMeasurements)
+      await updatePublicStats({
+        createPgClient,
+        committees,
+        honestMeasurements,
+        allMeasurements,
+        findDealClients: (_minerId, _cid) => ['f0client']
+      })
+
+      const { rows: updated } = await pgClient.query(
+        'SELECT day::TEXT, total, successful, successful_http FROM retrieval_stats'
+      )
+      assert.deepStrictEqual(updated, [
+        { day: today, total: 4 + 5, successful: 2 + 3, successful_http: 1 + 2 }
+      ])
+    })
 
     it('creates or updates the row for today - multiple miners', async () => {
       /** @type {Measurement[]} */
@@ -164,10 +208,10 @@ describe('public-stats', () => {
       })
 
       const { rows: created } = await pgClient.query(
-        'SELECT day::TEXT, total, successful FROM retrieval_stats'
+        'SELECT day::TEXT, total, successful, successful_http FROM retrieval_stats'
       )
       assert.deepStrictEqual(created, [
-        { day: today, total: 3, successful: 2 }
+        { day: today, total: 3, successful: 2, successful_http: 0 }
       ])
     })
   })
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE retrieval_stats ADD COLUMN IF NOT EXISTS successful_http INT;