Introduce devsphere view specific commands

Author: akalia-atlassian

package.json

@@ -99,6 +99,16 @@
                 },
                 "category": "Atlassian"
             },
+            {
+                "command": "atlascode.devsphere.review.initialise",
+                "title": "Initialise Devsphere Review Settings",
+                "category": "Atlassian"
+            },
+            {
+                "command": "atlascode.devsphere.custom.reset",
+                "title": "Reset Devsphere Custom Configuration",
+                "category": "Atlassian"
+            },
             {
                 "command": "atlascode.jira.searchIssues",
                 "title": "Search Jira Issue Results",

src/commands.ts

@@ -29,6 +29,8 @@ export enum Commands {
     BitbucketSelectContainer = 'atlascode.bb.selectContainer',
     BitbucketPullRequestsOverviewRefresh = 'atlascode.bitbucket.pullRequestsOverview.refresh',
     BitbucketPullRequestsOverviewFocus = 'atlascode.views.bb.pullRequestsOverviewTreeView.focus',
+    InitialiseDevsphereReviewSettings = 'atlascode.devsphere.review.initialise',
+    ResetDevsphereCustomConfiguration = 'atlascode.devsphere.custom.reset',
     BitbucketFetchPullRequests = 'atlascode.bb.fetchPullRequests',
     BitbucketRefreshPullRequests = 'atlascode.bb.refreshPullRequests',
     BitbucketToggleFileNesting = 'atlascode.bb.toggleFileNesting',

src/config/devsphere-config/devsphereConfigReview.ts

@@ -0,0 +1,23 @@
+import { Commands } from '../../commands';
+import { executeVSCodeCommand, LifecycleFns, updateConfig } from './devsphereConfigurationManager';
+
+async function reviewSetup(): Promise<void> {
+    await Promise.all([
+        executeVSCodeCommand(Commands.BitbucketPullRequestsOverviewFocus),
+        updateConfig('workbench.editor', 'showTabs', 'single'),
+        executeVSCodeCommand('workbench.action.closePanel'),
+        executeVSCodeCommand('workbench.action.closeAuxiliaryBar'),
+    ]);
+}
+
+async function reviewTeardown(): Promise<void> {
+    await Promise.allSettled([
+        updateConfig('workbench.editor', 'showTabs', 'multiple'),
+        executeVSCodeCommand('workbench.files.action.focusFilesExplorer'),
+    ]);
+}
+
+export const reviewLifecycleFns: LifecycleFns = {
+    setup: reviewSetup,
+    shutdown: reviewTeardown,
+};

src/config/devsphere-config/devsphereConfigurationManager.ts

@@ -0,0 +1,71 @@
+import { commands, Disposable, workspace } from 'vscode';
+
+export async function executeVSCodeCommand(command: string): Promise<void> {
+    try {
+        await commands.executeCommand(command);
+    } catch (error) {
+        console.error(`Failed to execute VS Code command: ${command}`, error);
+    }
+}
+
+export async function updateConfig(section: string, key: string, value: any): Promise<void> {
+    const config = workspace.getConfiguration(section);
+    if (config.get(key) !== value) {
+        await config.update(key, value, true);
+    }
+}
+
+/**
+ * Type representing all valid view names in the application.
+ *
+ * @important When creating a new view, you must add its name to this union type
+ * and register its teardown function in the teardownFunctions map.
+ */
+export enum View {
+    Review = 'review',
+    Noop = 'noop',
+}
+
+export type LifecycleFns = {
+    setup: () => Promise<void>;
+    shutdown: () => Promise<void>;
+};
+
+export const getDefaultLifecycleFns = (): LifecycleFns => ({
+    setup: async () => {},
+    shutdown: async () => {},
+});
+
+export class DevsphereConfigurationManager implements Disposable {
+    private currentView: View = View.Noop;
+
+    constructor(private lifecycleFunctions: Record<View, LifecycleFns>) {}
+
+    dispose() {
+        this.lifecycleFunctions = {
+            [View.Noop]: getDefaultLifecycleFns(),
+            [View.Review]: getDefaultLifecycleFns(),
+        };
+    }
+
+    async setupView(view: View) {
+        const oldView = this.currentView;
+        this.currentView = view;
+
+        if (oldView !== view) {
+            try {
+                await this.lifecycleFunctions[oldView].shutdown();
+            } catch (error) {
+                console.error(`Failed to shutdown view: ${oldView}`, error);
+            }
+        }
+
+        try {
+            // Setup is called even if oldView is the same because a user may have run the individual
+            // commands separately and we want a consistent state when the view is re-selected.
+            await this.lifecycleFunctions[view].setup();
+        } catch (error) {
+            console.error(`Failed to setup view: ${view}`, error);
+        }
+    }
+}

src/config/devsphere-config/registerDevsphereCommands.ts

@@ -0,0 +1,31 @@
+import { commands, ExtensionContext } from 'vscode';
+
+import { Commands } from '../../commands';
+import { reviewLifecycleFns } from './devsphereConfigReview';
+import {
+    DevsphereConfigurationManager,
+    getDefaultLifecycleFns,
+    LifecycleFns,
+    View,
+} from './devsphereConfigurationManager';
+
+// Map view names to their teardown functions - must include all possible ViewName values
+const lifecycleFunctions: Record<View, LifecycleFns> = {
+    [View.Review]: reviewLifecycleFns,
+    [View.Noop]: getDefaultLifecycleFns(),
+};
+
+export function registerDevsphereCommands(context: ExtensionContext): void {
+    const devsphereConfigManager = new DevsphereConfigurationManager(lifecycleFunctions);
+
+    context.subscriptions.push(devsphereConfigManager);
+
+    context.subscriptions.push(
+        commands.registerCommand(Commands.InitialiseDevsphereReviewSettings, () =>
+            devsphereConfigManager.setupView(View.Review),
+        ),
+        commands.registerCommand(Commands.ResetDevsphereCustomConfiguration, () =>
+            devsphereConfigManager.setupView(View.Noop),
+        ),
+    );
+}

src/extension.ts

@@ -10,6 +10,7 @@ import { activate as activateCodebucket } from './codebucket/command/registerCom
 import { CommandContext, setCommandContext } from './commandContext';
 import { Commands, registerCommands } from './commands';
 import { Configuration, configuration, IConfig } from './config/configuration';
+import { registerDevsphereCommands } from './config/devsphere-config/registerDevsphereCommands';
 import { ExtensionId, GlobalStateVersionKey } from './constants';
 import { Container } from './container';
 import { registerAnalyticsClient, registerErrorReporting, unregisterErrorReporting } from './errorReporting';
@@ -92,7 +93,7 @@ export async function activate(context: ExtensionContext) {
     // icon to appear in the activity bar
     activateBitbucketFeatures();
     activateYamlFeatures(context);
-
+    registerDevsphereCommands(context);
     Logger.info(
         `Atlassian for VS Code (v${atlascodeVersion}) activated in ${
             duration[0] * 1000 + Math.floor(duration[1] / 1000000)