@equinor/fusion-framework-react-app 14.0.3-next.0 → 14.0.3

package/src/__tests__/testApp.test.tsx

@@ -1,76 +0,0 @@
-import { describe, expect } from 'vitest';
-
-import { enableContextMock } from '@equinor/fusion-framework-module-context/mock';
-import type { ContextItem } from '@equinor/fusion-framework-module-context';
-import { useCurrentContext } from '@equinor/fusion-framework-react-app/context';
-import { useFramework } from '@equinor/fusion-framework-react';
-import { createHistory, enableNavigation } from '@equinor/fusion-framework-module-navigation';
-import type { NavigationModule } from '@equinor/fusion-framework-module-navigation';
-
-import { testApp } from '@equinor/fusion-framework-vitest-plugin-react-app/test';
-
-const projectA: ContextItem = {
-  id: 'ctx-a',
-  title: 'Project A',
-  type: { id: 'ProjectMaster' },
-  value: {},
-};
-
-const Greeting = () => <p>hello</p>;
-
-const CurrentContext = () => {
-  const { currentContext } = useCurrentContext();
-  return <p>{currentContext?.title ?? 'none'}</p>;
-};
-
-describe('testApp', () => {
-  testApp(
-    'resolves a fusion/app scope and renders through the public /vitest entry point',
-    async ({ render, fusion, app }) => {
-      const screen = await render(<Greeting />);
-      await expect.element(screen.getByText('hello')).toBeVisible();
-      expect(fusion).toBeDefined();
-      expect(app).toBeDefined();
-    },
-  );
-
-  describe('with a seeded context module', () => {
-    const test = testApp.extend(
-      'configureApp',
-      { injected: true },
-      () => (configurator) =>
-        enableContextMock(configurator, (mock) => mock.setCurrentContext(projectA)),
-    );
-
-    test('starts on the seeded context', async ({ render }) => {
-      const screen = await render(<CurrentContext />);
-      await expect.element(screen.getByText(projectA.title as string)).toBeVisible();
-    });
-  });
-
-  describe('with a configured parent framework', () => {
-    const NavigationLocation = () => {
-      const { navigation } = useFramework<[NavigationModule]>().modules;
-      return <p>{navigation.history.location.pathname}</p>;
-    };
-
-    // pushed on the history instance itself, before it's handed to the framework configurator,
-    // so a passing assertion also proves `configureFusion` ran ahead of framework initialization
-    const history = createHistory('memory');
-    history.push('/configured-by-configure-fusion');
-
-    const test = testApp.extend(
-      'configureFusion',
-      { injected: true },
-      () => (configurator) =>
-        enableNavigation(configurator, { configure: (config) => config.setHistory(history) }),
-    );
-
-    test('resolves the fusion instance with the configured navigation history', async ({
-      render,
-    }) => {
-      const screen = await render(<NavigationLocation />);
-      await expect.element(screen.getByText('/configured-by-configure-fusion')).toBeVisible();
-    });
-  });
-});

package/src/__tests__/useAccessToken.test.tsx

@@ -1,51 +0,0 @@
-import { describe, expect, it, vi } from 'vitest';
-
-import { mockFramework } from '@equinor/fusion-framework/mock';
-
-import { useAccessToken } from '../msal/useAccessToken';
-import { renderAppHook } from '@equinor/fusion-framework-vitest-plugin-react-app/test';
-
-describe('useAccessToken', () => {
-  it('resolves an access token from the app scope’s real, mock-backed auth module', async () => {
-    // `renderAppHook` runs the real msal module against an in-process mock client,
-    // so `auth` behaves exactly as it would with a signed-in user in production.
-    const { result, unmount } = await renderAppHook(() =>
-      useAccessToken({ scopes: ['User.Read'] }),
-    );
-
-    // `renderAppHook` awaits the render, and the mock resolves near-instantly,
-    // so the pending state may have already settled by the time we can observe it
-    await vi.waitFor(() => expect(result.current.pending).toBe(false));
-
-    expect(result.current.error).toBeNull();
-    // a structurally valid JWT has three dot-separated segments
-    expect(result.current.token?.split('.')).toHaveLength(3);
-
-    // unmount before the next test's environment tears down, so no acquisition
-    // effect can flush a state update against an already-destroyed `window`
-    await unmount();
-  });
-
-  it('surfaces an acquisition error instead of throwing', async () => {
-    const fusion = await mockFramework();
-    // persistent, not `-Once`: the app module hoists via a version-compat proxy that
-    // may call through before the hook's own effect does, consuming a one-shot mock
-    vi.spyOn(fusion.modules.auth, 'acquireToken').mockRejectedValue(
-      new Error('acquisition failed'),
-    );
-
-    const { result, unmount } = await renderAppHook(
-      () => useAccessToken({ scopes: ['User.Read'] }),
-      {
-        fusion,
-      },
-    );
-
-    await vi.waitFor(() => expect(result.current.pending).toBe(false));
-
-    expect(result.current.token).toBeUndefined();
-    expect(result.current.error).toBeInstanceOf(Error);
-
-    await unmount();
-  });
-});

