@theia/variable-resolver 1.77.0-next.1 → 1.77.0-next.101

package/src/browser/common-variable-contribution.spec.ts

@@ -0,0 +1,157 @@
+// *****************************************************************************
+// Copyright (C) 2026 Md. Mehedi Hasan.
+//
+// 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
+// *****************************************************************************
+
+import { enableJSDOM } from '@theia/core/lib/browser/test/jsdom';
+
+let disableJSDOM = enableJSDOM();
+
+import { ResourceContextKey } from '@theia/core/lib/browser/resource-context-key';
+import { ApplicationServer } from '@theia/core/lib/common/application-protocol';
+import { CommandService } from '@theia/core/lib/common/command';
+import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
+import { isCancelled } from '@theia/core/lib/common/cancellation';
+import { ILogger } from '@theia/core/lib/common/logger';
+import { PreferenceService } from '@theia/core/lib/common/preferences/preference-service';
+import { QuickInputService } from '@theia/core/lib/common/quick-pick-service';
+import { MockLogger } from '@theia/core/lib/common/test/mock-logger';
+import { Container } from '@theia/core/shared/inversify';
+import { expect } from 'chai';
+import * as sinon from 'sinon';
+import URI from '@theia/core/lib/common/uri';
+import { CommonVariableContribution } from './common-variable-contribution.js';
+import { VariableInput } from './variable-input.js';
+import { VariableRegistry } from './variable.js';
+
+disableJSDOM();
+
+describe('CommonVariableContribution', () => {
+
+    before(() => {
+        disableJSDOM = enableJSDOM();
+    });
+
+    after(() => {
+        disableJSDOM();
+    });
+
+    const workspace = new URI('file:///workspace');
+    const promptInput: VariableInput = {
+        id: 'task-argument',
+        type: 'promptString',
+        description: 'Enter a task argument',
+        default: 'default-value'
+    };
+    const pickInput: VariableInput = {
+        id: 'task-argument-choice',
+        type: 'pickString',
+        description: 'Choose a task argument',
+        options: ['first', 'second'],
+        default: 'second'
+    };
+
+    let variables: VariableRegistry;
+    let input: sinon.SinonStub;
+    let showQuickPick: sinon.SinonStub;
+
+    beforeEach(async () => {
+        const container = new Container();
+        container.bind(ILogger).to(MockLogger);
+        input = sinon.stub().resolves('task-argument');
+        showQuickPick = sinon.stub();
+        const inputs = [promptInput, pickInput];
+
+        container.bind<Partial<EnvVariablesServer>>(EnvVariablesServer).toConstantValue({
+            getExecPath: async () => ''
+        });
+        container.bind<Partial<CommandService>>(CommandService).toConstantValue({});
+        container.bind<Partial<PreferenceService>>(PreferenceService).toConstantValue({
+            get: sinon.stub().returns({ inputs })
+        });
+        container.bind<Partial<ResourceContextKey>>(ResourceContextKey).toConstantValue({
+            get: () => workspace.toString()
+        });
+        container.bind<Partial<QuickInputService>>(QuickInputService).toConstantValue({
+            input,
+            showQuickPick
+        });
+        container.bind<Partial<ApplicationServer>>(ApplicationServer).toConstantValue({});
+        container.bind(VariableRegistry).toSelf();
+        container.bind(CommonVariableContribution).toSelf();
+
+        variables = container.get(VariableRegistry);
+        await container.get(CommonVariableContribution).registerVariables(variables);
+    });
+
+    it('keeps promptString inputs open when focus is lost', async () => {
+        const resolved = await variables.getVariable('input')?.resolve(workspace, 'task-argument', 'tasks');
+
+        expect(resolved).to.equal('task-argument');
+        sinon.assert.calledOnceWithExactly(input, {
+            prompt: 'Enter a task argument',
+            value: 'default-value',
+            ignoreFocusLost: true
+        });
+    });
+
+    it('accepts an empty promptString value', async () => {
+        input.resolves('');
+
+        const resolved = await variables.getVariable('input')?.resolve(workspace, 'task-argument', 'tasks');
+
+        expect(resolved).to.equal('');
+    });
+
+    it('cancels promptString inputs when input returns undefined', async () => {
+        input.resolves(undefined);
+
+        let error: Error | undefined;
+        try {
+            await variables.getVariable('input')?.resolve(workspace, 'task-argument', 'tasks');
+        } catch (e) {
+            error = e as Error;
+        }
+
+        expect(isCancelled(error)).to.equal(true);
+    });
+
+    it('keeps pickString inputs open when focus is lost', async () => {
+        showQuickPick.resolves({ label: 'first', value: 'first' });
+
+        const resolved = await variables.getVariable('input')?.resolve(workspace, 'task-argument-choice', 'tasks');
+
+        expect(resolved).to.equal('first');
+        sinon.assert.calledOnceWithExactly(showQuickPick, [
+            { label: 'second', value: 'second', description: 'Default' },
+            { label: 'first', value: 'first' }
+        ], {
+            placeholder: 'Choose a task argument',
+            ignoreFocusOut: true
+        });
+    });
+
+    it('cancels pickString inputs when no item is selected', async () => {
+        showQuickPick.resolves(undefined);
+
+        let error: Error | undefined;
+        try {
+            await variables.getVariable('input')?.resolve(workspace, 'task-argument-choice', 'tasks');
+        } catch (e) {
+            error = e as Error;
+        }
+
+        expect(isCancelled(error)).to.equal(true);
+    });
+});

