feat: update resource data handling to include computed list helper fields and enhance test coverage for resource data retrieval

Author: NoOne7135

adminforth/modules/restApi.ts

@@ -274,7 +274,7 @@ const getResourceDataRequestSchema: AnySchemaObject = {
     filters: commonFiltersSchema,
     columns: {
       type: 'array',
-      description: 'Optional list of resource column names to include in returned rows. When set, the response is projected to exactly these resource columns and computed helper fields such as _label and _clickUrl are omitted.',
+      description: 'Optional list of resource column names to include in returned rows. For list requests, computed row helper fields such as _label and _clickUrl are still returned when available.',
       minItems: 1,
       uniqueItems: true,
       items: { type: 'string' },
@@ -1316,6 +1316,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
           }
         }
         const selectedColumnNameSet = selectedColumnNames ? new Set(selectedColumnNames) : undefined;
+        const shouldAddListHelpers = source === 'list';
         const selectedDataSourceColumnNameSet = selectedColumnNames
           ? new Set(selectedColumnNames.filter((columnName) => resource.dataSourceColumns.some((col) => col.name === columnName)))
           : undefined;
@@ -1331,7 +1332,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
           }
         }
 
-        const selectedDataSourceColumns = selectedDataSourceColumnNameSet
+        const selectedDataSourceColumns = selectedDataSourceColumnNameSet && !shouldAddListHelpers
           ? (
               resource.dataSourceColumns.some((col) => selectedDataSourceColumnNameSet.has(col.name))
                 ? resource.dataSourceColumns.filter((col) => selectedDataSourceColumnNameSet.has(col.name))
@@ -1382,7 +1383,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
         // for foreign keys, add references
         await Promise.all(
           resource.columns.filter((col) => (
-            col.foreignResource && (!selectedColumnNameSet || selectedColumnNameSet.has(col.name))
+            col.foreignResource && (!selectedColumnNameSet || shouldAddListHelpers || selectedColumnNameSet.has(col.name))
           )).map(async (col) => {
             let targetDataMap = {};
 
@@ -1493,7 +1494,6 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
           })
         );
 
-        const pkField = resource.columns.find((col) => col.primaryKey)?.name;
         // remove all columns which are not defined in resources, or defined but backendOnly
         {
           const ctx = {
@@ -1516,12 +1516,12 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
                 delete item[key];
               }
             }
-            if (!selectedColumnNameSet) {
+            if (!selectedColumnNameSet || shouldAddListHelpers) {
               item._label = resource.recordLabel(item);
             }
           }
         }
-        if (!selectedColumnNameSet && source === 'list' && resource.options.listTableClickUrl) {
+        if (shouldAddListHelpers && resource.options.listTableClickUrl) {
           await Promise.all(
             data.data.map(async (item) => {
                 item._clickUrl = await resource.options.listTableClickUrl(item, adminUser, resource);
@@ -1551,7 +1551,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
         if (selectedColumnNameSet) {
           for (const item of data.data) {
             for (const key of Object.keys(item)) {
-              if (!selectedColumnNameSet.has(key)) {
+              if (!selectedColumnNameSet.has(key) && key !== '_label' && key !== '_clickUrl') {
                 delete item[key];
               }
             }

tests/application/resources/cars_sl_allow_create.ts

@@ -5,6 +5,10 @@ const cars_sl = carsResourseTemplate("cars_sl", "sqlite", "id");
 
 export default {
   ...cars_sl,
+  options: {
+    ...(cars_sl as any).options,
+    listTableClickUrl: async (record: any, _adminUser: any, resource: any) => `/resource/${resource.resourceId}/show/${record.id}`,
+  },
   columns: [
     ...cars_sl.columns.filter(c => c.name !== "mileage" && c.name !== "photos" && c.name !== "generated_promo_picture"),
     {
@@ -33,4 +37,4 @@ export default {
       editReadonly: true,
     },
   ],
-};
+};

tests/jest_tests/CRUD_sqlite.test.ts

@@ -730,9 +730,10 @@ describe('POST /get_resource_data', () => {
     expect(res.status).toEqual(200);
     expect(res.body.error).toBeUndefined();
     expect(res.body.data[0]._label).toBe('🚘 Abobus amogus 🚗');
+    expect(res.body.data[0]._clickUrl).toBe(`/resource/cars_sl/show/${createdRecordId}`);
   });
 
-  it('returns exactly requested columns and omits computed helper fields', async () => {
+  it('returns requested columns with computed list helper fields', async () => {
     const res = await agent
       .set('Cookie', authCookie)
       .post('/adminapi/v1/get_resource_data')
@@ -751,9 +752,9 @@ describe('POST /get_resource_data', () => {
     expect(res.body.data[0]).toEqual({
       model: 'Abobus amogus',
       price: 1234,
+      _label: '🚘 Abobus amogus 🚗',
+      _clickUrl: `/resource/cars_sl/show/${createdRecordId}`,
     });
-    expect(res.body.data[0]._label).toBeUndefined();
-    expect(res.body.data[0]._clickUrl).toBeUndefined();
   });
 
   it('returns an error for unknown requested columns', async () => {
@@ -790,7 +791,9 @@ describe('POST /get_resource_data', () => {
 
     expect(res.status).toEqual(200);
     expect(res.body.error).toBeUndefined();
-    expect(res.body.data[0]).toEqual({});
+    expect(res.body.data[0]).toEqual({
+      _label: '👤 adminforth',
+    });
   });
 
   it('projects requested foreign columns after reference post-processing', async () => {
@@ -841,11 +844,12 @@ describe('POST /get_resource_data', () => {
 
     expect(res.status).toEqual(200);
     expect(res.body.error).toBeUndefined();
-    expect(res.body.data[0]).toEqual({
+    expect(res.body.data[0]).toMatchObject({
       seller_id: {
         label: '👤 adminforth',
         pk: adminUserId,
       },
+      _label: '🚘 Abobus amogus 🚗',
     });
   });
 
@@ -881,12 +885,13 @@ describe('POST /get_resource_data', () => {
 
     expect(res.status).toEqual(200);
     expect(res.body.error).toBeUndefined();
-    expect(res.body.data[0]).toEqual({
+    expect(res.body.data[0]).toMatchObject({
       record_id: {
         label: '🚘 Abobus amogus 🚗',
         pk: createdRecordId,
       },
     });
+    expect(res.body.data[0]._label.startsWith('Polymorphic car refs ')).toBe(true);
     expect(res.body.data[0].resource_id).toBeUndefined();
   });
 
@@ -1099,4 +1104,4 @@ describe('POST /delete_record', () => {
     expect(res.body.error).toBe("Operation aborted by hook");
   });
 
-});
+});