package/src/__tests__/useAppSetting.test.tsx

@@ -1,133 +0,0 @@
-import { act } from 'react';
-import { describe, expect, it, vi } from 'vitest';
-
-import { mockFramework } from '@equinor/fusion-framework/mock';
-import { enableAppManifestMock } from '@equinor/fusion-framework-app/mock';
-import type { AppModule } from '@equinor/fusion-framework-module-app';
-import { createRouterMiddleware } from '@equinor/fusion-framework-module-http/mock';
-
-import { useAppSetting } from '../settings/useAppSetting';
-import { renderAppHook } from '@equinor/fusion-framework-vitest-plugin-react-app/test';
-
-const env = {
-  manifest: {
-    appKey: 'test-app',
-    displayName: 'Test App',
-    description: 'A test application',
-    type: 'standalone' as const,
-  },
-};
-
-/**
- * Boots a parent framework whose `apps` client serves per-user settings from an
- * in-memory store, so `useAppSetting` exercises the real fetch/update round-trip
- * instead of a stubbed provider.
- *
- * @param initial - The settings the store starts seeded with.
- * @param putResponse - Overrides the response a PUT request resolves to, to simulate a failed update.
- */
-const mockSettingsFusion = async (
-  initial: Record<string, unknown> = {},
-  putResponse?: () => Response,
-) => {
-  const store: Record<string, unknown> = { ...initial };
-  const fusion = await mockFramework<[AppModule]>((configurator) => {
-    configurator.http.addMiddleware(
-      createRouterMiddleware('https://apps.fusion.test', (router) => {
-        router.get('/persons/me/apps/:appKey/settings', () => Response.json(store));
-        router.put('/persons/me/apps/:appKey/settings', async ({ request }) => {
-          // a caller-supplied response simulates a failed persistence request
-          if (putResponse) return putResponse();
-          // the PUT body replaces the seeded keys it targets, leaving the rest of the store untouched
-          Object.assign(store, await request.json());
-          return Response.json(store);
-        });
-      }),
-    );
-    enableAppManifestMock(configurator, env);
-  });
-  fusion.modules.app.setCurrentApp(env.manifest.appKey);
-  return fusion;
-};
-
-describe('useAppSetting', () => {
-  it('resolves the persisted value for a single setting key', async () => {
-    const fusion = await mockSettingsFusion({ theme: 'dark' });
-
-    const { result } = await renderAppHook(
-      () => useAppSetting<{ theme: string }, 'theme'>('theme'),
-      { env, fusion },
-    );
-
-    await vi.waitFor(() => expect(result.current[0]).toBe('dark'));
-  });
-
-  it('falls back to the default value until the persisted settings resolve', async () => {
-    const fusion = await mockSettingsFusion({ theme: 'dark' });
-
-    const { result } = await renderAppHook(
-      () => useAppSetting<{ theme: string }, 'theme'>('theme', 'light'),
-      { env, fusion },
-    );
-
-    expect(result.current[0]).toBe('light');
-    await vi.waitFor(() => expect(result.current[0]).toBe('dark'));
-  });
-
-  it('persists an updated value and notifies onUpdated', async () => {
-    const fusion = await mockSettingsFusion({ theme: 'dark' });
-    const onUpdated = vi.fn();
-
-    const { result } = await renderAppHook(
-      () => useAppSetting<{ theme: string }, 'theme'>('theme', undefined, { onUpdated }),
-      { env, fusion },
-    );
-
-    await vi.waitFor(() => expect(result.current[0]).toBe('dark'));
-
-    act(() => {
-      result.current[1]('light');
-    });
-
-    await vi.waitFor(() => expect(result.current[0]).toBe('light'));
-    await vi.waitFor(() => expect(onUpdated).toHaveBeenCalled());
-  });
-
-  it('resolves the next value from the previous one when given an updater function', async () => {
-    const fusion = await mockSettingsFusion({ count: 1 });
-
-    const { result } = await renderAppHook(
-      () => useAppSetting<{ count: number }, 'count'>('count'),
-      { env, fusion },
-    );
-
-    await vi.waitFor(() => expect(result.current[0]).toBe(1));
-
-    act(() => {
-      result.current[1]((current) => (current ?? 0) + 1);
-    });
-
-    await vi.waitFor(() => expect(result.current[0]).toBe(2));
-  });
-
-  it('surfaces a persistence failure through onError instead of throwing', async () => {
-    const fusion = await mockSettingsFusion(
-      { theme: 'dark' },
-      () => new Response(null, { status: 500 }),
-    );
-    const onError = vi.fn();
-
-    const { result } = await renderAppHook(
-      () => useAppSetting<{ theme: string }, 'theme'>('theme', undefined, { onError }),
-      { env, fusion },
-    );
-
-    await vi.waitFor(() => expect(result.current[0]).toBe('dark'));
-
-    act(() => {
-      result.current[1]('light');
-    });
-
-    await vi.waitFor(() => expect(onError).toHaveBeenCalledWith(expect.any(Error)));
-  });
-});

