Added tests for restore database webview controller by laurenastrid1 · Pull Request #21566 · microsoft/vscode-mssql

laurenastrid1 · 2026-03-11T17:35:14Z

Description

Added tests for restoreDatabaseWebviewController

Code Changes Checklist

New or updated unit tests added
All existing tests pass (npm run test)
Code follows contributing guidelines
Telemetry/logging updated if relevant
No regressions or UX breakage

Reviewers: Please read our reviewer guidelines

Copilot

Pull request overview

Adds unit test coverage around RestoreDatabaseWebviewController behavior and reducer handlers, along with small initialization flow changes in the existing restore controller (and an additional restore controller implementation introduced in the backup controller module).

Changes:

Added a comprehensive unit test suite for RestoreDatabaseWebviewController covering initialization paths, reducers, and helper methods.
Adjusted RestoreDatabaseWebviewController.initializeDialog default initialization ordering and view-model update calls.
Introduced a second RestoreDatabaseWebviewController implementation inside backupDatabaseWebviewController.ts (in addition to the existing dedicated restore controller file).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 8 comments.

File	Description
extensions/mssql/test/unit/restoreDatabaseWebviewController.test.ts	New unit tests for restore controller initialization, reducers, and helpers.
extensions/mssql/src/controllers/restoreDatabaseWebviewController.ts	Tweaks to restore controller initialization defaults and update calls.
extensions/mssql/src/controllers/backupDatabaseWebviewController.ts	Adds a full restore controller implementation (duplicate location) and supporting imports.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-11T17:42:28Z

extensions/mssql/src/controllers/backupDatabaseWebviewController.ts

