Add Sync Client base that implements progress tracking

Created on 1 April 2025, 4 days ago

Problem/Motivation

When using a Sync Client to fetch data from a paged API, you might want to keep track of the processed pages in case the process fails or gets interrupted, so the process can restart/retry and resume from the last successful page.

The pattern to store and fetch this information is generic, so providing this in the module can lower code replication in implementing modules.

Proposed resolution

Provide a base class that extends SyncClientBase with additional getters and setters to handle the progress data.
The progress is to be store in state, with an expiration duration that can be configured on the Sync Client.

✨ Feature request

Status

Active

Version

1.0

Component

Code

Created by

🇧🇪Belgium andreasderijcke Antwerpen / Gent

Live updates comments and jobs are added and updated live.

Merge Requests

!4Add Sync Client base that implements progress tracking
Merged
🇧🇪Belgium andreasderijcke
updated 4 days ago

Comments & Activities

Issue created by @andreasderijcke
Merge request !4Issue 3516723 Added PagedImportSyncClientBase and example SyncClientSimplePagedImport. → (Merged) created by andreasderijcke
Comment 4 days ago →
🇧🇪Belgium andreasderijcke Antwerpen / Gent
Added:

PagedImportSyncClientBase, PagedImportSyncClientInterface

Example client SyncClientSimplePagedImport and job type SyncClientSimplePagedImport to explain how to use it.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024

Add Sync Client base that implements progress tracking

Problem/Motivation

Proposed resolution

Merge Requests

!4Add Sync Client base that implements progress trackingMerged

Comments & Activities

!4Add Sync Client base that implements progress tracking
Merged