@eluvio/elv-client-js 4.0.11 → 4.0.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eluvio/elv-client-js",
-  "version": "4.0.11",
+  "version": "4.0.13",
   "description": "Javascript client for the Eluvio Content Fabric",
   "main": "src/index.js",
   "author": "Kevin Talmadge",
@@ -30,15 +30,7 @@
     "publish": "npm publish --access public",
     "test": "node test/RunTests.js",
     "test-docs": "GENERATE_METHOD_LOGS=true node test/RunTests.js",
-    "test-utilities": "mocha --recursive utilities/tests/unit",
-    "jest": "jest",
-    "test-cov": "jest --coverage --coverageDirectory 'test/coverage'",
-    "test-build": "USE_BUILD=true jest"
-  },
-  "pre-commit": {
-    "run": [
-      "lint"
-    ]
+    "test-utilities": "mocha --recursive utilities/tests/unit"
   },
   "browser": {
     "fs": false
@@ -85,7 +77,6 @@
     "lodash": "^4.17.19",
     "lodash.isequal": "^4.5.0",
     "mime-types": "^2.1.24",
-    "multicodec": "^0.5.3",
     "multihashes": "^0.4.14",
     "node-fetch": "^2.6.7",
     "object-path": "^0.11.8",
@@ -96,7 +87,6 @@
     "ramda": "^0.27.1",
     "shell-escape": "^0.2.0",
     "sjcl": "^1.0.8",
-    "stream-browserify": "^3.0.0",
     "typedarray": "0.0.6",
     "unorm": "^1.5.0",
     "urijs": "^1.19.10",
@@ -116,21 +106,14 @@
     "copy-webpack-plugin": "^6.0.2",
     "eslint": "^5.15.0",
     "eslint-plugin-html": "^5.0.0",
-    "jest": "^24.9.0",
-    "jest-cli": "^24.9.0",
-    "jsdoc": "^3.6.10",
-    "minami": "^1.2.3",
+    "jsdoc": "^4.0.0",
     "mocha": "^8.2.1",
     "moment": "^2.27.0",
-    "pre-commit": "^1.2.2",
     "raw-loader": "^0.5.1",
     "shell-quote": "^1.7.2",
     "showdown": "^1.9.1",
     "simple-mock": "^0.8.0",
-    "solc": "^0.7.5",
-    "truffle": "^5.1.54",
-    "truffle-contract": "^3.0.7",
-    "truffle-test-utils": "^0.1.0",
+    "taffydb": "^2.7.3",
     "webpack": "^4.20.2",
     "webpack-bundle-analyzer": "^3.3.2",
     "webpack-cli": "^3.1.2",

package/src/FrameClient.js

@@ -399,6 +399,7 @@ class FrameClient {
       "ListAccessGroups",
       "ListFiles",
       "ListNTPInstances",
+      "LRODraftInfo",
       "LROStatus",
       "MergeContractMetadata",
       "MergeMetadata",

package/src/HttpClient.js

@@ -23,7 +23,9 @@ class HttpClient {
   }
 
   RecordWriteToken(writeToken, nodeUrlStr) {
-    this.draftURIs[writeToken] = nodeUrlStr ? new URI(nodeUrlStr) : this.BaseURI();
+    if(!nodeUrlStr) throw Error("RecordWriteToken() - nodeUrlStr not supplied");
+    if(!writeToken) throw Error("RecordWriteToken() - writeToken not supplied");
+    this.draftURIs[writeToken] = new URI(nodeUrlStr);
   }
 
   RequestHeaders(bodyType, headers={}) {
@@ -86,7 +88,7 @@ class HttpClient {
     }
 
     let response;
-
+    this.Log(`${method} - ${uri.toString()}`);
     try {
       response =
         await HttpClient.Fetch(

package/src/client/ABRPublishing.js

@@ -8,7 +8,6 @@
 
 const R = require("ramda");
 const UrlJoin = require("url-join");
-const HttpClient = require("../HttpClient");
 
 const {
   ValidateLibrary,
@@ -16,6 +15,19 @@ const {
   ValidateParameters
 } = require("../Validation");
 
+// When `/abr_mezzanine/offerings` contains more than one entry, only 1 is the 'real' offering, the others are
+// additional copies to be modified upon finalization due to addlOfferingSpecs having been specified in call to
+// `CreateABRMezzanine()`. The 'real' offering will have an object stored in `mez_prep_specs`, the copies will not.
+// This function accepts the metadata retrieved from `/abr_mezzanine/offerings` and returns the offering key for the
+// 'real' offering that actually has transcode LROs.
+// If no suitable offering is found, throws an error.
+const MezJobMainOfferingKey = function(abrMezOfferings) {
+  if(!abrMezOfferings) throw Error("No mezzanine preparation job info found at /abr_mezzanine");
+  const mainOfferingKey = Object.keys(abrMezOfferings).find(offKey => abrMezOfferings[offKey].mez_prep_specs);
+  if(!mainOfferingKey) throw Error("Could not determine offering key for last submitted job");
+  return mainOfferingKey;
+};
+
 /**
  * Create a master media content object with the given files.
  *
@@ -438,13 +450,12 @@ exports.CreateABRMezzanine = async function({
 };
 
 /**
- * Start any incomplete jobs on the specified mezzanine
+ * Start transcoding jobs previously set up by CreateABRMezzanine() on the specified mezzanine
  *
  * @methodGroup ABR Publishing
  * @namedParams
  * @param {string} libraryId - ID of the mezzanine library
  * @param {string} objectId - ID of the mezzanine object
- * @param {string=} offeringKey=default - The offering to process
  * @param {Array<Object>=} access - Array of S3 credentials, along with path matching regexes - Required if any files in the masters are S3 references (See CreateProductionMaster method)
  * - Format: {region, bucket, accessKey, secret}
  * @param {number[]} jobIndexes - Array of LRO job indexes to start. LROs are listed in a map under metadata key /abr_mezzanine/offerings/(offeringKey)/mez_prep_specs/, and job indexes start with 0, corresponding to map keys in alphabetical order
@@ -454,19 +465,20 @@ exports.CreateABRMezzanine = async function({
 exports.StartABRMezzanineJobs = async function({
   libraryId,
   objectId,
-  offeringKey="default",
   access=[],
   jobIndexes = null
 }) {
   ValidateParameters({libraryId, objectId});
 
-  const mezzanineMetadata = await this.ContentObjectMetadata({
+  const lastJobOfferingsInfo = await this.ContentObjectMetadata({
     libraryId,
     objectId,
     metadataSubtree: UrlJoin("abr_mezzanine", "offerings")
   });
+  const offeringKey = MezJobMainOfferingKey(lastJobOfferingsInfo);
 
-  const prepSpecs = mezzanineMetadata[offeringKey].mez_prep_specs || [];
+  const prepSpecs = lastJobOfferingsInfo[offeringKey].mez_prep_specs;
+  if(!prepSpecs) throw Error("No stream preparation specs found");
 
   // Retrieve all masters associated with this offering
   let masterVersionHashes = Object.keys(prepSpecs).map(spec =>
@@ -497,7 +509,7 @@ exports.StartABRMezzanineJobs = async function({
 
   const lroInfo = {
     write_token: processingDraft.write_token,
-    node: this.HttpClient.BaseURI().toString(),
+    node: processingDraft.nodeUrl,
     offering: offeringKey
   };
 
@@ -507,7 +519,7 @@ exports.StartABRMezzanineJobs = async function({
     libraryId,
     objectId,
     writeToken: statusDraft.write_token,
-    metadataSubtree: `lro_draft_${offeringKey}`,
+    metadataSubtree: "lro_draft",
     metadata: lroInfo
   });
 
@@ -536,6 +548,7 @@ exports.StartABRMezzanineJobs = async function({
     hash: finalizeResponse.hash,
     lro_draft: lroInfo,
     writeToken: processingDraft.write_token,
+    nodeUrl: processingDraft.nodeUrl,
     data,
     logs: logs || [],
     warnings: warnings || [],
@@ -544,45 +557,71 @@ exports.StartABRMezzanineJobs = async function({
 };
 
 /**
- * Retrieve status information for a long running operation (LRO) on the given object.
+ * Retrieve node and write token for a mezzanine's current offering preparation job (if any).
+ * Also returns the offering key.
  *
  * @methodGroup ABR Publishing
  * @namedParams
  * @param {string} libraryId - ID of the library
  * @param {string} objectId - ID of the object
- * @param {string=} offeringKey=default - Offering key of the mezzanine
  *
  * @return {Promise<Object>} - LRO status
  */
-exports.LROStatus = async function({libraryId, objectId, offeringKey="default"}) {
-  ValidateParameters({libraryId, objectId});
+exports.LRODraftInfo = async function({libraryId, objectId}) {
+  const standardPathContents = await this.ContentObjectMetadata({
+    libraryId,
+    objectId,
+    metadataSubtree: "lro_draft"
+  });
 
-  const lroDraft =
-    await this.ContentObjectMetadata({
-      libraryId,
-      objectId,
-      metadataSubtree: `lro_draft_${offeringKey}`
-    }) ||
-    await this.ContentObjectMetadata({
-      libraryId,
-      objectId,
-      metadataSubtree: "lro_draft"
-    });
+  if(standardPathContents) return standardPathContents;
 
-  if(!lroDraft || !lroDraft.write_token) {
-    // Write token not present - check if mezz has already been finalized
-    const ready = await this.ContentObjectMetadata({
-      libraryId,
-      objectId,
-      metadataSubtree: UrlJoin("abr_mezzanine", "offerings", offeringKey, "ready")
-    });
+  // get last job info, under /abr_mezzanine/offerings/
+  const lastJobOfferingsInfo = await this.ContentObjectMetadata({
+    libraryId,
+    objectId,
+    metadataSubtree: UrlJoin("abr_mezzanine", "offerings")
+  });
+
+  if(!lastJobOfferingsInfo) throw Error("No metadata for mezzanine preparation job found at /abr_mezzanine");
+
+  const mainOfferingKey = MezJobMainOfferingKey(lastJobOfferingsInfo);
+  if(!mainOfferingKey) throw Error("Could not determine offering key for last submitted job");
 
+  // see if offering from last job was finalized
+  const ready = lastJobOfferingsInfo[mainOfferingKey].ready;
+
+  // old location for LRO draft info
+  const oldPathContents = await this.ContentObjectMetadata({
+    libraryId,
+    objectId,
+    metadataSubtree: `lro_draft_${mainOfferingKey}`
+  });
+  if(oldPathContents) {
+    return oldPathContents;
+  } else {
     if(ready) {
-      throw Error(`Mezzanine already finalized for offering '${offeringKey}'`);
+      throw Error("No LRO draft found for this mezzanine - looks like last mez prep job was already finalized.");
     } else {
-      throw Error("No LRO draft found for this mezzanine");
+      throw Error("No LRO draft found for this mezzanine - looks like last mez prep job was either cancelled or discarded.");
     }
   }
+};
+
+/**
+ * Retrieve status information for mezzanine transcoding jobs, aka long running operations (LROs) on the given object.
+ *
+ * @methodGroup ABR Publishing
+ * @namedParams
+ * @param {string} libraryId - ID of the library
+ * @param {string} objectId - ID of the object
+ *
+ * @return {Promise<Object>} - LRO status
+ */
+exports.LROStatus = async function({libraryId, objectId}) {
+  ValidateParameters({libraryId, objectId});
+
+  const lroDraft = await this.LRODraftInfo({libraryId, objectId});
 
   this.HttpClient.RecordWriteToken(lroDraft.write_token, lroDraft.node);
 
@@ -602,98 +641,80 @@ exports.LROStatus = async function({libraryId, objectId, offeringKey="default"})
  * @param {string} libraryId - ID of the mezzanine library
  * @param {string} objectId - ID of the mezzanine object
  * @param {string} writeToken - Write token for the mezzanine object
- * @param {string=} offeringKey=default - The offering to process
  * @param {function=} preFinalizeFn - A function to call before finalizing changes, to allow further modifications to offering. The function will be invoked with {elvClient, nodeUrl, writeToken} to allow access to the draft and MUST NOT finalize the draft.
  * @param {boolean=} preFinalizeThrow - If set to `true` then any error thrown by preFinalizeFn will not be caught. Otherwise, any exception will be appended to the `warnings` array returned after finalization.
  *
  * @return {Promise<Object>} - The finalize response for the mezzanine object, as well as any logs, warnings and errors from the finalization
  */
-exports.FinalizeABRMezzanine = async function({libraryId, objectId, offeringKey="default", preFinalizeFn, preFinalizeThrow}) {
+exports.FinalizeABRMezzanine = async function({libraryId, objectId, preFinalizeFn, preFinalizeThrow}) {
   ValidateParameters({libraryId, objectId});
 
-  const lroDraft = await this.ContentObjectMetadata({
+  const lroDraft = await this.LRODraftInfo({libraryId, objectId});
+
+  // tell http client what node to contact for this write token
+  this.HttpClient.RecordWriteToken(lroDraft.write_token, lroDraft.node);
+
+  const lastJobOfferingsInfo = await this.ContentObjectMetadata({
     libraryId,
     objectId,
-    metadataSubtree: `lro_draft_${offeringKey}`
+    writeToken: lroDraft.write_token,
+    metadataSubtree: UrlJoin("abr_mezzanine", "offerings")
   });
 
-  if(!lroDraft || !lroDraft.write_token) {
-    throw Error("No LRO draft found for this mezzanine");
-  }
-
-  const httpClient = this.HttpClient;
-  let error, result;
-  try {
-    // Point directly to the node containing the draft
-    this.HttpClient = new HttpClient({uris: [lroDraft.node], debug: httpClient.debug});
+  const offeringKey = MezJobMainOfferingKey(lastJobOfferingsInfo);
+  const masterHash = lastJobOfferingsInfo[offeringKey].prod_master_hash;
 
-    const mezzanineMetadata = await this.ContentObjectMetadata({
-      libraryId,
-      objectId,
-      writeToken: lroDraft.write_token,
-      metadataSubtree: UrlJoin("abr_mezzanine", "offerings")
-    });
+  // Authorization token for mezzanine and master
+  let authorizationTokens = [
+    await this.authClient.AuthorizationToken({libraryId, objectId, update: true}),
+    await this.authClient.AuthorizationToken({versionHash: masterHash})
+  ];
 
-    const masterHash = mezzanineMetadata[offeringKey].prod_master_hash;
+  const headers = {
+    Authorization: authorizationTokens.map(token => `Bearer ${token}`).join(",")
+  };
 
-    // Authorization token for mezzanine and master
-    let authorizationTokens = [
-      await this.authClient.AuthorizationToken({libraryId, objectId, update: true}),
-      await this.authClient.AuthorizationToken({versionHash: masterHash})
-    ];
+  const {data, errors, warnings, logs} = await this.CallBitcodeMethod({
+    objectId,
+    libraryId,
+    writeToken: lroDraft.write_token,
+    method: UrlJoin("media", "abr_mezzanine", "offerings", offeringKey, "finalize"),
+    headers,
+    constant: false
+  });
 
-    const headers = {
-      Authorization: authorizationTokens.map(token => `Bearer ${token}`).join(",")
+  let preFinalizeWarnings = [];
+  if(preFinalizeFn) {
+    const params = {
+      elvClient: this,
+      nodeUrl: lroDraft.node,
+      writeToken: lroDraft.write_token
     };
-
-    const {data, errors, warnings, logs} = await this.CallBitcodeMethod({
-      objectId,
-      libraryId,
-      writeToken: lroDraft.write_token,
-      method: UrlJoin("media", "abr_mezzanine", "offerings", offeringKey, "finalize"),
-      headers,
-      constant: false
-    });
-
-    let preFinalizeWarnings = [];
-    if(preFinalizeFn) {
-      const params = {
-        elvClient: this,
-        nodeUrl: lroDraft.node,
-        writeToken: lroDraft.write_token
-      };
-      if(preFinalizeThrow){
-        await preFinalizeFn(params);
-      } else try {
-        await preFinalizeFn(params);
-      } catch(e) {
-        preFinalizeWarnings = `Error trying to set video stream codec descriptors: ${e}`;
+    try {
+      await preFinalizeFn(params);
+    } catch(err) {
+      if(preFinalizeThrow) {
+        // noinspection ExceptionCaughtLocallyJS
+        throw new Error("Error running preFinalize function", {cause: err});
+      } else {
+        preFinalizeWarnings = `Error running preFinalize function: ${err}`;
       }
     }
-
-    const finalizeResponse = await this.FinalizeContentObject({
-      libraryId,
-      objectId: objectId,
-      writeToken: lroDraft.write_token,
-      commitMessage: "Finalize ABR mezzanine",
-      awaitCommitConfirmation: false
-    });
-
-    result = {
-      data,
-      logs: logs || [],
-      warnings: (warnings || []).concat(preFinalizeWarnings),
-      errors: errors || [],
-      ...finalizeResponse
-    };
-  } catch(err) {
-    error = err;
-  } finally {
-    // Ensure original http client is restored
-    this.HttpClient = httpClient;
   }
 
-  if(error) { throw error; }
+  const finalizeResponse = await this.FinalizeContentObject({
+    libraryId,
+    objectId: objectId,
+    writeToken: lroDraft.write_token,
+    commitMessage: "Finalize ABR mezzanine",
+    awaitCommitConfirmation: false
+  });
 
-  return result;
+  return {
+    data,
+    logs: logs || [],
+    warnings: (warnings || []).concat(preFinalizeWarnings),
+    errors: errors || [],
+    ...finalizeResponse
+  };
 };

package/src/client/ContentAccess.js

@@ -104,6 +104,7 @@ exports.Visibility = async function({id, clearCache}) {
  *
  * @methodGroup Content Objects
  * @param {string} objectId - The ID of the object
+ * @param {boolean=} clearCache - Clear any Visibility info cached by client for this object (forces new Ethereum calls)
  *
  * @return {string} - Key for the permission of the object - Use this to retrieve more details from client.permissionLevels
  */

package/src/client/ContentManagement.js

@@ -183,6 +183,7 @@ exports.CreateContentType = async function({name, metadata={}, bitcode}) {
     method: "POST",
     path: path
   });
+  // extract the url for the node that handled the request
   const nodeUrl = (new URL(rawCreateResponse.url)).origin;
   const createResponse = await this.utils.ResponseToJson(rawCreateResponse);
 
@@ -748,8 +749,8 @@ exports.CreateNonOwnerCap = async function({objectId, libraryId, publicKey, writ
  * @param {string} libraryId - ID of the library
  * @param {string} objectId - ID of the object
  * @param {object=} options -
- * meta: New metadata for the object - will be merged into existing metadata if specified
- * type: New type for the object - Object ID, version hash or name of type
+ * @param {object=} options.meta - New metadata for the object - will be merged into existing metadata if specified
+ * @param {string=} options.type - New type for the object - Object ID, version hash or name of type
  *
  * @returns {Promise<object>} - Response containing the object ID and write token of the draft, as well as URL of node handling the draft
  */
@@ -781,6 +782,7 @@ exports.EditContentObject = async function({libraryId, objectId, options={}}) {
     path: path,
     body: options
   });
+  // extract the url for the node that handled the request
   const nodeUrl = (new URL(rawEditResponse.url)).origin;
   const editResponse = await this.utils.ResponseToJson(rawEditResponse);
 

package/src/walletClient/Configuration.js

@@ -24,9 +24,9 @@ let WalletConfiguration = {
   },
   __MARKETPLACE_ORDER: [
     "PREVIEW",
+    "masked-singer-brazil-marketplace",
     "de228e92-ed45-4fe0-8e52-658cf366e962",
     "wwe-marketplace-main",
-    "realcannonballrun-marketplace",
     "maskverse-marketplace",
     "dolly-marketplace",
     "eluvio-live-marketplace-sonark",
@@ -36,7 +36,8 @@ let WalletConfiguration = {
     "emp-marketplace",
     "microsoft",
     "indieflix-marketplace",
-    "angels-airwaves-marketplace"
+    "angels-airwaves-marketplace",
+    "realcannonballrun-marketplace"
   ]
 };