@suprsend/node-sdk 1.7.0 → 1.8.0

package/src/workflow.js

@@ -4,6 +4,7 @@ import {
   SuprsendError,
   validate_workflow_body_schema,
   get_apparent_workflow_body_size,
+  InputValueError,
 } from "./utils";
 import get_attachment_json from "./attachment";
 import {
@@ -14,7 +15,7 @@ import {
 export default class Workflow {
   constructor(body, kwargs = {}) {
     if (!(body instanceof Object)) {
-      throw new SuprsendError("workflow body must be a json/dictionary");
+      throw new InputValueError("workflow body must be a json/dictionary");
     }
     this.body = body;
     this.idempotency_key = kwargs?.idempotency_key;
@@ -24,18 +25,26 @@ export default class Workflow {
   add_attachment(file_path = "", kwargs = {}) {
     const file_name = kwargs?.file_name;
     const ignore_if_error = kwargs?.ignore_if_error ?? false;
-    if (!this.body.data) {
+    if (!this.body?.data) {
       this.body.data = {};
     }
-    if (!(this.body instanceof Object)) {
-      throw new SuprsendError("data must be a dictionary");
+    // if body["data"] is not a dict, not raising error while adding attachment.
+    if (!(this.body["data"] instanceof Object)) {
+      console.log(
+        `WARNING: attachment cannot be added. please make sure body['data'] is a dictionary. Workflow ${JSON.stringify(
+          this.as_json()
+        )}`
+      );
+      return;
     }
     const attachment = get_attachment_json(
       file_path,
       file_name,
       ignore_if_error
     );
-
+    if (!attachment) {
+      return;
+    }
     if (!this.body.data["$attachments"]) {
       this.body["data"]["$attachments"] = [];
     }
@@ -56,12 +65,23 @@ export default class Workflow {
       is_part_of_bulk
     ); // review
     if (apparent_size > SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES) {
-      throw new SuprsendError(
+      throw new InputValueError(
         `workflow body too big - ${apparent_size} Bytes, must not cross ${SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE}`
       );
     }
     return [this.body, apparent_size];
   }
+
+  as_json() {
+    const body_dict = { ...this.body };
+    if (this.idempotency_key) {
+      body_dict["$idempotency_key"] = this.idempotency_key;
+    }
+    if (this.brand_id) {
+      body_dict["brand_id"] = this.brand_id;
+    }
+    return body_dict;
+  }
 }
 
 export class _WorkflowTrigger {

package/src/workflows_bulk.js

@@ -6,7 +6,7 @@ import {
   MAX_WORKFLOWS_IN_BULK_API,
   ALLOW_ATTACHMENTS_IN_BULK_API,
 } from "./constants";
-import { SuprsendError } from "./utils";
+import { SuprsendError, invalid_record_json, InputValueError } from "./utils";
 import Workflow from "./workflow";
 import { cloneDeep } from "lodash";
 import axios from "axios";
@@ -78,7 +78,7 @@ class _BulkWorkflowsChunk {
       return false;
     }
     if (body_size > SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES) {
-      throw new SuprsendError(
+      throw new InputValueError(
         `workflow body too big - ${body_size} Bytes, must not cross ${SINGLE_EVENT_MAX_APPARENT_SIZE_IN_BYTES_READABLE}`
       );
     }
@@ -134,7 +134,7 @@ class _BulkWorkflowsChunk {
       }
     } catch (err) {
       const error_status = err.status || 500;
-      return {
+      this.response = {
         status: "fail",
         status_code: error_status,
         message: err.message,
@@ -158,19 +158,23 @@ class BulkWorkflows {
     this.__pending_records = [];
     this.chunks = [];
     this.response = new BulkResponse();
+    // invalid_record json: {"record": workflow-json, "error": error_str, "code": 500}
+    this.__invalid_records = [];
   }
 
   __validate_workflows() {
-    if (!this.__workflows) {
-      throw new SuprsendError("workflow list is empty in bulk request");
-    }
     for (let wf of this.__workflows) {
-      const is_part_of_bulk = true;
-      const [wf_body, body_size] = wf.get_final_json(
-        this.config,
-        is_part_of_bulk
-      );
-      this.__pending_records.push([wf_body, body_size]);
+      try {
+        const is_part_of_bulk = true;
+        const [wf_body, body_size] = wf.get_final_json(
+          this.config,
+          is_part_of_bulk
+        );
+        this.__pending_records.push([wf_body, body_size]);
+      } catch (ex) {
+        const inv_rec = invalid_record_json(wf.as_json(), ex);
+        this.__invalid_records.push(inv_rec);
+      }
     }
   }
 
@@ -190,37 +194,41 @@ class BulkWorkflows {
   }
 
   append(...workflows) {
-    if (!workflows) {
-      throw new SuprsendError(
-        "workflow list empty. must pass one or more valid workflow instances"
-      );
-    }
     for (let wf of workflows) {
-      if (!wf) {
-        throw new SuprsendError("null/empty element found in bulk instance");
-      }
-      if (!(wf instanceof Workflow)) {
-        throw new SuprsendError(
-          "element must be an instance of suprsend.Workflow"
-        );
+      if (wf && wf instanceof Workflow) {
+        const wf_copy = cloneDeep(wf);
+        this.__workflows.push(wf_copy);
       }
-      const wf_copy = cloneDeep(wf);
-      this.__workflows.push(wf_copy);
     }
   }
 
   async trigger() {
     this.__validate_workflows();
-    this.__chunkify();
-    for (const [c_idx, ch] of this.chunks.entries()) {
-      if (this.config.req_log_level > 0) {
-        console.log(`DEBUG: triggering api call for chunk: ${c_idx}`);
+    if (this.__invalid_records.length > 0) {
+      const ch_response = BulkResponse.invalid_records_chunk_response(
+        this.__invalid_records
+      );
+      this.response.merge_chunk_response(ch_response);
+    }
+    if (this.__pending_records.length) {
+      this.__chunkify();
+      for (const [c_idx, ch] of this.chunks.entries()) {
+        if (this.config.req_log_level > 0) {
+          console.log(`DEBUG: triggering api call for chunk: ${c_idx}`);
+        }
+        // do api call
+        await ch.trigger();
+        // merge response
+        this.response.merge_chunk_response(ch.response);
+      }
+    } else {
+      if (this.__invalid_records.length === 0) {
+        this.response.merge_chunk_response(
+          BulkResponse.empty_chunk_success_response()
+        );
       }
-      // do api call
-      await ch.trigger();
-      // merge response
-      this.response.merge_chunk_response(ch.response);
     }
+
     return this.response;
   }
 }

package/types/index.d.ts

@@ -137,6 +137,11 @@ declare namespace suprsend {
       body: Dictionary,
       kwargs?: { idempotency_key?: string; brand_id?: string }
     ): SubscriberListBroadcast;
+
+    add_attachment(
+      file_path: string,
+      kwargs?: { file_name?: string; ignore_if_error?: boolean }
+    ): void;
   }
 
   interface SubscriberListsApi {