@openmrs/esm-react-utils 9.0.3-pre.4834 → 9.0.3-pre.4843

package/.turbo/turbo-build.log

@@ -1,3 +1,3 @@
-[0] Successfully compiled: 53 files with swc (119.35ms)
+[0] Successfully compiled: 53 files with swc (178.96ms)
 [0] swc --strip-leading-paths src -d dist exited with code 0
 [1] tsc --project tsconfig.build.json exited with code 0

package/dist/openmrsComponentDecorator.d.ts

@@ -6,7 +6,7 @@ export interface ComponentDecoratorOptions {
     featureName: string;
     disableTranslations?: boolean;
     strictMode?: boolean;
-    swrConfig?: Partial<Omit<SWRConfiguration, 'fetcher'>>;
+    swrConfig?: Partial<Omit<SWRConfiguration, 'fetcher' | 'provider'>>;
 }
 export interface OpenmrsReactComponentProps {
     _extensionContext?: ExtensionData;

package/dist/openmrsComponentDecorator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openmrsComponentDecorator.d.ts","sourceRoot":"","sources":["../src/openmrsComponentDecorator.tsx"],"names":[],"mappings":"AAAA,OAAc,EAAE,KAAK,aAAa,EAAE,KAAK,SAAS,EAAY,MAAM,OAAO,CAAC;AAE5E,OAAO,EAAyB,KAAK,gBAAgB,EAAE,MAAM,KAAK,CAAC;AAGnE,OAAO,EAAE,KAAK,eAAe,EAAE,KAAK,aAAa,EAAE,MAAM,yBAAyB,CAAC;AA8CnF,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC,CAAC;CACxD;AAED,MAAM,WAAW,0BAA0B;IACzC,iBAAiB,CAAC,EAAE,aAAa,CAAC;CACnC;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE,GAAG,CAAC;IACjB,eAAe,EAAE,SAAS,GAAG,IAAI,CAAC;IAClC,MAAM,EAAE,eAAe,CAAC;CACzB;AAED,wBAAgB,yBAAyB,CAAC,CAAC,EAAE,QAAQ,EAAE,yBAAyB,IAY5C,MAAM,aAAa,CAAC,CAAC,CAAC,KAAG,aAAa,CAAC,CAAC,CAAC,CA4E5E"}
+{"version":3,"file":"openmrsComponentDecorator.d.ts","sourceRoot":"","sources":["../src/openmrsComponentDecorator.tsx"],"names":[],"mappings":"AAAA,OAAc,EAAE,KAAK,aAAa,EAAE,KAAK,SAAS,EAAY,MAAM,OAAO,CAAC;AAE5E,OAAO,EAAyB,KAAK,gBAAgB,EAAE,MAAM,KAAK,CAAC;AAInE,OAAO,EAAE,KAAK,eAAe,EAAE,KAAK,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAqDnF,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,SAAS,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC;CACrE;AAED,MAAM,WAAW,0BAA0B;IACzC,iBAAiB,CAAC,EAAE,aAAa,CAAC;CACnC;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE,GAAG,CAAC;IACjB,eAAe,EAAE,SAAS,GAAG,IAAI,CAAC;IAClC,MAAM,EAAE,eAAe,CAAC;CACzB;AAED,wBAAgB,yBAAyB,CAAC,CAAC,EAAE,QAAQ,EAAE,yBAAyB,IAY5C,MAAM,aAAa,CAAC,CAAC,CAAC,KAAG,aAAa,CAAC,CAAC,CAAC,CA4E5E"}

package/dist/openmrsComponentDecorator.js

@@ -14,6 +14,7 @@ function _define_property(obj, key, value) {
 import React, { Suspense } from "react";
 import { I18nextProvider } from "react-i18next";
 import { SWRConfig } from "swr";
+import { initCache } from "swr/_internal";
 import { openmrsFetch, OpenmrsFetchError } from "@openmrs/esm-api";
 import { ComponentContext } from "./ComponentContext.js";
 const defaultOpts = {
@@ -21,7 +22,14 @@ const defaultOpts = {
     throwErrorsToConsole: true,
     disableTranslations: false
 };
+// One global SWR cache shared by every decorated component, the same regardless
+// of module-federation load order (see #1397). It is pre-initialized here so its
+// SWRGlobalState is owned by this (singleton) module, not by the first
+// `<SWRConfig>` that mounts. Otherwise that boundary's unmount would run
+// `SWRGlobalState.delete(swrCache)` and the other still-mounted decorated
+// components would crash on their next render ("undefined is not iterable").
 const swrCache = new Map();
+initCache(swrCache);
 // Read more about the available config options here: https://swr.vercel.app/docs/api#configuration
 const defaultSwrConfig = {
     // max number of retries after requests have failed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-react-utils",
-  "version": "9.0.3-pre.4834",
+  "version": "9.0.3-pre.4843",
   "license": "MPL-2.0",
   "description": "React utilities for OpenMRS.",
   "type": "module",
@@ -79,17 +79,17 @@
     "swr": "2.x"
   },
   "devDependencies": {
-    "@openmrs/esm-api": "9.0.3-pre.4834",
-    "@openmrs/esm-config": "9.0.3-pre.4834",
-    "@openmrs/esm-context": "9.0.3-pre.4834",
-    "@openmrs/esm-emr-api": "9.0.3-pre.4834",
-    "@openmrs/esm-error-handling": "9.0.3-pre.4834",
-    "@openmrs/esm-extensions": "9.0.3-pre.4834",
-    "@openmrs/esm-feature-flags": "9.0.3-pre.4834",
-    "@openmrs/esm-globals": "9.0.3-pre.4834",
-    "@openmrs/esm-navigation": "9.0.3-pre.4834",
-    "@openmrs/esm-state": "9.0.3-pre.4834",
-    "@openmrs/esm-utils": "9.0.3-pre.4834",
+    "@openmrs/esm-api": "9.0.3-pre.4843",
+    "@openmrs/esm-config": "9.0.3-pre.4843",
+    "@openmrs/esm-context": "9.0.3-pre.4843",
+    "@openmrs/esm-emr-api": "9.0.3-pre.4843",
+    "@openmrs/esm-error-handling": "9.0.3-pre.4843",
+    "@openmrs/esm-extensions": "9.0.3-pre.4843",
+    "@openmrs/esm-feature-flags": "9.0.3-pre.4843",
+    "@openmrs/esm-globals": "9.0.3-pre.4843",
+    "@openmrs/esm-navigation": "9.0.3-pre.4843",
+    "@openmrs/esm-state": "9.0.3-pre.4843",
+    "@openmrs/esm-utils": "9.0.3-pre.4843",
     "@swc/cli": "0.8.1",
     "@swc/core": "1.15.21",
     "@vitest/coverage-v8": "^4.1.2",

package/src/openmrsComponentDecorator.swr-cache.test.tsx

@@ -0,0 +1,98 @@
+import React, { useReducer, useState } from 'react';
+import { describe, expect, it } from 'vitest';
+import { render, screen } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import useSWR from 'swr';
+import { openmrsComponentDecorator } from './openmrsComponentDecorator';
+
+// Regression test for the shared-SWR-cache lifecycle crash: every decorated
+// component has its own `<SWRConfig>`, and SWR deletes a provider cache's state
+// when the first boundary to init it unmounts. Before the fix, that crashed any
+// still-mounted decorated component ("undefined is not iterable").
+
+function decorate(featureName: string, Inner: React.ComponentType) {
+  return openmrsComponentDecorator({
+    moduleName: featureName.toLowerCase(),
+    featureName,
+    strictMode: false,
+    throwErrorsToConsole: false,
+    disableTranslations: true,
+  })(Inner);
+}
+
+function Widget({ id }: { id: string }) {
+  // Touch SWR so this component reads the shared SWRGlobalState on every render.
+  useSWR(`widget-${id}`, () => Promise.resolve(id));
+  const [count, bump] = useReducer((n) => n + 1, 0);
+  return (
+    <button type="button" onClick={bump}>
+      {id}-{count}
+    </button>
+  );
+}
+
+describe('openmrsComponentDecorator shared SWR cache lifecycle', () => {
+  it('keeps a still-mounted decorated component working after a sibling decorated component unmounts', async () => {
+    const user = userEvent.setup();
+
+    // `A` renders first, so it is the first `<SWRConfig>` to initialize the
+    // shared cache (the boundary that owned SWR's deleter before the fix).
+    const A = decorate('A', () => <Widget id="A" />);
+    const B = decorate('B', () => <Widget id="B" />);
+
+    function Harness() {
+      const [showA, setShowA] = useState(true);
+      return (
+        <div>
+          {showA && <A />}
+          <B />
+          <button type="button" onClick={() => setShowA(false)}>
+            hide-a
+          </button>
+        </div>
+      );
+    }
+
+    render(<Harness />);
+
+    expect(await screen.findByRole('button', { name: 'A-0' })).toBeInTheDocument();
+    expect(await screen.findByRole('button', { name: 'B-0' })).toBeInTheDocument();
+
+    // Unmount the cache-owning component.
+    await user.click(screen.getByRole('button', { name: 'hide-a' }));
+    expect(screen.queryByRole('button', { name: 'A-0' })).not.toBeInTheDocument();
+
+    // Force the still-mounted component to re-render. Before the fix this threw
+    // and the decorator's error boundary replaced B with an error message.
+    await user.click(screen.getByRole('button', { name: 'B-0' }));
+
+    expect(await screen.findByRole('button', { name: 'B-1' })).toBeInTheDocument();
+    expect(screen.queryByText(/an error has occurred/i)).not.toBeInTheDocument();
+  });
+
+  it('shares cached data across separately decorated components (single global cache, #1397)', async () => {
+    // Fixed key, unique within this file (the shared cache persists across renders).
+    const key = 'swr-cache-sharing-test';
+
+    function Producer() {
+      const { data } = useSWR(key, () => Promise.resolve('shared-value'));
+      return <span>producer:{data ?? 'loading'}</span>;
+    }
+
+    // The consumer's own fetcher never resolves; if it renders the value, it can
+    // only have come from a cache shared with the producer.
+    function Consumer() {
+      const { data } = useSWR(key, () => new Promise<string>(() => {}));
+      return <span>consumer:{data ?? 'loading'}</span>;
+    }
+
+    const DecoratedProducer = decorate('Producer', Producer);
+    const DecoratedConsumer = decorate('Consumer', Consumer);
+
+    render(<DecoratedProducer />);
+    expect(await screen.findByText('producer:shared-value')).toBeInTheDocument();
+
+    render(<DecoratedConsumer />);
+    expect(await screen.findByText('consumer:shared-value')).toBeInTheDocument();
+  });
+});

package/src/openmrsComponentDecorator.tsx

@@ -1,6 +1,7 @@
 import React, { type ComponentType, type ErrorInfo, Suspense } from 'react';
 import { I18nextProvider } from 'react-i18next';
 import { type Cache, SWRConfig, type SWRConfiguration } from 'swr';
+import { initCache } from 'swr/_internal';
 import type {} from '@openmrs/esm-globals';
 import { openmrsFetch, OpenmrsFetchError } from '@openmrs/esm-api';
 import { type ComponentConfig, type ExtensionData } from '@openmrs/esm-extensions';
@@ -12,7 +13,14 @@ const defaultOpts = {
   disableTranslations: false,
 };
 
+// One global SWR cache shared by every decorated component, the same regardless
+// of module-federation load order (see #1397). It is pre-initialized here so its
+// SWRGlobalState is owned by this (singleton) module, not by the first
+// `<SWRConfig>` that mounts. Otherwise that boundary's unmount would run
+// `SWRGlobalState.delete(swrCache)` and the other still-mounted decorated
+// components would crash on their next render ("undefined is not iterable").
 const swrCache: Cache = new Map();
+initCache(swrCache);
 
 // Read more about the available config options here: https://swr.vercel.app/docs/api#configuration
 const defaultSwrConfig: SWRConfiguration = {
@@ -54,7 +62,8 @@ export interface ComponentDecoratorOptions {
   featureName: string;
   disableTranslations?: boolean;
   strictMode?: boolean;
-  swrConfig?: Partial<Omit<SWRConfiguration, 'fetcher'>>;
+  // `provider` omitted deliberately (see defaultSwrConfig); `fetcher` is fixed.
+  swrConfig?: Partial<Omit<SWRConfiguration, 'fetcher' | 'provider'>>;
 }
 
 export interface OpenmrsReactComponentProps {