Skip to content

Commit b4cebe8

Browse files
fix(desktop): skip auxiliary macOS snapshot windows (#12978)
Co-authored-by: Julius Marminge <[email protected]>
1 parent e676509 commit b4cebe8

2 files changed

Lines changed: 191 additions & 37 deletions

File tree

‎apps/desktop/src/snapShot/ActiveWindow.test.ts‎

Lines changed: 128 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,34 @@ function stubMacLookup(stdout: string) {
2828
);
2929
}
3030

31+
function macLookup(
32+
windows: ReadonlyArray<{
33+
id: number;
34+
title: string;
35+
bounds: { x: number; y: number; width: number; height: number };
36+
alpha?: number;
37+
}>,
38+
) {
39+
return JSON.stringify({
40+
owner: {
41+
name: "Editor",
42+
processId: 123,
43+
path: "/Applications/Editor.app",
44+
bundleId: "com.example.editor",
45+
},
46+
windows: windows.map((window) => ({ ...window, alpha: window.alpha ?? 1 })),
47+
});
48+
}
49+
3150
it("parses the frontmost macOS window from the osascript lookup", async () => {
3251
stubMacLookup(
33-
JSON.stringify({
34-
id: 42,
35-
title: "main.ts",
36-
bounds: { x: 10, y: 20, width: 800, height: 600 },
37-
owner: {
38-
name: "Editor",
39-
processId: 123,
40-
path: "/Applications/Editor.app",
41-
bundleId: "com.example.editor",
52+
macLookup([
53+
{
54+
id: 42,
55+
title: "main.ts",
56+
bounds: { x: 10, y: 20, width: 800, height: 600 },
4257
},
43-
}) + "\n",
58+
]) + "\n",
4459
);
4560

4661
const window = await activeWindow("darwin");
@@ -66,10 +81,15 @@ it("parses the frontmost macOS window from the osascript lookup", async () => {
6681
it("omits an empty macOS bundle identifier", async () => {
6782
stubMacLookup(
6883
JSON.stringify({
69-
id: 7,
70-
title: "",
71-
bounds: { x: 0, y: 0, width: 1, height: 1 },
7284
owner: { name: "cli", processId: 9, path: "", bundleId: "" },
85+
windows: [
86+
{
87+
id: 7,
88+
title: "",
89+
bounds: { x: 0, y: 0, width: 1, height: 1 },
90+
alpha: 1,
91+
},
92+
],
7393
}),
7494
);
7595

@@ -78,12 +98,107 @@ it("omits an empty macOS bundle identifier", async () => {
7898
assert.deepEqual(window?.owner, { name: "cli", processId: 9, path: "" });
7999
});
80100

101+
it.each([
102+
{
103+
name: "transparent and untitled helpers",
104+
helpers: [
105+
{
106+
id: 1,
107+
title: "",
108+
bounds: { x: -1, y: -44, width: 1_680, height: 44 },
109+
alpha: 0,
110+
},
111+
{ id: 2, title: "", bounds: { x: 0, y: 0, width: 1_680, height: 68 } },
112+
],
113+
content: {
114+
id: 3,
115+
title: "Document",
116+
bounds: { x: 0, y: 0, width: 1_680, height: 1_050 },
117+
},
118+
},
119+
{
120+
name: "Chrome strips stacked above the content window",
121+
helpers: [
122+
{ id: 75, title: "", bounds: { x: 0, y: 39, width: 1_800, height: 41 } },
123+
{ id: 74, title: "", bounds: { x: 0, y: 80, width: 1_800, height: 81 } },
124+
{ id: 1691, title: "", bounds: { x: 0, y: 39, width: 1_800, height: 158 } },
125+
],
126+
content: {
127+
id: 71,
128+
title: "(10) Video - YouTube",
129+
bounds: { x: 0, y: 161, width: 1_800, height: 1_008 },
130+
},
131+
},
132+
{
133+
name: "a smaller front window's strips with a larger background window",
134+
helpers: [
135+
{ id: 75, title: "", bounds: { x: 100, y: 139, width: 1_200, height: 41 } },
136+
{ id: 74, title: "", bounds: { x: 100, y: 180, width: 1_200, height: 81 } },
137+
],
138+
content: {
139+
id: 71,
140+
title: "Video - YouTube",
141+
bounds: { x: 100, y: 261, width: 1_200, height: 700 },
142+
},
143+
background: [
144+
{ id: 80, title: "Other document", bounds: { x: 0, y: 39, width: 1_800, height: 1_130 } },
145+
],
146+
},
147+
])("selects the content window behind $name", async ({ helpers, content, background = [] }) => {
148+
stubMacLookup(macLookup([...helpers, content, ...background]));
149+
150+
const window = await activeWindow("darwin");
151+
152+
assert.strictEqual(window?.id, content.id);
153+
assert.deepEqual(window?.bounds, content.bounds);
154+
});
155+
156+
it.each([
157+
{ name: "untitled dialog", title: "", bounds: { x: 300, y: 200, width: 400, height: 240 } },
158+
{ name: "titled palette", title: "Palette", bounds: { x: 0, y: 0, width: 800, height: 50 } },
159+
{ name: "offset untitled strip", title: "", bounds: { x: 100, y: 100, width: 800, height: 50 } },
160+
{ name: "tall untitled window", title: "", bounds: { x: 0, y: 0, width: 800, height: 900 } },
161+
])("keeps a frontmost $name ahead of a larger document", async ({ title, bounds }) => {
162+
stubMacLookup(
163+
macLookup([
164+
{ id: 1, title, bounds },
165+
{ id: 2, title: "Document", bounds: { x: 0, y: 0, width: 800, height: 1_000 } },
166+
]),
167+
);
168+
169+
const window = await activeWindow("darwin");
170+
171+
assert.strictEqual(window?.id, 1);
172+
assert.deepEqual(window?.bounds, bounds);
173+
});
174+
175+
it("keeps an untitled content window ahead of a much taller background window", async () => {
176+
const bounds = { x: 0, y: 0, width: 800, height: 900 };
177+
stubMacLookup(
178+
macLookup([
179+
{ id: 1, title: "", bounds },
180+
{ id: 2, title: "Background document", bounds: { x: 0, y: 0, width: 800, height: 4_000 } },
181+
]),
182+
);
183+
184+
const window = await activeWindow("darwin");
185+
186+
assert.strictEqual(window?.id, 1);
187+
assert.deepEqual(window?.bounds, bounds);
188+
});
189+
81190
it("resolves undefined when macOS has no frontmost window", async () => {
82191
stubMacLookup("\n");
83192

84193
assert.isUndefined(await activeWindow("darwin"));
85194
});
86195

196+
it("resolves undefined when macOS reports no visible windows", async () => {
197+
stubMacLookup(macLookup([]));
198+
199+
assert.isUndefined(await activeWindow("darwin"));
200+
});
201+
87202
it("composes the Windows foreground window from Win32 calls", async () => {
88203
const api = {
89204
getForegroundWindow: vi.fn(() => 0x1_f123_4567n),

‎apps/desktop/src/snapShot/ActiveWindow.ts‎

Lines changed: 63 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -30,23 +30,32 @@ export type ActiveWindow = {
3030

3131
const MAC_LOOKUP_TIMEOUT_MS = 5_000;
3232

33-
const MacActiveWindow = Schema.Struct({
34-
id: Schema.Number,
35-
title: Schema.String,
36-
bounds: Schema.Struct({
37-
x: Schema.Number,
38-
y: Schema.Number,
39-
width: Schema.Number,
40-
height: Schema.Number,
41-
}),
33+
const MAC_HELPER_STRIP_MAX_THICKNESS_RATIO = 0.25;
34+
35+
const MacActiveWindowLookup = Schema.Struct({
4236
owner: Schema.Struct({
4337
name: Schema.String,
4438
processId: Schema.Number,
4539
path: Schema.String,
4640
bundleId: Schema.String,
4741
}),
42+
windows: Schema.Array(
43+
Schema.Struct({
44+
id: Schema.Number,
45+
title: Schema.String,
46+
bounds: Schema.Struct({
47+
x: Schema.Number,
48+
y: Schema.Number,
49+
width: Schema.Number,
50+
height: Schema.Number,
51+
}),
52+
alpha: Schema.Number,
53+
}),
54+
),
4855
});
49-
const decodeMacActiveWindow = Schema.decodeUnknownSync(Schema.fromJsonString(MacActiveWindow));
56+
const decodeMacActiveWindowLookup = Schema.decodeUnknownSync(
57+
Schema.fromJsonString(MacActiveWindowLookup),
58+
);
5059

5160
const MAC_LOOKUP_SCRIPT = `
5261
ObjC.import("CoreGraphics");
@@ -55,38 +64,46 @@ function run() {
5564
const app = $.NSWorkspace.sharedWorkspace.frontmostApplication;
5665
if (app.isNil()) return "";
5766
const pid = app.processIdentifier;
67+
let ownerName = String(app.localizedName.js || "");
5868
const list = $.CGWindowListCopyWindowInfo(
5969
$.kCGWindowListOptionOnScreenOnly | $.kCGWindowListExcludeDesktopElements,
6070
$.kCGNullWindowID,
6171
);
6272
$.CFMakeCollectable(list);
6373
const count = $.CFArrayGetCount(list);
74+
const windows = [];
6475
for (let i = 0; i < count; i++) {
6576
const w = ObjC.castRefToObject($.CFArrayGetValueAtIndex(list, i));
6677
if (w.objectForKey("kCGWindowOwnerPID").js !== pid) continue;
6778
if (w.objectForKey("kCGWindowLayer").js !== 0) continue;
79+
if (!ownerName) {
80+
ownerName = String(ObjC.unwrap(w.objectForKey("kCGWindowOwnerName")) || "");
81+
}
6882
const b = ObjC.deepUnwrap(w.objectForKey("kCGWindowBounds"));
69-
return JSON.stringify({
83+
windows.push({
7084
id: w.objectForKey("kCGWindowNumber").js,
7185
title: String(ObjC.unwrap(w.objectForKey("kCGWindowName")) || ""),
7286
bounds: { x: b.X, y: b.Y, width: b.Width, height: b.Height },
73-
owner: {
74-
name: String(app.localizedName.js || ObjC.unwrap(w.objectForKey("kCGWindowOwnerName")) || ""),
75-
processId: pid,
76-
path: String(app.bundleURL.path.js || ""),
77-
bundleId: String(app.bundleIdentifier.js || ""),
78-
},
87+
alpha: w.objectForKey("kCGWindowAlpha").js,
7988
});
8089
}
81-
return "";
90+
return JSON.stringify({
91+
owner: {
92+
name: ownerName,
93+
processId: pid,
94+
path: String(app.bundleURL.path.js || ""),
95+
bundleId: String(app.bundleIdentifier.js || ""),
96+
},
97+
windows,
98+
});
8299
}`;
83100

84101
function runMacLookup(): Promise<string> {
85102
return new Promise((resolve, reject) => {
86103
NodeChildProcess.execFile(
87104
"/usr/bin/osascript",
88105
["-l", "JavaScript", "-e", MAC_LOOKUP_SCRIPT],
89-
{ timeout: MAC_LOOKUP_TIMEOUT_MS, maxBuffer: 64 * 1024 },
106+
{ timeout: MAC_LOOKUP_TIMEOUT_MS, maxBuffer: 1024 * 1024 },
90107
(error, stdout) => {
91108
if (error) reject(error);
92109
else resolve(stdout);
@@ -98,17 +115,39 @@ function runMacLookup(): Promise<string> {
98115
async function macActiveWindow(): Promise<ActiveWindow | undefined> {
99116
const output = (await runMacLookup()).trim();
100117
if (!output) return undefined;
101-
const window = decodeMacActiveWindow(output);
118+
const lookup = decodeMacActiveWindowLookup(output);
119+
const visible = lookup.windows.filter(
120+
(window) => window.alpha > 0 && window.bounds.width > 0 && window.bounds.height > 0,
121+
);
122+
// Helpers belong to the content behind them, which may not be the app's largest window.
123+
const window = visible.find((candidate, index) => {
124+
if (candidate.title.trim() !== "") return true;
125+
const bounds = candidate.bounds;
126+
return !visible.some((reference, referenceIndex) => {
127+
if (referenceIndex <= index) return false;
128+
return (
129+
(bounds.x === reference.bounds.x &&
130+
bounds.width === reference.bounds.width &&
131+
bounds.height <= bounds.width * MAC_HELPER_STRIP_MAX_THICKNESS_RATIO &&
132+
bounds.height <= reference.bounds.height * MAC_HELPER_STRIP_MAX_THICKNESS_RATIO) ||
133+
(bounds.y === reference.bounds.y &&
134+
bounds.height === reference.bounds.height &&
135+
bounds.width <= bounds.height * MAC_HELPER_STRIP_MAX_THICKNESS_RATIO &&
136+
bounds.width <= reference.bounds.width * MAC_HELPER_STRIP_MAX_THICKNESS_RATIO)
137+
);
138+
});
139+
});
140+
if (!window) return undefined;
102141
return {
103142
platform: "macos",
104143
id: window.id,
105144
title: window.title,
106145
bounds: window.bounds,
107146
owner: {
108-
name: window.owner.name,
109-
processId: window.owner.processId,
110-
path: window.owner.path,
111-
...(window.owner.bundleId ? { bundleId: window.owner.bundleId } : {}),
147+
name: lookup.owner.name,
148+
processId: lookup.owner.processId,
149+
path: lookup.owner.path,
150+
...(lookup.owner.bundleId ? { bundleId: lookup.owner.bundleId } : {}),
112151
},
113152
};
114153
}

0 commit comments

Comments
 (0)