Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

Avoid Windows package-time icon conversion (#5577)

Nick Gomezd7a89f73717e
diff --git a/knip.config.ts b/knip.config.ts
index 65f0e8807..d3638888e 100644
--- a/knip.config.ts
+++ b/knip.config.ts
@@ -147,11 +147,15 @@ export default {
'packages/server': {
entry: ['src/**/*.test.ts', 'src/parse-worker.ts'],
project: 'src/**',
- ignoreDependencies: ['@types/shell-quote'],
+ ignoreDependencies: [
+ '@types/shell-quote',
+ ],
},
'packages/cli': {
entry: ['src/**/*.test.ts', 'scripts/*.ts', 'tests/**/*.ts', 'src/parse-worker.ts'],
- ignoreDependencies: ['yjs'],
+ ignoreDependencies: [
+ 'yjs',
+ ],
},
'packages/desktop': {
entry: [
diff --git a/packages/app/tests/integration/bug3-source-mode-writeback.test.ts b/packages/app/tests/integration/bug3-source-mode-writeback.test.ts
index 8a60e5826..a28cc2b18 100644
--- a/packages/app/tests/integration/bug3-source-mode-writeback.test.ts
+++ b/packages/app/tests/integration/bug3-source-mode-writeback.test.ts
@@ -1,3 +1,4 @@
+
import { readFileSync } from 'node:fs';
import { join } from 'node:path';
import { setTimeout as wait } from 'node:timers/promises';
diff --git a/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts b/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts
index 6fcdc23f2..4fc2c11f9 100644
--- a/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts
+++ b/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts
@@ -1,3 +1,4 @@
+
import { setTimeout as wait } from 'node:timers/promises';
import { normalizeBridge } from '@inkeep/open-knowledge-core';
import { updateYFragment } from '@tiptap/y-tiptap';
diff --git a/packages/app/tests/integration/interior-edit-freshness.test.ts b/packages/app/tests/integration/interior-edit-freshness.test.ts
index 40b5cdfd6..9f2f6feb6 100644
--- a/packages/app/tests/integration/interior-edit-freshness.test.ts
+++ b/packages/app/tests/integration/interior-edit-freshness.test.ts
@@ -1,3 +1,4 @@
+
import { setTimeout as wait } from 'node:timers/promises';
import { updateYFragment, yXmlFragmentToProseMirrorRootNode } from '@tiptap/y-tiptap';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
diff --git a/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts b/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts
index 93666af70..2a085742b 100644
--- a/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts
+++ b/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts
@@ -1,3 +1,4 @@
+
import { setTimeout as wait } from 'node:timers/promises';
import { updateYFragment, yXmlFragmentToProseMirrorRootNode } from '@tiptap/y-tiptap';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
diff --git a/packages/app/tests/integration/producer-guard-wiring.test.ts b/packages/app/tests/integration/producer-guard-wiring.test.ts
index 867598d34..878d5196b 100644
--- a/packages/app/tests/integration/producer-guard-wiring.test.ts
+++ b/packages/app/tests/integration/producer-guard-wiring.test.ts
@@ -1,3 +1,4 @@
+
import { setTimeout as wait } from 'node:timers/promises';
import { updateYFragment, yXmlFragmentToProseMirrorRootNode } from '@tiptap/y-tiptap';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
diff --git a/packages/app/tests/integration/qa-039-reconciliation-counters-http.test.ts b/packages/app/tests/integration/qa-039-reconciliation-counters-http.test.ts
index 0970ac12f..4ada3cf26 100644
--- a/packages/app/tests/integration/qa-039-reconciliation-counters-http.test.ts
+++ b/packages/app/tests/integration/qa-039-reconciliation-counters-http.test.ts
@@ -1,3 +1,4 @@
+
import { randomUUID } from 'node:crypto';
import { afterEach, describe, expect, test } from 'vitest';
import { agentWriteMd, createTestServer, type TestServer } from './test-harness';
diff --git a/packages/app/tests/integration/qa-045-restore-after-gc.test.ts b/packages/app/tests/integration/qa-045-restore-after-gc.test.ts
index b632185e1..cbe2b705f 100644
--- a/packages/app/tests/integration/qa-045-restore-after-gc.test.ts
+++ b/packages/app/tests/integration/qa-045-restore-after-gc.test.ts
@@ -1,3 +1,4 @@
+
import { execFileSync } from 'node:child_process';
import { randomUUID } from 'node:crypto';
import { join } from 'node:path';
diff --git a/packages/app/tests/integration/qa-050-rollback-undo-shipped-path.test.ts b/packages/app/tests/integration/qa-050-rollback-undo-shipped-path.test.ts
index c530ce4ba..89bc9b4d9 100644
--- a/packages/app/tests/integration/qa-050-rollback-undo-shipped-path.test.ts
+++ b/packages/app/tests/integration/qa-050-rollback-undo-shipped-path.test.ts
@@ -1,3 +1,4 @@
+
import { randomUUID } from 'node:crypto';
import { afterAll, afterEach, beforeAll, describe, expect, test } from 'vitest';
import type * as Y from 'yjs';
diff --git a/packages/app/tests/integration/undo-after-rollback.test.ts b/packages/app/tests/integration/undo-after-rollback.test.ts
index d3767adc9..a78aeb0e4 100644
--- a/packages/app/tests/integration/undo-after-rollback.test.ts
+++ b/packages/app/tests/integration/undo-after-rollback.test.ts
@@ -1,3 +1,4 @@
+
import { ROLLBACK_ORIGIN } from '@inkeep/open-knowledge-server';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
import * as Y from 'yjs';
diff --git a/packages/app/tests/integration/undo-recycle-reset.test.ts b/packages/app/tests/integration/undo-recycle-reset.test.ts
index b076f955c..e7cc69c3f 100644
--- a/packages/app/tests/integration/undo-recycle-reset.test.ts
+++ b/packages/app/tests/integration/undo-recycle-reset.test.ts
@@ -1,3 +1,4 @@
+
import { writeFileSync } from 'node:fs';
import { join } from 'node:path';
import { setTimeout as wait } from 'node:timers/promises';
diff --git a/packages/app/tests/integration/undo-rederive-survival.test.ts b/packages/app/tests/integration/undo-rederive-survival.test.ts
index 7935e35f8..9ddcd0730 100644
--- a/packages/app/tests/integration/undo-rederive-survival.test.ts
+++ b/packages/app/tests/integration/undo-rederive-survival.test.ts
@@ -1,3 +1,4 @@
+
import { prependFrontmatter } from '@inkeep/open-knowledge-core';
import { Plugin, PluginKey } from '@tiptap/pm/state';
import { updateYFragment, yXmlFragmentToProseMirrorRootNode } from '@tiptap/y-tiptap';
diff --git a/packages/core/src/bridge/compose.ts b/packages/core/src/bridge/compose.ts
index f4cc8a286..2a597ec3d 100644
--- a/packages/core/src/bridge/compose.ts
+++ b/packages/core/src/bridge/compose.ts
@@ -1,3 +1,4 @@
+
import { prependFrontmatter, stripFrontmatter } from '../extensions/frontmatter.ts';
export type ComposeAdjustment = 'none' | 'body' | 'frontmatter' | 'unresolved';
diff --git a/packages/core/src/bridge/doc-boundary-space.ts b/packages/core/src/bridge/doc-boundary-space.ts
index 8fb428b90..01ef76a9f 100644
--- a/packages/core/src/bridge/doc-boundary-space.ts
+++ b/packages/core/src/bridge/doc-boundary-space.ts
@@ -1,3 +1,4 @@
+
import { FRONTMATTER_RE, stripFrontmatter } from '../extensions/frontmatter.ts';
import { carriedEdgeEmpties, type DocEdgeEmpties } from '../markdown/doc-edge-blank-runs.ts';
diff --git a/packages/core/src/markdown/comment-promoter.ts b/packages/core/src/markdown/comment-promoter.ts
index fc267cbea..fb0ba5a7c 100644
--- a/packages/core/src/markdown/comment-promoter.ts
+++ b/packages/core/src/markdown/comment-promoter.ts
@@ -1,3 +1,4 @@
+
import type { Nodes, Paragraph, PhrasingContent, Root, RootContent, Text } from 'mdast';
import { SKIP, visit } from 'unist-util-visit';
import type { VFile } from 'vfile';
diff --git a/packages/core/src/markdown/merged-walker.ts b/packages/core/src/markdown/merged-walker.ts
index bfd7e3109..fa3cfcd86 100644
--- a/packages/core/src/markdown/merged-walker.ts
+++ b/packages/core/src/markdown/merged-walker.ts
@@ -1,3 +1,4 @@
+
import type { Nodes, Parent, Root } from 'mdast';
import { SKIP, visit } from 'unist-util-visit';
import type { VFile } from 'vfile';
diff --git a/packages/core/src/markdown/safe-url.ts b/packages/core/src/markdown/safe-url.ts
index 4d3250d3a..8be632ba4 100644
--- a/packages/core/src/markdown/safe-url.ts
+++ b/packages/core/src/markdown/safe-url.ts
@@ -1,3 +1,4 @@
+
export const SAFE_URL_SCHEMES = ['https', 'http', 'mailto', 'tel', 'ftp', 'sms'] as const;
const SCHEME_ALT = SAFE_URL_SCHEMES.map((s) => `${s}:`).join('|');
diff --git a/packages/desktop/build/icon-beta.ico b/packages/desktop/build/icon-beta.ico
new file mode 100644
index 000000000..d8bcb80d8
Binary files /dev/null and b/packages/desktop/build/icon-beta.ico differ
diff --git a/packages/desktop/build/icon.ico b/packages/desktop/build/icon.ico
new file mode 100644
index 000000000..3518e35fa
Binary files /dev/null and b/packages/desktop/build/icon.ico differ
diff --git a/packages/desktop/electron-builder.yml b/packages/desktop/electron-builder.yml
index c48ee8dfd..96e78f531 100644
--- a/packages/desktop/electron-builder.yml
+++ b/packages/desktop/electron-builder.yml
@@ -386,9 +386,7 @@ dmg:
iconSize: 100
win:
- # electron-builder converts the 1024px PNG to the multi-size .ico via
- # app-builder at package time — no committed .ico needed.
- icon: build/icon.png
+ icon: build/icon.ico
# Per-arch NSIS installers (see `nsis.buildUniversalInstaller: false`).
# electron-updater on Windows supports NSIS only; MSI is Future Work.
target:
diff --git a/packages/desktop/scripts/desktop-variant-config.ts b/packages/desktop/scripts/desktop-variant-config.ts
index 04af65853..443ae42cc 100644
--- a/packages/desktop/scripts/desktop-variant-config.ts
+++ b/packages/desktop/scripts/desktop-variant-config.ts
@@ -109,7 +109,7 @@ export function createVariantBuilderConfig(
}));
config.mac.icon = variant.name === 'stable' ? config.mac.icon : variant.iconPath;
config.mac.artifactName = `${variant.artifactName}-\${version}-\${arch}-mac.\${ext}`;
- config.win.icon = variant.iconPath;
+ config.win.icon = variant.windowsIconPath;
config.linux.icon = variant.iconPath;
config.dmg.artifactName = `${variant.artifactName}-\${arch}.\${ext}`;
config.nsis.artifactName = `${variant.artifactName}-Setup-\${arch}.\${ext}`;
diff --git a/packages/desktop/src/shared/desktop-variant.ts b/packages/desktop/src/shared/desktop-variant.ts
index b4eb3986a..0b7fb1b9e 100644
--- a/packages/desktop/src/shared/desktop-variant.ts
+++ b/packages/desktop/src/shared/desktop-variant.ts
@@ -15,6 +15,7 @@ interface DesktopVariantIdentity {
readonly feedChannel: 'latest' | 'beta' | 'beta-product';
readonly instanceLabel: string | null;
readonly iconPath: string;
+ readonly windowsIconPath: string;
readonly linuxExecutableName: string;
readonly linuxPackageNames: {
readonly deb: string;
@@ -36,6 +37,7 @@ const DESKTOP_PRODUCT_VARIANTS = {
feedChannel: 'latest',
instanceLabel: null,
iconPath: 'build/icon.png',
+ windowsIconPath: 'build/icon.ico',
linuxExecutableName: DESKTOP_PRODUCTS.stable.linuxExecutableName,
linuxPackageNames: DESKTOP_PRODUCTS.stable.linuxPackageNames,
cliCommandNames: DESKTOP_PRODUCTS.stable.cliCommandNames,
@@ -52,6 +54,7 @@ const DESKTOP_PRODUCT_VARIANTS = {
feedChannel: 'beta-product',
instanceLabel: 'Beta',
iconPath: 'build/icon-beta.png',
+ windowsIconPath: 'build/icon-beta.ico',
linuxExecutableName: DESKTOP_PRODUCTS.beta.linuxExecutableName,
linuxPackageNames: DESKTOP_PRODUCTS.beta.linuxPackageNames,
cliCommandNames: DESKTOP_PRODUCTS.beta.cliCommandNames,
diff --git a/packages/desktop/tests/unit/desktop-variant-config.test.ts b/packages/desktop/tests/unit/desktop-variant-config.test.ts
index f570793fb..9e0c0d90f 100644
--- a/packages/desktop/tests/unit/desktop-variant-config.test.ts
+++ b/packages/desktop/tests/unit/desktop-variant-config.test.ts
@@ -1,6 +1,7 @@
import { type ChildProcess, spawn } from 'node:child_process';
import {
copyFileSync,
+ existsSync,
mkdirSync,
mkdtempSync,
readFileSync,
@@ -339,6 +340,21 @@ describe('desktop variant builder config', () => {
]);
});
+ test.each([
+ { variant: 'stable', icon: 'build/icon.ico' },
+ { variant: 'beta', icon: 'build/icon-beta.ico' },
+ { variant: 'legacy-beta', icon: 'build/icon.ico' },
+ ] as const)('selects the committed Windows icon for $variant', ({ variant, icon }) => {
+ expect(existsSync(resolve(desktopRoot, icon)), icon).toBe(true);
+ const config = createVariantBuilderConfig(
+ parseBuilderConfig(configSource),
+ variant,
+ paths,
+ '0.77.7',
+ );
+ expect(config.win.icon).toBe(icon);
+ });
+
test('selects the matching signed profile when it is available', () => {
const beta = createVariantBuilderConfig(
parseBuilderConfig(configSource),
diff --git a/packages/desktop/tests/unit/windows-icons.test.mjs b/packages/desktop/tests/unit/windows-icons.test.mjs
new file mode 100644
index 000000000..cd9db95f2
--- /dev/null
+++ b/packages/desktop/tests/unit/windows-icons.test.mjs
@@ -0,0 +1,93 @@
+import { spawnSync } from 'node:child_process';
+import { copyFileSync, mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { dirname, join, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { LinuxPackager, Packager, WinPackager } from 'electron-builder';
+import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest';
+import { parse, stringify } from 'yaml';
+
+const desktopRoot = resolve(dirname(fileURLToPath(import.meta.url)), '../..');
+let fixture;
+
+beforeEach(() => {
+ fixture = mkdtempSync(join(tmpdir(), 'ok-windows-icons-'));
+ vi.stubEnv('ELECTRON_BUILDER_ICONS_TOOLSET_DIR', join(fixture, 'unavailable-toolset'));
+});
+
+afterEach(() => {
+ vi.unstubAllEnvs();
+ rmSync(fixture, { recursive: true, force: true });
+});
+
+function baseConfig() {
+ return parse(readFileSync(join(desktopRoot, 'electron-builder.yml'), 'utf8'));
+}
+
+function releaseConfig(variant) {
+ for (const file of [
+ 'package.json',
+ 'electron-builder.yml',
+ 'build/installer.nsh',
+ 'build/deb-postinst.sh',
+ 'build/deb-postrm.sh',
+ 'build/entitlements.mac.plist',
+ 'build/helper-bundle/Info.plist',
+ ]) {
+ const target = join(fixture, file);
+ mkdirSync(dirname(target), { recursive: true });
+ copyFileSync(join(desktopRoot, file), target);
+ }
+ const preload = join(fixture, 'packaging-boundary.mjs');
+ writeFileSync(
+ preload,
+ `import childProcess from 'node:child_process';
+import { syncBuiltinESMExports } from 'node:module';
+childProcess.spawnSync = () => ({ status: 0 });
+syncBuiltinESMExports();
+`,
+ );
+ const result = spawnSync(
+ process.execPath,
+ ['--import', preload, join(desktopRoot, 'scripts/run-electron-builder.mjs'), '--win'],
+ {
+ cwd: fixture,
+ encoding: 'utf8',
+ env: { ...process.env, OK_DESKTOP_VARIANT: variant, CSC_LINK: '', CSC_KEYCHAIN: '' },
+ },
+ );
+ expect(result.status, result.stderr).toBe(0);
+ return parse(readFileSync(join(fixture, '.variant-build/electron-builder.yml'), 'utf8'));
+}
+
+async function resolveIcon(config, platform, format) {
+ const configPath = join(fixture, 'icon-config.yml');
+ writeFileSync(
+ configPath,
+ stringify({ ...config, directories: { ...config.directories, output: fixture } }),
+ );
+ const packager = new Packager({ projectDir: desktopRoot, config: configPath });
+ await packager.validateConfig();
+ const target = platform === 'win' ? new WinPackager(packager) : new LinuxPackager(packager);
+ return target.resolveIcon([target.platformSpecificBuildOptions.icon], [], format);
+}
+
+describe('Windows build icons', () => {
+ test.each([
+ ['direct Windows', null, 'icon'],
+ ['stable Windows release', 'stable', 'icon'],
+ ['beta Windows release', 'beta', 'icon-beta'],
+ ['legacy-beta Windows release', 'legacy-beta', 'icon'],
+ ])('resolves the %s icon without a conversion tool', async (_label, variant, asset) => {
+ const config = variant === null ? baseConfig() : releaseConfig(variant);
+ await expect(resolveIcon(config, 'win', 'ico')).resolves.toEqual([
+ { file: join(desktopRoot, `build/${asset}.ico`), size: 256 },
+ ]);
+ });
+
+ test('preserves the Linux PNG without a conversion tool', async () => {
+ await expect(resolveIcon(baseConfig(), 'linux', 'set')).resolves.toEqual([
+ { file: join(desktopRoot, 'build/icon.png'), size: 1024 },
+ ]);
+ });
+});