-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
There was a bug where the flagsReady status, returned from the useFlagsStatus hook, remains false even when an already started Unleash client is passed to the Unleash flag provider. This occurred despite the client being initialized and ready.
- Loading branch information
Showing
5 changed files
with
149 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| import React from 'react'; | ||
| import { render, screen, waitFor } from '@testing-library/react'; | ||
| import useFlagsStatus from './useFlagsStatus'; | ||
| import FlagProvider from './FlagProvider'; | ||
| import { UnleashClient } from 'unleash-proxy-client'; | ||
|
|
||
| const TestComponent = () => { | ||
| const { flagsReady } = useFlagsStatus(); | ||
|
|
||
| return <div>{flagsReady ? 'flagsReady' : 'loading'}</div>; | ||
| }; | ||
|
|
||
| const ErrorTestComponent = () => { | ||
| const { flagsError } = useFlagsStatus(); | ||
|
|
||
| return <div>{flagsError ? 'flagsError' : 'no issue'}</div>; | ||
| }; | ||
|
|
||
|
|
||
| const mockClient = { | ||
| on: vi.fn(), | ||
| off: vi.fn(), | ||
| start: vi.fn(), | ||
| stop: vi.fn(), | ||
| updateContext: vi.fn(), | ||
| isEnabled: vi.fn(), | ||
| getVariant: vi.fn(), | ||
| isReady: vi.fn(), | ||
| } as unknown as UnleashClient; | ||
|
|
||
| test('should initialize', async () => { | ||
| const onEventHandler = (event: string, callback: () => void) => { | ||
| if (event === 'ready') { | ||
| callback(); | ||
| } | ||
| }; | ||
|
|
||
| mockClient.on = onEventHandler as typeof mockClient.on; | ||
|
|
||
| const ui = ( | ||
| <FlagProvider unleashClient={mockClient}> | ||
| <TestComponent /> | ||
| </FlagProvider> | ||
| ); | ||
|
|
||
| render(ui); | ||
|
|
||
| await waitFor(() => { | ||
| expect(screen.queryByText('flagsReady')).toBeInTheDocument(); | ||
| }); | ||
| }); | ||
|
|
||
| // https://github.com/Unleash/proxy-client-react/issues/168 | ||
| test('should start when already initialized client is passed', async () => { | ||
| const client = new UnleashClient({ | ||
| url: 'http://localhost:4242/api', | ||
| fetch: async () => | ||
| new Promise((resolve) => { | ||
| setTimeout(() => | ||
| resolve({ | ||
| status: 200, | ||
| ok: true, | ||
| json: async () => ({ | ||
| toggles: [], | ||
| }), | ||
| headers: new Headers(), | ||
| }) | ||
| ); | ||
| }), | ||
| clientKey: '123', | ||
| appName: 'test', | ||
| }); | ||
| await client.start(); | ||
| expect(client.isReady()).toBe(true); | ||
|
|
||
| const ui = ( | ||
| <FlagProvider unleashClient={client}> | ||
| <TestComponent /> | ||
| </FlagProvider> | ||
| ); | ||
|
|
||
| render(ui); | ||
|
|
||
| await waitFor(() => { | ||
| expect(screen.queryByText('flagsReady')).toBeInTheDocument(); | ||
| }); | ||
| }); | ||
|
|
||
| test('should handle client errors', async () => { | ||
| const consoleError = vi.spyOn(console, 'error').mockImplementation(() => {}); | ||
|
|
||
| const client = new UnleashClient({ | ||
| url: 'http://localhost:4242/api', | ||
| fetch: async () => { | ||
| throw new Error('test error'); | ||
| }, | ||
| clientKey: '123', | ||
| appName: 'test', | ||
| }); | ||
|
|
||
| await client.start(); | ||
|
|
||
| const ui = ( | ||
| <FlagProvider unleashClient={client}> | ||
| <ErrorTestComponent /> | ||
| </FlagProvider> | ||
| ); | ||
|
|
||
| render(ui); | ||
|
|
||
| await waitFor(() => { | ||
| expect(screen.queryByText('flagsError')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| expect(consoleError).toHaveBeenCalledWith( | ||
| 'Unleash: unable to fetch feature toggles', | ||
| expect.any(Error) | ||
| ); | ||
| consoleError.mockRestore(); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters