node-server-engine 1.1.2 → 1.1.3

package/src/entities/PubSub/handleMessage/handleMessage.test.ts

@@ -1,102 +1,102 @@
-import { PreciseDate } from '@google-cloud/precise-date';
-import {
-  Subscription,
-  PubSub,
-  Attributes,
-  Message
-} from '@google-cloud/pubsub';
-import { expect } from 'chai';
-import { faker } from '@faker-js/faker';
-import { fake, SinonSpy } from 'sinon';
-import { handleMessage } from './handleMessage';
-
-describe('Entities - Pub/Sub - Handle Message', () => {
-  let subscription: Subscription;
-  let payload: Record<string, unknown>;
-  let attributes: Attributes;
-  let ack: SinonSpy;
-  let message: Message;
-  let publishTime: PreciseDate;
-
-  beforeEach(() => {
-    subscription = new Subscription(new PubSub(), faker.lorem.slug());
-
-    payload = { [faker.lorem.word()]: faker.lorem.word() };
-
-    attributes = { [faker.lorem.word()]: faker.lorem.word() };
-    const data = Buffer.from(JSON.stringify(payload));
-
-    publishTime = new PreciseDate(faker.date.recent());
-
-    ack = fake();
-    message = {
-      id: faker.string.uuid(),
-      ack,
-      ackId: faker.string.uuid(),
-      data,
-      attributes,
-      publishTime,
-      deliveryAttempt: 0,
-      received: 0
-    } as unknown as Message;
-  });
-
-  it('should parse the message and forward it to all the handlers', async () => {
-    const handlers = [fake(), fake(), fake()];
-
-    await handleMessage(message, subscription, handlers);
-
-    for (const handler of handlers) {
-      expect(handler).to.have.been.calledOnceWithExactly(
-        payload,
-        attributes,
-        publishTime
-      );
-    }
-  });
-
-  it('should parse a debezium message [create]', async () => {
-    const handler = fake();
-    payload = { before: null, after: { a: 'a', b: 'b', c: 'c' } };
-    message.data = Buffer.from(JSON.stringify(payload), 'utf-8');
-
-    await handleMessage(message, subscription, [handler], true);
-
-    expect(handler).to.have.been.calledOnceWithExactly(
-      { ...payload, diff: ['a', 'b', 'c'] },
-      attributes,
-      publishTime
-    );
-  });
-
-  it('should parse a debezium message [destroy]', async () => {
-    const handler = fake();
-    payload = { before: { a: 'a', b: 'b', c: 'c' }, after: null };
-    message.data = Buffer.from(JSON.stringify(payload), 'utf-8');
-
-    await handleMessage(message, subscription, [handler], true);
-
-    expect(handler).to.have.been.calledOnceWithExactly(
-      { ...payload, diff: ['a', 'b', 'c'] },
-      attributes,
-      publishTime
-    );
-  });
-
-  it('should parse a debezium message [update]', async () => {
-    const handler = fake();
-    payload = {
-      before: { a: 'a', b: 'b', c: 'c' },
-      after: { a: 'a', b: 'y', c: 'c' }
-    };
-    message.data = Buffer.from(JSON.stringify(payload), 'utf-8');
-
-    await handleMessage(message, subscription, [handler], true);
-
-    expect(handler).to.have.been.calledOnceWithExactly(
-      { ...payload, diff: ['b'] },
-      attributes,
-      publishTime
-    );
-  });
-});
+import { PreciseDate } from '@google-cloud/precise-date';
+import {
+  Subscription,
+  PubSub,
+  Attributes,
+  Message
+} from '@google-cloud/pubsub';
+import { expect } from 'chai';
+import { faker } from '@faker-js/faker';
+import { fake, SinonSpy } from 'sinon';
+import { handleMessage } from './handleMessage';
+
+describe('Entities - Pub/Sub - Handle Message', () => {
+  let subscription: Subscription;
+  let payload: Record<string, unknown>;
+  let attributes: Attributes;
+  let ack: SinonSpy;
+  let message: Message;
+  let publishTime: PreciseDate;
+
+  beforeEach(() => {
+    subscription = new Subscription(new PubSub(), faker.lorem.slug());
+
+    payload = { [faker.lorem.word()]: faker.lorem.word() };
+
+    attributes = { [faker.lorem.word()]: faker.lorem.word() };
+    const data = Buffer.from(JSON.stringify(payload));
+
+    publishTime = new PreciseDate(faker.date.recent());
+
+    ack = fake();
+    message = {
+      id: faker.string.uuid(),
+      ack,
+      ackId: faker.string.uuid(),
+      data,
+      attributes,
+      publishTime,
+      deliveryAttempt: 0,
+      received: 0
+    } as unknown as Message;
+  });
+
+  it('should parse the message and forward it to all the handlers', async () => {
+    const handlers = [fake(), fake(), fake()];
+
+    await handleMessage(message, subscription, handlers);
+
+    for (const handler of handlers) {
+      expect(handler).to.have.been.calledOnceWithExactly(
+        payload,
+        attributes,
+        publishTime
+      );
+    }
+  });
+
+  it('should parse a debezium message [create]', async () => {
+    const handler = fake();
+    payload = { before: null, after: { a: 'a', b: 'b', c: 'c' } };
+    message.data = Buffer.from(JSON.stringify(payload), 'utf-8');
+
+    await handleMessage(message, subscription, [handler], true);
+
+    expect(handler).to.have.been.calledOnceWithExactly(
+      { ...payload, diff: ['a', 'b', 'c'] },
+      attributes,
+      publishTime
+    );
+  });
+
+  it('should parse a debezium message [destroy]', async () => {
+    const handler = fake();
+    payload = { before: { a: 'a', b: 'b', c: 'c' }, after: null };
+    message.data = Buffer.from(JSON.stringify(payload), 'utf-8');
+
+    await handleMessage(message, subscription, [handler], true);
+
+    expect(handler).to.have.been.calledOnceWithExactly(
+      { ...payload, diff: ['a', 'b', 'c'] },
+      attributes,
+      publishTime
+    );
+  });
+
+  it('should parse a debezium message [update]', async () => {
+    const handler = fake();
+    payload = {
+      before: { a: 'a', b: 'b', c: 'c' },
+      after: { a: 'a', b: 'y', c: 'c' }
+    };
+    message.data = Buffer.from(JSON.stringify(payload), 'utf-8');
+
+    await handleMessage(message, subscription, [handler], true);
+
+    expect(handler).to.have.been.calledOnceWithExactly(
+      { ...payload, diff: ['b'] },
+      attributes,
+      publishTime
+    );
+  });
+});

