Skip to content

Commit

Permalink
chore: add connection storage, simplify connection controller and sto…
Browse files Browse the repository at this point in the history 
…rage controller interfaces (#627)
  • Loading branch information
@Anemy
Anemy authored Dec 18, 2023
1 parent 68a90ab commit 3d0c158
Show file tree
Hide file tree
Showing 10 changed files with 788 additions and 482 deletions.
189 changes: 28 additions & 161 deletions src/connectionController.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,7 @@ import { CONNECTION_STATUS } from './views/webview-app/extension-app-message-con
import { createLogger } from './logging';
import formatError from './utils/formatError';
import type LegacyConnectionModel from './views/webview-app/legacy/connection-model/legacy-connection-model';
import type { SecretStorageLocationType } from './storage/storageController';
import {
StorageLocation,
SecretStorageLocation,
} from './storage/storageController';
import type { StorageController } from './storage';
import { StorageVariables } from './storage';
import type { StatusView } from './views';
import type TelemetryService from './telemetry/telemetryService';
import LINKS from './utils/links';
Expand All @@ -27,11 +21,11 @@ import type {
ConnectionOptions as ConnectionOptionsFromLegacyDS,
} from 'mongodb-data-service-legacy';
import {
getConnectionTitle,
extractSecrets,
mergeSecrets,
convertConnectionModelToInfo,
} from 'mongodb-data-service-legacy';
import type { LoadedConnection } from './storage/connectionStorage';
import { ConnectionStorage } from './storage/connectionStorage';

export function launderConnectionOptionTypeFromLegacyToCurrent(
opts: ConnectionOptionsFromLegacyDS
Expand All @@ -58,15 +52,6 @@ export enum ConnectionTypes {
CONNECTION_ID = 'CONNECTION_ID',
}

export interface StoreConnectionInfo {
id: string; // Connection model id or a new uuid.
name: string; // Possibly user given name, not unique.
storageLocation: StorageLocation;
secretStorageLocation?: SecretStorageLocationType;
connectionOptions?: ConnectionOptionsFromLegacyDS;
connectionModel?: LegacyConnectionModel;
}

export enum NewConnectionType {
NEW_CONNECTION = 'NEW_CONNECTION',
SAVED_CONNECTION = 'SAVED_CONNECTION',
Expand All @@ -82,15 +67,6 @@ interface ConnectionQuickPicks {
data: { type: NewConnectionType; connectionId?: string };
}

type StoreConnectionInfoWithConnectionOptions = StoreConnectionInfo &
Required<Pick<StoreConnectionInfo, 'connectionOptions'>>;

type StoreConnectionInfoWithSecretStorageLocation = StoreConnectionInfo &
Required<Pick<StoreConnectionInfo, 'secretStorageLocation'>>;

type LoadedConnection = StoreConnectionInfoWithConnectionOptions &
StoreConnectionInfoWithSecretStorageLocation;

export default class ConnectionController {
// This is a map of connection ids to their configurations.
// These connections can be saved on the session (runtime),
Expand All @@ -99,7 +75,7 @@ export default class ConnectionController {
[connectionId: string]: LoadedConnection;
} = Object.create(null);
_activeDataService: DataService | null = null;
_storageController: StorageController;
_connectionStorage: ConnectionStorage;
_telemetryService: TelemetryService;

private readonly _serviceName = 'mdb.vscode.savedConnections';
Expand Down Expand Up @@ -130,37 +106,19 @@ export default class ConnectionController {
telemetryService: TelemetryService;
}) {
this._statusView = statusView;
this._storageController = storageController;
this._telemetryService = telemetryService;
this._connectionStorage = new ConnectionStorage({
storageController,
});
}

async loadSavedConnections(): Promise<void> {
const globalAndWorkspaceConnections = Object.entries({
...this._storageController.get(
StorageVariables.GLOBAL_SAVED_CONNECTIONS,
StorageLocation.GLOBAL
),
...this._storageController.get(
StorageVariables.WORKSPACE_SAVED_CONNECTIONS,
StorageLocation.WORKSPACE
),
});

await Promise.all(
globalAndWorkspaceConnections.map(
async ([connectionId, connectionInfo]) => {
const connectionInfoWithSecrets =
await this._getConnectionInfoWithSecrets(connectionInfo);
if (!connectionInfoWithSecrets) {
return;
}
const loadedConnections = await this._connectionStorage.loadConnections();

this._connections[connectionId] = connectionInfoWithSecrets;
}
)
);
for (const connection of loadedConnections) {
this._connections[connection.id] = connection;
}

const loadedConnections = Object.values(this._connections);
if (loadedConnections.length) {
this.eventEmitter.emit(DataServiceEventTypes.CONNECTIONS_DID_CHANGE);
}
Expand All @@ -179,61 +137,6 @@ export default class ConnectionController {
}); */
}

// TODO: Move this into the connectionStorage.
async _getConnectionInfoWithSecrets(
connectionInfo: StoreConnectionInfo
): Promise<LoadedConnection | undefined> {
try {
// We tried migrating this connection earlier but failed because Keytar was not
// available. So we return simply the connection without secrets.
if (
connectionInfo.connectionModel ||
!connectionInfo.secretStorageLocation ||
connectionInfo.secretStorageLocation === 'vscode.Keytar' ||
connectionInfo.secretStorageLocation ===
SecretStorageLocation.KeytarSecondAttempt
) {
// We had migrations in VSCode for ~5 months. We drop the connections
// that did not migrate.
return undefined;
}

const unparsedSecrets =
(await this._storageController.getSecret(connectionInfo.id)) ?? '';

return this._mergedConnectionInfoWithSecrets(
connectionInfo as LoadedConnection,
unparsedSecrets
);
} catch (error) {
log.error('Error while retrieving connection info', error);
return undefined;
}
}

_mergedConnectionInfoWithSecrets(
connectionInfo: LoadedConnection,
unparsedSecrets: string
): LoadedConnection {
if (!unparsedSecrets) {
return connectionInfo;
}

const secrets = JSON.parse(unparsedSecrets);
const connectionInfoWithSecrets = mergeSecrets(
{
id: connectionInfo.id,
connectionOptions: connectionInfo.connectionOptions,
},
secrets
);

return {
...connectionInfo,
connectionOptions: connectionInfoWithSecrets.connectionOptions,
};
}

async connectWithURI(): Promise<boolean> {
let connectionString: string | undefined;

Expand Down Expand Up @@ -293,7 +196,7 @@ export default class ConnectionController {
);

try {
const connectResult = await this.saveNewConnectionFromFormAndConnect(
const connectResult = await this.saveNewConnectionAndConnect(
{
id: uuidv4(),
connectionOptions: {
Expand Down Expand Up @@ -333,52 +236,24 @@ export default class ConnectionController {
});
}

private async _saveConnectionWithSecrets(
newStoreConnectionInfoWithSecrets: LoadedConnection
): Promise<LoadedConnection> {
// We don't want to store secrets to disc.
const { connectionInfo: safeConnectionInfo, secrets } = extractSecrets(
newStoreConnectionInfoWithSecrets as ConnectionInfoFromLegacyDS
);
const savedConnectionInfo = await this._storageController.saveConnection({
...newStoreConnectionInfoWithSecrets,
connectionOptions: safeConnectionInfo.connectionOptions, // The connection info without secrets.
});
await this._storageController.setSecret(
savedConnectionInfo.id,
JSON.stringify(secrets)
);

return savedConnectionInfo;
}

async saveNewConnectionFromFormAndConnect(
async saveNewConnectionAndConnect(
originalConnectionInfo: ConnectionInfoFromLegacyDS,
connectionType: ConnectionTypes
): Promise<ConnectionAttemptResult> {
const name = getConnectionTitle(originalConnectionInfo);
const newConnectionInfo = {
id: originalConnectionInfo.id,
name,
// To begin we just store it on the session, the storage controller
// handles changing this based on user preference.
storageLocation: StorageLocation.NONE,
secretStorageLocation: SecretStorageLocation.SecretStorage,
connectionOptions: originalConnectionInfo.connectionOptions,
};
const savedConnectionWithoutSecrets =
await this._connectionStorage.saveNewConnection(originalConnectionInfo);

const savedConnectionInfo = await this._saveConnectionWithSecrets(
newConnectionInfo
);

this._connections[savedConnectionInfo.id] = {
...savedConnectionInfo,
this._connections[savedConnectionWithoutSecrets.id] = {
...savedConnectionWithoutSecrets,
connectionOptions: originalConnectionInfo.connectionOptions, // The connection options with secrets.
};

log.info('Connect called to connect to instance', savedConnectionInfo.name);
log.info(
'Connect called to connect to instance',
savedConnectionWithoutSecrets.name
);

return this._connect(savedConnectionInfo.id, connectionType);
return this._connect(savedConnectionWithoutSecrets.id, connectionType);
}

async _connectWithDataService(
Expand Down Expand Up @@ -571,15 +446,10 @@ export default class ConnectionController {
return true;
}

private async _removeSecretsFromKeychain(connectionId: string) {
await this._storageController.deleteSecret(connectionId);
}

async removeSavedConnection(connectionId: string): Promise<void> {
delete this._connections[connectionId];

await this._removeSecretsFromKeychain(connectionId);
this._storageController.removeConnection(connectionId);
await this._connectionStorage.removeConnection(connectionId);

this.eventEmitter.emit(DataServiceEventTypes.CONNECTIONS_DID_CHANGE);
}
Expand Down Expand Up @@ -680,7 +550,7 @@ export default class ConnectionController {
},
});
} catch (e) {
throw new Error(`An error occured parsing the connection name: ${e}`);
throw new Error(`An error occurred parsing the connection name: ${e}`);
}

if (!inputtedConnectionName) {
Expand All @@ -691,7 +561,7 @@ export default class ConnectionController {
this.eventEmitter.emit(DataServiceEventTypes.CONNECTIONS_DID_CHANGE);
this.eventEmitter.emit(DataServiceEventTypes.ACTIVE_CONNECTION_CHANGED);

await this._storageController.saveConnection(
await this._connectionStorage.saveConnection(
this._connections[connectionId]
);

Expand Down Expand Up @@ -725,7 +595,7 @@ export default class ConnectionController {
return this._activeDataService !== null;
}

getSavedConnections(): StoreConnectionInfo[] {
getSavedConnections(): LoadedConnection[] {
return Object.values(this._connections);
}

Expand Down Expand Up @@ -917,13 +787,10 @@ export default class ConnectionController {
},
},
...Object.values(this._connections)
.sort(
(
connectionA: StoreConnectionInfo,
connectionB: StoreConnectionInfo
) => (connectionA.name || '').localeCompare(connectionB.name || '')
.sort((connectionA: LoadedConnection, connectionB: LoadedConnection) =>
(connectionA.name || '').localeCompare(connectionB.name || '')
)
.map((item: StoreConnectionInfo) => ({
.map((item: LoadedConnection) => ({
label: item.name,
data: {
type: NewConnectionType.SAVED_CONNECTION,
Expand Down
3 changes: 1 addition & 2 deletions src/explorer/explorerTreeController.ts
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import * as vscode from 'vscode';

import type { StoreConnectionInfo } from '../connectionController';
import type ConnectionController from '../connectionController';
import { DataServiceEventTypes } from '../connectionController';
import ConnectionTreeItem from './connectionTreeItem';
Expand Down Expand Up @@ -139,7 +138,7 @@ export default class ExplorerTreeController
this._connectionTreeItems = {};

// Create new connection tree items, using cached children wherever possible.
connections.forEach((connection: StoreConnectionInfo) => {
connections.forEach((connection) => {
const isActiveConnection =
connection.id === this._connectionController.getActiveConnectionId();
const isBeingConnectedTo =
Expand Down
7 changes: 6 additions & 1 deletion src/mdbExtensionController.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,15 @@ import type PlaygroundsTreeItem from './explorer/playgroundsTreeItem';
import PlaygroundResultProvider from './editors/playgroundResultProvider';
import WebviewController from './views/webviewController';
import { createIdFactory, generateId } from './utils/objectIdHelper';
import { ConnectionStorage } from './storage/connectionStorage';

// This class is the top-level controller for our extension.
// Commands which the extensions handles are defined in the function `activate`.
export default class MDBExtensionController implements vscode.Disposable {
_playgroundSelectedCodeActionProvider: PlaygroundSelectedCodeActionProvider;
_playgroundDiagnosticsCodeActionProvider: PlaygroundDiagnosticsCodeActionProvider;
_connectionController: ConnectionController;
_connectionStorage: ConnectionStorage;
_context: vscode.ExtensionContext;
_editorsController: EditorsController;
_playgroundController: PlaygroundController;
Expand All @@ -68,6 +70,9 @@ export default class MDBExtensionController implements vscode.Disposable {
this._context = context;
this._statusView = new StatusView(context);
this._storageController = new StorageController(context);
this._connectionStorage = new ConnectionStorage({
storageController: this._storageController,
});
this._telemetryService = new TelemetryService(
this._storageController,
context,
Expand Down Expand Up @@ -669,7 +674,7 @@ export default class MDBExtensionController implements vscode.Disposable {
// Show the overview page when it hasn't been show to the
// user yet, and they have no saved connections.
if (!hasBeenShownViewAlready) {
if (!this._storageController.hasSavedConnections()) {
if (!this._connectionStorage.hasSavedConnections()) {
void vscode.commands.executeCommand(
EXTENSION_COMMANDS.MDB_OPEN_OVERVIEW_PAGE
);
Expand Down
Loading

0 comments on commit 3d0c158

Please sign in to comment.