:recycle: trying to name every backend Joi model in use | consolidate some schemas

backend/lib/routes/membership/active.js

@@ -4,6 +4,7 @@ const Joi = require('joi')
 const apiSchema = require('../../schemas/api')
 const errorSchema = require('../../schemas/errors')
 const groupingSchema = require('../../schemas/groupings')
+const params = require('../../schemas/params')
 
 const pluginConfig = {
     handlerType: 'grouping',
@@ -18,7 +19,7 @@ const validators = {
     // headers: true,
 
     /** Validate the route params (/active/{thing}) */
-    params: Joi.object({ profile_id: Joi.number() }),
+    params: params.profileId,
 
     /** Validate the route query (/active/{thing}?limit=10&offset=10) */
     query: Joi.object({ type: Joi.string().lowercase().min(6).max(11) }),
@@ -100,7 +101,7 @@ module.exports = {
         response: {
             schema: apiSchema.single.append({
                 data: responseSchemas.list
-            })
+            }).label('grouping_list_res')
         },
     },
 }

backend/lib/routes/membership/join.js

@@ -3,6 +3,7 @@ const Joi = require('joi')
 const apiSchema = require('../../schemas/api')
 const errorSchema = require('../../schemas/errors')
 const groupingSchema = require('../../schemas/groupings')
+const params = require('../../schemas/params')
 
 const pluginConfig = {
     handlerType: 'grouping',
@@ -13,18 +14,18 @@ const pluginConfig = {
 }
 
 const validators = {
-    params: Joi.object({ profile_id: Joi.number() }),
+    params: params.profileId,
     payload: groupingSchema.single.append({
         target_id: Joi.number().required(),
         role: Joi.string(),
-    })
+    }).label('grouping_membership_single')
 }
 
 const responseSchemas = {
     response: Joi.object({
         memberships: Joi.array().items(),
         hasMatch: Joi.boolean()
-    }),
+    }).label('grouping_membership_list'),
     error: errorSchema.single
 }
 
@@ -106,10 +107,10 @@ module.exports = {
             status: {
                 200: apiSchema.single.append({
                     data: responseSchemas.response,
-                }),
+                }).label('join_grouping_res'),
                 409: apiSchema.single.append({
                     data: responseSchemas.error,
-                }),
+                }).label('error_single_res'),
             },
         },
     },

backend/lib/routes/notification/index.js

@@ -1,6 +1,8 @@
 const Joi = require('joi')
 const apiSchema = require('../../schemas/api')
 const errorSchema = require('../../schemas/errors')
+const params = require('../../schemas/params')
+
 const Stream = require('stream')
 const PassThrough = require('stream').PassThrough
 
@@ -13,9 +15,7 @@ const pluginConfig = {
 }
 
 const validators = {
-    params: Joi.object({
-        profile_id: Joi.number(),
-    })
+    params: params.profileId
 }
 
 module.exports = {
@@ -44,7 +44,7 @@ module.exports = {
         },
 
         /** Validate based on validators object */
-         validate: {
+        validate: {
             ...validators,
             failAction: 'log'
         },

backend/lib/routes/profile/get.js

@@ -4,6 +4,7 @@ const Joi = require('joi')
 const apiSchema = require('../../schemas/api')
 const errorSchema = require('../../schemas/errors')
 const profileSchema = require('../../schemas/profiles')
+const params = require('../../schemas/params')
 
 const pluginConfig = {
     handlerType: 'profile',
@@ -19,7 +20,7 @@ const responseSchemas = {
 }
 
 const validators = {
-    params: Joi.object({ profile_id: Joi.number() }),
+    params: params.profileId
 }
 
 module.exports = {
@@ -66,10 +67,10 @@ module.exports = {
             status: {
                 200: apiSchema.single.append({
                     data: responseSchemas.profile,
-                }),
+                }).label('profile_single_res'),
                 409: apiSchema.single.append({
                     data: responseSchemas.error,
-                }),
+                }).label('error_single_res'),
             },
         },
     },

backend/lib/routes/profile/match.js

@@ -68,10 +68,10 @@ module.exports = {
             status: {
                 200: apiSchema.single.append({
                     data: responseSchemas.response,
-                }),
+                }).label('response_list_res'),
                 409: apiSchema.single.append({
                     data: responseSchemas.error,
-                })
+                }).label('error_single_res')
             },
         },
     },

backend/lib/routes/profile/patch-queue.js

@@ -4,6 +4,7 @@ const Joi = require('joi')
 const apiSchema = require('../../schemas/api')
 const errorSchema = require('../../schemas/errors')
 const profileSchema = require('../../schemas/profiles')