package/src/entities/PubSub/handleMessage/handleMessage.ts

@@ -1,65 +1,65 @@
-import { Subscription, Message } from '@google-cloud/pubsub';
-import { PubSubMessageHandler, PubSubDebeziumPayload } from '../PubSub.types';
-import { LogSeverity } from 'const';
-import { EngineError } from 'entities/EngineError';
-import { reportDebug, reportError } from 'utils';
-
-const namespace = 'engine:PubSub:handleMessage';
-
-/**
- * handle the pubSubClients on message event
- * @param message - Message to parse and handle
- * @param subscription - The related Pub/Sub subscription object
- * @param handlers - Message handlers
- * @param isDebezium - Indicates that the subscription from Debezium events
- */
-export async function handleMessage(
-  message: Message,
-  subscription: Subscription,
-  handlers: Array<PubSubMessageHandler<unknown>>,
-  isDebezium = false
-): Promise<void> {
-  reportDebug({
-    namespace,
-    message: `Received message from Pub/Sub [${subscription.name}]`
-  });
-
-  message.ack();
-
-  let payload;
-  try {
-    payload = JSON.parse(message.data.toString()) as unknown;
-
-    // When handling Debezium message, we calculate automatically the keys that have changed between the previous and current state
-    if (isDebezium) {
-      payload = payload as PubSubDebeziumPayload<Record<string, unknown>>;
-      const { before, after } = payload;
-      if (before && after)
-        payload.diff = Object.keys(after).filter(
-          (key) => after[key] !== before[key]
-        );
-      else if (before) payload.diff = Object.keys(before);
-      else if (after) payload.diff = Object.keys(after);
-      else
-        throw new EngineError({
-          severity: LogSeverity.WARNING,
-          message: `Debezium Pub/Sub message did not include before nor after value [${subscription.name}]`,
-          data: { subscription, message: message.data.toString() }
-        });
-    }
-  } catch {
-    throw new EngineError({
-      severity: LogSeverity.WARNING,
-      message: `Pub/Sub message is not valid JSON ${subscription.name}`,
-      data: { subscription, message: message.data.toString() }
-    });
-  }
-
-  for (const handler of handlers) {
-    try {
-      await handler(payload, message.attributes, message.publishTime);
-    } catch (error) {
-      reportError(error);
-    }
-  }
-}
+import { Subscription, Message } from '@google-cloud/pubsub';
+import { PubSubMessageHandler, PubSubDebeziumPayload } from '../PubSub.types';
+import { LogSeverity } from 'const';
+import { EngineError } from 'entities/EngineError';
+import { reportDebug, reportError } from 'utils';
+
+const namespace = 'engine:PubSub:handleMessage';
+
+/**
+ * handle the pubSubClients on message event
+ * @param message - Message to parse and handle
+ * @param subscription - The related Pub/Sub subscription object
+ * @param handlers - Message handlers
+ * @param isDebezium - Indicates that the subscription from Debezium events
+ */
+export async function handleMessage(
+  message: Message,
+  subscription: Subscription,
+  handlers: Array<PubSubMessageHandler<unknown>>,
+  isDebezium = false
+): Promise<void> {
+  reportDebug({
+    namespace,
+    message: `Received message from Pub/Sub [${subscription.name}]`
+  });
+
+  message.ack();
+
+  let payload;
+  try {
+    payload = JSON.parse(message.data.toString()) as unknown;
+
+    // When handling Debezium message, we calculate automatically the keys that have changed between the previous and current state
+    if (isDebezium) {
+      payload = payload as PubSubDebeziumPayload<Record<string, unknown>>;
+      const { before, after } = payload;
+      if (before && after)
+        payload.diff = Object.keys(after).filter(
+          (key) => after[key] !== before[key]
+        );
+      else if (before) payload.diff = Object.keys(before);
+      else if (after) payload.diff = Object.keys(after);
+      else
+        throw new EngineError({
+          severity: LogSeverity.WARNING,
+          message: `Debezium Pub/Sub message did not include before nor after value [${subscription.name}]`,
+          data: { subscription, message: message.data.toString() }
+        });
+    }
+  } catch {
+    throw new EngineError({
+      severity: LogSeverity.WARNING,
+      message: `Pub/Sub message is not valid JSON ${subscription.name}`,
+      data: { subscription, message: message.data.toString() }
+    });
+  }
+
+  for (const handler of handlers) {
+    try {
+      await handler(payload, message.attributes, message.publishTime);
+    } catch (error) {
+      reportError(error);
+    }
+  }
+}

