Skip to content

armgit / Orkas

Public Imported from GitHub
0

Orkas is an open-source (MIT), local-first AI team for your desktop: a Commander turns your goal into to-dos and coordinates 16 built-in specialist agents plus Claude Code, Codex, OpenCode, OpenClaw and Hermes, with projects, scheduled automations and connectors. Free app for macOS & Windows; built-in models or your own keys.

fix(packaging): retain and classify required runtime helpers

wyt701bb848e6b3
diff --git a/bin/packaged-entrypoint-gate.cjs b/bin/packaged-entrypoint-gate.cjs
index 7a9f8bdf..bf45d839 100644
--- a/bin/packaged-entrypoint-gate.cjs
+++ b/bin/packaged-entrypoint-gate.cjs
@@ -115,6 +115,7 @@ const PACKAGED_BIN_HELPERS = Object.freeze([
// Shared automation schema loaded by both the packaged Orkas bridge and
// the in-process auto_tasks tool.
'auto-tasks-contract.cjs',
+ 'project-instructions-contract.cjs',
'browser-tool-contract.cjs',
'bridge-skill-runner.cjs',
// Loaded by the retained Google Workspace bundle, never a standalone catalog transport.
@@ -216,6 +217,7 @@ const PACKAGED_BIN_HELPERS = Object.freeze([
const DORMANT_BIN_FILES = Object.freeze([]);
const BUILD_ONLY_BIN_FILES = Object.freeze([
+ 'project-instructions-contract.d.cts',
'tool-input-compat.d.cts',
'builtin-resource-gate.cjs',
'ensure-runtime.cjs',
diff --git a/package.json b/package.json
index 68734376..5511e1ef 100644
--- a/package.json
+++ b/package.json
@@ -134,7 +134,10 @@
"!bin/packaged-resource-gate.cjs",
"!bin/runtime-gate.cjs",
"!bin/tool-input-compat.d.cts",
+ "!bin/project-instructions-contract.d.cts",
"src/main/**/*.{js,ts,mjs,md,json}",
+ "src/main/install-data-root.cjs",
+ "src/main/util/migrate-source-data-root.cjs",
"resources/connectors/setup/*.md",
"src/main/native/build/*.node",
"src/renderer/**/*",
diff --git a/test/main/bootstrap-entry.test.ts b/test/main/bootstrap-entry.test.ts
index 6568de58..fc413697 100644
--- a/test/main/bootstrap-entry.test.ts
+++ b/test/main/bootstrap-entry.test.ts
@@ -2,9 +2,14 @@ import * as fs from 'node:fs';
import * as os from 'node:os';
import * as path from 'node:path';
import { runInNewContext } from 'node:vm';
+import { createRequire } from 'node:module';
+import { spawnSync } from 'node:child_process';
+import { finished } from 'node:stream/promises';
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
+const require = createRequire(import.meta.url);
+
let root = '';
beforeEach(() => {
@@ -38,10 +43,58 @@ beforeEach(() => {
});
afterEach(() => {
- fs.rmSync(root, { recursive: true, force: true });
+ require('original-fs').rmSync(root, { recursive: true, force: true, maxRetries: 5, retryDelay: 100 });
});
describe('desktop bootstrap entry', () => {
+ // Windows container selection needs its native drive/pin fixture; never let
+ // an ASAR contract case choose a real host drive as a side effect.
+ it.skipIf(process.platform === 'win32')('cold-boots the packaged bootstrap and storage helpers from the configured ASAR file projection', async () => {
+ const storageHelpers = ['src/main/install-data-root.cjs', 'src/main/util/migrate-source-data-root.cjs'];
+ for (const relative of storageHelpers) {
+ fs.copyFileSync(path.join(process.cwd(), relative), path.join(root, relative));
+ }
+ fs.writeFileSync(path.join(root, 'src/main/index.js'), `
+ const assert = require('node:assert/strict');
+ const fs = require('node:fs');
+ const path = require('node:path');
+ const expected = path.join(require('node:os').homedir(), '.orkas', 'data');
+ assert.equal(process.env.ORKAS_WORKSPACE_ROOT, expected);
+ assert.ok(fs.statSync(expected).isDirectory());
+ assert.ok(fs.statSync(path.join(expected, '.migrated-from-source')).isFile());
+ assert.equal(typeof require('./util/migrate-source-data-root.cjs').migrateSourceDataRoot, 'function');
+ process.stdout.write('BOOTSTRAP_ASAR_OK');
+ `);
+ // Use the real ASAR glob crawler and archive writer with production file
+ // patterns. The controlled Main/tsx boundaries avoid starting the desktop;
+ // the bootstrap and both early storage modules are their actual bytes.
+ const { createPackageWithOptions, extractFile } = require('@electron/asar');
+ const patterns: string[] = JSON.parse(fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf8')).build.files;
+ const archive = path.join(root, 'app.asar');
+ const output = await createPackageWithOptions(root, archive, {
+ pattern: `/{${patterns.filter((pattern) => !pattern.startsWith('!')).join(',')}}`,
+ globOptions: { ignore: patterns.filter((pattern) => pattern.startsWith('!')).map((pattern) => path.join(root, pattern.slice(1)).replaceAll('\\', '/')) },
+ });
+ await finished(output);
+ const launcher = path.join(root, 'launch.cjs');
+ fs.writeFileSync(launcher, `
+ require('node:os').homedir = () => require('node:path').join(__dirname, 'isolated-home');
+ require('./app.asar/bootstrap.cjs');
+ `);
+ const env = { ...process.env, ELECTRON_RUN_AS_NODE: '1' };
+ delete env.ORKAS_WORKSPACE_ROOT;
+ delete env.NODE_OPTIONS;
+ delete env.NODE_PATH;
+ const result = spawnSync(process.execPath, [launcher], { cwd: root, env, encoding: 'utf8', timeout: 10000 });
+ expect(result.error).toBeUndefined();
+ expect(result.status, result.stderr.replaceAll(root, '<fixture>')).toBe(0);
+ expect(result.stderr).toBe('');
+ expect(result.stdout).toBe('BOOTSTRAP_ASAR_OK');
+ for (const relative of storageHelpers) {
+ expect(extractFile(archive, relative)).toEqual(fs.readFileSync(path.join(process.cwd(), relative)));
+ }
+ }, 15000);
+
it.each([
{ platform: 'darwin', defaultApp: true, override: false },
{ platform: 'linux', defaultApp: true, override: false },
diff --git a/test/main/util/packaged-entrypoint-gate.test.ts b/test/main/util/packaged-entrypoint-gate.test.ts
index d2ac0dbc..1993eb63 100644
--- a/test/main/util/packaged-entrypoint-gate.test.ts
+++ b/test/main/util/packaged-entrypoint-gate.test.ts
@@ -113,6 +113,10 @@ describe('packaged-entrypoint-gate', () => {
expect(gate.BUILD_ONLY_BIN_FILES).toContain('packaged-entrypoint-gate.cjs');
expect(gate.BUILD_ONLY_BIN_FILES).toContain('packaged-dependency-gate.cjs');
expect(gate.PACKAGED_BIN_HELPERS).toContain('auto-tasks-contract.cjs');
+ expect(gate.PACKAGED_BIN_HELPERS).toContain('project-instructions-contract.cjs');
+ expect(gate.PACKAGED_BIN_ENTRYPOINTS).not.toContain('project-instructions-contract.cjs');
+ expect(gate.BUILD_ONLY_BIN_FILES).toContain('project-instructions-contract.d.cts');
+ expect(gate.PACKAGED_BIN_HELPERS).not.toContain('project-instructions-contract.d.cts');
expect(gate.PACKAGED_BIN_HELPERS).toContain('bridge-skill-runner.cjs');
expect(gate.PACKAGED_BIN_HELPERS).toContain('local-cli-lark.cjs');
expect(gate.PACKAGED_BIN_HELPERS).toContain('proxy-bootstrap.cjs');
@@ -145,14 +149,16 @@ describe('packaged-entrypoint-gate', () => {
.toThrow(/invalid runtime helper.*browser-tool-contract\.cjs/);
});
- it('rejects a build-only helper that is not excluded from the app', () => {
- const packageJson = JSON.parse(fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf8'));
- packageJson.build.files = packageJson.build.files.filter(
- (entry: string) => entry !== '!bin/runtime-gate.cjs',
- );
+ it.each(['runtime-gate.cjs', 'project-instructions-contract.d.cts'])(
+ 'rejects build-only %s that is not excluded from the app', (name) => {
+ const packageJson = JSON.parse(fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf8'));
+ packageJson.build.files = packageJson.build.files.filter(
+ (entry: string) => entry !== `!bin/${name}`,
+ );
- expect(() => gate.verifyBuildFilesConfig(packageJson.build)).toThrow(/runtime-gate\.cjs/);
- });
+ expect(() => gate.verifyBuildFilesConfig(packageJson.build)).toThrow(name);
+ },
+ );
it.each(['files', 'asarUnpack'] as const)(
'rejects every MCP runtime glob omitted from build.%s',
@@ -234,7 +240,7 @@ describe('packaged-entrypoint-gate', () => {
.toThrow(/missing esbuild loader lib\/main\.js/);
});
- it.each(['skill-esm-loader.cjs', 'browser-tool-contract.cjs', 'connector-discovery-contract.cjs', 'ebay-signature.cjs', 'temu-api-contracts.cjs', 'shein-api-contracts.cjs', 'lazada-api-contracts.cjs', 'amazon-business-api.cjs', 'amazon-api-contracts.cjs', 'square-business-api.cjs', 'square-api-contracts.cjs', 'ebay-business-api.cjs', 'ebay-api-contracts.cjs', 'etsy-business-api.cjs', 'etsy-api-contracts.cjs', 'bigcommerce-business-api.cjs', 'bigcommerce-api-contracts.cjs', 'woocommerce-business-api.cjs', 'woocommerce-api-contracts.cjs', 'commercelayer-business-api.cjs', 'commercelayer-api-contracts.cjs', 'constant-contact-business-api.cjs', 'constant-contact-api-contracts.cjs', 'shopify-business-api.cjs', 'shopify-api-contracts.cjs', 'shopline-business-api.cjs', 'shopline-api-contracts.cjs', 'shoplazza-business-api.cjs', 'shoplazza-api-contracts.cjs', 'reloadly-business-api.cjs', 'reloadly-api-contracts.cjs', 'lightspeed-business-api.cjs', 'lightspeed-api-contracts.cjs', 'shopline-graphql-api.cjs', 'shopline-graphql-contracts.cjs', 'base-shop-business-api.cjs', 'base-shop-api-contracts.cjs', 'walmart-business-api.cjs', 'walmart-api-contracts.cjs', 'qoo10-business-api.cjs', 'qoo10-api-contracts.cjs', 'futureshop-business-api.cjs', 'futureshop-api-contracts.cjs', 'shopee-business-api.cjs', 'shopee-api-contracts.cjs', 'tiktok-shop-business-api.cjs', 'tiktok-shop-api-contracts.cjs', 'yahoo-shopping-business-api.cjs', 'yahoo-shopping-api-contracts.cjs', 'douyin-business-api.cjs', 'douyin-api-contracts.cjs', 'aliexpress-business-api.cjs', 'aliexpress-api-contracts.cjs', 'mercado-libre-business-api.cjs', 'mercado-libre-api-contracts.cjs', 'kuaishou-business-api.cjs', 'kuaishou-api-contracts.cjs', 'alibaba-1688-business-api.cjs', 'alibaba-1688-api-contracts.cjs', 'youzan-business-api.cjs', 'youzan-api-contracts.cjs', 'icbu-business-api.cjs', 'icbu-api-contracts.cjs', 'weimob-business-api.cjs', 'weimob-api-contracts.cjs', 'taobao-business-api.cjs', 'taobao-api-contracts.cjs', 'jd-business-api.cjs', 'jd-api-contracts.cjs'])(
+ it.each(['project-instructions-contract.cjs', 'skill-esm-loader.cjs', 'browser-tool-contract.cjs', 'connector-discovery-contract.cjs', 'ebay-signature.cjs', 'temu-api-contracts.cjs', 'shein-api-contracts.cjs', 'lazada-api-contracts.cjs', 'amazon-business-api.cjs', 'amazon-api-contracts.cjs', 'square-business-api.cjs', 'square-api-contracts.cjs', 'ebay-business-api.cjs', 'ebay-api-contracts.cjs', 'etsy-business-api.cjs', 'etsy-api-contracts.cjs', 'bigcommerce-business-api.cjs', 'bigcommerce-api-contracts.cjs', 'woocommerce-business-api.cjs', 'woocommerce-api-contracts.cjs', 'commercelayer-business-api.cjs', 'commercelayer-api-contracts.cjs', 'constant-contact-business-api.cjs', 'constant-contact-api-contracts.cjs', 'shopify-business-api.cjs', 'shopify-api-contracts.cjs', 'shopline-business-api.cjs', 'shopline-api-contracts.cjs', 'shoplazza-business-api.cjs', 'shoplazza-api-contracts.cjs', 'reloadly-business-api.cjs', 'reloadly-api-contracts.cjs', 'lightspeed-business-api.cjs', 'lightspeed-api-contracts.cjs', 'shopline-graphql-api.cjs', 'shopline-graphql-contracts.cjs', 'base-shop-business-api.cjs', 'base-shop-api-contracts.cjs', 'walmart-business-api.cjs', 'walmart-api-contracts.cjs', 'qoo10-business-api.cjs', 'qoo10-api-contracts.cjs', 'futureshop-business-api.cjs', 'futureshop-api-contracts.cjs', 'shopee-business-api.cjs', 'shopee-api-contracts.cjs', 'tiktok-shop-business-api.cjs', 'tiktok-shop-api-contracts.cjs', 'yahoo-shopping-business-api.cjs', 'yahoo-shopping-api-contracts.cjs', 'douyin-business-api.cjs', 'douyin-api-contracts.cjs', 'aliexpress-business-api.cjs', 'aliexpress-api-contracts.cjs', 'mercado-libre-business-api.cjs', 'mercado-libre-api-contracts.cjs', 'kuaishou-business-api.cjs', 'kuaishou-api-contracts.cjs', 'alibaba-1688-business-api.cjs', 'alibaba-1688-api-contracts.cjs', 'youzan-business-api.cjs', 'youzan-api-contracts.cjs', 'icbu-business-api.cjs', 'icbu-api-contracts.cjs', 'weimob-business-api.cjs', 'weimob-api-contracts.cjs', 'taobao-business-api.cjs', 'taobao-api-contracts.cjs', 'jd-business-api.cjs', 'jd-api-contracts.cjs'])(
'blocks a package missing the runtime helper %s', (name) => {
const pcRoot = packagedFixture();
fs.rmSync(path.join(pcRoot, 'bin', name));