+const params = require('../../schemas/params')
 
 const pluginConfig = {
     handlerType: 'profile',
@@ -16,7 +17,7 @@ const pluginConfig = {
 const responseSchemas = {
     response: Joi.array().items(
         Joi.alternatives().try(
-            Joi.number(),
+            params.profileId,
             profileSchema.single,
         ),
     ),
@@ -24,8 +25,8 @@ const responseSchemas = {
 }
 
 const validators = {
-    params: Joi.object({ profile_id: Joi.number(), target_id: Joi.number() }),
-    query: Joi.object({ include_profile: Joi.bool(), reinsert: Joi.boolean() }),
+    params: params.profileId.append({ target_id: Joi.number() }),
+    query: params.profileInclude.append({ reinsert: Joi.boolean() }),
 }
 
 module.exports = {
@@ -80,10 +81,10 @@ module.exports = {
             status: {
                 200: apiSchema.single.append({
                     data: responseSchemas.response,
-                }),
+                }).label('match_queue_res'),
                 409: apiSchema.single.append({
                     data: responseSchemas.error,
-                })
+                }).label('error_single_res')
             },
         },
     },

backend/lib/routes/profile/queue.js

@@ -4,6 +4,7 @@ const Joi = require('joi')
 const apiSchema = require('../../schemas/api')
 const errorSchema = require('../../schemas/errors')
 const profileSchema = require('../../schemas/profiles')
+const params = require('../../schemas/params')
 
 const pluginConfig = {
     handlerType: 'profile',
@@ -16,7 +17,7 @@ const pluginConfig = {
 const responseSchemas = {
     response: Joi.array().items(
         Joi.alternatives().try(
-            Joi.number(),
+            params.profileId,
             profileSchema.single,
         )
     ),
@@ -24,8 +25,8 @@ const responseSchemas = {
 }
 
 const validators = {
-    params: Joi.object({ profile_id: Joi.number() }),
-    query: Joi.object({ include_profile: Joi.bool() }),
+    params: params.profileId,
+    query: params.profileInclude,
 }
 
 module.exports = {
@@ -85,10 +86,10 @@ module.exports = {
             status: {
                 200: apiSchema.single.append({
                     data: responseSchemas.response,
-                }),
+                }).label('match_queue_res'),
                 409: apiSchema.single.append({
                     data: responseSchemas.error,
-                })
+                }).label('error_single_res')
             },
         },
     },

backend/lib/routes/profile/respond.js

@@ -4,6 +4,7 @@ const Joi = require('joi')
 const apiSchema = require('../../schemas/api')
 const errorSchema = require('../../schemas/errors')
 const surveyResponseSchema = require('../../schemas/responses')
+const params = require('../../schemas/params')
 
 const pluginConfig = {
     handlerType: 'profile',
@@ -23,9 +24,7 @@ const validators = {
     // headers: true,
 
     /** Validate the route params (/active/{thing}) */
-    params: Joi.object({
-        profile_id: Joi.number(),
-    }),
+    params: params.profileId,
 
     /** Validate the route query (/active/{thing}?limit=10&offset=10) */
     query: Joi.object({
@@ -94,10 +93,10 @@ module.exports = {
             status: {
                 201: apiSchema.single.append({
                     data: responseSchemas.response,
-                }),
+                }).label('response_list_res'),
                 409: apiSchema.single.append({
                     data: responseSchemas.error,
-                })
+                }).label('error_single_res')
             },
         },
     },

backend/lib/routes/profile/score.js

@@ -3,6 +3,8 @@
 const Joi = require('joi')
 const apiSchema = require('../../schemas/api')
 const errorSchema = require('../../schemas/errors')
+const params = require('../../schemas/params')
+const profileSchema = require('../../schemas/profiles')
 
 const pluginConfig = {
     handlerType: 'score',
@@ -17,9 +19,7 @@ const validators = {
     // headers: true,
 
     /** Validate the route params (/active/{thing}) */
-    params: Joi.object({
-        profile_id: Joi.number(),
-    }),
+    params: params.profileId,
 
     /** Validate the route query (/active/{thing}?limit=10&offset=10) */
     query: Joi.object({
@@ -31,7 +31,7 @@ const validators = {
 }
 
 const responseSchemas = {
-    response: Joi.array().items(),
+    response: profileSchema.list,
     error: errorSchema.single
 }
 
@@ -97,10 +97,10 @@ module.exports = {
             status: {
                 200: apiSchema.single.append({
                     data: responseSchemas.response,
-                }),
+                }).label('profile_list_res'),
                 409: apiSchema.single.append({
                     data: responseSchemas.error,
-                })
+                }).label('error_single_res')
             },
         },
     },

backend/lib/routes/profile/update.js

@@ -4,6 +4,7 @@ const Joi = require('joi')
 const apiSchema = require('../../schemas/api')
 const errorSchema = require('../../schemas/errors')
 const surveyResponseSchema = require('../../schemas/responses')
