@openmrs/esm-error-handling 10.0.1-pre.5542 → 10.0.1-pre.5561

package/.turbo/turbo-build.log

@@ -1 +1 @@
-Successfully compiled: 1 file with swc (159.52ms)
+Successfully compiled: 1 file with swc (165.69ms)

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAsBA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,OAAO,QAKvC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,kBAAkB,KAExB,aAAa,OAAO,UAK7B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AA8CA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,OAAO,QAKvC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,kBAAkB,KAExB,aAAa,OAAO,UAK7B"}

package/dist/index.js

@@ -1,8 +1,11 @@
 /** @module @category Error Handling */ import { dispatchToastShown } from "@openmrs/esm-globals";
-window.onerror = function(error) {
-    console.error('Unexpected error: ', error);
+// Uses the standard `window.onerror` signature: the first argument is the error
+// message (a string) or an Event, and the fifth is the actual Error object (when
+// the browser provides it). We prefer the Error so the toast shows its message.
+window.onerror = function(message, _source, _lineno, _colno, error) {
+    console.error('Unexpected error: ', error ?? message);
     dispatchToastShown({
-        description: error ?? 'Oops! An unexpected error occurred.',
+        description: getErrorMessage(error ?? message, 'Oops! An unexpected error occurred.'),
         kind: 'error',
         title: 'Error'
     });
@@ -11,11 +14,28 @@ window.onerror = function(error) {
 window.onunhandledrejection = function(event) {
     console.error('Unhandled rejection: ', event.reason);
     dispatchToastShown({
-        description: event.reason ?? 'Oops! An unhandled promise rejection occurred.',
+        // `event.reason` is whatever the promise rejected with, frequently an Error
+        // object. `showToast` expects `description` to be a renderable, non-empty
+        // value, so resolve it to a string message rather than passing the raw
+        // rejection (which renders as "[object Object]" and fails the non-empty check).
+        description: getErrorMessage(event.reason, 'Oops! An unhandled promise rejection occurred.'),
         kind: 'error',
         title: 'Error'
     });
 };
+/**
+ * Resolves an arbitrary thrown/rejected value to a user-facing, non-empty
+ * message string suitable for use as a toast description, falling back to the
+ * provided message when no usable message can be derived.
+ */ function getErrorMessage(reason, fallback) {
+    if (reason instanceof Error) {
+        return reason.message || fallback;
+    }
+    if (typeof reason === 'string' && reason.trim().length > 0) {
+        return reason;
+    }
+    return fallback;
+}
 /**
  * Reports an error to the global error handler. The error will be displayed
  * to the user as a toast notification. This function ensures the error is

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-error-handling",
-  "version": "10.0.1-pre.5542",
+  "version": "10.0.1-pre.5561",
   "license": "MPL-2.0",
   "description": "An ES module to help with error handling",
   "type": "module",
@@ -46,10 +46,10 @@
     "access": "public"
   },
   "peerDependencies": {
-    "@openmrs/esm-globals": "^10.0.1-pre.5542"
+    "@openmrs/esm-globals": "^10.0.1-pre.5561"
   },
   "devDependencies": {
-    "@openmrs/esm-globals": "10.0.1-pre.5542",
+    "@openmrs/esm-globals": "10.0.1-pre.5561",
     "@swc/cli": "0.8.1",
     "@swc/core": "1.15.21",
     "@vitest/coverage-v8": "^4.1.2",

package/src/index.ts

@@ -1,10 +1,13 @@
 /** @module @category Error Handling */
 import { dispatchToastShown } from '@openmrs/esm-globals';
 
-window.onerror = function (error) {
-  console.error('Unexpected error: ', error);
+// Uses the standard `window.onerror` signature: the first argument is the error
+// message (a string) or an Event, and the fifth is the actual Error object (when
+// the browser provides it). We prefer the Error so the toast shows its message.
+window.onerror = function (message, _source, _lineno, _colno, error) {
+  console.error('Unexpected error: ', error ?? message);
   dispatchToastShown({
-    description: error ?? 'Oops! An unexpected error occurred.',
+    description: getErrorMessage(error ?? message, 'Oops! An unexpected error occurred.'),
     kind: 'error',
     title: 'Error',
   });
@@ -14,12 +17,33 @@ window.onerror = function (error) {
 window.onunhandledrejection = function (event: PromiseRejectionEvent) {
   console.error('Unhandled rejection: ', event.reason);
   dispatchToastShown({
-    description: event.reason ?? 'Oops! An unhandled promise rejection occurred.',
+    // `event.reason` is whatever the promise rejected with, frequently an Error
+    // object. `showToast` expects `description` to be a renderable, non-empty
+    // value, so resolve it to a string message rather than passing the raw
+    // rejection (which renders as "[object Object]" and fails the non-empty check).
+    description: getErrorMessage(event.reason, 'Oops! An unhandled promise rejection occurred.'),
     kind: 'error',
     title: 'Error',
   });
 };
 
+/**
+ * Resolves an arbitrary thrown/rejected value to a user-facing, non-empty
+ * message string suitable for use as a toast description, falling back to the
+ * provided message when no usable message can be derived.
+ */
+function getErrorMessage(reason: unknown, fallback: string): string {
+  if (reason instanceof Error) {
+    return reason.message || fallback;
+  }
+
+  if (typeof reason === 'string' && reason.trim().length > 0) {
+    return reason;
+  }
+
+  return fallback;
+}
+
 /**
  * Reports an error to the global error handler. The error will be displayed
  * to the user as a toast notification. This function ensures the error is

package/src/openmrs-esm-error-handling.test.ts

@@ -1,8 +1,15 @@
-import { describe, it, expect, vi } from 'vitest';
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { dispatchToastShown } from '@openmrs/esm-globals';
 import { reportError } from './index';
 
+vi.mock('@openmrs/esm-globals', () => ({
+  dispatchToastShown: vi.fn(),
+}));
+
 vi.useFakeTimers();
 
+const mockDispatchToastShown = vi.mocked(dispatchToastShown);
+
 describe('error handler', () => {
   it('transforms non-Error inputs into valid Error objects', () => {
     expect(() => {
@@ -26,3 +33,41 @@ describe('error handler', () => {
     }).toThrow("'undefined' was thrown as an error");
   });
 });
+
+describe('window.onunhandledrejection', () => {
+  beforeEach(() => {
+    mockDispatchToastShown.mockClear();
+    vi.spyOn(console, 'error').mockImplementation(() => {});
+  });
+
+  // The handler only reads `event.reason`, so a minimal stand-in avoids
+  // constructing a real (and itself-unhandled) PromiseRejectionEvent.
+  const fireRejection = (reason: unknown) => window.onunhandledrejection?.({ reason } as PromiseRejectionEvent);
+
+  it('shows a toast with the Error message as a string description', () => {
+    fireRejection(new Error('Something broke'));
+
+    expect(mockDispatchToastShown).toHaveBeenCalledWith(
+      expect.objectContaining({ description: 'Something broke', kind: 'error', title: 'Error' }),
+    );
+    expect(typeof mockDispatchToastShown.mock.calls[0][0].description).toBe('string');
+  });
+
+  it('shows a string reason directly', () => {
+    fireRejection('plain string reason');
+
+    expect(mockDispatchToastShown).toHaveBeenCalledWith(
+      expect.objectContaining({ description: 'plain string reason' }),
+    );
+  });
+
+  it('falls back to a friendly message for empty/non-string reasons', () => {
+    for (const reason of [undefined, null, new Error(''), { some: 'object' }]) {
+      mockDispatchToastShown.mockClear();
+      fireRejection(reason);
+      expect(mockDispatchToastShown.mock.calls[0][0].description).toBe(
+        'Oops! An unhandled promise rejection occurred.',
+      );
+    }
+  });
+});