package/src/__tests__/useAppSettings.test.tsx

@@ -1,147 +0,0 @@
-import { act } from 'react';
-import { describe, expect, it, vi } from 'vitest';
-
-import { mockFramework } from '@equinor/fusion-framework/mock';
-import { enableAppManifestMock } from '@equinor/fusion-framework-app/mock';
-import type { AppModule } from '@equinor/fusion-framework-module-app';
-import { createRouterMiddleware } from '@equinor/fusion-framework-module-http/mock';
-
-import { useAppSettings } from '../settings/useAppSettings';
-import { renderAppHook } from '@equinor/fusion-framework-vitest-plugin-react-app/test';
-
-const env = {
-  manifest: {
-    appKey: 'test-app',
-    displayName: 'Test App',
-    description: 'A test application',
-    type: 'standalone' as const,
-  },
-};
-
-/**
- * Boots a parent framework whose `apps` client serves per-user settings from an
- * in-memory store, so `useAppSettings` exercises the real fetch/update round-trip
- * instead of a stubbed provider.
- *
- * @param initial - The settings the store starts seeded with.
- * @param putResponse - Overrides the response a PUT request resolves to, to simulate a failed update.
- */
-const mockSettingsFusion = async (
-  initial: Record<string, unknown> = {},
-  putResponse?: () => Response,
-) => {
-  const store: Record<string, unknown> = { ...initial };
-  const fusion = await mockFramework<[AppModule]>((configurator) => {
-    configurator.http.addMiddleware(
-      createRouterMiddleware('https://apps.fusion.test', (router) => {
-        router.get('/persons/me/apps/:appKey/settings', () => Response.json(store));
-        router.put('/persons/me/apps/:appKey/settings', async ({ request }) => {
-          // a caller-supplied response simulates a failed persistence request
-          if (putResponse) return putResponse();
-          // the PUT body replaces the seeded keys it targets, leaving the rest of the store untouched
-          Object.assign(store, await request.json());
-          return Response.json(store);
-        });
-      }),
-    );
-    enableAppManifestMock(configurator, env);
-  });
-  fusion.modules.app.setCurrentApp(env.manifest.appKey);
-  return fusion;
-};
-
-interface TestSettings extends Record<string, unknown> {
-  theme: string;
-  layout: string;
-}
-
-describe('useAppSettings', () => {
-  it('resolves the full persisted settings object', async () => {
-    const fusion = await mockSettingsFusion({ theme: 'dark', layout: 'grid' });
-
-    const { result } = await renderAppHook(() => useAppSettings<TestSettings>(), { env, fusion });
-
-    await vi.waitFor(() =>
-      expect(result.current[0]).toMatchObject({ theme: 'dark', layout: 'grid' }),
-    );
-  });
-
-  it('falls back to the default value until the persisted settings resolve', async () => {
-    const fusion = await mockSettingsFusion({ theme: 'dark', layout: 'grid' });
-
-    const { result } = await renderAppHook(
-      () => useAppSettings<TestSettings>({ theme: 'light', layout: 'list' }),
-      { env, fusion },
-    );
-
-    expect(result.current[0]).toMatchObject({ theme: 'light', layout: 'list' });
-    await vi.waitFor(() =>
-      expect(result.current[0]).toMatchObject({ theme: 'dark', layout: 'grid' }),
-    );
-  });
-
-  it('persists an updated settings object and notifies onUpdated', async () => {
-    const fusion = await mockSettingsFusion({ theme: 'dark', layout: 'grid' });
-    const onUpdated = vi.fn();
-
-    const { result } = await renderAppHook(
-      () => useAppSettings<TestSettings>(undefined, { onUpdated }),
-      { env, fusion },
-    );
-
-    await vi.waitFor(() =>
-      expect(result.current[0]).toMatchObject({ theme: 'dark', layout: 'grid' }),
-    );
-
-    act(() => {
-      result.current[1]({ theme: 'light', layout: 'grid' });
-    });
-
-    await vi.waitFor(() =>
-      expect(result.current[0]).toMatchObject({ theme: 'light', layout: 'grid' }),
-    );
-    await vi.waitFor(() => expect(onUpdated).toHaveBeenCalled());
-  });
-
-  it('resolves the next settings object from the previous one when given an updater function', async () => {
-    const fusion = await mockSettingsFusion({ theme: 'dark', layout: 'grid' });
-
-    const { result } = await renderAppHook(() => useAppSettings<TestSettings>(), { env, fusion });
-
-    await vi.waitFor(() =>
-      expect(result.current[0]).toMatchObject({ theme: 'dark', layout: 'grid' }),
-    );
-
-    act(() => {
-      // `current` is typed as possibly undefined even though it's already resolved by this point
-      result.current[1]((current) => ({ theme: current?.theme ?? 'dark', layout: 'list' }));
-    });
-
-    await vi.waitFor(() =>
-      expect(result.current[0]).toMatchObject({ theme: 'dark', layout: 'list' }),
-    );
-  });
-
-  it('surfaces a persistence failure through onError instead of throwing', async () => {
-    const fusion = await mockSettingsFusion(
-      { theme: 'dark', layout: 'grid' },
-      () => new Response(null, { status: 500 }),
-    );
-    const onError = vi.fn();
-
-    const { result } = await renderAppHook(
-      () => useAppSettings<TestSettings>(undefined, { onError }),
-      { env, fusion },
-    );
-
-    await vi.waitFor(() =>
-      expect(result.current[0]).toMatchObject({ theme: 'dark', layout: 'grid' }),
-    );
-
-    act(() => {
-      result.current[1]({ theme: 'light', layout: 'grid' });
-    });
-
-    await vi.waitFor(() => expect(onError).toHaveBeenCalledWith(expect.any(Error)));
-  });
-});