+const params = require('../../schemas/params')
 
 const pluginConfig = {
     handlerType: 'profile',
@@ -23,7 +24,7 @@ const validators = {
     // headers: true,
 
     /** Validate the route params (/active/{thing}) */
-    params: Joi.object({ profile_id: Joi.number() }),
+    params: params.profileId,
 
     /** Validate the route query (/active/{thing}?limit=10&offset=10) */
     // query: true,
@@ -87,10 +88,10 @@ module.exports = {
             status: {
                 200: apiSchema.single.append({
                     data: responseSchemas.response,
-                }),
+                }).label('response_list_res'),
                 409: apiSchema.single.append({
                     data: responseSchemas.error,
-                })
+                }).label('error_single_res')
             },
         },
     },

backend/lib/routes/survey/questions.js

@@ -61,7 +61,7 @@ module.exports = {
         response: {
             schema: apiSchema.single.append({
                 data: responseSchemas.response
-            }),
+            }).label('question_list_res'),
             failAction: 'log',
         },
     },

backend/lib/routes/survey/responses.js

@@ -3,6 +3,7 @@
 const Joi = require('joi')
 const apiSchema = require('../../schemas/api')
 const surveyResponseSchema = require('../../schemas/responses')
+const params = require('../../schemas/params')
 
 const pluginConfig = {
     handlerType: 'survey',
@@ -17,7 +18,7 @@ const validators = {
     /** Validate the header (cookie check) */
     // headers: true,
     /** Validate the route params (/active/{thing}) */
-    params: Joi.object({ user_id: Joi.number() }),
+    params: params.userId,
     /** Validate the route query (/active/{thing}?limit=10&offset=10) */
     // query: true,
     /** Validate the incoming payload (POST method) */
@@ -61,7 +62,7 @@ module.exports = {
         response: {
             schema: apiSchema.single.append({
                 data: responseSchemas.response
-            }),
+            }).label('response_list_res'),
             failAction: 'log',
         },
     },

backend/lib/routes/user/create-profile.js

@@ -2,6 +2,7 @@
 
 const Joi = require('joi')
 const errorSchema = require('../../schemas/errors')
+const params = require('../../schemas/params')
 
 const pluginConfig = {
     handlerType: 'user',
@@ -16,7 +17,7 @@ const validators = {
     // headers: true,
 
     /** Validate the route params (/active/{thing}) */
-    params: Joi.object({ user_id: Joi.number() }),
+    params: params.userId,
 
     /** Validate the route query (/active/{thing}?limit=10&offset=10) */
     // query: true,
@@ -33,13 +34,8 @@ const responseSchemas = {
     response: Joi.object({
         profile_id: Joi.number(),
         user_id: Joi.number(),
-        // HELP: not sure if this is right, but attempting to fix
-        // ValidationError data[0].user_name is not allowed
-        // the logic being that CompleteProfile has had user_name added
-        // and getCompleteProfiles utilizes CompleteProfile
-        // and this route utilizes getCompleteProfiles
         user_name: Joi.string(),
-    }),
+    }).label('created_profile'),
     error: errorSchema.single
 }
 
@@ -107,12 +103,12 @@ module.exports = {
                     ok: Joi.bool(),
                     handler: Joi.string(),
                     data: responseSchemas.response,
-                }),
+                }).label('created_profile_res'),
                 409: Joi.object({
                     ok: Joi.bool(),
                     handler: Joi.string(),
                     data: responseSchemas.error,
-                }),
+                }).label('error_single_res'),
             },
         },
     },

backend/lib/routes/user/current.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const Joi = require('joi')
+const params = require('../../schemas/params')
 
 const pluginConfig = {
     handlerType: 'user',
@@ -15,10 +16,7 @@ const pluginConfig = {
 /** Validator functions by request method */
 const validators = {
     get: {
-        params: Joi.object({
-            name: Joi.string().min(3).max(11),
-            all: Joi.array(),
-        }),
+        params: params.userName,
     },
 }
 
@@ -62,7 +60,7 @@ module.exports = {
                 ok: Joi.bool(),
                 handler: Joi.string(),
                 data: validators.get.params,
-            }),
+            }).label('user_name_res'),
             failAction: 'log',
         },
     },

backend/lib/routes/user/list-profiles.js

@@ -2,6 +2,8 @@
 
 const Joi = require('joi')
 const errorSchema = require('../../schemas/errors')
