1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406import * as path from 'path';
import * as childProcess from 'child_process';
import { type Browser, chromium, Page } from '@playwright/test';
import { major } from '@mui/material/version';
import fs from 'node:fs/promises';
const isMaterialUIv6 = major === 6;
// Tests that need a longer timeout.
const timeSensitiveSuites = [
'ColumnAutosizingAsync',
'DensitySelectorGrid',
'DataGridOverlays',
'GridToolbarFilterBar',
'ColumnSpanningDerived',
'PopularFeaturesDemo',
'ServerSideRowGroupingGroupExpansion',
'RowSpanningClassSchedule',
'ListView',
'RowSpanningCalendar',
];
await main();
async function main() {
const screenshotDir = path.resolve(import.meta.dirname, './screenshots/chrome');
const browser = await chromium.launch({
args: [
// We could add the hide-scrollbars flag, which should improve argos
// flaky tests based on the scrollbars.
// '--hide-scrollbars',
],
headless: false,
});
let page = await newTestPage(browser);
let errorConsole: string | undefined;
page.on('console', (msg) => {
// Filter out native user-agent errors e.g. "Failed to load resource: net::ERR_FAILED"
if (msg.args().length > 0 && (msg.type() === 'error' || msg.type() === 'warning')) {
errorConsole = msg.text();
}
});
// prepare screenshots
await emptyDir(screenshotDir);
const routes = await page.evaluate(() => window.muiFixture.allTests);
async function navigateToTest(route: string) {
// Use client-side routing which is much faster than full page navigation via page.goto().
return page.evaluate((_route) => {
window.muiFixture.navigate(_route);
}, route);
}
describe('visual regressions', () => {
afterAll(async () => {
await browser.close();
});
it('should have no errors after the initial render', () => {
const msg = errorConsole;
errorConsole = undefined;
if (isConsoleWarningIgnored(msg)) {
return;
}
expect(msg).to.equal(undefined);
});
const getTimeout = (route: { url: string }) => {
// With the playwright inspector we might want to call `page.pause` which would lead to a timeout.
if (process.env.PWDEBUG) {
return 0;
}
// Some routes are more complex and take longer to render.
if (route.url.includes('DataGridProDemo')) {
return 6000;
}
return undefined;
};
routes.forEach((route) => {
it(
`creates screenshots of ${route.url}`,
{
timeout: getTimeout(route),
},
async () => {
if (/^\/docs-charts-tooltip\/Interaction/.test(route.url)) {
// Ignore tooltip interaction demo screenshot.
// There is a dedicated test for it in this file, and this is why we don't exclude it with the glob pattern in test/regressions/testsBySuite.ts
return;
}
await navigateToTest(route.url);
// Move cursor offscreen to not trigger unwanted hover effects.
await page.mouse.move(0, 0);
const screenshotPath = path.resolve(screenshotDir, `.${route.url}.png`);
const testcase = await page.waitForSelector(
`[data-testid="testcase"][data-testpath="${route.url}"]:not([aria-busy="true"])`,
);
await page.evaluate(async () => {
const images = document.querySelectorAll('img');
if (images.length <= 0) {
return;
}
const promises = [];
for (const img of images) {
if (img.complete) {
continue;
}
if (img.loading === 'lazy') {
// Force lazy-loaded images to load
img.setAttribute('loading', 'eager');
}
const { promise, resolve, reject } = Promise.withResolvers<void>();
img.onload = () => resolve();
img.onerror = reject;
promises.push(promise);
}
await Promise.all(promises);
});
if (/^\/docs-charts-.*/.test(route.url)) {
// Run one tick of the clock to get the final animation state
await sleep(10);
}
if (timeSensitiveSuites.some((suite) => route.url.includes(suite))) {
await sleep(100);
}
// Wait for the page to settle after taking the screenshot.
await page.waitForLoadState();
await testcase.screenshot({ path: screenshotPath, type: 'png' });
},
);
it(`should have no errors rendering ${route.url}`, () => {
const msg = errorConsole;
errorConsole = undefined;
if (isConsoleWarningIgnored(msg)) {
return;
}
expect(msg).to.equal(undefined);
});
});
it('should position the headers matching the columns', async () => {
const route = '/docs-data-grid-virtualization/ColumnVirtualizationGrid';
const screenshotPath = path.resolve(screenshotDir, `.${route}ScrollLeft400px.png`);
await navigateToTest(route);
const testcase = await page.waitForSelector(
`[data-testid="testcase"][data-testpath="${route}"]:not([aria-busy="true"])`,
);
await sleep(100);
await page.evaluate(() => {
const virtualScroller = document.querySelector('.MuiDataGrid-virtualScroller');
if (!virtualScroller) {
throw new Error('missing virtualScroller');
}
virtualScroller.scrollLeft = 400;
virtualScroller.dispatchEvent(new Event('scroll'));
});
await sleep(100);
await testcase.screenshot({ path: screenshotPath, type: 'png' });
});
it('should position charts axis tooltip 8px away from the pointer', async () => {
const route = '/docs-charts-tooltip/Interaction';
const axisScreenshotPath = path.resolve(screenshotDir, `.${route}AxisTooltip.png`);
await navigateToTest(route);
// Make sure demo got loaded
await page.waitForSelector(
`[data-testid="testcase"][data-testpath="${route}"]:not([aria-busy="true"])`,
);
const charts = await page.locator('svg').all();
await charts[0].click();
// Should also trigger the item in charts[1]. But did not succeed to trigger the react `onPointerEnter`
// Need to screenshot the body because the tooltip is outside of the testcase div
const body = await page.waitForSelector(`body`);
await body.screenshot({ path: axisScreenshotPath, type: 'png' });
});
it('should export a chart as PNG', async () => {
const route = '/docs-charts-export/ExportChartAsImage';
const screenshotPath = path.resolve(screenshotDir, `.${route}PNG.png`);
await navigateToTest(route);
const downloadPromise = page.waitForEvent('download');
await page.getByRole('button', { name: 'Export Image' }).click();
const download = await downloadPromise;
await download.saveAs(screenshotPath);
});
describe('print preview', () => {
/* These tests do not properly clean up after themselves, so moving them to their own describe block to close the
* page after every test. */
beforeEach(async () => {
page = await newTestPage(browser);
});
afterEach(async () => {
await page.close();
});
it('should take a screenshot of the data grid print preview', async () => {
const route = '/docs-data-grid-export/ExportDefaultToolbar';
const screenshotPath = path.resolve(screenshotDir, `.${route}Print.png`);
await navigateToTest(route);
// Click the export button in the toolbar.
await page.getByRole('button', { name: 'Export' }).click();
const printButton = page.getByRole('menuitem', { name: 'Print' });
// Click the print export option from the export menu in the toolbar.
// Trigger the action async because window.print() is blocking the main thread
// like window.alert() is.
setTimeout(() => {
printButton.click();
});
await sleep(5000);
await screenshotPrintDialogPreview(screenshotPath, {
x: 72,
y: 99,
width: 520,
height: 400,
});
});
it('should take a screenshot of the print export with dynamic row height', async () => {
const route = '/test-regressions-data-grid/PrintExportDynamicRowHeight';
const screenshotPath = path.resolve(screenshotDir, `.${route}Print.png`);
await navigateToTest(route);
// Click the export button in the toolbar.
await page.getByRole('button', { name: 'Export' }).click();
const printButton = page.getByRole('menuitem', { name: 'Print' });
// Click the print export option from the export menu in the toolbar.
// Trigger the action async because window.print() is blocking the main thread
// like window.alert() is.
setTimeout(() => {
printButton.click();
});
await sleep(5000);
await screenshotPrintDialogPreview(screenshotPath, {
x: 72,
y: 99,
width: 520,
height: 400,
});
});
it('should take a screenshot of the charts print preview', async () => {
const route = '/docs-charts-export/PrintChart';
const screenshotPath = path.resolve(screenshotDir, `.${route}Print.png`);
await navigateToTest(route);
const printButton = page.getByRole('button', { name: 'Print' });
// Trigger the action async because window.print() is blocking the main thread
// like window.alert() is.
setTimeout(() => {
printButton.click();
});
await sleep(4000);
await screenshotPrintDialogPreview(screenshotPath, {
x: 94,
y: 107,
width: 490,
height: 200,
});
});
});
});
}
function isConsoleWarningIgnored(msg?: string) {
const isMuiV6Error =
isMaterialUIv6 &&
msg?.startsWith(
'MUI: The Experimental_CssVarsProvider component has been ported into ThemeProvider.',
);
const isReactRouterFlagsError = msg?.includes('React Router Future Flag Warning');
const isNoDevRoute = msg?.includes('No routes matched location "/#no-dev"');
// We use the Tailwind CDN in iframed docs demos to isolate the library and avoid having to bundle it.
const isTailwindCdnWarning = msg?.includes(
'The browser build of Tailwind CSS should not be used in production.',
);
if (isMuiV6Error || isReactRouterFlagsError || isNoDevRoute || isTailwindCdnWarning) {
return true;
}
return false;
}
function sleep(timeoutMS: number | undefined) {
return new Promise((resolve) => {
setTimeout(resolve, timeoutMS);
});
}
function screenshotPrintDialogPreview(
screenshotPath: string,
{ x, y, width, height }: { x: number; y: number; width: number; height: number },
) {
return new Promise<void>((resolve, reject) => {
// See https://ffmpeg.org/ffmpeg-devices.html#x11grab
const args = `-y -f x11grab -framerate 1 -video_size ${width}x${height} -i :99.0+${x},${y} -vframes 1 ${screenshotPath}`;
const ffmpeg = childProcess.spawn('ffmpeg', args.split(' '));
ffmpeg.on('close', (code) => {
if (code === 0) {
resolve();
} else {
reject(new Error(`ffmpeg exited with code ${code}`));
}
});
});
}
async function newTestPage(browser: Browser): Promise<Page> {
// reuse viewport from `vrtest`
// https://github.com/nathanmarks/vrtest/blob/1185b852a6c1813cedf5d81f6d6843d9a241c1ce/src/server/runner.js#L44
const page = await browser.newPage({ viewport: { width: 1000, height: 700 } });
// Block images since they slow down tests (need download).
// They're also most likely decorative for documentation demos
await page.route(/./, async (route, request) => {
const type = request.resourceType();
// Block all images except the flags
if (type === 'image' && !request.url().startsWith('https://flagcdn.com')) {
route.abort();
} else {
route.continue();
}
});
// Skip animations
await page.emulateMedia({ reducedMotion: 'reduce' });
// Simulate portrait mode for date pickers.
// See `usePickerOrientation`.
await page.evaluate(() => {
Object.defineProperty(window.screen.orientation, 'angle', {
get() {
return 0;
},
});
});
const baseUrl = 'http://localhost:5001';
// Wait for all requests to finish.
// This should load shared resources such as fonts.
await page.goto(baseUrl, { waitUntil: 'networkidle' });
await page.waitForFunction(() => window.muiFixture?.isReady);
return page;
}
async function emptyDir(dir: string): Promise<void> {
await fs.mkdir(dir, { recursive: true });
const items = await fs.readdir(dir);
await Promise.all(items.map((item) => fs.rm(path.join(dir, item), { recursive: true })));
}