Shell: Integrate Cloudshell to existing shells (#2098)

* first draft * refactored code * ux fix * add custom header support and fix ui * minor changes * hide last command also * remove logger * bug fixes * updated loick file * fix tests * moved files * update readme * documentation update * fix compilationerror * undefined check handle * format fix * format fix * fix lints * format fix * fix unrelatred test * code refator * fix format * ut fix * cgmanifest * Revert "cgmanifest" This reverts commit 2e76a6926ee0d3d4e0510f2e04e03446c2ca8c47. * fix snap * test fix * formatting code * updated xterm * include username in command * cloudshell add exit * fix test * format fix * tets fix * fix multiple open cloudshell calls * socket time out after 20 min * remove unused code * 120 min * Addressed comments
2025-12-28 21:32:05 +00:00 · 2025-05-01 01:49:01 +05:30
parent bb66deb3a4
commit 205355bf55
35 changed files with 2664 additions and 90 deletions
--- a/src/Explorer/Tabs/CloudShellTab/Data/CloudShellClient.tsx
+++ b/src/Explorer/Tabs/CloudShellTab/Data/CloudShellClient.tsx
@@ -0,0 +1,117 @@
+import { v4 as uuidv4 } from "uuid";
+import { configContext } from "../../../../ConfigContext";
+import { userContext } from "../../../../UserContext";
+import { armRequest } from "../../../../Utils/arm/request";
+import {
+  CloudShellProviderInfo,
+  CloudShellSettings,
+  ConnectTerminalResponse,
+  NetworkType,
+  OsType,
+  ProvisionConsoleResponse,
+  SessionType,
+  ShellType,
+} from "../Models/DataModels";
+import { getLocale } from "../Utils/CommonUtils";
+
+export const getUserSettings = async (): Promise<CloudShellSettings> => {
+  return await armRequest<CloudShellSettings>({
+    host: configContext.ARM_ENDPOINT,
+    path: `/providers/Microsoft.Portal/userSettings/cloudconsole`,
+    method: "GET",
+    apiVersion: "2023-02-01-preview",
+  });
+};
+
+export const putEphemeralUserSettings = async (
+  userSubscriptionId: string,
+  userRegion: string,
+  vNetSettings?: object,
+) => {
+  const ephemeralSettings: CloudShellSettings = {
+    properties: {
+      preferredOsType: OsType.Linux,
+      preferredShellType: ShellType.Bash,
+      preferredLocation: userRegion,
+      networkType:
+        !vNetSettings || Object.keys(vNetSettings).length === 0
+          ? NetworkType.Default
+          : vNetSettings
+          ? NetworkType.Isolated
+          : NetworkType.Default,
+      sessionType: SessionType.Ephemeral,
+      userSubscription: userSubscriptionId,
+      vnetSettings: vNetSettings ?? {},
+    },
+  };
+
+  return await armRequest({
+    host: configContext.ARM_ENDPOINT,
+    path: `/providers/Microsoft.Portal/userSettings/cloudconsole`,
+    method: "PUT",
+    apiVersion: "2023-02-01-preview",
+    body: ephemeralSettings,
+  });
+};
+
+export const verifyCloudShellProviderRegistration = async (subscriptionId: string): Promise<CloudShellProviderInfo> => {
+  return await armRequest({
+    host: configContext.ARM_ENDPOINT,
+    path: `/subscriptions/${subscriptionId}/providers/Microsoft.CloudShell`,
+    method: "GET",
+    apiVersion: "2022-12-01",
+  });
+};
+
+export const registerCloudShellProvider = async (subscriptionId: string) => {
+  return await armRequest({
+    host: configContext.ARM_ENDPOINT,
+    path: `/subscriptions/${subscriptionId}/providers/Microsoft.CloudShell/register`,
+    method: "POST",
+    apiVersion: "2022-12-01",
+  });
+};
+
+export const provisionConsole = async (consoleLocation: string): Promise<ProvisionConsoleResponse> => {
+  const data = {
+    properties: {
+      osType: OsType.Linux,
+    },
+  };
+
+  return await armRequest<ProvisionConsoleResponse>({
+    host: configContext.ARM_ENDPOINT,
+    path: `providers/Microsoft.Portal/consoles/default`,
+    method: "PUT",
+    apiVersion: "2023-02-01-preview",
+    customHeaders: {
+      "x-ms-console-preferred-location": consoleLocation,
+    },
+    body: data,
+  });
+};
+
+export const connectTerminal = async (
+  consoleUri: string,
+  size: { rows: number; cols: number },
+): Promise<ConnectTerminalResponse> => {
+  const targetUri = consoleUri + `/terminals?cols=${size.cols}&rows=${size.rows}&version=2019-01-01&shell=bash`;
+  const resp = await fetch(targetUri, {
+    method: "POST",
+    headers: {
+      Accept: "application/json",
+      "Content-Type": "application/json",
+      "Content-Length": "2",
+      Authorization: userContext.authorizationToken,
+      "x-ms-client-request-id": uuidv4(),
+      "Accept-Language": getLocale(),
+    },
+    body: "{}", // empty body is necessary
+  });
+
+  if (!resp.ok) {
+    throw new Error(`Failed to connect to terminal: ${resp.status} ${resp.statusText}`);
+  }
+
+  return resp.json();
+};