+export class RestoreDatabaseWebviewController extends ObjectManagementWebviewController<
+    RestoreDatabaseFormState,
+    RestoreDatabaseReducers<RestoreDatabaseFormState>
+> {


PR description/title indicate only adding tests, but this change adds a large new production controller (RestoreDatabaseWebviewController) into backupDatabaseWebviewController.ts and also modifies the existing restore controller. Please confirm whether these production code changes are intentional and update the PR description accordingly (or revert the unrelated additions).

Copilot · 2026-03-11T17:42:29Z

extensions/mssql/test/unit/restoreDatabaseWebviewController.test.ts

+        controller = new RestoreDatabaseWebviewController(
+            mockContext,
+            vscodeWrapper,
+            mockObjectManagementService,
+            mockConnectionManager,
+            mockFileBrowserService,
+            mockAzureBlobService,
+            mockProfile,
+            "ownerUri",
+            mockProfile.database,
+        );


mockFileBrowserService is declared but never assigned before being passed into the RestoreDatabaseWebviewController constructor. This will trigger TS2454 (used before assignment) and can also cause runtime failures when file browser reducers are registered. Initialize it in setup (e.g., create a stub instance) before constructing the controller.

Copilot · 2026-03-11T17:42:29Z

extensions/mssql/test/unit/restoreDatabaseWebviewController.test.ts

+
+        getRestoreConfigInfoStub =
+            mockObjectManagementService.getRestoreConfigInfo as sinon.SinonStub;
+        mockObjectManagementService.getBackupConfigInfo as sinon.SinonStub;


This line is a no-op expression (mockObjectManagementService.getBackupConfigInfo as sinon.SinonStub;) and looks like leftover scaffolding. It can be flagged by linting/no-unused-expressions rules; remove it or assign it to a variable if you intended to configure the stub.

Suggested change

mockObjectManagementService.getBackupConfigInfo as sinon.SinonStub;

You could probably remove this since it's not being assigned to anything.

Copilot · 2026-03-11T17:42:29Z

extensions/mssql/test/unit/restoreDatabaseWebviewController.test.ts

+        mockInitialState.formComponents = controller[
+            "setFormComponents"
+        ] as typeof mockInitialState.formComponents;


mockInitialState.formComponents is being assigned to the setFormComponents function reference instead of the function result. This makes formComponents incorrect for later tests that spread/use it. Call controller["setFormComponents"]() (or reuse controller.state.formComponents) to capture the actual components object.

Suggested change

mockInitialState.formComponents = controller[

"setFormComponents"

] as typeof mockInitialState.formComponents;

mockInitialState.formComponents = controller["state"]

.formComponents as typeof mockInitialState.formComponents;

Copilot · 2026-03-11T17:42:29Z

extensions/mssql/test/unit/restoreDatabaseWebviewController.test.ts

+        controller = new RestoreDatabaseWebviewController(
+            mockContext,
+            vscodeWrapper,
+            mockObjectManagementService,
+            mockConnectionManager,
+            mockFileBrowserService,
+            mockAzureBlobService,
+            mockProfile,
+            "ownerUri",
+            mockProfile.database,
+        );
+
+        mockInitialState = {
+            viewModel: {
+                dialogType: ObjectManagementDialogType.RestoreDatabase,
+                model: {
+                    loadState: ApiStatus.Loaded,
+                    azureComponentStatuses: {
+                        accountId: ApiStatus.NotStarted,
+                        tenantId: ApiStatus.NotStarted,
+                        subscriptionId: ApiStatus.NotStarted,
+                        storageAccountId: ApiStatus.NotStarted,
+                        blobContainerId: ApiStatus.NotStarted,
+                    },
+                    type: DisasterRecoveryType.BackupFile,
+                    backupFiles: [
+                        {
+                            filePath: `${mockConfigInfo.configInfo.defaultBackupFolder}/${defaultBackupName}`,
+                            isExisting: false,
+                        },
+                    ],
+                    tenants: [],
+                    subscriptions: [],
+                    storageAccounts: [],
+                    blobContainers: [],
+                    url: "",
+                    serverName: "serverName",
+                    restorePlan: undefined,
+                    restorePlanStatus: ApiStatus.NotStarted,
+                    blobs: [],
+                    cachedRestorePlanParams: undefined,
+                    selectedBackupSets: [],
+                } as RestoreDatabaseViewModel,
+            },
+            ownerUri: "ownerUri",
+            databaseName: "testDatabase",
+            defaultFileBrowserExpandPath: mockConfigInfo.configInfo.defaultBackupFolder,
+            formState: {
+                sourceDatabaseName: "",
+                targetDatabaseName: "",
+                accountId: "",
+                tenantId: "",
+                subscriptionId: "",
+                storageAccountId: "",
+                blobContainerId: "",
+                dataFileFolder: mockConfigInfo.configInfo.dataFileFolder,
+                logFileFolder: mockConfigInfo.configInfo.logFileFolder,
+            } as RestoreDatabaseFormState,
+            formComponents: {},
+            fileBrowserState: undefined,
+            dialog: undefined,
+            formErrors: [],
+            fileFilterOptions: [
+                {
+                    displayName: LocConstants.BackupDatabase.backupFileTypes,
+                    value: defaultBackupFileTypes,
+                },
+                {
+                    displayName: LocConstants.BackupDatabase.allFiles,
+                    value: allFileTypes,
+                },
+            ],
+        } as ObjectManagementWebviewState<RestoreDatabaseFormState>;
+
+        await controller["initializeDialog"]();
+


The controller constructor calls start(), which kicks off an async initializeDialog() automatically. The test then calls initializeDialog() again, causing multiple overlapping initializations and potential race/flakiness. Consider stubbing RestoreDatabaseWebviewController.prototype.start to a no-op (or using a test subclass) so the test controls when initialization runs.

Copilot · 2026-03-11T17:42:30Z

extensions/mssql/test/unit/restoreDatabaseWebviewController.test.ts

+        expect(result.options["backupFilePaths"]).to.equal("");
+        expect(result.options["readHeaderFromMedia"]).to.be.false;
+        expect(result.readHeaderFromMedia).to.be.false;
+        // AssertionError: expected '' to equal 'testDatabase'


The inline // AssertionError: expected '' to equal 'testDatabase' looks like leftover debugging output. Please remove it (or replace with a brief comment describing the intended behavior) to keep the test readable.

Suggested change

// AssertionError: expected '' to equal 'testDatabase'

// Expect the source database name to be preserved from the state

Copilot · 2026-03-11T17:42:30Z

extensions/mssql/src/controllers/restoreDatabaseWebviewController.ts

+
        void this.getRestorePlan(false)
            .then((state) => {
                restoreViewModel = this.setDefaultFormValuesFromPlan(state);


setDefaultFormValuesFromPlan(state) mutates state.formState / view model defaults, but the result is no longer propagated back to the webview (the previous updateViewModel(..., state) call was removed). This makes the default values computed from the restore plan effectively invisible to the UI. Consider calling updateState(state) or updating the view model/state after applying defaults so the webview receives the updated values.

Suggested change

restoreViewModel = this.setDefaultFormValuesFromPlan(state);

restoreViewModel = this.setDefaultFormValuesFromPlan(state);

this.updateViewModel(restoreViewModel);

Copilot · 2026-03-11T17:42:30Z

extensions/mssql/src/controllers/backupDatabaseWebviewController.ts

+export class RestoreDatabaseWebviewController extends ObjectManagementWebviewController<
+    RestoreDatabaseFormState,
+    RestoreDatabaseReducers<RestoreDatabaseFormState>
+> {


This file now contains a full RestoreDatabaseWebviewController implementation. There is already an exported RestoreDatabaseWebviewController in src/controllers/restoreDatabaseWebviewController.ts; duplicating the controller here will diverge over time and makes it ambiguous which module should be imported. Please remove the restore controller from backupDatabaseWebviewController.ts (and keep it in its dedicated file), or refactor to a shared helper if code reuse is the goal.

lewis-sanchez · 2026-03-12T04:23:39Z

extensions/mssql/src/controllers/backupDatabaseWebviewController.ts

    //#endregion
 }
+
+export class RestoreDatabaseWebviewController extends ObjectManagementWebviewController<


What's the difference between the RestoreDatabaseWebViewController class here and the one defined in restoreDatabaseWebviewController.ts? The two classes look identical. You might want to remove this one.

lewis-sanchez · 2026-03-12T04:37:53Z

extensions/mssql/test/unit/restoreDatabaseWebviewController.test.ts

+            azureProfile.database,
+        );
+
+        let getRestorePlanStub = sandbox.stub(azureController as any, "getRestorePlan");


Are you able to clean up some of the any usages in this file? Public methods/services could use sandbox.createStubInstance<T>().

If your using any types to mock private methods, then sinon won't be able to help there, but you could try exercising private methods indirectly through public reducers and mocking any injected services with createStubInstance.

lewis-sanchez · 2026-03-12T04:49:17Z

extensions/mssql/test/unit/restoreDatabaseWebviewController.test.ts

+    let mockObjectManagementService: ObjectManagementService;
+    let mockProfile: ConnectionProfile;
+    let mockConnectionManager: sinon.SinonStubbedInstance<ConnectionManager>;
+    let mockFileBrowserService: FileBrowserService;


You can probably remove this. It's only being passed into the controller constructor and since it's not setup or interacted with as a mock this is just being set to undefined

lewis-sanchez · 2026-03-12T04:51:38Z

extensions/mssql/test/unit/restoreDatabaseWebviewController.test.ts

+    let mockInitialState: ObjectManagementWebviewState<RestoreDatabaseFormState>;
+    let vscodeWrapper: sinon.SinonStubbedInstance<VscodeWrapper>;
+    let getRestoreConfigInfoStub: sinon.SinonStub;
+    // let getRestorePlanStub: sinon.SinonStub;


Remove this commented out code.

lewis-sanchez · 2026-03-12T04:55:13Z

extensions/mssql/test/unit/restoreDatabaseWebviewController.test.ts

+            .stub(happyController as any, "setDefaultFormValuesFromPlan")
+            .returns(mockInitialState.viewModel.model);
+        await happyController["initializeDialog"]();
+        await new Promise((resolve) => setTimeout(resolve, 0));


Replace this line with await Promise.resolve();

lewis-sanchez · 2026-03-12T04:57:21Z

extensions/mssql/test/unit/restoreDatabaseWebviewController.test.ts

+        sandbox.restore();
+    });
+
+    test("should initialize with correct state", async () => {


This test has 5 paths. See if you can break each path into it's own unit test.

Lauren Nathan added 3 commits February 25, 2026 14:32

initial tests

5cb4f57

added more tests

e6dda61

finished tests

471320e

Copilot AI review requested due to automatic review settings March 11, 2026 17:35

laurenastrid1 requested review from Benjin, aasimkhan30, allancascante, caohai, kburtram, lewis-sanchez, manujoseph85 and ssreerama as code owners March 11, 2026 17:35

Copilot started reviewing on behalf of laurenastrid1 March 11, 2026 17:36 View session

Copilot AI reviewed Mar 11, 2026

View reviewed changes

lewis-sanchez reviewed Mar 12, 2026

View reviewed changes

	// AssertionError: expected '' to equal 'testDatabase'
	// Expect the source database name to be preserved from the state

	restoreViewModel = this.setDefaultFormValuesFromPlan(state);
	restoreViewModel = this.setDefaultFormValuesFromPlan(state);
	this.updateViewModel(restoreViewModel);

Conversation

laurenastrid1 commented Mar 11, 2026

Description

Code Changes Checklist

Reviewers: Please read our reviewer guidelines

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

lewis-sanchez Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

lewis-sanchez Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lewis-sanchez Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

lewis-sanchez Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

lewis-sanchez Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

lewis-sanchez Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

lewis-sanchez Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lewis-sanchez Mar 12, 2026 •

edited

Loading