add request client header into tf request for all terminals.

Author: lyu571

src/client/runner/terraformRunner.ts

@@ -32,7 +32,7 @@ export class TerraformRunner extends BaseRunner {
     public async init(): Promise<any> {
         console.debug("[DEBUG]#### TerraformRunner init begin.");
 
-        this.setAKSK();
+        // this.setAKSK();
 
         terraformShellManager.getShell().runTerraformCmd(TerraformCommand.Version);
         terraformShellManager.getShell().runTerraformCmd(TerraformCommand.Init);

src/client/terminal/integratedShell.ts

@@ -23,17 +23,18 @@ import { BaseRunner } from "../runner/baseRunner";
 import { TerraformerRunner, CommandType, FlagType, FlagsMap, defaultProduct } from "../../client/runner/terraformerRunner";
 import { TerraformRunner } from "../runner/terraformRunner";
 
-// import stripAnsi from 'strip-ansi';
 
 export class IntegratedShell extends BaseShell {
     // eslint-disable-next-line @typescript-eslint/naming-convention
     private static readonly GRAPH_FILE_NAME = "graph.png";
     private readonly runner: BaseRunner;
+    private readonly env: { [key: string]: string | null | undefined };
 
-    constructor(rr: BaseRunner) {
+    constructor(rr: BaseRunner, ee: any) {
         super();
         // terraform or terraformer?
         this.runner = rr;
+        this.env = ee;
     }
 
     // Creates a png of terraform resource graph to visualize the resources under management.
@@ -179,7 +180,7 @@ export class IntegratedShell extends BaseShell {
     }
 
     public async runTerraformCmd(tfCommand: string, args?: string[]) {
-        this.checkCreateTerminal();
+        this.createTerminal(Constants.TerraformTerminalName);
         this.terminal.show();
 
         // const cmd= [tfCommand, args.values].join(' ');
@@ -193,7 +194,7 @@ export class IntegratedShell extends BaseShell {
     }
 
     public async runNormalCmd(tfCommand: string, newLine = true) {
-        this.checkCreateTerminal();
+        this.createTerminal(Constants.TerraformTerminalName);
         this.terminal.show();
         this.terminal.sendText(tfCommand, newLine);
     }
@@ -220,9 +221,13 @@ export class IntegratedShell extends BaseShell {
         }
     }
 
-    private checkCreateTerminal(): void {
+    private createTerminal(name: string): void {
         if (!this.terminal) {
-            this.terminal = vscode.window.createTerminal(Constants.TerraformTerminalName);
+            const options: vscode.TerminalOptions = {
+                name: name,
+                env: this.env,
+            };
+            this.terminal = vscode.window.createTerminal(options);
         }
     }
 }

src/client/terminal/terraformShellManager.ts

@@ -11,6 +11,9 @@ import { TencentCloudShell } from "./cloudShell";
 import { IntegratedShell } from "./integratedShell";
 import { isTerminalSetToCloudShell } from "../../utils/settingUtils";
 import { TerraformerRunner } from "../runner/terraformerRunner";
+import * as context from "../../commons/context";
+import * as settingUtils from "../../utils/settingUtils";
+import { Constants } from "../../commons/constants";
 
 export interface ITerraformShellManager {
     getShell(): BaseShell;
@@ -19,6 +22,8 @@ export interface ITerraformShellManager {
     dispose(): void;
 }
 
+
+
 class TerraformShellManager implements ITerraformShellManager {
     private static cloudShell = new TencentCloudShell();
     private static integratedShell: IntegratedShell;
@@ -39,11 +44,19 @@ class TerraformShellManager implements ITerraformShellManager {
 
     public getIntegratedShell(runner?: any): IntegratedShell {
         if (!TerraformShellManager.integratedShell) {
+            // set TencentCloud AKSK, Region and Client info
+            const [ak, sk, region] = settingUtils.getAKSKandRegion();
+            const tfEnv = {
+                [Constants.REQUEST_CLIENT]: context.genRequestClient(),
+                [Constants.TENCENTCLOUD_SECRET_ID]: ak,
+                [Constants.TENCENTCLOUD_SECRET_KEY]: sk,
+                [Constants.TENCENTCLOUD_REGION]: region,
+            };
             // default runner is Terraformer
-            TerraformShellManager.integratedShell = new IntegratedShell(TerraformerRunner.getInstance());
+            TerraformShellManager.integratedShell = new IntegratedShell(TerraformerRunner.getInstance(), tfEnv);
             // specify runner
             if (runner) {
-                TerraformShellManager.integratedShell = new IntegratedShell(runner);
+                TerraformShellManager.integratedShell = new IntegratedShell(runner, tfEnv);
             }
         }
         return TerraformShellManager.integratedShell;

src/commons/constants.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/naming-convention */
 /*---------------------------------------------------------------------------------------------
  *  Copyright (c) Tencent Corporation. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
@@ -6,6 +7,9 @@
 "use strict";
 
 export class Constants {
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    public static TerraformTerminalName = "TIAT-Terraform";
+    public static TerraformTerminalName = "TIC-Terraform";
+    public static REQUEST_CLIENT = "TENCENTCLOUD_API_REQUEST_CLIENT";
+    public static TENCENTCLOUD_SECRET_ID = "TENCENTCLOUD_SECRET_ID";
+    public static TENCENTCLOUD_SECRET_KEY = "TENCENTCLOUD_SECRET_KEY";
+    public static TENCENTCLOUD_REGION = "TENCENTCLOUD_REGION";
 }

src/commons/context.ts

@@ -2,7 +2,20 @@ import { container } from './container';
 import * as vscode from 'vscode';
 
 export const Context = Symbol('ExtensionContext');
+export const REQUEST_CLIENT_PREFIX = "Terraform-Vscode-";//Terraform-1.81.61@vscode";
 
 export function bindExtensionContext(ctx: vscode.ExtensionContext) {
     container.bind(Context).toConstantValue(ctx);
+}
+
+export function getExtensionVersion(): string {
+    let extension = vscode.extensions.getExtension('Tencent-Cloud.vscode-tencentcloud-terraform');
+    let currentVersion = extension.packageJSON.version;
+    return currentVersion;
+}
+
+export function genRequestClient(): string {
+    const currentVersion = getExtensionVersion();
+    const reqCli = `${REQUEST_CLIENT_PREFIX}v${currentVersion}`;
+    return reqCli;
 }

src/commons/tencent/user/index.ts

@@ -1,5 +1,5 @@
 import { localize } from "vscode-nls-i18n";
-import { ExtensionContext, workspace, ConfigurationTarget, window, ProgressLocation, MessageItem, extensions } from "vscode";
+import { ExtensionContext, workspace, ConfigurationTarget, window, ProgressLocation, MessageItem } from "vscode";
 
 import { container } from "../../container";
 import { Context } from "../../context";
@@ -10,6 +10,7 @@ import { Credential } from "tencentcloud-sdk-nodejs/tencentcloud/common/interfac
 import { getCamClient, getCommonClient, getStsClient } from "@/connectivity/client";
 import * as loginMgt from "../../../views/login/loginMgt";
 import * as settingUtils from "../../../utils/settingUtils";
+import * as context from "../../context";
 
 export namespace user {
     export interface UserInfo {
@@ -24,7 +25,6 @@ export namespace user {
         arn?: string;
     }
 
-    export const REQUEST_CLIENT_PREFIX = "Terraform-Vscode-";//Terraform-1.81.61@vscode";
     export const AKSK_TITLE = "TcTerraform.pickup.aksk";
     export const OAUTH_TITLE = "TcTerraform.pickup.oauth";
     export const AKSK_PLACEHOLD = "TcTerraform.pickup.aksk.placeholder";
@@ -72,8 +72,7 @@ export namespace user {
             try {
                 // query user info
                 const stsClient = await getStsClient();
-                const currentVersion = getExtensionVersion();
-                const reqCli = `${REQUEST_CLIENT_PREFIX}v${currentVersion}`;
+                const reqCli = context.genRequestClient();
                 stsClient.sdkVersion = reqCli;
                 console.log('[DEBUG]--------------------getStsClient:', stsClient);
                 // const stsClient = await getCommonClient("sts.tencentcloudapi.com", "2018-08-13");
@@ -132,12 +131,6 @@ export namespace user {
         }
     }
 
-    function getExtensionVersion(): string {
-        let extension = extensions.getExtension('Tencent-Cloud.vscode-tencentcloud-terraform');
-        let currentVersion = extension.packageJSON.version;
-        return currentVersion;
-    }
-
     export async function loginOut() {
         const yesBtn: MessageItem = { title: localize("TcTerraform.common.yes") };
         const action = await window.showWarningMessage(

src/extension.ts

@@ -1,7 +1,6 @@
 // The module 'vscode' contains the VS Code extensibility API
 // Import the module and reference it with the alias vscode in your code below
 import * as vscode from 'vscode';
-import * as settingUtils from "./utils/settingUtils";
 import { init } from "vscode-nls-i18n";
 import { TerraformCommand, TerraformerCommand } from "./commons/customCmdRegister";
 import { terraformShellManager } from "./client/terminal/terraformShellManager";
@@ -16,6 +15,8 @@ import { GitUtils } from './utils/gitUtils';
 import _ from 'lodash';
 import * as autocomplete from './autocomplete/TerraformExampleProvider';
 import * as loginMgt from './views/login/loginMgt';
+import * as context from './commons/context';
+import { Constants } from './commons/constants';
 
 const TF_MODE: vscode.DocumentFilter = { language: 'terraform', scheme: 'file' };
 const COMPATIBLE_MODE: vscode.DocumentFilter = { scheme: 'file' };
@@ -29,6 +30,8 @@ export async function activate(context: vscode.ExtensionContext) {
     await TerraformRunner.getInstance().checkInstalled();
     await TerraformerRunner.getInstance().checkInstalled();
 
+    // set request client
+    await setRequestClient();
     // terraform cmd
     context.subscriptions.push(vscode.commands.registerCommand('tcTerraform.apply', () => {
         terraformShellManager.getShell().runTerraformCmd(TerraformCommand.Apply);
@@ -115,9 +118,31 @@ export async function activate(context: vscode.ExtensionContext) {
 
 }
 
+async function setRequestClient() {
+    const config = vscode.workspace.getConfiguration('terminal.integrated.env');
+    const os = getOSPlatform();
+    const curConfig = config[os] || {};
 
+    // env[Constants.REQUEST_CLIENT] = context.genRequestClient();
+    const updatedConfig = { ...curConfig, [Constants.REQUEST_CLIENT]: context.genRequestClient() };
+
+    await config.update(os, updatedConfig, vscode.ConfigurationTarget.Global);
+}
+
+function getOSPlatform(): string {
+    const platform = process.platform;
+    switch (platform) {
+        case 'win32':
+            return 'windows';
+        case 'darwin':
+            return 'osx';
+        case 'linux':
+        default:
+            return 'linux';
+    }
+}
 
 // This method is called when your extension is deactivated
 export function deactivate() {
-    /* TODO document why this function 'deactivate' is empty */
+
 }