@go-mailer/jarvis 3.2.0 → 3.2.2

package/README.md

@@ -219,6 +219,11 @@ Keywords in request queries are used to prepare the following queries. Given the
     ```
     GET https://go-mailer.com?count=1
     ```
+6. **group**: To group items that match the query by a certain field, the `group_by` keyword is used.
+
+    ```
+    GET https://go-mailer.com?group_by=age
+    ```
 
 ### **Special Characters**
 The use of special characters in query values indicate the need to prepare the following queries:

package/lib/query.js

@@ -2,7 +2,8 @@ const buildQuery = (options) => {
   const sort_condition = options.sort_by ? buildSortOrderString(options.sort_by) : ''
   const fields_to_return = options.return_only ? buildReturnFieldsString(options.return_only) : ''
   const count = options.count || false
-  const seek_conditions = options.bool ? { ...buildBooleanQuery(options.bool || '')} : {}
+  const seek_conditions = options.bool ? { ...buildBooleanQuery(options.bool || '') } : {}
+  const group_by = options.group_by || null
 
   const { skip, limit } = determinePagination(options.page, options.population)
 
@@ -31,8 +32,21 @@ const buildQuery = (options) => {
     seek_conditions[field] = { ...condition }
   })
 
+  let pipeline = []
+  if (group_by) {
+    pipeline = generatePipeline({
+      group_by,
+      seek_conditions,
+      fields_to_return,
+      sort_condition,
+      skip,
+      limit
+    })
+  }
+
   return {
     count,
+    group_by,
     fields_to_return,
     limit,
     seek_conditions,
@@ -50,7 +64,7 @@ const buildBooleanQuery = (value) => {
       truthiness = false
       key = val.substr(1)
     }
-    
+
     return {
       ...sac,
       [key]: truthiness
@@ -108,6 +122,12 @@ const buildWildcardOptions = (key_list, value) => {
   }
 }
 
+const cleanGroupBy = (value) => {
+  if (!value || typeof value !== string) return null
+  
+  return value.split(',')[0]
+}
+
 const determinePagination = (page = 0, population = Number.MAX_SAFE_INTEGER) => {
   return {
     limit: Number(population),
@@ -115,6 +135,68 @@ const determinePagination = (page = 0, population = Number.MAX_SAFE_INTEGER) =>
   }
 }
 
+const generateGroupPipeline = ({ group_by, seek_conditions, sort_condition, skip, limit, fields_to_return, count }) => {
+  if (!group_by || typeof group_by !== 'string') return null
+
+  const pipeline = []
+  const group_field = group_by.split(',')[0]
+
+  pipeline.push({
+    $match: { ...seek_conditions }
+  })
+  
+  if (skip) {
+    pipeline.push({
+      $skip: { skip }
+    })
+  }
+  
+  if (limit) {
+    pipeline.push({
+      $limit: { limit }
+    })
+  }
+  
+  if (sort_condition){
+    const sort_options = sort_condition.split(' ').reduce((sac, condition) => {
+      let key = condition
+      let value = 1
+      if (key.includes('-')) {
+        key = key.split('-')[1]
+        value = -1
+      }
+      
+      return { ...sac, [key]: value }
+    }, {})
+
+    pipeline.push({
+      $sort: { ...sort_options }
+    })
+  }
+  
+  if (fields_to_return){
+    const projection_options = fields_to_return.split(' ').reduce((sac, condition) => ({ ...sac, [condition]: 1 }), {})
+
+    pipeline.push({
+      $project: { ...projection_options }
+    })
+  }
+  
+  pipeline.push({
+    $group: {
+      _id: { group_field: `$${group_field}`}
+    }
+  })
+
+  if (count) {
+    pipeline.push({
+      $count: "size"
+    })
+  }
+  
+  return pipeline
+}
+
 module.exports = {
   buildInQuery,
   buildNorQuery,
@@ -124,5 +206,6 @@ module.exports = {
   buildReturnFieldsString,
   buildSortOrderString,
   buildWildcardOptions,
-  determinePagination
+  determinePagination,
+  generateGroupPipeline
 }

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "@go-mailer/jarvis",
-  "version": "3.2.0",
+  "version": "3.2.2",
   "main": "index.js",
   "repository": "git@github.com:go-mailer-ltd/jarvis-node.git",
   "author": "Nathan Oguntuberu <nateoguns.work@gmail.com>",
   "license": "MIT",
+  "scripts": {
+    "test": "mocha --recursive -w -c || true"
+  },
   "dependencies": {
     "@logtail/node": "^0.3.3",
     "axios": "^1.3.4",

package/test/query.test.js

@@ -0,0 +1,46 @@
+/** */
+const { expect } = require('chai')
+const { generateGroupPipeline } = require('../lib/query')
+
+describe('Query Processor', () => {
+
+  describe('Requests: Group By', () => {
+    it('should return `null` when the group_by keyword is not used.', () => {
+      const pipeline = generateGroupPipeline({ name: 'test name' })
+      expect(pipeline).to.be.null
+    })
+    
+    it('create the correct pipeline with only `group_by` specified', () => {
+      const group_by = 'age'
+      const pipeline = generateGroupPipeline({ group_by })
+      expect(pipeline).to.deep.include({ $group: { _id: { group_field: `$${group_by}` } } })
+    })
+    
+    it('create the correct pipeline with `seek_conditions` specified', () => {
+      const group_by = 'age'
+      const seek_conditions = { status: 'active' }
+      const pipeline = generateGroupPipeline({ group_by, seek_conditions })
+      expect(pipeline).to.deep.include({ $match: seek_conditions })
+    })
+    
+    it('create the correct pipeline with `sort_conditions` specified', () => {
+      const group_by = 'age'
+      const sort_condition = '-created_on age'
+      const pipeline = generateGroupPipeline({ group_by, sort_condition })
+      expect(pipeline).to.deep.include({ $sort: { created_on: -1, age: 1 } })
+    })
+    
+    it('create the correct pipeline with only `fields_to_return` specified', () => {
+      const group_by = 'age'
+      const fields_to_return = 'age name'
+      const pipeline = generateGroupPipeline({ group_by, fields_to_return })
+      expect(pipeline).to.deep.include({ $project: { age: 1, name: 1 } })
+    })
+    
+    it('create the correct pipeline with only `count` specified', () => {
+      const group_by = 'age'
+      const pipeline = generateGroupPipeline({ group_by, count: true })
+      expect(pipeline).to.deep.include({ $count: 'size' })
+    })
+  })
+})