cleanup: simplify ipfs upload function

signer: add option to cache sig for hash, to get consistent wacz results when downloading / saving to ipfs
bump to 0.1.5

Author: ikreymer

package.json

@@ -7,7 +7,7 @@
     "type": "git",
     "url": "git+https://github.com/webrecorder/awp-sw.git"
   },
-  "version": "0.1.4",
+  "version": "0.1.5",
   "license": "AGPL-3.0-or-later",
   "exports": {
     ".": "./src/index.js"
@@ -18,7 +18,7 @@
   "dependencies": {
     "@ipld/car": "^5.0.1",
     "@ipld/unixfs": "^2.0.0",
-    "@webrecorder/wabac": "^2.13.9",
+    "@webrecorder/wabac": "^2.13.10",
     "client-zip": "^2.3.0",
     "hash-wasm": "^4.9.0",
     "idb": "^7.1.1",

src/api.js

@@ -28,10 +28,10 @@ class ExtAPI extends API
     };
   }
 
-  get downloaderOpts() {
+  downloaderOpts() {
     const softwareString = this.softwareString;
 
-    const signer = new Signer(softwareString);
+    const signer = new Signer(softwareString, {cacheSig: true});
 
     return {softwareString, signer};
   }
@@ -50,7 +50,7 @@ class ExtAPI extends API
       const format = params._query.get("format") || "wacz";
       let filename = params._query.get("filename");
 
-      const dl = new Downloader({...this.downloaderOpts, coll, format, filename, pageList});
+      const dl = new Downloader({...this.downloaderOpts(), coll, format, filename, pageList});
       return dl.download();
     }
 
@@ -96,9 +96,11 @@ class ExtAPI extends API
 
     const client = await self.clients.get(event.clientId);
 
-    const opts = {...this.downloaderOpts, customSplits: body.customSplits};
+    const p = runIPFSAdd(collId, coll, client, this.downloaderOpts(), this.collections, body);
 
-    new IPFSAdd(collId, coll, client, opts, this.collections).run(body);
+    if (event.waitUntil) {
+      event.waitUntil(p);
+    }
 
     return {collId};
   }
