The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Emit URL-safe pagination cursors (#25822)
tomjtobinn95e2a851ca4b
diff --git a/packages/twenty-server/src/engine/api/graphql/graphql-query-runner/utils/__tests__/cursors.util.spec.ts b/packages/twenty-server/src/engine/api/graphql/graphql-query-runner/utils/__tests__/cursors.util.spec.tsindex 1f1434bc214..9855b0ec109 100644--- a/packages/twenty-server/src/engine/api/graphql/graphql-query-runner/utils/__tests__/cursors.util.spec.ts+++ b/packages/twenty-server/src/engine/api/graphql/graphql-query-runner/utils/__tests__/cursors.util.spec.ts@@ -9,7 +9,7 @@ import { type ObjectRecordOrderBy } from 'src/engine/api/graphql/workspace-queryimport { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';-import { decodeCursor, encodeCursor } from '../cursors.util';+import { decodeCursor, encodeCursor, encodeCursorData } from '../cursors.util';const buildMockField = (id: string,@@ -314,3 +314,39 @@ describe('encodeCursor', () => {expect(decoded).toEqual({ id: 'abc' });});});++describe('cursor serialization', () => {+ const cursorData = { value: 'Ͽ' };++ it('should encode cursors with the URL-safe base64 alphabet', () => {+ const legacyBase64 = Buffer.from(JSON.stringify(cursorData)).toString(+ 'base64',+ );+ const cursor = encodeCursorData(cursorData);++ expect(legacyBase64).toContain('+');+ expect(legacyBase64).toContain('/');+ expect(cursor).toBe(+ Buffer.from(JSON.stringify(cursorData)).toString('base64url'),+ );+ expect(cursor).toMatch(/^[A-Za-z0-9_-]+$/);+ });++ it('should survive an unescaped query string round trip', () => {+ const cursor = encodeCursorData(cursorData);+ const parsedCursor = new URLSearchParams(`starting_after=${cursor}`).get(+ 'starting_after',+ );++ expect(parsedCursor).toBe(cursor);+ expect(decodeCursor(parsedCursor as string)).toEqual(cursorData);+ });++ it('should continue to decode legacy base64 cursors', () => {+ const legacyCursor = Buffer.from(JSON.stringify(cursorData)).toString(+ 'base64',+ );++ expect(decodeCursor(legacyCursor)).toEqual(cursorData);+ });+});diff --git a/packages/twenty-server/src/engine/api/graphql/graphql-query-runner/utils/cursors.util.ts b/packages/twenty-server/src/engine/api/graphql/graphql-query-runner/utils/cursors.util.tsindex 829d2d49c06..1ee6761fb2f 100644--- a/packages/twenty-server/src/engine/api/graphql/graphql-query-runner/utils/cursors.util.ts+++ b/packages/twenty-server/src/engine/api/graphql/graphql-query-runner/utils/cursors.util.ts@@ -101,7 +101,7 @@ export const encodeCursor = <T extends ObjectRecord = ObjectRecord>({};export const encodeCursorData = (cursorData: CursorData) => {- return Buffer.from(JSON.stringify(cursorData)).toString('base64');+ return Buffer.from(JSON.stringify(cursorData)).toString('base64url');};export const getCursor = (