Remove triggerReload from ActiveSolutionTracker interface

Author: edriouk

src/desktop/extension.ts

@@ -221,7 +221,7 @@ export const activate = async (context: ExtensionContext): Promise<CsolutionExte
     const fileDecorationProviderManager = new FileDecorationProviderManagerImpl();
     const treeViewProviderImpl = new TreeViewProviderImpl(SolutionOutlineView.treeViewId);
     const treeViewFileDecorationProvider = new TreeViewFileDecorationProvider(fileDecorationProviderManager, themeProvider);
-    const mergeCommand = new MergeCommand(commandsProvider, activeSolutionTracker);
+    const mergeCommand = new MergeCommand(commandsProvider);
     const buildCommand = new BuildCommand(buildTaskProvider, commandsProvider, buildTaskDefinitionBuilder);
     const runGeneratorCommand = new GeneratorCommand(commandsProvider, solutionManager, outputChannelProvider, cmsisToolboxManager);
     const armclangDefineGetter = new ArmclangDefineGetter(processManager, workspaceFsProvider);

src/manifest.ts

@@ -46,6 +46,7 @@ export const CONFIG_AUTO_SHOW_CMSIS_VIEW = 'autoShowCMSISView';
 export const CONFIG_BUILD_OUTPUT_VERBOSITY = 'buildOutputVerbosity';
 export const MANAGE_COMPONENTS_PACKS_COMMAND_ID = `${PACKAGE_NAME}.manageComponentsPacks`;
 export const MERGE_FILE_COMMAND_ID = `${PACKAGE_NAME}.mergeFile`;
+export const REFRESH_COMMAND_ID = `${PACKAGE_NAME}.refresh`;
 
 export const MIN_TOOLBOX_VERSION = '2.12.0';
 

src/solutions/active-solution-tracker.factories.ts

@@ -69,7 +69,6 @@ export const activeSolutionTrackerFactory = makeFactory<MockActiveSolutionTracke
     solutions: () => [],
     activate: () => jest.fn(),
     getSolutionDetails: () => jest.fn(),
-    triggerReload: (r) => jest.fn(() => r.onActiveSolutionFilesChangedEmitter?.fire()),
     suspendWatch: () => false,
     mockFireActiveSolutionFilesChanged: (r) => () => r.onActiveSolutionFilesChangedEmitter?.fire(),
 });

src/solutions/active-solution-tracker.ts

@@ -83,8 +83,6 @@ export interface ActiveSolutionTracker {
 
     getSolutionDetails(solutionPath: string): SolutionDetails;
 
-    triggerReload(): void;
-
     suspendWatch: boolean;
 }
 
@@ -297,7 +295,7 @@ export class ActiveSolutionTrackerImpl implements ActiveSolutionTracker {
         return this.configurationProvider.getConfigVariable<string>(manifest.CONFIG_EXCLUDE) || undefined;
     }
 
-    public triggerReload(): void {
+    private triggerReload(): void {
         this.activeSolutionFilesChangedEmitter.fire();
     }
 

src/solutions/solution-manager.test.ts

@@ -18,6 +18,7 @@ import 'jest';
 import * as vscode from 'vscode';
 import * as path from 'path';
 import { SolutionLoadState, SolutionManagerImpl } from './solution-manager';
+import * as manifest from '../manifest';
 import { EventEmitter, Event, ExtensionContext, ConfigurationChangeEvent, } from 'vscode';
 import { ActiveSolutionTracker, SolutionDetails, } from './active-solution-tracker';
 import { waitTimeout } from '../__test__/test-waits';
@@ -47,7 +48,6 @@ describe('SolutionManager', () => {
         onDidChangeActiveSolution: Event<void>;
         onActiveSolutionFilesChanged: Event<void>;
         getSolutionDetails: jest.Mock;
-        triggerReload: jest.Mock;
         suspendWatch: boolean;
     };
     let changeActiveSolutionEmitter: EventEmitter<void>;
@@ -102,7 +102,6 @@ describe('SolutionManager', () => {
                     displayName: path.basename(solutionPath),
                 }),
             ),
-            triggerReload: jest.fn(() => changeSolutionFilesEmitter.fire()),
             suspendWatch: false,
         };
 
