meadow-integration 1.0.16 → 1.0.18

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "meadow-integration",
-    "version": "1.0.16",
+    "version": "1.0.18",
     "description": "Meadow Data Integration",
     "bin": {
         "mdwint": "source/cli/Meadow-Integration-CLI-Run.js"
@@ -16,7 +16,7 @@
     "author": "steven velozo <steven@velozo.com>",
     "license": "MIT",
     "devDependencies": {
-        "quackage": "^1.0.63"
+        "quackage": "^1.0.64"
     },
     "mocha": {
         "diff": true,

package/source/services/clone/Meadow-Service-Sync-Entity-Initial.js

@@ -41,6 +41,7 @@ class MeadowSyncEntityInitial extends libFableServiceProviderBase
 		this.PageSize = this.options.PageSize || 100;
 		this.SyncDeletedRecords = this.options.SyncDeletedRecords || false;
 		this.MaxRecordsPerEntity = this.options.MaxRecordsPerEntity || 0;
+		this.UseAdvancedIDPagination = this.options.UseAdvancedIDPagination || false;
 
 		this.Meadow = false;
 
@@ -447,9 +448,10 @@ class MeadowSyncEntityInitial extends libFableServiceProviderBase
 					tmpSyncState.EstimatedRecordCount = tmpSyncState.Server.RecordCount - tmpSyncState.Local.RecordCount;
 
 					// Apply MaxRecordsPerEntity cap if configured
-					let tmpRecordCap = (this.MaxRecordsPerEntity > 0)
+					tmpSyncState.RecordCap = (this.MaxRecordsPerEntity > 0)
 						? Math.min(tmpSyncState.Server.RecordCount, this.MaxRecordsPerEntity)
 						: tmpSyncState.Server.RecordCount;
+					let tmpRecordCap = tmpSyncState.RecordCap;
 
 					if (this.MaxRecordsPerEntity > 0 && tmpSyncState.EstimatedRecordCount > this.MaxRecordsPerEntity)
 					{
@@ -459,14 +461,21 @@ class MeadowSyncEntityInitial extends libFableServiceProviderBase
 					this.operation.createProgressTracker(tmpSyncState.EstimatedRecordCount, `FullSync-${this.EntitySchema.TableName}`);
 					this.operation.printProgressTrackerStatus(`FullSync-${this.EntitySchema.TableName}`);
 
-					// Generate paginated URL partials
-					tmpSyncState.URLPartials = [];
-					for (let i = 0; i < tmpRecordCap; i += this.PageSize)
+					if (this.UseAdvancedIDPagination)
 					{
-						tmpSyncState.URLPartials.push(`${this.EntitySchema.TableName}s/FilteredTo/FBV~${this.DefaultIdentifier}~GT~${tmpSyncState.Local.MaxIDEntity}~FSF~${this.DefaultIdentifier}~ASC~ASC/${i}/${this.PageSize}`);
+						this.fable.log.info(`${this.EntitySchema.TableName}: using advanced ID pagination (local: ${tmpSyncState.Local.RecordCount}/${tmpSyncState.Local.MaxIDEntity}, server: ${tmpSyncState.Server.RecordCount}/${tmpSyncState.Server.MaxIDEntity}, estimated new: ${tmpSyncState.EstimatedRecordCount}${this.MaxRecordsPerEntity > 0 ? `, capped at ${this.MaxRecordsPerEntity}` : ''})`);
 					}
+					else
+					{
+						// Generate paginated URL partials
+						tmpSyncState.URLPartials = [];
+						for (let i = 0; i < tmpRecordCap; i += this.PageSize)
+						{
+							tmpSyncState.URLPartials.push(`${this.EntitySchema.TableName}s/FilteredTo/FBV~${this.DefaultIdentifier}~GT~${tmpSyncState.Local.MaxIDEntity}~FSF~${this.DefaultIdentifier}~ASC~ASC/${i}/${this.PageSize}`);
+						}
 
-					this.fable.log.info(`${this.EntitySchema.TableName}: downloading ${tmpSyncState.URLPartials.length} pages (local: ${tmpSyncState.Local.RecordCount}/${tmpSyncState.Local.MaxIDEntity}, server: ${tmpSyncState.Server.RecordCount}/${tmpSyncState.Server.MaxIDEntity}, estimated new: ${tmpSyncState.EstimatedRecordCount}${this.MaxRecordsPerEntity > 0 ? `, capped at ${this.MaxRecordsPerEntity}` : ''})`);
+						this.fable.log.info(`${this.EntitySchema.TableName}: downloading ${tmpSyncState.URLPartials.length} pages (local: ${tmpSyncState.Local.RecordCount}/${tmpSyncState.Local.MaxIDEntity}, server: ${tmpSyncState.Server.RecordCount}/${tmpSyncState.Server.MaxIDEntity}, estimated new: ${tmpSyncState.EstimatedRecordCount}${this.MaxRecordsPerEntity > 0 ? `, capped at ${this.MaxRecordsPerEntity}` : ''})`);
+					}
 
 					return fStageComplete();
 				},
@@ -477,149 +486,216 @@ class MeadowSyncEntityInitial extends libFableServiceProviderBase
 					let tmpRecordsSkipped = 0;
 					let tmpRecordsErrored = 0;
 
-					this.fable.Utility.eachLimit(tmpSyncState.URLPartials, 1,
-						(pURLPartial, fDownloadComplete) =>
-						{
-							tmpPageIndex++;
+					// Shared record-processing function used by both pagination modes
+					const fProcessPageRecords = (pBody, fPageProcessComplete) =>
+					{
+						this.fable.Utility.eachLimit(pBody, 5,
+							(pEntityRecord, fEntitySyncComplete) =>
+							{
+								const tmpRecord = pEntityRecord;
+								const tmpQuery = this.Meadow.query;
 
-							this.fable.MeadowCloneRestClient.getJSON(pURLPartial,
-								(pDownloadError, pResponse, pBody) =>
+								if ((typeof(tmpRecord[this.DefaultIdentifier]) !== 'undefined') && (tmpRecord[this.DefaultIdentifier] > 0))
 								{
-									if (pDownloadError)
-									{
-										this.fable.log.error(`${this.EntitySchema.TableName}: page ${tmpPageIndex} download error: ${pDownloadError}`);
-										return fDownloadComplete();
-									}
-									if (pBody && Array.isArray(pBody) && pBody.length > 0)
-									{
-										this.fable.Utility.eachLimit(pBody, 5,
-											(pEntityRecord, fEntitySyncComplete) =>
-											{
-												const tmpRecord = pEntityRecord;
-												const tmpQuery = this.Meadow.query;
-
-												if ((typeof(tmpRecord[this.DefaultIdentifier]) !== 'undefined') && (tmpRecord[this.DefaultIdentifier] > 0))
-												{
-													tmpQuery.addFilter(this.DefaultIdentifier, tmpRecord[this.DefaultIdentifier]);
-												}
+									tmpQuery.addFilter(this.DefaultIdentifier, tmpRecord[this.DefaultIdentifier]);
+								}
 
-												if (!tmpSyncState.HasDeletedColumn)
-												{
-													tmpQuery.setDisableDeleteTracking(true);
-												}
+								if (!tmpSyncState.HasDeletedColumn)
+								{
+									tmpQuery.setDisableDeleteTracking(true);
+								}
 
-												this.Meadow.doRead(tmpQuery,
-													(pReadError, pQuery, pRecord) =>
-													{
-														if (pReadError)
-														{
-															tmpRecordsErrored++;
-															return fEntitySyncComplete();
-														}
-														if (!pRecord)
-														{
-															// Record not found -- create it
-															const tmpRecordToCommit = this.marshalRecord(tmpRecord);
+								this.Meadow.doRead(tmpQuery,
+									(pReadError, pQuery, pRecord) =>
+									{
+										if (pReadError)
+										{
+											tmpRecordsErrored++;
+											return fEntitySyncComplete();
+										}
+										if (!pRecord)
+										{
+											// Record not found -- create it
+											const tmpRecordToCommit = this.marshalRecord(tmpRecord);
 
-															const tmpCreateQuery = this.Meadow.query.addRecord(tmpRecordToCommit);
+											const tmpCreateQuery = this.Meadow.query.addRecord(tmpRecordToCommit);
 
-															tmpCreateQuery.setDisableAutoIdentity(true);
-															tmpCreateQuery.setDisableAutoDateStamp(true);
-															tmpCreateQuery.setDisableAutoUserStamp(true);
-															tmpCreateQuery.setDisableDeleteTracking(true);
+											tmpCreateQuery.setDisableAutoIdentity(true);
+											tmpCreateQuery.setDisableAutoDateStamp(true);
+											tmpCreateQuery.setDisableAutoUserStamp(true);
+											tmpCreateQuery.setDisableDeleteTracking(true);
 
-															tmpCreateQuery.AllowIdentityInsert = true;
+											tmpCreateQuery.AllowIdentityInsert = true;
 
-															this.Meadow.doCreate(tmpCreateQuery,
-																(pCreateError) =>
+											this.Meadow.doCreate(tmpCreateQuery,
+												(pCreateError) =>
+												{
+													if (pCreateError)
+													{
+														let tmpErrorStr = (typeof(pCreateError) === 'string') ? pCreateError : JSON.stringify(pCreateError);
+														if (tmpErrorStr.toLowerCase().indexOf('duplicate') > -1 || tmpErrorStr.toLowerCase().indexOf('unique') > -1)
+														{
+															// Duplicate key (likely GUID conflict) -- fall back to update
+															this.log.warn(`${this.EntitySchema.TableName}: duplicate key on create for ID ${tmpRecord[this.DefaultIdentifier]}; falling back to update.`);
+															const tmpUpdateQuery = this.Meadow.query.addRecord(tmpRecordToCommit);
+															tmpUpdateQuery.setDisableAutoIdentity(true);
+															tmpUpdateQuery.setDisableAutoDateStamp(true);
+															tmpUpdateQuery.setDisableAutoUserStamp(true);
+															tmpUpdateQuery.setDisableDeleteTracking(true);
+															this.Meadow.doUpdate(tmpUpdateQuery,
+																(pUpdateError) =>
 																{
-																	if (pCreateError)
+																	if (pUpdateError)
 																	{
-																		let tmpErrorStr = (typeof(pCreateError) === 'string') ? pCreateError : JSON.stringify(pCreateError);
-																		if (tmpErrorStr.toLowerCase().indexOf('duplicate') > -1 || tmpErrorStr.toLowerCase().indexOf('unique') > -1)
-																		{
-																			// Duplicate key (likely GUID conflict) -- fall back to update
-																			this.log.warn(`${this.EntitySchema.TableName}: duplicate key on create for ID ${tmpRecord[this.DefaultIdentifier]}; falling back to update.`);
-																			const tmpUpdateQuery = this.Meadow.query.addRecord(tmpRecordToCommit);
-																			tmpUpdateQuery.setDisableAutoIdentity(true);
-																			tmpUpdateQuery.setDisableAutoDateStamp(true);
-																			tmpUpdateQuery.setDisableAutoUserStamp(true);
-																			tmpUpdateQuery.setDisableDeleteTracking(true);
-																			this.Meadow.doUpdate(tmpUpdateQuery,
-																				(pUpdateError) =>
-																				{
-																					if (pUpdateError)
-																					{
-																						tmpRecordsErrored++;
-																						this.log.error(`${this.EntitySchema.TableName}: fallback update also failed for ID ${tmpRecord[this.DefaultIdentifier]}: ${pUpdateError}`);
-																						return fEntitySyncComplete();
-																					}
-																					tmpRecordsCreated++;
-																					this.operation.incrementProgressTrackerStatus(`FullSync-${this.EntitySchema.TableName}`, 1);
-																					return fEntitySyncComplete();
-																				});
-																			return;
-																		}
 																		tmpRecordsErrored++;
-																		this.log.error(`${this.EntitySchema.TableName}: doCreate error for ID ${tmpRecord[this.DefaultIdentifier]}: ${pCreateError}`);
+																		this.log.error(`${this.EntitySchema.TableName}: fallback update also failed for ID ${tmpRecord[this.DefaultIdentifier]}: ${pUpdateError}`);
 																		return fEntitySyncComplete();
 																	}
 																	tmpRecordsCreated++;
 																	this.operation.incrementProgressTrackerStatus(`FullSync-${this.EntitySchema.TableName}`, 1);
 																	return fEntitySyncComplete();
 																});
+															return;
 														}
-														else
-														{
-															tmpRecordsSkipped++;
-															return fEntitySyncComplete();
-														}
-													});
-											},
-											(pEntitySyncError) =>
-											{
-												this.operation.printProgressTrackerStatus(`FullSync-${this.EntitySchema.TableName}`);
-												if (pEntitySyncError)
-												{
-													this.log.error(`Problem or early completion syncing entity ${this.EntitySchema.TableName}: ${pEntitySyncError}`, pEntitySyncError);
-												}
-												return fDownloadComplete();
-											});
-									}
-									else
-									{
-										if (Array.isArray(pBody) && pBody.length == 0)
+														tmpRecordsErrored++;
+														this.log.error(`${this.EntitySchema.TableName}: doCreate error for ID ${tmpRecord[this.DefaultIdentifier]}: ${pCreateError}`);
+														return fEntitySyncComplete();
+													}
+													tmpRecordsCreated++;
+													this.operation.incrementProgressTrackerStatus(`FullSync-${this.EntitySchema.TableName}`, 1);
+													return fEntitySyncComplete();
+												});
+										}
+										else
 										{
-											return fDownloadComplete(new Error('Records depleted!'));
+											tmpRecordsSkipped++;
+											return fEntitySyncComplete();
 										}
-										return fDownloadComplete();
-									}
-								});
-						},
-						(pDownloadError) =>
+									});
+							},
+							(pEntitySyncError) =>
+							{
+								this.operation.printProgressTrackerStatus(`FullSync-${this.EntitySchema.TableName}`);
+								if (pEntitySyncError)
+								{
+									this.log.error(`Problem or early completion syncing entity ${this.EntitySchema.TableName}: ${pEntitySyncError}`, pEntitySyncError);
+								}
+								return fPageProcessComplete(pEntitySyncError);
+							});
+					};
+
+					const fSyncComplete = (pDownloadError) =>
+					{
+						this.fable.log.info(`${this.EntitySchema.TableName}: sync complete — created: ${tmpRecordsCreated}, skipped: ${tmpRecordsSkipped}, errors: ${tmpRecordsErrored}`);
+						if (pDownloadError)
+						{
+							this.fable.log.error(`Error returned URL Partial .. this may not be an error: ${pDownloadError}`);
+						}
+
+						// Store sync results on the entity so callers can inspect the breakdown
+						this.syncResults = (
+							{
+								Created: tmpRecordsCreated,
+								Skipped: tmpRecordsSkipped,
+								Errors: tmpRecordsErrored,
+								Deleted: 0,
+								ServerRecordCount: tmpSyncState.Server.RecordCount,
+								LocalRecordCount: tmpSyncState.Local.RecordCount,
+								ServerMaxID: tmpSyncState.Server.MaxIDEntity,
+								LocalMaxID: tmpSyncState.Local.MaxIDEntity,
+								EstimatedNew: tmpSyncState.EstimatedRecordCount
+							});
+
+						fStageComplete();
+					};
+
+					if (this.UseAdvancedIDPagination)
+					{
+						// Advanced ID pagination: use keyset pagination (WHERE ID > lastMaxID)
+						// instead of OFFSET to avoid progressive table scan slowdown on large datasets.
+						let tmpLastMaxID = tmpSyncState.Local.MaxIDEntity;
+						let tmpTotalFetched = 0;
+
+						const fFetchPage = () =>
 						{
-							this.fable.log.info(`${this.EntitySchema.TableName}: sync complete — created: ${tmpRecordsCreated}, skipped: ${tmpRecordsSkipped}, errors: ${tmpRecordsErrored}`);
-							if (pDownloadError)
+							if (tmpTotalFetched >= tmpSyncState.RecordCap)
 							{
-								this.fable.log.error(`Error returned URL Partial .. this may not be an error: ${pDownloadError}`);
+								return fSyncComplete();
 							}
 
-							// Store sync results on the entity so callers can inspect the breakdown
-							this.syncResults = (
+							tmpPageIndex++;
+							let tmpURL = `${this.EntitySchema.TableName}s/FilteredTo/FBV~${this.DefaultIdentifier}~GT~${tmpLastMaxID}~FSF~${this.DefaultIdentifier}~ASC~ASC/0/${this.PageSize}`;
+
+							this.fable.MeadowCloneRestClient.getJSON(tmpURL,
+								(pDownloadError, pResponse, pBody) =>
 								{
-									Created: tmpRecordsCreated,
-									Skipped: tmpRecordsSkipped,
-									Errors: tmpRecordsErrored,
-									Deleted: 0,
-									ServerRecordCount: tmpSyncState.Server.RecordCount,
-									LocalRecordCount: tmpSyncState.Local.RecordCount,
-									ServerMaxID: tmpSyncState.Server.MaxIDEntity,
-									LocalMaxID: tmpSyncState.Local.MaxIDEntity,
-									EstimatedNew: tmpSyncState.EstimatedRecordCount
+									if (pDownloadError)
+									{
+										this.fable.log.error(`${this.EntitySchema.TableName}: page ${tmpPageIndex} download error: ${pDownloadError}`);
+										return fSyncComplete(pDownloadError);
+									}
+									if (pBody && Array.isArray(pBody) && pBody.length > 0)
+									{
+										// Track the max ID from this page for the next page filter
+										for (let r = 0; r < pBody.length; r++)
+										{
+											if (pBody[r][this.DefaultIdentifier] > tmpLastMaxID)
+											{
+												tmpLastMaxID = pBody[r][this.DefaultIdentifier];
+											}
+										}
+										tmpTotalFetched += pBody.length;
+
+										fProcessPageRecords(pBody, (pProcessError) =>
+										{
+											if (pProcessError)
+											{
+												return fSyncComplete(pProcessError);
+											}
+											return setImmediate(fFetchPage);
+										});
+									}
+									else
+									{
+										// No more records
+										return fSyncComplete();
+									}
 								});
+						};
+						fFetchPage();
+					}
+					else
+					{
+						// Standard offset-based pagination
+						this.fable.Utility.eachLimit(tmpSyncState.URLPartials, 1,
+							(pURLPartial, fDownloadComplete) =>
+							{
+								tmpPageIndex++;
 
-							fStageComplete();
-						});
+								this.fable.MeadowCloneRestClient.getJSON(pURLPartial,
+									(pDownloadError, pResponse, pBody) =>
+									{
+										if (pDownloadError)
+										{
+											this.fable.log.error(`${this.EntitySchema.TableName}: page ${tmpPageIndex} download error: ${pDownloadError}`);
+											return fDownloadComplete();
+										}
+										if (pBody && Array.isArray(pBody) && pBody.length > 0)
+										{
+											fProcessPageRecords(pBody, fDownloadComplete);
+										}
+										else
+										{
+											if (Array.isArray(pBody) && pBody.length == 0)
+											{
+												return fDownloadComplete(new Error('Records depleted!'));
+											}
+											return fDownloadComplete();
+										}
+									});
+							},
+							fSyncComplete);
+					}
 				},
 			],
 			(pError) =>

package/source/services/clone/Meadow-Service-Sync.js

@@ -65,6 +65,18 @@ class MeadowSync extends libFableServiceProviderBase
 			this.MaxRecordsPerEntity = parseInt(this.options.MaxRecordsPerEntity, 10) || 0;
 		}
 
