push result ok

Author: alexanderkirtzel

packages/sources/node/src/__tests__/destination.test.ts

@@ -320,7 +320,7 @@ describe('Destination', () => {
 
     expect(result).toEqual({
       event: expect.any(Object),
-      status: { ok: false },
+      ok: false,
       successful: [
         {
           id: 'mockDestination',
@@ -361,7 +361,7 @@ describe('Destination', () => {
     result = await elb(mockEvent);
     expect(result).toStrictEqual(
       expect.objectContaining({
-        status: { ok: true },
+        ok: true,
         successful: [expect.objectContaining({ id: 'mockDestination' })],
         queued: [expect.objectContaining({ id: 'destinationConsent' })],
       }),
@@ -370,7 +370,7 @@ describe('Destination', () => {
     result = await elb('walker consent', { test: false });
     expect(result).toStrictEqual(
       expect.objectContaining({
-        status: { ok: true },
+        ok: true,
         successful: [],
         queued: [],
         failed: [],
@@ -386,7 +386,7 @@ describe('Destination', () => {
     );
     expect(result).toStrictEqual(
       expect.objectContaining({
-        status: { ok: true },
+        ok: true,
         successful: [expect.objectContaining({ id: 'destinationConsent' })],
         queued: [],
       }),

packages/sources/node/src/__tests__/source.test.ts

@@ -65,8 +65,8 @@ describe('Source Node', () => {
       expect.anything(),
     );
     expect(result).toEqual({
+      ok: true,
       event: mockEvent,
-      status: { ok: true },
       successful: [{ id: 'mock', destination: mockDestination }],
       queued: [],
       failed: [],
@@ -124,13 +124,10 @@ describe('Source Node', () => {
     const elbWithZeroParams = elb as unknown as () => Promise<Elb.PushResult>;
 
     result = await elbWithZeroParams();
-
-    expect(result.status).toHaveProperty('ok', false);
-    expect(result.status.error).toBe('Error: Event name is required');
+    expect(result.ok).toBeFalsy();
 
     result = await elb('foo');
-    expect(result.status).toHaveProperty('ok', false);
-    expect(result.status.error).toBe('Error: Event name is invalid');
+    expect(result.ok).toBeFalsy();
   });
 
   test('globals', async () => {

packages/sources/node/src/lib/push.ts

@@ -2,6 +2,7 @@ import type { WalkerOS } from '@elbwalker/types';
 import type { SourceNode, Elb } from '../types';
 import {
   assign,
+  createPushResult,
   isCommand,
   isSameType,
   pushToDestinations,
@@ -15,12 +16,7 @@ export function createPush(instance: SourceNode.Instance): Elb.Fn {
     data: Elb.PushData = {},
     options?: Elb.PushOptions,
   ) => {
-    let result: Elb.PushResult = {
-      status: { ok: false },
-      successful: [],
-      queued: [],
-      failed: [],
-    };
+    let result: Elb.PushResult;
 
     return await tryCatchAsync(
       async (
@@ -36,28 +32,19 @@ export function createPush(instance: SourceNode.Instance): Elb.Fn {
 
         if (command) {
           // Command event
-          const commandResult = await handleCommand(
-            instance,
-            command,
-            data,
-            options,
-          );
-          result = assign(result, commandResult);
+          result = await handleCommand(instance, command, data, options);
         } else if (event) {
           // Regular event
-          const eventResult = await pushToDestinations(instance, event);
-          result = assign(result, eventResult);
-          result.event = event;
+          result = await pushToDestinations(instance, event);
         }
 
-        return assign({ status: { ok: true } }, result);
+        return createPushResult(result);
       },
       (error) => {
         // Call custom error handling
         if (instance.config.onError) instance.config.onError(error, instance);
 
-        result.status.error = String(error);
-        return result;
+        return createPushResult({ ok: false });
       },
     )(nameOrEvent, data, options);
   };

packages/types/src/elb.ts

@@ -54,12 +54,7 @@ export type PushContext = WalkerOS.OrderedProperties;
 
 export interface PushResult extends Destination.Result {
   event?: WalkerOS.Event;
-  status: Status;
-}
-
-export interface Status {
   ok: boolean;
-  error?: string;
 }
 
 type FnParameters<T> = T extends (...args: unknown[]) => unknown

packages/utils/src/__tests__/destination.test.ts

@@ -53,11 +53,11 @@ describe('Destination', () => {
   test('allowed', async () => {
     const instance = createInstance({ allowed: false });
     let result = await pushToDestinations(instance, event);
-    expect(result.status.ok).toBeFalsy();
+    expect(result.ok).toBeFalsy();
 
     instance.allowed = true;
     result = await pushToDestinations(instance, event);
-    expect(result.status.ok).toBeTruthy();
+    expect(result.ok).toBeTruthy();
   });
 
   test('preventing data manipulation', async () => {
@@ -108,7 +108,7 @@ describe('Destination', () => {
       destination,
     });
     expect(result.failed).toHaveLength(1);
-    expect(result.status.ok).toBeFalsy();
+    expect(result.ok).toBeFalsy();
     expect(mockPush).toHaveBeenCalledTimes(1);
     expect(destination.dlq).toContainEqual([event, new Error('kaputt')]);
   });

packages/utils/src/core/destination.ts

@@ -52,7 +52,7 @@ export async function pushToDestinations(
   const { allowed, consent, globals, user } = instance;
 
   // Check if instance is allowed to push
-  if (!allowed) return createPushResult({ status: { ok: false } });
+  if (!allowed) return createPushResult({ ok: false });
 
   // Add event to the instance queue
   if (event) instance.queue.push(event);
@@ -194,12 +194,13 @@ export async function pushToDestinations(
     }
   }
 
-  return {
-    status: { ok },
+  return createPushResult({
+    ok,
+    event,
     successful,
     queued,
     failed,
-  };
+  });
 }
 
 export async function destinationInit<
@@ -310,19 +311,13 @@ export async function resolveMappingData(
 export function createPushResult(
   partialResult?: Partial<Elb.PushResult>,
 ): Elb.PushResult {
-  const result: Elb.PushResult = assign(
+  return assign(
     {
+      ok: !partialResult?.failed?.length,
       successful: [],
       queued: [],
       failed: [],
-      status: {},
     },
     partialResult,
   );
-
-  // Check if some destinations failed
-  if (!isDefined(result.status.ok))
-    result.status.ok = result.failed.length === 0;
-
-  return result;
 }