chore: replace metabase client w singleton instance

theopensystemslab · Dec 19, 2024 · 8f12f20 · 8f12f20
1 parent 15ad49c
commit 8f12f20
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 20 deletions.
diff --git a/api.planx.uk/modules/analytics/metabase/collection/getCollection.ts b/api.planx.uk/modules/analytics/metabase/collection/getCollection.ts
@@ -1,7 +1,7 @@
 import { createMetabaseClient } from "../shared/client.js";
 import type { GetCollectionResponse } from "./types.js";
+import { $metabase } from "../shared/client.js";
 
-const client = createMetabaseClient();
 /**
  * Retrieves info on a collection from Metabase, use to check a parent. Currently only used in tests but could be useful for other Metabase functionality
  * @param id
@@ -10,6 +10,6 @@ const client = createMetabaseClient();
 export async function getCollection(
   id: number,
 ): Promise<GetCollectionResponse> {
-  const response = await client.get(`/api/collection/${id}`);
+  const response = await $metabase.get(`/api/collection/${id}`);
   return response.data;
 }
diff --git a/api.planx.uk/modules/analytics/metabase/shared/client.test.ts b/api.planx.uk/modules/analytics/metabase/shared/client.test.ts
@@ -4,6 +4,7 @@ import {
   MetabaseError,
 } from "./client.js";
 import nock from "nock";
+import { $metabase } from "./client.js";
 
 describe("Metabase client", () => {
   beforeEach(() => {
@@ -16,13 +17,12 @@ describe("Metabase client", () => {
   });
 
   test("returns configured client", async () => {
-    const client = createMetabaseClient();
-    expect(client.defaults.baseURL).toBe(process.env.METABASE_URL_EXT);
-    expect(client.defaults.headers["X-API-Key"]).toBe(
+    expect($metabase.defaults.baseURL).toBe(process.env.METABASE_URL_EXT);
+    expect($metabase.defaults.headers["X-API-Key"]).toBe(
       process.env.METABASE_API_KEY,
     );
-    expect(client.defaults.headers["Content-Type"]).toBe("application/json");
-    expect(client.defaults.timeout).toBe(30_000);
+    expect($metabase.defaults.headers["Content-Type"]).toBe("application/json");
+    expect($metabase.defaults.timeout).toBe(30_000);
   });
 
   describe("validates configuration", () => {
@@ -61,8 +61,7 @@ describe("Metabase client", () => {
         .get("/test")
         .reply(200, { data: "success" });
 
-      const client = createMetabaseClient();
-      const response = await client.get("/test");
+      const response = await $metabase.get("/test");
 
       expect(response.data).toEqual({ data: "success" });
       expect(metabaseScope.isDone()).toBe(true);
@@ -76,10 +75,10 @@ describe("Metabase client", () => {
         .times(4)
         .reply(500, { message: "Internal Server Error" });
 
-      const client = createMetabaseClient();
+      const $metabase = createMetabaseClient();
 
       try {
-        await client.get("/test");
+        await $metabase.get("/test");
         expect.fail("Should have thrown an error");
       } catch (error) {
         expect(error).toBeInstanceOf(MetabaseError);
@@ -93,8 +92,8 @@ describe("Metabase client", () => {
 
       metabaseScope.get("/test").once().reply(200, { data: "success" });
 
-      const client = createMetabaseClient();
-      const response = await client.get("/test");
+      const $metabase = createMetabaseClient();
+      const response = await $metabase.get("/test");
 
       expect(response.data).toEqual({ data: "success" });
 

diff --git a/api.planx.uk/modules/analytics/metabase/shared/client.ts b/api.planx.uk/modules/analytics/metabase/shared/client.ts
@@ -121,10 +121,4 @@ export const createMetabaseClient = (): AxiosInstance => {
   return client;
 };
 
-// // Export both client and instance with delayed instantiation for test purposes
-// export let metabaseClient: AxiosInstance;
-
-// export const initializeMetabaseClient = () => {
-//   metabaseClient = createMetabaseClient();
-//   return metabaseClient;
-// };
+export const $metabase = createMetabaseClient();