@nlabs/reaktor 0.10.0 → 0.10.2

package/TEST_UTILITIES_GUIDE.md

@@ -0,0 +1,360 @@
+# Test Utilities Guide
+
+This guide explains how to use the test utilities in `src/utils/testUtils.ts` to optimize and consolidate your GraphQL query and mutation tests.
+
+## Overview
+
+The test utilities provide a standardized way to create tests for GraphQL resolvers, reducing code duplication and improving maintainability. They abstract common testing patterns into reusable functions.
+
+## Available Utilities
+
+### 1. Mock Context and Resolve Info
+
+```typescript
+import { createMockContext, createMockResolveInfo } from '../utils/testUtils';
+
+// Create a standard mock context
+const context = createMockContext();
+
+// Create a custom context with overrides
+const customContext = createMockContext({
+  databaseName: 'custom-db',
+  session: { userId: 'custom-user' }
+});
+
+// Create mock resolve info for GraphQL resolvers
+const resolveInfo = createMockResolveInfo('fieldName');
+```
+
+### 2. Mock Data Generators
+
+```typescript
+import {
+  createMockUser,
+  createMockPost,
+  createMockMessage,
+  createMockReaction,
+  createMockTag
+} from '../utils/testUtils';
+
+// Create mock data with defaults
+const user = createMockUser();
+const post = createMockPost();
+
+// Create mock data with custom values
+const customUser = createMockUser({
+  userId: 'custom-id',
+  email: 'custom@example.com'
+});
+```
+
+### 3. Mock Setup Utilities
+
+```typescript
+import { mockActionsModule, mockObjectType, setupCommonMocks } from '../utils/testUtils';
+
+// Mock actions module
+mockActionsModule('../actions/users', {
+  getUser: jest.fn(),
+  getSessionUser: jest.fn()
+});
+
+// Mock object types
+mockObjectType('../objectTypes/user', 'user');
+
+// Setup common mocks (auth utils, etc.)
+setupCommonMocks();
+```
+
+## Test Suite Creators
+
+### 1. Query Test Suite
+
+Use `createQueryTestSuite` for testing GraphQL query resolvers:
+
+```typescript
+import { createQueryTestSuite, createMockUser } from '../utils/testUtils';
+
+// Mock dependencies
+mockActionsModule('../actions/users', {
+  getUser: jest.fn(),
+  getSessionUser: jest.fn()
+});
+mockObjectType('../objectTypes/user', 'user');
+
+// Define test cases
+const testCases = [
+  {
+    name: 'getUserByEmail',
+    actionName: 'getUser',
+    args: { email: 'test@example.com' },
+    expectedCall: (context: any, args: any) => ({ email: args.email }),
+    mockReturnValue: createMockUser(),
+    errorCase: true
+  },
+  {
+    name: 'getUserById',
+    actionName: 'getUser',
+    args: { userId: 'user1' },
+    expectedCall: (context: any, args: any) => ({ userId: args.userId }),
+    mockReturnValue: createMockUser(),
+    errorCase: true
+  }
+];
+
+// Create the test suite
+createQueryTestSuite(
+  'User Queries',
+  '../actions/users',
+  '../objectTypes/user',
+  'user',
+  testCases
+);
+```
+
+### 2. Mutation Test Suite
+
+Use `createMutationTestSuite` for testing GraphQL mutation resolvers:
+
+```typescript
+import { createMutationTestSuite, createMockUser, setupCommonMocks } from '../utils/testUtils';
+
+// Setup common mocks
+setupCommonMocks();
+
+// Mock mutations module (complex setup)
+jest.mock('./users', () => ({
+  userMutations: {
+    getField: jest.fn((fieldName) => ({
+      resolve: jest.fn(async (context, args) => {
+        const actions = require('../actions/users');
+        return await actions[fieldName](context, args);
+      })
+    }))
+  }
+}));
+
+// Define test cases
+const testCases = [
+  {
+    name: 'addUser',
+    actionName: 'addUser',
+    args: { username: 'testuser', email: 'test@example.com' },
+    expectedCall: (context: any, args: any) => args,
+    mockReturnValue: createMockUser()
+  },
+  {
+    name: 'deactivateUser',
+    actionName: 'deactivateUser',
+    args: { userId: 'user1' },
+    expectedCall: (context: any, args: any) => args,
+    mockReturnValue: createMockUser(),
+    requiresAuth: true,
+    authUserId: 'user1'
+  }
+];
+
+// Create the test suite
+createMutationTestSuite(
+  'User',
+  '../actions/users',
+  './users',
+  testCases
+);
+```
+
+### 3. Integration Test Suite
+
+Use `createIntegrationTestSuite` for testing integration scenarios:
+
+```typescript
+import { createIntegrationTestSuite, createMockUser } from '../utils/testUtils';
+
+// Define test cases
+const testCases = [
+  {
+    name: 'getUserByEmail',
+    actionName: 'getUser',
+    args: { email: 'test@example.com' },
+    expectedCall: (context: any, args: any) => ({ email: args.email }),
+    successReturnValue: createMockUser(),
+    errorReturnValue: null,
+    testErrorCase: true
+  }
+];
+
+// Create the integration test suite
+createIntegrationTestSuite(
+  'User',
+  '../actions/users',
+  '../objectTypes/user',
+  'user',
+  testCases
+);
+```
+
+## Test Case Configuration
+
+### Query Test Cases
+
+```typescript
+{
+  name: string;                    // Test name
+  actionName: string;              // Action function name
+  args: any;                       // Arguments to pass
+  expectedCall: (context: any, args: any) => any;  // Expected call parameters
+  mockReturnValue?: any;           // Mock return value
+  errorCase?: boolean;             // Whether to test error handling
+}
+```
+
+### Mutation Test Cases
+
+```typescript
+{
+  name: string;                    // Test name
+  actionName: string;              // Action function name
+  args: any;                       // Arguments to pass
+  expectedCall: (context: any, args: any) => any;  // Expected call parameters
+  mockReturnValue?: any;           // Mock return value
+  requiresAuth?: boolean;          // Whether authentication is required
+  authUserId?: string;             // User ID for auth check
+  errorCase?: boolean;             // Whether to test error handling
+}
+```
+
+### Integration Test Cases
+
+```typescript
+{
+  name: string;                    // Test name
+  actionName: string;              // Action function name
+  args: any;                       // Arguments to pass
+  expectedCall: (context: any, args: any) => any;  // Expected call parameters
+  successReturnValue?: any;        // Success case return value
+  errorReturnValue?: any;          // Error case return value
+  testErrorCase?: boolean;         // Whether to test error scenarios
+}
+```
+
+## Migration Guide
+
+### From Manual Tests to Utilities
+
+**Before (Manual):**
+```typescript
+describe('User Queries', () => {
+  const mockContext = {
+    databaseName: 'test',
+    session: { userId: 'user1', username: 'testuser', userAccess: 1 }
+  };
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  describe('getUserByEmail', () => {
+    it('should call getUser action with email parameter', async () => {
+      const mockUser = { userId: 'user1', email: 'test@example.com' };
+      const { getUser } = require('../actions/users');
+      getUser.mockResolvedValue(mockUser);
+
+      const result = await getUser(mockContext, { email: 'test@example.com' });
+
+      expect(getUser).toHaveBeenCalledWith(mockContext, { email: 'test@example.com' });
+      expect(result).toEqual(mockUser);
+    });
+  });
+});
+```
+
+**After (Using Utilities):**
+```typescript
+import { createQueryTestSuite, createMockUser } from '../utils/testUtils';
+
+const testCases = [
+  {
+    name: 'getUserByEmail',
+    actionName: 'getUser',
+    args: { email: 'test@example.com' },
+    expectedCall: (context: any, args: any) => ({ email: args.email }),
+    mockReturnValue: createMockUser()
+  }
+];
+
+createQueryTestSuite('User Queries', '../actions/users', '../objectTypes/user', 'user', testCases);
+```
+
+## Benefits
+
+1. **Reduced Code Duplication**: Common test patterns are abstracted into reusable functions
+2. **Consistent Testing**: All tests follow the same structure and patterns
+3. **Easier Maintenance**: Changes to test patterns only need to be made in one place
+4. **Better Readability**: Test intentions are clearer with declarative test case definitions
+5. **Faster Development**: New tests can be created quickly by defining test cases
+
+## Best Practices
+
+1. **Use Descriptive Names**: Make test case names clear and descriptive
+2. **Group Related Tests**: Use the suite name to group related functionality
+3. **Test Both Success and Error Cases**: Include error handling tests where appropriate
+4. **Use Mock Data Generators**: Use the provided mock data generators for consistent test data
+5. **Keep Test Cases Focused**: Each test case should test one specific scenario
+
+## Example: Complete Optimized Test File
+
+```typescript
+import {
+  createQueryTestSuite,
+  createMockUser,
+  mockActionsModule,
+  mockObjectType
+} from '../utils/testUtils';
+
+// Mock dependencies
+mockActionsModule('../actions/users', {
+  getUser: jest.fn(),
+  getSessionUser: jest.fn()
+});
+
+mockObjectType('../objectTypes/user', 'user');
+
+// Define test cases
+const userQueryTestCases = [
+  {
+    name: 'getUserByEmail',
+    actionName: 'getUser',
+    args: { email: 'test@example.com' },
+    expectedCall: (context: any, args: any) => ({ email: args.email }),
+    mockReturnValue: createMockUser(),
+    errorCase: true
+  },
+  {
+    name: 'getUserById',
+    actionName: 'getUser',
+    args: { userId: 'user1' },
+    expectedCall: (context: any, args: any) => ({ userId: args.userId }),
+    mockReturnValue: createMockUser(),
+    errorCase: true
+  },
+  {
+    name: 'getUserBySession',
+    actionName: 'getSessionUser',
+    args: {},
+    expectedCall: (context: any, args: any) => ({}),
+    mockReturnValue: createMockUser(),
+    errorCase: true
+  }
+];
+
+// Create the test suite
+createQueryTestSuite(
+  'User Queries',
+  '../actions/users',
+  '../objectTypes/user',
+  'user',
+  userQueryTestCases
+);
+```
+
+This approach reduces the original 130-line test file to just 40 lines while maintaining the same test coverage and functionality.