package/src/browser/common-variable-contribution.ts

@@ -15,14 +15,14 @@
 // *****************************************************************************
 
 import { injectable, inject, optional } from '@theia/core/shared/inversify';
-import { VariableContribution, VariableRegistry } from './variable';
+import { VariableContribution, VariableRegistry } from './variable.js';
 import { ApplicationServer } from '@theia/core/lib/common/application-protocol';
 import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
 import { CommandService } from '@theia/core/lib/common/command';
 import { OS } from '@theia/core/lib/common/os';
 import { PreferenceService } from '@theia/core/lib/common/preferences/preference-service';
 import { ResourceContextKey } from '@theia/core/lib/browser/resource-context-key';
-import { VariableInput } from './variable-input';
+import { VariableInput } from './variable-input.js';
 import { QuickInputService, QuickPickValue } from '@theia/core/lib/browser';
 import { MaybeArray, RecursivePartial } from '@theia/core/lib/common/types';
 import { cancelled } from '@theia/core/lib/common/cancellation';
@@ -108,10 +108,15 @@ export class CommonVariableContribution implements VariableContribution {
                     if (typeof input.description !== 'string') {
                         return undefined;
                     }
-                    return this.quickInputService?.input({
+                    const value = await this.quickInputService?.input({
                         prompt: input.description,
-                        value: input.default
+                        value: input.default,
+                        ignoreFocusLost: true
                     });
+                    if (value === undefined) {
+                        throw cancelled();
+                    }
+                    return value;
                 }
                 if (input.type === 'pickString') {
                     if (typeof input.description !== 'string' || !Array.isArray(input.options)) {
@@ -135,8 +140,14 @@ export class CommonVariableContribution implements VariableContribution {
                             });
                         }
                     }
-                    const selectedPick = await this.quickInputService?.showQuickPick(elements, { placeholder: input.description });
-                    return selectedPick?.value;
+                    const selectedPick = await this.quickInputService?.showQuickPick(elements, {
+                        placeholder: input.description,
+                        ignoreFocusOut: true
+                    });
+                    if (!selectedPick) {
+                        throw cancelled();
+                    }
+                    return selectedPick.value;
                 }
                 if (input.type === 'command') {
                     if (typeof input.command !== 'string') {

package/src/browser/index.ts

@@ -14,6 +14,6 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 // *****************************************************************************
 
-export * from './variable';
-export * from './variable-quick-open-service';
-export * from './variable-resolver-service';
+export * from './variable.js';
+export * from './variable-quick-open-service.js';
+export * from './variable-resolver-service.js';

package/src/browser/variable-quick-open-service.ts

@@ -16,8 +16,8 @@
 
 import { inject, injectable, optional } from '@theia/core/shared/inversify';
 import { MessageService } from '@theia/core/lib/common/message-service';
-import { VariableRegistry, Variable } from './variable';
-import { VariableResolverService } from './variable-resolver-service';
+import { VariableRegistry, Variable } from './variable.js';
+import { VariableResolverService } from './variable-resolver-service.js';
 import { QuickPickItem, QuickInputService } from '@theia/core/lib/browser';
 
 @injectable()

package/src/browser/variable-resolver-frontend-contribution.spec.ts

@@ -25,9 +25,9 @@ import * as chai from 'chai';
 import { Container, ContainerModule } from '@theia/core/shared/inversify';
 import { ILogger, bindContributionProvider } from '@theia/core/lib/common';
 import { MockLogger } from '@theia/core/lib/common/test/mock-logger';
-import { VariableContribution, VariableRegistry } from './variable';
-import { VariableQuickOpenService } from './variable-quick-open-service';
-import { VariableResolverFrontendContribution } from './variable-resolver-frontend-contribution';
+import { VariableContribution, VariableRegistry } from './variable.js';
+import { VariableQuickOpenService } from './variable-quick-open-service.js';
+import { VariableResolverFrontendContribution } from './variable-resolver-frontend-contribution.js';
 
 disableJSDOM();
 

package/src/browser/variable-resolver-frontend-contribution.ts

@@ -17,8 +17,8 @@
 import { injectable, inject, named } from '@theia/core/shared/inversify';
 import { FrontendApplicationContribution } from '@theia/core/lib/browser';
 import { Command, CommandContribution, CommandRegistry, ContributionProvider } from '@theia/core/lib/common';
-import { VariableContribution, VariableRegistry } from './variable';
-import { VariableQuickOpenService } from './variable-quick-open-service';
+import { VariableContribution, VariableRegistry } from './variable.js';
+import { VariableQuickOpenService } from './variable-quick-open-service.js';
 
 export const LIST_VARIABLES: Command = Command.toLocalizedCommand({
     id: 'variable.list',

package/src/browser/variable-resolver-frontend-module.ts

@@ -17,11 +17,11 @@
 import { ContainerModule } from '@theia/core/shared/inversify';
 import { bindRootContributionProvider, CommandContribution } from '@theia/core';
 import { FrontendApplicationContribution } from '@theia/core/lib/browser';
-import { VariableRegistry, VariableContribution } from './variable';
-import { VariableQuickOpenService } from './variable-quick-open-service';
-import { VariableResolverFrontendContribution } from './variable-resolver-frontend-contribution';
-import { VariableResolverService } from './variable-resolver-service';
-import { CommonVariableContribution } from './common-variable-contribution';
+import { VariableRegistry, VariableContribution } from './variable.js';
+import { VariableQuickOpenService } from './variable-quick-open-service.js';
+import { VariableResolverFrontendContribution } from './variable-resolver-frontend-contribution.js';
+import { VariableResolverService } from './variable-resolver-service.js';
+import { CommonVariableContribution } from './common-variable-contribution.js';
 
 export default new ContainerModule(bind => {
     bind(VariableRegistry).toSelf().inSingletonScope();

package/src/browser/variable-resolver-service.spec.ts

@@ -17,8 +17,8 @@
 import * as chai from 'chai';
 import { Container } from '@theia/core/shared/inversify';
 import { cancelled } from '@theia/core/lib/common';
-import { VariableRegistry } from './variable';
-import { VariableResolverService } from './variable-resolver-service';
+import { VariableRegistry } from './variable.js';
+import { VariableResolverService } from './variable-resolver-service.js';
 import { ILogger } from '@theia/core';
 import { MockLogger } from '@theia/core/lib/common/test/mock-logger';
 

package/src/browser/variable-resolver-service.ts

@@ -17,9 +17,9 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
 import { injectable, inject } from '@theia/core/shared/inversify';
-import { VariableRegistry } from './variable';
+import { VariableRegistry } from './variable.js';
 import URI from '@theia/core/lib/common/uri';
-import { CommandIdVariables } from '../common/variable-types';
+import { CommandIdVariables } from '../common/variable-types.js';
 import { isCancelled } from '@theia/core';
 
 export interface VariableResolveOptions {

package/src/browser/variable.spec.ts

@@ -18,7 +18,7 @@ import * as chai from 'chai';
 import { Container, ContainerModule } from '@theia/core/shared/inversify';
 import { ILogger, Disposable } from '@theia/core/lib/common';
 import { MockLogger } from '@theia/core/lib/common/test/mock-logger';
-import { Variable, VariableRegistry } from './variable';
+import { Variable, VariableRegistry } from './variable.js';
 
 const expect = chai.expect;
 let variableRegistry: VariableRegistry;

package/src/browser/variable.ts

@@ -17,7 +17,7 @@
 import { injectable, inject, named } from '@theia/core/shared/inversify';
 import { Disposable, DisposableCollection, MaybePromise, ILogger } from '@theia/core';
 import URI from '@theia/core/lib/common/uri';
-import { CommandIdVariables } from '../common/variable-types';
+import { CommandIdVariables } from '../common/variable-types.js';
 
 /**
  * Variable can be used inside of strings using ${variableName} syntax.