@outliant/sunrise-utils 1.1.32 → 1.2.0

package/CHANGELOG.md

@@ -4,9 +4,16 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [1.2.0](https://github.com/outliant/sunrise-utils/compare/1.1.32...1.2.0)
+
+- chore: event service with sns #86b0xg1gf [`7baa9ec`](https://github.com/outliant/sunrise-utils/commit/7baa9ec2d0c85f78d3573854d1216d974551465c)
+
 #### [1.1.32](https://github.com/outliant/sunrise-utils/compare/1.1.31...1.1.32)
 
+> 23 July 2024
+
 - chore add is_any_of filter to user_select field condition #86b0b3k2r [`#42`](https://github.com/outliant/sunrise-utils/pull/42)
+- chore(release): 1.1.32 [`cdeeae5`](https://github.com/outliant/sunrise-utils/commit/cdeeae5e959518d725badd30ea3cb40724654cf5)
 
 #### [1.1.31](https://github.com/outliant/sunrise-utils/compare/1.1.29...1.1.31)
 

package/index.d.ts

@@ -43,7 +43,7 @@ declare namespace Utils {
       field: string;
       direction: 'asc' | 'desc';
       text: string;
-    }[],
+    }[];
     columns?: string[];
   }
 
@@ -95,6 +95,42 @@ declare namespace Utils {
     export function getIsPausedQuery(): any;
     export function getNotIsPausedQuery(): any;
   }
+
+  interface SNSService {
+    publishBatch(params: {
+      TopicArn: string;
+      PublishBatchRequestEntries: {
+        Id: string;
+        Message: string;
+        [key: string]: any;
+      }[];
+    }): Promise<void>;
+  }
+
+  type EventServiceTypes =
+    | 'customer'
+    | 'customer.fields'
+    | 'project'
+    | 'project.fields'
+    | 'project.stage'
+    | 'task'
+    | 'task.fields';
+  type EventServiceAction = 'create' | 'update' | 'delete';
+
+  type EventParams = {
+    orgId: string;
+    type: EventServiceTypes;
+    action: EventServiceAction;
+    sourceId: string;
+    data: any;
+    attributes?: Record<string, string | string[] | number>;
+  };
+
+  class EventService {
+    constructor(snsService: SNSService, eventsTopicArn: string);
+
+    send(events: EventParams[]): Promise<any>;
+  }
 }
 
 export = Utils;

package/index.js

@@ -4,6 +4,7 @@ const taskPipeline = require('./lib/taskPipeline');
 const projectPipeline = require('./lib/projectPipeline');
 const usersPipeline = require('./lib/usersPipeline');
 const queries = require('./lib/queries');
+const EventService = require('./lib/eventService');
 
 module.exports = {
   log,
@@ -11,5 +12,6 @@ module.exports = {
   taskPipeline,
   projectPipeline,
   usersPipeline,
-  queries
+  queries,
+  EventService
 };

package/lib/eventService.js

@@ -0,0 +1,88 @@
+const _ = require('lodash');
+const { v4: uuid } = require('uuid');
+
+class EventService {
+  constructor(snsService, eventsTopicArn) {
+    this.snsService = snsService;
+    this.eventsTopicArn = eventsTopicArn;
+  }
+
+  async send(events) {
+    const groups = _.chunk(events, 10);
+
+    for (const group of groups) {
+      const now = new Date().getTime();
+      const entries = _.map(
+        group,
+        ({ orgId, type, action, sourceId, data, attributes = {} }) => {
+          const params = {
+            organization_id: orgId,
+            type,
+            action,
+            source_id: sourceId,
+            data,
+            status: 'pending',
+            created_at: now,
+            updated_at: now
+          };
+
+          return {
+            Id: this.generateMessageId(),
+            Message: JSON.stringify(params),
+            MessageAttributes: {
+              type: {
+                DataType: 'String',
+                StringValue: type
+              },
+              action: {
+                DataType: 'String',
+                StringValue: action
+              },
+              ...this.createSnsMessageAttributes(attributes)
+            }
+          };
+        }
+      );
+
+      this.snsService.publishBatch({
+        TopicArn: this.eventsTopicArn,
+        PublishBatchRequestEntries: entries
+      });
+    }
+  }
+
+  createSnsMessageAttributes(attributes) {
+    const snsAttributes = {};
+
+    for (const [key, value] of Object.entries(attributes)) {
+      if (_.isString(value)) {
+        snsAttributes[key] = {
+          DataType: 'String',
+          StringValue: value
+        };
+      } else if (_.isArray(value)) {
+        snsAttributes[key] = {
+          DataType: 'String.Array',
+          StringValue: JSON.stringify(_.map(value, (v) => v.toString()))
+        };
+      } else if (_.isNumber(value)) {
+        snsAttributes[key] = {
+          DataType: 'Number',
+          StringValue: value.toString()
+        };
+      } else {
+        throw new Error(
+          `Unsupported attribute type for key "${key}": ${typeof value}`
+        );
+      }
+    }
+
+    return snsAttributes;
+  }
+
+  generateMessageId() {
+    return uuid();
+  }
+}
+
+module.exports = EventService;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@outliant/sunrise-utils",
   "description": "Helper functions for project Sunrise",
-  "version": "1.1.32",
+  "version": "1.2.0",
   "license": "ISC",
   "author": "Outliant",
   "main": "index.js",

package/test/lib/eventService.spec.js

@@ -0,0 +1,85 @@
+'use strict';
+
+/* eslint-env node, mocha */
+const { expect } = require('chai');
+const sinon = require('sinon');
+
+const EventService = require('../../lib/eventService');
+
+describe('eventService', function () {
+  let sandbox;
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox();
+    sandbox.stub(Date.prototype, 'getTime').returns(111111111);
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+  });
+
+  it('should publish sns message to events topic', async () => {
+    sandbox
+      .stub(EventService.prototype, 'generateMessageId')
+      .returns('test-id');
+    const snsService = {
+      publishBatch: sandbox.stub()
+    };
+    const eventService = new EventService(snsService, 'test-sns-topic');
+
+    await eventService.send([
+      {
+        orgId: 'test-org-id',
+        type: 'project.fields',
+        action: 'update',
+        sourceId: 'test-project-id',
+        data: {
+          id: 'property-id',
+          old: '',
+          new: 'new value',
+          propertyName: 'test-property'
+        },
+        attributes: {
+          projectId: 'test-project-id',
+          projectCreatedAt: 111111,
+          projectTags: ['tag1', 'tag2', 'tag3']
+        }
+      }
+    ]);
+
+    expect(
+      snsService.publishBatch.calledWith({
+        TopicArn: 'test-sns-topic',
+        PublishBatchRequestEntries: [
+          {
+            Id: 'test-id',
+            Message:
+              '{"organization_id":"test-org-id","type":"project.fields","action":"update","source_id":"test-project-id","data":{"id":"property-id","old":"","new":"new value","propertyName":"test-property"},"status":"pending","created_at":111111111,"updated_at":111111111}',
+            MessageAttributes: {
+              type: {
+                DataType: 'String',
+                StringValue: 'project.fields'
+              },
+              action: {
+                DataType: 'String',
+                StringValue: 'update'
+              },
+              projectId: {
+                DataType: 'String',
+                StringValue: 'test-project-id'
+              },
+              projectCreatedAt: {
+                DataType: 'Number',
+                StringValue: '111111'
+              },
+              projectTags: {
+                DataType: 'String.Array',
+                StringValue: '["tag1","tag2","tag3"]'
+              }
+            }
+          }
+        ]
+      })
+    ).to.be.true;
+  });
+});