|
| 1 | +/** |
| 2 | + * ObjectUI |
| 3 | + * Copyright (c) 2024-present ObjectStack Inc. |
| 4 | + * |
| 5 | + * This source code is licensed under the MIT license found in the |
| 6 | + * LICENSE file in the root directory of this source tree. |
| 7 | + */ |
| 8 | + |
| 9 | +import { describe, it, expect, vi, beforeEach } from 'vitest'; |
| 10 | +import { render, screen, fireEvent } from '@testing-library/react'; |
| 11 | +import { DashboardGridLayout } from '../DashboardGridLayout'; |
| 12 | +import type { DashboardSchema } from '@object-ui/types'; |
| 13 | + |
| 14 | +// Mock localStorage |
| 15 | +const localStorageMock = (() => { |
| 16 | + let store: Record<string, string> = {}; |
| 17 | + return { |
| 18 | + getItem: (key: string) => store[key] || null, |
| 19 | + setItem: (key: string, value: string) => { store[key] = value; }, |
| 20 | + clear: () => { store = {}; }, |
| 21 | + removeItem: (key: string) => { delete store[key]; }, |
| 22 | + }; |
| 23 | +})(); |
| 24 | + |
| 25 | +Object.defineProperty(window, 'localStorage', { value: localStorageMock }); |
| 26 | + |
| 27 | +// Mock react-grid-layout |
| 28 | +vi.mock('react-grid-layout', () => ({ |
| 29 | + Responsive: ({ children }: any) => <div data-testid="grid-layout">{children}</div>, |
| 30 | + WidthProvider: (Component: any) => Component, |
| 31 | +})); |
| 32 | + |
| 33 | +describe('DashboardGridLayout', () => { |
| 34 | + beforeEach(() => { |
| 35 | + localStorageMock.clear(); |
| 36 | + }); |
| 37 | + |
| 38 | + const mockSchema: DashboardSchema = { |
| 39 | + type: 'dashboard', |
| 40 | + name: 'test_dashboard', |
| 41 | + title: 'Test Dashboard', |
| 42 | + widgets: [ |
| 43 | + { |
| 44 | + id: 'widget-1', |
| 45 | + type: 'metric-card', |
| 46 | + title: 'Total Sales', |
| 47 | + layout: { x: 0, y: 0, w: 3, h: 2 }, |
| 48 | + }, |
| 49 | + { |
| 50 | + id: 'widget-2', |
| 51 | + type: 'bar', |
| 52 | + title: 'Revenue by Month', |
| 53 | + layout: { x: 3, y: 0, w: 6, h: 4 }, |
| 54 | + }, |
| 55 | + ], |
| 56 | + }; |
| 57 | + |
| 58 | + it('should render without crashing', () => { |
| 59 | + const { container } = render(<DashboardGridLayout schema={mockSchema} />); |
| 60 | + expect(container).toBeTruthy(); |
| 61 | + }); |
| 62 | + |
| 63 | + it('should render dashboard title', () => { |
| 64 | + render(<DashboardGridLayout schema={mockSchema} />); |
| 65 | + expect(screen.getByText('Test Dashboard')).toBeInTheDocument(); |
| 66 | + }); |
| 67 | + |
| 68 | + it('should render all widgets', () => { |
| 69 | + render(<DashboardGridLayout schema={mockSchema} />); |
| 70 | + |
| 71 | + expect(screen.getByText('Total Sales')).toBeInTheDocument(); |
| 72 | + expect(screen.getByText('Revenue by Month')).toBeInTheDocument(); |
| 73 | + }); |
| 74 | + |
| 75 | + it('should render edit mode button', () => { |
| 76 | + render(<DashboardGridLayout schema={mockSchema} />); |
| 77 | + |
| 78 | + const editButton = screen.getByRole('button', { name: /edit/i }); |
| 79 | + expect(editButton).toBeInTheDocument(); |
| 80 | + }); |
| 81 | + |
| 82 | + it('should toggle edit mode when edit button is clicked', () => { |
| 83 | + render(<DashboardGridLayout schema={mockSchema} />); |
| 84 | + |
| 85 | + const editButton = screen.getByRole('button', { name: /edit/i }); |
| 86 | + fireEvent.click(editButton); |
| 87 | + |
| 88 | + // In edit mode, should show Save and Cancel buttons |
| 89 | + expect(screen.getByRole('button', { name: /save/i })).toBeInTheDocument(); |
| 90 | + expect(screen.getByRole('button', { name: /cancel/i })).toBeInTheDocument(); |
| 91 | + }); |
| 92 | + |
| 93 | + it('should save layout to localStorage when save button is clicked', () => { |
| 94 | + render(<DashboardGridLayout schema={mockSchema} persistLayoutKey="test-layout" />); |
| 95 | + |
| 96 | + const editButton = screen.getByRole('button', { name: /edit/i }); |
| 97 | + fireEvent.click(editButton); |
| 98 | + |
| 99 | + const saveButton = screen.getByRole('button', { name: /save/i }); |
| 100 | + fireEvent.click(saveButton); |
| 101 | + |
| 102 | + // Check that layout was saved to localStorage |
| 103 | + const saved = localStorageMock.getItem('test-layout'); |
| 104 | + expect(saved).toBeTruthy(); |
| 105 | + }); |
| 106 | + |
| 107 | + it('should restore layout from localStorage', () => { |
| 108 | + const savedLayout = { |
| 109 | + lg: [ |
| 110 | + { i: 'widget-1', x: 0, y: 0, w: 3, h: 2 }, |
| 111 | + { i: 'widget-2', x: 3, y: 0, w: 6, h: 4 }, |
| 112 | + ], |
| 113 | + }; |
| 114 | + |
| 115 | + localStorageMock.setItem('test-layout', JSON.stringify(savedLayout)); |
| 116 | + |
| 117 | + render(<DashboardGridLayout schema={mockSchema} persistLayoutKey="test-layout" />); |
| 118 | + |
| 119 | + // Component should render with saved layout |
| 120 | + expect(screen.getByText('Test Dashboard')).toBeInTheDocument(); |
| 121 | + }); |
| 122 | + |
| 123 | + it('should call onLayoutChange when layout changes', () => { |
| 124 | + const onLayoutChange = vi.fn(); |
| 125 | + render(<DashboardGridLayout schema={mockSchema} onLayoutChange={onLayoutChange} />); |
| 126 | + |
| 127 | + // Trigger layout change (this would normally happen through drag/drop) |
| 128 | + // In our mock, we can't easily trigger this, but we verify the callback exists |
| 129 | + expect(onLayoutChange).toBeDefined(); |
| 130 | + }); |
| 131 | + |
| 132 | + it('should cancel edit mode when cancel button is clicked', () => { |
| 133 | + render(<DashboardGridLayout schema={mockSchema} />); |
| 134 | + |
| 135 | + const editButton = screen.getByRole('button', { name: /edit/i }); |
| 136 | + fireEvent.click(editButton); |
| 137 | + |
| 138 | + const cancelButton = screen.getByRole('button', { name: /cancel/i }); |
| 139 | + fireEvent.click(cancelButton); |
| 140 | + |
| 141 | + // Should exit edit mode |
| 142 | + expect(screen.getByRole('button', { name: /edit/i })).toBeInTheDocument(); |
| 143 | + expect(screen.queryByRole('button', { name: /save/i })).not.toBeInTheDocument(); |
| 144 | + }); |
| 145 | + |
| 146 | + it('should reset layout when reset button is clicked', () => { |
| 147 | + render(<DashboardGridLayout schema={mockSchema} />); |
| 148 | + |
| 149 | + const editButton = screen.getByRole('button', { name: /edit/i }); |
| 150 | + fireEvent.click(editButton); |
| 151 | + |
| 152 | + // Look for reset button (might be in a dropdown or menu) |
| 153 | + const buttons = screen.getAllByRole('button'); |
| 154 | + const resetButton = buttons.find(btn => btn.textContent?.includes('Reset')); |
| 155 | + |
| 156 | + if (resetButton) { |
| 157 | + fireEvent.click(resetButton); |
| 158 | + } |
| 159 | + }); |
| 160 | + |
| 161 | + it('should render grid layout container', () => { |
| 162 | + render(<DashboardGridLayout schema={mockSchema} />); |
| 163 | + |
| 164 | + const gridLayout = screen.getByTestId('grid-layout'); |
| 165 | + expect(gridLayout).toBeInTheDocument(); |
| 166 | + }); |
| 167 | + |
| 168 | + it('should handle empty widgets array', () => { |
| 169 | + const emptySchema: DashboardSchema = { |
| 170 | + type: 'dashboard', |
| 171 | + name: 'empty_dashboard', |
| 172 | + title: 'Empty Dashboard', |
| 173 | + widgets: [], |
| 174 | + }; |
| 175 | + |
| 176 | + const { container } = render(<DashboardGridLayout schema={emptySchema} />); |
| 177 | + expect(container).toBeTruthy(); |
| 178 | + }); |
| 179 | + |
| 180 | + it('should apply custom className', () => { |
| 181 | + const { container } = render( |
| 182 | + <DashboardGridLayout schema={mockSchema} className="custom-class" /> |
| 183 | + ); |
| 184 | + |
| 185 | + const dashboardContainer = container.querySelector('.custom-class'); |
| 186 | + expect(dashboardContainer).toBeTruthy(); |
| 187 | + }); |
| 188 | + |
| 189 | + it('should render drag handles in edit mode', () => { |
| 190 | + render(<DashboardGridLayout schema={mockSchema} />); |
| 191 | + |
| 192 | + const editButton = screen.getByRole('button', { name: /edit/i }); |
| 193 | + fireEvent.click(editButton); |
| 194 | + |
| 195 | + // In edit mode, widgets should have drag handles (GripVertical icons) |
| 196 | + const gripIcons = container.querySelectorAll('svg'); |
| 197 | + expect(gripIcons.length).toBeGreaterThan(0); |
| 198 | + }); |
| 199 | +}); |
0 commit comments