package/coverage/actions/index.html

@@ -23,30 +23,30 @@
         <div class='clearfix'>
             
             <div class='fl pad1y space-right2'>
-                <span class="strong">57.53% </span>
+                <span class="strong">97% </span>
                 <span class="quiet">Statements</span>
-                <span class='fraction'>168/292</span>
+                <span class='fraction'>227/234</span>
             </div>
         
             
             <div class='fl pad1y space-right2'>
-                <span class="strong">33.33% </span>
+                <span class="strong">83.89% </span>
                 <span class="quiet">Branches</span>
-                <span class='fraction'>7/21</span>
+                <span class='fraction'>99/118</span>
             </div>
         
             
             <div class='fl pad1y space-right2'>
-                <span class="strong">45.91% </span>
+                <span class="strong">98.03% </span>
                 <span class="quiet">Functions</span>
-                <span class='fraction'>45/98</span>
+                <span class='fraction'>50/51</span>
             </div>
         
             
             <div class='fl pad1y space-right2'>
-                <span class="strong">53.78% </span>
+                <span class="strong">96.95% </span>
                 <span class="quiet">Lines</span>
-                <span class='fraction'>142/264</span>
+                <span class='fraction'>223/230</span>
             </div>
         
             
@@ -61,7 +61,7 @@
             </div>
         </template>
     </div>
