feat: Add list nodes tests (#16)

* Add tests for listing arweave nodes

* Remove redundant test

* format

* Update tests/nodes.test.js

Co-authored-by: Miroslav Bajtoš <oss@bajtos.net>

---------

Co-authored-by: Miroslav Bajtoš <oss@bajtos.net>

Author: pyropy

lib/nodes.js

@@ -0,0 +1,54 @@
+const IP_ADDRESS_REGEX = /^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}$/
+
+export const getNodes = async (fetchNodes = fetchNodesFromViewblock) => {
+  // TODO: Find a publicly documented API
+  const docs = []
+  let maxPage = Infinity
+  for (let page = 0; page < maxPage; page++) {
+    const res = await fetchNodes(page)
+    const body = await res.json()
+    if (maxPage === Infinity) {
+      maxPage = body.pages
+    }
+    docs.push(...body.docs)
+  }
+  const nodes = [
+    {
+      host: 'arweave.net',
+      port: 443,
+      protocol: 'https'
+    },
+    ...docs
+      .map(doc => doc.id)
+      .filter(Boolean)
+      .map(addr => {
+        const [host, port] = addr.split(':')
+        const protocol = IP_ADDRESS_REGEX.test(host) ? 'http' : 'https'
+        return {
+          host,
+          port: port
+            ? Number(port)
+            : protocol === 'http' ? 80 : 443,
+          protocol
+        }
+      })
+  ]
+  console.log(`Found ${nodes.length} nodes`)
+  return nodes
+}
+
+/**
+ * Fetches arweave nodes from the ViewBlock API
+ *
+ * @param {number} page
+ */
+const fetchNodesFromViewblock = (page) => {
+  return fetch(
+    `https://api.viewblock.io/arweave/nodes?page=${page}&network=mainnet`,
+    {
+      headers: {
+        Origin: 'https://viewblock.io'
+      }
+    }
+  )
+}

main.js

@@ -2,8 +2,8 @@
 
 import './vendor/arweave.js'
 import pTimeout from './vendor/p-timeout.js'
+import { getNodes } from './lib/nodes.js'
 
-const IP_ADDRESS_REGEX = /^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}$/
 const ONE_MINUTE = 60_000
 const MEASUREMENT_DELAY = ONE_MINUTE
 const UPDATE_NODES_DELAY = 10 * ONE_MINUTE
@@ -16,50 +16,6 @@ const RANDOM_TRANSACTION_IDS = [
 ]
 const RETRIEVE_TIMEOUT = 10_000
 
-const getNodes = async () => {
-  // TODO: Find a publicly documented API
-  const docs = []
-  let maxPage = Infinity
-  for (let page = 0; page < maxPage; page++) {
-    const res = await fetch(
-      `https://api.viewblock.io/arweave/nodes?page=${page + 1}&network=mainnet`,
-      {
-        headers: {
-          Origin: 'https://viewblock.io'
-        }
-      }
-    )
-    const body = await res.json()
-    if (maxPage === Infinity) {
-      maxPage = body.pages
-    }
-    docs.push(...body.docs)
-  }
-  const nodes = [
-    {
-      host: 'arweave.net',
-      port: 443,
-      protocol: 'https'
-    },
-    ...docs
-      .map(doc => doc.id)
-      .filter(Boolean)
-      .map(addr => {
-        const [host, port] = addr.split(':')
-        const protocol = IP_ADDRESS_REGEX.test(host) ? 'http' : 'https'
-        return {
-          host,
-          port: port
-            ? Number(port)
-            : protocol === 'http' ? 80 : 443,
-          protocol
-        }
-      })
-  ]
-  console.log(`Found ${nodes.length} nodes`)
-  return nodes
-}
-
 const measure = async node => {
   const arweave = Arweave.init(node)
   const txId = RANDOM_TRANSACTION_IDS[Math.floor(Math.random() * RANDOM_TRANSACTION_IDS.length)]

test.js

@@ -1 +1 @@
-import './tests/example.test.js'
+import './tests/nodes.test.js'

tests/example.test.js

@@ -0,0 +1,57 @@
+import { test } from 'zinnia:test'
+import { assertEquals } from 'zinnia:assert'
+import { getNodes } from '../lib/nodes.js'
+
+test('should return arweave.net node by default', async () => {
+  const mockFetch = (pages) => {
+    return Promise.resolve({
+      json: () => ({
+        pages: 1,
+        docs: []
+      })
+    })
+  }
+
+  const nodes = await getNodes(mockFetch)
+  assertEquals(nodes, [{
+    host: 'arweave.net', port: 443, protocol: 'https'
+  }])
+})
+
+test('should return nodes from all pages with a custom fetch function', async () => {
+  const mockFetch = (page) => {
+    if (page === 0) {
+      return Promise.resolve({
+        json: () => ({
+          pages: 2,
+          docs: [
+            { id: '127.0.0.1:1984' },
+            { id: '127.0.0.1:1986' },
+            {}
+          ]
+        })
+      })
+    }
+
+    return Promise.resolve({
+      json: () => ({
+        pages: 2,
+        docs: [
+          { id: '127.0.0.1' },
+          { id: 'test.arweave.net' },
+          { id: '' }
+        ]
+      })
+    })
+  }
+
+  const nodes = await getNodes(mockFetch)
+  assertEquals(nodes.length, 5)
+  assertEquals(nodes, [
+    { host: 'arweave.net', port: 443, protocol: 'https' },
+    { host: '127.0.0.1', port: 1984, protocol: 'http' },
+    { host: '127.0.0.1', port: 1986, protocol: 'http' },
+    { host: '127.0.0.1', port: 80, protocol: 'http' },
+    { host: 'test.arweave.net', port: 443, protocol: 'https' }
+  ])
+})