Add support pagination to getRelations (#193)

* Add support pagination to getRelations * Add Report to scope * Add optional support pagination * Add flag isPagination * Add order by createdAt and addtional where by scope * Add order by createdAt and addtional where by scope * Fix where by scope * Add to response-presenter - relations field * Refactor Co-authored-by: Evgenij Shangin <[email protected]> * Refactor Co-authored-by: Evgenij Shangin <[email protected]> * Refactor --------- Co-authored-by: Evgenij Shangin <[email protected]>
datalens-tech · Oct 16, 2024 · 5dfd8d8 · 5dfd8d8
1 parent cbbb5fd
commit 5dfd8d8
Show file tree

Hide file tree

Showing 7 changed files with 102 additions and 24 deletions.
diff --git a/api/constants.ts b/api/constants.ts
@@ -18,6 +18,7 @@ export {
     RETURN_FAVORITES_COLUMNS,
     RETURN_NAVIGATION_COLUMNS,
     INTER_TENANT_GET_ENTRIES_SCHEMA,
+    ALLOWED_ENTRIES_SCOPE,
     AUTHORIZATION_HEADER,
     DL_AUTH_HEADER_KEY,
 } from '../src/const';
diff --git a/src/components/response-presenter.ts b/src/components/response-presenter.ts
@@ -58,6 +58,10 @@ export async function prepareResponseAsync({data}: {data: any}): Promise<ST.Serv
         response.entry = await Utils.macrotasksEncodeData(response.entry);
     }
 
