@orchestrator-ui/orchestrator-ui-components 1.22.0 → 1.24.0

package/src/rtk/endpoints/streamMessages.ts

@@ -11,7 +11,10 @@ import { CacheTags, orchestratorApi } from '../api';
 
 const getWebSocket = async (url: string) => {
     const session = (await getSession()) as WfoSession;
-    const token = session?.accessToken ? [session?.accessToken] : [];
+
+    const token = session?.accessToken
+        ? ['base64.bearer.token', session?.accessToken]
+        : '';
     // Implemented authentication taking this into account: https://stackoverflow.com/questions/4361173/http-headers-in-websockets-client-api/77060459#77060459
     return new WebSocket(url, token);
 };
@@ -55,7 +58,7 @@ const streamMessagesApi = orchestratorApi.injectEndpoints({
                 const cleanUp = () => {
                     const message = getToastMessage(
                         ToastTypes.ERROR,
-                        'Connection to the server was lost. Please refresh the page to reconnect.',
+                        'Connection to the server was lost. Please click the websocket icon or refresh the page to reconnect.',
                         'WebSocket closed',
                     );
                     dispatch(addToastMessage(message));
@@ -139,7 +142,6 @@ const streamMessagesApi = orchestratorApi.injectEndpoints({
 
                 webSocket.onerror = (event) => {
                     console.error('WebSocket error', event);
-                    cleanUp();
                 };
 
                 webSocket.onclose = () => {

package/src/rtk/storeProvider.tsx

@@ -2,6 +2,7 @@ import React, { useState } from 'react';
 import type { ReactNode } from 'react';
 import { Provider } from 'react-redux';
 
+import { emptyOrchestratorConfig } from '@/contexts';
 import { CustomApiConfig } from '@/rtk/slices/customApis';
 import { OrchestratorComponentOverride } from '@/rtk/slices/orchestratorComponentOverride';
 import type { OrchestratorConfig } from '@/types';
@@ -9,7 +10,7 @@ import type { OrchestratorConfig } from '@/types';
 import { getOrchestratorStore } from './store';
 
 export type StoreProviderProps = {
-    initialOrchestratorConfig: OrchestratorConfig;
+    initialOrchestratorConfig: OrchestratorConfig | null;
     orchestratorComponentOverride?: OrchestratorComponentOverride;
     customApis?: CustomApiConfig[];
     children: ReactNode;
@@ -22,7 +23,8 @@ export const StoreProvider = ({
     children,
 }: StoreProviderProps) => {
     const store = getOrchestratorStore({
-        orchestratorConfig: initialOrchestratorConfig,
+        orchestratorConfig:
+            initialOrchestratorConfig ?? emptyOrchestratorConfig,
         orchestratorComponentOverride,
         customApis,
     });

package/src/types/forms.ts

@@ -24,7 +24,7 @@ export interface Form {
 export type InputForm = JSONSchema6;
 export interface FormNotCompleteResponse {
     form: InputForm;
-    hasNext?: boolean;
+    meta?: { hasNext?: boolean };
 }
 
 export type FieldProps<

package/src/types/types.ts

@@ -24,6 +24,14 @@ export type Customer = {
     shortcode: string;
 };
 
+export type CustomerWithSubscriptionCount = Customer & {
+    subscriptions: {
+        pageInfo: {
+            totalItems: number;
+        };
+    };
+};
+
 export type InUseByRelation = {
     subscription_instance_id: string;
     subscription_id: string;
@@ -337,6 +345,10 @@ export interface CustomersResult {
     customers: GraphQlSinglePage<Customer>;
 }
 
+export interface CustomersWithSubscriptionCountResult {
+    customers: GraphQlSinglePage<CustomerWithSubscriptionCount>;
+}
+
 export interface TaskDefinitionsResult<T = TaskDefinition> {
     workflows: GraphQlResultPage<T>;
 }

package/src/utils/getEnvironmentVariables.spec.ts

@@ -0,0 +1,51 @@
+import process from 'process';
+
+import { getEnvironmentVariables } from './getEnvironmentVariables';
+
+const originalEnv = process.env;
+
+describe('getEnvironmentVariables()', () => {
+    const warnMock = jest.spyOn(console, 'warn');
+
+    jest.mock('process');
+
+    beforeEach(() => {
+        process.env = {
+            ...originalEnv,
+        };
+        jest.resetAllMocks();
+    });
+
+    afterEach(() => {
+        process.env = originalEnv;
+    });
+
+    it('returns an object with the environment variables and its values', () => {
+        process.env.test01 = 'value01';
+        process.env.test02 = 'value02';
+
+        const result = getEnvironmentVariables(['test01', 'test02']);
+
+        expect(warnMock).not.toHaveBeenCalled();
+        expect(result).toEqual({
+            test01: 'value01',
+            test02: 'value02',
+        });
+    });
+
+    it('returns an empty string as value in the result when the environment variable is not set', () => {
+        process.env.test01 = 'value01';
+        process.env.test03 = 'value03';
+
+        const result = getEnvironmentVariables(['test01', 'test02', 'test03']);
+
+        expect(warnMock).toHaveBeenCalledWith(
+            'Warning: Missing required environment variables: test02',
+        );
+        expect(result).toEqual({
+            test01: 'value01',
+            test02: '',
+            test03: 'value03',
+        });
+    });
+});

package/src/utils/getEnvironmentVariables.ts

@@ -0,0 +1,33 @@
+import process from 'process';
+
+// By convention, only this function should be used to access the process.env object.
+// It logs a warning if one or more variables are not set
+export function getEnvironmentVariables<T>(
+    envVars: (keyof T)[],
+): Record<keyof T, string> {
+    const missingEnvironmentVariables: string[] = [];
+
+    const environmentVariablesWithValues = envVars.reduce(
+        (acc, currentKey) => {
+            const value = process.env[currentKey.toString()];
+
+            if (value === undefined) {
+                missingEnvironmentVariables.push(currentKey.toString());
+            }
+
+            return {
+                ...acc,
+                [currentKey]: value || '',
+            };
+        },
+        {} as Record<keyof T, string>,
+    );
+
+    if (missingEnvironmentVariables.length > 0) {
+        console.warn(
+            `Warning: Missing required environment variables: ${missingEnvironmentVariables.join(', ')}`,
+        );
+    }
+
+    return environmentVariablesWithValues;
+}

package/src/utils/index.ts

@@ -1,6 +1,7 @@
 export * from './csvDownload';
 export * from './date';
 export * from './environmentVariables';
+export * from './getEnvironmentVariables';
 export * from './getProductNamesFromProcess';
 export * from './getQueryVariablesForExport';
 export * from './getStatusBadgeColor';

package/src/components/WfoRouteChangeListener/WfoRouteChangeListener.tsx

@@ -1,22 +0,0 @@
-import React, { useEffect } from 'react';
-
-import { getSession, signIn } from 'next-auth/react';
-import { useRouter } from 'next/router';
-
-import { useGetOrchestratorConfig } from '@/hooks';
-
-export const WfoRouteChangeListener = () => {
-    const router = useRouter();
-    const { authActive } = useGetOrchestratorConfig();
-
-    useEffect(() => {
-        if (authActive) {
-            getSession().then((session) => {
-                if (!session) {
-                    signIn();
-                }
-            });
-        }
-    }, [authActive, router]);
-    return <></>;
-};

package/src/components/WfoRouteChangeListener/index.tsx

@@ -1 +0,0 @@
-export * from './WfoRouteChangeListener';