add an ipfs worker message

src/schema.mjs

@@ -125,6 +125,47 @@ export const jsonrpc = {
   ],
 };
 
+export const ipfs = {
+  type: "object",
+  properties: {
+    type: {
+      type: "string",
+      enum: ["ipfs"],
+    },
+    commissioner: {
+      type: "string",
+    },
+    version: {
+      type: "string",
+    },
+    options: {
+      type: "object",
+      properties: {
+        timeout: {
+          $comment: "temporal unit is milliseconds",
+          type: "integer",
+        },
+        uri: { type: "string" },
+        gateway: {
+          type: "string",
+          pattern: "^.+ipfs/$",
+          $comment: "http gateway for ipfs should end with ipfs/",
+        },
+      },
+      required: ["uri", "gateway"],
+    },
+    results: {
+      type: "object",
+      nullable: true,
+    },
+    error: {
+      type: "string",
+      nullable: true,
+    },
+  },
+  required: ["type", "commissioner", "version", "error", "results", "options"],
+};
+
 export const exit = {
   type: "object",
   required: ["type", "version"],
@@ -140,7 +181,7 @@ export const exit = {
 };
 
 export const workerMessage = {
-  oneOf: [https, graphql, jsonrpc, exit],
+  oneOf: [https, graphql, jsonrpc, ipfs, exit],
 };
 
 export const config = {

test/schema_test.mjs

@@ -16,6 +16,7 @@ import {
   manifestations,
   config,
   crawlPath,
+  ipfs,
 } from "../src/schema.mjs";
 
 const ajv = new Ajv();
@@ -331,3 +332,40 @@ test("if crawl path validator throws if transformer.args[0] isn't a string", (t)
   t.true(check.errors[0].instancePath.includes("transformer/args/0"));
   t.is(check.errors[0].message, "must be string");
 });
+
+test("should be a valid ipfs message", async (t) => {
+  const check = ajv.compile(ipfs);
+  const message = {
+    options: {
+      uri: "ipfs://Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu",
+      gateway: `https://ipfs.io/ipfs/`,
+    },
+    version: "1.0.0",
+    type: "ipfs",
+    commissioner: "test",
+    results: null,
+    error: null,
+  };
+
+  const valid = check(message);
+  t.true(valid);
+});
+
+test("ipfs message url should end with ipfs/", async (t) => {
+  const check = ajv.compile(ipfs);
+  const message = {
+    options: {
+      uri: "ipfs://Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu",
+      gateway: `https://ipfs.io/`,
+    },
+    version: "1.0.0",
+    type: "ipfs",
+    commissioner: "test",
+    results: null,
+    error: null,
+  };
+
+  const valid = check(message);
+  t.false(valid);
+  t.true(check.errors[0].instancePath.includes("/options/gateway"));
+});