@theia/ai-copilot 1.76.0-next.4 → 1.76.0-next.7

package/lib/node/copilot-cli-auth-provider.spec.js

@@ -0,0 +1,249 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2026 EclipseSource GmbH and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const fs_1 = require("fs");
+const os = require("os");
+const path_1 = require("path");
+const promise_util_1 = require("@theia/core/lib/common/promise-util");
+const mock_logger_1 = require("@theia/core/lib/common/test/mock-logger");
+const copilot_cli_auth_provider_1 = require("./copilot-cli-auth-provider");
+class TestableCopilotCliAuthProvider extends copilot_cli_auth_provider_1.CopilotCliAuthProvider {
+    constructor() {
+        super();
+        // The logger is injected in production, and read-only for everyone else.
+        Object.assign(this, { logger: new mock_logger_1.MockLogger() });
+    }
+    callParseDeviceCode(output) {
+        return this.parseDeviceCode(output);
+    }
+    callFindStoredToken(home) {
+        return this.findStoredToken(home);
+    }
+    callFindTokenInText(text) {
+        return this.findTokenInText(text);
+    }
+    callParseAccountLabel(output) {
+        return this.parseAccountLabel(output);
+    }
+    callCreateLoginEnv(home, noopBrowser) {
+        return this.createLoginEnv(home, noopBrowser);
+    }
+    callExtractFailure(output) {
+        return this.extractFailure(output);
+    }
+    callToHostUrl(enterpriseUrl) {
+        return this.toHostUrl(enterpriseUrl);
+    }
+    setLoginResult(result) {
+        Object.assign(this, { loginResult: result });
+    }
+}
+describe('CopilotCliAuthProvider - parseDeviceCode', () => {
+    const provider = new TestableCopilotCliAuthProvider();
+    it('should extract from the output format of the current CLI', () => {
+        const parsed = provider.callParseDeviceCode('To authenticate, visit https://github.com/login/device and enter code B54F-40A3\nWaiting for authorization...\n');
+        (0, chai_1.expect)(parsed?.verification_uri).to.equal('https://github.com/login/device');
+        (0, chai_1.expect)(parsed?.user_code).to.equal('B54F-40A3');
+    });
+    it('should extract the verification URL and the user code', () => {
+        const parsed = provider.callParseDeviceCode('Please enter the code AAEB-CD8C at https://github.com/login/device to authenticate.\n');
+        (0, chai_1.expect)(parsed?.verification_uri).to.equal('https://github.com/login/device');
+        (0, chai_1.expect)(parsed?.user_code).to.equal('AAEB-CD8C');
+    });
+    it('should extract from output spread across several lines', () => {
+        const parsed = provider.callParseDeviceCode([
+            'Opening your browser to authenticate...',
+            'First copy your one-time code: 1A2B-3C4D',
+            'Then open https://github.com/login/device in your browser.'
+        ].join('\n'));
+        (0, chai_1.expect)(parsed?.user_code).to.equal('1A2B-3C4D');
+        (0, chai_1.expect)(parsed?.verification_uri).to.equal('https://github.com/login/device');
+    });
+    it('should extract an enterprise verification URL', () => {
+        const parsed = provider.callParseDeviceCode('Enter WXYZ-7890 at https://company.ghe.com/login/device\n');
+        (0, chai_1.expect)(parsed?.verification_uri).to.equal('https://company.ghe.com/login/device');
+        (0, chai_1.expect)(parsed?.user_code).to.equal('WXYZ-7890');
+    });
+    it('should return undefined while only the URL has been reported', () => {
+        (0, chai_1.expect)(provider.callParseDeviceCode('Visit https://github.com/login/device\n')).to.be.undefined;
+    });
+    it('should return undefined while only the code has been reported', () => {
+        (0, chai_1.expect)(provider.callParseDeviceCode('Your code is AAEB-CD8C\n')).to.be.undefined;
+    });
+    it('should return undefined for unrelated output', () => {
+        (0, chai_1.expect)(provider.callParseDeviceCode('Opening your browser to authenticate...\n')).to.be.undefined;
+    });
+    it('should not mistake a lowercase word pair for a code', () => {
+        (0, chai_1.expect)(provider.callParseDeviceCode('see also-here at https://github.com/login/device\n')).to.be.undefined;
+    });
+});
+describe('CopilotCliAuthProvider - extractFailure', () => {
+    const provider = new TestableCopilotCliAuthProvider();
+    it('should pick the line reporting the failure', () => {
+        const failure = provider.callExtractFailure([
+            'Waiting for authorization...',
+            'Error: Access denied by policy settings (Request ID: DEA8:572C1)'
+        ].join('\n'));
+        (0, chai_1.expect)(failure).to.equal('Error: Access denied by policy settings (Request ID: DEA8:572C1)');
+    });
+    it('should pick the last failure line when several are reported', () => {
+        const failure = provider.callExtractFailure([
+            'Error: first problem',
+            'unauthorized: not authorized to use this Copilot feature'
+        ].join('\n'));
+        (0, chai_1.expect)(failure).to.equal('unauthorized: not authorized to use this Copilot feature');
+    });
+    it('should ignore the clipboard failure the CLI reports on a healthy login', () => {
+        const failure = provider.callExtractFailure([
+            'To authenticate, visit https://github.com/login/device and enter code B54F-40A3',
+            'Failed to copy to clipboard. Please visit https://github.com/login/device and enter the code manually.',
+            'Error: Access denied by policy settings'
+        ].join('\n'));
+        (0, chai_1.expect)(failure).to.equal('Error: Access denied by policy settings');
+    });
+    it('should not report the clipboard failure as the cause when it is the only match', () => {
+        const failure = provider.callExtractFailure([
+            'Waiting for authorization...',
+            'Failed to copy to clipboard. Please visit https://github.com/login/device manually.'
+        ].join('\n'));
+        (0, chai_1.expect)(failure).to.contain('Waiting for authorization');
+        (0, chai_1.expect)(failure).to.not.contain('clipboard');
+    });
+    it('should fall back to the tail of the output when no line names the problem', () => {
+        (0, chai_1.expect)(provider.callExtractFailure('Waiting for authorization...\n')).to.contain('Waiting for authorization');
+    });
+});
+describe('CopilotCliAuthProvider - toHostUrl', () => {
+    const provider = new TestableCopilotCliAuthProvider();
+    it('should prefix a bare domain with https', () => {
+        (0, chai_1.expect)(provider.callToHostUrl('company.ghe.com')).to.equal('https://company.ghe.com');
+    });
+    it('should keep a URL that already has a scheme', () => {
+        (0, chai_1.expect)(provider.callToHostUrl('https://company.ghe.com')).to.equal('https://company.ghe.com');
+    });
+    it('should upgrade a plain HTTP URL, since the sign-in carries credentials', () => {
+        (0, chai_1.expect)(provider.callToHostUrl('http://company.ghe.com')).to.equal('https://company.ghe.com');
+    });
+    it('should not mistake a host that merely starts with "http" for a URL with a scheme', () => {
+        (0, chai_1.expect)(provider.callToHostUrl('httpbin.example.com')).to.equal('https://httpbin.example.com');
+    });
+});
+describe('CopilotCliAuthProvider - cancelLogin', () => {
+    it('should settle a login that is being awaited, so that closing the dialog does not hang it', async () => {
+        const provider = new TestableCopilotCliAuthProvider();
+        const result = new promise_util_1.Deferred();
+        provider.setLoginResult(result);
+        await provider.cancelLogin();
+        (0, chai_1.expect)(await result.promise).to.equal(false);
+    });
+});
+describe('CopilotCliAuthProvider - findTokenInText', () => {
+    const provider = new TestableCopilotCliAuthProvider();
+    it('should find the token in the commented JSON the CLI writes', () => {
+        const config = [
+            '// User settings written by the Copilot CLI',
+            '{',
+            '  "github": { "token": "gho_abcdefghijklmnopqrstuvwxyz0123" },',
+            '  "host": "https://github.com"',
+            '}'
+        ].join('\n');
+        (0, chai_1.expect)(provider.callFindTokenInText(config)).to.equal('gho_abcdefghijklmnopqrstuvwxyz0123');
+    });
+    it('should find a token regardless of the surrounding format', () => {
+        (0, chai_1.expect)(provider.callFindTokenInText('token = ghu_abcdefghijklmnopqrstuvwxyz0123\n')).to.equal('ghu_abcdefghijklmnopqrstuvwxyz0123');
+    });
+    it('should not match values that only look similar', () => {
+        (0, chai_1.expect)(provider.callFindTokenInText('{ "user": "ndoschek", "short": "gho_tooshort", "url": "https://github.com" }')).to.be.undefined;
+    });
+    it('should return undefined for content without a token', () => {
+        (0, chai_1.expect)(provider.callFindTokenInText('// nothing to see here\n{}\n')).to.be.undefined;
+    });
+});
+describe('CopilotCliAuthProvider - findStoredToken', () => {
+    const provider = new TestableCopilotCliAuthProvider();
+    const token = 'gho_abcdefghijklmnopqrstuvwxyz0123';
+    let home;
+    beforeEach(async () => {
+        home = await fs_1.promises.mkdtemp((0, path_1.join)(os.tmpdir(), 'theia-copilot-token-'));
+    });
+    afterEach(async () => {
+        await fs_1.promises.rm(home, { recursive: true, force: true });
+    });
+    it('should find the token the CLI persisted', async () => {
+        await fs_1.promises.writeFile((0, path_1.join)(home, 'config.json'), `{ "github": { "token": "${token}" } }`);
+        (0, chai_1.expect)(await provider.callFindStoredToken(home)).to.equal(token);
+    });
+    it('should not inspect the files this provider wrote itself', async () => {
+        await fs_1.promises.writeFile((0, path_1.join)(home, 'settings.json'), `{ "token": "${token}" }`);
+        await fs_1.promises.writeFile((0, path_1.join)(home, 'no-browser.sh'), `#!/bin/sh\n# ${token}\n`);
+        (0, chai_1.expect)(await provider.callFindStoredToken(home)).to.be.undefined;
+    });
+    it('should skip a file that is implausibly large instead of reading it', async () => {
+        // Written with a leading newline so that the token would be found if the file were read.
+        await fs_1.promises.writeFile((0, path_1.join)(home, 'huge.json'), 'x'.repeat(1024 * 1024 + 1) + `\n${token}\n`);
+        (0, chai_1.expect)(await provider.callFindStoredToken(home)).to.be.undefined;
+    });
+    it('should return undefined for a home without a token', async () => {
+        await fs_1.promises.writeFile((0, path_1.join)(home, 'config.json'), '{ "host": "https://github.com" }');
+        (0, chai_1.expect)(await provider.callFindStoredToken(home)).to.be.undefined;
+    });
+});
+describe('CopilotCliAuthProvider - parseAccountLabel', () => {
+    const provider = new TestableCopilotCliAuthProvider();
+    it('should extract the login the CLI reported', () => {
+        (0, chai_1.expect)(provider.callParseAccountLabel('Signed in successfully as ndoschek.')).to.equal('ndoschek');
+    });
+    it('should extract the login without a trailing period', () => {
+        (0, chai_1.expect)(provider.callParseAccountLabel('Signed in successfully as some-user\n')).to.equal('some-user');
+    });
+    it('should return undefined when no login was reported', () => {
+        (0, chai_1.expect)(provider.callParseAccountLabel('Waiting for authorization...')).to.be.undefined;
+    });
+});
+describe('CopilotCliAuthProvider - createLoginEnv', () => {
+    const provider = new TestableCopilotCliAuthProvider();
+    it('should isolate the login in the given home with the keychain disabled', () => {
+        const env = provider.callCreateLoginEnv('/tmp/theia-copilot-login-test', '/tmp/theia-copilot-login-test/no-browser.sh');
+        (0, chai_1.expect)(env.COPILOT_HOME).to.equal('/tmp/theia-copilot-login-test');
+        (0, chai_1.expect)(env.COPILOT_DISABLE_KEYTAR).to.equal('1');
+    });
+    it('should remove a token variable whatever its case, since Windows ignores it', () => {
+        const previous = { ...process.env };
+        try {
+            process.env.Github_Token = 'gho_environment';
+            const env = provider.callCreateLoginEnv('/tmp/home', '/tmp/home/no-browser.sh');
+            (0, chai_1.expect)(Object.keys(env).some(name => name.toLowerCase() === 'github_token')).to.be.false;
+        }
+        finally {
+            process.env = previous;
+        }
+    });
+    it('should remove tokens from the environment so they cannot satisfy the sign-in', () => {
+        const env = provider.callCreateLoginEnv('/tmp/theia-copilot-login-test', '/tmp/theia-copilot-login-test/no-browser.sh');
+        (0, chai_1.expect)(env.COPILOT_GITHUB_TOKEN).to.be.undefined;
+        (0, chai_1.expect)(env.GH_TOKEN).to.be.undefined;
+        (0, chai_1.expect)(env.GITHUB_TOKEN).to.be.undefined;
+    });
+    it('should point the CLI at the no-op opener and drop the display variables', () => {
+        const env = provider.callCreateLoginEnv('/tmp/theia-copilot-login-test', '/tmp/theia-copilot-login-test/no-browser.sh');
+        (0, chai_1.expect)(env.BROWSER).to.equal('/tmp/theia-copilot-login-test/no-browser.sh');
+        (0, chai_1.expect)(env.DISPLAY).to.be.undefined;
+        (0, chai_1.expect)(env.WAYLAND_DISPLAY).to.be.undefined;
+    });
+});
+//# sourceMappingURL=copilot-cli-auth-provider.spec.js.map

