add unit tests

Author: dblythy

README.md

@@ -73,6 +73,7 @@ The testing pyramid emphasizes the following layers:
 - Focus on testing individual functions or components in isolation.
 - Fast, reliable, and provide detailed feedback on specific parts of your code.
 - Recommended to have a large amount of unit tests that test small units of code
+- These tests should use mocks to simulate dependencies, eliminating the need for the entire system to be operational.
 - Example: Testing a utility function or a cloud function independently.
 - Command: `npm run test:unit`
 

cloud/Hello/functions.js

@@ -0,0 +1,10 @@
+Parse.Cloud.define('hello', req => {
+  req.log.info(req);
+  return 'Hi';
+});
+
+Parse.Cloud.define('helloAsyncFunction', async req => {
+  await new Promise(resolve => setTimeout(resolve, 1000));
+  req.log.info(req);
+  return 'Hi async';
+});

cloud/TestObject/beforeSave.js

@@ -0,0 +1,39 @@
+// breaking down the beforeSave into smaller methods allows for easier testing and better separation of concerns
+export class TestObjectBeforeSave {
+  constructor(request) {
+    this.request = request;
+  }
+
+  async execute() {
+    const object = this.request.object;
+    this.validateRequest();
+    this.addBeforeSaveFlag(object);
+    await this.performAdditionalProcessing(object);
+  }
+
+  validateRequest() {
+    if (!this.request || !this.request.object) {
+      throw new Error('Invalid request object.');
+    }
+  }
+
+  addBeforeSaveFlag(object) {
+    object.set('beforeSave', true);
+  }
+
+  async performAdditionalProcessing(object) {
+    // Simulate some async operation
+    const additionalData = await this.fetchAdditionalData();
+    object.set('additionalData', additionalData);
+  }
+
+  async fetchAdditionalData() {
+    // Mock some external operation, e.g., fetching data from a database
+    return 'mockedData';
+  }
+}
+
+Parse.Cloud.beforeSave('TestObject', (req) => {
+  const beforeSaveTestObject = new TestObjectBeforeSave(req);
+  return beforeSaveTestObject.execute();
+});

cloud/functions.js

@@ -1,2 +1,5 @@
 // It is best practise to organize your cloud functions group into their own file. You can then import them in your main.js.
-await import('./functions.js');
+await Promise.all([
+  import('./Hello/functions.js'),
+  import('./TestObject/beforeSave.js')
+]);

cloud/main.js

@@ -36,3 +36,4 @@ httpServer.listen(port, function () {
 });
 // This will enable the Live Query real-time server
 await ParseServer.createLiveQueryServer(httpServer);
+console.log(`Visit http://localhost:${port}/test to check the Parse Server`);

index.js

@@ -1,14 +1,27 @@
-import jest from 'jest-mock';
-global.Parse = {
-  Cloud: {
-    define: jest.fn(),
-    beforeSave: jest.fn(),
-    run: jest.fn(),
-  },
-  Error: class ParseError extends Error {
-    constructor(code, message) {
-      super(message);
-      this.code = code;
-    }
-  },
-}
+// This is a setup file for Jest that mocks the Parse Cloud Code triggers.
+import Parse from 'parse/node';
+Parse.initialize('myAppId');
+const triggerStore = {};
+Parse.Cloud = new Proxy(
+  {},
+  {
+    get(target, prop) {
+      if (prop === 'getTrigger') {
+        return (triggerType, name) => {
+          const trigger =  triggerStore[triggerType][name];
+          if (!trigger) {
+            throw new Error(`Trigger ${triggerType}.${name} not found`);
+          }
+          return trigger;
+        }
+      }
+      if (!(prop in triggerStore)) {
+        triggerStore[prop] = {};
+      }
+      return (name, func) => {
+        triggerStore[prop][name] = func;
+      };
+    },
+  }
+);
+global.Parse = Parse;