@@ -150,7 +152,7 @@ class ExtAPI extends API
   }
 
   async getPublicKey() {
-    const signer = new Signer();
+    const { signer } = this.downloaderOpts();
     const keys = await signer.loadKeys();
     if (!keys || !keys.public) {
       return {};
@@ -161,44 +163,27 @@ class ExtAPI extends API
 }
 
 // ===========================================================================
-class IPFSAdd
-{
-  constructor(collId, coll, client, opts, collections) {
-    this.collId = collId;
-    this.coll = coll;
-    this.client = client;
-    this.opts = opts;
-    this.collections = collections;
-
-    this.size = 0;
-  }
+async function runIPFSAdd(collId, coll, client, opts, collections, replayOpts) {
+  let size = 0;
 
-  async run(replayOpts) {
-    const {url, cid} = await ipfsAdd(this.coll, this.opts, replayOpts, (size) => this.progress(size));
-    const result = {cid, ipfsURL: url};
-
-    if (this.client) {
-      this.client.postMessage({
-        type: "ipfsAdd",
-        collId: this.collId,
-        size: this.size,
-        result
+  const sendMessage = (type, result = null) => {
+    if (client) {
+      client.postMessage({
+        type, collId, size, result
       });
     }
+  };
 
-    await this.collections.updateMetadata(this.coll.name, this.coll.config.metadata);
-  }
+  const {url, cid} = await ipfsAdd(coll, opts, replayOpts, (incSize) => {
+    size += incSize;
+    sendMessage("ipfsProgress");
+  });
 
-  progress(incSize) {
-    this.size += incSize;
-    if (this.client) {
-      this.client.postMessage({
-        type: "ipfsProgress",
-        collId: this.collId,
-        size: this.size,
-      });
-    }
-  }
+  const result = {cid, ipfsURL: url};
+
+  sendMessage("ipfsAdd", result);
+
+  await collections.updateMetadata(coll.name, coll.config.metadata);
 }
 
 export { ExtAPI };

src/ipfsutils.js

@@ -18,7 +18,7 @@ export async function ipfsAdd(coll, downloaderOpts = {}, replayOpts = {}, progre
 
   const filename = "webarchive.wacz";
 
-  if (downloaderOpts.customSplits) {
+  if (replayOpts.customSplits) {
     const ZIP = new Uint8Array([]);
     const WARC_PAYLOAD = new Uint8Array([]);
     const WARC_GROUP = new Uint8Array([]);
@@ -397,7 +397,7 @@ function getReplayHtml(waczPath, replayOpts = {}) {
     </style>
   </head>
   <body>${showEmbed ? `
-    <replay-web-page ${deepLink ? "deepLink=\"true\" " : ""}url="${pageUrl}" loading="${loading || ''}" embed="replay-with-info" src="${waczPath}"></replay-web-page>` : `
+    <replay-web-page ${deepLink ? "deepLink=\"true\" " : ""}url="${pageUrl}" loading="${loading || ""}" embed="replay-with-info" src="${waczPath}"></replay-web-page>` : `
     <replay-app-main source="${waczPath}"></replay-app-main>`
 }
   </body>

src/keystore.js

@@ -59,13 +59,13 @@ export class KeyStore
   }
 }
 
-
 // ====================================================================
 export class Signer
 {
-  constructor(softwareString) {
+  constructor(softwareString, opts = {}) {
     this._store = new KeyStore();
     this.softwareString = softwareString || "ArchiveWeb.page";
+    this.cacheSig = opts.cacheSig;
   }
 
   close() {
@@ -112,14 +112,17 @@ export class Signer
       keyPair.publicKey = await crypto.subtle.importKey("spki", publicKey, ecdsaImportParams, true, ["verify"]);
     }
 
-    const data = new TextEncoder().encode(string);
+    let signature = this.cacheSig ? await this.loadSig(string) : null;
 
-    let signature = await crypto.subtle.sign(ecdsaSignParams, keyPair.privateKey, data);
+    if (!signature) {
+      const data = new TextEncoder().encode(string);
+      signature = await crypto.subtle.sign(ecdsaSignParams, keyPair.privateKey, data);
+      signature = encodeBase64(new Uint8Array(signature));
+      await this.saveSig(string, signature);
+    }
 
     //console.log("verify", await crypto.subtle.verify(ecdsaSignParams, keyPair.publicKey, signature, data));
 
-    signature = encodeBase64(new Uint8Array(signature));
-
     return {
       hash: string,
       signature,
@@ -129,6 +132,15 @@ export class Signer
     };
   }
 
+  async saveSig(id, sig) {
+    return await this._store.put({id, sig});
+  }
+
+  async loadSig(id) {
+    const res = await this._store.get(id);
+    return res && res.sig;
+  }
+
   async saveKeys(keys, id = "_userkey") {
     return await this._store.put({id, keys});
   }

yarn.lock

@@ -495,10 +495,10 @@
   resolved "https://registry.yarnpkg.com/@webpack-cli/serve/-/serve-2.0.0.tgz#f08ea194e01ed45379383a8886e8c85a65a5f26a"
   integrity sha512-Rumq5mHvGXamnOh3O8yLk1sjx8dB30qF1OeR6VC00DIR6SLJ4bwwUGKC4pE7qBFoQyyh0H9sAg3fikYgAqVR0w==
 
-"@webrecorder/wabac@^2.13.9":
-  version "2.13.9"
-  resolved "https://registry.yarnpkg.com/@webrecorder/wabac/-/wabac-2.13.9.tgz#7c01777231386c714a984fadfd55340848bfbfca"
-  integrity sha512-ozaO4fs4XwgbueQkwS+8ghHjhpp/iP3R7dCZJ09BWgowI5hMwjJY0KAKjWbFVDH1RQ4cPkh8KPQWAdI+x2wR2g==
+"@webrecorder/wabac@^2.13.10":
+  version "2.13.10"
+  resolved "https://registry.yarnpkg.com/@webrecorder/wabac/-/wabac-2.13.10.tgz#7319cf18ff9198d6d4760aed6d2ad271e2472bfc"
+  integrity sha512-tce4CmMZqPqZH1ZqLbKGb6+2QcdzwZbdMr94PtLcMvkCarXLs7oE2jnHQ3kDDXByDqp4JCS554WviwToACNOaQ==
   dependencies:
     "@peculiar/asn1-ecc" "^2.3.0"
     "@peculiar/asn1-schema" "^2.3.0"