@@ -155,7 +154,7 @@ describe('SolutionManager', () => {
     it('register the command on activation', async () => {
         expect(commandsProvider.registerCommand).toHaveBeenCalledTimes(1);
         expect(commandsProvider.registerCommand).toHaveBeenCalledWith(
-            SolutionManagerImpl.refreshCommandId,
+            manifest.REFRESH_COMMAND_ID,
             expect.any(Function),
             expect.anything(),
         );
@@ -168,7 +167,7 @@ describe('SolutionManager', () => {
         await waitTimeout(100);
 
         await commandsProvider.mockRunRegistered(
-            SolutionManagerImpl.refreshCommandId,
+            manifest.REFRESH_COMMAND_ID,
         );
 
         await waitTimeout(100);

src/solutions/solution-manager.ts

@@ -72,8 +72,6 @@ export interface SolutionManager {
 }
 
 export class SolutionManagerImpl implements SolutionManager {
-    public static readonly refreshCommandId = `${manifest.PACKAGE_NAME}.refresh`;
-
     private readonly loadStateChangeEmitter = new vscode.EventEmitter<SolutionLoadStateChangeEvent>();
     public readonly onDidChangeLoadState = this.loadStateChangeEmitter.event;
 
@@ -103,7 +101,7 @@ export class SolutionManagerImpl implements SolutionManager {
             this.activeSolutionTracker.onActiveSolutionFilesChanged(this.handleActiveSolutionFilesChanged, this),
             this.eventHub.onDidConvertCompleted(this.handleSolutionConvertCompleted, this),
             this.eventHub.onDidCbuildCompleted(this.handleCbuildCompleted, this),
-            this.commandsProvider.registerCommand(SolutionManagerImpl.refreshCommandId, this.refresh, this),
+            this.commandsProvider.registerCommand(manifest.REFRESH_COMMAND_ID, this.refresh, this),
             this.environmentManagerApiProvider.onActivate(environmentManagerApi => {
                 environmentManagerApi.onDidActivate(() => {
                     if (!this.isSolutionActivated()) {

src/views/solution-outline/commands/merge-command.test.ts

@@ -36,7 +36,7 @@ import * as vscode from 'vscode';
 import { extensionContextFactory } from '../../../vscode-api/extension-context.factories';
 import { commandsProviderFactory, MockCommandsProvider } from '../../../vscode-api/commands-provider.factories';
 import { MergeCommand } from './merge-command';
-import { activeSolutionTrackerFactory, MockActiveSolutionTracker } from '../../../solutions/active-solution-tracker.factories';
+import * as manifest from '../../../manifest';
 import { COutlineItem } from '../tree-structure/solution-outline-item';
 import * as child_process from 'child_process';
 import * as os from 'os';
@@ -48,7 +48,6 @@ jest.mock('os');
 
 describe('MergeCommand', () => {
     let commandsProvider: MockCommandsProvider;
-    let activeSolutionTracker: MockActiveSolutionTracker;
     let command: MergeCommand;
     const testDataHandler = new TestDataHandler();
     let tmpDir: string;
@@ -80,8 +79,7 @@ describe('MergeCommand', () => {
         fsUtils.writeTextFile(path.join(tmpDir, 'component.c.base@1.0.0'), '// base\n');
 
         commandsProvider = commandsProviderFactory();
-        activeSolutionTracker = activeSolutionTrackerFactory();
-        command = new MergeCommand(commandsProvider, activeSolutionTracker);
+        command = new MergeCommand(commandsProvider);
 
         componentNode = new COutlineItem('component');
         componentNode.setTag('component');
@@ -358,7 +356,7 @@ describe('MergeCommand', () => {
             expect(warningSpy).toHaveBeenCalledWith('Merge exited with code 1. Conflicts may exist.');
             expect(deleteFileIfExistsSpy).not.toHaveBeenCalled();
             expect(renameFileSpy).not.toHaveBeenCalled();
-            expect(activeSolutionTracker.triggerReload).not.toHaveBeenCalled();
+            expect(commandsProvider.executeCommand).not.toHaveBeenCalledWith(manifest.REFRESH_COMMAND_ID);
         });
 
         it('handles merge errors gracefully', async () => {
@@ -436,7 +434,7 @@ describe('MergeCommand', () => {
             expect(deleteFileIfExistsSpy).toHaveBeenCalledWith(base);
             expect(renameFileSpy).toHaveBeenCalledWith(update, expectedBase);
             expect(renameFileSpy).toHaveBeenCalledWith(merged, local);
-            expect(activeSolutionTracker.triggerReload).toHaveBeenCalledTimes(1);
+            expect(commandsProvider.executeCommand).toHaveBeenCalledWith(manifest.REFRESH_COMMAND_ID);
         });
     });
 });

src/views/solution-outline/commands/merge-command.ts

@@ -16,12 +16,11 @@
 
 import * as vscode from 'vscode';
 import { CommandsProvider } from '../../../vscode-api/commands-provider';
-import { PACKAGE_NAME } from '../../../manifest';
+import { PACKAGE_NAME, REFRESH_COMMAND_ID } from '../../../manifest';
 import { exec, ExecException, execSync } from 'child_process';
 import { COutlineItem } from '../tree-structure/solution-outline-item';
 import path from 'path';
 import * as os from 'os';
-import { ActiveSolutionTracker } from '../../../solutions/active-solution-tracker';
 import semver from 'semver';
 import { extractVersion } from '../../../utils/string-utils';
 import * as fsUtils from '../../../utils/fs-utils';
@@ -32,7 +31,6 @@ export class MergeCommand {
 
     constructor(
         private readonly commandsProvider: CommandsProvider,
-        private readonly activeSolutionTracker: ActiveSolutionTracker,
     ) { }
 
     public async activate(context: Pick<vscode.ExtensionContext, 'subscriptions'>) {
@@ -121,7 +119,7 @@ export class MergeCommand {
             }
 
             if (exitCode === 0 && mergedMTimeAfter > mergedMTimeBefore) {
-                this.performPostMergeOperations(local, update, base, merged);
+                await this.performPostMergeOperations(local, update, base, merged);
             }
 
         } catch (err) {
@@ -149,7 +147,7 @@ export class MergeCommand {
         return { local, update, base };
     }
 
-    private performPostMergeOperations(local: string, update: string, base: string, merged: string): void {
+    private async performPostMergeOperations(local: string, update: string, base: string, merged: string): Promise<void> {
         // create .bak file of local file
         const backupPath = `${local}.bak`;
         fsUtils.copyFile(local, backupPath);
@@ -170,7 +168,7 @@ export class MergeCommand {
         fsUtils.renameFile(merged, local);
 
         // refresh tree view to update file status
-        this.activeSolutionTracker.triggerReload();
+        await this.commandsProvider.executeCommand(REFRESH_COMMAND_ID);
     }
 
     private getVSCodeExecutablePath(): string | undefined {