openmrs-esm-patient-chart

:wave: New to our project? Be sure to review the OpenMRS 3 Frontend Developer Documentation :teacher:

OpenMRS CI

OpenMRS ESM Patient Chart

The openmrs-esm-patient-chart is a frontend module for the OpenMRS SPA. It contains various microfrontends that constitute widgets in a patient dashboard. These widgets include:

In addition to these widgets, two other microfrontends exist that encapsulate cross-cutting concerns. These are:

Setup

Check out the developer documentation in the Wiki.

This monorepo uses yarn.

To install the dependencies, run:

yarn

To start a dev server for a specific microfrontend, run:

yarn start --sources 'packages/esm-patient-<insert-package-name>-app'

This command uses the openmrs tooling to fire up a dev server running esm-patient-chart as well as the specified microfrontend.

There are two approaches for working on multiple microfrontends simultaneously.

You could run yarn start with as many sources arguments as you require. For example, to run the biometrics and vitals microfrontends simultaneously, you’d use:

yarn start --sources 'packages/esm-patient-biometrics-app' --sources 'packages/esm-patient-vitals-app'

Alternatively, you could run yarn serve from within the individual packages and then use import map overrides.

Running unit and integration tests

To run unit and integration tests for all packages, run:

yarn turbo run test

To run tests in watch mode, run:

yarn turbo run test:watch

To run tests for a specific package, pass the package name to the --filter flag. For example, to run tests for esm-patient-conditions-app, run:

yarn turbo run test --filter=@openmrs/esm-patient-conditions-app

To run a specific test file, run:

yarn turbo run test -- visit-notes-form

The above command will only run tests in the file or files that match the provided string.

You can also run the matching tests from above in watch mode. In order to interact with the test runner, you will need to tell Turborepo to use the “tui” UI. Use the following command and then press “enter” in the Turbo UI to activate interactive mode.

yarn turbo run test:watch --ui tui -- visit-notes-form

To generate a coverage report, run:

yarn turbo run coverage

By default, turbo will cache test runs. This means that re-running tests wihout changing any of the related files will return the cached logs from the last run. To bypass the cache, run tests with the force flag, as follows:

yarn turbo run test --force

Running End-to-End (E2E) tests

Before running the E2E tests, you need to set up the test environment. Install Playwright browsers and setup the default test environment variables by running the following commands:

npx playwright install
cp example.env .env

By default, tests run against a local backend at http://localhost:8080/openmrs. To test local changes, make sure your dev server is running before executing tests. For example, to test local changes to the Allergies app, run:

yarn start --sources packages/esm-patient-allergies-app

To test against a remote instance (such as the OpenMRS refapp hosted on dev3.openmrs.org, update the E2E_BASE_URL environment variable in your .env file:

E2E_BASE_URL=https://dev3.openmrs.org/openmrs

To run E2E tests:

yarn test-e2e

This will run all the E2E tests (files in the e2e directory with the *.spec.ts extension) in headless mode. That means no browser UI will be visible.

To run tests in headed mode (shows the browser while tests run) use:

yarn test-e2e --headed

To run tests in Playwright’s UI mode (interactive debugger), use:

yarn test-e2e --ui

You’ll most often want to run tests in both headed and UI mode:

yarn test-e2e --headed --ui

To run a specific test file:

yarn test-e2e <test-name>

Read the e2e testing guide to learn more about End-to-End tests in this project.

Updating Playwright

The Playwright version in the Bamboo e2e Dockerfile and the package.json file must match. If you update the Playwright version in one place, you must update it in the other.

Troubleshooting

If you notice that your local version of the application is not working or that there’s a mismatch between what you see locally versus what’s in dev3, you likely have outdated versions of core libraries. To update core libraries, run the following commands:

# Upgrade core libraries
yarn up openmrs@next @openmrs/esm-framework@next

# Reset version specifiers to `next`. Don't commit actual version numbers.
git checkout package.json

# Run `yarn` to recreate the lockfile
yarn

Layout

The patient chart consists of the following parts:

The navigation menu lives on the left side of the screen and provides links to dashboards in the patient chart.

The patient header contains the patient banner. Uninvasive notifications also appear in this area following actions such as form submissions.

The chart review area is the main part of the screen. It displays whatever dashboard is active.

A dashboard is a collection of widgets.

The workspace is where data entry takes place. On mobile devices it covers the screen; on desktop it appears in a sidebar.

The side menu provides access to features that do not have their own pages, such as the notifications menu.

Design Patterns

For documentation about our design patterns, please visit our design system documentation website.

Configuration

Please see the Implementer Documentation for information about configuring modules.

Deployment

See Creating a Distribution for information about adding microfrontends to a distribution.

This site is open source. Improve this page.