launchdarkly
diff --git a/‎packages/toolbar/src/core/tests/EnvironmentProvider.test.tsx‎
Lines changed: 376 additions & 0 deletions b/‎packages/toolbar/src/core/tests/EnvironmentProvider.test.tsx‎
Lines changed: 376 additions & 0 deletions
@@ -0,0 +1,376 @@
+import { render, screen, waitFor, act } from '@testing-library/react';
+import { expect, test, describe, vi, beforeEach, afterEach } from 'vitest';
+import { EnvironmentProvider, useEnvironmentContext } from '../ui/Toolbar/context/api/EnvironmentProvider';
+import '@testing-library/jest-dom/vitest';
+import React from 'react';
+
+// Mock the ProjectProvider
+vi.mock('../ui/Toolbar/context/api/ProjectProvider', () => ({
+  useProjectContext: vi.fn(),
+}));
+
+import { useProjectContext } from '../ui/Toolbar/context/api/ProjectProvider';
+
+// Test component that uses the Environment context
+function TestConsumer() {
+  const { environment } = useEnvironmentContext();
+
+  return (
+    <div>
+      <div data-testid="environment">{environment || 'none'}</div>
+    </div>
+  );
+}
+
+// Test component with environment setter
+function TestConsumerWithSetter() {
+  const { environment, setEnvironment } = useEnvironmentContext();
+
+  return (
+    <div>
+      <div data-testid="environment">{environment || 'none'}</div>
+      <button data-testid="set-staging" onClick={() => setEnvironment('staging')}>
+        Set Staging
+      </button>
+      <button data-testid="set-production" onClick={() => setEnvironment('production')}>
+        Set Production
+      </button>
+    </div>
+  );
+}
+
+describe('EnvironmentProvider', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+    localStorage.clear();
+
+    // Default mock - no environments
+    (useProjectContext as any).mockReturnValue({
+      environments: [],
+    });
+  });
+
+  afterEach(() => {
+    localStorage.clear();
+  });
+
+  describe('Environment Auto-Detection - First Time User', () => {
+    test('defaults to production when no environments available and no saved value', async () => {
+      // GIVEN: New developer with no saved environment and no environments from project
+      (useProjectContext as any).mockReturnValue({
+        environments: [],
+      });
+
+      // WHEN: Provider initializes
+      render(
+        <EnvironmentProvider>
+          <TestConsumer />
+        </EnvironmentProvider>,
+      );
+
+      // THEN: Defaults to production
+      await waitFor(() => {
+        expect(screen.getByTestId('environment')).toHaveTextContent('production');
+      });
+    });
+
+    test('auto-selects first available environment when no environment is saved', async () => {
+      // GIVEN: New developer using toolbar for first time (no saved environment)
+      (useProjectContext as any).mockReturnValue({
+        environments: [
+          { _id: 'env-1', key: 'staging', name: 'Staging' },
+          { _id: 'env-2', key: 'production', name: 'Production' },
+        ],
+      });
+
+      // WHEN: They open the toolbar
+      render(
+        <EnvironmentProvider>
+          <TestConsumer />
+        </EnvironmentProvider>,
+      );
+
+      // THEN: System auto-selects the first environment
+      await waitFor(() => {
+        expect(screen.getByTestId('environment')).toHaveTextContent('staging');
+      });
+
+      // AND: Saves it to localStorage for next time
+      expect(localStorage.getItem('ld-toolbar-environment')).toBe('staging');
+    });
+
+    test('selects environment matching provided clientSideId', async () => {
+      // GIVEN: Developer initializes toolbar with a specific clientSideId
+      const clientSideId = 'sdk-key-production';
+
+      (useProjectContext as any).mockReturnValue({
+        environments: [
+          { _id: 'sdk-key-staging', key: 'staging', name: 'Staging' },
+          { _id: clientSideId, key: 'production', name: 'Production' },
+        ],
+      });
+
+      // WHEN: Toolbar initializes with clientSideId
+      render(
+        <EnvironmentProvider clientSideId={clientSideId}>
+          <TestConsumer />
+        </EnvironmentProvider>,
+      );
+
+      // THEN: Correct environment is auto-selected based on SDK key
+      await waitFor(() => {
+        expect(screen.getByTestId('environment')).toHaveTextContent('production');
+      });
+    });
+
+    test('falls back to first environment when clientSideId does not match', async () => {
+      // GIVEN: Developer provides a clientSideId that doesn't match any environment
+      (useProjectContext as any).mockReturnValue({
+        environments: [
+          { _id: 'env-1', key: 'staging', name: 'Staging' },
+          { _id: 'env-2', key: 'production', name: 'Production' },
+        ],
+      });
+
+      // WHEN: Toolbar initializes with non-matching clientSideId
+      render(
+        <EnvironmentProvider clientSideId="non-existent-sdk-key">
+          <TestConsumer />
+        </EnvironmentProvider>,
+      );
+
+      // THEN: Falls back to first available environment
+      await waitFor(() => {
+        expect(screen.getByTestId('environment')).toHaveTextContent('staging');
+      });
+    });
+  });
+
+  describe('Environment Persistence - Returning User', () => {
+    test('restores previously selected environment from localStorage', async () => {
+      // GIVEN: Developer has used toolbar before and selected an environment
+      localStorage.setItem('ld-toolbar-environment', 'qa');
+
+      (useProjectContext as any).mockReturnValue({
+        environments: [
+          { _id: 'env-1', key: 'production', name: 'Production' },
+          { _id: 'env-2', key: 'qa', name: 'QA' },
+        ],
+      });
+
+      // WHEN: They open toolbar again
+      render(
+        <EnvironmentProvider>
+          <TestConsumer />
+        </EnvironmentProvider>,
+      );
+
+      // THEN: Their previous environment selection is restored
+      await waitFor(() => {
+        expect(screen.getByTestId('environment')).toHaveTextContent('qa');
+      });
+    });
+
+    test('localStorage takes precedence over clientSideId', async () => {
+      // GIVEN: localStorage has one environment, but clientSideId points to another
+      localStorage.setItem('ld-toolbar-environment', 'staging');
+
+      (useProjectContext as any).mockReturnValue({
+        environments: [
+          { _id: 'sdk-key-production', key: 'production', name: 'Production' },
+          { _id: 'sdk-key-staging', key: 'staging', name: 'Staging' },
+        ],
+      });
+
+      // WHEN: Developer opens toolbar with a clientSideId
+      render(
+        <EnvironmentProvider clientSideId="sdk-key-production">
+          <TestConsumer />
+        </EnvironmentProvider>,
+      );
+
+      // THEN: Saved environment from localStorage is used (not the one from clientSideId)
+      await waitFor(() => {
+        expect(screen.getByTestId('environment')).toHaveTextContent('staging');
+      });
+    });
+  });
+
+  describe('Environment Selection Workflow', () => {
+    test('allows changing environment after initial selection', async () => {
+      // GIVEN: User has an environment selected
+      (useProjectContext as any).mockReturnValue({
+        environments: [
+          { _id: 'env-1', key: 'production', name: 'Production' },
+          { _id: 'env-2', key: 'staging', name: 'Staging' },
+        ],
+      });
+
+      render(
+        <EnvironmentProvider>
+          <TestConsumerWithSetter />
+        </EnvironmentProvider>,
+      );
+
+      // Initial environment auto-selected (first one)
+      await waitFor(() => {
+        expect(screen.getByTestId('environment')).toHaveTextContent('production');
+      });
+
+      // WHEN: User switches to different environment
+      const switchButton = screen.getByTestId('set-staging');
+      act(() => {
+        switchButton.click();
+      });
+
+      // THEN: Environment updates
+      await waitFor(() => {
+        expect(screen.getByTestId('environment')).toHaveTextContent('staging');
+      });
+
+      // AND: Change is persisted to localStorage
+      expect(localStorage.getItem('ld-toolbar-environment')).toBe('staging');
+    });
+
+    test('persists environment changes to localStorage', async () => {
+      // GIVEN: User is using the toolbar
+      (useProjectContext as any).mockReturnValue({
+        environments: [{ _id: 'env-1', key: 'production', name: 'Production' }],
+      });
+
+      render(
+        <EnvironmentProvider>
+          <TestConsumerWithSetter />
+        </EnvironmentProvider>,
+      );
+
+      await waitFor(() => {
+        expect(screen.getByTestId('environment')).toHaveTextContent('production');
+      });
+
+      // WHEN: User changes environment multiple times
+      const stagingButton = screen.getByTestId('set-staging');
+      act(() => {
+        stagingButton.click();
+      });
+
+      // THEN: Each change is persisted
+      expect(localStorage.getItem('ld-toolbar-environment')).toBe('staging');
+
+      const productionButton = screen.getByTestId('set-production');
+      act(() => {
+        productionButton.click();
+      });
+
+      expect(localStorage.getItem('ld-toolbar-environment')).toBe('production');
+    });
+  });
+
+  describe('Context Hook - useEnvironmentContext', () => {
+    test('throws error when used without EnvironmentProvider', () => {
+      // GIVEN: Component uses context without provider
+      const TestDefault = () => {
+        const { environment } = useEnvironmentContext();
+        return <div data-testid="environment">{environment}</div>;
+      };
+
+      // WHEN: Rendered without provider
+      // THEN: Should throw an error
+      expect(() => {
+        render(<TestDefault />);
+      }).toThrow('useEnvironmentContext must be used within an EnvironmentProvider');
+    });
+  });
+
+  describe('Edge Cases', () => {
+    test('handles empty environments array gracefully', async () => {
+      // GIVEN: Project has no environments configured
+      (useProjectContext as any).mockReturnValue({
+        environments: [],
+      });
+
+      // WHEN: Provider initializes
+      render(
+        <EnvironmentProvider>
+          <TestConsumer />
+        </EnvironmentProvider>,
+      );
+
+      // THEN: Defaults to production without crashing
+      await waitFor(() => {
+        expect(screen.getByTestId('environment')).toHaveTextContent('production');
+      });
+    });
+
+    test('handles environments being updated after initial render', async () => {
+      // GIVEN: Initially no environments
+      const mockUseProjectContext = useProjectContext as any;
+      mockUseProjectContext.mockReturnValue({
+        environments: [],
+      });
+
+      const { rerender } = render(
+        <EnvironmentProvider>
+          <TestConsumer />
+        </EnvironmentProvider>,
+      );
+
+      // Initially defaults to production
+      await waitFor(() => {
+        expect(screen.getByTestId('environment')).toHaveTextContent('production');
+      });
+
+      // WHEN: Environments become available
+      mockUseProjectContext.mockReturnValue({
+        environments: [
+          { _id: 'env-1', key: 'staging', name: 'Staging' },
+          { _id: 'env-2', key: 'production', name: 'Production' },
+        ],
+      });
+
+      rerender(
+        <EnvironmentProvider>
+          <TestConsumer />
+        </EnvironmentProvider>,
+      );
+
+      // THEN: Environment updates to first available
+      await waitFor(() => {
+        expect(screen.getByTestId('environment')).toHaveTextContent('staging');
+      });
+    });
+
+    test('does not overwrite localStorage when restoring saved value', async () => {
+      // GIVEN: A saved environment in localStorage
+      localStorage.setItem('ld-toolbar-environment', 'qa');
+
+      (useProjectContext as any).mockReturnValue({
+        environments: [
+          { _id: 'env-1', key: 'production', name: 'Production' },
+          { _id: 'env-2', key: 'qa', name: 'QA' },
+        ],
+      });
+
+      // Spy on localStorage.setItem
+      const setItemSpy = vi.spyOn(Storage.prototype, 'setItem');
+
+      // WHEN: Provider initializes
+      render(
+        <EnvironmentProvider>
+          <TestConsumer />
+        </EnvironmentProvider>,
+      );
+
+      await waitFor(() => {
+        expect(screen.getByTestId('environment')).toHaveTextContent('qa');
+      });
+
+      // THEN: localStorage.setItem was not called (value was restored, not set)
+      // Note: setItem might be called 0 times if restoring from localStorage
+      const environmentSetCalls = setItemSpy.mock.calls.filter((call) => call[0] === 'ld-toolbar-environment');
+      expect(environmentSetCalls.length).toBe(0);
+
+      setItemSpy.mockRestore();
+    });
+  });
+});