random-mirrors/cosmos-explorer
1
0
Fork 0
mirror of https://github.com/Azure/cosmos-explorer.git synced 2025-04-21 09:09:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

refactored code

Browse Source
This commit is contained in:
Sourabh Jain 2025-04-09 15:52:20 +05:30
parent 58f867abfa
commit 441c3c5752
8 changed files with 162 additions and 146 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/Explorer/Tabs/CloudShellTab/CloudShellTerminalCore.tsx
View File

@ -14,7 +14,8 @@ import {
registerCloudShellProvider, registerCloudShellProvider,
verifyCloudShellProviderRegistration verifyCloudShellProviderRegistration
} from "./Data/CloudShellClient"; } from "./Data/CloudShellClient";
import { ShellTypeHandler } from "./ShellTypes/ShellTypeFactory"; import { END_MARKER, START_MARKER } from "./ShellTypes/AbstractShellHandler";
import { ShellTypeHandlerFactory } from "./ShellTypes/ShellTypeFactory";
import { AttachAddon } from "./Utils/AttachAddOn"; import { AttachAddon } from "./Utils/AttachAddOn";
import { askConfirmation, wait } from "./Utils/CommonUtils"; import { askConfirmation, wait } from "./Utils/CommonUtils";
import { getNormalizedRegion } from "./Utils/RegionUtils"; import { getNormalizedRegion } from "./Utils/RegionUtils";
@ -55,7 +56,7 @@ export const startCloudShellTerminal =
} }
// Get the shell handler for this type // Get the shell handler for this type
const shellHandler = ShellTypeHandler.getHandler(shellType); const shellHandler = ShellTypeHandlerFactory.getHandler(shellType);
// Configure WebSocket connection with shell-specific commands // Configure WebSocket connection with shell-specific commands
const socket = await establishTerminalConnection( const socket = await establishTerminalConnection(
terminal, terminal,
@ -169,8 +170,14 @@ export const establishTerminalConnection = async (
// Configure the socket // Configure the socket
socket = await configureSocketConnection(socket, socketUri, terminal, initCommands, 0); socket = await configureSocketConnection(socket, socketUri, terminal, initCommands, 0);
const options = {
startMarker: START_MARKER,
endMarker: END_MARKER,
terminalSuppressedData: shellHandler.getTerminalSuppressedData()
};
// Attach the terminal addon // Attach the terminal addon
const attachAddon = new AttachAddon(socket); const attachAddon = new AttachAddon(socket, options);
terminal.loadAddon(attachAddon); terminal.loadAddon(attachAddon);
// Authorize the session // Authorize the session
@ -205,7 +212,7 @@ export const configureSocketConnection = async (
socket.onerror = async () => { socket.onerror = async () => {
if (socketRetryCount < MAX_RETRY_COUNT && socket.readyState !== WebSocket.CLOSED) { if (socketRetryCount < MAX_RETRY_COUNT && socket.readyState !== WebSocket.CLOSED) {
await configureSocketConnection(socket, uri, terminal, initCommands, socketRetryCount + 1, attachAddon); await configureSocketConnection(socket, uri, terminal, initCommands, socketRetryCount + 1);
} else { } else {
socket.close(); socket.close();
} }

45
src/Explorer/Tabs/CloudShellTab/ShellTypes/AbstractShellHandler.tsx Normal file
View File

@ -0,0 +1,45 @@
import { userContext } from "../../../../UserContext";
import { listKeys } from "../../../../Utils/arm/generatedClients/cosmos/databaseAccounts";
import { getHostFromUrl } from "../Utils/CommonUtils";
export const START_MARKER = `echo "START INITIALIZATION" > /dev/null`;
export const END_MARKER = `echo "END INITIALIZATION" > /dev/null`;
export abstract class AbstractShellHandler {
abstract getShellName(): string;
abstract getSetUpCommands(): string[];
abstract getConnectionCommands(config: any): string[];
abstract getEndpoint(): string;
abstract getTerminalSuppressedData(): string;
public async getInitialCommands(): Promise<string> {
const dbAccount = userContext.databaseAccount;
const dbName = dbAccount.name;
let key = "";
if (dbName) {
const keys = await listKeys(userContext.subscriptionId, userContext.resourceGroup, dbName);
key = keys?.primaryMasterKey || "";
}
const setupCommands = this.getSetUpCommands();
const config = {
host: getHostFromUrl(this.getEndpoint()),
name: dbName,
password: key,
endpoint: this.getEndpoint(),
};
const connectionCommands = this.getConnectionCommands(config);
const allCommands = [
START_MARKER,
...setupCommands,
END_MARKER,
...connectionCommands
];
return allCommands.join("\n").concat("\n");
}
}

49
src/Explorer/Tabs/CloudShellTab/ShellTypes/CassandraShellHandler.tsx
View File

@ -4,49 +4,40 @@
*/ */
import { userContext } from "../../../../UserContext"; import { userContext } from "../../../../UserContext";
import { listKeys } from "../../../../Utils/arm/generatedClients/cosmos/databaseAccounts"; import { AbstractShellHandler } from "./AbstractShellHandler";
import { getHostFromUrl } from "../Utils/CommonUtils";
import { ShellTypeConfig } from "./ShellTypeFactory";
export class CassandraShellHandler implements ShellTypeConfig { const PACKAGE_VERSION: string = "5.0.3";
export class CassandraShellHandler extends AbstractShellHandler {
public getShellName(): string { public getShellName(): string {
return "Cassandra"; return "Cassandra";
} }
public async getInitialCommands(): Promise<string> { public getEndpoint(): string {
const dbAccount = userContext.databaseAccount; return userContext.databaseAccount?.properties?.cassandraEndpoint;
const endpoint = dbAccount.properties.cassandraEndpoint;
// Get database key
const dbName = dbAccount.name;
let key = "";
if (dbName) {
const keys = await listKeys(userContext.subscriptionId, userContext.resourceGroup, dbName);
key = keys?.primaryMasterKey || "";
} }
const config = { public getSetUpCommands(): string[] {
host: getHostFromUrl(endpoint),
name: dbAccount.name,
password: key,
endpoint: endpoint
};
return this.getCommands(config).join("\n").concat("\n");
}
private getCommands(config: any): string[] {
return [ return [
"if ! command -v cqlsh &> /dev/null; then echo '⚠️ cqlsh not found. Installing...'; fi", "if ! command -v cqlsh &> /dev/null; then echo '⚠️ cqlsh not found. Installing...'; fi",
"if ! command -v cqlsh &> /dev/null; then curl -LO https://archive.apache.org/dist/cassandra/5.0.3/apache-cassandra-5.0.3-bin.tar.gz; fi", `if ! command -v cqlsh &> /dev/null; then curl -LO https://archive.apache.org/dist/cassandra/${PACKAGE_VERSION}/apache-cassandra-${PACKAGE_VERSION}-bin.tar.gz; fi`,
"if ! command -v cqlsh &> /dev/null; then tar -xvzf apache-cassandra-5.0.3-bin.tar.gz; fi", `if ! command -v cqlsh &> /dev/null; then tar -xvzf apache-cassandra-${PACKAGE_VERSION}-bin.tar.gz; fi`,
"if ! command -v cqlsh &> /dev/null; then mkdir -p ~/cassandra && mv apache-cassandra-5.0.3/* ~/cassandra/; fi", `if ! command -v cqlsh &> /dev/null; then mkdir -p ~/cassandra && mv apache-cassandra-${PACKAGE_VERSION}/* ~/cassandra/; fi`,
"if ! command -v cqlsh &> /dev/null; then echo 'export PATH=$HOME/cassandra/bin:$PATH' >> ~/.bashrc; fi", "if ! command -v cqlsh &> /dev/null; then echo 'export PATH=$HOME/cassandra/bin:$PATH' >> ~/.bashrc; fi",
"if ! command -v cqlsh &> /dev/null; then echo 'export SSL_VERSION=TLSv1_2' >> ~/.bashrc; fi", "if ! command -v cqlsh &> /dev/null; then echo 'export SSL_VERSION=TLSv1_2' >> ~/.bashrc; fi",
"if ! command -v cqlsh &> /dev/null; then echo 'export SSL_VALIDATE=false' >> ~/.bashrc; fi", "if ! command -v cqlsh &> /dev/null; then echo 'export SSL_VALIDATE=false' >> ~/.bashrc; fi",
"source ~/.bashrc", "source ~/.bashrc"
];
}
public getConnectionCommands(config: any): string[] {
return [
`cqlsh ${config.host} 10350 -u ${config.name} -p ${config.password} --ssl --protocol-version=4` `cqlsh ${config.host} 10350 -u ${config.name} -p ${config.password} --ssl --protocol-version=4`
]; ];
} }
public getTerminalSuppressedData(): string {
return "Non-Generic MongoDB Shell";
}
} }

51
src/Explorer/Tabs/CloudShellTab/ShellTypes/MongoShellHandler.tsx
View File

@ -4,49 +4,38 @@
*/ */
import { userContext } from "../../../../UserContext"; import { userContext } from "../../../../UserContext";
import { listKeys } from "../../../../Utils/arm/generatedClients/cosmos/databaseAccounts"; import { AbstractShellHandler } from "./AbstractShellHandler";
import { getHostFromUrl } from "../Utils/CommonUtils";
import { ShellTypeConfig } from "./ShellTypeFactory";
export class MongoShellHandler implements ShellTypeConfig { const PACKAGE_VERSION: string = "2.3.8";
export class MongoShellHandler extends AbstractShellHandler {
public getShellName(): string { public getShellName(): string {
return "MongoDB"; return "MongoDB";
} }
public async getInitialCommands(): Promise<string> { public getEndpoint(): string {
const dbAccount = userContext.databaseAccount; return userContext.databaseAccount?.properties?.mongoEndpoint;
const endpoint = dbAccount.properties.mongoEndpoint;
// Get database key
const dbName = dbAccount.name;
let key = "";
if (dbName) {
const keys = await listKeys(userContext.subscriptionId, userContext.resourceGroup, dbName);
key = keys?.primaryMasterKey || "";
} }
const config = { public getSetUpCommands(): string[] {
host: getHostFromUrl(endpoint),
name: dbAccount.name,
password: key,
endpoint: endpoint
};
return this.getCommands(config).join("\n").concat("\n");
}
private getCommands(config: any): string[] {
return [ return [
"echo 'START INITIALIZATION'",
"if ! command -v mongosh &> /dev/null; then echo '⚠️ mongosh not found. Installing...'; fi", "if ! command -v mongosh &> /dev/null; then echo '⚠️ mongosh not found. Installing...'; fi",
"if ! command -v mongosh &> /dev/null; then curl -LO https://downloads.mongodb.com/compass/mongosh-2.3.8-linux-x64.tgz; fi", `if ! command -v mongosh &> /dev/null; then curl -LO https://downloads.mongodb.com/compass/mongosh-${PACKAGE_VERSION}-linux-x64.tgz; fi`,
"if ! command -v mongosh &> /dev/null; then tar -xvzf mongosh-2.3.8-linux-x64.tgz; fi", `if ! command -v mongosh &> /dev/null; then tar -xvzf mongosh-${PACKAGE_VERSION}-linux-x64.tgz; fi`,
"if ! command -v mongosh &> /dev/null; then mkdir -p ~/mongosh && mv mongosh-2.3.8-linux-x64/* ~/mongosh/; fi", `if ! command -v mongosh &> /dev/null; then mkdir -p ~/mongosh && mv mongosh-${PACKAGE_VERSION}-linux-x64/* ~/mongosh/; fi`,
"if ! command -v mongosh &> /dev/null; then echo 'export PATH=$HOME/mongosh/bin:$PATH' >> ~/.bashrc; fi", "if ! command -v mongosh &> /dev/null; then echo 'export PATH=$HOME/mongosh/bin:$PATH' >> ~/.bashrc; fi",
"source ~/.bashrc", "source ~/.bashrc"
"echo 'END INITIALIZATION'", ];
}
public getConnectionCommands(config: any): string[] {
return [
`mongosh --host ${config.host} --port 10255 --username ${config.name} --password ${config.password} --tls --tlsAllowInvalidCertificates` `mongosh --host ${config.host} --port 10255 --username ${config.name} --password ${config.password} --tls --tlsAllowInvalidCertificates`
]; ];
} }
public getTerminalSuppressedData(): string {
return "Non-Generic MongoDB Shell";
}
} }

47
src/Explorer/Tabs/CloudShellTab/ShellTypes/PostgresShellHandler.tsx
View File

@ -4,50 +4,41 @@
*/ */
import { userContext } from "../../../../UserContext"; import { userContext } from "../../../../UserContext";
import { listKeys } from "../../../../Utils/arm/generatedClients/cosmos/databaseAccounts"; import { AbstractShellHandler } from "./AbstractShellHandler";
import { getHostFromUrl } from "../Utils/CommonUtils";
import { ShellTypeConfig } from "./ShellTypeFactory";
export class PostgresShellHandler implements ShellTypeConfig { const PACKAGE_VERSION: string = "15.2";
export class PostgresShellHandler extends AbstractShellHandler {
public getShellName(): string { public getShellName(): string {
return "PostgreSQL"; return "PostgreSQL";
} }
public async getInitialCommands(): Promise<string> { public getEndpoint(): string {
const dbAccount = userContext.databaseAccount; return userContext.databaseAccount?.properties?.postgresqlEndpoint;
const endpoint = dbAccount.properties.postgresqlEndpoint;
// Get database key
const dbName = dbAccount.name;
let key = "";
if (dbName) {
const keys = await listKeys(userContext.subscriptionId, userContext.resourceGroup, dbName);
key = keys?.primaryMasterKey || "";
} }
const config = { public getSetUpCommands(): string[] {
host: getHostFromUrl(endpoint),
name: dbAccount.name,
password: key,
endpoint: endpoint
};
return this.getCommands(config).join("\n").concat("\n");
}
private getCommands(config: any): string[] {
return [ return [
"if ! command -v psql &> /dev/null; then echo '⚠️ psql not found. Installing...'; fi", "if ! command -v psql &> /dev/null; then echo '⚠️ psql not found. Installing...'; fi",
"if ! command -v psql &> /dev/null; then curl -LO https://ftp.postgresql.org/pub/source/v15.2/postgresql-15.2.tar.bz2; fi", `if ! command -v psql &> /dev/null; then curl -LO https://ftp.postgresql.org/pub/source/v${PACKAGE_VERSION}/postgresql-${PACKAGE_VERSION}.tar.bz2; fi`,
"if ! command -v psql &> /dev/null; then tar -xvjf postgresql-15.2.tar.bz2; fi", `if ! command -v psql &> /dev/null; then tar -xvjf postgresql-${PACKAGE_VERSION}.tar.bz2; fi`,
"if ! command -v psql &> /dev/null; then mkdir -p ~/pgsql; fi", "if ! command -v psql &> /dev/null; then mkdir -p ~/pgsql; fi",
"if ! command -v psql &> /dev/null; then curl -LO https://ftp.gnu.org/gnu/readline/readline-8.1.tar.gz; fi", "if ! command -v psql &> /dev/null; then curl -LO https://ftp.gnu.org/gnu/readline/readline-8.1.tar.gz; fi",
"if ! command -v psql &> /dev/null; then tar -xvzf readline-8.1.tar.gz; fi", "if ! command -v psql &> /dev/null; then tar -xvzf readline-8.1.tar.gz; fi",
"if ! command -v psql &> /dev/null; then cd readline-8.1 && ./configure --prefix=$HOME/pgsql; fi", "if ! command -v psql &> /dev/null; then cd readline-8.1 && ./configure --prefix=$HOME/pgsql; fi",
"if ! command -v psql &> /dev/null; then echo 'export PATH=$HOME/pgsql/bin:$PATH' >> ~/.bashrc; fi", "if ! command -v psql &> /dev/null; then echo 'export PATH=$HOME/pgsql/bin:$PATH' >> ~/.bashrc; fi",
"source ~/.bashrc", "source ~/.bashrc"
];
}
public getConnectionCommands(config: any): string[] {
return [
`psql 'read -p "Enter Database Name: " dbname && read -p "Enter Username: " username && host=${config.endpoint} port=5432 dbname=$dbname user=$username sslmode=require'` `psql 'read -p "Enter Database Name: " dbname && read -p "Enter Username: " username && host=${config.endpoint} port=5432 dbname=$dbname user=$username sslmode=require'`
]; ];
} }
public getTerminalSuppressedData(): string {
return "";
}
} }

27
src/Explorer/Tabs/CloudShellTab/ShellTypes/ShellTypeFactory.tsx
View File

@ -8,17 +8,13 @@ import { CassandraShellHandler } from "./CassandraShellHandler";
import { MongoShellHandler } from "./MongoShellHandler"; import { MongoShellHandler } from "./MongoShellHandler";
import { PostgresShellHandler } from "./PostgresShellHandler"; import { PostgresShellHandler } from "./PostgresShellHandler";
import { VCoreMongoShellHandler } from "./VCoreMongoShellHandler"; import { VCoreMongoShellHandler } from "./VCoreMongoShellHandler";
import { AbstractShellHandler } from "./AbstractShellHandler";
export interface ShellTypeConfig { export class ShellTypeHandlerFactory {
getShellName(): string;
getInitialCommands(): Promise<string>;
}
export class ShellTypeHandler {
/** /**
* Gets the appropriate handler for the given shell type * Gets the appropriate handler for the given shell type
*/ */
public static getHandler(shellType: TerminalKind): ShellTypeConfig { public static getHandler(shellType: TerminalKind): AbstractShellHandler {
switch (shellType) { switch (shellType) {
case TerminalKind.Postgres: case TerminalKind.Postgres:
return new PostgresShellHandler(); return new PostgresShellHandler();
@ -32,21 +28,4 @@ export class ShellTypeHandler {
throw new Error(`Unsupported shell type: ${shellType}`); throw new Error(`Unsupported shell type: ${shellType}`);
} }
} }
/**
* Gets the display name for a shell type
*/
public static getShellNameForDisplay(terminalKind: TerminalKind): string {
switch (terminalKind) {
case TerminalKind.Postgres:
return "PostgreSQL";
case TerminalKind.Mongo:
case TerminalKind.VCoreMongo:
return "MongoDB";
case TerminalKind.Cassandra:
return "Cassandra";
default:
return "";
}
}
} }

49
src/Explorer/Tabs/CloudShellTab/ShellTypes/VCoreMongoShellHandler.tsx
View File

@ -4,47 +4,38 @@
*/ */
import { userContext } from "../../../../UserContext"; import { userContext } from "../../../../UserContext";
import { listKeys } from "../../../../Utils/arm/generatedClients/cosmos/databaseAccounts"; import { AbstractShellHandler } from "./AbstractShellHandler";
import { getHostFromUrl } from "../Utils/CommonUtils";
import { ShellTypeConfig } from "./ShellTypeFactory";
export class VCoreMongoShellHandler implements ShellTypeConfig { const PACKAGE_VERSION: string = "2.3.8";
export class VCoreMongoShellHandler extends AbstractShellHandler {
public getShellName(): string { public getShellName(): string {
return "MongoDB VCore"; return "MongoDB VCore";
} }
public async getInitialCommands(): Promise<string> { public getEndpoint(): string {
const dbAccount = userContext.databaseAccount; return userContext.databaseAccount?.properties?.vcoreMongoEndpoint;
const endpoint = dbAccount.properties.vcoreMongoEndpoint;
// Get database key
const dbName = dbAccount.name;
let key = "";
if (dbName) {
const keys = await listKeys(userContext.subscriptionId, userContext.resourceGroup, dbName);
key = keys?.primaryMasterKey || "";
} }
const config = { public getSetUpCommands(): string[] {
host: getHostFromUrl(endpoint),
name: dbAccount.name,
password: key,
endpoint: endpoint
};
return this.getCommands(config).join("\n").concat("\n");
}
private getCommands(config: any): string[] {
return [ return [
"if ! command -v mongosh &> /dev/null; then echo '⚠️ mongosh not found. Installing...'; fi", "if ! command -v mongosh &> /dev/null; then echo '⚠️ mongosh not found. Installing...'; fi",
"if ! command -v mongosh &> /dev/null; then curl -LO https://downloads.mongodb.com/compass/mongosh-2.3.8-linux-x64.tgz; fi", `if ! command -v mongosh &> /dev/null; then curl -LO https://downloads.mongodb.com/compass/mongosh-${PACKAGE_VERSION}-linux-x64.tgz; fi`,
"if ! command -v mongosh &> /dev/null; then tar -xvzf mongosh-2.3.8-linux-x64.tgz; fi", `if ! command -v mongosh &> /dev/null; then tar -xvzf mongosh-${PACKAGE_VERSION}-linux-x64.tgz; fi`,
"if ! command -v mongosh &> /dev/null; then mkdir -p ~/mongosh && mv mongosh-2.3.8-linux-x64/* ~/mongosh/; fi", `if ! command -v mongosh &> /dev/null; then mkdir -p ~/mongosh && mv mongosh-${PACKAGE_VERSION}-linux-x64/* ~/mongosh/; fi`,
"if ! command -v mongosh &> /dev/null; then echo 'export PATH=$HOME/mongosh/bin:$PATH' >> ~/.bashrc; fi", "if ! command -v mongosh &> /dev/null; then echo 'export PATH=$HOME/mongosh/bin:$PATH' >> ~/.bashrc; fi",
"source ~/.bashrc", "source ~/.bashrc"
];
}
public getConnectionCommands(config: any): string[] {
return [
`read -p "Enter username: " username && mongosh "mongodb+srv://$username:@${config.endpoint}/?authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000" --tls --tlsAllowInvalidCertificates` `read -p "Enter username: " username && mongosh "mongodb+srv://$username:@${config.endpoint}/?authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000" --tls --tlsAllowInvalidCertificates`
]; ];
} }
public getTerminalSuppressedData(): string {
return "Non-Generic MongoDB Shell";
}
} }

23
src/Explorer/Tabs/CloudShellTab/Utils/AttachAddOn.tsx
View File

@ -3,6 +3,9 @@ import { IDisposable, ITerminalAddon, Terminal } from 'xterm';
interface IAttachOptions { interface IAttachOptions {
bidirectional?: boolean; bidirectional?: boolean;
startMarker?: string;
endMarker?: string;
terminalSuppressedData?: string;
} }
export class AttachAddon implements ITerminalAddon { export class AttachAddon implements ITerminalAddon {
@ -11,11 +14,20 @@ export class AttachAddon implements ITerminalAddon {
private _disposables: IDisposable[] = []; private _disposables: IDisposable[] = [];
private _socketData: string; private _socketData: string;
private _flag: boolean = true;
private _startMarker: string;
private _endMarker: string;
private _terminalSuppressedData: string;
constructor(socket: WebSocket, options?: IAttachOptions) { constructor(socket: WebSocket, options?: IAttachOptions) {
this._socket = socket; this._socket = socket;
// always set binary type to arraybuffer, we do not handle blobs // always set binary type to arraybuffer, we do not handle blobs
this._socket.binaryType = 'arraybuffer'; this._socket.binaryType = 'arraybuffer';
this._bidirectional = !(options && options.bidirectional === false); this._bidirectional = !(options && options.bidirectional === false);
this._startMarker = options?.startMarker;
this._endMarker = options?.endMarker;
this._terminalSuppressedData = options?.terminalSuppressedData;
this._socketData = ''; this._socketData = '';
} }
@ -67,7 +79,18 @@ export class AttachAddon implements ITerminalAddon {
this._socketData += data; this._socketData += data;
data = ''; data = '';
} }
if (data.includes(this._startMarker)) {
this._flag = false;
terminal.write("Preparing environment...\r\n");
}
if (this._flag && this._terminalSuppressedData && this._terminalSuppressedData.length > 0 && !data.includes(this._terminalSuppressedData)) {
terminal.write(data); terminal.write(data);
}
if (data.includes(this._endMarker)) {
this._flag = true;
}
}) })
); );