fix(smart-field): smart field should allow to request all fields (#861)

Author: arnaud-moncel

src/services/requested-fields-extractor.js

@@ -27,6 +27,12 @@ function extractRequestedFieldsForAssociation(associationName, requestedFields,
   return requestedFields.map((fieldName) => `${associationName}.${fieldName}`);
 }
 
+function extractRequestedSmartField(requestedFields, schema) {
+  const schemaSmartFields = schema.fields.filter(({ isVirtual }) => isVirtual);
+  return requestedFields[schema.name].split(',')
+    .filter((fieldName) => schemaSmartFields.some(({ field }) => field === fieldName));
+}
+
 /**
  * @param {Record<string, string>} requestedFields
  * @param {*} modelOrAssociation
@@ -58,9 +64,12 @@ function extractRequestedFields(requestedFields, modelOrAssociation, schemas) {
   const modelFields = requestedFields[modelOrAssociation.name].split(',')
     .filter((fieldName) => !requestedFields[fieldName]);
 
+  const smartFields = extractRequestedSmartField(requestedFields, schemas[modelOrAssociation.name]);
+
   return Array.from(new Set([
     ...primaryKeyArray,
     ...modelFields,
+    ...smartFields,
     ...allAssociationFields,
   ]));
 }

test/services/requested-fields-extractor.test.js

@@ -25,7 +25,17 @@ describe('services > requested-fields-extractor', () => {
       associations: {},
     };
 
-    const result = extractRequestedFields(fields, model);
+    const schemas = {
+      user: {
+        name: 'user',
+        fields: [{
+          field: 'name',
+          isVirtual: false,
+        }],
+      },
+    };
+
+    const result = extractRequestedFields(fields, model, schemas);
 
     expect(result).toStrictEqual(['id', 'name']);
   });
@@ -43,7 +53,17 @@ describe('services > requested-fields-extractor', () => {
       associations: {},
     };
 
-    const result = extractRequestedFields(fields, model);
+    const schemas = {
+      user: {
+        name: 'user',
+        fields: [{
+          field: 'name',
+          isVirtual: false,
+        }],
+      },
+    };
+
+    const result = extractRequestedFields(fields, model, schemas);
 
     expect(result).toStrictEqual(['id', 'name']);
   });
@@ -70,7 +90,15 @@ describe('services > requested-fields-extractor', () => {
     };
 
     const schemas = {
+      user: {
+        name: 'user',
+        fields: [{
+          field: 'name',
+          isVirtual: false,
+        }],
+      },
       addresses: {
+        name: 'addresses',
         fields: [{
           field: 'street',
           isVirtual: false,
@@ -105,7 +133,15 @@ describe('services > requested-fields-extractor', () => {
     };
 
     const schemas = {
+      user: {
+        name: 'user',
+        fields: [{
+          field: 'name',
+          isVirtual: false,
+        }],
+      },
       addresses: {
+        name: 'addresses',
         fields: [
           {
             field: 'street',
@@ -147,7 +183,15 @@ describe('services > requested-fields-extractor', () => {
     };
 
     const schemas = {
+      user: {
+        name: 'user',
+        fields: [{
+          field: 'name',
+          isVirtual: false,
+        }],
+      },
       addresses: {
+        name: 'addresses',
         fields: [
           {
             field: 'street',
@@ -166,4 +210,38 @@ describe('services > requested-fields-extractor', () => {
       'homeAddress',
     ]);
   });
+
+  it('should include requested smart field', () => {
+    expect.assertions(1);
+
+    const fields = {
+      user: 'smartField',
+    };
+
+    const model = {
+      name: 'user',
+      primaryKeys: { id: null, uid: null },
+      associations: {},
+    };
+
+    const schemas = {
+      user: {
+        name: 'user',
+        fields: [{
+          field: 'smartField',
+          isVirtual: true,
+        }, {
+          field: 'anotherSmartField',
+          isVirtual: true,
+        }],
+      },
+    };
+
+    const result = extractRequestedFields(fields, model, schemas);
+
+    expect(result).toStrictEqual([
+      'id',
+      'smartField',
+    ]);
+  });
 });