package/lib/node/copilot-cli-auth-provider.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copilot-cli-auth-provider.spec.js","sourceRoot":"","sources":["../../src/node/copilot-cli-auth-provider.spec.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,oDAAoD;AACpD,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;AAEhF,+BAA8B;AAC9B,2BAAoC;AACpC,yBAAyB;AACzB,+BAA4B;AAC5B,sEAA+D;AAC/D,yEAAqE;AAErE,2EAAqE;AAErE,MAAM,8BAA+B,SAAQ,kDAAsB;IAC/D;QACI,KAAK,EAAE,CAAC;QACR,yEAAyE;QACzE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,wBAAU,EAAE,EAAE,CAAC,CAAC;IACtD,CAAC;IAED,mBAAmB,CAAC,MAAc;QAC9B,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED,mBAAmB,CAAC,IAAY;QAC5B,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,mBAAmB,CAAC,IAAY;QAC5B,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,qBAAqB,CAAC,MAAc;QAChC,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAED,kBAAkB,CAAC,IAAY,EAAE,WAAmB;QAChD,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAClD,CAAC;IAED,kBAAkB,CAAC,MAAc;QAC7B,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAED,aAAa,CAAC,aAAqB;QAC/B,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACzC,CAAC;IAED,cAAc,CAAC,MAAyB;QACpC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC;IACjD,CAAC;CACJ;AAED,QAAQ,CAAC,0CAA0C,EAAE,GAAG,EAAE;IAEtD,MAAM,QAAQ,GAAG,IAAI,8BAA8B,EAAE,CAAC;IAEtD,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAChE,MAAM,MAAM,GAAG,QAAQ,CAAC,mBAAmB,CACvC,iHAAiH,CACpH,CAAC;QACF,IAAA,aAAM,EAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;QAC7E,IAAA,aAAM,EAAC,MAAM,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC7D,MAAM,MAAM,GAAG,QAAQ,CAAC,mBAAmB,CACvC,uFAAuF,CAC1F,CAAC;QACF,IAAA,aAAM,EAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;QAC7E,IAAA,aAAM,EAAC,MAAM,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAC9D,MAAM,MAAM,GAAG,QAAQ,CAAC,mBAAmB,CAAC;YACxC,yCAAyC;YACzC,0CAA0C;YAC1C,4DAA4D;SAC/D,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACd,IAAA,aAAM,EAAC,MAAM,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAChD,IAAA,aAAM,EAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACjF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACrD,MAAM,MAAM,GAAG,QAAQ,CAAC,mBAAmB,CACvC,2DAA2D,CAC9D,CAAC;QACF,IAAA,aAAM,EAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAClF,IAAA,aAAM,EAAC,MAAM,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACpE,IAAA,aAAM,EAAC,QAAQ,CAAC,mBAAmB,CAAC,yCAAyC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IACpG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACrE,IAAA,aAAM,EAAC,QAAQ,CAAC,mBAAmB,CAAC,0BAA0B,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IACrF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,IAAA,aAAM,EAAC,QAAQ,CAAC,mBAAmB,CAAC,2CAA2C,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IACtG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC3D,IAAA,aAAM,EAAC,QAAQ,CAAC,mBAAmB,CAAC,oDAAoD,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IAC/G,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,yCAAyC,EAAE,GAAG,EAAE;IAErD,MAAM,QAAQ,GAAG,IAAI,8BAA8B,EAAE,CAAC;IAEtD,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAClD,MAAM,OAAO,GAAG,QAAQ,CAAC,kBAAkB,CAAC;YACxC,8BAA8B;YAC9B,kEAAkE;SACrE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACd,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,kEAAkE,CAAC,CAAC;IACjG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACnE,MAAM,OAAO,GAAG,QAAQ,CAAC,kBAAkB,CAAC;YACxC,sBAAsB;YACtB,0DAA0D;SAC7D,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACd,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;QAC9E,MAAM,OAAO,GAAG,QAAQ,CAAC,kBAAkB,CAAC;YACxC,iFAAiF;YACjF,wGAAwG;YACxG,yCAAyC;SAC5C,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACd,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gFAAgF,EAAE,GAAG,EAAE;QACtF,MAAM,OAAO,GAAG,QAAQ,CAAC,kBAAkB,CAAC;YACxC,8BAA8B;YAC9B,qFAAqF;SACxF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACd,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;QACxD,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2EAA2E,EAAE,GAAG,EAAE;QACjF,IAAA,aAAM,EAAC,QAAQ,CAAC,kBAAkB,CAAC,gCAAgC,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAClH,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,oCAAoC,EAAE,GAAG,EAAE;IAEhD,MAAM,QAAQ,GAAG,IAAI,8BAA8B,EAAE,CAAC;IAEtD,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAC9C,IAAA,aAAM,EAAC,QAAQ,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC1F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACnD,IAAA,aAAM,EAAC,QAAQ,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAClG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;QAC9E,IAAA,aAAM,EAAC,QAAQ,CAAC,aAAa,CAAC,wBAAwB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACjG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kFAAkF,EAAE,GAAG,EAAE;QACxF,IAAA,aAAM,EAAC,QAAQ,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAClG,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,sCAAsC,EAAE,GAAG,EAAE;IAElD,EAAE,CAAC,0FAA0F,EAAE,KAAK,IAAI,EAAE;QACtG,MAAM,QAAQ,GAAG,IAAI,8BAA8B,EAAE,CAAC;QACtD,MAAM,MAAM,GAAG,IAAI,uBAAQ,EAAW,CAAC;QACvC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAEhC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC;QAE7B,IAAA,aAAM,EAAC,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,0CAA0C,EAAE,GAAG,EAAE;IAEtD,MAAM,QAAQ,GAAG,IAAI,8BAA8B,EAAE,CAAC;IAEtD,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QAClE,MAAM,MAAM,GAAG;YACX,6CAA6C;YAC7C,GAAG;YACH,gEAAgE;YAChE,gCAAgC;YAChC,GAAG;SACN,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACb,IAAA,aAAM,EAAC,QAAQ,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;IAChG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAChE,IAAA,aAAM,EAAC,QAAQ,CAAC,mBAAmB,CAAC,8CAA8C,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxI,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACtD,IAAA,aAAM,EAAC,QAAQ,CAAC,mBAAmB,CAAC,8EAA8E,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IACzI,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC3D,IAAA,aAAM,EAAC,QAAQ,CAAC,mBAAmB,CAAC,8BAA8B,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IACzF,CAAC,CAAC,CAAC;AAEP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,0CAA0C,EAAE,GAAG,EAAE;IAEtD,MAAM,QAAQ,GAAG,IAAI,8BAA8B,EAAE,CAAC;IACtD,MAAM,KAAK,GAAG,oCAAoC,CAAC;IACnD,IAAI,IAAY,CAAC;IAEjB,UAAU,CAAC,KAAK,IAAI,EAAE;QAClB,IAAI,GAAG,MAAM,aAAE,CAAC,OAAO,CAAC,IAAA,WAAI,EAAC,EAAE,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACjB,MAAM,aAAE,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,aAAE,CAAC,SAAS,CAAC,IAAA,WAAI,EAAC,IAAI,EAAE,aAAa,CAAC,EAAE,2BAA2B,KAAK,OAAO,CAAC,CAAC;QACvF,IAAA,aAAM,EAAC,MAAM,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,aAAE,CAAC,SAAS,CAAC,IAAA,WAAI,EAAC,IAAI,EAAE,eAAe,CAAC,EAAE,eAAe,KAAK,KAAK,CAAC,CAAC;QAC3E,MAAM,aAAE,CAAC,SAAS,CAAC,IAAA,WAAI,EAAC,IAAI,EAAE,eAAe,CAAC,EAAE,gBAAgB,KAAK,IAAI,CAAC,CAAC;QAC3E,IAAA,aAAM,EAAC,MAAM,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;QAChF,yFAAyF;QACzF,MAAM,aAAE,CAAC,SAAS,CAAC,IAAA,WAAI,EAAC,IAAI,EAAE,WAAW,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,KAAK,KAAK,IAAI,CAAC,CAAC;QAC1F,IAAA,aAAM,EAAC,MAAM,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QAChE,MAAM,aAAE,CAAC,SAAS,CAAC,IAAA,WAAI,EAAC,IAAI,EAAE,aAAa,CAAC,EAAE,kCAAkC,CAAC,CAAC;QAClF,IAAA,aAAM,EAAC,MAAM,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IACrE,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,4CAA4C,EAAE,GAAG,EAAE;IAExD,MAAM,QAAQ,GAAG,IAAI,8BAA8B,EAAE,CAAC;IAEtD,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACjD,IAAA,aAAM,EAAC,QAAQ,CAAC,qBAAqB,CAAC,qCAAqC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACvG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC1D,IAAA,aAAM,EAAC,QAAQ,CAAC,qBAAqB,CAAC,uCAAuC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC1G,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC1D,IAAA,aAAM,EAAC,QAAQ,CAAC,qBAAqB,CAAC,8BAA8B,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IAC3F,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,yCAAyC,EAAE,GAAG,EAAE;IAErD,MAAM,QAAQ,GAAG,IAAI,8BAA8B,EAAE,CAAC;IAEtD,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAC7E,MAAM,GAAG,GAAG,QAAQ,CAAC,kBAAkB,CAAC,+BAA+B,EAAE,6CAA6C,CAAC,CAAC;QACxH,IAAA,aAAM,EAAC,GAAG,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnE,IAAA,aAAM,EAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4EAA4E,EAAE,GAAG,EAAE;QAClF,MAAM,QAAQ,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;QACpC,IAAI,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,iBAAiB,CAAC;YAC7C,MAAM,GAAG,GAAG,QAAQ,CAAC,kBAAkB,CAAC,WAAW,EAAE,yBAAyB,CAAC,CAAC;YAChF,IAAA,aAAM,EAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAC7F,CAAC;gBAAS,CAAC;YACP,OAAO,CAAC,GAAG,GAAG,QAAQ,CAAC;QAC3B,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8EAA8E,EAAE,GAAG,EAAE;QACpF,MAAM,GAAG,GAAG,QAAQ,CAAC,kBAAkB,CAAC,+BAA+B,EAAE,6CAA6C,CAAC,CAAC;QACxH,IAAA,aAAM,EAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QACjD,IAAA,aAAM,EAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QACrC,IAAA,aAAM,EAAC,GAAG,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yEAAyE,EAAE,GAAG,EAAE;QAC/E,MAAM,GAAG,GAAG,QAAQ,CAAC,kBAAkB,CAAC,+BAA+B,EAAE,6CAA6C,CAAC,CAAC;QACxH,IAAA,aAAM,EAAC,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAC;QAC5E,IAAA,aAAM,EAAC,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QACpC,IAAA,aAAM,EAAC,GAAG,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IAChD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/node/copilot-cli-locator.d.ts

