chore: use ipld-explorer-components@7.0.2 (#2257)

SgtPooki · lidel · web-flow · commit 99ba9acb51c9 · 2024-09-13T12:41:01.000-07:00
* chore: update ipld-explorer-components

* chore: use ipld-explorer-components@7.0.1

* feat: use latest kubo, kubo-rpc-client, &amp; ipfsd-ctl

* test: debugging tests

* fix(ci): typecheck for kubo-rpc-client

* fix: update ipld-explorer-components and fix explore tests

* chore: remove unused imports

* chore: some minor cleanup

* test: fix RPC e2e tests

* chore: lint fix

* chore: code cleanup and type fixes

* chore: remove unused var in test

* test: fix remote rpc api tests

* chore: PR comments

* chore: lint fix

---------

Co-authored-by: Marcin Rataj &lt;lidel@lidel.org&gt;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -67,14 +67,14 @@
     "ipfs-css": "^1.4.0",
     "ipfs-geoip": "^9.1.0",
     "ipfs-provider": "^2.1.0",
-    "ipld-explorer-components": "^5.2.0",
+    "ipld-explorer-components": "^7.0.2",
     "is-ipfs": "^8.0.1",
     "istextorbinary": "^6.0.0",
     "it-all": "^1.0.5",
     "it-first": "^1.0.6",
     "it-last": "^1.0.5",
     "it-map": "^1.0.5",
-    "kubo-rpc-client": "^3.0.2",
+    "kubo-rpc-client": "^4.1.1",
     "milliseconds": "^1.0.3",
     "money-clip": "^3.0.5",
     "multiformats": "^13.0.1",
@@ -164,10 +164,10 @@
     "http-proxy": "^1.18.1",
     "http-server": "^14.1.1",
     "ipfs": "0.58.3",
-    "ipfsd-ctl": "^13.0.0",
+    "ipfsd-ctl": "^14.1.0",
     "jest": "^28.1.3",
     "jest-environment-jsdom": "^28.1.3",
-    "kubo": "^0.24.0",
+    "kubo": "^0.30.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
     "os-browserify": "^0.3.0",
diff --git a/src/bundles/identity.test.js b/src/bundles/identity.test.js
@@ -29,10 +29,8 @@ describe.skip('identity.js', function () {
     let ipfs
     let ipfsd
     beforeAll(async () => {
-      // const kuboRpcModule = await import('kubo-rpc-client')
-      // console.log('kuboRpcModule: ', kuboRpcModule)
-      const kuboRpcModule = await import('kubo-rpc-client')
-      const { createController } = await import('ipfsd-ctl')
+      const { create } = await import('kubo-rpc-client')
+      const { createNode } = await import('ipfsd-ctl')
       const ipfsBin = (await import('kubo')).default.path()
       console.log('ipfsBin: ', ipfsBin)
       /**
@@ -41,16 +39,16 @@ describe.skip('identity.js', function () {
        */
       const KUBO_PORT = process.env.KUBO_PORT_2033_TEST
       if (KUBO_PORT == null) {
-        ipfsd = await createController({
-          type: 'go',
-          ipfsBin,
-          kuboRpcModule,
+        ipfsd = await createNode({
+          type: 'kubo',
+          bin: ipfsBin,
+          rpc: create,
           test: true,
           disposable: true
         })
         ipfs = ipfsd.api
       } else {
-        ipfs = kuboRpcModule(`https://localhost:${KUBO_PORT}`)
+        ipfs = create(`https://127.0.0.1:${KUBO_PORT}`)
       }
     })
 
diff --git a/src/bundles/ipfs-provider.js b/src/bundles/ipfs-provider.js
@@ -368,7 +368,7 @@ const actions = {
       const result = await getIpfs({
         /**
          *
-         * @param {import('kubo-rpc-client').IPFSHTTPClient} ipfs
+         * @param {import('kubo-rpc-client').KuboRPCClient} ipfs
          * @returns {Promise<boolean>}
          */
         connectionTest: async (ipfs) => {
diff --git a/test/e2e/explore.test.js b/test/e2e/explore.test.js
@@ -19,7 +19,8 @@ const __dirname = dirname(__filename)
  * @param {any} value
  * @param {import('multiformats/block').BlockEncoder<Code, any>} codec
  * @param {import('multiformats/hashes/interface').MultihashHasher<Code>} hasher
- * @returns {CID | null}
+ * @param {import('multiformats/cid').Version} version
+ * @returns {Promise<CID | null>}
  */
 const createCID = async (value, codec, hasher, version = 1) => {
   try {
@@ -60,9 +61,9 @@ async function testExploredCid ({ cid, type, humanReadableCID, page, fillOutForm
 /**
  * Loads saved block fixtures from fixtures/explore/blocks and adds them locally to the ipfs node
  * @param {object} param0
- * @param {import('kubo-rpc-client').IPFSHTTPClient} param0.ipfs
+ * @param {import('kubo-rpc-client').KuboRPCClient} param0.ipfs
  * @param {string|string[]} param0.blockCid
- * @param {object} param0.blockPutArgs
+ * @param {object} [param0.blockPutArgs]
  */
 async function loadBlockFixtures ({ ipfs, blockCid, blockPutArgs = { format: 'v0' } }) {
   try {
@@ -119,19 +120,20 @@ test.describe('Explore screen', () => {
     })
 
     test('should open dag-pb', async ({ page }) => {
+      test.setTimeout(60000)
       const cidData = new Uint8Array(Buffer.from('hello world'))
       const dagPbAsDagJson = {
         Data: cidData,
         Links: []
       }
-      const cid = await createCID(dagPbAsDagJson, dagPb, sha256, 0)
+      const cid = await createCID(dagPbAsDagJson, dagPb, sha256, 0) // QmU1Sq1B7RPQD2XcQNLB58qJUyJffVJqihcxmmN1STPMxf
 
       // add bytes to backend node so that explore page can load the content
       const cidInstance = await ipfs.dag.put(dagPbAsDagJson, {
         storeCodec: 'dag-pb',
         hashAlg: 'sha2-256'
       })
-      const dagPbCid = cidInstance.toString()
+      const dagPbCid = cidInstance.toString() // bafybeicuhktpnonfgpel7acwqcim34slne5kul43k5fdg6cnqrrp3rkxtq
 
       await testExploredCid({
         page,
@@ -174,7 +176,7 @@ test.describe('Explore screen', () => {
     })
 
     test('should open dag-pb unixFS XKCD Archives', async ({ page }) => {
-      test.setTimeout(60000)
+      test.setTimeout(120000)
       await loadBlockFixtures({
         ipfs,
         blockCid: [
@@ -212,7 +214,7 @@ test.describe('Explore screen', () => {
     })
 
     test('should explore Project Apollo Archive', async ({ page }) => {
-      test.setTimeout(90000)
+      test.setTimeout(240000)
       await loadBlockFixtures({
         ipfs,
         blockCid: [
diff --git a/test/e2e/fixtures/generateFixtures.sh b/test/e2e/fixtures/generateFixtures.sh
@@ -8,7 +8,7 @@ save_fixture() {
   shift
   local fixture_path="$1/$fixture_cid"
   echo -e "\$fixture_path: $fixture_path \n"
-  ipfs block get $fixture_cid > $fixture_path
+  npx kubo block get $fixture_cid > $fixture_path
 }
 
 # Example call:
diff --git a/test/e2e/ipns.test.js b/test/e2e/ipns.test.js
@@ -1,7 +1,7 @@
 import { test, expect } from './setup/coverage.js'
-import { createController } from 'ipfsd-ctl'
-import { path as getGoIpfsPath } from 'kubo'
-import * as kuboRpcModule from 'kubo-rpc-client'
+import { createNode } from 'ipfsd-ctl'
+import { path as kuboPath } from 'kubo'
+import { create } from 'kubo-rpc-client'
 
 // TODO: Fix parallelism of these tests
 test.describe.configure({ mode: 'serial' })
@@ -12,10 +12,10 @@ test.describe('IPNS publishing', () => {
 
   test.beforeAll(async () => {
     // spawn a second ephemeral local node as a peer for ipns publishing
-    ipfsd = await createController({
-      type: 'go',
-      ipfsBin: getGoIpfsPath(),
-      kuboRpcModule,
+    ipfsd = await createNode({
+      type: 'kubo',
+      bin: process.env.IPFS_GO_EXEC || kuboPath(),
+      rpc: create,
       test: true,
       disposable: true
     })
@@ -26,7 +26,7 @@ test.describe('IPNS publishing', () => {
   test.describe('Settings screen', () => {
     let ipfs
     test.beforeEach(async ({ page }) => {
-      ipfs = kuboRpcModule.create(process.env.IPFS_RPC_ADDR)
+      ipfs = create(process.env.IPFS_RPC_ADDR)
       await page.goto('/#/settings')
     })
     test('should list IPNS keys', async ({ page }) => {
@@ -76,7 +76,7 @@ test.describe('IPNS publishing', () => {
     let ipfs
     test.beforeEach(async ({ page }) => {
       keyName = 'pet-name-e2e-ipns-test-' + new Date().getTime() + Math.random().toString(16).slice(2)
-      ipfs = kuboRpcModule.create(process.env.IPFS_RPC_ADDR)
+      ipfs = create(process.env.IPFS_RPC_ADDR)
       await ipfs.key.gen(keyName)
       await page.goto('/#/files')
       await page.reload()
diff --git a/test/e2e/peers.test.js b/test/e2e/peers.test.js
@@ -1,7 +1,7 @@
 import { test } from './setup/coverage.js'
-import { createController } from 'ipfsd-ctl'
-import * as kuboRpcModule from 'kubo-rpc-client'
-import { path as getGoIpfsPath } from 'kubo'
+import { createNode } from 'ipfsd-ctl'
+import { create } from 'kubo-rpc-client'
+import { path as kuboPath } from 'kubo'
 
 const addConnection = 'text=Add connection'
 
@@ -10,18 +10,18 @@ test.describe('Peers screen', () => {
   let peeraddr
   test.beforeAll(async () => {
     // spawn an ephemeral local node for manual swarm connect test
-    ipfsd = await createController({
-      type: 'go',
-      ipfsBin: getGoIpfsPath(),
-      kuboRpcModule,
+    ipfsd = await createNode({
+      type: 'kubo',
+      bin: process.env.IPFS_GO_EXEC || kuboPath(),
+      rpc: create,
       test: true,
       disposable: true
     })
     const { addresses } = await ipfsd.api.id()
     peeraddr = addresses.find((ma) => ma.toString().startsWith('/ip4/127.0.0.1')).toString()
 
     // connect ipfs-backend used by webui to this new peer to have something  in the peer table
-    const webuiIpfs = kuboRpcModule.create(process.env.IPFS_RPC_ADDR)
+    const webuiIpfs = create(process.env.IPFS_RPC_ADDR)
     await webuiIpfs.swarm.connect(peeraddr)
   })
 
diff --git a/test/e2e/remote-rpc-api.test.js b/test/e2e/remote-rpc-api.test.js
@@ -1,14 +1,18 @@
+// @ts-check
 import { test, expect } from './setup/coverage.js'
-import { createController } from 'ipfsd-ctl'
-import getPort from 'get-port'
+import { createNode } from 'ipfsd-ctl'
+import getPort from 'aegir/get-port'
 import { createServer } from 'http'
 import httpProxy from 'http-proxy'
 import basicAuth from 'basic-auth'
 import { multiaddrToUri as toUri } from '@multiformats/multiaddr-to-uri'
-import { path as getGoIpfsPath } from 'kubo'
-import * as kuboRpcModule from 'kubo-rpc-client'
+import { path as kuboPath } from 'kubo'
+import { create } from 'kubo-rpc-client'
 const { createProxyServer } = httpProxy
 
+// we need these tests to run in serial otherwise we try to start up two nodes on the same port
+test.describe.configure({ mode: 'serial' })
+
 test.describe('Remote RPC API tests', () => {
   // Basic Auth Proxy Setup
   // -----------------------------------
@@ -24,16 +28,32 @@ test.describe('Remote RPC API tests', () => {
   let password
   let proxyPort
 
-  let rpcMaddr
+  let rpcPort
+  let rpcAddr
   let rpcUrl
   let rpcId
 
   test.beforeAll(async () => {
-  // spawn an ephemeral local node to ensure we connect to a different, remote node
-    ipfsd = await createController({
-      type: 'go',
-      ipfsBin: getGoIpfsPath(),
-      kuboRpcModule,
+    rpcPort = await getPort(55055, '0.0.0.0')
+    rpcAddr = `/ip4/127.0.0.1/tcp/${rpcPort}`
+    // spawn an ephemeral local node to ensure we connect to a different, remote node
+    ipfsd = await createNode({
+      type: 'kubo',
+      bin: kuboPath(),
+      rpc: create,
+      init: {
+        config: {
+          Addresses: {
+            API: rpcAddr
+          },
+          Gateway: {
+            NoFetch: true
+          },
+          Routing: {
+            Type: 'none'
+          }
+        }
+      },
       test: true,
       disposable: true
     })
@@ -46,8 +66,7 @@ test.describe('Remote RPC API tests', () => {
     password = 'pass'
 
     const proxy = createProxyServer()
-    rpcMaddr = ipfsd.apiAddr.toString()
-    const remoteApiUrl = toUri(rpcMaddr, { assumeHttp: true })
+    const remoteApiUrl = toUri(rpcAddr, { assumeHttp: true })
     rpcUrl = new URL(remoteApiUrl).toString() // normalization for browsers
     proxy.on('proxyReq', (proxyReq, req, res, options) => {
     // swap Origin before passing to the real API
@@ -57,21 +76,19 @@ test.describe('Remote RPC API tests', () => {
       proxyReq.setHeader('Host', new URL(remoteApiUrl).host)
     })
 
-    proxy.on('error', function (err, req, res) {
+    proxy.on('error', function (err, req, /** @type {import('http').ServerResponse} */ res) {
       res.writeHead(500, { 'Content-Type': 'text/plain' })
       res.end(`proxyd error: ${JSON.stringify(err)}`)
     })
 
     proxyd = createServer((req, res) => {
-    // console.log(`${req.method}\t\t${req.url}`)
-
-      res.oldWriteHead = res.writeHead
+      const oldWriteHead = res.writeHead.bind(res)
       res.writeHead = function (statusCode, headers) {
       // hardcoded liberal CORS for easier testing
         res.setHeader('Access-Control-Allow-Origin', '*')
         // usual suspects + 'authorization' header
         res.setHeader('Access-Control-Allow-Headers', 'X-Stream-Output, X-Chunked-Output, X-Content-Length, authorization')
-        res.oldWriteHead(statusCode)
+        return oldWriteHead(statusCode)
       }
 
       const auth = basicAuth(req)
@@ -139,8 +156,7 @@ test.describe('Remote RPC API tests', () => {
           endpoint = uri.port || endpoint
         }
       } catch (_) {}
-      // await page.waitForFunction(`localStorage.getItem('ipfsApi') && localStorage.getItem('ipfsApi').includes('${endpoint}')`)
-      await page.waitForFunction(endpoint => window.localStorage.getItem('ipfsApi') && window.localStorage.getItem('ipfsApi').includes(endpoint), endpoint)
+      await page.waitForFunction(endpoint => window.localStorage.getItem('ipfsApi')?.includes(endpoint), endpoint)
       return
     }
     await page.waitForFunction(() => window.localStorage.getItem('ipfsApi') === null)
@@ -203,19 +219,19 @@ test.describe('Remote RPC API tests', () => {
 
   test.describe('RPC @ multiaddr', () => {
     test('should be possible to set via Settings page', async ({ page }) => {
-      await switchIpfsApiEndpointViaSettings(rpcMaddr, page)
+      await switchIpfsApiEndpointViaSettings(rpcAddr, page)
       await expectPeerIdOnStatusPage(rpcId, page)
     })
 
     test('should show full multiaddr on Status page', async ({ page }) => {
-      await switchIpfsApiEndpointViaSettings(rpcMaddr, page)
-      await expectHttpApiAddressOnStatusPage(rpcMaddr, page)
+      await switchIpfsApiEndpointViaSettings(rpcAddr, page)
+      await expectHttpApiAddressOnStatusPage(rpcAddr, page)
       await expectPeerIdOnStatusPage(rpcId, page)
     })
 
     test('should show full multiaddr on Settings page', async ({ page }) => {
-      await switchIpfsApiEndpointViaSettings(rpcMaddr, page)
-      await expectHttpApiAddressOnSettingsPage(rpcMaddr, page)
+      await switchIpfsApiEndpointViaSettings(rpcAddr, page)
+      await expectHttpApiAddressOnSettingsPage(rpcAddr, page)
     })
   })
 
diff --git a/test/e2e/setup/global-setup.js b/test/e2e/setup/global-setup.js
@@ -50,7 +50,7 @@ const globalSetup = async config => {
   const rpcEndpoint = `${apiOpts.protocol}://${apiOpts.host}:${apiOpts.port}`
 
   await page.context().addInitScript(({ kuboGateway, rpcEndpoint }) => {
-    localStorage.setItem('kuboGateway', JSON.stringify(kuboGateway))
+    localStorage.setItem('kuboGateway', JSON.stringify({ ...kuboGateway, trustlessBlockBrokerConfig: { init: { allowInsecure: true, allowLocal: true } } }))
     localStorage.setItem('ipfsApi', JSON.stringify(rpcEndpoint))
     localStorage.setItem('explore.ipld.gatewayEnabled', 'false') // disable gateway network requests when testing e2e
   }, { rpcEndpoint, kuboGateway })
diff --git a/test/e2e/setup/ipfs-backend.js b/test/e2e/setup/ipfs-backend.js

Original file line number	Diff line number	Diff line change
`@@ -368,7 +368,7 @@ const actions = {`
`368`	`368`	`const result = await getIpfs({`
`369`	`369`	`/**`
`370`	`370`	`*`
`371`		`- * @param {import('kubo-rpc-client').IPFSHTTPClient} ipfs`
	`371`	`+ * @param {import('kubo-rpc-client').KuboRPCClient} ipfs`
`372`	`372`	`* @returns {Promise<boolean>}`
`373`	`373`	`*/`
`374`	`374`	`connectionTest: async (ipfs) => {`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ save_fixture() {`
`8`	`8`	`shift`
`9`	`9`	`local fixture_path="$1/$fixture_cid"`
`10`	`10`	`echo -e "\$fixture_path: $fixture_path \n"`
`11`		`- ipfs block get $fixture_cid > $fixture_path`
	`11`	`+ npx kubo block get $fixture_cid > $fixture_path`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`# Example call:`