-    <div class='status-line medium'></div>
+    <div class='status-line high'></div>
     <div class="pad1">
 <table class="coverage-summary">
 <thead>
@@ -79,33 +79,18 @@
 </tr>
 </thead>
 <tbody><tr>
-	<td class="file high" data-value="groups.ts"><a href="groups.ts.html">groups.ts</a></td>
-	<td data-value="93.15" class="pic high">
-	<div class="chart"><div class="cover-fill" style="width: 93%"></div><div class="cover-empty" style="width: 7%"></div></div>
+	<td class="file high" data-value="posts.ts"><a href="posts.ts.html">posts.ts</a></td>
+	<td data-value="97" class="pic high">
+	<div class="chart"><div class="cover-fill" style="width: 97%"></div><div class="cover-empty" style="width: 3%"></div></div>
 	</td>
-	<td data-value="93.15" class="pct high">93.15%</td>
-	<td data-value="146" class="abs high">136/146</td>
-	<td data-value="100" class="pct high">100%</td>
-	<td data-value="7" class="abs high">7/7</td>
-	<td data-value="81.13" class="pct high">81.13%</td>
-	<td data-value="53" class="abs high">43/53</td>
-	<td data-value="92.42" class="pct high">92.42%</td>
-	<td data-value="132" class="abs high">122/132</td>
-	</tr>
-
-<tr>
-	<td class="file low" data-value="tags.ts"><a href="tags.ts.html">tags.ts</a></td>
-	<td data-value="21.91" class="pic low">
-	<div class="chart"><div class="cover-fill" style="width: 21%"></div><div class="cover-empty" style="width: 79%"></div></div>
-	</td>
-	<td data-value="21.91" class="pct low">21.91%</td>
-	<td data-value="146" class="abs low">32/146</td>
-	<td data-value="0" class="pct low">0%</td>
-	<td data-value="14" class="abs low">0/14</td>
-	<td data-value="4.44" class="pct low">4.44%</td>
-	<td data-value="45" class="abs low">2/45</td>
-	<td data-value="15.15" class="pct low">15.15%</td>
-	<td data-value="132" class="abs low">20/132</td>
+	<td data-value="97" class="pct high">97%</td>
+	<td data-value="234" class="abs high">227/234</td>
+	<td data-value="83.89" class="pct high">83.89%</td>
+	<td data-value="118" class="abs high">99/118</td>
+	<td data-value="98.03" class="pct high">98.03%</td>
+	<td data-value="51" class="abs high">50/51</td>
+	<td data-value="96.95" class="pct high">96.95%</td>
+	<td data-value="230" class="abs high">223/230</td>
 	</tr>
 
 </tbody>
