From d9a6bce5a7533a96d56533fb1532a3595e9a5f31 Mon Sep 17 00:00:00 2001 From: Tom Wier Date: Fri, 13 Dec 2024 13:35:45 +0300 Subject: [PATCH] feat(#129): moving troubleshooting section --- .../guides/interoperability/openhim.md | 36 ++++++++++++-- .../bad-client-screen.png | Bin .../guides/interoperability/openmrs.md | 2 +- .../interoperability/troubleshooting.md | 45 ------------------ 4 files changed, 32 insertions(+), 51 deletions(-) rename content/en/building/guides/interoperability/{troubleshooting => openhim}/bad-client-screen.png (100%) delete mode 100644 content/en/building/guides/interoperability/troubleshooting.md diff --git a/content/en/building/guides/interoperability/openhim.md b/content/en/building/guides/interoperability/openhim.md index b5e7c57a0..45b5a03dd 100644 --- a/content/en/building/guides/interoperability/openhim.md +++ b/content/en/building/guides/interoperability/openhim.md @@ -8,7 +8,6 @@ keywords: openmrs interoperability relatedContent: > building/guides/interoperability/cht-config building/guides/interoperability/ltfu - building/guides/interoperability/troubleshooting building/concepts/interoperability/ building/guides/integrations/openmrs/ --- @@ -38,10 +37,6 @@ See more information on the [CHT interoperability page]({{< ref "building/concep - `docker` - `Postman` or similar tool for API testing. -### Troubleshooting - -Users getting errors when running the following installation steps, please see the [Troubleshooting guide]({{< ref "building/guides/interoperability/troubleshooting" >}}). - ### Install & First Time Run 1. Run `./startup.sh init` to start-up the docker containers on the first run or after calling `./startup.sh destroy`. Use `./startup.sh up` for subsequent runs after calling `init` without calling `destroy`. @@ -113,3 +108,34 @@ curl -X PUT -H "Content-Type: text/plain" http://medic:password@localhost:5988/a - To then restart the containers, run `./startup.sh up`. You do not need to run `init` again like you did in the initial install above. - To shut-down and delete _everything_, run `./startup.sh destroy`. You will have to subsequently run `./startup.sh init` if you wish to start the containers. +### Troubleshooting + +#### Error "bind: address already in use" +Users encountering: + +> Error response from daemon: Ports are not available: exposing port TCP 0.0.0.0:5000 -> 0.0.0.0:0: listen tcp 0.0.0.0:5000: bind: address already in use + +when running `./startup.sh init` need to update ports to available values in the `/docker/docker-compose.yml` file, under the `ports` verb. + +#### Error when running mediator `curl` request +If the mediator `curl` request fails, visit [http://localhost:9000/#!/clients](http://localhost:9000/#!/clients) and click on the icon the red arrow points to in the image below. + +![](bad-client-screen.png) + +#### Error "Preset ts-jest is invalid:" when running `npm test` +Users encountering the error below when running `npm test`: + +> Preset ts-jest is invalid: +> The "id" argument must be of type string. Received null +> TypeError [ERR_INVALID_ARG_TYPE]: The "id" argument must be of type string. Received null + +need to run `npm i --save-dev ts-jest` before running `npm test`. + +#### Error "unsuccessful npm install" when running `npm install` +Users encountering the error when running `npm install`: + +> npm ERR! code EACCES +> npm ERR! syscall unlink +> npm ERR! path /Users/phil/interoperability/cht-config/node_modules/.package-lock.json + +need to run `npm install` as root user. diff --git a/content/en/building/guides/interoperability/troubleshooting/bad-client-screen.png b/content/en/building/guides/interoperability/openhim/bad-client-screen.png similarity index 100% rename from content/en/building/guides/interoperability/troubleshooting/bad-client-screen.png rename to content/en/building/guides/interoperability/openhim/bad-client-screen.png diff --git a/content/en/building/guides/interoperability/openmrs.md b/content/en/building/guides/interoperability/openmrs.md index c8a134173..800a2d7ee 100644 --- a/content/en/building/guides/interoperability/openmrs.md +++ b/content/en/building/guides/interoperability/openmrs.md @@ -377,7 +377,7 @@ The interoperability project will automatically create the following resources ### Troubleshooting -In case of errors when setting up the OpenHIM project please see the [Troubleshooting guide]({{< ref "building/guides/interoperability/troubleshooting" >}}). +In case of errors when setting up the OpenHIM project please see the [Troubleshooting guide]({{< ref "building/guides/interoperability/openhim#troubleshooting" >}}). If the openhim project starts up correctly but something else does not work as expected, it can be helpful to first check the transaction log page of OpenHIM to see which requests were sent, and the request and response bodies. See the sequence diagrams above for the expected requests/responses. diff --git a/content/en/building/guides/interoperability/troubleshooting.md b/content/en/building/guides/interoperability/troubleshooting.md deleted file mode 100644 index 2a449266e..000000000 --- a/content/en/building/guides/interoperability/troubleshooting.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "Troubleshooting Interoperability" -linkTitle: "Troubleshooting" -weight: 5 -description: > - Guide to troubleshooting OpenHIM, Mediators, and configurations for interoperability workflows -keywords: openmrs interoperability -relatedContent: > - building/guides/interoperability/cht-config - building/guides/interoperability/ltfu - building/guides/interoperability/openhim - building/guides/interoperability/openmrs - building/concepts/interoperability/ ---- -# Troubleshooting - -## Error "bind: address already in use" -Users encountering: - -> Error response from daemon: Ports are not available: exposing port TCP 0.0.0.0:5000 -> 0.0.0.0:0: listen tcp 0.0.0.0:5000: bind: address already in use - -when running `./startup.sh init` need to update ports to available values in the `/docker/docker-compose.yml` file, under the `ports` verb. - -## Error when running mediator `curl` request -If the mediator `curl` request fails, visit [http://localhost:9000/#!/clients](http://localhost:9000/#!/clients) and click on the icon the red arrow points to in the image below. - -![](bad-client-screen.png) - -## Error "Preset ts-jest is invalid:" when running `npm test` -Users encountering the error below when running `npm test`: - -> Preset ts-jest is invalid: -> The "id" argument must be of type string. Received null -> TypeError [ERR_INVALID_ARG_TYPE]: The "id" argument must be of type string. Received null - -need to run `npm i --save-dev ts-jest` before running `npm test`. - -## Error "unsuccessful npm install" when running `npm install` -Users encountering the error when running `npm install`: - -> npm ERR! code EACCES -> npm ERR! syscall unlink -> npm ERR! path /Users/phil/interoperability/cht-config/node_modules/.package-lock.json - -need to run `npm install` as root user.