Add sorter for distant tables

Author: thomtrp

packages/twenty-server/src/engine/metadata-modules/remote-server/remote-table/distant-table/distant-table.service.ts

@@ -10,7 +10,7 @@ import {
 } from 'src/engine/metadata-modules/remote-server/remote-server.entity';
 import { WorkspaceDataSourceService } from 'src/engine/workspace-datasource/workspace-datasource.service';
 import { DistantTables } from 'src/engine/metadata-modules/remote-server/remote-table/distant-table/types/distant-table';
-import { STRIPE_DISTANT_TABLES } from 'src/engine/metadata-modules/remote-server/remote-table/distant-table/util/stripe-distant-tables.util';
+import { STRIPE_DISTANT_TABLES } from 'src/engine/metadata-modules/remote-server/remote-table/distant-table/utils/stripe-distant-tables.util';
 import { PostgresTableSchemaColumn } from 'src/engine/metadata-modules/remote-server/types/postgres-table-schema-column';
 
 @Injectable()

packages/twenty-server/src/engine/metadata-modules/remote-server/remote-table/distant-table/utils/__tests__/sort-distant-tables.spec.ts

@@ -0,0 +1,44 @@
+import { RemoteTableStatus } from 'src/engine/metadata-modules/remote-server/remote-table/dtos/remote-table.dto';
+import { distantTablesSorter } from 'src/engine/metadata-modules/remote-server/remote-table/distant-table/utils/sort-distant-tables.util';
+
+const table1 = {
+  status: RemoteTableStatus.SYNCED,
+  name: 'table1',
+};
+
+const table2 = {
+  status: RemoteTableStatus.NOT_SYNCED,
+  name: 'table2',
+};
+
+describe('distantTablesSorter', () => {
+  it('should return -1 when first param status is SYNCED and second param status is NOT_SYNCED', () => {
+    const result = distantTablesSorter(table1, table2);
+
+    expect(result).toBe(-1);
+  });
+
+  it('should return 1 when first param status is NOT_SYNCED and second param status is SYNCED', () => {
+    const result = distantTablesSorter(table2, table1);
+
+    expect(result).toBe(1);
+  });
+
+  it('should return -1 when same status and first param name is smaller than second param name', () => {
+    const result = distantTablesSorter(
+      { ...table1, status: RemoteTableStatus.NOT_SYNCED },
+      table2,
+    );
+
+    expect(result).toBe(-1);
+  });
+
+  it('should return 1 when same status and second param name is smaller than first param name', () => {
+    const result = distantTablesSorter(table2, {
+      ...table1,
+      status: RemoteTableStatus.NOT_SYNCED,
+    });
+
+    expect(result).toBe(1);
+  });
+});

packages/twenty-server/src/engine/metadata-modules/remote-server/remote-table/distant-table/utils/sort-distant-tables.util.ts

@@ -0,0 +1,19 @@
+import { RemoteTableStatus } from 'src/engine/metadata-modules/remote-server/remote-table/dtos/remote-table.dto';
+
+export const sortDistantTables = (table1, table2) => {
+  if (
+    table1.status === RemoteTableStatus.SYNCED &&
+    table2.status === RemoteTableStatus.NOT_SYNCED
+  ) {
+    return -1;
+  }
+
+  if (
+    table1.status === RemoteTableStatus.NOT_SYNCED &&
+    table2.status === RemoteTableStatus.SYNCED
+  ) {
+    return 1;
+  }
+
+  return table1.name > table2.name ? 1 : -1;
+};

packages/twenty-server/src/engine/metadata-modules/remote-server/remote-table/distant-table/util/stripe-distant-tables.util.ts renamed to packages/twenty-server/src/engine/metadata-modules/remote-server/remote-table/distant-table/utils/stripe-distant-tables.util.ts

@@ -31,6 +31,7 @@ import { PostgresTableSchemaColumn } from 'src/engine/metadata-modules/remote-se
 import { fetchTableColumns } from 'src/engine/metadata-modules/remote-server/remote-table/utils/fetch-table-columns.util';
 import { ForeignTableService } from 'src/engine/metadata-modules/remote-server/remote-table/foreign-table/foreign-table.service';
 import { RemoteTableSchemaUpdateService } from 'src/engine/metadata-modules/remote-server/remote-table/remote-table-schema-update/remote-table-schema-update.service';
+import { sortDistantTables } from 'src/engine/metadata-modules/remote-server/remote-table/distant-table/utils/sort-distant-tables.util';
 
 export class RemoteTableService {
   private readonly logger = new Logger(RemoteTableService.name);
@@ -82,26 +83,25 @@ export class RemoteTableService {
       workspaceId,
     );
 
-    if (currentRemoteTables.length === 0 || !shouldFetchPendingSchemaUpdates) {
-      const distantTablesWithStatus = Object.keys(distantTables).map(
-        (tableName) => ({
+    const shouldGetTablesWithPendingSchemaUpdates =
+      currentRemoteTables.length > 0 && shouldFetchPendingSchemaUpdates;
+
+    const distantTablesWithStatus = shouldGetTablesWithPendingSchemaUpdates
+      ? await this.remoteTableSchemaUpdateService.getDistantTablesWithUpdates({
+          remoteServerSchema: remoteServer.schema,
+          workspaceId,
+          remoteTables: currentRemoteTables,
+          distantTables,
+        })
+      : Object.keys(distantTables).map((tableName) => ({
           name: tableName,
           schema: remoteServer.schema,
           status: currentRemoteTableDistantNames.includes(tableName)
             ? RemoteTableStatus.SYNCED
             : RemoteTableStatus.NOT_SYNCED,
-        }),
-      );
+        }));
 
-      return distantTablesWithStatus;
-    }
-
-    return this.remoteTableSchemaUpdateService.getDistantTablesWithUpdates({
-      remoteServerSchema: remoteServer.schema,
-      workspaceId,
-      remoteTables: currentRemoteTables,
-      distantTables,
-    });
+    return distantTablesWithStatus.sort(sortDistantTables);
   }
 
   public async findRemoteTablesByServerId({