package/src/__tests__/useCurrentAccount.test.tsx

@@ -1,32 +0,0 @@
-import { describe, expect, it } from 'vitest';
-
-import { useCurrentAccount } from '../msal/useCurrentAccount';
-import { renderAppHook } from '@equinor/fusion-framework-vitest-plugin-react-app/test';
-
-describe('useCurrentAccount', () => {
-  it('returns the default mock user signed in by the app scope’s auth module', async () => {
-    const { result } = await renderAppHook(() => useCurrentAccount());
-
-    expect(result.current).toMatchObject({
-      name: 'Test User',
-      username: 'test.user@equinor.com',
-    });
-  });
-
-  it('returns the account configured through the msal mock builder', async () => {
-    const { result } = await renderAppHook(() => useCurrentAccount(), {
-      configure: (configurator) =>
-        configurator.msal.setAccount({ name: 'Ada Lovelace', username: 'ada@equinor.com' }),
-    });
-
-    expect(result.current).toMatchObject({ name: 'Ada Lovelace', username: 'ada@equinor.com' });
-  });
-
-  it('returns undefined when no account is signed in', async () => {
-    const { result } = await renderAppHook(() => useCurrentAccount(), {
-      configure: (configurator) => configurator.msal.setAccount(null),
-    });
-
-    expect(result.current).toBeUndefined();
-  });
-});