+    if (response.relations) {
+        response.relations = await Utils.macrotasksEncodeData(response.relations);
+    }
+
     return {
         code: 200,
         response,

diff --git a/src/const/common.ts b/src/const/common.ts
@@ -1,3 +1,4 @@
+import {EntryScope} from '../db/models/new/entry/types';
 import {Mode} from '../types/models';
 
 export const TRUE_FLAGS = ['1', 'true', true];
@@ -244,3 +245,11 @@ export const INTER_TENANT_GET_ENTRIES_SCHEMA = {
 };
 
 export const ModeValues: Mode[] = ['save', 'publish'];
+
+export const ALLOWED_ENTRIES_SCOPE = [
+    EntryScope.Dash,
+    EntryScope.Widget,
+    EntryScope.Dataset,
+    EntryScope.Connection,
+    EntryScope.Report,
+] as const;
diff --git a/src/controllers/entries.ts b/src/controllers/entries.ts
@@ -31,6 +31,7 @@ import {
     formatGetEntryMetaPrivateResponse,
     formatEntryModel,
 } from '../services/new/entry/formatters';
+import {EntryScope} from '../db/models/new/entry/types';
 
 export default {
     getEntry: async (req: Request, res: Response) => {
@@ -243,10 +244,19 @@ export default {
                 entryId: params.entryId,
                 direction: query.direction as Optional<RelationDirection>,
                 includePermissionsInfo: Utils.isTrueArg(query.includePermissionsInfo),
+                page: (query.page && Number(query.page)) as number | undefined,
+                pageSize: (query.pageSize && Number(query.pageSize)) as number | undefined,
+                scope: query.scope as EntryScope | undefined,
             },
         );
 
-        const {code, response} = await prepareResponseAsync({data: result});
+        // TODO: leave a response with pagination only, when there will be pagination support everywhere in the frontend
+        const formattedResponse =
+            typeof query.page !== 'undefined' && typeof query.pageSize !== 'undefined'
+                ? result
+                : result.relations;
+
+        const {code, response} = await prepareResponseAsync({data: formattedResponse});
 
         res.status(code).send(response);
     },

diff --git a/src/services/entry/actions/get-entry-relations.ts b/src/services/entry/actions/get-entry-relations.ts
@@ -3,18 +3,22 @@ import {Entry, EntryColumn} from '../../../db/models/new/entry';
 import {DlsActions} from '../../../types/models';
 import {ServiceArgs} from '../../new/types';
 import Utils from '../../../utils';
-import {US_ERRORS} from '../../../const';
+import {ALLOWED_ENTRIES_SCOPE, US_ERRORS} from '../../../const';
 import {makeSchemaValidator} from '../../../components/validation-schema-compiler';
 import {getWorkbook} from '../../new/workbook/get-workbook';
 import {getEntryPermissionsByWorkbook} from '../../new/workbook/utils';
 import {getRelatedEntries, RelationDirection} from './get-related-entries';
 import {registry} from '../../../registry';
 import {getReplica} from '../../new/utils';
+import {EntryScope} from '../../../db/models/new/entry/types';
 
 export type GetEntryRelationsArgs = {
     entryId: string;
     direction?: RelationDirection;
     includePermissionsInfo?: boolean;
+    scope?: EntryScope;
+    page?: number;
+    pageSize?: number;
 };
 
 const validateArgs = makeSchemaValidator({
@@ -31,6 +35,19 @@ const validateArgs = makeSchemaValidator({
         includePermissionsInfo: {
             type: 'boolean',
         },
+        scope: {
+            type: 'string',
+            enum: ALLOWED_ENTRIES_SCOPE,
+        },
+        page: {
+            type: 'number',
+            minimum: 0,
+        },
+        pageSize: {
+            type: 'number',
+            minimum: 1,
+            maximum: 200,
+        },
     },
 });
 
@@ -42,11 +59,21 @@ export async function getEntryRelations(
 
     const {tenantId, isPrivateRoute} = ctx.get('info');
 
-    const {entryId, direction = RelationDirection.Parent, includePermissionsInfo = false} = args;
+    const {
+        entryId,
+        scope,
+        page,
+        pageSize,
+        direction = RelationDirection.Parent,
+        includePermissionsInfo = false,
+    } = args;
 
     ctx.log('GET_ENTRY_RELATIONS_REQUEST', {
         entryId: Utils.encodeId(entryId),
         direction,
+        scope,
+        page,
+        pageSize,
         includePermissionsInfo,
     });
 
@@ -74,9 +101,24 @@ export async function getEntryRelations(
         {
             entryIds: [entryId],
             direction,
+            scope,
+            page,
+            pageSize,
         },
     );
 
+    const isPagination = typeof page !== 'undefined' && typeof pageSize !== 'undefined';
+
+    let nextPageToken;
+
+    if (isPagination) {
+        nextPageToken = Utils.getOptimisticNextPageToken({
+            page: page,
+            pageSize: pageSize,
+            curPage: relations,
+        });
+    }
+
     relations = relations.filter((item) => item.tenantId === entry.tenantId);
 
     if (entry.workbookId) {
@@ -138,5 +180,8 @@ export async function getEntryRelations(
 
     ctx.log('GET_ENTRY_RELATIONS_SUCCESS', {count: relations.length});
 
-    return relations;
+    return {
+        relations,
+        nextPageToken,
+    };
 }
diff --git a/src/services/entry/actions/get-related-entries.ts b/src/services/entry/actions/get-related-entries.ts
@@ -8,6 +8,7 @@ import {
 } from '../../../const';
 import {getReplica} from '../../new/utils';
 import {EntryScope} from '../../../db/models/new/entry/types';
+import {EntryColumn} from '../../../db/models/new/entry';
 
 export enum RelationDirection {
     Parent = 'parent',
@@ -18,6 +19,9 @@ type GetRelatedEntriesData = {
     entryIds: string[];
     direction?: RelationDirection;
     extendedTimeout?: boolean;
+    scope?: EntryScope;
+    page?: number;
+    pageSize?: number;
 };
 
 type GetRelatedEntriesResult = {
@@ -38,14 +42,17 @@ export async function getRelatedEntries(
     {
         entryIds,
         direction = RelationDirection.Parent,
+        scope,
+        page,
+        pageSize,
         extendedTimeout = false,
     }: GetRelatedEntriesData,
 ) {
-    ctx.log('GET_RELATED_ENTRIES_RUN');
+    ctx.log('GET_RELATED_ENTRIES_RUN', {scope, page, pageSize});
 
     const endToStart = direction === RelationDirection.Parent;
 
-    const relatedEntries = (await Entry.query(getReplica(trx))
+    const relatedEntries = Entry.query(getReplica(trx))
         .withRecursive('relatedEntries', (qb) => {
             qb.select(['fromId', 'toId', raw('1 depth')])
                 .from('links')
@@ -82,14 +89,28 @@ export async function getRelatedEntries(
                 .join('revisions', 'entries.savedId', 'revisions.revId')
                 .as('re');
         })
-        .orderBy('depth')
-        .timeout(
-            extendedTimeout ? EXTENDED_QUERY_TIMEOUT : DEFAULT_QUERY_TIMEOUT,
-        )) as unknown[] as GetRelatedEntriesResult[];
+        .where((builder) => {
+            if (scope) {
+                builder.where({[EntryColumn.Scope]: scope});
+            }
+        })
+        .orderBy('createdAt');
+
+    if (pageSize) {
+        relatedEntries.limit(pageSize);
+
+        if (page) {
+            relatedEntries.offset(pageSize * page);
+        }
+    }
+
+    const result = (await relatedEntries.timeout(
+        extendedTimeout ? EXTENDED_QUERY_TIMEOUT : DEFAULT_QUERY_TIMEOUT,
+    )) as unknown[] as GetRelatedEntriesResult[];
 
     ctx.log('GET_RELATED_ENTRIES_DONE', {
-        amount: relatedEntries && relatedEntries.length,
+        amount: result?.length,
     });
 
-    return relatedEntries;
+    return result;
 }
diff --git a/src/utils/utils.ts b/src/utils/utils.ts
@@ -441,18 +441,6 @@ export class Utils {
         return dsnList;
     }
 
-    /** @deprecated use getOptimisticNextPageToken */
-    static getNextPageToken(page: number, pageSize: number, total: number) {
-        const lastPage = Math.ceil(total / pageSize) - 1;
-        let nextPageToken;
-
-        if (page >= 0 && page < lastPage) {
-            nextPageToken = String(page + 1);
-        }
-
-        return nextPageToken;
-    }
-
     static getOptimisticNextPageToken({
         page,
         pageSize,