support logout

lyu571 · lyu571 · commit 5ec1b44bb7f2 · 2023-11-30T01:16:47.000+08:00
diff --git a/package.json b/package.json
@@ -122,6 +122,11 @@
                 "title": "Login: %TcTerraform.view.login.welcome%",
                 "category": "TencentCloud Terraform"
             },
+            {
+                "command": "tcTerraform.logout",
+                "title": "Logout",
+                "category": "TencentCloud Terraform"
+            },
             {
                 "command": "tcTerraform.resourcesExplorer.refresh",
                 "title": "%TcTerraform.refresh%",
diff --git a/package.nls.json b/package.nls.json
@@ -1,6 +1,9 @@
 {
     "TcTerraform.title": "Tencent Cloud Terraform",
-    "TcTerraform.view.login": "Login Tencent Cloud",
+    "TcTerraform.view.login": "Log in Tencent Cloud",
+    "TcTerraform.view.logout": "Log out Tencent Cloud",
+    "TcTerraform.view.logout.tips": "[Logout Tencent Cloud](command:tcTerraform.logout)",
+    "TcTerraform.view.logout.confirm": "Are you sure to log out?",
     "TcTerraform.view.login.welcome": "Please login the Tencent Cloud. [Sign up](https://cloud.tencent.com/register) for a Tencent Cloud account if you do not have one.\n[Sign in Tencent Cloud](command:tcTerraform.login)",
     "TcTerraform.view.codesnippet": "Code Snippets and Examples",
     "TcTerraform.view.resource": "Resources Explorer",
@@ -18,8 +21,9 @@
     "TcTerraform.pickup.aksk.verify.empty": "{0} can not be empty",
     "TcTerraform.welcome": "Welcome to use Tencent Cloud Terraform extension, please wait for the page loading...",
     "TcTerraform.msg.aksk.notfound": "Cannot find TENCENTCLOUD_SECRET_ID and TENCENTCLOUD_SECRET_KEY, please sign in first!",
-    "TcTerraform.logout": "Logout Tencent Cloud ({0})",
     "TcTerraform.login": "Login Tencent Cloud...",
-    "TcTerraform.login.success": "Logged into Tencent Cloud successfully.",
-    "TcTerraform.login.failed": "Logged failed, please try angin."
+    "TcTerraform.login.msg.success": "Logged into Tencent Cloud successfully.",
+    "TcTerraform.login.msg.failed": "Logged failed, please try angin.",
+    "TcTerraform.common.yes": "Yes",
+    "TcTerraform.common.no": "No"
 }
diff --git a/src/autocomplete/TerraformExampleProvider.ts b/src/autocomplete/TerraformExampleProvider.ts
@@ -35,7 +35,7 @@ export class TerraformExampleProvider implements CompletionItemProvider {
                 command: EXAMPLE_CMD,
                 arguments: [text],
             };
-            exampleItems.push(c)
+            exampleItems.push(c);
         }
 
         return exampleItems;
diff --git a/src/commons/tencent/commands.ts b/src/commons/tencent/commands.ts
@@ -6,14 +6,11 @@ export function registerLoginCmds() {
 
     commands.registerCommand(command.TENCENT_LOGINOUT, user.loginOut);
 
-    // commands.registerCommand(command.TENCENT_LOGIN_STATUS, user.loginStatus);
 }
 
 export namespace command {
     // login command
     export const TENCENT_LOGIN = "tcTerraform.login";
     // logout command
     export const TENCENT_LOGINOUT = "tcTerraform.logout";
-
-    export const TENCENT_LOGIN_STATUS = "tcTerraform.login.status";
 }
diff --git a/src/commons/tencent/user/index.ts b/src/commons/tencent/user/index.ts
@@ -9,7 +9,7 @@ import { AbstractClient } from "tencentcloud-sdk-nodejs/tencentcloud/common/abst
 import { Credential } from "tencentcloud-sdk-nodejs/tencentcloud/common/interface";
 import { LoginProvider } from "../../../views/login/loginExplorer";
 import { terraformShellManager } from "../../../client/terminal/terraformShellManager";