package/src/__tests__/useCurrentBookmark.test.tsx

@@ -1,108 +0,0 @@
-import { describe, expect, it, vi } from 'vitest';
-
-import { mockFramework } from '@equinor/fusion-framework/mock';
-import { enableAppManifestMock } from '@equinor/fusion-framework-app/mock';
-import type { AppMockConfigureFn } from '@equinor/fusion-framework-app/mock';
-import type { AppModule } from '@equinor/fusion-framework-module-app';
-import { enableBookmarkMock } from '@equinor/fusion-framework-module-bookmark/mock';
-import type { Bookmark, BookmarkModule } from '@equinor/fusion-framework-module-bookmark';
-
-import { useCurrentBookmark } from '../bookmark/useCurrentBookmark';
-import { renderAppHook } from '@equinor/fusion-framework-vitest-plugin-react-app/test';
-import { useAppModules } from '../useAppModules';
-
-const env = {
-  manifest: {
-    appKey: 'test-app',
-    displayName: 'Test App',
-    description: 'A test application',
-    type: 'standalone' as const,
-  },
-};
-
-/** A fully-formed seeded bookmark, so tests only override what they care about. */
-const createBookmark = (overrides: Partial<Bookmark> = {}): Bookmark => ({
-  id: 'bookmark-1',
-  name: 'My Bookmark',
-  appKey: 'test-app',
-  created: new Date('2024-01-01T00:00:00.000Z'),
-  createdBy: { id: 'seed-user', name: 'Seed User' },
-  ...overrides,
-});
-
-describe('useCurrentBookmark', () => {
-  it('returns the app-scoped current bookmark once it belongs to the active app', async () => {
-    const bookmark = createBookmark();
-    const fusion = await mockFramework<[AppModule]>((configurator) =>
-      enableAppManifestMock(configurator, env),
-    );
-    fusion.modules.app.setCurrentApp(env.manifest.appKey);
-
-    const configure: AppMockConfigureFn<[BookmarkModule]> = (configurator) =>
-      enableBookmarkMock(configurator, (builder) => {
-        builder.setBookmarks([bookmark]);
-        builder.setCurrentBookmark(bookmark.id);
-      });
-
-    const { result } = await renderAppHook(() => useCurrentBookmark(), { env, fusion, configure });
-
-    await vi.waitFor(() =>
-      expect(result.current.currentBookmark).toMatchObject({ id: bookmark.id }),
-    );
-  });
-
-  it('hides the current bookmark once it belongs to a different app', async () => {
-    const bookmark = createBookmark({ appKey: 'some-other-app' });
-    const fusion = await mockFramework<[AppModule]>((configurator) =>
-      enableAppManifestMock(configurator, env),
-    );
-    fusion.modules.app.setCurrentApp(env.manifest.appKey);
-
-    const configure: AppMockConfigureFn<[BookmarkModule]> = (configurator) =>
-      enableBookmarkMock(configurator, (builder) => {
-        builder.setBookmarks([bookmark]);
-        builder.setCurrentBookmark(bookmark.id);
-      });
-
-    const { result } = await renderAppHook(
-      () => ({
-        bookmark: useCurrentBookmark(),
-        // unfiltered provider state, so we can tell the seeded bookmark actually
-        // resolved rather than the filter trivially matching a still-pending value
-        provider: useAppModules<[BookmarkModule]>().bookmark,
-      }),
-      { env, fusion, configure },
-    );
-
-    await vi.waitFor(() =>
-      expect(result.current.provider.currentBookmark).toMatchObject({ id: bookmark.id }),
-    );
-    expect(result.current.bookmark.currentBookmark).toBeNull();
-  });
-
-  it('falls back to the framework-scoped bookmark provider, warning about the deprecation', async () => {
-    const bookmark = createBookmark();
-    const fusion = await mockFramework<[AppModule, BookmarkModule]>((configurator) => {
-      enableAppManifestMock(configurator, env);
-      enableBookmarkMock(configurator, (builder) => {
-        builder.setBookmarks([bookmark]);
-        builder.setCurrentBookmark(bookmark.id);
-      });
-    });
-    fusion.modules.app.setCurrentApp(env.manifest.appKey);
-
-    const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
-
-    const { result } = await renderAppHook(() => useCurrentBookmark(), { env, fusion });
-
-    await vi.waitFor(() =>
-      expect(result.current.currentBookmark).toMatchObject({ id: bookmark.id }),
-    );
-    expect(warnSpy).toHaveBeenCalledWith(
-      '@deprecation',
-      expect.stringContaining('has not enabled bookmarks'),
-    );
-
-    warnSpy.mockRestore();
-  });
-});

