OpenMRS Add pagination

.changeset/wicked-carrots-whisper.md

@@ -0,0 +1,5 @@
+---
+'@openfn/language-openmrs': minor
+---
+
+- Add pagination support on request helper function

packages/openmrs/ast.json

@@ -9,10 +9,6 @@
       "docs": {
         "description": "Gets patient matching a uuid",
         "tags": [
-          {
-            "title": "example",
-            "description": "getPatient(\"123\")"
-          },
           {
             "title": "function",
             "description": null,

packages/openmrs/package.json

@@ -25,18 +25,17 @@
     "configuration-schema.json"
   ],
   "dependencies": {
-    "@openfn/language-common": "2.0.1"
+    "@openfn/language-common": "workspace:*"
   },
   "devDependencies": {
     "@openfn/simple-ast": "^0.4.1",
-    "assertion-error": "^1.0.1",
-    "chai": "^3.4.0",
+    "assertion-error": "^1.1.0",
+    "chai": "^5.1.1",
     "deep-eql": "^0.1.3",
     "esno": "^0.16.3",
-    "mocha": "^10.1.0",
+    "mocha": "^10.7.3",
     "nock": "^12.0.3",
-    "rimraf": "^3.0.2",
-    "sinon": "^1.17.2"
+    "rimraf": "^3.0.2"
   },
   "type": "module",
   "exports": {
@@ -48,4 +47,4 @@
     "./package.json": "./package.json"
   },
   "types": "types/index.d.ts"
-}
+}

packages/openmrs/src/Adaptor.js

@@ -27,8 +27,6 @@ export function execute(...operations) {
 
 /**
  * Gets patient matching a uuid
- * @example
- * getPatient("123")
  * @function
  * @public
  * @param {string} uuid - A uuid for the patient
@@ -175,7 +173,7 @@ export function post(path, data, callback = s => s) {
  */
 export function searchPatient(query, callback = s => s) {
   return async state => {
-    const [resolvedQuery = {}] = expandReferences(state, query);
+    const [resolvedQuery] = expandReferences(state, query);
 
     console.log('Searching for patient with query:', resolvedQuery);
 
@@ -187,8 +185,6 @@ export function searchPatient(query, callback = s => s) {
       resolvedQuery
     );
 
-    console.log(`Found ${response.body.results.length} patients`);
-
     return prepareNextState(state, response, callback);
   };
 }
@@ -324,8 +320,8 @@ export function getEncounters(query, callback = s => s) {
       {},
       resolvedQuery
     );
+    console.log(`Found ${response.body.results.length} results`);
 
-    console.log(`Found ${response.body.results.length}} results`);
     return prepareNextState(state, response, callback);
   };
 }

packages/openmrs/src/Utils.js

@@ -2,11 +2,11 @@ import { composeNextState } from '@openfn/language-common';
 import {
   request as commonRequest,
   makeBasicAuthHeader,
-  logResponse
+  logResponse,
 } from '@openfn/language-common/util';
 
 export const prepareNextState = (state, response, callback) => {
-  const { body, ...responseWithoutBody } = response
+  const { body, ...responseWithoutBody } = response;
   const nextState = {
     ...composeNextState(state, response.body),
     response: responseWithoutBody,
@@ -15,24 +15,53 @@ export const prepareNextState = (state, response, callback) => {
   return callback(nextState);
 };
 
-export function request(state, method, path, data, params) {
+export async function request(state, method, path, data, params) {
   const { instanceUrl, username, password } = state.configuration;
   const headers = makeBasicAuthHeader(username, password);
 
   const options = {
     body: data,
-
     headers: {
       ...headers,
       'content-type': 'application/json',
     },
-
     query: params,
-
     parseAs: 'json',
   };
 
   const url = `${instanceUrl}${path}`;
 
-  return commonRequest(method, url, options).then(response => logResponse(response));
+  let allResponses;
+  let query = options?.query;
+  let allowPagination = isNaN(query?.startIndex);
+
+  do {
+    const requestOptions = query ? { ...options, query } : options;
+    const response = await commonRequest(method, url, requestOptions);
+    logResponse(response);
+
+    if (allResponses) {
+      allResponses.body.results.push(...response.body.results);
+    } else {
+      allResponses = response;
+    }
+    const nextUrl = response?.body?.links?.find(
+      link => link.rel === 'next'
+    )?.uri;
+
+    if (nextUrl) {
+      console.log(`Fetched ${response.body.results.length} results`);
+      console.log(`Fetching next page from ${nextUrl}`);
+      const urlObj = new URL(nextUrl);
+      const params = new URLSearchParams(urlObj.search);
+      const startIndex = params.get('startIndex');
+
+      query = { ...query, startIndex };
+    } else {
+      delete allResponses.body.links;
+      break;
+    }
+  } while (allowPagination);
+
+  return allResponses;
 }