Skip to content

Commit ca14c09

Browse files
chore(mosaic): lint clock reads during render (#10641)
1 parent ce066ae commit ca14c09

5 files changed

Lines changed: 197 additions & 1 deletion

File tree

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
---

‎packages/mosaic/eslint/import-guards.test.mjs‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -580,6 +580,79 @@ describe('Mosaic effects', { timeout: 30_000 }, () => {
580580
});
581581
});
582582

583+
describe('Mosaic clock reads', { timeout: 30_000 }, () => {
584+
async function renderClockMessages(file, source) {
585+
const messages = await lintAt(file, source);
586+
expect(messages.find(message => message.fatal)).toBeUndefined();
587+
return messages.filter(message => message.ruleId === 'mosaic/no-render-clock').map(message => message.message);
588+
}
589+
590+
test('rejects a clock read in a hook body', async () => {
591+
expect(
592+
await renderClockMessages('src/hooks/sample.ts', 'export function useSample() { return Date.now(); }'),
593+
).toEqual([
594+
'Read the current time with useNow during render, so the server and the client agree. Date.now() and new Date() belong in effects, event handlers and machine actions.',
595+
]);
596+
});
597+
598+
test.each([
599+
['a component body', 'export function Sample() { const now = new Date(); return now.getTime(); }'],
600+
['an arrow hook', 'export const useSample = () => Date.now();'],
601+
[
602+
'a useState initializer',
603+
"import { useState } from 'react';\nexport function useSample() { return useState(() => Date.now())[0]; }",
604+
],
605+
[
606+
'a useState initializer reference',
607+
"import { useState } from 'react';\nexport function useSample() { return useState(Date.now)[0]; }",
608+
],
609+
[
610+
'a useMemo callback',
611+
"import { useMemo } from 'react';\nexport function useSample() { return useMemo(() => new Date(), []); }",
612+
],
613+
['a useRef value', "import { useRef } from 'react';\nexport function useSample() { return useRef(Date.now()); }"],
614+
['a map callback', 'export function useSample(items: number[]) { return items.map(item => item - Date.now()); }'],
615+
['an Array.from callback', 'export function useSample() { return Array.from([1], () => new Date()); }'],
616+
[
617+
'a forwardRef render',
618+
"import { forwardRef } from 'react';\nexport const Sample = forwardRef(() => { void Date.now(); return null; });",
619+
],
620+
])('rejects a clock read in %s', async (_name, source) => {
621+
expect(await renderClockMessages('src/hooks/sample.ts', source)).toHaveLength(1);
622+
});
623+
624+
test.each([
625+
[
626+
'an effect',
627+
"import { useEffect } from 'react';\nexport function useSample() { useEffect(() => { void Date.now(); }, []); }",
628+
],
629+
[
630+
'a named effect callback',
631+
"import { useEffect } from 'react';\nexport function Sample() { useEffect(function RecordTime() { void Date.now(); }, []); return null; }",
632+
],
633+
[
634+
'a useCallback',
635+
"import { useCallback } from 'react';\nexport function useSample() { return useCallback(() => Date.now(), []); }",
636+
],
637+
['an event handler', 'export function useSample() { return { onClick: () => new Date() }; }'],
638+
['a custom hook callback', 'export function useSample() { return usePendingAction(() => Date.now()); }'],
639+
['a timer', 'export function useSample() { return () => setTimeout(() => Date.now(), 0); }'],
640+
['a promise callback', 'export function useSample(load: Promise<void>) { void load.then(() => Date.now()); }'],
641+
['a plain function', 'export function unlockTime(seconds: number) { return Date.now() + seconds * 1000; }'],
642+
['a parsed date', 'export function useSample(value: string) { return new Date(value); }'],
643+
])('allows a clock read in %s', async (_name, source) => {
644+
expect(await renderClockMessages('src/hooks/sample.ts', source)).toEqual([]);
645+
});
646+
647+
test.each(['src/hooks/use-now.ts', 'src/mosaic-provider.tsx'])('allows the shared clock in %s', async file => {
648+
expect(await renderClockMessages(file, 'export function useSample() { return Date.now(); }')).toEqual([]);
649+
});
650+
651+
test('ignores test files', async () => {
652+
expect(await renderClockMessages(testFixture, 'export function useSample() { return Date.now(); }')).toEqual([]);
653+
});
654+
});
655+
583656
describe('Mosaic package configuration', () => {
584657
test('inherits repository rules and keeps Mosaic guards in the package', async () => {
585658
const configAt = async cwd => {

‎packages/mosaic/eslint/plugin.mjs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
import { forwardRefParts, noDynamicMessageCatalogs, noModelReactState, noRawInvoke } from './rules.mjs';
1+
import { forwardRefParts, noDynamicMessageCatalogs, noModelReactState, noRawInvoke, noRenderClock } from './rules.mjs';
22

33
export default {
44
rules: {
55
'no-model-react-state': noModelReactState,
66
'no-dynamic-message-catalogs': noDynamicMessageCatalogs,
77
'forward-ref-parts': forwardRefParts,
88
'no-raw-invoke': noRawInvoke,
9+
'no-render-clock': noRenderClock,
910
},
1011
};

‎packages/mosaic/eslint/rules.mjs‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -296,3 +296,110 @@ export const noRawInvoke = {
296296
};
297297
},
298298
};
299+
300+
export const noRenderClock = {
301+
meta: {
302+
type: 'problem',
303+
schema: [],
304+
messages: {
305+
useNow:
306+
'Read the current time with useNow during render, so the server and the client agree. Date.now() and new Date() belong in effects, event handlers and machine actions.',
307+
},
308+
},
309+
create(context) {
310+
return {
311+
CallExpression(node) {
312+
if (isDateNow(node.callee) && readsDuringRender(node)) {
313+
context.report({ node, messageId: 'useNow' });
314+
}
315+
},
316+
MemberExpression(node) {
317+
if (isDateNow(node) && isCallbackArgument(node) && !defersCallback(node.parent) && readsDuringRender(node)) {
318+
context.report({ node, messageId: 'useNow' });
319+
}
320+
},
321+
NewExpression(node) {
322+
if (isCurrentDate(node) && readsDuringRender(node)) {
323+
context.report({ node, messageId: 'useNow' });
324+
}
325+
},
326+
};
327+
},
328+
};
329+
330+
const RENDER_HOOKS = new Set(['useState', 'useMemo', 'useReducer']);
331+
const DEFERRED_CALLBACKS = new Set([
332+
'setTimeout',
333+
'setInterval',
334+
'requestAnimationFrame',
335+
'queueMicrotask',
336+
'addEventListener',
337+
'then',
338+
'catch',
339+
'finally',
340+
]);
341+
const RENDER_WRAPPERS = new Set(['forwardRef', 'memo']);
342+
343+
function readsDuringRender(node) {
344+
for (let fn = enclosingFunction(node); fn; fn = enclosingFunction(fn)) {
345+
if (!isCallbackArgument(fn)) {
346+
return /^(use[A-Z0-9]|[A-Z])/.test(functionName(fn) ?? '');
347+
}
348+
if (RENDER_WRAPPERS.has(calleeName(fn.parent))) {
349+
return true;
350+
}
351+
if (defersCallback(fn.parent)) {
352+
return false;
353+
}
354+
}
355+
return false;
356+
}
357+
358+
function isCallbackArgument(node) {
359+
return node.parent.type === 'CallExpression' && node.parent.arguments.includes(node);
360+
}
361+
362+
function defersCallback(call) {
363+
const name = calleeName(call) ?? '';
364+
return DEFERRED_CALLBACKS.has(name) || (/^use[A-Z]/.test(name) && !RENDER_HOOKS.has(name));
365+
}
366+
367+
function isDateNow(node) {
368+
return (
369+
node.type === 'MemberExpression' &&
370+
node.object.type === 'Identifier' &&
371+
node.object.name === 'Date' &&
372+
propertyName(node.property, node.computed) === 'now'
373+
);
374+
}
375+
376+
function isCurrentDate(node) {
377+
return node.callee.type === 'Identifier' && node.callee.name === 'Date' && node.arguments.length === 0;
378+
}
379+
380+
function enclosingFunction(node) {
381+
for (let current = node.parent; current; current = current.parent) {
382+
if (
383+
current.type === 'FunctionDeclaration' ||
384+
current.type === 'FunctionExpression' ||
385+
current.type === 'ArrowFunctionExpression'
386+
) {
387+
return current;
388+
}
389+
}
390+
return undefined;
391+
}
392+
393+
function calleeName(call) {
394+
if (call.callee.type === 'Identifier') {
395+
return call.callee.name;
396+
}
397+
return call.callee.type === 'MemberExpression' ? propertyName(call.callee.property, call.callee.computed) : undefined;
398+
}
399+
400+
function functionName(fn) {
401+
if (fn.id) {
402+
return fn.id.name;
403+
}
404+
return fn.parent.type === 'VariableDeclarator' && fn.parent.id.type === 'Identifier' ? fn.parent.id.name : undefined;
405+
}

‎packages/mosaic/oxlint.config.mjs‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,19 @@ export default defineConfig({
230230
'mosaic/no-raw-invoke': 'error',
231231
},
232232
},
233+
{
234+
files: ['src/**/*.{ts,tsx}'],
235+
excludeFiles: [
236+
'src/hooks/use-now.ts',
237+
'src/mosaic-provider.tsx',
238+
'src/**/__tests__/**',
239+
'src/**/*.test.{ts,tsx}',
240+
'src/**/*.test-d.{ts,tsx}',
241+
],
242+
rules: {
243+
'mosaic/no-render-clock': 'error',
244+
},
245+
},
233246
{
234247
files: ['src/features/**/*.{ts,tsx}'],
235248
excludeFiles: ['src/**/__tests__/**', 'src/**/*.test.{ts,tsx}', 'src/**/*.test-d.{ts,tsx}'],

0 commit comments

Comments
 (0)