Skip to content

fix(devtools): do not throw if devtools are unavailable #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 9, 2025
Merged

fix(devtools): do not throw if devtools are unavailable #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
188 changes: 101 additions & 87 deletions apps/demo/e2e/devtools.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,98 +1,112 @@
import { test, expect } from '@playwright/test';
import { Action } from '@ngrx/store';

test('has title', async ({ page }) => {
await page.goto('');
test.describe('DevTools', () => {
test('DevTools do not throw an error when not available', async ({
page,
}) => {
await page.goto('');
const errors = [];
page.on('pageerror', (error) => errors.push(error));
await page.getByRole('link', { name: 'DevTools' }).click();
await expect(
page.getByRole('row', { name: 'Go for a walk' })
).toBeVisible();
});

await page.evaluate(() => {
window['devtoolsSpy'] = [];
test('DevTools are syncing state changes', async ({ page }) => {
await page.goto('');

window['__REDUX_DEVTOOLS_EXTENSION__'] = {
connect: () => {
return {
send: (data: Action) => {
window['devtoolsSpy'].push(data);
},
};
},
};
});
await page.getByRole('link', { name: 'DevTools' }).click();
await page
.getByRole('row', { name: 'Go for a walk' })
.getByRole('checkbox')
.click();
await page
.getByRole('row', { name: 'Exercise' })
.getByRole('checkbox')
.click();
await page.evaluate(() => {
window['devtoolsSpy'] = [];

await expect(
page.getByRole('region', { name: 'Go for a walk' })
).toBeVisible();
await expect(page.getByRole('region', { name: 'Exercise' })).toBeVisible();
window['__REDUX_DEVTOOLS_EXTENSION__'] = {
connect: () => {
return {
send: (data: Action) => {
window['devtoolsSpy'].push(data);
},
};
},
};
});
await page.getByRole('link', { name: 'DevTools' }).click();
await page
.getByRole('row', { name: 'Go for a walk' })
.getByRole('checkbox')
.click();
await page
.getByRole('row', { name: 'Exercise' })
.getByRole('checkbox')
.click();

await page
.getByRole('row', { name: 'Go for a walk' })
.getByRole('checkbox')
.click();
await page
.getByRole('row', { name: 'Exercise' })
.getByRole('checkbox')
.click();
await expect(
page.getByRole('region', { name: 'Go for a walk' })
).toBeVisible();
await expect(page.getByRole('region', { name: 'Exercise' })).toBeVisible();

await expect(
page.getByRole('region', { name: 'Go for a walk' })
).toBeHidden();
await expect(page.getByRole('region', { name: 'Exercise' })).toBeHidden();
await page
.getByRole('row', { name: 'Go for a walk' })
.getByRole('checkbox')
.click();
await page
.getByRole('row', { name: 'Exercise' })
.getByRole('checkbox')
.click();

const devtoolsActions = await page.evaluate(() => window['devtoolsSpy']);
await expect(
page.getByRole('region', { name: 'Go for a walk' })
).toBeHidden();
await expect(page.getByRole('region', { name: 'Exercise' })).toBeHidden();

expect(devtoolsActions).toEqual([
{
type: 'add todo',
},
{
type: 'select todo 1',
},
{
type: 'Store Update',
},
{
type: 'Store Update',
},
{
type: 'Store Update',
},
{
type: 'select todo 4',
},
{
type: 'Store Update',
},
{
type: 'Store Update',
},
{
type: 'Store Update',
},
{
type: 'select todo 1',
},
{
type: 'Store Update',
},
{
type: 'Store Update',
},
{
type: 'select todo 4',
},
{
type: 'Store Update',
},
{
type: 'Store Update',
},
]);
const devtoolsActions = await page.evaluate(() => window['devtoolsSpy']);

expect(devtoolsActions).toEqual([
{
type: 'add todo',
},
{
type: 'select todo 1',
},
{
type: 'Store Update',
},
{
type: 'Store Update',
},
{
type: 'Store Update',
},
{
type: 'select todo 4',
},
{
type: 'Store Update',
},
{
type: 'Store Update',
},
{
type: 'Store Update',
},
{
type: 'select todo 1',
},
{
type: 'Store Update',
},
{
type: 'Store Update',
},
{
type: 'select todo 4',
},
{
type: 'Store Update',
},
{
type: 'Store Update',
},
]);
});
});
2 changes: 1 addition & 1 deletion libs/ngrx-toolkit/src/lib/devtools/internal/devtools-syncer.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ export class DevtoolsSyncer implements OnDestroy {

const isToolkitAvailable = Boolean(window.__REDUX_DEVTOOLS_EXTENSION__);
if (!isToolkitAvailable) {
throw new Error(
console.info(
'NgRx Toolkit/DevTools: Redux DevTools Extension is not available.'
);
}
Expand Down
7 changes: 4 additions & 3 deletions libs/ngrx-toolkit/src/lib/devtools/tests/connecting.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ describe('connect & send', () => {
expect(connectSpy).toHaveBeenCalledTimes(0);
});

it('should not connect if it runs on the server', () => {
const { connectSpy } = setupExtensions(false);
expect(connectSpy).toHaveBeenCalledTimes(0);
it('should not throw if it runs on the server', () => {
setupExtensions(true, false);
const Store = signalStore({ providedIn: 'root' }, withDevtools('flight'));
expect(() => TestBed.inject(Store)).not.toThrowError();
});

it('should only send when store is initialized', () => {
Expand Down