feat: add node method to fetch node info

feat: add node method to fetch node info

Author: avivash

packages/homestar/src/index.js

@@ -21,6 +21,7 @@ import * as T from './types.js'
  * @typedef {T.HomestarEvents} HomestarEvents
  * @typedef {T.HomestarOptions} HomestarOptions
  * @typedef {T.Metrics} Metrics
+ * @typedef {T.Node} Node
  * @typedef {T.Health} Health
  * @typedef {T.WorkflowNotification} WorkflowNotification
  * @typedef {T.EventNotification} EventNotification
@@ -91,6 +92,15 @@ export class Homestar extends Emittery {
     })
   }
 
+  /**
+   * Homestar Node info
+   */
+  async node() {
+    return this.#channel.request({
+      method: 'node',
+    })
+  }
+
   /**
    * Homestar Health info
    */

packages/homestar/src/schemas.js

@@ -4,6 +4,7 @@ import { CID as _CID } from 'multiformats/cid'
 /**
  * @typedef {import('zod').z.infer<typeof Receipt>} Receipt
  * @typedef {import('zod').z.infer<typeof Metrics>} Metrics
+ * @typedef {import('zod').z.infer<typeof Node>} Node
  * @typedef {import('zod').z.infer<typeof Health>} Health
  * @typedef {import('zod').z.infer<typeof Invocation>} Invocation
  * @typedef {import('zod').z.infer<typeof Task>} Task
@@ -30,10 +31,11 @@ export const Metrics = z.object({
 
 export const Health = z.object({
   healthy: z.boolean(),
-  // nodeInfo: z.object({
-  //   static: z.object({ peer_id: z.string() }),
-  //   dynamic: z.object({ listeners: z.array(z.string()) }),
-  // }),
+})
+
+export const Node = z.object({
+  static: z.object({ peer_id: z.string() }),
+  dynamic: z.object({ listeners: z.array(z.string()) }),
 })
 
 export const CID = /** @type {typeof z.custom<import('multiformats').CID>} */ (

packages/homestar/src/types.ts

@@ -31,6 +31,7 @@ export interface Receipt<Out> extends Schemas.Receipt {
 export type HomestarService = Service<
   [
     IO<{ method: 'metrics' }, Schemas.Metrics>,
+    IO<{ method: 'node' }, Schemas.Node>,
     IO<{ method: 'health' }, Schemas.Health>,
     IO<{ method: 'subscribe_run_workflow'; params: Workflow[] }, string>,
     IO<{ method: 'subscribe_network_events' }, string>,

packages/homestar/test/homestar.test.js

@@ -53,6 +53,30 @@ test(
   }
 )
 
+test(
+  'should fetch node info from homestar',
+  async function () {
+    const hs = new Homestar({
+      transport: new WebsocketTransport(HS1_URL, {
+        ws: WebSocket,
+      }),
+    })
+
+    const { error, result } = await hs.node()
+
+    if (error) {
+      return assert.fail(error)
+    }
+
+    assert.ok(typeof result.static.peer_id === 'string')
+    assert.ok(Array.isArray(result.dynamic.listeners))
+    hs.close()
+  },
+  {
+    timeout: 30_000,
+  }
+)
+
 test(
   'should fetch health from homestar',
   async function () {
@@ -69,9 +93,7 @@ test(
     }
 
     assert.equal(result.healthy, true)
-    // assert.ok(result.nodeInfo)
-    // assert.ok(typeof result.nodeInfo.static.peer_id === 'string')
-    // assert.ok(Array.isArray(result.nodeInfo.dynamic.listeners))
+
     hs.close()
   },
   {