+const profileSchema = require('../../schemas/profiles')
+const params = require('../../schemas/params')
 
 const pluginConfig = {
     handlerType: 'user',
@@ -16,9 +18,7 @@ const validators = {
     // headers: true,
 
     /** Validate the route params (/active/{thing}) */
-    params: Joi.object({
-        user_id: Joi.number(),
-    }),
+    params: params.userId,
 
     /** Validate the route query (/active/{thing}?limit=10&offset=10) */
     // query: true,
@@ -27,26 +27,7 @@ const validators = {
 }
 
 const responseSchemas = {
-    profilesList: Joi.object({
-        profile_id: Joi.number().integer().greater(0).required(),
-        user_id: Joi.number().integer().greater(0).required(),
-        // HELP: not sure if this is right, but attempting to fix
-        // ValidationError data[0].user_name is not allowed
-        // the logic being that CompleteProfile has had user_name added
-        // and getCompleteProfiles utilizes CompleteProfile
-        // and this route utilizes getCompleteProfiles
-        user_name: Joi.string(),
-        tags: Joi.array().items(),
-        responses: Joi.array().items(
-            Joi.object({
-                response_key_id: Joi.number().required(),
-                profile_id: Joi.number().required(),
-                response_id: Joi.number().required(),
-                val: Joi.string().required(),
-            }),
-        ),
-        user_type: Joi.string().required(),
-    }),
+    profilesList: profileSchema.list,
     error: errorSchema.single
 }
 
@@ -95,13 +76,13 @@ module.exports = {
                 200: Joi.object({
                     ok: Joi.bool(),
                     handler: Joi.string(),
-                    data: Joi.array().items(responseSchemas.profilesList),
-                }),
+                    data: responseSchemas.profilesList,
+                }).label('list_profiles_res'),
                 500: Joi.object({
                     ok: Joi.bool(),
                     handler: Joi.string(),
                     data: responseSchemas.error,
-                }),
+                }).label('error_single_res'),
             },
         },
     },

backend/lib/routes/user/login.js

@@ -1,6 +1,8 @@
 'use strict'
 
 const Joi = require('joi')
+const errorSchema = require('../../schemas/errors')
+const userSchema = require('../../schemas/user')
 
 const pluginConfig = {
     handlerType: 'user',
@@ -14,18 +16,11 @@ const pluginConfig = {
 const validators = {
     post: {
         payload: Joi.object({
-            user: Joi.object(),
-            error: Joi.string(),
-        }),
+            user: userSchema.single,
+            error: errorSchema.single,
+        }).append().label('login_payload'),
     },
-    user: Joi.object({
-        user_id: Joi.number(),
-        user_name: Joi.string(),
-        user_email: Joi.string(),
-        created_at: Joi.date(),
-        updated_at: Joi.date(),
-        token: Joi.string(),
-    }),
+    user: userSchema.single,
 }
 
 module.exports = {
@@ -76,7 +71,7 @@ module.exports = {
                 ok: Joi.bool(),
                 handler: Joi.string(),
                 data: validators.user,
-            }),
+            }).label('login_res'),
             failAction: 'log',
         },
     },

backend/lib/schemas/groupings.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const Joi = require('joi')
+const surveyProfileSchema = require('./profiles')
 
 const singleGrouping = Joi.object({
     grouping_id: Joi.number(),
@@ -12,7 +13,7 @@ const singleWithProfile = Joi.object({
     grouping_id: Joi.number(),
     grouping_name: Joi.string(),
     grouping_type: Joi.string(),
-    profile: Joi.object()
+    profile: surveyProfileSchema.single
 }).label('grouping_single_with_profile')
 
 module.exports = {

backend/lib/schemas/params.js

@@ -0,0 +1,11 @@
+const Joi = require('joi')
+
+module.exports = {
+    profileId: Joi.object({ profile_id: Joi.number() }).label('profile_id_param'),
+    profileInclude: Joi.object({ include_profile: Joi.bool() }),
+    userId: Joi.object({ user_id: Joi.number() }).label('user_id_param'),
+    userName: Joi.object({
+        name: Joi.string().min(3).max(11),
+        all: Joi.array(),
+    }).label('user_name_param')
+}

backend/lib/schemas/profiles.js

@@ -2,6 +2,7 @@
 
 const Joi = require('joi')
 const surveyResponseSchema = require('./responses')
+const userSchema = require('./user')
 
 const singleProfile = Joi.object({
     profile_id: Joi.number(),
@@ -10,7 +11,7 @@ const singleProfile = Joi.object({
     responses: surveyResponseSchema.list,
     tags: Joi.array().items(),
     user_type: Joi.any(),
-    user: Joi.object(),
+    user: userSchema.single,
     profile_description: Joi.string().allow(null, ''),
     profile_prefs: Joi.object(),
     profile_media: Joi.array().items(),

backend/lib/schemas/user.js

@@ -0,0 +1,16 @@
+'use strict'
+
+const Joi = require('joi')
+
+const singleUser = Joi.object({
+    user_id: Joi.number(),
+    user_name: Joi.string(),
+    user_email: Joi.string(),
+    created_at: Joi.date(),
+    updated_at: Joi.date(),
+    token: Joi.string()
+}).label('user_single')
+
+module.exports = {
+    single: singleUser
+}