(feat) Provide function for obtaining default config tree in test code

openmrs · Dec 24, 2023 · 7ca052e · 7ca052e
1 parent 4a0e8ab
commit 7ca052e
Show file tree

Hide file tree

Showing 4 changed files with 73 additions and 21 deletions.
diff --git a/packages/framework/esm-framework/docs/API.md b/packages/framework/esm-framework/docs/API.md
@@ -198,6 +198,7 @@
 - [age](API.md#age)
 - [canAccessStorage](API.md#canaccessstorage)
 - [daysIntoYear](API.md#daysintoyear)
+- [getDefaultsFromConfigSchema](API.md#getdefaultsfromconfigschema)
 - [isSameDay](API.md#issameday)
 - [isVersionSatisfied](API.md#isversionsatisfied)
 - [retry](API.md#retry)
@@ -4841,6 +4842,35 @@ The number of days.
 
 ___
 
+### getDefaultsFromConfigSchema
+
+▸ **getDefaultsFromConfigSchema**(`schema`): `Object`
+
+Given a config schema, this returns an object like is returned by `useConfig`
+with all default values.
+
+This should be used in tests and not in production code.
+
+If all you need is the default values in your tests, these are returned by
+default from the `useConfig`/`getConfig` mock. This function is useful if you
+need to override some of the default values.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `schema` | `any` |
+
+#### Returns
+
+`Object`
+
+#### Defined in
+
+[packages/framework/esm-utils/src/test-helpers.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/test-helpers.ts#L13)
+
+___
+
 ### isSameDay
 
 ▸ **isSameDay**(`firstDate`, `secondDate`): `boolean`

diff --git a/packages/framework/esm-framework/mock.tsx b/packages/framework/esm-framework/mock.tsx
@@ -4,7 +4,15 @@ import { createStore, type StoreApi } from 'zustand';
 import { NEVER, of } from 'rxjs';
 import { interpolateUrl } from '@openmrs/esm-config';
 import { type SessionStore } from '@openmrs/esm-api';
-export { parseDate, formatDate, formatDatetime, formatTime, age } from '@openmrs/esm-utils';
+import { getDefaultsFromConfigSchema } from '@openmrs/esm-utils';
+export {
+  getDefaultsFromConfigSchema,
+  parseDate,
+  formatDate,
+  formatDatetime,
+  formatTime,
+  age,
+} from '@openmrs/esm-utils';
 export { interpolateString, interpolateUrl, validators, validator } from '@openmrs/esm-config';
 
 window.i18next = { ...window.i18next, language: 'en' };
@@ -135,28 +143,10 @@ export enum Type {
 }
 
 let configSchema = {};
-function getDefaults(schema) {
-  let tmp = {};
-  for (let k of Object.keys(schema)) {
-    if (schema[k].hasOwnProperty('_default')) {
-      tmp[k] = schema[k]._default;
-    } else if (k.startsWith('_')) {
-      continue;
-    } else if (isOrdinaryObject(schema[k])) {
-      tmp[k] = getDefaults(schema[k]);
-    } else {
-      tmp[k] = schema[k];
-    }
-  }
-  return tmp;
-}
-function isOrdinaryObject(x) {
-  return !!x && x.constructor === Object;
-}
 
-export const getConfig = jest.fn().mockImplementation(() => Promise.resolve(getDefaults(configSchema)));
+export const getConfig = jest.fn().mockImplementation(() => Promise.resolve(getDefaultsFromConfigSchema(configSchema)));
 
-export const useConfig = jest.fn().mockImplementation(() => getDefaults(configSchema));
+export const useConfig = jest.fn().mockImplementation(() => getDefaultsFromConfigSchema(configSchema));
 
 export function defineConfigSchema(moduleName, schema) {
   configSchema = schema;

diff --git a/packages/framework/esm-utils/src/index.ts b/packages/framework/esm-utils/src/index.ts
@@ -2,6 +2,7 @@ export * from './age-helpers';
 export * from './omrs-dates';
 export * from './shallowEqual';
 export * from './storage';
+export * from './test-helpers';
 export * from './translate';
 export * from './version';
 export * from './retry';
diff --git a/packages/framework/esm-utils/src/test-helpers.ts b/packages/framework/esm-utils/src/test-helpers.ts
@@ -0,0 +1,31 @@
+/** @module @category Utility */
+
+/**
+ * Given a config schema, this returns an object like is returned by `useConfig`
+ * with all default values.
+ *
+ * This should be used in tests and not in production code.
+ *
+ * If all you need is the default values in your tests, these are returned by
+ * default from the `useConfig`/`getConfig` mock. This function is useful if you
+ * need to override some of the default values.
+ */
+export function getDefaultsFromConfigSchema(schema) {
+  let tmp = {};
+  for (let k of Object.keys(schema)) {
+    if (schema[k].hasOwnProperty('_default')) {
+      tmp[k] = schema[k]._default;
+    } else if (k.startsWith('_')) {
+      continue;
+    } else if (isOrdinaryObject(schema[k])) {
+      tmp[k] = getDefaultsFromConfigSchema(schema[k]);
+    } else {
+      tmp[k] = schema[k];
+    }
+  }
+  return tmp;
+}
+
+function isOrdinaryObject(x) {
+  return !!x && x.constructor === Object;
+}