add copies options to get-getter

Author: fratzinger

docs/composition-api.md

@@ -119,6 +119,7 @@ And here's a look at each individual property:
   - Set `params.paginate` to `true` to turn off realtime updates for the results and defer pagination to the API server.  Pagination works the same as for the [makeFindMixin pagination](./mixins.html#pagination-with-fall-through-cacheing).
   - Set `params.debounce` to an integer and the API requests will automatically be debounced by that many milliseconds.  For example, setting `debounce: 1000` will assure that the API request will be made at most every 1 second.
   - Set `params.temps` to `true` to include temporary (local-only) items in the results. Temporary records are instances that have been created but not yet saved to the database.
+  - Set `params.copies` to `true` to include cloned items in the results. The queried items get replaced with the corresponding copies from `copiesById`
 - `fetchParams` This is a separate set of params that, when provided, will become the params sent to the API server.  The `params` will then only be used to query data from the local data store.
   - Explicitly returning `null` will prevent an API request from being made.
 - `queryWhen` must be a `computed` property which returns a `boolean`. It provides a logical separation for preventing API requests *outside* of the `params`.

docs/service-plugin.md

@@ -199,7 +199,10 @@ Service modules include the following getters:
 
 - `list {Array}` - an array of items. The array form of `keyedById`  Read only.
 - `find(params) {Function}` - a helper function that allows you to use the [Feathers Adapter Common API](https://docs.feathersjs.com/api/databases/common) and [Query API](https://docs.feathersjs.com/api/databases/querying) to pull data from the store.  This allows you to treat the store just like a local Feathers database adapter (but without hooks).
-  - `params {Object}` - an object with a `query` object and optional `paginate` and `temps` boolean properties. The `query` is in the FeathersJS query format. You can set `params.paginate` to `false` to disable pagination for a single request.
+  - `params {Object}` - an object with a `query` object and optional properties. You can set the following  properties:
+    - `params.query {Boolean}` - The `query` is in the FeathersJS query format.
+    - `params.temps {Boolean}` - **Default:** `false` - if `true` also consider temporary records from `tempsById`
+    - `params.copies {Boolean}` - **Default:** `false` - if `true`: first search for the regular records and then replace the records with the related copies from `copiesById`
 - `count(params) {Function}` - a helper function that counts items in the store matching the provided query in the params and returns this number <Badge text="3.12.0+" />
   - `params {Object}` - an object with a `query` object and an optional `temps` boolean property.
 - `get(id[, params]) {Function}` - a function that allows you to query the store for a single item, by id.  It works the same way as `get` requests in Feathers database adapters.

src/service-module/service-module.getters.ts

@@ -16,6 +16,21 @@ const OPERATORS = ['$in', '$nin', '$lt', '$lte', '$gt', '$gte', '$ne', '$or']
 const additionalOperators = ['$elemMatch']
 const defaultOps = FILTERS.concat(OPERATORS).concat(additionalOperators)
 
+const getCopiesById = ({
+  keepCopiesInStore,
+  servicePath,
+  serverAlias,
+  copiesById
+}) => {
+  if (keepCopiesInStore) {
+    return copiesById
+  } else {
+    const Model = _get(models, `[${serverAlias}].byServicePath[${servicePath}]`)
+
+    return Model.copiesById
+  }
+}
+
 export default function makeServiceGetters() {
   return {
     list(state) {
@@ -30,6 +45,9 @@ export default function makeServiceGetters() {
       // Set params.temps to true to include the tempsById records
       params.temps = params.hasOwnProperty('temps') ? params.temps : false
 
+      // Set params.copies to true to include the copiesById records
+      params.copies = params.hasOwnProperty('copies') ? params.copies : false
+
       const { paramsForServer, whitelist, keyedById } = state
       const q = _omit(params.query || {}, paramsForServer)
 
@@ -44,6 +62,18 @@ export default function makeServiceGetters() {
 
       values = values.filter(sift(query))
 
+      if (params.copies) {
+        const { idField } = state
+        const copiesById = getCopiesById(state)
+        values.forEach((val, i, arr) => {
+          const copy = copiesById[val[idField]]
+          if (copy) {
+            // replace keyedById value with existing clone value
+            arr[i] = copy
+          }
+        })
+      }
+
       const total = values.length
 
       if (filters.$sort) {
@@ -102,18 +132,8 @@ export default function makeServiceGetters() {
       return tempRecord || null
     },
     getCopyById: state => id => {
-      const { servicePath, keepCopiesInStore, serverAlias } = state
-
-      if (keepCopiesInStore) {
-        return state.copiesById[id]
-      } else {
-        const Model = _get(
-          models,
-          `[${serverAlias}].byServicePath[${servicePath}]`
-        )
-
-        return Model.copiesById[id]
-      }
+      const copiesById = getCopiesById(state)
+      return copiesById[id]
     }
   }
 }

src/utils.ts

@@ -28,6 +28,8 @@ interface Params {
   provider?: string
   route?: { [key: string]: string }
   headers?: { [key: string]: any }
+  temps?: boolean
+  copies?: boolean
 
   [key: string]: any // (JL) not sure if we want this
 }
@@ -231,7 +233,6 @@ export function getId(item, idField) {
   if (item._id != null || item.hasOwnProperty('_id')) {
     return item._id
   }
-
 }
 
 // Creates a Model class name from the last part of the servicePath

test/service-module/module.getters.test.ts

@@ -12,6 +12,8 @@ import {
   clearModels
 } from '../../src/service-module/global-models'
 
+import { values as _values } from 'lodash'
+
 const options = {
   idField: '_id',
   tempIdField: '__id',
@@ -81,24 +83,20 @@ describe('Service Module - Getters', function () {
         1: { test: true }
       }
     }
-    // @ts-ignore
+
     const result = getCopyById(state)(1)
 
-    // @ts-ignore
     assert(result.test, 'got the copy')
   })
 
   it('getCopyById with keepCopiesInStore: false', function () {
     const state = {
       keepCopiesInStore: false,
       servicePath: 'todos',
-      serverAlias: 'my-getters-test',
-      copiesById: {
-        1: { test: true }
-      }
+      serverAlias: 'my-getters-test'
     }
     Object.assign(globalModels, {
-      'my-getters-test': {
+      [state.serverAlias]: {
         byServicePath: {
           todos: {
             copiesById: {
@@ -108,31 +106,28 @@ describe('Service Module - Getters', function () {
         }
       }
     })
-    // @ts-ignore
+
     const result = getCopyById(state)(1)
 
-    // @ts-ignore
     assert(result.test, 'got the copy')
 
     clearModels()
   })
 
   it('get works on keyedById', function () {
     const { state, items } = this
-    // @ts-ignore
+
     const result = get(state)(1)
 
-    // @ts-ignore
     assert.deepEqual(result, items[0])
   })
 
   it('get works on tempsById', function () {
     const { state } = this
     const tempId = Object.keys(state.tempsById)[0]
-    // @ts-ignore
+
     const result = get(state)(tempId)
 
-    // @ts-ignore
     assert(result.__id === tempId)
   })
 
@@ -163,6 +158,162 @@ describe('Service Module - Getters', function () {
     assert(results.total === 4, 'total was correct')
   })
 
+  it('find - no copies by default', function () {
+    const state = {
+      keepCopiesInStore: false,
+      servicePath: 'todos',
+      serverAlias: 'my-getters-test',
+      keyedById: {
+        1: { _id: 1, test: true, __isClone: false },
+        2: { _id: 2, test: true, __isClone: false },
+        3: { _id: 3, test: true, __isClone: false }
+      },
+      copiesById: {
+        1: { _id: 1, test: true, __isClone: true }
+      }
+    }
+    Object.assign(globalModels, {
+      [state.serverAlias]: {
+        byServicePath: {
+          todos: {
+            copiesById: {
+              1: { _id: 1, test: true, __isClone: true }
+            }
+          }
+        }
+      }
+    })
+
+    const params = { query: {} }
+    const results = find(state)(params)
+
+    assert.deepEqual(
+      results.data,
+      _values(state.keyedById).filter(i => !i.__isClone),
+      'the list was correct'
+    )
+    assert(results.limit === 0, 'limit was correct')
+    assert(results.skip === 0, 'skip was correct')
+    assert(results.total === 3, 'total was correct')
+
+    clearModels()
+  })
+
+  it('find - with copies with keepCopiesInStore:true', function () {
+    const state = {
+      keepCopiesInStore: true,
+      idField: '_id',
+      keyedById: {
+        1: { _id: 1, test: true, __isClone: false },
+        2: { _id: 2, test: true, __isClone: false },
+        3: { _id: 3, test: true, __isClone: false }
+      },
+      copiesById: {
+        1: { _id: 1, test: true, __isClone: true }
+      }
+    }
+
+    const params = { query: {}, copies: true }
+    const results = find(state)(params)
+
+    const expected = [
+      { _id: 1, test: true, __isClone: true },
+      { _id: 2, test: true, __isClone: false },
+      { _id: 3, test: true, __isClone: false }
+    ]
+
+    assert.deepEqual(results.data, expected, 'the list was correct')
+    assert(results.limit === 0, 'limit was correct')
+    assert(results.skip === 0, 'skip was correct')
+    assert(results.total === 3, 'total was correct')
+  })
+
+  it('find - with copies with keepCopiesInStore:false', function () {
+    const state = {
+      keepCopiesInStore: false,
+      servicePath: 'todos',
+      serverAlias: 'my-getters-test',
+      idField: '_id',
+      keyedById: {
+        1: { _id: 1, test: true, __isClone: false },
+        2: { _id: 2, test: true, __isClone: false },
+        3: { _id: 3, test: true, __isClone: false }
+      }
+    }
+    Object.assign(globalModels, {
+      [state.serverAlias]: {
+        byServicePath: {
+          todos: {
+            copiesById: {
+              1: { _id: 1, test: true, __isClone: true }
+            }
+          }
+        }
+      }
+    })
+
+    const params = { query: {}, copies: true }
+    const results = find(state)(params)
+
+    const expected = [
+      { _id: 1, test: true, __isClone: true },
+      { _id: 2, test: true, __isClone: false },
+      { _id: 3, test: true, __isClone: false }
+    ]
+
+    assert.deepEqual(results.data, expected, 'the list was correct')
+    assert(results.limit === 0, 'limit was correct')
+    assert(results.skip === 0, 'skip was correct')
+    assert(results.total === 3, 'total was correct')
+
+    clearModels()
+  })
+
+  it('find - with copies and temps', function () {
+    const state = {
+      keepCopiesInStore: false,
+      servicePath: 'todos',
+      serverAlias: 'my-getters-test',
+      idField: '_id',
+      keyedById: {
+        1: { _id: 1, test: true, __isClone: false },
+        2: { _id: 2, test: true, __isClone: false },
+        3: { _id: 3, test: true, __isClone: false }
+      },
+      tempsById: {
+        abc: { __id: 'abc', test: true, __isClone: false, __isTemp: true }
+      }
+    }
+    Object.assign(globalModels, {
+      [state.serverAlias]: {
+        byServicePath: {
+          todos: {
+            copiesById: {
+              1: { _id: 1, test: true, __isClone: true }
+            }
+          }
+        }
+      }
+    })
+
+    const params = { query: {}, copies: true, temps: true }
+    const results = find(state)(params)
+
+    const expected = [
+      { _id: 1, test: true, __isClone: true },
+      { _id: 2, test: true, __isClone: false },
+      { _id: 3, test: true, __isClone: false },
+      { __id: 'abc', test: true, __isClone: false, __isTemp: true }
+    ]
+
+    assert.deepEqual(results.data, expected, 'the list was correct')
+    assert(results.limit === 0, 'limit was correct')
+    assert(results.skip === 0, 'skip was correct')
+    assert(results.total === 4, 'total was correct')
+
+    clearModels()
+  })
+
   it('find with query', function () {
     const { state } = this
     const params = { query: { test: false } }