package/src/entities/PubSub/handleMessage/index.ts

@@ -1 +1 @@
-export * from './handleMessage';
+export * from './handleMessage';

package/src/entities/PubSub/index.ts

@@ -1,2 +1,2 @@
-export * from './PubSub';
-export * from './PubSub.types';
+export * from './PubSub';
+export * from './PubSub.types';

package/src/entities/PushNotification/PushNotification.test.ts

@@ -1,35 +1,35 @@
-import { expect } from 'chai';
-import { faker } from '@faker-js/faker';
-import { stub, SinonStub } from 'sinon';
-import { PushNotification } from './PushNotification';
-import { PushNotificationNotification } from './PushNotification.types';
-import { PubSub } from 'entities/PubSub/PubSub';
-
-describe('Entities - PushNotification', function () {
-  let notification: PushNotificationNotification;
-  let publishStub: SinonStub;
-  let userId: string;
-
-  beforeEach(() => {
-    process.env.CHART = 'test';
-    process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC = 'notification_queue';
-    userId = faker.string.uuid();
-    notification = {
-      title: faker.lorem.word(),
-      body: faker.lorem.word()
-    };
-
-    publishStub = stub(PubSub, 'publish');
-  });
-
-  it('should send push notification to the user', async () => {
-    await PushNotification.sendPush(userId, notification);
-    expect(publishStub).to.have.been.calledOnceWithExactly(
-      'notification_queue',
-      {
-        ...notification,
-        userId
-      }
-    );
-  });
-});
+import { expect } from 'chai';
+import { faker } from '@faker-js/faker';
+import { stub, SinonStub } from 'sinon';
+import { PushNotification } from './PushNotification';
+import { PushNotificationNotification } from './PushNotification.types';
+import { PubSub } from 'entities/PubSub/PubSub';
+
+describe('Entities - PushNotification', function () {
+  let notification: PushNotificationNotification;
+  let publishStub: SinonStub;
+  let userId: string;
+
+  beforeEach(() => {
+    process.env.CHART = 'test';
+    process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC = 'notification_queue';
+    userId = faker.string.uuid();
+    notification = {
+      title: faker.lorem.word(),
+      body: faker.lorem.word()
+    };
+
+    publishStub = stub(PubSub, 'publish');
+  });
+
+  it('should send push notification to the user', async () => {
+    await PushNotification.sendPush(userId, notification);
+    expect(publishStub).to.have.been.calledOnceWithExactly(
+      'notification_queue',
+      {
+        ...notification,
+        userId
+      }
+    );
+  });
+});

package/src/entities/PushNotification/PushNotification.ts