@@ -116,7 +101,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2025-02-04T16:39:29.322Z
+                at 2025-08-12T16:14:39.389Z
             </div>
         <script src="../prettify.js"></script>
         <script>

package/coverage/actions/notifications.ts.html

@@ -0,0 +1,223 @@
+
+<!doctype html>
+<html lang="en">
+
+<head>
+    <title>Code coverage report for actions/notifications.ts</title>
+    <meta charset="utf-8" />
+    <link rel="stylesheet" href="../prettify.css" />
+    <link rel="stylesheet" href="../base.css" />
+    <link rel="shortcut icon" type="image/x-icon" href="../favicon.png" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <style type='text/css'>
+        .coverage-summary .sorter {
+            background-image: url(../sort-arrow-sprite.png);
+        }
+    </style>
+</head>
+    
+<body>
+<div class='wrapper'>
+    <div class='pad1'>
+        <h1><a href="../index.html">All files</a> / <a href="index.html">actions</a> notifications.ts</h1>
+        <div class='clearfix'>
+            
+            <div class='fl pad1y space-right2'>
+                <span class="strong">100% </span>
+                <span class="quiet">Statements</span>
+                <span class='fraction'>18/18</span>
+            </div>
+        
+            
+            <div class='fl pad1y space-right2'>
+                <span class="strong">100% </span>
+                <span class="quiet">Branches</span>
+                <span class='fraction'>4/4</span>
+            </div>
+        
+            
+            <div class='fl pad1y space-right2'>
+                <span class="strong">100% </span>
+                <span class="quiet">Functions</span>
+                <span class='fraction'>3/3</span>
+            </div>
+        
+            
+            <div class='fl pad1y space-right2'>
+                <span class="strong">100% </span>
+                <span class="quiet">Lines</span>
+                <span class='fraction'>17/17</span>
+            </div>
+        
+            
+        </div>
+        <p class="quiet">
+            Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
+        </p>
+        <template id="filterTemplate">
+            <div class="quiet">
+                Filter:
+                <input type="search" id="fileSearch">
+            </div>
+        </template>
+    </div>
+    <div class='status-line high'></div>
+    <pre><table class="coverage">
+<tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
+<a name='L2'></a><a href='#L2'>2</a>
+<a name='L3'></a><a href='#L3'>3</a>
+<a name='L4'></a><a href='#L4'>4</a>
+<a name='L5'></a><a href='#L5'>5</a>
+<a name='L6'></a><a href='#L6'>6</a>
+<a name='L7'></a><a href='#L7'>7</a>
+<a name='L8'></a><a href='#L8'>8</a>
+<a name='L9'></a><a href='#L9'>9</a>
+<a name='L10'></a><a href='#L10'>10</a>
+<a name='L11'></a><a href='#L11'>11</a>
+<a name='L12'></a><a href='#L12'>12</a>
+<a name='L13'></a><a href='#L13'>13</a>
+<a name='L14'></a><a href='#L14'>14</a>
+<a name='L15'></a><a href='#L15'>15</a>
+<a name='L16'></a><a href='#L16'>16</a>
+<a name='L17'></a><a href='#L17'>17</a>
+<a name='L18'></a><a href='#L18'>18</a>
+<a name='L19'></a><a href='#L19'>19</a>
+<a name='L20'></a><a href='#L20'>20</a>
+<a name='L21'></a><a href='#L21'>21</a>
+<a name='L22'></a><a href='#L22'>22</a>
+<a name='L23'></a><a href='#L23'>23</a>
+<a name='L24'></a><a href='#L24'>24</a>
+<a name='L25'></a><a href='#L25'>25</a>
+<a name='L26'></a><a href='#L26'>26</a>
+<a name='L27'></a><a href='#L27'>27</a>
+<a name='L28'></a><a href='#L28'>28</a>
+<a name='L29'></a><a href='#L29'>29</a>
+<a name='L30'></a><a href='#L30'>30</a>
+<a name='L31'></a><a href='#L31'>31</a>
+<a name='L32'></a><a href='#L32'>32</a>
+<a name='L33'></a><a href='#L33'>33</a>
+<a name='L34'></a><a href='#L34'>34</a>
+<a name='L35'></a><a href='#L35'>35</a>
+<a name='L36'></a><a href='#L36'>36</a>
+<a name='L37'></a><a href='#L37'>37</a>
+<a name='L38'></a><a href='#L38'>38</a>
+<a name='L39'></a><a href='#L39'>39</a>
+<a name='L40'></a><a href='#L40'>40</a>
+<a name='L41'></a><a href='#L41'>41</a>
+<a name='L42'></a><a href='#L42'>42</a>
+<a name='L43'></a><a href='#L43'>43</a>
+<a name='L44'></a><a href='#L44'>44</a>
+<a name='L45'></a><a href='#L45'>45</a>
+<a name='L46'></a><a href='#L46'>46</a>
+<a name='L47'></a><a href='#L47'>47</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">6x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">3x</span>
+<span class="cline-any cline-yes">3x</span>
+<span class="cline-any cline-yes">3x</span>
+<span class="cline-any cline-yes">3x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">3x</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">3x</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">3x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">/**
+ * Copyright (c) 2019-Present, Nitrogen Labs, Inc.
+ * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
+ */
+// const eventCategory: string = 'notifications';
+// Push Notifications
+import {Notification as APNNotification, Provider, Responses} from 'apn';
+&nbsp;
+import {Config} from '../config.js';
+&nbsp;
+import type {NotificationType} from '../types/notifications.types.js';
+&nbsp;
+export const getApnProvider = () =&gt; new Provider({
+  ca: Config.get('app.apn.ca'),
+  cert: Config.get('app.apn.cert'),
+  key: Config.get('app.apn.key'),
+  production: Config.get('environment') === 'prod'
+});
+&nbsp;
+export const pushNotification = (deviceTokens: string[], note: NotificationType): Promise&lt;Responses&gt; =&gt; {
+  // Push notification to device
+  const provider: Provider = getApnProvider();
+  const notification: APNNotification = new APNNotification();
+  notification.topic = Config.get('app.apn.id');
+  notification.alert = note.message;
+&nbsp;
+  if(note.data) {
+    notification.mutableContent = true;
+    notification.payload = note.data;
+  }
+&nbsp;
+  if(note.badge !== undefined) {
+    notification.badge = note.badge;
+  }
+&nbsp;
+  return provider.send(notification, deviceTokens);
+};
+&nbsp;
+export const clearBadges = (deviceTokens: string[]): Promise&lt;Responses&gt; =&gt; {
+  // Push notification to device
+  const provider = getApnProvider();
+  const notification = new APNNotification();
+  notification.badge = 0;
+&nbsp;
+  return provider.send(notification, deviceTokens);
+};
+&nbsp;</pre></td></tr></table></pre>
+
+                <div class='push'></div><!-- for sticky footer -->
+            </div><!-- /wrapper -->
+            <div class='footer quiet pad2 space-top1 center small'>
+                Code coverage generated by
+                <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
+                at 2025-08-09T00:45:28.923Z
+            </div>
+        <script src="../prettify.js"></script>
+        <script>
+            window.onload = function () {
+                prettyPrint();
+            };
+        </script>
+        <script src="../sorter.js"></script>
+        <script src="../block-navigation.js"></script>
+    </body>
+</html>
+