(fix) Fetch all backend modules in implementer tools when count exceeds page limit #1463

ODORA0 · 2025-09-29T05:37:19Z

Requirements

This PR has a title that briefly describes the work done including the ticket number. Ensure your PR title includes a conventional commit label (such as feat, fix, or chore, among others). See existing PR titles for inspiration.

If applicable

My work is based on designs, which are linked or shown either in the Jira ticket or the description below.
My work includes tests or is validated by existing tests.
I have updated the esm-framework mock to reflect any API changes I have made.

Summary

Updated fetchInstalledBackendModules to follow links[rel="next"] until exhausted
Normalized relative next URLs to prevent broken fetches
Switched to v=default representation to avoid 400 Bad Request errors on some servers
Mapped results to uuid for proper dependency matching
Ensures modules like Reporting are correctly recognized and avoids false "unresolved backend dependencies" errors

Screenshots

Related Issue

Other

ibacher

Thanks @ODORA0! Just a couple of nits and it should be ok.

ibacher · 2025-10-07T18:36:21Z

...ages/apps/esm-implementer-tools-app/src/backend-dependencies/openmrs-backend-dependencies.ts

+      nextUrl = resolveNext(nextLink ? nextLink.uri || nextLink.href || null : null);
+      safetyCounter += 1;
+    } catch (e) {
+      console.error('Failed to fetch installed backend modules page', e);


Would be good to include more details like what page we were trying to fetch, etc.

ibacher · 2025-10-07T18:37:13Z

...ages/apps/esm-implementer-tools-app/src/backend-dependencies/openmrs-backend-dependencies.ts

+  const collected: Array<BackendModule> = [];
+  let nextUrl: string | null = `${restBaseUrl}/module?v=default`;
+  let safetyCounter = 0;
+  const MAX_PAGES = 50;


If this is actually intended as a const it should be defined outside the function. Otherwise, just call this maxPages.

ibacher · 2025-10-07T18:41:15Z

...ages/apps/esm-implementer-tools-app/src/backend-dependencies/openmrs-backend-dependencies.ts

+
+      // Use moduleid/moduleId for name matching against required dependency keys (e.g., 'reporting')
+      const pageResults: Array<BackendModule> = rawResults.map((r) => ({
+        uuid: r.moduleId ?? r.moduleid ?? r.uuid,


While the API can return moduleId (but never moduleid), we're always requesting the default view where the property will always be uuid

Suggested change

uuid: r.moduleId ?? r.moduleid ?? r.uuid,

uuid: r.uuid,

ibacher · 2025-10-07T18:44:02Z

...ages/apps/esm-implementer-tools-app/src/backend-dependencies/openmrs-backend-dependencies.ts

+      const links: Array<{ rel?: string; uri?: string; href?: string }> = Array.isArray(data?.links) ? data.links : [];
+      const nextLink = links.find((l) => (l.rel || '').toLowerCase() === 'next');
+
+      nextUrl = resolveNext(nextLink ? nextLink.uri || nextLink.href || null : null);


For the REST API, we always return the property uri if anything.

Suggested change

nextUrl = resolveNext(nextLink ? nextLink.uri || nextLink.href || null : null);

nextUrl = resolveNext(nextLink?.uri ?? null);

...ages/apps/esm-implementer-tools-app/src/backend-dependencies/openmrs-backend-dependencies.ts

denniskigen · 2025-10-07T20:00:32Z

...ages/apps/esm-implementer-tools-app/src/backend-dependencies/openmrs-backend-dependencies.ts

-  });
+async function fetchInstalledBackendModules(): Promise<Array<BackendModule>> {
+  const collected: Array<BackendModule> = [];
+  let nextUrl: string | null = `${restBaseUrl}/module?v=default`;


Suggested change

let nextUrl: string | null = `${restBaseUrl}/module?v=default`;

let nextUrl: string | null = `${restBaseUrl}/module?v=custom:(uuid,version)`;

Can we whittle the custom representation down to just fetching the uuid and version properties? That substantially reduces the payload size from ~10 fields per module down to just 2. The response would look like this:

{ "results": [ { "uuid": "serialization.xstream", "version": "0.2.16" }, { "uuid": "authentication", "version": "2.0.0-SNAPSHOT" }, { "uuid": "fhir2", "version": "2.8.0-SNAPSHOT" } ] }

versus this in the default response:

{ "results": [ { "uuid": "serialization.xstream", "display": "Serialization Xstream", "name": "Serialization Xstream", "description": "Core (de)serialize API and services supported by xstream library", "version": "0.2.16", "started": true, "startupErrorMessage": null, "links": [ { "rel": "full", "uri": "https://dev3.openmrs.org/openmrs/ws/rest/v1/module/serialization.xstream?v=full", "resourceAlias": "module" }, { "rel": "ref", "uri": "https://dev3.openmrs.org/openmrs/ws/rest/v1/module/serialization.xstream?v=ref", "resourceAlias": "module" }, { "rel": "action", "uri": "https://dev3.openmrs.org/openmrs/ws/rest/v1/moduleaction", "resourceAlias": "module" }, { "rel": "self", "uri": "https://dev3.openmrs.org/openmrs/ws/rest/v1/module/serialization.xstream", "resourceAlias": "module" } ], "resourceVersion": "1.8" }, { "uuid": "authentication", "display": "Authentication", "name": "Authentication", "description": "Authentication support for OpenMRS", "version": "2.0.0-SNAPSHOT", "started": true, "startupErrorMessage": null, "links": [ { "rel": "full", "uri": "https://dev3.openmrs.org/openmrs/ws/rest/v1/module/authentication?v=full", "resourceAlias": "module" }, { "rel": "ref", "uri": "https://dev3.openmrs.org/openmrs/ws/rest/v1/module/authentication?v=ref", "resourceAlias": "module" }, { "rel": "action", "uri": "https://dev3.openmrs.org/openmrs/ws/rest/v1/moduleaction", "resourceAlias": "module" }, { "rel": "self", "uri": "https://dev3.openmrs.org/openmrs/ws/rest/v1/module/authentication", "resourceAlias": "module" } ], "resourceVersion": "1.8" }, { "uuid": "fhir2", "display": "FHIR2", "name": "FHIR2", "description": "Implementation of FHIR R4 for OpenMRS", "version": "2.8.0-SNAPSHOT", "started": true, "startupErrorMessage": null, "links": [ { "rel": "full", "uri": "https://dev3.openmrs.org/openmrs/ws/rest/v1/module/fhir2?v=full", "resourceAlias": "module" }, { "rel": "ref", "uri": "https://dev3.openmrs.org/openmrs/ws/rest/v1/module/fhir2?v=ref", "resourceAlias": "module" }, { "rel": "action", "uri": "https://dev3.openmrs.org/openmrs/ws/rest/v1/moduleaction", "resourceAlias": "module" }, { "rel": "self", "uri": "https://dev3.openmrs.org/openmrs/ws/rest/v1/module/fhir2", "resourceAlias": "module" } ], "resourceVersion": "1.8" } ] }

denniskigen · 2025-10-07T20:06:10Z

...ages/apps/esm-implementer-tools-app/src/backend-dependencies/openmrs-backend-dependencies.ts

+      const { data } = await openmrsFetch(nextUrl, { method: 'GET' });
+      const rawResults: Array<any> = Array.isArray(data?.results) ? data.results : [];
+
+      // Use moduleid/moduleId for name matching against required dependency keys (e.g., 'reporting')


Suggested change

// Use moduleid/moduleId for name matching against required dependency keys (e.g., 'reporting')

This is misleading because the API's uuid field already contains module IDs like "webservices.rest". The moduleId/moduleid fields don't exist in the API response.

denniskigen · 2025-10-07T20:16:29Z

...ages/apps/esm-implementer-tools-app/src/backend-dependencies/openmrs-backend-dependencies.ts

+  while (nextUrl && safetyCounter < MAX_PAGES) {
+    try {
+      const { data } = await openmrsFetch(nextUrl, { method: 'GET' });
+      const rawResults: Array<any> = Array.isArray(data?.results) ? data.results : [];


Suggested change

const rawResults: Array<any> = Array.isArray(data?.results) ? data.results : [];

const rawResults: Array<BackendModule> = Array.isArray(data?.results) ? data.results : [];

…rect moduleId mapping

…mproved error handling

denniskigen

Thanks, @ODORA0!

alaboso requested review from denniskigen and ibacher October 2, 2025 14:15

alaboso marked this pull request as ready for review October 2, 2025 14:15

ibacher reviewed Oct 7, 2025

View reviewed changes

denniskigen reviewed Oct 7, 2025

View reviewed changes

denniskigen changed the title ~~fix(implementer-tools): handle paginated backend module fetch and correct moduleId mapping~~ (fix) Fetch all backend modules in implementer tools when count exceeds page limit Oct 7, 2025

ODORA0 force-pushed the ImplementerTools branch from 4cc5468 to 7307a9e Compare October 8, 2025 20:53

denniskigen requested a review from ibacher October 9, 2025 11:25

ODORA0 added 2 commits October 9, 2025 14:27

fix(implementer-tools): handle paginated backend module fetch and cor…

4e55e42

…rect moduleId mapping

Optimize backend module fetching with custom API representation and i…

23200a9

…mproved error handling

ibacher approved these changes Oct 9, 2025

View reviewed changes

Additional mods

93ece0d

denniskigen force-pushed the ImplementerTools branch from 7307a9e to 93ece0d Compare October 9, 2025 13:06

Add tests

14f7664

denniskigen force-pushed the ImplementerTools branch from 35053b7 to 14f7664 Compare October 9, 2025 19:29

denniskigen approved these changes Oct 9, 2025

View reviewed changes

denniskigen enabled auto-merge (squash) October 9, 2025 19:34

denniskigen merged commit d6d451f into openmrs:main Oct 9, 2025
14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

(fix) Fetch all backend modules in implementer tools when count exceeds page limit #1463

(fix) Fetch all backend modules in implementer tools when count exceeds page limit #1463

Uh oh!

ODORA0 commented Sep 29, 2025 •

edited by denniskigen

Loading

Uh oh!

ibacher left a comment

Uh oh!

ibacher Oct 7, 2025

Uh oh!

ibacher Oct 7, 2025

Uh oh!

ibacher Oct 7, 2025

Uh oh!

ibacher Oct 7, 2025

Uh oh!

Uh oh!

denniskigen Oct 7, 2025 •

edited

Loading

Uh oh!

denniskigen Oct 7, 2025

Uh oh!

denniskigen Oct 7, 2025

Uh oh!

denniskigen left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	nextUrl = resolveNext(nextLink ? nextLink.uri \|\| nextLink.href \|\| null : null);
	nextUrl = resolveNext(nextLink?.uri ?? null);

	let nextUrl: string \| null = `${restBaseUrl}/module?v=default`;
	let nextUrl: string \| null = `${restBaseUrl}/module?v=custom:(uuid,version)`;

	const rawResults: Array<any> = Array.isArray(data?.results) ? data.results : [];
	const rawResults: Array<BackendModule> = Array.isArray(data?.results) ? data.results : [];

(fix) Fetch all backend modules in implementer tools when count exceeds page limit #1463

(fix) Fetch all backend modules in implementer tools when count exceeds page limit #1463

Uh oh!

Conversation

ODORA0 commented Sep 29, 2025 • edited by denniskigen Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Requirements

If applicable

Summary

Screenshots

Related Issue

Other

Uh oh!

ibacher left a comment

Choose a reason for hiding this comment

Uh oh!

ibacher Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

ibacher Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

ibacher Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

ibacher Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

denniskigen Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

denniskigen Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

denniskigen Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

denniskigen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ODORA0 commented Sep 29, 2025 •

edited by denniskigen

Loading

denniskigen Oct 7, 2025 •

edited

Loading