Skip to content

Commit

Permalink
fix: full-reload only when file-routes.json is added/changed
Browse files Browse the repository at this point in the history
Fixes: #2277
  • Loading branch information
taefi committed Apr 3, 2024
1 parent bf9054d commit 0e0a1d6
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 3 deletions.
9 changes: 6 additions & 3 deletions packages/ts/file-router/src/vite-plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,15 @@ export default function vitePluginFileSystemRouter({

const changeListener = (file: string): void => {
if (!file.startsWith(dir)) {
if (file.endsWith('/generated/file-routes.json')) {
server.hot.send({ type: 'full-reload' });
}
return;
}

generateRuntimeFiles(_viewsDir, runtimeUrls, extensions, _logger)
.then(() => server.hot.send({ type: 'full-reload' }))
.catch((e: unknown) => _logger.error(String(e)));
generateRuntimeFiles(_viewsDir, runtimeUrls, extensions, _logger).catch((e: unknown) =>
_logger.error(String(e)),
);
};

server.watcher.on('add', changeListener);
Expand Down
58 changes: 58 additions & 0 deletions packages/ts/file-router/test/vite-plugin/vite-plugin.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
import { use } from '@esm-bundle/chai';
import chaiAsPromised from 'chai-as-promised';
// eslint-disable-next-line import/no-extraneous-dependencies
import { FSWatcher } from 'chokidar';
import sinon from 'sinon';
import sinonChai from 'sinon-chai';
import vitePluginFileSystemRouter from '../../src/vite-plugin';

use(chaiAsPromised);
use(sinonChai);

describe('@vaadin/hilla-file-router', () => {
describe('vite-plugin', () => {
const watcher = new FSWatcher();
const mockServer = {
hot: {
send: sinon.spy(),
},
watcher,
};
const plugin = vitePluginFileSystemRouter({ isDevMode: true });
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-expect-error
plugin.configResolved({
logger: { info: sinon.spy() },
root: '/path/to/project',
build: { outDir: '/path/to/project/dist' },
});
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-expect-error
plugin.configureServer(mockServer);

beforeEach(() => {
sinon.resetHistory();
});

it('should send full-reload only when file-routes.json is added', () => {
sinon.assert.notCalled(mockServer.hot.send);
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
mockServer.watcher.emit('add', '/path/to/generated/file-routes.json');
sinon.assert.calledWith(mockServer.hot.send, { type: 'full-reload' });
});

it('should send full-reload only when file-routes.json changes', () => {
sinon.assert.notCalled(mockServer.hot.send);
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
mockServer.watcher.emit('change', '/path/to/generated/file-routes.json');
sinon.assert.calledWith(mockServer.hot.send, { type: 'full-reload' });
});

it('should not send full-reload when other files change', () => {
sinon.assert.notCalled(mockServer.hot.send);
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
mockServer.watcher.emit('change', '/path/to/views/file.tsx');
sinon.assert.notCalled(mockServer.hot.send);
});
});
});

0 comments on commit 0e0a1d6

Please sign in to comment.