@opencloning/utils 1.8.1 → 1.9.1

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @opencloning/utils
 
+## 1.9.1
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @opencloning/store@1.9.1
+
+## 1.9.0
+
+### Minor Changes
+
+- [#711](https://github.com/OpenCloning/OpenCloning_frontend/pull/711) [`6813620`](https://github.com/OpenCloning/OpenCloning_frontend/commit/6813620f4a47c44857045866d667474efbf9a64c) Thanks [@manulera](https://github.com/manulera)! - Use authentication for cloning endpoints in opencloning-db
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @opencloning/store@1.9.0
+
+## 1.8.2
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @opencloning/store@1.8.2
+
 ## 1.8.1
 
 ### Patch Changes

package/package.json

@@ -1,7 +1,7 @@
 {
   "license": "MIT",
   "name": "@opencloning/utils",
-  "version": "1.8.1",
+  "version": "1.9.1",
   "type": "module",
   "main": "./src/utils/index.js",
   "exports": {
@@ -9,6 +9,7 @@
     "./readNwrite": "./src/utils/readNwrite.js",
     "./network": "./src/utils/network.js",
     "./getHttpClient": "./src/utils/getHttpClient.js",
+    "./httpClientAuth": "./src/utils/httpClientAuth.js",
     "./sourceFunctions": "./src/utils/sourceFunctions.js",
     "./error2String": "./src/utils/error2String.js",
     "./enzyme_utils": "./src/utils/enzyme_utils.js",
@@ -30,7 +31,7 @@
     "directory": "packages/utils"
   },
   "dependencies": {
-    "@opencloning/store": "1.8.1",
+    "@opencloning/store": "1.9.1",
     "@teselagen/bio-parsers": "^0.4.38",
     "@teselagen/sequence-utils": "^0.3.42",
     "@zip.js/zip.js": "^2.8.26",

package/src/utils/getHttpClient.js

@@ -1,4 +1,5 @@
 import axios from 'axios';
+import { attachAuthInterceptors } from './httpClientAuth';
 import urlWhitelist from '../config/urlWhitelist';
 
 export default function getHttpClient(extraUrls = []) {
@@ -22,3 +23,9 @@ export default function getHttpClient(extraUrls = []) {
 
   return client;
 }
+
+export function getAuthenticatedHttpClient(extraUrls = []) {
+  const client = getHttpClient(extraUrls);
+  attachAuthInterceptors(client);
+  return client;
+}

package/src/utils/getHttpClient.test.js

@@ -0,0 +1,19 @@
+import { describe, expect, it } from 'vitest';
+
+import getHttpClient, { getAuthenticatedHttpClient } from './getHttpClient';
+
+describe('getHttpClient', () => {
+  it('creates a generic client without auth interceptors', () => {
+    const client = getHttpClient();
+
+    expect(client.interceptors.request.handlers.filter(Boolean)).toHaveLength(1);
+    expect(client.interceptors.response.handlers.filter(Boolean)).toHaveLength(0);
+  });
+
+  it('creates an authenticated client with auth interceptors', () => {
+    const client = getAuthenticatedHttpClient();
+
+    expect(client.interceptors.request.handlers.filter(Boolean)).toHaveLength(2);
+    expect(client.interceptors.response.handlers.filter(Boolean)).toHaveLength(1);
+  });
+});

package/src/utils/httpClientAuth.js

@@ -0,0 +1,36 @@
+const AUTH_INTERCEPTORS_ATTACHED = '__opencloningHttpClientAuthAttached';
+
+let unauthorizedHandler = null;
+
+export function setHttpClientUnauthorizedHandler(fn) {
+  unauthorizedHandler = fn;
+}
+
+export function attachAuthInterceptors(client, { tokenStorageKey = 'token' } = {}) {
+  if (client[AUTH_INTERCEPTORS_ATTACHED]) {
+    return client;
+  }
+
+  client[AUTH_INTERCEPTORS_ATTACHED] = true;
+
+  client.interceptors.request.use((config) => {
+    const token = localStorage.getItem(tokenStorageKey);
+    if (token) {
+      config.headers = config.headers ?? {};
+      config.headers.Authorization = `Bearer ${token}`;
+    }
+    return config;
+  });
+
+  client.interceptors.response.use(
+    (response) => response,
+    (error) => {
+      if (error.response?.status === 401 && unauthorizedHandler) {
+        unauthorizedHandler();
+      }
+      return Promise.reject(error);
+    },
+  );
+
+  return client;
+}

package/src/utils/httpClientAuth.test.js

@@ -0,0 +1,52 @@
+import axios from 'axios';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+
+import { attachAuthInterceptors, setHttpClientUnauthorizedHandler } from './httpClientAuth';
+
+describe('httpClientAuth', () => {
+  beforeEach(() => {
+    localStorage.clear();
+    setHttpClientUnauthorizedHandler(null);
+  });
+
+  afterEach(() => {
+    localStorage.clear();
+    setHttpClientUnauthorizedHandler(null);
+  });
+
+  it('adds the bearer token to authenticated requests', () => {
+    const client = attachAuthInterceptors(axios.create());
+    const requestFulfilled = client.interceptors.request.handlers[0].fulfilled;
+    const config = { headers: {} };
+
+    localStorage.setItem('token', '__TEST_TOKEN__');
+
+    const result = requestFulfilled(config);
+
+    expect(result).toBe(config);
+    expect(config.headers.Authorization).toBe('Bearer __TEST_TOKEN__');
+  });
+
+  it('calls the shared unauthorized handler for 401 responses', async () => {
+    const client = attachAuthInterceptors(axios.create());
+    const responseRejected = client.interceptors.response.handlers[0].rejected;
+    const handler = vi.fn();
+    const error = { response: { status: 401 } };
+
+    setHttpClientUnauthorizedHandler(handler);
+
+    await expect(responseRejected(error)).rejects.toBe(error);
+
+    expect(handler).toHaveBeenCalledTimes(1);
+  });
+
+  it('does not attach duplicate interceptors to the same client', () => {
+    const client = axios.create();
+
+    attachAuthInterceptors(client);
+    attachAuthInterceptors(client);
+
+    expect(client.interceptors.request.handlers.filter(Boolean)).toHaveLength(1);
+    expect(client.interceptors.response.handlers.filter(Boolean)).toHaveLength(1);
+  });
+});

package/src/utils/index.js

@@ -4,6 +4,7 @@
 export * from './readNwrite.js';
 export * from './network.js';
 export * from './getHttpClient.js';
+export * from './httpClientAuth.js';
 export * from './sourceFunctions.js';
 export { default as error2String } from './error2String.js';
 export * from './enzyme_utils.js';