feat: move data engine to a standalone package without react dependency [LIBS-711] #1392
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
Leaving this as draft for an initial review, still need to write documentation for how to use this in non-React and React server component contexts |
Member
Author
|
Most of these SonarCloud code smells are probably legit but from older code... we should probably still address them here. |
Member
Author
|
An alternative option here might be to export the engine as a separate library entrypoint to |
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
KaiVandivier
reviewed
Nov 4, 2025
KaiVandivier
reviewed
Nov 4, 2025
Comment on lines
-248
to
+249
| const mockSpy = jest.fn(() => 42) | ||
| const mockSpy = jest.fn(() => Promise.resolve(42)) |
|
KaiVandivier
approved these changes
Nov 4, 2025
Contributor
KaiVandivier
left a comment
KaiVandivier
left a comment
There was a problem hiding this comment.
Remaining: tests and docs
Otherwise awesome!!! 🙌
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implements LIBS-711
Key features
Externalizes the data engine as a new standalone package (
@dhis2/data-engine, we could consider a different name) so that it can be used in non-React contexts. This new package has zero external dependencies and should encapsulate all most DHIS2-specific business logic/authentication/etc.Additionally, add support for a
fetch-like interface to DataEngine - i.e.engine.fetch('/me', { method: 'PATCH', body: { 'employer': 'DHIS2' }}). Add syntax sugar methods for each method as well, i.e.engine.get('me')This is a non-breaking change for consumers of
app-runtimeorapp-service-dataFinally, a new
DataEnginewith config-initializedRestApiLinkis bound towindow.enginein the QueryPlayground example, which allows testing and experimenting with the engine in the browser console. See below:Checklist