fix: remove query filtering

This is intented to fix the issue uncovered in #482.

It also adds `$populateParams` to the `paramsForServer`  by default, which means it now supports feathers-graph-populate out of the box, now.

Author: marshallswain

docs/getting-started.md

@@ -293,7 +293,7 @@ const defaultOptions = {
   replaceItems: false,
   skipRequestIfExists: false,
 
-  paramsForServer: [],
+  paramsForServer: ['$populateParams'],
   whitelist: [],
 
   handleEvents: {
@@ -316,7 +316,7 @@ const defaultOptions = {
 - `preferUpdate {Boolean}` - **Default:** `false` - If `true`, calling `model.save()` will do an `update` instead of a `patch`.
 - `replaceItems {Boolean}` - **Default:** `false` - If `true`, updates & patches replace the record in the store. Default is false, which merges in changes.
 - `skipRequestIfExists {Boolean}` - **Default:** `false` - For get action, if `true` the record already exists in store, skip the remote request.
-- `paramsForServer {Array}` - **Default:** `[]` - Custom query operators that are ignored in the find getter, but will pass through to the server.
+- `paramsForServer {Array}` - **Default:** `['$populateParams']` - Custom query operators that are ignored in the find getter, but will pass through to the server. It is preconfigured to work with the `$populateParams` custom operator from [feathers-graph-populate](https://feathers-graph-populate.netlify.app/).
 - `whitelist {Array}` - **Default:** `[]` - Custom query operators that will be allowed in the find getter.
 - `enableEvents {Boolean}` - **Default:** `true` - If `false` socket event listeners will be turned off. See the services
 - `handleEvents {Object}`: For this to work `enableEvents` must be `true`

docs/service-plugin.md

@@ -37,7 +37,7 @@ const servicePlugin = makeServicePlugin({
   replaceItems: false,
   skipRequestIfExists: false,
 
-  paramsForServer: [],
+  paramsForServer: ['$populateParams'],
   whitelist: [],
 
   enableEvents: true,
@@ -75,7 +75,7 @@ The following options can also be configured in [Global Configuration](getting-s
 - `preferUpdate {Boolean}` - **Default:** `globalConfig: false` - If `true`, calling `model.save()` will do an `update` instead of a `patch`.
 - `replaceItems {Boolean}` - **Default:** `globalConfig: false` - If `true`, updates & patches replace the record in the store. Default is false, which merges in changes.
 - `skipRequestIfExists {Boolean}` - **Default:** `globalConfig: false` - For get action, if `true` the record already exists in store, skip the remote request.
-- `paramsForServer {Array}` - Custom query operators that are ignored in the find getter, but will pass through to the server.
+- `paramsForServer {Array}` - **Default:** `['$populateParams']` - Custom query operators that are ignored in the find getter, but will pass through to the server. It is preconfigured to work with the `$populateParams` custom operator from [feathers-graph-populate](https://feathers-graph-populate.netlify.app/).
 - `whitelist {Array}` - Custom query operators that will be allowed in the find getter.
 - `enableEvents {Boolean}` - **Default:** `globalConfig: true` - If `false` socket event listeners will be turned off
 - `handleEvents {Object}`: For this to work `enableEvents` must be `true`
@@ -141,7 +141,7 @@ Each service comes loaded with the following default state:
       mostRecent: any
     },
 
-    paramsForServer: [],
+    paramsForServer: ['$populateParams'],
     whitelist: [],
 
     isFindPending: false,

src/index.ts

@@ -44,7 +44,7 @@ const defaults: FeathersVuexOptions = {
   debug: false, // Set to true to enable logging messages.
   keepCopiesInStore: false, // Set to true to store cloned copies in the store instead of on the Model.
   nameStyle: 'short', // Determines the source of the module name. 'short', 'path', or 'explicit'
-  paramsForServer: [], // Custom query operators that are ignored in the find getter, but will pass through to the server.
+  paramsForServer: ['$populateParams'], // Custom query operators that are ignored in the find getter, but will pass through to the server. $populateParams is for https://feathers-graph-populate.netlify.app/
   preferUpdate: false, // When true, calling model.save() will do an update instead of a patch.
   replaceItems: false, // Instad of merging in changes in the store, replace the entire record.
   serverAlias: 'api',

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

@@ -32,12 +32,8 @@ export default function makeServiceGetters() {
 
       const { paramsForServer, whitelist, keyedById } = state
       const q = _omit(params.query || {}, paramsForServer)
-      const customOperators = Object.keys(q).filter(
-        k => k[0] === '$' && !defaultOps.includes(k)
-      )
-      const cleanQuery = _omit(q, customOperators)
 
-      const { query, filters } = filterQuery(cleanQuery, {
+      const { query, filters } = filterQuery(q, {
         operators: additionalOperators.concat(whitelist)
       })
       let values = _.values(keyedById)

src/service-module/service-module.state.ts

@@ -34,6 +34,7 @@ export interface ServiceStateExclusiveDefaults {
     defaultSkip: number
     default?: PaginationState
   }
+  paramsForServer: string[]
   modelName?: string
 }
 
@@ -109,6 +110,7 @@ export default function makeDefaultState(options: MakeServicePluginOptions) {
       defaultLimit: null,
       defaultSkip: null
     },
+    paramsForServer: ['$populateParams'],
 
     isFindPending: false,
     isGetPending: false,

test/service-module/make-service-plugin.test.ts

@@ -81,7 +81,7 @@ describe('makeServicePlugin', function() {
         defaultLimit: null,
         defaultSkip: null
       },
-      paramsForServer: [],
+      paramsForServer: ['$populateParams'],
       preferUpdate: false,
       replaceItems: false,
       serverAlias: 'default',

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

@@ -177,7 +177,7 @@ describe('Service Module - Getters', function () {
 
   it('find with custom operator', function () {
     const { state } = this
-    const params = { query: { test: false, $populateQuery: 'test' } }
+    const params = { query: { test: false, $populateParams: 'test' } }
     const results = find(state)(params)
 
     assert(results.data.length === 1, 'the length was correct')
@@ -203,13 +203,11 @@ describe('Service Module - Getters', function () {
   it('find with non-whitelisted custom operator fails', function () {
     const { state } = this
     const params = { query: { $client: 'test' } }
-    let results
     try {
-      results = find(state)(params)
+      find(state)(params)
     } catch (error) {
       assert(error)
     }
-    assert(!results[0])
   })
 
   it('find with whitelisted custom operators', function () {

test/service-module/service-module.reinitialization.test.ts

@@ -82,7 +82,7 @@ describe('Service Module - Reinitialization', function() {
         defaultLimit: null,
         defaultSkip: null
       },
-      paramsForServer: [],
+      paramsForServer: ['$populateParams'],
       preferUpdate: false,
       replaceItems: false,
       serverAlias,

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

@@ -662,7 +662,7 @@ describe('Service Module', function() {
           defaultLimit: null,
           defaultSkip: null
         },
-        paramsForServer: [],
+        paramsForServer: ['$populateParams'],
         whitelist: []
       }