github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-04-10 03:01:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

refactor: use DEBUG_PREVIEW_IMAGE env var

Browse Source
This commit is contained in:
Samuel Maddock
2025-01-22 19:07:52 -05:00
parent 5b32118711
commit 213328f00e
2 changed files with 10 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
spec/api-browser-window-spec.ts
View File

@@ -1,4 +1,4 @@
import { NativeImage, nativeImage } from 'electron';
import { nativeImage } from 'electron';
import { app, BrowserWindow, BrowserView, dialog, ipcMain, OnBeforeSendHeadersListenerDetails, net, protocol, screen, webContents, webFrameMain, session, WebContents, WebFrameMain } from 'electron/main';
import { expect } from 'chai';
@@ -16,7 +16,7 @@ import { setTimeout } from 'node:timers/promises';
import * as nodeUrl from 'node:url';
import { emittedUntil, emittedNTimes } from './lib/events-helpers';
import { previewNativeImage } from './lib/image-helpers';
import { debugPreviewImage } from './lib/image-helpers';
import { HexColors, hasCapturableScreen, ScreenCapture, getPixelColor } from './lib/screen-helpers';
import { ifit, ifdescribe, defer, listen, waitUntil } from './lib/spec-helpers';
import { closeWindow, closeAllWindows } from './lib/window-helpers';
@@ -6440,9 +6440,6 @@ describe('BrowserWindow module', () => {
});
describe('offscreen rendering', () => {
// Toggle to display windows previewing OSR NativeImage results
const DEBUG_OFFSCREEN = false;
let w: BrowserWindow;
beforeEach(function () {
w = new BrowserWindow({
@@ -6457,19 +6454,13 @@ describe('BrowserWindow module', () => {
});
afterEach(closeAllWindows);
const preview = async (image: NativeImage) => {
if (DEBUG_OFFSCREEN) {
await previewNativeImage(image);
}
};
it('creates offscreen window with correct size', async () => {
const paint = once(w.webContents, 'paint') as Promise<[any, Electron.Rectangle, Electron.NativeImage]>;
w.loadFile(path.join(fixtures, 'api', 'offscreen-rendering.html'));
const [, , data] = await paint;
expect(data.constructor.name).to.equal('NativeImage');
expect(data.isEmpty()).to.be.false('data is empty');
await preview(data);
await debugPreviewImage(data);
const size = data.getSize();
const { scaleFactor } = screen.getPrimaryDisplay();
expect(size.width).to.be.closeTo(100 * scaleFactor, 2);
@@ -6481,7 +6472,7 @@ describe('BrowserWindow module', () => {
const paint = once(w.webContents, 'paint') as Promise<[any, Electron.Rectangle, Electron.NativeImage]>;
w.loadFile(path.join(fixtures, 'api', 'offscreen-rendering.html'));
const [, , data] = await paint;
await preview(data);
await debugPreviewImage(data);
expect(getPixelColor(data, { x: 0, y: 0 }, true)).to.equal('#ff0000ff');
});
@@ -6490,7 +6481,7 @@ describe('BrowserWindow module', () => {
const paint = once(w.webContents, 'paint') as Promise<[any, Electron.Rectangle, Electron.NativeImage]>;
w.loadFile(path.join(fixtures, 'api', 'offscreen-rendering.html'));
const [, , data] = await paint;
await preview(data);
await debugPreviewImage(data);
expect(getPixelColor(data, { x: 0, y: 0 }, true)).to.equal(HexColors.TRANSPARENT);
});
@@ -6501,7 +6492,7 @@ describe('BrowserWindow module', () => {
const paint = once(w.webContents, 'paint') as Promise<[any, Electron.Rectangle, Electron.NativeImage]>;
w.loadFile(path.join(fixtures, 'api', 'offscreen-rendering.html'));
const [, , data] = await paint;
await preview(data);
await debugPreviewImage(data);
expect(getPixelColor(data, { x: 0, y: 0 }, true)).to.equal(bgColor);
});

5
spec/lib/image-helpers.ts
View File

@@ -5,8 +5,11 @@ import { once } from 'node:events';
/**
* Opens a window to display a native image. Useful for quickly debugging tests
* rather than writing a file and opening manually.
*
* Set the `DEBUG_PREVIEW_IMAGE` environment variable to show previews.
*/
export async function previewNativeImage (image: NativeImage) {
export async function debugPreviewImage (image: NativeImage) {
if (!process.env.DEBUG_PREVIEW_IMAGE) return;
const previewWindow = new BaseWindow({
title: 'NativeImage preview',
backgroundColor: '#444444'