:pencil: backend | added some jsdoc style comments to start

backend/README.md

@@ -50,7 +50,8 @@ TBD
 
 ## :pill: Tests & Code Quality
 
-TBD
+Tests are run with AVA with code coverage reporting via nyc. Look at the example test for ideas, as well as the [ava documentation](https://github.com/avajs/ava/blob/main/docs/01-writing-tests.md)
+* Run tests with coverage report with `npm test`
 
 ## :heart: Built With
 
@@ -58,3 +59,5 @@ TBD
 * [Objection](https://vincit.github.io/objection.js/) - Light ORM
 * [Knex.js](https://knexjs.org/) - Query builder
 * [Schiwfty](https://hapipal.com/docs/schwifty) - Model layer
+* [Ava](https://github.com/avajs/ava) - Easy testing
+* [Nyc](https://github.com/istanbuljs/nyc) - Test coverage with Istanbul's CLI

backend/lib/index.js

@@ -2,8 +2,25 @@ const UserPlugin = require('./plugins/user');
 const MembershipPlugin = require('./plugins/membership');
 const TestPlugin = require('./plugins/example');
 
+/**
+ * A Hapi server instance
+ * @typedef {Object} Server
+ */
+
+/**
+ * A plugin for Hapi
+ * @typedef {Object} Plugin
+ */
+
 exports.plugin = {
     name: 'main-app-plugin',
+
+    /**
+     * Main Hapi plugin that grabs all our
+     * other plugins to create the API app
+     * @param {Server} server
+     * @param {Object} options
+     */
     register: async (server, options) => {
 
         await server.register(TestPlugin, {

backend/lib/plugins/example.js

@@ -3,6 +3,12 @@ const example = require('../routes/example/base')
 module.exports = {
     name: 'myPlugin',
     version: '1.0.0',
+
+    /**
+     * Example route registration
+     * @param {Server} server
+     * @param {Object} options
+     */
     register: async (server, options) => {
         // Create a route for example
         server.route(example)

backend/lib/routes/example/base.js

@@ -1,9 +1,24 @@
 module.exports = {
     method: 'GET',
     path: '/',
+
+    /**
+     * Our request hanlder callback
+     * @param {*} request
+     * @param {*} h
+     * @returns {Object}
+     */
     handler: async function (request, h) {
         return { test: 'hello, world' }
     },
+
+    /**
+     * Our route options
+     * @param {string} description - Title for our swagger docs
+     * @param {string} notes - Subtitle for our swagger docs
+     * @param {Array} tags - Our tags
+     * @param {boolean} auth - The authentication scheme
+     */
     options: {
         description: 'Test',
         notes: 'This is an example route',

backend/lib/services/user.js

@@ -5,7 +5,12 @@ const Jwt = require('@hapi/jwt');
 const Schmervice = require('@hapipal/schmervice');
 const SecurePassword = require('secure-password');
 
+/** Class for methods used in the User plugin */
 module.exports = class UserService extends Schmervice.Service {
+    /**
+     * Unsure of what our constructor does
+     * @param  {...any} args
+     */
     constructor(...args) {
         super(...args)
         const pwd = new SecurePassword()
@@ -14,21 +19,50 @@ module.exports = class UserService extends Schmervice.Service {
             verify: Util.promisify(pwd.verify.bind(pwd))
         }
     }
+
+    /**
+     * Use knex to find users with id column
+     * @param {number} id
+     * @param {*} txn
+     * @returns
+     */
     async findById(id, txn) {
         const { User } = this.server.models()
         return await User.query(txn).throwIfNotFound().findById(id)
     }
+
+    /**
+     * Use knew to find first user with username
+     * @param {*} username
+     * @param {*} txn
+     * @returns
+     */
     async findByUsername(username, txn) {
         const { User } = this.server.models()
 
         return await User.query(txn).throwIfNotFound().first().where({ username })
     }
+
+    /**
+     * Signup function
+     * @param {*} param0
+     * @param {*} txn
+     * @returns
+     */
     async signup({ password, ...userInfo }, txn) {
         const { User } = this.server.models()
         const { id } = await User.query(txn).insert(userInfo)
         await this.changePassword(id, password, txn)
         return id
     }
+
+    /**
+     * Updates user's info
+     * @param {number} id
+     * @param {*} param1
+     * @param {*} txn
+     * @returns
+     */
     async update(id, { password, ...userInfo }, txn) {
         const { User } = this.server.models()
 
@@ -42,6 +76,13 @@ module.exports = class UserService extends Schmervice.Service {
 
         return id
     }
+
+    /**
+     * Self explanatory
+     * @param {*} param0
+     * @param {*} txn
+     * @returns
+     */
     async login({ email, password }, txn) {
         const { User } = this.server.models()
 
@@ -51,7 +92,7 @@ module.exports = class UserService extends Schmervice.Service {
             .where({ user_email: email })
 
 
-        // Uncomment to run password check using SecurePassword
+        /** Uncomment to run password check using SecurePassword */
         // const passwordCheck = await this.pwd.verify(Buffer.from(password), user.password)
         // if (passwordCheck === SecurePassword.VALID_NEEDS_REHASH) {
         //     await this.changePassword(user.id, password, txn)
@@ -62,6 +103,12 @@ module.exports = class UserService extends Schmervice.Service {
 
         return user
     }
+
+    /**
+     * Create a token to be sent in request headers
+     * @param {User} user
+     * @returns {Token}
+     */
     createToken(user) {
         const key = this.server.registrations['main-app-plugin'].options.jwtKey
 
@@ -77,6 +124,14 @@ module.exports = class UserService extends Schmervice.Service {
             ttlSec: 4 * 60 * 60 // 7 days
         })
     }
+
+    /**
+     * Use knex to try to change password entry
+     * @param {number} id
+     * @param {string} password
+     * @param {*} txn
+     * @returns {number}
+     */
     async changePassword(id, password, txn) {
         const { User } = this.server.models()
 

backend/package.json

@@ -8,7 +8,7 @@
     "migrate": "knex migrate:latest",
     "unmigrate": "knex migrate:down",
     "seed": "knex seed:run",
-    "test": "nyc ava"
+    "test": "nyc ava --timeout=3000"
   },
   "author": "TOJ",
   "license": "UNLICENSED",

backend/server/manifest.js

@@ -5,10 +5,10 @@ const Vision = require('@hapi/vision');
 const Schwifty = require('@hapipal/schwifty');
 const HapiSwagger = require('hapi-swagger');
 
-// Pull .env into process.env
+/** Pull .env into process.env */
 Dotenv.config({ path: `${__dirname}/.env` });
 
-// Glue manifest as a confidence store
+/** Glue manifest as a confidence store */
 module.exports = new Confidence.Store({
     server: {
         host: process.env.API_HOST,
@@ -34,8 +34,10 @@ module.exports = new Confidence.Store({
     },
     register: {
         plugins: [
+
+            /** Main app */
             {
-                plugin: '../lib', // Main plugin
+                plugin: '../lib',
                 routes: {
                     prefix: '/api'
                 },
@@ -46,21 +48,23 @@ module.exports = new Confidence.Store({
                             $param: 'APP_SECRET',
                             $default: 'app-secret'
                         },
-                        production: { // In production do not default to "app-secret"
+                        // Use .env file in production
+                        production: {
                             $param: 'APP_SECRET'
                         }
                     }
                 }
             },
-            // Documentaion deps
-            Inert,
-            Vision,
+
+            /** Documentaion plugins */
+            Inert, Vision,
             {
                 plugin: HapiSwagger,
                 options: {
                     info: { title: 'Test API Documentation' }
                 }
             },
+            /** Model and knex integration */
             {
                 plugin: Schwifty,
                 options: {