-import { getStsClient } from "@/connectivity/client";
+import { getCamClient, getStsClient } from "@/connectivity/client";
 import { StreamingStatistics } from "tencentcloud-sdk-nodejs/tencentcloud/services/dlc/v20210125/dlc_models";
 
 export namespace user {
@@ -22,6 +22,7 @@ export namespace user {
         type?: string;
         appid?: string;
         region?: string;
+        arn?: string;
     }
 
     export const AKSK_TITLE = "TcTerraform.pickup.aksk";
@@ -61,7 +62,7 @@ export namespace user {
             process.env.TENCENTCLOUD_SECRET_KEY = secretKey;
 
             // query user info
-            const resp = await (await getStsClient()).GetCallerIdentity({}).
+            const stsResp = await (await getStsClient()).GetCallerIdentity().
                 then(
                     (result) => {
                         console.debug('[DEBUG]--------------------------------result:', result);
@@ -77,12 +78,31 @@ export namespace user {
                     }
             );
 
+            const camResp = await (await getCamClient()).GetUserAppId().
+                then(
+                    (result) => {
+                        console.debug('[DEBUG]--------------------------------result:', result);
+                        if (!result) {
+                            throw new Error('[Warn] GetUserAppId result.TotalCount is 0.');
+                        }
+                        return result;
+                    },
+                    (err) => {
+                        console.error('[TencentCloudSDKError] GetUserAppId got a error from SDK.', err.message);
+                        window.showErrorMessage('Login Failed. Reason:' + err.message);
+                        return err;
+                    }
+                );
+
             // set user info
             let userinfo: UserInfo = {
                 secretId: accessKey,
                 secretKey: secretKey,
-                uin: resp.PrincipalId ?? resp.UserId ?? "-",
-                type: resp.Type ?? "unknow"
+                uin: stsResp.PrincipalId ?? stsResp.UserId ?? "-",
+                type: stsResp.Type ?? "unknow",
+                appid: camResp.AppId ?? "-",
+                arn: stsResp.Arn,
+                region: process.env.TENCENTCLOUD_REGION ?? "unknow",
             };
             setInfo(userinfo);
 
@@ -94,21 +114,19 @@ export namespace user {
     }
 
     export async function loginOut() {
-        const yes = localize("common.yes");
+        const yes = localize("TcTerraform.common.yes");
         const action = await window.showWarningMessage(
-            localize("tencent.loginout.title"),
+            localize("TcTerraform.view.logout"),
             {
                 modal: true,
-                detail: localize("tencent.loginout.detail"),
+                detail: localize("TcTerraform.view.logout.confirm"),
             },
-            yes
         );
         if (action !== yes) {
             return;
         }
 
-        const { secrets } = container.get<ExtensionContext>(Context);
-        await secrets.delete(USER_INFO);
+        await clearInfo();
 
         tree.refreshTreeData();
     }
@@ -186,6 +204,13 @@ export namespace user {
         tree.refreshTreeData();
     }
 
+    export async function clearInfo() {
+        const { secrets } = container.get<ExtensionContext>(Context);
+
+        await secrets.delete(USER_INFO);
+        tree.refreshTreeData();
+    }
+
     export async function getInfo(): Promise<UserInfo | undefined> {
         const { secrets } = container.get<ExtensionContext>(Context);
         const userinfo = await secrets.get(USER_INFO);
diff --git a/src/connectivity/client.ts b/src/connectivity/client.ts
@@ -4,6 +4,8 @@
 import * as vscode from "vscode";
 import { Client as CvmClient } from "tencentcloud-sdk-nodejs-cvm/tencentcloud/services/cvm/v20170312/cvm_client";
 import { Client as TkeClient } from "tencentcloud-sdk-nodejs-tke/tencentcloud/services/tke/v20180525/tke_client";
+import { Client as StsClient } from "tencentcloud-sdk-nodejs-sts/tencentcloud/services/sts/v20180813/sts_client";
+import { Client as CamClient } from "tencentcloud-sdk-nodejs-cam/tencentcloud/services/cam/v20190116/cam_client";
 import { AbstractClient } from "tencentcloud-sdk-nodejs/tencentcloud/common/abstract_client";
 import * as tencentcloud from "tencentcloud-sdk-nodejs";
 import { localize } from "vscode-nls-i18n";
@@ -98,15 +100,15 @@ export async function getCommonClient(region?: string): Promise<AbstractClient>
     return client;
 }
 
-export async function getStsClient(region?: string): Promise<any> {
+export async function getStsClient(region?: string): Promise<StsClient> {
     const [secretId, secretKey] = settingUtils.getAKSK();
 
     if (secretId === undefined || secretKey === undefined || secretId === null || secretKey === null) {
         let msg = localize("TcTerraform.msg.aksk.notfound");
         vscode.window.showErrorMessage(msg);
         return null;
     }
-    const StsClient = tencentcloud.sts.v20180813.Client;
+
     return new StsClient({
         credential: {
             secretId: secretId,
@@ -115,3 +117,21 @@ export async function getStsClient(region?: string): Promise<any> {
         region: process.env.TENCENTCLOUD_REGION ?? "ap-guangzhou",
     });
 }
+
+export async function getCamClient(region?: string): Promise<CamClient> {
+    const [secretId, secretKey] = settingUtils.getAKSK();
+
+    if (secretId === undefined || secretKey === undefined || secretId === null || secretKey === null) {
+        let msg = localize("TcTerraform.msg.aksk.notfound");
+        vscode.window.showErrorMessage(msg);
+        return null;
+    }
+
+    return new CamClient({
+        credential: {
+            secretId: secretId,
+            secretKey: secretKey,
+        },
+        region: process.env.TENCENTCLOUD_REGION ?? "ap-guangzhou",
+    });
+}
diff --git a/src/views/login/loginExplorer.ts b/src/views/login/loginExplorer.ts
@@ -1,6 +1,6 @@
 import { localize } from "vscode-nls-i18n";
-import { window } from "vscode";
-import { container, tencent, cmds } from "../../commons";
+import { window, ThemeIcon } from "vscode";
+import { container, tencent } from "../../commons";
 import { getSecretIdFromEnv, getSecretKeyFromEnv } from "../../utils/settingUtils";
 import { user } from "../../commons/tencent/user/index";
 import * as loginMgt from "./loginMgt";
@@ -18,32 +18,37 @@ export class LoginProvider extends tencent.tree.TreeDataProvider {
     }
 
     isLoggedIn(): boolean {
-        if (getSecretIdFromEnv() && getSecretKeyFromEnv()) {
+        if (getSecretIdFromEnv() && getSecretKeyFromEnv() && user.getInfo()) {
             return true;
         }
         return false;
     }
 
     async getChildren(element?: tencent.tree.TreeItem | undefined): Promise<tencent.tree.TreeItem[]> {
-        let welcome: tencent.tree.TreeItem[] = [];
+        let items: tencent.tree.TreeItem[] = [];
         if (!element) {
             if (!this.isLoggedIn()) {
-                window.showInformationMessage(localize("TcTerraform.login.failed"));
-                return welcome;
+                window.showInformationMessage(localize("TcTerraform.login.msg.failed"));
+                loginMgt.clearStatusBar();
+                return items;
             }
 
             const info = await user.getInfo();
             if (info) {
-                welcome.push(new tencent.tree.TreeItem(
-                    `Welcome to use ` + localize("TcTerraform.title"),
-                    new tencent.tree.TreeItem(
-                        `Current Account: [${info.uin}](${info.type})`
-                    )
-                ));
+                let welcome = new tencent.tree.TreeItem(`Current Account: [${info.uin}](${info.type})`, {
+                    iconPath: new ThemeIcon("account"),
+                });
+                items.push(welcome);
                 loginMgt.updateStatusBar();
+
+                let logout = new tencent.tree.TreeItem(localize("TcTerraform.view.logout"), {
+                    iconPath: new ThemeIcon("log-out"),
+                    command: { command: tencent.command.TENCENT_LOGINOUT, title: "Log Out" },
+                });
+                items.push(logout);
             }
         }
-        return welcome;
+        return items;
     }
 
 }
diff --git a/src/views/login/loginMgt.ts b/src/views/login/loginMgt.ts
@@ -3,20 +3,30 @@ import { user } from "../../commons/tencent/user/index";
 import { localize } from "vscode-nls-i18n";
 
 let myStatusBarItem: vscode.StatusBarItem;
-const TENCENT_LOGIN_STATUS = 'tcTerraform.login.status';
 
 export async function updateStatusBar(): Promise<void> {
     const info = await user.getInfo();
     if (info) {
-        myStatusBarItem.text = localize("TcTerraform.title") + `: [${info.uin}](${info.type})`;
+        myStatusBarItem.text = localize("TcTerraform.title") + ` / APPID: ${info.appid}`;
+        myStatusBarItem.tooltip =
+            `User Details:
+Uin: [${info.uin}]
+User type: [${info.type}]
+Region: [${info.region}]
+Arn: [${info.arn}]`;
         myStatusBarItem.show();
     } else {
         myStatusBarItem.hide();
     }
 }
 
+export function clearStatusBar() {
+    myStatusBarItem.hide();
+}
+
 export function createStatusBar(): vscode.StatusBarItem {
     myStatusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, 100);
-    myStatusBarItem.command = TENCENT_LOGIN_STATUS;
+    myStatusBarItem.backgroundColor = new vscode.ThemeColor("statusBarItem.hoverBackground");
+    // myStatusBarItem.command = TENCENT_LOGIN_STATUS;
     return myStatusBarItem;
 }

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ export class TerraformExampleProvider implements CompletionItemProvider {`
`35`	`35`	`command: EXAMPLE_CMD,`
`36`	`36`	`arguments: [text],`
`37`	`37`	`};`
`38`		`- exampleItems.push(c)`
	`38`	`+ exampleItems.push(c);`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`return exampleItems;`
Original file line number	Diff line number	Diff line change
`@@ -6,14 +6,11 @@ export function registerLoginCmds() {`
`6`	`6`
`7`	`7`	`commands.registerCommand(command.TENCENT_LOGINOUT, user.loginOut);`
`8`	`8`
`9`		`- // commands.registerCommand(command.TENCENT_LOGIN_STATUS, user.loginStatus);`
`10`	`9`	`}`
`11`	`10`
`12`	`11`	`export namespace command {`
`13`	`12`	`// login command`
`14`	`13`	`export const TENCENT_LOGIN = "tcTerraform.login";`
`15`	`14`	`// logout command`
`16`	`15`	`export const TENCENT_LOGINOUT = "tcTerraform.logout";`
`17`		`-`
`18`		`- export const TENCENT_LOGIN_STATUS = "tcTerraform.login.status";`
`19`	`16`	`}`