@@ -1,44 +1,44 @@
-import { PushNotificationNotification } from './PushNotification.types';
-import { EngineError } from 'entities';
-import { PubSub } from 'entities/PubSub';
-import { reportDebug } from 'utils';
-
-const namespace = 'engine:PushNotification';
-
-export const PushNotification = {
-  /** Initialize the push notification entity */
-  init(): void {
-    reportDebug({ namespace, message: 'Initializing PushNotification' });
-    if (!process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC)
-      throw new EngineError({
-        message:
-          'Environment variable PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC is not defined'
-      });
-    // Register publisher
-    PubSub.addPublisher(process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC);
-  },
-
-  /**
-   * Send a push notification through the push service
-   * @param userId - ID of the user that should receive the notification
-   * @param notification - Notification that should be sent
-   */
-  async sendPush(
-    userId: string,
-    notification: PushNotificationNotification
-  ): Promise<void> {
-    reportDebug({
-      namespace,
-      message: `Received data to send notification to user with Id '${userId}'`,
-      data: { userId, notification }
-    });
-
-    await PubSub.publish(
-      process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC as string,
-      {
-        ...notification,
-        userId
-      }
-    );
-  }
-};
+import { PushNotificationNotification } from './PushNotification.types';
+import { EngineError } from 'entities';
+import { PubSub } from 'entities/PubSub';
+import { reportDebug } from 'utils';
+
+const namespace = 'engine:PushNotification';
+
+export const PushNotification = {
+  /** Initialize the push notification entity */
+  init(): void {
+    reportDebug({ namespace, message: 'Initializing PushNotification' });
+    if (!process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC)
+      throw new EngineError({
+        message:
+          'Environment variable PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC is not defined'
+      });
+    // Register publisher
+    PubSub.addPublisher(process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC);
+  },
+
+  /**
+   * Send a push notification through the push service
+   * @param userId - ID of the user that should receive the notification
+   * @param notification - Notification that should be sent
+   */
+  async sendPush(
+    userId: string,
+    notification: PushNotificationNotification
+  ): Promise<void> {
+    reportDebug({
+      namespace,
+      message: `Received data to send notification to user with Id '${userId}'`,
+      data: { userId, notification }
+    });
+
+    await PubSub.publish(
+      process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC as string,
+      {
+        ...notification,
+        userId
+      }
+    );
+  }
+};

package/src/entities/PushNotification/PushNotification.types.ts

@@ -1,25 +1,25 @@
-/** Notification to send to the user's device */
-export interface PushNotificationNotification {
-  /** Title of the notification */
-  title?: string;
-  /** Body of the notification */
-  body?: string;
-  /** Data payload of the notification */
-  payload?: unknown;
-  /** Indicates that the notification is a VOIP notification */
-  voip?: boolean;
-  /** Indicate that it is a background notification (data only, low priority) */
-  background?: boolean;
-  /** Push token can be specified here is we want to send to a given user */
-  token?: string;
-  /** Indicates that the data content can be mutated by the client (iOS) */
-  mutable?: boolean;
-  /** Indicates that the notification requires some client side processing to be displayed (iOS) */
-  contentAvailable?: boolean;
-  /** Time to live of the notification in seconds. After this the notification will not be distributed */
-  ttl?: number;
-  /** Indicate that it is a high priority notification */
-  priority?: boolean;
-  /** Notifications with the same string here will be collapsed in the system tray */
-  collapseId?: string;
-}
+/** Notification to send to the user's device */
+export interface PushNotificationNotification {
+  /** Title of the notification */
+  title?: string;
+  /** Body of the notification */
+  body?: string;
+  /** Data payload of the notification */
+  payload?: unknown;
+  /** Indicates that the notification is a VOIP notification */
+  voip?: boolean;
+  /** Indicate that it is a background notification (data only, low priority) */
+  background?: boolean;
+  /** Push token can be specified here is we want to send to a given user */
+  token?: string;
+  /** Indicates that the data content can be mutated by the client (iOS) */
+  mutable?: boolean;
+  /** Indicates that the notification requires some client side processing to be displayed (iOS) */
+  contentAvailable?: boolean;
+  /** Time to live of the notification in seconds. After this the notification will not be distributed */
+  ttl?: number;
+  /** Indicate that it is a high priority notification */
+  priority?: boolean;
+  /** Notifications with the same string here will be collapsed in the system tray */
+  collapseId?: string;
+}

package/src/entities/PushNotification/index.ts

@@ -1,2 +1,2 @@
-export * from './PushNotification';
-export * from './PushNotification.types';
+export * from './PushNotification';
+export * from './PushNotification.types';