@@ -0,0 +1,120 @@
+import { ILogger } from '@theia/core';
+/**
+ * Environment variable that points at the Copilot CLI, honored by the Copilot SDK as well.
+ */
+export declare const COPILOT_CLI_PATH_ENV = "COPILOT_CLI_PATH";
+/**
+ * Locates the executable of the GitHub Copilot CLI on the machine running the backend.
+ *
+ * The CLI is a native executable that GitHub ships in a platform-specific package. It is looked up
+ * rather than bundled, because it is a large proprietary binary that an application does not
+ * necessarily carry: a packaged application (for example an AppImage) cannot execute a binary from
+ * inside its archive, and an installation may deliberately not ship it at all. Users install the CLI
+ * themselves, the same way as for the Claude Code integration.
+ *
+ * The native executable is resolved rather than the `index.js` entry point of the same package, so
+ * that it can be spawned directly. Spawning the JavaScript entry point would require a Node.js
+ * executable, which the backend does not have at hand: `process.execPath` is the Electron binary in
+ * an Electron application, and starting that would start a second application instead of the CLI.
+ */
+export declare class CopilotCliLocator {
+    protected readonly logger: ILogger;
+    protected configuredPath: string | undefined;
+    protected resolution: Promise<string> | undefined;
+    /**
+     * Sets the location the user configured, which takes precedence over every other source.
+     * A changed value discards what was resolved before.
+     */
+    setConfiguredPath(path: string | undefined): void;
+    /**
+     * Resolves the executable of the Copilot CLI, and remembers it for later calls.
+     * Rejects with an explanation of where it was searched when there is none.
+     */
+    resolve(): Promise<string>;
+    protected doResolve(): Promise<string>;
+    /**
+     * Accepts the configured location either as the executable itself or as the directory holding it,
+     * so that both what a user has on their `PATH` and what a package manager installed can be given.
+     *
+     * A configured launcher is followed to the executable it would start, because that is what `which`
+     * or `whereis` report for a global installation. Starting the launcher would work as well, but only
+     * for as long as a Node.js is on the `PATH` of the backend, which is nothing to rely on.
+     */
+    protected resolveConfiguredPath(configured: string): Promise<string | undefined>;
+    /**
+     * The location given in the environment, resolved the same way as a configured one.
+     *
+     * The variable is documented as doing what the preference does, so a directory or a launcher is
+     * accepted here as well. A value that leads nowhere is reported and then left behind rather than
+     * turned into an error, so that the remaining sources still get their chance.
+     */
+    protected environmentCandidates(): Promise<string[]>;
+    /**
+     * The executable of a platform package that was installed alongside this application, if any.
+     *
+     * Both the module paths of this file and those of the Copilot SDK are searched, so that the
+     * package is found whether the installation hoisted it or nested it below the SDK.
+     */
+    protected bundledCandidates(): Promise<string[]>;
+    /**
+     * The executable of a platform package as Node.js resolves it from the given file.
+     *
+     * This is how the launcher of the CLI finds its own executable, and it is the only lookup that
+     * covers every layout: an installation hoists the platform package next to the launcher, while a
+     * global installation nests it below the launcher instead. The package points its main entry at
+     * the executable, so the directory of what was resolved is the directory holding it.
+     */
+    protected resolvedCandidates(anchor: string): string[];
+    /**
+     * The executable of a CLI that is on the `PATH` of the backend process.
+     *
+     * A global npm installation does not put the executable itself there but a launcher: a link to
+     * the JavaScript entry point on Linux and macOS, and a `.cmd` shim on Windows. Such a hit is
+     * therefore mapped to the platform package it belongs to, see {@link toCandidatesOnPath}.
+     */
+    protected pathCandidates(): Promise<string[]>;
+    /**
+     * Interprets what a `copilot` on the `PATH` points at: a launcher of a global npm installation is
+     * mapped to the executable of the platform package it would start, anything else is taken to be
+     * the executable itself.
+     */
+    protected toCandidatesOnPath(target: string): string[];
+    /**
+     * The executable of a globally installed CLI, for the case that the global binary directory is
+     * not on the `PATH` of the backend process. That is common when the application was started from
+     * a desktop launcher rather than from a shell.
+     */
+    protected globalInstallCandidates(): Promise<string[]>;
+    /**
+     * The executables a module directory can hold the CLI in.
+     *
+     * A global installation nests the platform package below the launcher rather than hoisting it, so
+     * the launcher is used to resolve from, and the hoisted layout is tried as well.
+     */
+    protected moduleDirectoryCandidates(modules: string): string[];
+    /**
+     * The executables the platform packages of this host would have below the given module directory.
+     */
+    protected toPlatformPackageCandidates(base: string): string[];
+    /**
+     * The platform-specific packages that can carry the CLI for this host.
+     * On Linux both the glibc and the musl build are candidates.
+     */
+    protected getCliPlatformPackageNames(): string[];
+    protected getBinaryName(): string;
+    /**
+     * The names a CLI can go by in a directory that is on the `PATH` or that a user configured: the
+     * executable itself, and on Windows in addition the shim a global npm installation writes, since
+     * that is the only entry it puts there.
+     */
+    protected getCliFileNames(): string[];
+    /**
+     * Whether the given path is something that starts the CLI rather than the CLI itself, which is
+     * either its JavaScript entry point or a shim of a global installation.
+     */
+    protected isLauncher(path: string): boolean;
+    protected isJsEntryPoint(path: string): boolean;
+    protected isShim(path: string): boolean;
+    protected isExecutable(path: string): Promise<boolean>;
+}
+//# sourceMappingURL=copilot-cli-locator.d.ts.map