package/src/__tests__/useCurrentContext.test.tsx

@@ -1,72 +0,0 @@
-import { act } from 'react';
-import { describe, expect, it, vi } from 'vitest';
-
-import { mockFramework } from '@equinor/fusion-framework/mock';
-import { enableAppManifestMock } from '@equinor/fusion-framework-app/mock';
-import type { AppMockConfigureFn } from '@equinor/fusion-framework-app/mock';
-import type { AppModule } from '@equinor/fusion-framework-module-app';
-import { enableContextMock } from '@equinor/fusion-framework-module-context/mock';
-import type { ContextItem, ContextModule } from '@equinor/fusion-framework-module-context';
-
-import { useCurrentContext } from '../context/useCurrentContext';
-import { renderAppHook } from '@equinor/fusion-framework-vitest-plugin-react-app/test';
-
-const env = {
-  manifest: {
-    appKey: 'test-app',
-    displayName: 'Test App',
-    description: 'A test application',
-    type: 'standalone' as const,
-  },
-};
-
-const project: ContextItem = {
-  id: 'ctx-1',
-  title: 'My project',
-  type: { id: 'ProjectMaster' },
-  value: {},
-};
-const facility: ContextItem = {
-  id: 'ctx-2',
-  title: 'My facility',
-  type: { id: 'Facility' },
-  value: {},
-};
-
-describe('useCurrentContext', () => {
-  it('resolves the context item selected on startup from the app-scoped context module', async () => {
-    const fusion = await mockFramework<[AppModule]>((configurator) =>
-      enableAppManifestMock(configurator, env),
-    );
-    const configure: AppMockConfigureFn<[ContextModule]> = (configurator) =>
-      enableContextMock(configurator, (mock) => {
-        mock.setCurrentContext(project);
-      });
-
-    const { result } = await renderAppHook(() => useCurrentContext(), { env, fusion, configure });
-
-    await vi.waitFor(() => expect(result.current.currentContext).toMatchObject({ id: project.id }));
-  });
-
-  it('switches the current context when setCurrentContext is called with another seeded item', async () => {
-    const fusion = await mockFramework<[AppModule]>((configurator) =>
-      enableAppManifestMock(configurator, env),
-    );
-    const configure: AppMockConfigureFn<[ContextModule]> = (configurator) =>
-      enableContextMock(configurator, (mock) => {
-        mock.setCurrentContext(project);
-        mock.addContext(facility);
-      });
-
-    const { result } = await renderAppHook(() => useCurrentContext(), { env, fusion, configure });
-    await vi.waitFor(() => expect(result.current.currentContext).toMatchObject({ id: project.id }));
-
-    await act(async () => {
-      await result.current.setCurrentContext(facility.id);
-    });
-
-    await vi.waitFor(() =>
-      expect(result.current.currentContext).toMatchObject({ id: facility.id }),
-    );
-  });
-});