@foxtware/mineral 0.1.10 → 0.1.12

package/api/shopify/shopify.utils.js

@@ -4,8 +4,10 @@ const {
   FetchClient,
   appendUrlToBase,
   fetchClientCommonSteps,
+  jsonlToObjectArray,
   pathAsArray,
   objectDigNodeAtPath,
+  sentenceCaseString,
 } = require('../utils');
 
 const handleMutationUserErrors = async (state) => {
@@ -97,6 +99,80 @@ const movePageInfoToMeta = async (state) => {
   };
 };
 
+// https://shopify.dev/docs/api/usage/bulk-operations/queries
+const parseShopifyJsonl = (jsonl) => {
+  const objects = jsonlToObjectArray(jsonl);
+  const objectsMap = new Map();
+  const objectsWithoutStitching = [];
+
+  for (const object of objects) {
+    const {
+      id: gid,
+      __parentId: parentGid,
+    } = object;
+
+    if (!gid) {
+      objectsWithoutStitching.push(object);
+      continue;
+    }
+
+    const [objectType] = gid.split('gid://shopify/')[1].split(/[^a-zA-Z0-9]+/);
+
+    objectsMap.set(gid, {
+      ...object,
+      selfType: objectType,
+      ...parentGid && { parentGid },
+    });
+  }
+
+  const objectTypeToProperty = (objectType) => `${ sentenceCaseString(objectType) }s`;
+
+  for (const [gid, object] of objectsMap) {
+    const {
+      selfType,
+      parentGid,
+    } = object;
+
+    if (!parentGid) {
+      continue;
+    }
+
+    const objectProperty = objectTypeToProperty(selfType);
+
+    let parentObject = objectsMap.get(parentGid);
+    if (!parentObject) {
+      continue;
+    }
+
+    const nestedParent = gid.split('?')?.[1];
+
+    if (nestedParent) {
+      let [nestedParentType] = nestedParent.split('=');
+      nestedParentType = nestedParentType
+        .replaceAll('_id', '')
+        .split('_')
+        .map((word) => word[0].toUpperCase() + word.slice(1))
+        .join('');
+      nestedParentType = sentenceCaseString(nestedParentType);
+      parentObject = parentObject[nestedParentType];
+    }
+
+    if (!parentObject) {
+      continue;
+    }
+
+    parentObject[objectProperty] = parentObject[objectProperty] || [];
+    parentObject[objectProperty].push(objectsMap.get(gid));
+  }
+
+  const topLevelObjects = Array.from(objectsMap.values()).filter((object) => !object?.parentGid);
+
+  return [
+    ...topLevelObjects,
+    ...objectsWithoutStitching,
+  ];
+};
+
 const shopifyClient = new FetchClient({
   pipeline: [
     resolveCreds,
@@ -113,5 +189,6 @@ const shopifyClient = new FetchClient({
 });
 
 module.exports = {
+  parseShopifyJsonl,
   shopifyClient,
 };

package/api/shopify/shopifyBulkOperationRunQuery.js

@@ -0,0 +1,70 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/bulkoperationrunquery
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('./shopifyMutationDo');
+
+const defaultReturnAttrs = `
+  id
+  type
+  status
+  objectCount
+  url
+  errorCode
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['query'],
+]);
+
+const shopifyBulkOperationRunQuery = async (
+  credsPayload,
+  query,
+  {
+    apiVersion,
+    returnAttrs = defaultReturnAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    query,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'bulkOperationRunQuery',
+    {
+      mutationVariables: {
+        query: {
+          type: 'String!',
+          value: query,
+        },
+      },
+      returnSchema: `bulkOperation { ${ returnAttrs } }`,
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyBulkOperationRunQuery,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyBulkOperationRunQuery" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "query": "{ products { edges { node { id title handle } } } }"
+  }'
+*/

package/api/shopify/shopifyBulkQueryDo.js

@@ -0,0 +1,127 @@
+const { credsValidator } = require('../validators');
+const {
+  ArgsWarden,
+  customFetch,
+  gidToId,
+  wait,
+} = require('../utils');
+const { parseShopifyJsonl } = require('./shopify.utils');
+const { shopifyBulkOperationGet } = require('./shopifyBulkOperationGet');
+const { shopifyBulkOperationRunQuery } = require('./shopifyBulkOperationRunQuery');
+
+const bulkOpAttrs = `
+  id
+  status
+  type
+  objectCount
+  url
+  errorCode
+`;
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['query'],
+]);
+
+const shopifyBulkQueryDo = async (
+  credsPayload,
+  query,
+  {
+    apiVersion,
+    waitForResult = true,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    query,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const queryRunResponse = await shopifyBulkOperationRunQuery(
+    credsPayload,
+    query,
+    {
+      apiVersion,
+      returnAttrs: bulkOpAttrs,
+    },
+  );
+
+  if (!waitForResult) {
+    return queryRunResponse;
+  }
+
+  if (!queryRunResponse.ok) {
+    return queryRunResponse;
+  }
+
+  let bulkOperation = queryRunResponse.data.bulkOperation;
+  let bulkOperationId = gidToId(bulkOperation.id);
+
+  while (['CREATED', 'RUNNING'].includes(bulkOperation?.status)) {
+
+    if (bulkOperation) {
+      await wait(5000);
+    }
+
+    const operationResponse = await shopifyBulkOperationGet(
+      credsPayload,
+      bulkOperationId,
+      {
+        apiVersion,
+        attrs: bulkOpAttrs,
+      },
+    );
+    if (!operationResponse.ok) {
+      return operationResponse;
+    }
+
+    bulkOperation = operationResponse.data;
+  }
+
+  if (bulkOperation.status !== 'COMPLETED') {
+    return {
+      ok: false,
+      error: {
+        code: 'BULK_OPERATION_FAILED',
+        message: `Bulk operation failed with status ${ bulkOperation.status }`,
+        details: bulkOperation,
+      },
+    };
+  }
+
+  const resultsResponse = await customFetch(bulkOperation.url);
+  if (!resultsResponse.ok) {
+    return resultsResponse;
+  }
+
+  const results = parseShopifyJsonl(resultsResponse.data);
+
+  return {
+    ok: true,
+    data: results,
+    meta: {
+      bulkOperation,
+    },
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyBulkQueryDo,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyBulkQueryDo" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "query": "{ products { edges { node { id title handle } } } }"
+  }'
+*/

package/api/shopify/shopifyTagsAddBulk.js

@@ -18,12 +18,6 @@ const tagsAddBulkMutation = `
   }
 `.trim();
 
-const tagsAddBulkUserErrors = (bulkResult) => {
-  return bulkResult?.data?.tagsAdd?.userErrors
-    || bulkResult?.tagsAdd?.userErrors
-    || [];
-};
-
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
   ['gids', Array.isArray],
@@ -35,9 +29,7 @@ const shopifyTagsAddBulk = async (
   gids,
   tags,
   {
-    apiVersion,
-    clientIdentifier,
-    waitForResult = true,
+    ...bulkMutationOptions
   } = {},
 ) => {
 
@@ -61,11 +53,7 @@ const shopifyTagsAddBulk = async (
         })),
       },
     },
-    {
-      apiVersion,
-      clientIdentifier,
-      waitForResult,
-    },
+    bulkMutationOptions,
   );
 };
 
@@ -75,7 +63,6 @@ const funcApiConfig = {
 
 module.exports = {
   shopifyTagsAddBulk,
-  tagsAddBulkUserErrors,
   funcApiConfig,
 };
 
@@ -84,7 +71,7 @@ curl -X POST "http://localhost:8000/shopifyTagsAddBulk" \
   -H "Content-Type: application/json" \
   -d '{
     "credsPayload": { "credsPath": "shopify.au" },
-    "gids": ["gid://shopify/Customer/123"],
-    "tags": ["aug26_migration"]
+    "gids": ["gid://shopify/Customer/123", "gid://shopify/Customer/456"],
+    "tags": ["martian_sympathisers"]
   }'
 */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foxtware/mineral",
-  "version": "0.1.10",
+  "version": "0.1.12",
   "bin": {
     "mineral": "bin/mineral.js"
   },