refactor: retrieval helpers in a shared package

package.json

@@ -13,6 +13,7 @@
     "workflows",
     "usage-reporter",
     "payment-settler",
+    "retrieval",
     "stats-api"
   ],
   "scripts": {

piece-retriever/bin/piece-retriever.js

@@ -1,4 +1,10 @@
-import { isValidEthereumAddress } from '../lib/address.js'
+import {
+  isValidEthereumAddress,
+  httpAssert,
+  setContentSecurityPolicy,
+  getBadBitsEntry,
+} from '@filbeam/retrieval'
+
 import { parseRequest } from '../lib/request.js'
 import {
   retrieveFile as defaultRetrieveFile,
@@ -9,9 +15,6 @@ import {
   logRetrievalResult,
   updateDataSetStats,
 } from '../lib/store.js'
-import { httpAssert } from '../lib/http-assert.js'
-import { setContentSecurityPolicy } from '../lib/content-security-policy.js'
-import { getBadBitsEntry } from '../lib/bad-bits-util.js'
 
 export default {
   /**

piece-retriever/lib/request.js

@@ -1,4 +1,4 @@
-import { httpAssert } from './http-assert.js'
+import { httpAssert } from '@filbeam/retrieval'
 
 /**
  * Parse params found in path of the request URL

piece-retriever/lib/store.js

@@ -1,4 +1,4 @@
-import { httpAssert } from './http-assert.js'
+import { httpAssert } from '@filbeam/retrieval'
 
 /**
  * Logs the result of a file retrieval attempt to the D1 database.

piece-retriever/package.json

@@ -12,5 +12,8 @@
     "deploy:mainnet": "wrangler deploy --env mainnet",
     "start": "wrangler d1 migrations apply dev-db --local --env dev --cwd ../db && wrangler dev --env dev",
     "test": "wrangler d1 migrations apply test-db --local --cwd ../db && vitest run"
+  },
+  "dependencies": {
+    "@filbeam/retrieval": "^1.0.0"
   }
 }

piece-retriever/test/test-helpers.js

@@ -1,5 +1,5 @@
 import { DNS_ROOT } from './retriever.test'
-import { getBadBitsEntry } from '../lib/bad-bits-util'
+import { getBadBitsEntry } from '@filbeam/retrieval'
 
 /**
  * @param {string} payerWalletAddress

piece-retriever/tsconfig.json

@@ -7,5 +7,9 @@
   },
   "include": ["**/*.ts", "**/*.js", "src/**/*.json"],
   "exclude": ["dist", "test"],
-  "references": []
+  "references": [
+    {
+      "path": "../retrieval/tsconfig.json"
+    }
+  ]
 }

retrieval/index.js

@@ -0,0 +1,4 @@
+export * from './lib/address.js'
+export * from './lib/bad-bits-util.js'
+export * from './lib/content-security-policy.js'
+export * from './lib/http-assert.js'

piece-retriever/lib/bad-bits-util.js → retrieval/lib/bad-bits-util.js

@@ -10,18 +10,3 @@ export async function getBadBitsEntry(cid) {
     .join('')
   return hashHex
 }
-
-/**
- * @param {{ DB: D1Database }} env
- * @param {string} cid
- * @returns {Promise<boolean>}
- */
-export async function findInBadBits(env, cid) {
-  const badBitsEntry = await getBadBitsEntry(cid)
-
-  const result = await env.DB.prepare('SELECT * FROM bad_bits WHERE hash = ?')
-    .bind(badBitsEntry)
-    .all()
-
-  return result.results.length > 0
-}

retrieval/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@filbeam/retrieval",
+  "version": "1.0.0",
+  "private": true,
+  "description": "FilBeam retrieval helpers",
+  "author": "Space Meridian <filbeam@meridian.space>",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "test": "vitest run"
+  }
+}

piece-retriever/test/address.test.js → retrieval/test/address.test.js

@@ -2,6 +2,7 @@ import { describe, it, expect } from 'vitest'
 import { isValidEthereumAddress } from '../lib/address.js'
 
 describe('isValidEthereumAddress', () => {
+  /** @type {{ name: string; input: string; expected: boolean }[]} */
   const cases = [
     {
       name: 'valid lowercase address',

retrieval/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "../tsconfig.base.json",
+  "compilerOptions": {
+    "composite": true,
+    "outDir": "dist"
+  },
+  "include": ["**/*.js"],
+  "exclude": ["dist"],
+  "references": []
+}

tsconfig.json

@@ -27,6 +27,9 @@
     {
       "path": "payment-settler/tsconfig.json"
     },
+    {
+      "path": "retrieval/tsconfig.json"
+    },
     {
       "path": "stats-api/tsconfig.json"
     }

vitest.workspace.js

@@ -8,5 +8,6 @@ export default defineWorkspace([
   'workflows',
   'usage-reporter',
   'payment-settler',
+  'retrieval',
   'stats-api',
 ])