@jmruthers/pace-core 0.6.4 → 0.6.6

package/src/rbac/components/__tests__/NavigationProvider.test.tsx

@@ -1,726 +0,0 @@
-/**
- * @file Navigation Provider Component Tests
- * @package @jmruthers/pace-core
- * @module RBAC/Components/NavigationProvider
- * @since 2.0.0
- *
- * Comprehensive test suite for the NavigationProvider component.
- * Tests cover all functionality including navigation permission checking, audit logging,
- * strict mode enforcement, context management, and error scenarios.
- */
-
-import React from 'react';
-import { render, screen, waitFor, act } from '@testing-library/react';
-import { vi, describe, it, expect, beforeEach, afterEach } from 'vitest';
-import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
-import { renderWithProviders } from '../../../__tests__/helpers';
-
-// Mock the RBAC logger - define inside factory to avoid hoisting issues
-const mockLogger = {
-  debug: vi.fn(),
-  error: vi.fn(),
-  warn: vi.fn(),
-  info: vi.fn(),
-};
-
-vi.mock('../../config', () => ({
-  getRBACLogger: vi.fn(() => mockLogger),
-  getRBACConfig: vi.fn(() => ({
-    debug: true,
-    logLevel: 'debug',
-    developmentMode: true,
-    audit: {
-      enabled: true,
-      logLevel: 'debug'
-    }
-  })),
-  isDebugMode: vi.fn(() => true),
-  isDevelopmentMode: vi.fn(() => true),
-}));
-
-import { 
-  NavigationProvider, 
-  NavigationProviderProps, 
-  useNavigationPermissions,
-  NavigationItem,
-  NavigationAccessRecord 
-} from '../NavigationProvider';
-import { useUnifiedAuth } from '../../../providers/services/UnifiedAuthProvider';
-
-// Mock the UnifiedAuthProvider
-const mockUseUnifiedAuthFn = vi.fn();
-vi.mock('../../../providers/services/UnifiedAuthProvider', () => ({
-  useUnifiedAuth: () => mockUseUnifiedAuthFn(),
-  UnifiedAuthProvider: ({ children }: { children: React.ReactNode }) => <div data-testid="unified-auth-provider">{children}</div>
-}));
-
-// Mock useResolvedScope
-const mockUseResolvedScopeFn = vi.fn();
-vi.mock('../../hooks/useResolvedScope', () => ({
-  useResolvedScope: () => mockUseResolvedScopeFn(),
-}));
-
-// Mock useCan hook
-const mockUseCanFn = vi.fn();
-vi.mock('../../hooks', () => ({
-  useCan: (...args: any[]) => mockUseCanFn(...args),
-}));
-
-// Test data
-const mockUser = {
-  id: 'user-123',
-  email: 'test@example.com',
-  selectedOrganisationId: 'org-456',
-  selectedEventId: 'event-789'
-};
-
-const mockScope = {
-  organisationId: 'org-456',
-  eventId: 'event-789',
-  appId: undefined
-};
-
-const mockNavigationItems: NavigationItem[] = [
-  {
-    id: 'dashboard',
-    label: 'Dashboard',
-    path: '/dashboard',
-    permissions: ['read:dashboard'] as any,
-    meta: { icon: '🏠', description: 'Main dashboard' }
-  },
-  {
-    id: 'events',
-    label: 'Events',
-    path: '/events',
-    permissions: ['read:events'] as any,
-    meta: { icon: '📅', description: 'Event management' }
-  },
-  {
-    id: 'users',
-    label: 'Users',
-    path: '/users',
-    permissions: ['read:users'] as any,
-    meta: { icon: '👥', description: 'User management' }
-  }
-];
-
-// Test component that uses the context
-const TestComponent: React.FC<{ testId?: string }> = ({ testId = 'test-component' }) => {
-  const context = useNavigationPermissions();
-  
-  return (
-    <div data-testid={testId}>
-      <div data-testid="is-enabled">{context.isEnabled.toString()}</div>
-      <div data-testid="is-strict-mode">{context.isStrictMode.toString()}</div>
-      <div data-testid="is-audit-log-enabled">{context.isAuditLogEnabled.toString()}</div>
-      <div data-testid="navigation-permission">
-        {context.hasNavigationPermission(mockNavigationItems[0]).toString()}
-      </div>
-      <div data-testid="permissions">
-        {JSON.stringify(context.getNavigationPermissions())}
-      </div>
-      <div data-testid="filtered-items-count">
-        {context.getFilteredNavigationItems(mockNavigationItems).length}
-      </div>
-      <div data-testid="history-length">
-        {context.getNavigationAccessHistory().length}
-      </div>
-    </div>
-  );
-};
-
-// Test wrapper component
-const TestWrapper: React.FC<{ 
-  children: React.ReactNode; 
-  providerProps?: Partial<NavigationProviderProps> 
-}> = ({ children, providerProps = {} }) => {
-  const queryClient = new QueryClient({
-    defaultOptions: {
-      queries: { retry: false },
-      mutations: { retry: false }
-    }
-  });
-
-  return (
-    <QueryClientProvider client={queryClient}>
-      <NavigationProvider {...providerProps}>
-        {children}
-      </NavigationProvider>
-    </QueryClientProvider>
-  );
-};
-
-describe('NavigationProvider', () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-    
-    // Set up default mock with organisation context
-    mockUseUnifiedAuthFn.mockReturnValue({
-      user: {
-        id: 'user-123',
-        email: 'test@example.com',
-      },
-      selectedOrganisation: { id: 'org-456' },
-      selectedEvent: { event_id: 'event-789' },
-      supabase: {} as any,
-    });
-    
-    // Mock useResolvedScope to return resolved scope
-    mockUseResolvedScopeFn.mockReturnValue({
-      resolvedScope: mockScope,
-      isLoading: false,
-      error: null,
-    });
-    
-    // Mock useCan to return true by default
-    // Note: useCan is called inside hasNavigationPermission callback, so it needs to return a value every time
-    mockUseCanFn.mockImplementation(() => ({
-      can: true,
-      isLoading: false,
-      error: null,
-    }));
-  });
-
-  afterEach(() => {
-    vi.clearAllMocks();
-  });
-
-  describe('Basic Functionality', () => {
-    it('should render children correctly', () => {
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('test-component')).toBeInTheDocument();
-    });
-
-    it('should provide context values with defaults', () => {
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('is-enabled')).toHaveTextContent('true');
-      expect(screen.getByTestId('is-strict-mode')).toHaveTextContent('true');
-      expect(screen.getByTestId('is-audit-log-enabled')).toHaveTextContent('true');
-    });
-
-    it('should allow navigation permission when enabled', () => {
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      // When enabled and useCan returns true, permission should be granted
-      expect(screen.getByTestId('navigation-permission')).toHaveTextContent('true');
-    });
-
-    it('should return empty permissions initially', () => {
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('permissions')).toHaveTextContent('{}');
-    });
-
-    it('should return empty history initially', () => {
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('history-length')).toHaveTextContent('0');
-    });
-
-    it('should filter navigation items correctly', () => {
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      // When useCan returns true for all items, all items should pass the filter
-      expect(screen.getByTestId('filtered-items-count')).toHaveTextContent('3');
-    });
-  });
-
-  describe('Configuration Options', () => {
-    it('should respect strictMode prop', () => {
-      renderWithProviders(
-        <TestWrapper providerProps={{ strictMode: false }}>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('is-strict-mode')).toHaveTextContent('false');
-    });
-
-    it('should respect auditLog prop', () => {
-      renderWithProviders(
-        <TestWrapper providerProps={{ auditLog: false }}>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('is-audit-log-enabled')).toHaveTextContent('false');
-    });
-
-    it('should respect maxHistorySize prop', () => {
-      const TestComponentWithHistory = () => {
-        const context = useNavigationPermissions();
-        // Test that history management functions exist
-        return (
-          <div data-testid="history-functions">
-            {typeof context.getNavigationAccessHistory === 'function' ? 'has-get' : 'no-get'}
-            {typeof context.clearNavigationAccessHistory === 'function' ? 'has-clear' : 'no-clear'}
-          </div>
-        );
-      };
-
-      renderWithProviders(
-        <TestWrapper providerProps={{ maxHistorySize: 5 }}>
-          <TestComponentWithHistory />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('history-functions')).toHaveTextContent('has-gethas-clear');
-    });
-  });
-
-  describe('Navigation Permission Checking', () => {
-    it('should allow navigation permission when user is authenticated', () => {
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      // When user is authenticated and useCan returns true, permission should be granted
-      expect(screen.getByTestId('navigation-permission')).toHaveTextContent('true');
-    });
-
-    it('should deny navigation permission when user is not authenticated', () => {
-      mockUseUnifiedAuthFn.mockReturnValue({ ...mockUser, id: null });
-
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('navigation-permission')).toHaveTextContent('false');
-    });
-
-    it('should deny navigation permission when organisation context is missing', () => {
-      mockUseUnifiedAuthFn.mockReturnValue({ 
-        ...mockUser, 
-        selectedOrganisationId: null 
-      });
-
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('navigation-permission')).toHaveTextContent('false');
-    });
-
-    it('should allow navigation permission when disabled', () => {
-      const TestComponentDisabled = () => {
-        const context = useNavigationPermissions();
-        // We can't directly test isEnabled from outside, but we can test the behavior
-        return (
-          <div data-testid="navigation-permission">
-            {context.hasNavigationPermission(mockNavigationItems[0]).toString()}
-          </div>
-        );
-      };
-
-      // Mock the context to return disabled state
-      vi.spyOn(React, 'useState').mockReturnValueOnce([false, vi.fn()]);
-
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponentDisabled />
-        </TestWrapper>
-      );
-
-      // When disabled, hasNavigationPermission returns true (allows all)
-      expect(screen.getByTestId('navigation-permission')).toHaveTextContent('true');
-    });
-  });
-
-  describe('Navigation Item Filtering', () => {
-    it('should filter items based on permissions when enabled', () => {
-      const TestComponentWithFiltering = () => {
-        const context = useNavigationPermissions();
-        const filteredItems = context.getFilteredNavigationItems(mockNavigationItems);
-        return (
-          <div data-testid="filtered-items">
-            {filteredItems.map(item => (
-              <div key={item.id} data-testid={`item-${item.id}`}>
-                {item.label}
-              </div>
-            ))}
-            <div data-testid="filtered-count">{filteredItems.length}</div>
-          </div>
-        );
-      };
-
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponentWithFiltering />
-        </TestWrapper>
-      );
-
-      // When useCan returns true for all items, all items should pass the filter
-      expect(screen.getByTestId('filtered-count')).toHaveTextContent('3');
-    });
-
-    it('should return all items when disabled', () => {
-      const TestComponentWithFiltering = () => {
-        const context = useNavigationPermissions();
-        // Mock disabled state
-        const filteredItems = context.getFilteredNavigationItems(mockNavigationItems);
-        return (
-          <div data-testid="filtered-items-count">
-            {filteredItems.length}
-          </div>
-        );
-      };
-
-      // Mock disabled state
-      vi.spyOn(React, 'useState').mockReturnValueOnce([false, vi.fn()]);
-
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponentWithFiltering />
-        </TestWrapper>
-      );
-
-      // When disabled, all items should be returned (no filtering)
-      expect(screen.getByTestId('filtered-items-count')).toHaveTextContent('3');
-    });
-  });
-
-  describe('Audit Logging', () => {
-    it('should log strict mode status when enabled', async () => {
-      renderWithProviders(
-        <TestWrapper providerProps={{ strictMode: true, auditLog: true }}>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      // Note: NavigationProvider doesn't currently log strict mode status
-      // The test verifies that strict mode is enabled by checking the component state
-      await waitFor(() => {
-        expect(screen.getByTestId('is-strict-mode')).toHaveTextContent('true');
-      });
-    });
-
-    it('should not log when audit logging is disabled', async () => {
-      renderWithProviders(
-        <TestWrapper providerProps={{ auditLog: false }}>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      await waitFor(() => {
-        expect(mockLogger.debug).not.toHaveBeenCalledWith(
-          'Strict mode enabled - all navigation access attempts will be logged and enforced'
-        );
-      });
-    });
-  });
-
-  describe('History Management', () => {
-    it('should clear navigation access history', () => {
-      const TestComponentWithClear = () => {
-        const context = useNavigationPermissions();
-        const clearHistory = () => context.clearNavigationAccessHistory();
-        
-        return (
-          <div>
-            <button onClick={clearHistory} data-testid="clear-button">
-              Clear History
-            </button>
-            <div data-testid="history-length">
-              {context.getNavigationAccessHistory().length}
-            </div>
-          </div>
-        );
-      };
-
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponentWithClear />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('history-length')).toHaveTextContent('0');
-    });
-
-    it('should maintain history within maxHistorySize limit', () => {
-      const TestComponentWithHistory = () => {
-        const context = useNavigationPermissions();
-        
-        // Test that history management functions exist
-        return (
-          <div data-testid="history-functions">
-            {typeof context.getNavigationAccessHistory === 'function' ? 'has-get' : 'no-get'}
-            {typeof context.clearNavigationAccessHistory === 'function' ? 'has-clear' : 'no-clear'}
-          </div>
-        );
-      };
-
-      renderWithProviders(
-        <TestWrapper providerProps={{ maxHistorySize: 5 }}>
-          <TestComponentWithHistory />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('history-functions')).toHaveTextContent('has-gethas-clear');
-    });
-  });
-
-  describe('Error Handling', () => {
-    it('should handle missing user gracefully', () => {
-      mockUseUnifiedAuthFn.mockReturnValue({});
-
-      expect(() => {
-        renderWithProviders(
-          <TestWrapper>
-            <TestComponent />
-          </TestWrapper>
-        );
-      }).not.toThrow();
-    });
-
-    it('should handle missing organisation context gracefully', () => {
-      mockUseUnifiedAuthFn.mockReturnValue({
-        ...mockUser,
-        selectedOrganisationId: null,
-        selectedEventId: null
-      });
-
-      expect(() => {
-        renderWithProviders(
-          <TestWrapper>
-            <TestComponent />
-          </TestWrapper>
-        );
-      }).not.toThrow();
-    });
-  });
-
-  describe('useNavigationPermissions Hook', () => {
-    it('should throw error when used outside provider', () => {
-      const TestComponentOutsideProvider = () => {
-        useNavigationPermissions();
-        return <div>Should not render</div>;
-      };
-
-      expect(() => {
-        renderWithProviders(<TestComponentOutsideProvider />);
-      }).toThrow('useNavigationPermissions must be used within a NavigationProvider');
-    });
-
-    it('should return context when used within provider', () => {
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('test-component')).toBeInTheDocument();
-    });
-  });
-
-  describe('Callback Functions', () => {
-    it('should call onNavigationAccess callback when provided', () => {
-      const onNavigationAccess = vi.fn();
-      
-      // We can't directly trigger navigation access from outside the provider,
-      // but we can test that the callback is properly set up
-      renderWithProviders(
-        <TestWrapper providerProps={{ onNavigationAccess }}>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('test-component')).toBeInTheDocument();
-    });
-
-    it('should call onStrictModeViolation callback when provided', () => {
-      const onStrictModeViolation = vi.fn();
-      
-      renderWithProviders(
-        <TestWrapper providerProps={{ onStrictModeViolation }}>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('test-component')).toBeInTheDocument();
-    });
-  });
-
-  describe('Scope Management', () => {
-    it('should create scope with organisation and event IDs', () => {
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      // The scope is created internally, but we can verify the component works
-      expect(screen.getByTestId('test-component')).toBeInTheDocument();
-    });
-
-    it('should handle missing event ID in scope', () => {
-      mockUseUnifiedAuthFn.mockReturnValue({
-        ...mockUser,
-        selectedEventId: null
-      });
-
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('test-component')).toBeInTheDocument();
-    });
-  });
-
-  describe('Performance', () => {
-    it('should memoize context value', () => {
-      const { rerender } = renderWithProviders(
-        <TestWrapper>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      const initialRender = screen.getByTestId('test-component');
-
-      // Rerender with same props
-      rerender(
-        <TestWrapper>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      // Component should still be there
-      expect(screen.getByTestId('test-component')).toBeInTheDocument();
-    });
-  });
-
-  describe('Integration', () => {
-    it('should work with multiple consumers', () => {
-      const AnotherTestComponent = () => {
-        const context = useNavigationPermissions();
-        return <div data-testid="another-component">{context.isEnabled.toString()}</div>;
-      };
-
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponent />
-          <AnotherTestComponent />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('test-component')).toBeInTheDocument();
-      expect(screen.getByTestId('another-component')).toBeInTheDocument();
-    });
-
-    it('should maintain state across re-renders', () => {
-      const { rerender } = renderWithProviders(
-        <TestWrapper>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('is-enabled')).toHaveTextContent('true');
-
-      rerender(
-        <TestWrapper>
-          <TestComponent />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('is-enabled')).toHaveTextContent('true');
-    });
-  });
-
-  describe('Edge Cases', () => {
-    it('should handle empty navigation items array', () => {
-      const TestComponentEmptyItems = () => {
-        const context = useNavigationPermissions();
-        const filteredItems = context.getFilteredNavigationItems([]);
-        return <div data-testid="empty-items-count">{filteredItems.length}</div>;
-      };
-
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponentEmptyItems />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('empty-items-count')).toHaveTextContent('0');
-    });
-
-    it('should handle navigation item with missing permissions', () => {
-      const itemWithoutPermissions: NavigationItem = {
-        id: 'no-permissions',
-        label: 'No Permissions',
-        path: '/no-permissions',
-        permissions: []
-      };
-
-      const TestComponentNoPermissions = () => {
-        const context = useNavigationPermissions();
-        const hasPermission = context.hasNavigationPermission(itemWithoutPermissions);
-        return <div data-testid="no-permissions-permission">{hasPermission.toString()}</div>;
-      };
-
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponentNoPermissions />
-        </TestWrapper>
-      );
-
-      expect(screen.getByTestId('no-permissions-permission')).toHaveTextContent('false');
-    });
-
-    it('should handle navigation item with undefined meta', () => {
-      const itemWithoutMeta: NavigationItem = {
-        id: 'no-meta',
-        label: 'No Meta',
-        path: '/no-meta',
-        permissions: ['read:test'] as any
-      };
-
-      const TestComponentNoMeta = () => {
-        const context = useNavigationPermissions();
-        const hasPermission = context.hasNavigationPermission(itemWithoutMeta);
-        return <div data-testid="no-meta-permission">{hasPermission.toString()}</div>;
-      };
-
-      renderWithProviders(
-        <TestWrapper>
-          <TestComponentNoMeta />
-        </TestWrapper>
-      );
-
-      // Item has permissions defined, so useCan is called and returns true (mocked)
-      expect(screen.getByTestId('no-meta-permission')).toHaveTextContent('true');
-    });
-  });
-});