feat(@aws-amplify/datastore): configurable sync pagination limit (#5181)

* feat(@aws-amplify/datastore): configurable sync pagination limit * better name for sync paginationLimit variable Co-authored-by: shpetimshala <shpetim.sha@gmail.com> Co-authored-by: Manuel Iglesias <6154160+manueliglesias@users.noreply.github.com>
aws-amplify · Mar 27, 2020 · a4f518b · a4f518b
1 parent c9c020d
commit a4f518b
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 3 deletions.
diff --git a/packages/datastore/src/datastore/datastore.ts b/packages/datastore/src/datastore/datastore.ts
@@ -645,6 +645,7 @@ let amplifyConfig: Record<string, any> = {};
 let conflictHandler: ConflictHandler;
 let errorHandler: (error: SyncError) => void;
 let maxRecordsToSync: number;
+let syncPageSize: number;
 let fullSyncInterval: number;
 
 function configure(config: DataStoreConfig = {}) {
@@ -653,6 +654,7 @@ function configure(config: DataStoreConfig = {}) {
 		conflictHandler: configConflictHandler,
 		errorHandler: configErrorHandler,
 		maxRecordsToSync: configMaxRecordsToSync,
+		syncPageSize: configSyncPageSize,
 		fullSyncInterval: configFullSyncInterval,
 		...configFromAmplify
 	} = config;
@@ -676,6 +678,11 @@ function configure(config: DataStoreConfig = {}) {
 		maxRecordsToSync ||
 		config.maxRecordsToSync;
 
+	syncPageSize =
+		(configDataStore && configDataStore.syncPageSize) ||
+		syncPageSize ||
+		config.syncPageSize;
+
 	fullSyncInterval =
 		(configDataStore && configDataStore.fullSyncInterval) ||
 		configFullSyncInterval ||
@@ -797,6 +804,7 @@ async function start(): Promise<void> {
 			storage,
 			modelInstanceCreator,
 			maxRecordsToSync,
+			syncPageSize,
 			conflictHandler,
 			errorHandler
 		);

diff --git a/packages/datastore/src/sync/index.ts b/packages/datastore/src/sync/index.ts
@@ -85,6 +85,7 @@ export class SyncEngine {
 		private readonly storage: Storage,
 		private readonly modelInstanceCreator: ModelInstanceCreator,
 		private readonly maxRecordsToSync: number,
+		private readonly syncPageSize: number,
 		conflictHandler: ConflictHandler,
 		errorHandler: ErrorHandler
 	) {
@@ -103,7 +104,8 @@ export class SyncEngine {
 
 		this.syncQueriesProcessor = new SyncProcessor(
 			this.schema,
-			maxRecordsToSync
+			maxRecordsToSync,
+			syncPageSize
 		);
 		this.subscriptionsProcessor = new SubscriptionProcessor(this.schema);
 		this.mutationsProcessor = new MutationProcessor(

diff --git a/packages/datastore/src/sync/processors/sync.ts b/packages/datastore/src/sync/processors/sync.ts
@@ -16,7 +16,8 @@ class SyncProcessor {
 
 	constructor(
 		private readonly schema: InternalSchema,
-		private readonly maxRecordsToSync: number = DEFAULT_MAX_RECORDS_TO_SYNC
+		private readonly maxRecordsToSync: number = DEFAULT_MAX_RECORDS_TO_SYNC,
+		private readonly syncPageSize: number = DEFAULT_PAGINATION_LIMIT
 	) {
 		this.generateQueries();
 	}
@@ -104,6 +105,11 @@ class SyncProcessor {
 				? this.maxRecordsToSync
 				: DEFAULT_MAX_RECORDS_TO_SYNC;
 
+		const syncPageSize =
+			this.syncPageSize !== undefined
+				? this.syncPageSize
+				: DEFAULT_PAGINATION_LIMIT;
+
 		const parentPromises = new Map<string, Promise<void>>();
 
 		const observable = new Observable<SyncModelPage>(observer => {
@@ -147,7 +153,7 @@ class SyncProcessor {
 
 							const limit = Math.min(
 								maxRecordsToSync - recordsReceived,
-								DEFAULT_PAGINATION_LIMIT
+								syncPageSize
 							);
 
 							({ items, nextToken, startedAt } = await this.retrievePage(

diff --git a/packages/datastore/src/types.ts b/packages/datastore/src/types.ts
@@ -383,11 +383,13 @@ export type DataStoreConfig = {
 		conflictHandler?: ConflictHandler; // default : retry until client wins up to x times
 		errorHandler?: (error: SyncError) => void; // default : logger.warn
 		maxRecordsToSync?: number; // merge
+		syncPageSize?: number;
 		fullSyncInterval?: number;
 	};
 	conflictHandler?: ConflictHandler; // default : retry until client wins up to x times
 	errorHandler?: (error: SyncError) => void; // default : logger.warn
 	maxRecordsToSync?: number; // merge
+	syncPageSize?: number;
 	fullSyncInterval?: number;
 };