package/lib/node/copilot-cli-locator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"copilot-cli-locator.d.ts","sourceRoot":"","sources":["../../src/node/copilot-cli-locator.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,OAAO,EAAO,MAAM,aAAa,CAAC;AAI3C;;GAEG;AACH,eAAO,MAAM,oBAAoB,qBAAqB,CAAC;AAOvD;;;;;;;;;;;;;GAaG;AACH,qBACa,iBAAiB;IAG1B,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEnC,SAAS,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7C,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAElD;;;OAGG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAQjD;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;cAehB,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAwC5C;;;;;;;OAOG;cACa,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAqBtF;;;;;;OAMG;cACa,qBAAqB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAe1D;;;;;OAKG;cACa,iBAAiB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IActD;;;;;;;OAOG;IACH,SAAS,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE;IAYtD;;;;;;OAMG;cACa,cAAc,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAkBnD;;;;OAIG;IACH,SAAS,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE;IActD;;;;OAIG;cACa,uBAAuB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAe5D;;;;;OAKG;IACH,SAAS,CAAC,yBAAyB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE;IAU9D;;OAEG;IACH,SAAS,CAAC,2BAA2B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;IAO7D;;;OAGG;IACH,SAAS,CAAC,0BAA0B,IAAI,MAAM,EAAE;IAKhD,SAAS,CAAC,aAAa,IAAI,MAAM;IAIjC;;;;OAIG;IACH,SAAS,CAAC,eAAe,IAAI,MAAM,EAAE;IAIrC;;;OAGG;IACH,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI3C,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI/C,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;cAIvB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAa/D"}