Merge pull request #1 from lucferbux/enable-shared-library

Author: lucferbux

README.md

@@ -1,2 +1,23 @@
 # kubeflow-ui-essentials
-A place for Kubeflow common UI code
+## Overview
+
+`kubeflow-ui-essentials` is a library designed to provide common UI components and utilities for the Kubeflow ecosystem. This library follows a modular architecture to ensure reusability and maintainability across various Kubeflow repositories. The library is versioned to facilitate consistent updates and integration.
+
+## Folder Structure
+
+The repository contains the following files:
+
+- **api**: Contains the API utilities for the Kubeflow UI components.
+- **components**: Contains the reusable UI components for the Kubeflow UI.
+- **hooks**: Contains the custom hooks for the Kubeflow UI components.
+- **utilities**: Contains the utility functions for the Kubeflow UI components.
+- **context**: Contains the context providers for the Kubeflow UI components.
+- **style**: Contains the global styles for the Kubeflow UI components.
+
+## Contributing
+
+We welcome contributions to the project. Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.
+
+## License
+
+This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.

api/__tests__/errorUtils.spec.ts

@@ -0,0 +1,36 @@
+import { NotReadyError } from '~/shared/utilities/useFetchState';
+import { APIError } from '~/shared/api/types';
+import { handleRestFailures } from '~/shared/api/errorUtils';
+import { mockRegisteredModel } from '~/__mocks__/mockRegisteredModel';
+import { mockBFFResponse } from '~/__mocks__/utils';
+
+describe('handleRestFailures', () => {
+  it('should successfully return registered models', async () => {
+    const modelRegistryMock = mockRegisteredModel({});
+    const result = await handleRestFailures(Promise.resolve(mockBFFResponse(modelRegistryMock)));
+    expect(result.data).toStrictEqual(modelRegistryMock);
+  });
+
+  it('should handle and throw model registry errors', async () => {
+    const statusMock: APIError = {
+      error: {
+        code: '',
+        message: 'error',
+      },
+    };
+
+    await expect(handleRestFailures(Promise.resolve(statusMock))).rejects.toThrow('error');
+  });
+
+  it('should handle common state errors ', async () => {
+    await expect(handleRestFailures(Promise.reject(new NotReadyError('error')))).rejects.toThrow(
+      'error',
+    );
+  });
+
+  it('should handle other errors', async () => {
+    await expect(handleRestFailures(Promise.reject(new Error('error')))).rejects.toThrow(
+      'Error communicating with server',
+    );
+  });
+});