Skip to content

Formerly KrillinAI, VideoTranslation and Dubbing Tool for 120+ Languages. Open-source AI workspace for creators, powered by Codex. Video downloader, video translation, create videos, images, audios, and edits with Agents in one place. For your Social Media like YouTube, TikTok, Instagram, etc.

fix(desktop): disable telemetry in local test packages

Leggett46b1152ad61d
diff --git a/.github/workflows/desktop-release.yml b/.github/workflows/desktop-release.yml
index 7ff4cc1f..fea465ee 100644
--- a/.github/workflows/desktop-release.yml
+++ b/.github/workflows/desktop-release.yml
@@ -95,6 +95,7 @@ jobs:
env:
OPENCREATOR_DESKTOP_CACHE_DIR: ${{ github.workspace }}/apps/desktop/.cache
OPENCREATOR_DESKTOP_BUILD_MANIFEST: ${{ github.workspace }}/apps/desktop/release/opencreator-desktop-build-manifest-${{ matrix.platform }}-${{ matrix.arch }}.json
+ OPENCREATOR_DESKTOP_OFFICIAL_BUILD: '1'
steps:
- name: 验证 macOS 正式签名凭据
if: matrix.platform == 'darwin'
diff --git a/apps/desktop/electron-builder.yml b/apps/desktop/electron-builder.yml
index d83186a2..25d867bc 100644
--- a/apps/desktop/electron-builder.yml
+++ b/apps/desktop/electron-builder.yml
@@ -25,6 +25,8 @@ files:
- "!**/*.d.ts"
- "!**/{test,tests,__tests__,example,examples}/**/*"
extraResources:
+ - from: .pack/desktop-build-profile.json
+ to: desktop-build-profile.json
- from: .pack/daemon/dist
to: daemon/dist
filter:
diff --git a/apps/desktop/scripts/package-release.mjs b/apps/desktop/scripts/package-release.mjs
index 229b24bd..60dd3176 100644
--- a/apps/desktop/scripts/package-release.mjs
+++ b/apps/desktop/scripts/package-release.mjs
@@ -71,6 +71,12 @@ const env = {
mkdirSync(releaseDir, { recursive: true });
mkdirSync(cacheDir, { recursive: true });
+mkdirSync(resolve(desktopDir, '.pack'), { recursive: true });
+const officialBuild = process.env.OPENCREATOR_DESKTOP_OFFICIAL_BUILD === '1';
+writeFileSync(
+ resolve(desktopDir, '.pack', 'desktop-build-profile.json'),
+ `${JSON.stringify({ officialBuild }, null, 2)}\n`
+);
prepareElectronBuilderCache(env.ELECTRON_BUILDER_CACHE);
rmSync(manifestPath, { force: true });
@@ -223,6 +229,7 @@ const manifest = {
platform,
arch,
mode,
+ officialBuild,
packageRoot,
packageRootRelative: relative(rootDir, packageRoot),
webBuildHash: webBuild.hash,
diff --git a/apps/desktop/scripts/verify-package.mjs b/apps/desktop/scripts/verify-package.mjs
index db8613e5..86768a92 100644
--- a/apps/desktop/scripts/verify-package.mjs
+++ b/apps/desktop/scripts/verify-package.mjs
@@ -58,6 +58,7 @@ const packageRoot = process.env.OPENCREATOR_DESKTOP_PACKAGE_ROOT
? resolve(process.env.OPENCREATOR_DESKTOP_PACKAGE_ROOT)
: resolve(manifest.packageRoot);
const resourcesDir = platformResourcesDir(packageRoot);
+const buildProfilePath = join(resourcesDir, 'desktop-build-profile.json');
const appAsar = join(resourcesDir, 'app.asar');
const daemonDir = join(resourcesDir, 'daemon');
const webDir = join(resourcesDir, 'web');
@@ -92,6 +93,7 @@ const machOMagicValues = new Set([
assertExists(packageRoot);
assertExists(executable);
assertExists(appAsar);
+assertBuildProfile();
assertExists(join(daemonDir, 'dist', 'main.js'));
assertExists(join(
daemonDir,
@@ -161,6 +163,20 @@ function platformResourcesDir(root) {
: join(root, 'resources');
}
+function assertBuildProfile() {
+ assertExists(buildProfilePath);
+ const profile = JSON.parse(readFileSync(buildProfilePath, 'utf8'));
+ if (typeof profile?.officialBuild !== 'boolean') {
+ throw new Error('Packaged Desktop build profile has an invalid officialBuild marker');
+ }
+ if (
+ typeof manifest.officialBuild === 'boolean'
+ && profile.officialBuild !== manifest.officialBuild
+ ) {
+ throw new Error('Packaged Desktop build profile does not match the build manifest');
+ }
+}
+
function packagedExecutable(root) {
if (process.platform === 'darwin') {
return join(root, 'Contents', 'MacOS', 'OpenCreator');
diff --git a/apps/desktop/src/main/main.ts b/apps/desktop/src/main/main.ts
index 189a00e2..c6d68278 100644
--- a/apps/desktop/src/main/main.ts
+++ b/apps/desktop/src/main/main.ts
@@ -1,3 +1,4 @@
+import { readFileSync } from 'node:fs';
import { join, resolve } from 'node:path';
import { resolveOpenCreatorPaths } from '@opencreator/config';
import {
@@ -174,7 +175,7 @@ async function launchDesktop(): Promise<void> {
settings,
logger,
appVersion: app.getVersion(),
- isPackaged: app.isPackaged,
+ isOfficialBuild: app.isPackaged && readOfficialBuildMarker(process.resourcesPath),
isWindowActive: () => windowManager?.isActive() === true,
endpointOverride: process.env.OPENCREATOR_TELEMETRY_URL
});
@@ -322,6 +323,17 @@ async function launchDesktop(): Promise<void> {
});
}
+function readOfficialBuildMarker(resourcesPath: string): boolean {
+ try {
+ const profile = JSON.parse(
+ readFileSync(join(resourcesPath, 'desktop-build-profile.json'), 'utf8')
+ ) as unknown;
+ return isRecord(profile) && profile.officialBuild === true;
+ } catch {
+ return false;
+ }
+}
+
function registerIpcHandlers(input: {
development: boolean;
bootstrap: BootstrapController;
diff --git a/apps/desktop/src/main/telemetry.ts b/apps/desktop/src/main/telemetry.ts
index aceb969d..e9152ea2 100644
--- a/apps/desktop/src/main/telemetry.ts
+++ b/apps/desktop/src/main/telemetry.ts
@@ -35,7 +35,7 @@ export function startDesktopTelemetry(input: {
settings: SettingsStore;
logger: DesktopLogger;
appVersion: string;
- isPackaged: boolean;
+ isOfficialBuild: boolean;
isWindowActive(): boolean;
endpointOverride?: string;
platform?: NodeJS.Platform;
@@ -48,7 +48,7 @@ export function startDesktopTelemetry(input: {
}): DesktopTelemetryController {
const now = input.now ?? (() => new Date());
const store = createTelemetryStore(input.path, input.persistence);
- const endpoint = resolveTelemetryEndpoint(input.endpointOverride, input.isPackaged);
+ const endpoint = resolveTelemetryEndpoint(input.endpointOverride, input.isOfficialBuild);
const fetchImpl = input.fetchImpl ?? fetch;
let launchRecorded = false;
let stopped = false;
@@ -153,9 +153,9 @@ export function startDesktopTelemetry(input: {
export function resolveTelemetryEndpoint(
override: string | undefined,
- isPackaged: boolean
+ isOfficialBuild: boolean
): string | undefined {
- const value = override?.trim() || (isPackaged ? DEFAULT_TELEMETRY_URL : '');
+ const value = override?.trim() || (isOfficialBuild ? DEFAULT_TELEMETRY_URL : '');
if (value === '') return undefined;
try {
const url = new URL(value);
diff --git a/apps/desktop/test/telemetry.test.ts b/apps/desktop/test/telemetry.test.ts
index e410ca36..ab8e0ba1 100644
--- a/apps/desktop/test/telemetry.test.ts
+++ b/apps/desktop/test/telemetry.test.ts
@@ -89,7 +89,7 @@ describe('desktop telemetry', () => {
settings,
logger: logger(),
appVersion: '3.0.1',
- isPackaged: false,
+ isOfficialBuild: false,
endpointOverride: 'http://127.0.0.1:8790/api/v1/public/desktop-usage',
platform: 'darwin',
architecture: 'arm64',
@@ -120,7 +120,7 @@ describe('desktop telemetry', () => {
expect(requests.at(-1)?.body).not.toHaveProperty('conversation');
});
- it('only permits HTTPS and local HTTP endpoints', () => {
+ it('uses the production endpoint only for official builds', () => {
expect(resolveTelemetryEndpoint('https://admin.example.com/report', false))
.toBe('https://admin.example.com/report');
expect(resolveTelemetryEndpoint('http://127.0.0.1:8790/report', false))
@@ -157,7 +157,7 @@ describe('desktop telemetry', () => {
settings: memorySettings(),
logger: logger(),
appVersion: '3.0.1',
- isPackaged: false,
+ isOfficialBuild: false,
endpointOverride: `http://127.0.0.1:${address.port}/api/v1/public/desktop-usage`,
now: () => new Date('2026-09-07T02:00:00Z'),
isWindowActive: () => false,
@@ -190,7 +190,7 @@ describe('desktop telemetry', () => {
settings,
logger: logger(),
appVersion: '3.0.1',
- isPackaged: true,
+ isOfficialBuild: true,
isWindowActive: () => true,
fetchImpl,
persistence: telemetryMemory.persistence as TelemetryPersistence
@@ -217,7 +217,7 @@ describe('desktop telemetry', () => {
settings: memorySettings(),
logger: logger(),
appVersion: '3.0.1',
- isPackaged: true,
+ isOfficialBuild: true,
now: () => new Date('2026-09-07T02:00:00Z'),
isWindowActive: () => false,
fetchImpl: async (_url, init) => {
@@ -251,7 +251,7 @@ describe('desktop telemetry', () => {
settings: memorySettings(),
logger: logger(),
appVersion: '3.0.1',
- isPackaged: true,
+ isOfficialBuild: true,
isWindowActive: () => true,
now: () => new Date('2026-09-07T02:00:00Z'),
fetchImpl: async (_url, init) => {