[sync] fix(t1557): export personal view losing view condition (#986) (#2395)

Synced from teableio/teable-ee@3f3fe02

Co-authored-by: teable-bot <bot@teable.io>

Author: tea-artist

apps/nestjs-backend/src/features/export/open-api/export-open-api.controller.ts

@@ -1,5 +1,7 @@
 import { Controller, Get, UseGuards, Param, Res, Query } from '@nestjs/common';
+import { type IExportCsvRo, exportCsvRoSchema } from '@teable/openapi';
 import { Response } from 'express';
+import { ZodValidationPipe } from '../../../zod.validation.pipe';
 import { Permissions } from '../../auth/decorators/permissions.decorator';
 import { PermissionGuard } from '../../auth/guard/permission.guard';
 import { ExportOpenApiService } from './export-open-api.service';
@@ -12,9 +14,9 @@ export class ExportOpenApiController {
   @Permissions('table|export', 'view|read')
   async exportCsvFromTable(
     @Param('tableId') tableId: string,
-    @Query('viewId') viewId: string,
+    @Query(new ZodValidationPipe(exportCsvRoSchema)) query: IExportCsvRo,
     @Res({ passthrough: true }) response: Response
   ): Promise<void> {
-    return await this.exportOpenService.exportCsvFromTable(response, tableId, viewId);
+    return await this.exportOpenService.exportCsvFromTable(response, tableId, query);
   }
 }

apps/nestjs-backend/src/features/export/open-api/export-open-api.service.ts

@@ -1,9 +1,11 @@
 import { Readable } from 'stream';
 import { Injectable, Logger } from '@nestjs/common';
-import type { IAttachmentCellValue, IFilter } from '@teable/core';
-import { FieldType, HttpErrorCode, mergeFilter, ViewType } from '@teable/core';
+import type { IAttachmentCellValue, IFieldVo } from '@teable/core';
+import { FieldType, HttpErrorCode, ViewType } from '@teable/core';
 import { PrismaService } from '@teable/db-main-prisma';
+import type { IExportCsvRo } from '@teable/openapi';
 import type { Response } from 'express';
+import { keyBy, sortBy } from 'lodash';
 import Papa from 'papaparse';
 import { CustomHttpException } from '../../../custom.exception';
 import { FieldService } from '../../field/field.service';
@@ -18,15 +20,16 @@ export class ExportOpenApiService {
     private readonly recordService: RecordService,
     private readonly prismaService: PrismaService
   ) {}
-  async exportCsvFromTable(
-    response: Response,
-    tableId: string,
-    viewId?: string,
-    exportQuery?: {
-      projection?: string[];
-      recordFilter?: IFilter;
-    }
-  ) {
+  async exportCsvFromTable(response: Response, tableId: string, query?: IExportCsvRo) {
+    const {
+      viewId,
+      filter: queryFilter,
+      orderBy: queryOrderBy,
+      groupBy: queryGroupBy,
+      projection,
+      ignoreViewQuery,
+      columnMeta: queryColumnMeta,
+    } = query ?? {};
     let count = 0;
     let isOver = false;
     const csvStream = new Readable({
@@ -48,7 +51,7 @@ export class ExportOpenApiService {
         });
       });
 
-    if (viewId) {
+    if (viewId && !ignoreViewQuery) {
       viewRaw = await this.prismaService.view
         .findUnique({
           where: {
@@ -57,10 +60,9 @@ export class ExportOpenApiService {
             deletedTime: null,
           },
           select: {
-            name: true,
             id: true,
             type: true,
-            filter: true,
+            name: true,
           },
         })
         .catch((e) => {
@@ -93,20 +95,27 @@ export class ExportOpenApiService {
     csvStream.pipe(response);
 
     // set headers as first row
-    const headers = (
-      await this.fieldService.getFieldsByQuery(tableId, {
-        viewId: viewRaw?.id ? viewRaw?.id : undefined,
-        filterHidden: viewRaw?.id ? true : undefined,
-      })
-    ).filter((field) => {
-      if (exportQuery?.projection) {
-        return exportQuery?.projection.includes(field.id);
-      }
-
-      return true;
+    const viewIdForQuery = ignoreViewQuery ? undefined : viewRaw?.id;
+    let allFields = await this.fieldService.getFieldsByQuery(tableId, {
+      viewId: viewIdForQuery,
+      filterHidden: Boolean(viewIdForQuery),
     });
+
+    // Sort fields based on:
+    // 1. If ignoreViewQuery is true and queryColumnMeta is provided, sort by queryColumnMeta order
+    // 2. If viewId is provided (and ignoreViewQuery is false), getFieldsByQuery already sorted by view columnMeta
+    // 3. Otherwise, keep table's original field order
+    allFields = this.sortFieldsByColumnMeta(allFields, ignoreViewQuery, queryColumnMeta);
+
+    const fieldsMap = keyBy(allFields, 'id');
+    // Filter by projection but keep the original field order from view/table
+    const headers = allFields.filter((field) => !projection || projection.includes(field.id));
     const headerData = Papa.unparse([headers.map((h) => h.name)]);
 
+    const projectionNames = projection
+      ? (projection.map((p) => fieldsMap[p]?.name).filter((p) => Boolean(p)) as string[])
+      : undefined;
+
     const headersInfoMap = new Map(
       headers.map((h, index) => [
         h.name,
@@ -122,22 +131,23 @@ export class ExportOpenApiService {
     csvStream.push('\uFEFF');
     csvStream.push(headerData);
 
-    const mergedFilter = viewRaw?.filter
-      ? mergeFilter(JSON.parse(viewRaw?.filter), exportQuery?.recordFilter)
-      : exportQuery?.recordFilter;
-
     try {
       while (!isOver) {
         const { records } = await this.recordService.getRecords(
           tableId,
           {
             take: 1000,
             skip: count,
-            viewId: viewRaw?.id ? viewRaw?.id : undefined,
-            filter: mergedFilter,
+            viewId: viewIdForQuery,
+            filter: queryFilter,
+            orderBy: queryOrderBy,
+            groupBy: queryGroupBy,
+            ignoreViewQuery,
+            projection: projectionNames,
           },
           true
         );
+
         if (records.length === 0) {
           isOver = true;
           // end the stream
@@ -164,6 +174,7 @@ export class ExportOpenApiService {
             return recordsArr;
           })
         );
+
         csvStream.push('\r\n');
         csvStream.push(csvData);
         count += records.length;
@@ -174,4 +185,24 @@ export class ExportOpenApiService {
       this.logger.error((e as Error)?.message, `ExportCsv: ${tableId}`);
     }
   }
+
+  /**
+   * Sort fields based on columnMeta order
+   * @param fields - The fields to sort
+   * @param ignoreViewQuery - Whether to ignore view query
+   * @param queryColumnMeta - The columnMeta from query params for custom sorting
+   * @returns Sorted fields
+   */
+  private sortFieldsByColumnMeta(
+    fields: IFieldVo[],
+    ignoreViewQuery?: boolean,
+    queryColumnMeta?: Record<string, { order: number }>
+  ): IFieldVo[] {
+    // If ignoreViewQuery is true and queryColumnMeta is provided, sort by queryColumnMeta order
+    if (ignoreViewQuery && queryColumnMeta) {
+      return sortBy(fields, (field) => queryColumnMeta[field.id]?.order ?? Infinity);
+    }
+    // Otherwise, keep the order from getFieldsByQuery (either view columnMeta order or table original order)
+    return fields;
+  }
 }

apps/nestjs-backend/test/table-export.e2e-spec.ts

@@ -3,7 +3,7 @@ import fs from 'fs';
 import path from 'path';
 import type { INestApplication } from '@nestjs/common';
 import type { IFieldVo, IViewRo } from '@teable/core';
-import { FieldType, Colors, Relationship, ViewType, DriverClient } from '@teable/core';
+import { FieldType, Colors, Relationship, ViewType, DriverClient, SortFunc } from '@teable/core';
 import type { INotifyVo } from '@teable/openapi';
 import {
   exportCsvFromTable as apiExportCsvFromTable,
@@ -315,7 +315,7 @@ describe.skipIf(globalThis.testConfig.driver === DriverClient.Sqlite)(
         type: ViewType.Grid,
       });
 
-      const exportRes = await apiExportCsvFromTable(mainTable.id, view2.id);
+      const exportRes = await apiExportCsvFromTable(mainTable.id, { viewId: view2.id });
       const { data: csvData } = exportRes;
 
       await apiDeleteTable(baseId, mainTable.id);
@@ -345,7 +345,7 @@ describe.skipIf(globalThis.testConfig.driver === DriverClient.Sqlite)(
         type: ViewType.Grid,
       });
 
-      const exportRes = await apiExportCsvFromTable(mainTable.id, view2.id);
+      const exportRes = await apiExportCsvFromTable(mainTable.id, { viewId: view2.id });
       const { data: csvData } = exportRes;
 
       await apiDeleteTable(baseId, mainTable.id);
@@ -355,5 +355,149 @@ describe.skipIf(globalThis.testConfig.driver === DriverClient.Sqlite)(
         `Text field,Checkbox field,Select field,Date field,Attachment field,User Field,Link field,Link field from lookups sub_Name,Link field from lookups sub_Number,Link field from lookups sub_Checkbox,Link field from lookups sub_SingleSelect\r\ntxt1,true,x,"November 28, 2022",test.txt ${txtFileData.presignedUrl},,Name1,Name1,1.00,true,sub_y\r\ntxt2,,y,"November 28, 2022",,test,,,,,\r\n,true,z,,,,,,,,`
       );
     });
+
+    it(`should return a csv stream with filter parameter (personal view filter)`, async () => {
+      const { mainTable, subTable } = await createTables();
+
+      const textField = mainTable?.fields?.find((f) => f.name === 'Text field') as IFieldVo;
+
+      // Export with filter to only include records where Text field = 'txt1'
+      const exportRes = await apiExportCsvFromTable(mainTable.id, {
+        filter: {
+          conjunction: 'and',
+          filterSet: [
+            {
+              fieldId: textField.id,
+              operator: 'is',
+              value: 'txt1',
+            },
+          ],
+        },
+      });
+      const { data: csvData } = exportRes;
+
+      await apiDeleteTable(baseId, mainTable.id);
+      await apiDeleteTable(baseId, subTable.id);
+
+      // Should only contain the first record with txt1
+      expect(csvData).toBe(
+        `Text field,Number field,Checkbox field,Select field,Date field,Attachment field,User Field,Link field,Link field from lookups sub_Name,Link field from lookups sub_Number,Link field from lookups sub_Checkbox,Link field from lookups sub_SingleSelect\r\ntxt1,1.00,true,x,"November 28, 2022",test.txt ${txtFileData.presignedUrl},,Name1,Name1,1.00,true,sub_y`
+      );
+    });
+
+    it(`should return a csv stream with projection parameter (only specified fields)`, async () => {
+      const { mainTable, subTable } = await createTables();
+
+      const textField = mainTable?.fields?.find((f) => f.name === 'Text field') as IFieldVo;
+      const numberField = mainTable?.fields?.find((f) => f.name === 'Number field') as IFieldVo;
+      const selectField = mainTable?.fields?.find((f) => f.name === 'Select field') as IFieldVo;
+
+      // Export with projection to only include specific fields
+      const exportRes = await apiExportCsvFromTable(mainTable.id, {
+        projection: [textField.id, numberField.id, selectField.id],
+      });
+      const { data: csvData } = exportRes;
+
+      await apiDeleteTable(baseId, mainTable.id);
+      await apiDeleteTable(baseId, subTable.id);
+
+      // Should only contain the specified fields in projection order
+      expect(csvData).toBe(`Text field,Number field,Select field\r\ntxt1,1.00,x\r\ntxt2,,y\r\n,,z`);
+    });
+
+    it(`should return a csv stream with orderBy parameter (sorted export)`, async () => {
+      const { mainTable, subTable } = await createTables();
+
+      const textField = mainTable?.fields?.find((f) => f.name === 'Text field') as IFieldVo;
+
+      // Export with orderBy to sort by Text field descending
+      const exportRes = await apiExportCsvFromTable(mainTable.id, {
+        orderBy: [
+          {
+            fieldId: textField.id,
+            order: SortFunc.Desc,
+          },
+        ],
+        projection: [textField.id], // Use projection to simplify test assertion
+      });
+      const { data: csvData } = exportRes;
+
+      await apiDeleteTable(baseId, mainTable.id);
+      await apiDeleteTable(baseId, subTable.id);
+
+      // Records should be sorted: txt2, txt1, empty
+      expect(csvData).toBe(`Text field\r\ntxt2\r\ntxt1\r\n`);
+    });
+
+    it(`should return a csv stream with ignoreViewQuery parameter (ignore view filter)`, async () => {
+      const { mainTable, subTable } = await createTables();
+
+      const textField = mainTable?.fields?.find((f) => f.name === 'Text field') as IFieldVo;
+
+      // Create a view with filter
+      const viewWithFilter = await createView(mainTable.id, {
+        type: ViewType.Grid,
+        filter: {
+          conjunction: 'and',
+          filterSet: [
+            {
+              fieldId: textField.id,
+              operator: 'is',
+              value: 'txt1',
+            },
+          ],
+        },
+      });
+
+      // Export with ignoreViewQuery=true should return all records despite view filter
+      const exportRes = await apiExportCsvFromTable(mainTable.id, {
+        viewId: viewWithFilter.id,
+        ignoreViewQuery: true,
+        projection: [textField.id],
+      });
+      const { data: csvData } = exportRes;
+
+      await apiDeleteTable(baseId, mainTable.id);
+      await apiDeleteTable(baseId, subTable.id);
+
+      // Should return all records since view query is ignored
+      expect(csvData).toBe(`Text field\r\ntxt1\r\ntxt2\r\n`);
+    });
+
+    it(`should return a csv stream with combined filter and projection (personal view scenario)`, async () => {
+      const { mainTable, subTable } = await createTables();
+
+      const textField = mainTable?.fields?.find((f) => f.name === 'Text field') as IFieldVo;
+      const selectField = mainTable?.fields?.find((f) => f.name === 'Select field') as IFieldVo;
+      const numberField = mainTable?.fields?.find((f) => f.name === 'Number field') as IFieldVo;
+
+      // Simulate personal view export with filter + projection + orderBy
+      const exportRes = await apiExportCsvFromTable(mainTable.id, {
+        filter: {
+          conjunction: 'and',
+          filterSet: [
+            {
+              fieldId: selectField.id,
+              operator: 'isAnyOf',
+              value: ['x', 'y'],
+            },
+          ],
+        },
+        projection: [textField.id, numberField.id, selectField.id],
+        orderBy: [
+          {
+            fieldId: textField.id,
+            order: SortFunc.Asc,
+          },
+        ],
+      });
+      const { data: csvData } = exportRes;
+
+      await apiDeleteTable(baseId, mainTable.id);
+      await apiDeleteTable(baseId, subTable.id);
+
+      // Should only return records with select 'x' or 'y', sorted by text field ascending
+      expect(csvData).toBe(`Text field,Number field,Select field\r\ntxt1,1.00,x\r\ntxt2,,y`);
+    });
   }
 );

apps/nextjs-app/src/features/app/blocks/admin/template/components/BaseSelectPanel.tsx

@@ -87,19 +87,19 @@ export const BaseSelectPanel = (props: IBaseSelectPanelProps) => {
         <Button
           variant="outline"
           size={'xs'}
-          className={cn('w-32 overflow-hidden', {
+          className={cn('w-32 overflow-hidden truncate', {
             'border-red-500': !baseName,
           })}
           disabled={disabled}
         >
-          {baseName ?? (
-            <span
-              className="truncate text-red-500"
-              title={t('settings.templateAdmin.baseSelectPanel.abnormalBase')}
-            >
-              {t('settings.templateAdmin.baseSelectPanel.abnormalBase')}
-            </span>
-          )}
+          <span
+            className={cn('truncate', {
+              'text-red-500': !baseName,
+            })}
+            title={baseName ?? t('settings.templateAdmin.baseSelectPanel.abnormalBase')}
+          >
+            {baseName ?? t('settings.templateAdmin.baseSelectPanel.abnormalBase')}
+          </span>
         </Button>
       </DialogTrigger>
       <DialogContent className="flex h-[550px] min-w-[750px] flex-col">