Refactor ModalContext tests

This commit is contained in:
2025-06-04 20:48:38 +02:00
parent 73653c4271
commit 3276fd98c2

View File

@@ -12,6 +12,25 @@ const createWrapper = () => {
return Wrapper;
};
// Modal field pairs for parameterized testing
const modalFieldPairs = [
{ field: 'newFileModalVisible', setter: 'setNewFileModalVisible' },
{ field: 'deleteFileModalVisible', setter: 'setDeleteFileModalVisible' },
{
field: 'commitMessageModalVisible',
setter: 'setCommitMessageModalVisible',
},
{ field: 'settingsModalVisible', setter: 'setSettingsModalVisible' },
{
field: 'switchWorkspaceModalVisible',
setter: 'setSwitchWorkspaceModalVisible',
},
{
field: 'createWorkspaceModalVisible',
setter: 'setCreateWorkspaceModalVisible',
},
] as const;
describe('ModalContext', () => {
beforeEach(() => {
vi.clearAllMocks();
@@ -22,64 +41,37 @@ describe('ModalContext', () => {
});
describe('ModalProvider', () => {
it('provides modal context with initial false values', () => {
it('provides modal context with initial false values and all setter functions', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
expect(result.current.newFileModalVisible).toBe(false);
expect(result.current.deleteFileModalVisible).toBe(false);
expect(result.current.commitMessageModalVisible).toBe(false);
expect(result.current.settingsModalVisible).toBe(false);
expect(result.current.switchWorkspaceModalVisible).toBe(false);
expect(result.current.createWorkspaceModalVisible).toBe(false);
// All modal states should be false initially and setters should be functions
modalFieldPairs.forEach(({ field, setter }) => {
expect(result.current[field]).toBe(false);
expect(typeof result.current[setter]).toBe('function');
});
});
it('provides all setter functions', () => {
it('maintains function stability across re-renders', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
expect(typeof result.current.setNewFileModalVisible).toBe('function');
expect(typeof result.current.setDeleteFileModalVisible).toBe('function');
expect(typeof result.current.setCommitMessageModalVisible).toBe(
'function'
);
expect(typeof result.current.setSettingsModalVisible).toBe('function');
expect(typeof result.current.setSwitchWorkspaceModalVisible).toBe(
'function'
);
expect(typeof result.current.setCreateWorkspaceModalVisible).toBe(
'function'
);
const { result, rerender } = renderHook(() => useModalContext(), {
wrapper,
});
it('provides complete context interface', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
const initialSetters = modalFieldPairs.map(
({ setter }) => result.current[setter]
);
const expectedKeys = [
'newFileModalVisible',
'setNewFileModalVisible',
'deleteFileModalVisible',
'setDeleteFileModalVisible',
'commitMessageModalVisible',
'setCommitMessageModalVisible',
'settingsModalVisible',
'setSettingsModalVisible',
'switchWorkspaceModalVisible',
'setSwitchWorkspaceModalVisible',
'createWorkspaceModalVisible',
'setCreateWorkspaceModalVisible',
];
rerender();
expectedKeys.forEach((key) => {
expect(key in result.current).toBe(true);
modalFieldPairs.forEach(({ setter }, index) => {
expect(result.current[setter]).toBe(initialSetters[index]);
});
});
});
describe('useModalContext hook', () => {
it('throws error when used outside ModalProvider', () => {
// Suppress console.error for this test since we expect an error
const consoleSpy = vi
.spyOn(console, 'error')
.mockImplementation(() => {});
@@ -91,251 +83,61 @@ describe('ModalContext', () => {
consoleSpy.mockRestore();
});
it('returns modal context when used within provider', () => {
it('returns complete context interface', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
expect(result.current).toBeDefined();
expect(typeof result.current).toBe('object');
modalFieldPairs.forEach(({ field, setter }) => {
expect(field in result.current).toBe(true);
expect(setter in result.current).toBe(true);
});
it('maintains function stability across re-renders', () => {
const wrapper = createWrapper();
const { result, rerender } = renderHook(() => useModalContext(), {
wrapper,
});
const initialSetters = {
setNewFileModalVisible: result.current.setNewFileModalVisible,
setDeleteFileModalVisible: result.current.setDeleteFileModalVisible,
setCommitMessageModalVisible:
result.current.setCommitMessageModalVisible,
setSettingsModalVisible: result.current.setSettingsModalVisible,
setSwitchWorkspaceModalVisible:
result.current.setSwitchWorkspaceModalVisible,
setCreateWorkspaceModalVisible:
result.current.setCreateWorkspaceModalVisible,
};
rerender();
expect(result.current.setNewFileModalVisible).toBe(
initialSetters.setNewFileModalVisible
);
expect(result.current.setDeleteFileModalVisible).toBe(
initialSetters.setDeleteFileModalVisible
);
expect(result.current.setCommitMessageModalVisible).toBe(
initialSetters.setCommitMessageModalVisible
);
expect(result.current.setSettingsModalVisible).toBe(
initialSetters.setSettingsModalVisible
);
expect(result.current.setSwitchWorkspaceModalVisible).toBe(
initialSetters.setSwitchWorkspaceModalVisible
);
expect(result.current.setCreateWorkspaceModalVisible).toBe(
initialSetters.setCreateWorkspaceModalVisible
);
});
});
describe('modal state management', () => {
describe('newFileModalVisible', () => {
it('can be set to true', () => {
// Test all modals with the same pattern using parameterized tests
modalFieldPairs.forEach(({ field, setter }) => {
describe(field, () => {
it('can be toggled true and false', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
// Set to true
act(() => {
result.current.setNewFileModalVisible(true);
result.current[setter](true);
});
expect(result.current[field]).toBe(true);
// Set to false
act(() => {
result.current[setter](false);
});
expect(result.current[field]).toBe(false);
});
expect(result.current.newFileModalVisible).toBe(true);
});
it('can be toggled back to false', () => {
it('supports function updater pattern', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
// Toggle using function updater
act(() => {
result.current.setNewFileModalVisible(true);
result.current[setter]((prev) => !prev);
});
expect(result.current[field]).toBe(true);
act(() => {
result.current.setNewFileModalVisible(false);
result.current[setter]((prev) => !prev);
});
expect(result.current.newFileModalVisible).toBe(false);
});
it('can be toggled multiple times', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
act(() => {
result.current.setNewFileModalVisible(true);
});
expect(result.current.newFileModalVisible).toBe(true);
act(() => {
result.current.setNewFileModalVisible(false);
});
expect(result.current.newFileModalVisible).toBe(false);
act(() => {
result.current.setNewFileModalVisible(true);
});
expect(result.current.newFileModalVisible).toBe(true);
});
});
describe('deleteFileModalVisible', () => {
it('can be set to true', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
act(() => {
result.current.setDeleteFileModalVisible(true);
});
expect(result.current.deleteFileModalVisible).toBe(true);
});
it('can be toggled back to false', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
act(() => {
result.current.setDeleteFileModalVisible(true);
});
act(() => {
result.current.setDeleteFileModalVisible(false);
});
expect(result.current.deleteFileModalVisible).toBe(false);
});
});
describe('commitMessageModalVisible', () => {
it('can be set to true', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
act(() => {
result.current.setCommitMessageModalVisible(true);
});
expect(result.current.commitMessageModalVisible).toBe(true);
});
it('can be toggled back to false', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
act(() => {
result.current.setCommitMessageModalVisible(true);
});
act(() => {
result.current.setCommitMessageModalVisible(false);
});
expect(result.current.commitMessageModalVisible).toBe(false);
});
});
describe('settingsModalVisible', () => {
it('can be set to true', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
act(() => {
result.current.setSettingsModalVisible(true);
});
expect(result.current.settingsModalVisible).toBe(true);
});
it('can be toggled back to false', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
act(() => {
result.current.setSettingsModalVisible(true);
});
act(() => {
result.current.setSettingsModalVisible(false);
});
expect(result.current.settingsModalVisible).toBe(false);
});
});
describe('switchWorkspaceModalVisible', () => {
it('can be set to true', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
act(() => {
result.current.setSwitchWorkspaceModalVisible(true);
});
expect(result.current.switchWorkspaceModalVisible).toBe(true);
});
it('can be toggled back to false', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
act(() => {
result.current.setSwitchWorkspaceModalVisible(true);
});
act(() => {
result.current.setSwitchWorkspaceModalVisible(false);
});
expect(result.current.switchWorkspaceModalVisible).toBe(false);
});
});
describe('createWorkspaceModalVisible', () => {
it('can be set to true', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
act(() => {
result.current.setCreateWorkspaceModalVisible(true);
});
expect(result.current.createWorkspaceModalVisible).toBe(true);
});
it('can be toggled back to false', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
act(() => {
result.current.setCreateWorkspaceModalVisible(true);
});
act(() => {
result.current.setCreateWorkspaceModalVisible(false);
});
expect(result.current.createWorkspaceModalVisible).toBe(false);
expect(result.current[field]).toBe(false);
});
});
});
describe('independent modal state', () => {
it('each modal state is independent', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
// Set multiple modals to true
// Set first three modals to true
act(() => {
result.current.setNewFileModalVisible(true);
result.current.setDeleteFileModalVisible(true);
@@ -354,14 +156,11 @@ describe('ModalContext', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
// Set all modals to true first
// Set all modals to true
act(() => {
result.current.setNewFileModalVisible(true);
result.current.setDeleteFileModalVisible(true);
result.current.setCommitMessageModalVisible(true);
result.current.setSettingsModalVisible(true);
result.current.setSwitchWorkspaceModalVisible(true);
result.current.setCreateWorkspaceModalVisible(true);
modalFieldPairs.forEach(({ setter }) => {
result.current[setter](true);
});
});
// Toggle one modal off
@@ -370,51 +169,13 @@ describe('ModalContext', () => {
});
expect(result.current.newFileModalVisible).toBe(false);
expect(result.current.deleteFileModalVisible).toBe(true);
expect(result.current.commitMessageModalVisible).toBe(true);
expect(result.current.settingsModalVisible).toBe(true);
expect(result.current.switchWorkspaceModalVisible).toBe(true);
expect(result.current.createWorkspaceModalVisible).toBe(true);
// All others should remain true
modalFieldPairs.slice(1).forEach(({ field }) => {
expect(result.current[field]).toBe(true);
});
});
describe('useState setter function behavior', () => {
it('handles function updater pattern', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
// Test function updater for toggling
act(() => {
result.current.setNewFileModalVisible((prev) => !prev);
});
expect(result.current.newFileModalVisible).toBe(true);
act(() => {
result.current.setNewFileModalVisible((prev) => !prev);
});
expect(result.current.newFileModalVisible).toBe(false);
});
it('handles conditional updates with function updater', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
// Set to true first
act(() => {
result.current.setSettingsModalVisible(true);
});
// Use function updater with condition
act(() => {
result.current.setSettingsModalVisible((prev) => (prev ? false : true));
});
expect(result.current.settingsModalVisible).toBe(false);
});
it('supports multiple rapid state updates', () => {
it('supports rapid state updates', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
@@ -454,205 +215,4 @@ describe('ModalContext', () => {
expect(result.current.newFileModalVisible).toBe(true);
});
});
describe('context value structure', () => {
it('provides expected context interface', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
const expectedBooleanValues = {
newFileModalVisible: false,
deleteFileModalVisible: false,
commitMessageModalVisible: false,
settingsModalVisible: false,
switchWorkspaceModalVisible: false,
createWorkspaceModalVisible: false,
};
// Check the boolean values
Object.entries(expectedBooleanValues).forEach(([key, value]) => {
expect(result.current[key as keyof typeof result.current]).toBe(value);
});
// Check the setter functions exist
expect(typeof result.current.setNewFileModalVisible).toBe('function');
expect(typeof result.current.setDeleteFileModalVisible).toBe('function');
expect(typeof result.current.setCommitMessageModalVisible).toBe(
'function'
);
expect(typeof result.current.setSettingsModalVisible).toBe('function');
expect(typeof result.current.setSwitchWorkspaceModalVisible).toBe(
'function'
);
expect(typeof result.current.setCreateWorkspaceModalVisible).toBe(
'function'
);
});
it('all boolean values have correct types', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
expect(typeof result.current.newFileModalVisible).toBe('boolean');
expect(typeof result.current.deleteFileModalVisible).toBe('boolean');
expect(typeof result.current.commitMessageModalVisible).toBe('boolean');
expect(typeof result.current.settingsModalVisible).toBe('boolean');
expect(typeof result.current.switchWorkspaceModalVisible).toBe('boolean');
expect(typeof result.current.createWorkspaceModalVisible).toBe('boolean');
});
it('all setter functions have correct types', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
expect(typeof result.current.setNewFileModalVisible).toBe('function');
expect(typeof result.current.setDeleteFileModalVisible).toBe('function');
expect(typeof result.current.setCommitMessageModalVisible).toBe(
'function'
);
expect(typeof result.current.setSettingsModalVisible).toBe('function');
expect(typeof result.current.setSwitchWorkspaceModalVisible).toBe(
'function'
);
expect(typeof result.current.setCreateWorkspaceModalVisible).toBe(
'function'
);
});
});
describe('performance considerations', () => {
it('does not cause unnecessary re-renders', () => {
const wrapper = createWrapper();
const { result, rerender } = renderHook(() => useModalContext(), {
wrapper,
});
const initialContext = result.current;
// Re-render without changing anything
rerender();
// All function references should be stable
expect(result.current.setNewFileModalVisible).toBe(
initialContext.setNewFileModalVisible
);
expect(result.current.setDeleteFileModalVisible).toBe(
initialContext.setDeleteFileModalVisible
);
expect(result.current.setCommitMessageModalVisible).toBe(
initialContext.setCommitMessageModalVisible
);
expect(result.current.setSettingsModalVisible).toBe(
initialContext.setSettingsModalVisible
);
expect(result.current.setSwitchWorkspaceModalVisible).toBe(
initialContext.setSwitchWorkspaceModalVisible
);
expect(result.current.setCreateWorkspaceModalVisible).toBe(
initialContext.setCreateWorkspaceModalVisible
);
});
it('maintains setter function stability after state changes', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
const initialSetters = {
setNewFileModalVisible: result.current.setNewFileModalVisible,
setDeleteFileModalVisible: result.current.setDeleteFileModalVisible,
};
// Change some state
act(() => {
result.current.setNewFileModalVisible(true);
result.current.setDeleteFileModalVisible(true);
});
// Function references should still be the same
expect(result.current.setNewFileModalVisible).toBe(
initialSetters.setNewFileModalVisible
);
expect(result.current.setDeleteFileModalVisible).toBe(
initialSetters.setDeleteFileModalVisible
);
});
});
describe('real-world usage patterns', () => {
it('supports common modal workflow patterns', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
// Typical workflow: open modal, perform action, close modal
act(() => {
result.current.setNewFileModalVisible(true);
});
expect(result.current.newFileModalVisible).toBe(true);
// User performs action (file creation), then modal closes
act(() => {
result.current.setNewFileModalVisible(false);
});
expect(result.current.newFileModalVisible).toBe(false);
});
it('supports opening multiple modals in sequence', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
// Open new file modal
act(() => {
result.current.setNewFileModalVisible(true);
});
// Close new file modal, open settings
act(() => {
result.current.setNewFileModalVisible(false);
result.current.setSettingsModalVisible(true);
});
expect(result.current.newFileModalVisible).toBe(false);
expect(result.current.settingsModalVisible).toBe(true);
// Close settings, open workspace creation
act(() => {
result.current.setSettingsModalVisible(false);
result.current.setCreateWorkspaceModalVisible(true);
});
expect(result.current.settingsModalVisible).toBe(false);
expect(result.current.createWorkspaceModalVisible).toBe(true);
});
it('supports modal state reset pattern', () => {
const wrapper = createWrapper();
const { result } = renderHook(() => useModalContext(), { wrapper });
// Open multiple modals
act(() => {
result.current.setNewFileModalVisible(true);
result.current.setSettingsModalVisible(true);
result.current.setDeleteFileModalVisible(true);
});
// Reset all to false (like on route change or logout)
act(() => {
result.current.setNewFileModalVisible(false);
result.current.setSettingsModalVisible(false);
result.current.setDeleteFileModalVisible(false);
result.current.setCommitMessageModalVisible(false);
result.current.setSwitchWorkspaceModalVisible(false);
result.current.setCreateWorkspaceModalVisible(false);
});
expect(result.current.newFileModalVisible).toBe(false);
expect(result.current.settingsModalVisible).toBe(false);
expect(result.current.deleteFileModalVisible).toBe(false);
expect(result.current.commitMessageModalVisible).toBe(false);
expect(result.current.switchWorkspaceModalVisible).toBe(false);
expect(result.current.createWorkspaceModalVisible).toBe(false);
});
});
});