(refactor) O3-2815: Replace usages of `/ws/rest/v1` with `restBaseUrl` #1661

jwnasambu · 2024-02-13T14:56:00Z

Requirements

This PR has a title that briefly describes the work done including the ticket number. If there is a ticket, make sure your PR title includes a conventional commit label. See existing PR titles for inspiration.
My work conforms to the OpenMRS 3.0 Styleguide and design documentation.
My work includes tests or is validated by existing tests.

Summary

Change all instances of the hard-coded API base URL '/ws/rest/v1/' to use the restBaseUrl variable instead. To enhances maintainability and flexibility of the API base URL configuration.

Screenshots

None

Related Issue

https://openmrs.atlassian.net/browse/O3-2815

Other

usamaidrsk · 2024-02-14T07:22:44Z

packages/esm-form-engine-app/src/hooks/useFormSchema.tsx

@@ -10,7 +10,7 @@ import { type OHRIFormSchema } from '@openmrs/openmrs-form-engine-lib';
 * @returns An object containing the form schema, error, and loading state
 */
 const useFormSchema = (formUuid: string) => {
-  const url = formUuid ? `/ws/rest/v1/o3/forms/${formUuid}` : null;
+  const url = formUuid ? `/restBaseUrl/o3/forms/${formUuid}` : null;


You might need to check on this @jwnasambu

usamaidrsk · 2024-02-14T10:58:44Z

Thanks @jwnasambu for the initiative.
Looking at the value restBaseUrl resolves to, I think it's about replacing '/ws/rest/v1/' with restBaseUrl

cc @denniskigen

jwnasambu · 2024-02-14T13:07:35Z

@usamaidrsk Thanks so much for the catch! @denis' ticket description is very clear its me on the wrong and am trying to fix my errors.

jwnasambu · 2024-02-15T18:04:23Z

@denniskigen, @usamaidrsk, @ibacher kindly how can I go about with the E2E Tests build faller. Basing on the research I have done, Am getting The error you're encountering (SyntaxError: Unexpected token 'export') suggests that the environment in which you're running your code doesn't support ECMAScript module syntax.

To resolve this, you can try the following steps:

Ensure Node.js Version:
Make sure you are using a version of Node.js that supports ECMAScript modules (ESM). Node.js versions 13.2.0 and later support ESM. You can check your Node.js version using: node --version` Apparently am running node -v
v18.12.0 which shouldn't be the cause.

ibacher · 2024-02-15T18:38:34Z

Do not change the strings in mocks or test files at all. Only in the production code. Also, in one place, a regular expression was changed to remove the preceding .+, which makes that code non-functional.

vasharma05 · 2024-02-21T12:12:35Z

yarn up @openmrs/esm-framework@next openmrs@next

denniskigen · 2024-02-24T22:27:32Z

Thanks, @jwnasambu!

(feat) O3-2760: Add a `closeWorkspaceWithSavedChanges` function to the workspace API (openmrs#1689) * Added new function 'closeWorkspaceWithSavedChanges' to close workspace after form is saved * Passing 'closeWorkspaceWithSavedChanges' as workspace props (docs) Amend steps for updating core libraries in README (openmrs#1690) (chore) Bump @openmrs/ngx-formentry (openmrs#1684) (fix) O3 2804: Reuse the ResponsiveWrapper component from esm-framework (openmrs#1673) * (feat) Reuse ResponsiveWrapper component from esm-framework * feat: Added Layer in visit-notes-form * Fix styleguide imports by bumping both openmrs tooling and framework * Misc fixes --------- Co-authored-by: Dennis Kigen <[email protected]> (refactor) O3-2815: Replace usages of `/ws/rest/v1` with `restBaseUrl` (openmrs#1661) * (Refactor)O3-2815: Replace usages of '/ws/rest/v1' with restBaseUrl * Fixup --------- Co-authored-by: jwnasambu <wamalwa1844.com> Co-authored-by: Dennis Kigen <[email protected]> (feat) Add ability to cancel orders (openmrs#1640) * (feat) cancel order * clean up * pr changes, reload fixes and clean up * translations * wip cancel order via action * mutate orders on cancel * order mutations and pr comments * fixes to labs * button text change * Fixup * More tweaks --------- Co-authored-by: Dennis Kigen <[email protected]> (chore) Add generic slot to Visit Form (openmrs#1688) * (chore) Add billing slot to Start Visit Form * Add generic visit attribute slot * remove slot from config --------- Co-authored-by: CynthiaKamau <[email protected]> (chore) Bump Angular form engine (openmrs#1694) (feat) Makes orders widget expandable and adds detailed order view (openmrs#1696) * (feat) Expandable orders widget * adds order item cards when expanded * changes button to tooltip (fix) O3-2629: Submit button on Allergy Form remains disabled when filling allergen and severity before reactions (openmrs#1699) fix the allergy reaction dependency (feat) Hide bottom navigation on tablets and phones when workspace is active (openmrs#1695) (feat) Relocate Load More button in visits section (openmrs#1702) (chore) Relocate Load More button in visits section add closeWorkspaceWithSavedChanges argument to Allergy form parameterised allergy reaction should be checked correctly maintain non-coded allergen array remove test (chore) Prettier should only list files that don't formatting config (feat) Add config to handle bill submission in start visit form (openmrs#1700) Upgrade peter-evans/create-pull-request See peter-evans/create-pull-request#2790 (chore) Update translations from Transifex (openmrs#1683) add test fix added test

openmrs#1661) * (Refactor)O3-2815: Replace usages of '/ws/rest/v1' with restBaseUrl * Fixup --------- Co-authored-by: jwnasambu <wamalwa1844.com> Co-authored-by: Dennis Kigen <[email protected]>

) * Add functionality to allow deleting and editing an allergy (feat) O3-2760: Add a `closeWorkspaceWithSavedChanges` function to the workspace API (#1689) * Added new function 'closeWorkspaceWithSavedChanges' to close workspace after form is saved * Passing 'closeWorkspaceWithSavedChanges' as workspace props (docs) Amend steps for updating core libraries in README (#1690) (chore) Bump @openmrs/ngx-formentry (#1684) (fix) O3 2804: Reuse the ResponsiveWrapper component from esm-framework (#1673) * (feat) Reuse ResponsiveWrapper component from esm-framework * feat: Added Layer in visit-notes-form * Fix styleguide imports by bumping both openmrs tooling and framework * Misc fixes --------- Co-authored-by: Dennis Kigen <[email protected]> (refactor) O3-2815: Replace usages of `/ws/rest/v1` with `restBaseUrl` (#1661) * (Refactor)O3-2815: Replace usages of '/ws/rest/v1' with restBaseUrl * Fixup --------- Co-authored-by: jwnasambu <wamalwa1844.com> Co-authored-by: Dennis Kigen <[email protected]> (feat) Add ability to cancel orders (#1640) * (feat) cancel order * clean up * pr changes, reload fixes and clean up * translations * wip cancel order via action * mutate orders on cancel * order mutations and pr comments * fixes to labs * button text change * Fixup * More tweaks --------- Co-authored-by: Dennis Kigen <[email protected]> (chore) Add generic slot to Visit Form (#1688) * (chore) Add billing slot to Start Visit Form * Add generic visit attribute slot * remove slot from config --------- Co-authored-by: CynthiaKamau <[email protected]> (chore) Bump Angular form engine (#1694) (feat) Makes orders widget expandable and adds detailed order view (#1696) * (feat) Expandable orders widget * adds order item cards when expanded * changes button to tooltip (fix) O3-2629: Submit button on Allergy Form remains disabled when filling allergen and severity before reactions (#1699) fix the allergy reaction dependency (feat) Hide bottom navigation on tablets and phones when workspace is active (#1695) (feat) Relocate Load More button in visits section (#1702) (chore) Relocate Load More button in visits section add closeWorkspaceWithSavedChanges argument to Allergy form parameterised allergy reaction should be checked correctly maintain non-coded allergen array remove test (chore) Prettier should only list files that don't formatting config (feat) Add config to handle bill submission in start visit form (#1700) Upgrade peter-evans/create-pull-request See peter-evans/create-pull-request#2790 (chore) Update translations from Transifex (#1683) add test fix added test * clean deletePatientAllergy function * Update packages/esm-patient-allergies-app/src/allergies/allergies-form/allergy-form.component.tsx Co-authored-by: Dennis Kigen <[email protected]> * Update packages/esm-patient-allergies-app/src/allergies/allergies-form/allergy-form.test.tsx Co-authored-by: Dennis Kigen <[email protected]> * Update packages/esm-patient-allergies-app/src/allergies/allergies-form/allergy-form.resource.ts Co-authored-by: Dennis Kigen <[email protected]> * (chore) Bump @openmrs/ngx-formentry * make default allergy loading more clean * fix linting --------- Co-authored-by: Dennis Kigen <[email protected]>

openmrs#1661) * (Refactor)O3-2815: Replace usages of '/ws/rest/v1' with restBaseUrl * Fixup --------- Co-authored-by: jwnasambu <wamalwa1844.com> Co-authored-by: Dennis Kigen <[email protected]>

…enmrs#1703) * Add functionality to allow deleting and editing an allergy (feat) O3-2760: Add a `closeWorkspaceWithSavedChanges` function to the workspace API (openmrs#1689) * Added new function 'closeWorkspaceWithSavedChanges' to close workspace after form is saved * Passing 'closeWorkspaceWithSavedChanges' as workspace props (docs) Amend steps for updating core libraries in README (openmrs#1690) (chore) Bump @openmrs/ngx-formentry (openmrs#1684) (fix) O3 2804: Reuse the ResponsiveWrapper component from esm-framework (openmrs#1673) * (feat) Reuse ResponsiveWrapper component from esm-framework * feat: Added Layer in visit-notes-form * Fix styleguide imports by bumping both openmrs tooling and framework * Misc fixes --------- Co-authored-by: Dennis Kigen <[email protected]> (refactor) O3-2815: Replace usages of `/ws/rest/v1` with `restBaseUrl` (openmrs#1661) * (Refactor)O3-2815: Replace usages of '/ws/rest/v1' with restBaseUrl * Fixup --------- Co-authored-by: jwnasambu <wamalwa1844.com> Co-authored-by: Dennis Kigen <[email protected]> (feat) Add ability to cancel orders (openmrs#1640) * (feat) cancel order * clean up * pr changes, reload fixes and clean up * translations * wip cancel order via action * mutate orders on cancel * order mutations and pr comments * fixes to labs * button text change * Fixup * More tweaks --------- Co-authored-by: Dennis Kigen <[email protected]> (chore) Add generic slot to Visit Form (openmrs#1688) * (chore) Add billing slot to Start Visit Form * Add generic visit attribute slot * remove slot from config --------- Co-authored-by: CynthiaKamau <[email protected]> (chore) Bump Angular form engine (openmrs#1694) (feat) Makes orders widget expandable and adds detailed order view (openmrs#1696) * (feat) Expandable orders widget * adds order item cards when expanded * changes button to tooltip (fix) O3-2629: Submit button on Allergy Form remains disabled when filling allergen and severity before reactions (openmrs#1699) fix the allergy reaction dependency (feat) Hide bottom navigation on tablets and phones when workspace is active (openmrs#1695) (feat) Relocate Load More button in visits section (openmrs#1702) (chore) Relocate Load More button in visits section add closeWorkspaceWithSavedChanges argument to Allergy form parameterised allergy reaction should be checked correctly maintain non-coded allergen array remove test (chore) Prettier should only list files that don't formatting config (feat) Add config to handle bill submission in start visit form (openmrs#1700) Upgrade peter-evans/create-pull-request See peter-evans/create-pull-request#2790 (chore) Update translations from Transifex (openmrs#1683) add test fix added test * clean deletePatientAllergy function * Update packages/esm-patient-allergies-app/src/allergies/allergies-form/allergy-form.component.tsx Co-authored-by: Dennis Kigen <[email protected]> * Update packages/esm-patient-allergies-app/src/allergies/allergies-form/allergy-form.test.tsx Co-authored-by: Dennis Kigen <[email protected]> * Update packages/esm-patient-allergies-app/src/allergies/allergies-form/allergy-form.resource.ts Co-authored-by: Dennis Kigen <[email protected]> * (chore) Bump @openmrs/ngx-formentry * make default allergy loading more clean * fix linting --------- Co-authored-by: Dennis Kigen <[email protected]>

jwnasambu marked this pull request as draft February 13, 2024 14:58

jwnasambu changed the title ~~Replace usages of '/ws/rest/v1' with restBaseUrl~~ (Refactor)O3-2815: Replace usages of '/ws/rest/v1' with restBaseUrl Feb 13, 2024

jwnasambu force-pushed the (refactor)O3-2815 branch from b91b610 to ebd6384 Compare February 13, 2024 21:36

usamaidrsk reviewed Feb 14, 2024

View reviewed changes

jwnasambu marked this pull request as ready for review February 15, 2024 18:04

jwnasambu marked this pull request as draft February 15, 2024 20:56

denniskigen changed the title ~~(Refactor)O3-2815: Replace usages of '/ws/rest/v1' with restBaseUrl~~ (refactor) O3-2815: Replace usages of /ws/rest/v1 with restBaseUrl Feb 15, 2024

jwnasambu marked this pull request as ready for review February 20, 2024 22:02

denniskigen mentioned this pull request Feb 20, 2024

(test) Add restBaseUrl to esm-framework mock openmrs/openmrs-esm-core#940

Merged

4 tasks

jwnasambu force-pushed the (refactor)O3-2815 branch from b5e4bc3 to c126e8c Compare February 21, 2024 14:43

denniskigen force-pushed the (refactor)O3-2815 branch from f311587 to f66a9bd Compare February 23, 2024 21:11

denniskigen mentioned this pull request Feb 24, 2024

(feat) Remove millis prop from Toast component openmrs/openmrs-esm-form-engine-lib#172

Merged

3 tasks

(Refactor)O3-2815: Replace usages of '/ws/rest/v1' with restBaseUrl

8a89f07

denniskigen force-pushed the (refactor)O3-2815 branch 4 times, most recently from ce9da4d to 0671d4d Compare February 24, 2024 21:52

Fixup

7793e3c

denniskigen force-pushed the (refactor)O3-2815 branch from 0671d4d to 7793e3c Compare February 24, 2024 22:13

denniskigen approved these changes Feb 24, 2024

View reviewed changes

denniskigen merged commit 6aa9325 into openmrs:main Feb 24, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(refactor) O3-2815: Replace usages of `/ws/rest/v1` with `restBaseUrl` #1661

(refactor) O3-2815: Replace usages of `/ws/rest/v1` with `restBaseUrl` #1661

jwnasambu commented Feb 13, 2024 •

edited

Loading

usamaidrsk Feb 14, 2024

usamaidrsk commented Feb 14, 2024

jwnasambu commented Feb 14, 2024 •

edited

Loading

jwnasambu commented Feb 15, 2024

ibacher commented Feb 15, 2024

vasharma05 commented Feb 21, 2024

denniskigen commented Feb 24, 2024

(refactor) O3-2815: Replace usages of /ws/rest/v1 with restBaseUrl #1661

(refactor) O3-2815: Replace usages of /ws/rest/v1 with restBaseUrl #1661

Conversation

jwnasambu commented Feb 13, 2024 • edited Loading

Requirements

Summary

Screenshots

Related Issue

Other

usamaidrsk Feb 14, 2024

Choose a reason for hiding this comment

usamaidrsk commented Feb 14, 2024

jwnasambu commented Feb 14, 2024 • edited Loading

jwnasambu commented Feb 15, 2024

ibacher commented Feb 15, 2024

vasharma05 commented Feb 21, 2024

denniskigen commented Feb 24, 2024

(refactor) O3-2815: Replace usages of `/ws/rest/v1` with `restBaseUrl` #1661

(refactor) O3-2815: Replace usages of `/ws/rest/v1` with `restBaseUrl` #1661

jwnasambu commented Feb 13, 2024 •

edited

Loading

jwnasambu commented Feb 14, 2024 •

edited

Loading