Merge pull request feathersjs-ecosystem#459 from feathers-plus/fgraphql-2

Added support for dePopulate to fgraphql hook.

Author: eddyystop

lib/services/de-populate.js

@@ -9,7 +9,7 @@ module.exports = function (func) {
 
     (Array.isArray(items) ? items : [items]).forEach(item => {
       if (typeof func === 'function') {
-        func(item)
+        func(item);
       }
 
       removeProps('_computed', item);

lib/services/fgraphql.js

@@ -18,6 +18,7 @@ module.exports = function fgraphql (options1 = {}) {
     inclAllFieldsServer: true,
     inclAllFieldsClient: true,
     inclAllFields: null, // Will be initialized each hook call.
+    inclJoinedNames: true,
     extraAuthProps: []
   }, options1.options || {});
 
@@ -134,38 +135,46 @@ async function processRecord (store, query, depth, rec, type, j) {
   debug(`processRecord rec# ${j} typeof ${typeof rec} Type ${type}`);
   if (!rec) return; // Catch any null values from resolvers.
 
-  const allNamesInQuery = [];
   const recFieldNamesInQuery = [];
+  const joinedNamesInQuery = [];
 
   // Process every query item.
   const queryPropNames = Object.keys(query);
   for (let i = 0, ilen = queryPropNames.length; i < ilen; i++) {
     const fieldName = queryPropNames[i];
-    await processRecordQuery(store, query, depth, rec, fieldName, type, allNamesInQuery, recFieldNamesInQuery, j, i);
+    await processRecordQuery(store, query, depth, rec, fieldName, type,
+      recFieldNamesInQuery, joinedNamesInQuery, j, i);
   }
 
   // Retain only record fields selected
-  debug(`field names found ${allNamesInQuery}`);
+  debug(`field names found ${recFieldNamesInQuery} joined names ${joinedNamesInQuery}`);
   if (recFieldNamesInQuery.length || !store.options.inclAllFields || queryPropNames.includes('_none')) {
     // recs[0] may have been created by [rec] so can't replace array elem
     Object.keys(rec).forEach(key => {
-      if (!allNamesInQuery.includes(key)) {
+      if (!recFieldNamesInQuery.includes(key) && !joinedNamesInQuery.includes(key)) {
         delete rec[key];
       }
     });
   }
+
+  // Include joined names in record.
+  if (store.options.inclJoinedNames && joinedNamesInQuery.length) {
+    rec._include = joinedNamesInQuery;
+  }
 }
 
 // Process one query field for a record.
-async function processRecordQuery (store, query, depth, rec, fieldName, type, allNamesInQuery, recFieldNamesInQuery, j, i) {
+async function processRecordQuery (
+  store, query, depth, rec, fieldName, type,
+  recFieldNamesInQuery, joinedNamesInQuery, j, i
+) {
   debug(`\nprocessRecordQuery rec# ${j} Type ${type} field# ${i} name ${fieldName}`);
 
   // One way to include/exclude rec fields is to give their names a falsey value.
   // _args and _none are not record field names but special purpose
   if (query[fieldName] && fieldName !== '_args' && fieldName !== '_none') {
-    allNamesInQuery.push(fieldName);
-
     if (store.ourResolvers[type][fieldName]) {
+      joinedNamesInQuery.push(fieldName);
       await processRecordFieldResolver(store, query, depth, rec, fieldName, type);
     } else {
       debug('is not resolver call');
@@ -232,7 +241,6 @@ function convertResolverResult (result, ourQuery, fieldName, type) {
 
 function convertSdlToFeathersSchemaObject (schemaDefinitionLanguage, parse) {
   const graphQLSchemaObj = parse(schemaDefinitionLanguage);
-  // inspector('graphQLSchemaObj', graphQLSchemaObj)
   return convertDocument(graphQLSchemaObj);
 }
 

tests/services/fgraphql.js renamed to tests/services/fgraphql.test.js

@@ -21,6 +21,8 @@ describe('services fgraphql', () => {
     ['opt server-', s('str'),  r('full'),   'User',     q('obj'),   o('server-'), afterJane(),  false,  a('janeFull-') ],
     ['opt client-', s('str'),  r('full'),   'User',     q('obj'),   o('client-'), afterJane(),  true,   a('janeFull-') ],
     ['before hook', s('str'),  r('full'),   'User',     q('obj'),   o('both'),    beforeJane(), false,  a('janeFull')  ],
+    ['func params', s('param'),r('params'), 'User',     q('params'),o('both'),    afterJane(),  false,  a('janeParams')],
+    ['join names',  s('str'),  r('full'),   'User',     q('obj'),   o('join-'),   afterJane(),  false,  a('janeJoin')  ],
     // Test conversion of resolver results
     // desc,        schema,    resolvers,   recordType, query,      options,      context,      client, result
     ['undef->null', s('cnv0'), r('undefin'),'User',     q('obj'),   o('both'),    beforeJane(), false,  a('janeNull')  ],
@@ -177,6 +179,15 @@ type User {
           fullName: { nonNullTypeField: true, typeof: 'String' }
         }
       };
+    case 'param':
+      return {
+        User: {
+          firstName: { typeof: 'String' },
+          lastName: { typeof: 'String' },
+          fullName: { nonNullTypeField: true, typeof: 'String' },
+          params: { typeof: 'JSON' }
+        }
+      };
     case 'err1':
       return () => null;
 
@@ -217,6 +228,16 @@ function r (typ) {
               }
           }
         };
+      case 'params':
+        return {
+          User: {
+            // fullName: String!
+            fullName:
+              (parent, args, content, ast) => `${parent.first} ${parent.last}`, // eslint-disable-line no-unused-vars
+            params:
+              (parent, args, content, ast) => ({ args, ast })
+          }
+        };
       case 'err1':
         return { User: { fullName: 'foo' } };
 
@@ -319,6 +340,10 @@ function q (typ) {
       return        { fullName: '', first: null, last: 1              }   ;
     case 'fcn':
       return () => ({ fullName: {}                                    }  );
+    case 'params':
+      return        { fullName: {},                        params: {
+        _args: { key: 1, query: { foo: 2 }, params: { bar: 3 }, baz: 4 }
+        } }   ;
     case 'err1':
       return undefined;
 
@@ -419,6 +444,12 @@ function o (typ) {
         inclAllFieldsClient: true,
         extraAuthProps: ['foo']
       };
+    case 'join-':
+      return {
+        inclAllFieldsServer: true,
+        inclAllFieldsClient: true,
+        inclJoinedNames: false
+      };
     default:
       throw new Error(`Invalid typ ${typ} for "o" function.`);
   }
@@ -429,21 +460,28 @@ function a (typ) {
   switch (typ) {
     /* eslint-disable */
     case 'janeNull' :
-      return { first: 'Jane', last: 'Doe', fullName: null         };
+      return { first: 'Jane', last: 'Doe', fullName: null,         _include: ['fullName'] };
     case 'janeFull' :
-      return { first: 'Jane', last: 'Doe', fullName: 'Jane Doe'   };
+      return { first: 'Jane', last: 'Doe', fullName: 'Jane Doe',   _include: ['fullName'] };
     case 'janeArray' :
-      return { first: 'Jane', last: 'Doe', fullName: ['Jane Doe'] };
+      return { first: 'Jane', last: 'Doe', fullName: ['Jane Doe'], _include: ['fullName'] };
     case 'janeArray0' :
-      return { first: 'Jane', last: 'Doe', fullName: []           };
+      return { first: 'Jane', last: 'Doe', fullName: [],           _include: ['fullName'] };
     case 'janeFull-' :
-      return {                             fullName: 'Jane Doe'   };
+      return {                             fullName: 'Jane Doe',   _include: ['fullName'] };
     case 'janeMess' :
-      return { first: 'foo',  last: 'Doe', fullName: 'Jane Doe'   };
+      return { first: 'foo',  last: 'Doe', fullName: 'Jane Doe',   _include: ['fullName'] };
     case 'jane0' :
-      return { first: 'Jane'                                      };
+      return { first: 'Jane'                                                              };
     case 'janeFalsey' :
-      return {                last: 'Doe'                         };
+      return {                last: 'Doe'                                                 };
+    case 'janeJoin' :
+      return { first: 'Jane', last: 'Doe', fullName: 'Jane Doe'                           };
+    case 'janeParams' :
+      return { first: 'Jane', last: 'Doe', fullName: 'Jane Doe',   _include: ['fullName', 'params'],
+        params: {
+          args: { key: 1, query: { foo: 2 }, params: { bar: 3 }, baz: 4 }, ast: undefined
+        } };
 
     case 'S2post' :
       return {
@@ -452,7 +490,8 @@ function a (typ) {
         posts: [
           { _id: '1001', body: 'foo body' },
           { _id: '1002', body: 'bar body' },
-        ]
+        ],
+        _include: ['posts']
       };
     case 'S2parm' :
       return {
@@ -461,7 +500,8 @@ function a (typ) {
         posts: [
           { _id: '1001', body: 'foo body' },
           { _id: '9999', body: 'bar body' },
-        ]
+        ],
+        _include: ['posts']
       };
     case 'S2comm' :
       return {
@@ -470,7 +510,8 @@ function a (typ) {
         comments: [
           { _id: '2001', comment: 'foo comment' },
           { _id: '2002', comment: 'bar comment' },
-        ]
+        ],
+        _include: ['comments']
       };
     case 'S2cont' :
       return {
@@ -479,7 +520,8 @@ function a (typ) {
         posts: [
           { _id: '1001', body: 'foo body' },
           { _id: '9999', body: 'bar body' },
-        ]
+        ],
+        _include: ['posts']
       };
     case 'S2both' :
       return {
@@ -492,7 +534,8 @@ function a (typ) {
         comments: [
           { _id: '2001', comment: 'foo comment' },
           { _id: '2002', comment: 'bar comment' },
-        ]
+        ],
+        _include: ['posts', 'comments']
       };
 
     case 'S3all' :
@@ -502,29 +545,42 @@ function a (typ) {
         posts: [
           { _id: '1001',
             body: 'foo body',
-            author: { _id: '3001', first: 'Jane', last: 'Doe' }
+            author: { _id: '3001', first: 'Jane', last: 'Doe' },
+            _include: ['author']
           },
           {
             _id: '1002',
             body: 'bar body',
-            author: { _id: '3001', first: 'Jane', last: 'Doe' }
+            author: { _id: '3001', first: 'Jane', last: 'Doe' },
+            _include: ['author']
           }
         ],
         comments: [
           { _id: '2001',
             comment: 'foo comment',
-            author: { _id: '4001', first: 'Jane', last: 'Doe' }
+            author: { _id: '4001', first: 'Jane', last: 'Doe' },
+            _include: ['author']
           },
           {
             _id: '2002',
             comment: 'bar comment',
-            author: { _id: '4001', first: 'Jane', last: 'Doe' }
+            author: { _id: '4001', first: 'Jane', last: 'Doe' },
+            _include: ['author']
           }
-        ]
+        ],
+        _include: ['posts', 'comments']
       }
 
     default:
       throw new Error(`Invalid typ ${typ} for "a" function.`);
   }
   /* eslint-enable */
 }
+
+/*
+const { inspect } = require('util');
+function inspector(desc, obj) {
+  console.log(desc);
+  console.log(inspect(obj, { colors: true, depth: 5 }));
+}
+*/