@ogcio/building-blocks-sdk 0.0.10 → 0.0.11

package/src/client/clients/featureFlags/utils.test.ts

@@ -0,0 +1,51 @@
+import t from "tap";
+import { FEATURE_FLAGS } from "../../../types/index.js";
+import type FeatureFlags from "./index.js";
+import { waitForConnection } from "./utils.js";
+
+t.test("waitForConnection", async (t) => {
+  t.test("should resolve when featureFlags is connected", async (t) => {
+    const mockFeatureFlags = {
+      isConnected: false,
+    } as FeatureFlags;
+
+    // Simulate connection after 50ms
+    setTimeout(() => {
+      mockFeatureFlags.isConnected = true;
+    }, 50);
+
+    const consoles = t.capture(console, "log");
+
+    const startTime = Date.now();
+    await waitForConnection(mockFeatureFlags, 10);
+    const elapsedTime = Date.now() - startTime;
+
+    t.ok(elapsedTime >= 50);
+    t.match(consoles(), [
+      { args: [`[${FEATURE_FLAGS}] Connecting...`] },
+      { args: [/Connected in \d+ms/] },
+    ]);
+
+    t.end();
+  });
+
+  t.test("should throw an error if connection times out", async (t) => {
+    const mockFeatureFlags = {
+      isConnected: false,
+    } as FeatureFlags;
+
+    const consoleLogSpy = t.capture(console, "log");
+
+    const startTime = Date.now();
+    await t.rejects(
+      waitForConnection(mockFeatureFlags, 10, 30),
+      `[${FEATURE_FLAGS}] Connection timed out after 30ms`,
+    );
+    const elapsedTime = Date.now() - startTime;
+
+    t.ok(elapsedTime >= 30);
+    t.match(consoleLogSpy(), [{ args: [`[${FEATURE_FLAGS}] Connecting...`] }]);
+
+    t.end();
+  });
+});

package/src/client/clients/featureFlags/utils.ts

@@ -0,0 +1,42 @@
+import { FEATURE_FLAGS } from "../../../types/index.js";
+import type FeatureFlags from "./index.js";
+
+const waitForConnection = (
+  featureFlags: FeatureFlags,
+  everyMs = 10,
+  timeoutMs = 5000, // Default timeout of 5 seconds
+): Promise<void> => {
+  const fn = (
+    interval: NodeJS.Timeout,
+    timeout: NodeJS.Timeout,
+    resolve: () => void,
+    startTime: number,
+  ) => {
+    if (featureFlags.isConnected) {
+      const elapsedTime = Date.now() - startTime;
+      console.log(`[${FEATURE_FLAGS}] Connected in ${elapsedTime}ms`);
+      clearInterval(interval);
+      clearTimeout(timeout);
+      resolve();
+    }
+  };
+
+  return new Promise((resolve, reject) => {
+    const startTime = Date.now();
+    console.log(`[${FEATURE_FLAGS}] Connecting...`);
+    const interval = setInterval(() => {
+      fn(interval, timeout, resolve, startTime);
+    }, everyMs);
+
+    const timeout = setTimeout(() => {
+      clearInterval(interval);
+      const message = `[${FEATURE_FLAGS}] Connection timed out after ${timeoutMs}ms`;
+      console.error(message);
+      reject(new Error(message));
+    }, timeoutMs);
+
+    fn(interval, timeout, resolve, startTime);
+  });
+};
+
+export { waitForConnection };

package/src/clients-configurations/clients-configuration.json

@@ -80,6 +80,14 @@
         "profile:entitlement:*"
       ],
       "updateDefinitions": true
+    },
+    {
+      "name": "featureFlags",
+      "openApiDefinitionUrl": "https://app.unleash-hosted.com/demo/docs/openapi.json",
+      "openApiDefinitionFormat": "json",
+      "citizenPermissions": [],
+      "publicServantPermissions": [],
+      "updateDefinitions": true
     }
   ]
 }

package/src/index.ts

@@ -1,4 +1,5 @@
 import { Analytics } from "@ogcio/analytics-sdk";
+import FeatureFlags from "./client/clients/featureFlags/index.js";
 
 import Messaging from "./client/clients/messaging/index.js";
 import Payments from "./client/clients/payments/index.js";
@@ -43,6 +44,10 @@ const getBuildingBlockSDK = (
       ...services.upload,
       getTokenFn,
     }),
+    featureFlags: new FeatureFlags({
+      ...services.featureFlags,
+      getTokenFn,
+    }),
   };
 };
 

package/src/types/index.ts

@@ -1,4 +1,5 @@
 import type { Analytics } from "@ogcio/analytics-sdk";
+import type FeatureFlags from "../client/clients/featureFlags/index.js";
 import type Messaging from "../client/clients/messaging/index.js";
 import type Payments from "../client/clients/payments/index.js";
 import type Profile from "../client/clients/profile/index.js";
@@ -11,6 +12,7 @@ export const PAYMENTS = "payments" as const;
 export const PROFILE = "profile" as const;
 export const SCHEDULER = "scheduler" as const;
 export const UPLOAD = "upload" as const;
+export const FEATURE_FLAGS = "featureFlags" as const;
 
 export type SERVICE_NAME =
   | typeof ANALYTICS
@@ -18,7 +20,8 @@ export type SERVICE_NAME =
   | typeof PAYMENTS
   | typeof PROFILE
   | typeof SCHEDULER
-  | typeof UPLOAD;
+  | typeof UPLOAD
+  | typeof FEATURE_FLAGS;
 
 export type TokenFunction = (
   serviceName: SERVICE_NAME,
@@ -50,6 +53,7 @@ type ServiceClients = {
   profile: typeof Profile;
   scheduler: typeof Scheduler;
   upload: typeof Upload;
+  featureFlags: typeof FeatureFlags;
 };
 
 export type BuildingBlocksSDK = {

package/tap.yml

@@ -0,0 +1,14 @@
+color: true
+coverage-report:
+  - text
+exclude:
+  - "**/@(fixture*(s)|dist)/**"
+include:
+  - "**/@(test?(s)|__test?(s)__)/**/*.test.@(js|cjs|mjs|tap|cts|jsx|mts|ts|tsx)"
+  - "**/*.@(test?(s)|spec).@(js|cjs|mjs|tap|cts|jsx|mts|ts|tsx)"
+  - "**/test?(s).@(js|cjs|mjs|tap|cts|jsx|mts|ts|tsx)"
+jobs: 1
+reporter: base
+snapshot-clean-cwd: true
+timeout: 30
+allow-incomplete-coverage: true

package/tsconfig.json

@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "types": ["node", "vitest/globals"],
     "target": "ESNext",
     "strict": true,
     "esModuleInterop": true,

package/vitest.config.cts

@@ -0,0 +1,9 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  plugins: [],
+  test: {
+    include: ["**/*.test.ts"],
+    globals: true,
+  },
+});