+		// When true, use ID-based keyset pagination instead of OFFSET pagination.
+		// This avoids table scans on large datasets by filtering WHERE ID > lastMaxID.
+		this.UseAdvancedIDPagination = false;
+		if (this.fable.ProgramConfiguration.hasOwnProperty('UseAdvancedIDPagination'))
+		{
+			this.UseAdvancedIDPagination = !!this.fable.ProgramConfiguration.UseAdvancedIDPagination;
+		}
+		else if (this.options.hasOwnProperty('UseAdvancedIDPagination'))
+		{
+			this.UseAdvancedIDPagination = !!this.options.UseAdvancedIDPagination;
+		}
+
 		// Tolerance window in milliseconds for cross-database timestamp precision differences.
 		// Passed through to Ongoing sync entities for bisection date comparison.
 		this.DateTimePrecisionMS = 1000;
@@ -114,6 +126,7 @@ class MeadowSync extends libFableServiceProviderBase
 						SyncDeletedRecords: this.SyncDeletedRecords,
 						MaxRecordsPerEntity: this.MaxRecordsPerEntity,
 						DateTimePrecisionMS: this.DateTimePrecisionMS,
+						UseAdvancedIDPagination: this.UseAdvancedIDPagination,
 					};
 
 					let tmpSyncEntity;