:gear: writing and adjusting backend tests

.gitignore

@@ -5,4 +5,5 @@ dist-ssr
 *.local
 **/.env
 .nyc_output
-**/generated/*
+**/generated/*
+**/.vscode

backend/lib/routes/profile/update.js

@@ -46,6 +46,7 @@ module.exports = {
 
             /** Grab payload info */
             const res = request.payload
+
             try {
                 const updatedResponses =
                     await profileService.updateResponsesInProfile(
@@ -56,6 +57,7 @@ module.exports = {
                 if (!updatedResponses) {
                     throw new RangeError('Response not updated')
                 }
+
                 return h
                     .response({
                         ok: true,

backend/lib/services/profile.js

@@ -43,7 +43,7 @@ const scoreAll = (profileList, userProfile) => {
  * Grab the zip code string
  */
 const getZipCodeFromProfile = profile => {
-    console.log('profile getZipCode', profile)
+    // console.log('profile getZipCode', profile)
     // There should only be one zip code entry per profile
     let zipRes = profile.responses.filter(
         // Whatever the zipcode questions is
@@ -198,7 +198,7 @@ module.exports = class ProfileService extends Schmervice.Service {
             return null
         }
 
-        await await Response.query().insert(responseToSave)
+        await Response.query().insert(responseToSave)
         return allResponses
     }
 
@@ -241,7 +241,7 @@ module.exports = class ProfileService extends Schmervice.Service {
         let profileIdsOfOppositeType = await Profile.query()
             .withGraphFetched('responses')
             .withGraphFetched('user')
-        
+
         // TODO: Let Objection optimize this
         const isPosterOpposite = userProfile.user.is_poster == 1 ? 0 : 1
         profileIdsOfOppositeType = profileIdsOfOppositeType.filter(
@@ -257,7 +257,7 @@ module.exports = class ProfileService extends Schmervice.Service {
         const profilePlusDistance = await Promise.all(
             profileIdsOfOppositeType.map(async profile => {
                 const targetZip = getZipCodeFromProfile(profile)
-                
+
                 if(!userZip || !targetZip) return { ...profile, distance: [9999, distanceUnit] }
 
                 const distance = await this._compareDistance(

backend/package.json

@@ -11,7 +11,7 @@
     "reseed": "knex migrate:rollback --all && knex migrate:latest && knex seed:run",
     "generate": "node ./db/data-generator/index.js",
     "seed": "knex seed:run",
-    "test": "nyc ava --timeout=3000"
+    "test": "nyc ava --timeout=5000"
   },
   "author": "TOJ",
   "license": "UNLICENSED",

backend/tests/matchqueue.spec.js

@@ -28,7 +28,7 @@ const pathToTest = {
     url: `/${params.profile_id}/queue/${params.target_id}/delete?include_profile=${params.include_profile}&reinsert=${params.reinsert}`,
 }
 
-test('path / should return ok on GET', async t => {
+test('path /<profile_id>/queue/<target_id> should return ok on PATCH', async t => {
     /**
      * Create a new server and register services,
      * models and routes for testing

backend/tests/notification.spec.js

@@ -0,0 +1,54 @@
+'use strict'
+
+const test = require('ava')
+const Hapi = require('@hapi/hapi')
+
+const plugin = require('../lib/plugins/notification')
+
+/**
+ * Route parameters
+ */
+const params = {
+    profile_id: 37
+}
+const mockReturn = {
+    queue: [
+        { mocked_profile_id: 1, target_id: 2, is_deleted: false },
+        { mocked_profile_id: 2, target_id: 3, is_deleted: false },
+        { mocked_profile_id: 3, target_id: 1, is_deleted: false },
+    ],
+}
+const pathToTest = {
+    method: 'GET',
+    url: `/${params.profile_id}/subscribe`,
+}
+
+test('path /subscribe should return ok on GET', async t => {
+    /**
+     * Create a new server and register services,
+     * models and routes for testing
+     * -
+     * NOTE: We use a mocked registerModel() and register
+     * models manually. Normally this is handled by
+     * Schwifty at runtime.
+     */
+    const server = Hapi.server()
+
+    /**
+     * Register Routes and Services as usual
+     */
+    await plugin.register(server)
+
+    /**
+     * Test the server with registered models and services
+     */
+    const { payload } = await server.inject(pathToTest)
+    console.log('---')
+    console.log(payload)
+    const res = JSON.parse(payload)
+    t.deepEqual(res.ok, true)
+    t.deepEqual(
+        res.data,
+        mockReturn.queue.map(entry => entry.target_id),
+    )
+})

backend/tests/respond.spec.js

@@ -0,0 +1,82 @@
+'use strict'
+
+const test = require('ava')
+const { stub } = require('sinon')
+const Hapi = require('@hapi/hapi')
+
+const plugin = require('../lib/plugins/profile')
+
+const Response = require('../lib/models/response')
+const ResponseKey = require('../lib/models/response-key')
+/**
+ * Route parameters
+ */
+const params = {
+    profile_id: 38
+}
+const mockReturn = {
+    responses: [
+        {
+            response_id: 1,
+            profile_id: 38,
+            response_key_id: 6,
+            val: '400'
+        },
+        {
+            response_id: 2,
+            profile_id: 38,
+            response_key_id: 7,
+            val: '90012'
+        }
+    ],
+}
+const pathToTest = {
+    method: 'POST',
+    url: `/${params.profile_id}/respond?response_key_id=5&val=999`,
+}
+
+test('path /<profile_id>/respond should return ok on POST', async t => {
+    /**
+     * Create a new server and register services,
+     * models and routes for testing
+     * -
+     * NOTE: We use a mocked registerModel() and register
+     * models manually. Normally this is handled by
+     * Schwifty at runtime.
+     */
+    const server = Hapi.server()
+    /**
+     * Overload so we don't register any models
+     * using the plugin call (see plugins/profile.js)
+     * and Manually load the model we need for the test
+     */
+    server.registerModel = () => {}
+    server.models = () => ({ Response, ResponseKey })
+    /**
+     * Register Routes and Services as usual
+     */
+    await plugin.register(server)
+    /**
+     * Replace Objection model methods with our own mock functions
+     * !: Janky - might be better to temp knex sqlite instance
+     */
+    stub(server.models()['Response'], 'query').returns({
+        where: () => mockReturn.responses,
+        insert: response => {
+            response.response_id = 3
+            mockReturn.responses.push(response)
+        }
+    })
+
+
+    /**
+     * Test the server with registered models and services
+     */
+    const { payload } = await server.inject(pathToTest)
+    const res = JSON.parse(payload)
+    t.deepEqual(res.ok, true)
+    t.deepEqual(
+        res.data,
+        mockReturn.responses,
+    )
+})

backend/tests/score.spec.js

@@ -11,7 +11,7 @@ const ZipCode = require('../lib/models/zip-code')
 const MatchQueue = require('../lib/models/matchqueue')
 
 // !: Must match the key set in servives/profile.js
-const zipcodeKey = 7 
+const zipcodeKey = 7
 
 /**
  * Route parameters
@@ -56,7 +56,7 @@ const pathToTest = {
     url: `/${params.profile_id}/score?max_distance=${params.max_distance}`,
 }
 
-test(`path ${pathToTest.path} should return ok on GET`, async t => {
+test(`path ${pathToTest.url} should return ok on GET`, async t => {
     /**
      * Create a new server and register services,
      * models and routes for testing

backend/tests/update.spec.js

@@ -0,0 +1,103 @@
+'use strict'
+
+const test = require('ava')
+const { stub } = require('sinon')
+const Hapi = require('@hapi/hapi')
+
+const plugin = require('../lib/plugins/profile')
+
+const Response = require('../lib/models/response')
+const ResponseKey = require('../lib/models/response-key')
+/**
+ * Route parameters
+ */
+const params = {
+    profile_id: 38
+}
+const mockReturn = {
+    responses: [
+        {
+            response_id: 1,
+            profile_id: 38,
+            response_key_id: 6,
+            val: '400'
+        },
+        {
+            response_id: 2,
+            profile_id: 38,
+            response_key_id: 7,
+            val: '90012'
+        }
+    ],
+}
+const pathToTest = {
+    method: 'PATCH',
+    url: `/${params.profile_id}/update/1`,
+    payload: [
+        {
+            response_id: 1,
+            profile_id: 38,
+            response_key_id: 6,
+            val: '999'
+        },
+        {
+            response_id: 2,
+            profile_id: 38,
+            response_key_id: 7,
+            val: '999'
+        }
+    ]
+}
+
+test(`path ${pathToTest.url} should return ok on ${pathToTest.method}`, async t => {
+    /**
+     * Create a new server and register services,
+     * models and routes for testing
+     * -
+     * NOTE: We use a mocked registerModel() and register
+     * models manually. Normally this is handled by
+     * Schwifty at runtime.
+     */
+    const server = Hapi.server()
+    /**
+     * Overload so we don't register any models
+     * using the plugin call (see plugins/profile.js)
+     * and Manually load the model we need for the test
+     */
+    server.registerModel = () => {}
+    server.models = () => ({ Response, ResponseKey })
+    /**
+     * Register Routes and Services as usual
+     */
+    await plugin.register(server)
+    /**
+     * Replace Objection model methods with our own mock functions
+     * !: Janky - might be better to temp knex sqlite instance
+     */
+    stub(server.models()['Response'], 'query').returns({
+        where: () => {
+            mockReturn.responses.forEach(res => {
+                res.val = '999'
+            })
+            return mockReturn.responses
+        },
+        update: () => ({
+            where: () => ({
+                where: () => {}
+            })
+        })
+    })
+
+
+    /**
+     * Test the server with registered models and services
+     */
+    const { payload } = await server.inject(pathToTest)
+    const res = JSON.parse(payload)
+
+    t.deepEqual(res.ok, true)
+    t.deepEqual(
+        res.data,
+        mockReturn.responses,
+    )
+})