chore: Prepare ZE for Secrets SDK

Signed-off-by: Trae Yelovich <[email protected]>
zowe · Jul 27, 2023 · 79fc350 · 79fc350
1 parent 25235b8
commit 79fc350
Show file tree

Hide file tree

Showing 11 changed files with 30 additions and 30 deletions.
diff --git a/packages/zowe-explorer-api/__tests__/__unit__/security/KeytarCredentialManager.unit.test.ts b/packages/zowe-explorer-api/__tests__/__unit__/security/KeytarCredentialManager.unit.test.ts
@@ -55,7 +55,7 @@ describe("KeytarCredentialManager", () => {
             loggerWarnSpy = jest.spyOn(imperative.Logger.prototype, "warn").mockImplementation();
         });
 
-        it("should handle CredentialManager in Imperative settings", () => {
+        it("should handle CredentialManager in Imperative settings", async () => {
             jest.spyOn(fs, "existsSync").mockReturnValueOnce(true);
             const readFileSyncSpy = jest.spyOn(fs, "readFileSync").mockReturnValue(
                 JSON.stringify({
@@ -64,14 +64,14 @@ describe("KeytarCredentialManager", () => {
                     },
                 })
             );
-            const keytar = KeytarCredentialManager.getSecurityModules("@traeok/keytar-rs", false);
+            const { keyring: keytar } = await import("@zowe/secrets-for-zowe-sdk");
             expect(keytar).toBeDefined();
             expect(loggerWarnSpy).not.toHaveBeenCalled();
             expect(readFileSyncSpy).toHaveBeenCalledTimes(1);
             expect(Object.keys(keytar as object).length).toBe(5);
         });
 
-        it("should handle credential-manager in Imperative settings", () => {
+        it("should handle credential-manager in Imperative settings", async () => {
             jest.spyOn(fs, "existsSync").mockReturnValueOnce(true);
             const readFileSyncSpy = jest.spyOn(fs, "readFileSync").mockReturnValue(
                 JSON.stringify({
@@ -80,14 +80,14 @@ describe("KeytarCredentialManager", () => {
                     },
                 })
             );
-            const keytar = KeytarCredentialManager.getSecurityModules("@traeok/keytar-rs", false);
+            const { keyring: keytar } = await import("@zowe/secrets-for-zowe-sdk");
             expect(keytar).toBeDefined();
             expect(loggerWarnSpy).not.toHaveBeenCalled();
             expect(readFileSyncSpy).toHaveBeenCalledTimes(1);
             expect(Object.keys(keytar as object).length).toBe(5);
         });
 
-        it("should handle CredentialManager in Imperative settings - Theia", () => {
+        it("should handle CredentialManager in Imperative settings - Theia", async () => {
             jest.spyOn(fs, "existsSync").mockReturnValueOnce(true);
             const readFileSyncSpy = jest.spyOn(fs, "readFileSync").mockReturnValue(
                 JSON.stringify({
@@ -97,42 +97,42 @@ describe("KeytarCredentialManager", () => {
                 })
             );
             jest.spyOn(process, "cwd").mockReturnValueOnce(__dirname + "/../../../../..");
-            const keytar = KeytarCredentialManager.getSecurityModules("@traeok/keytar-rs", true);
+            const { keyring: keytar } = await import("@zowe/secrets-for-zowe-sdk");
             expect(keytar).toBeDefined();
             expect(loggerWarnSpy).not.toHaveBeenCalled();
             expect(readFileSyncSpy).toHaveBeenCalledTimes(1);
             expect(Object.keys(keytar as object).length).toBe(5);
         });
 
-        it("should handle empty Imperative settings", () => {
+        it("should handle empty Imperative settings", async () => {
             jest.spyOn(fs, "existsSync").mockReturnValueOnce(true);
             const readFileSyncSpy = jest.spyOn(fs, "readFileSync").mockReturnValue(JSON.stringify({}));
-            const keytar = KeytarCredentialManager.getSecurityModules("@traeok/keytar-rs", false);
+            const { keyring: keytar } = await import("@zowe/secrets-for-zowe-sdk");
             expect(loggerWarnSpy).not.toHaveBeenCalled();
             expect(readFileSyncSpy).toHaveBeenCalledTimes(1);
             expect(keytar).toBeUndefined();
         });
 
-        it("should handle non-existent Imperative settings", () => {
+        it("should handle non-existent Imperative settings", async () => {
             jest.spyOn(fs, "existsSync").mockReturnValueOnce(false);
             const readFileSyncSpy = jest.spyOn(fs, "readFileSync");
-            const keytar = KeytarCredentialManager.getSecurityModules("@traeok/keytar-rs", false);
+            const { keyring: keytar } = await import("@zowe/secrets-for-zowe-sdk");
             expect(loggerWarnSpy).not.toHaveBeenCalled();
             expect(readFileSyncSpy).not.toHaveBeenCalled();
             expect(keytar).toBeUndefined();
         });
 
-        it("should handle error loading Imperative settings", () => {
+        it("should handle error loading Imperative settings", async () => {
             jest.spyOn(fs, "existsSync").mockReturnValueOnce(true);
             const readFileSyncSpy = jest.spyOn(fs, "readFileSync").mockReturnValueOnce("invalid json");
-            const keytar = KeytarCredentialManager.getSecurityModules("@traeok/keytar-rs", false);
+            const { keyring: keytar } = await import("@zowe/secrets-for-zowe-sdk");
             expect(loggerWarnSpy).toHaveBeenCalledTimes(1);
             expect(loggerWarnSpy.mock.calls[0][0].message).toContain("Unexpected token");
             expect(readFileSyncSpy).toHaveBeenCalledTimes(1);
             expect(keytar).toBeUndefined();
         });
 
-        it("should handle error loading invalid security module", () => {
+        it("should handle error loading invalid security module", async () => {
             jest.spyOn(fs, "existsSync").mockReturnValueOnce(true);
             const readFileSyncSpy = jest.spyOn(fs, "readFileSync").mockReturnValue(
                 JSON.stringify({
@@ -141,7 +141,7 @@ describe("KeytarCredentialManager", () => {
                     },
                 })
             );
-            const keytar = KeytarCredentialManager.getSecurityModules("keytar_bad", false);
+            const keytar = require("nonexistent-keytar");
             expect(loggerWarnSpy).toHaveBeenCalledTimes(2);
             expect(loggerWarnSpy.mock.calls[0][0].message).toContain("Cannot find module");
             expect(readFileSyncSpy).toHaveBeenCalledTimes(1);

diff --git a/packages/zowe-explorer-api/src/profiles/ProfilesCache.ts b/packages/zowe-explorer-api/src/profiles/ProfilesCache.ts
@@ -75,7 +75,8 @@ export class ProfilesCache {
 
     public async getProfileInfo(envTheia = false): Promise<zowe.imperative.ProfileInfo> {
         const mProfileInfo = new zowe.imperative.ProfileInfo("zowe", {
-            credMgrOverride: zowe.imperative.ProfileCredentials.defaultCredMgrWithKeytar(() => getSecurityModules("@traeok/keytar-rs", envTheia)),
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+            credMgrOverride: zowe.imperative.ProfileCredentials.defaultCredMgrWithKeytar(() => require("@zowe/secrets-for-zowe-sdk").keyring),
         });
         await mProfileInfo.readProfilesFromDisk({ homeDir: getZoweDir(), projectDir: this.cwd ?? undefined });
         return mProfileInfo;

diff --git a/packages/zowe-explorer-api/src/security/KeytarApi.ts b/packages/zowe-explorer-api/src/security/KeytarApi.ts
@@ -24,7 +24,7 @@ export class KeytarApi {
         const profiles = new ProfilesCache(log, vscode.workspace.workspaceFolders?.[0]?.uri.fsPath);
         const scsActive = profiles.isSecureCredentialPluginActive();
         if (scsActive) {
-            const keytar = KeytarCredentialManager.getSecurityModules("@traeok/keytar-rs", isTheia);
+            const { keyring: keytar } = await import("@zowe/secrets-for-zowe-sdk");
             if (!initialized && keytar) {
                 KeytarCredentialManager.keytar = keytar as unknown as KeytarModule;
                 await imperative.CredentialManagerFactory.initialize({

diff --git a/packages/zowe-explorer-api/src/security/KeytarCredentialManager.ts b/packages/zowe-explorer-api/src/security/KeytarCredentialManager.ts
@@ -212,9 +212,7 @@ export class KeytarCredentialManager extends imperative.AbstractCredentialManage
  */
 export function getSecurityModules(moduleName: string, isTheia: boolean): NodeModule | undefined {
     const r = typeof __webpack_require__ === "function" ? __non_webpack_require__ : require;
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
-    return r(moduleName);
-    /*// Workaround for Theia issue (https://github.com/eclipse-theia/theia/issues/4935)
+    // Workaround for Theia issue (https://github.com/eclipse-theia/theia/issues/4935)
     const appRoot = isTheia ? process.cwd() : vscode.env.appRoot;
     try {
         // eslint-disable-next-line @typescript-eslint/no-unsafe-return
@@ -228,5 +226,5 @@ export function getSecurityModules(moduleName: string, isTheia: boolean): NodeMo
     } catch (err) {
         imperative.Logger.getAppLogger().warn(err as string);
     }
-    return undefined;*/
+    return undefined;
 }
diff --git a/packages/zowe-explorer-ftp-extension/package.json b/packages/zowe-explorer-ftp-extension/package.json
@@ -51,9 +51,6 @@
     "@zowe/zowe-explorer-api": "2.10.0-SNAPSHOT",
     "tmp": "0.2.1"
   },
-  "resolutions": {
-    "**/@zowe/imperative": "file:../imperative"
-  },
   "devDependencies": {
     "@types/tmp": "0.2.0",
     "concurrently": "^5.2.0",

diff --git a/packages/zowe-explorer-ftp-extension/webpack.config.js b/packages/zowe-explorer-ftp-extension/webpack.config.js
@@ -40,7 +40,6 @@ const config = {
     externals: {
         // Add modules that cannot be webpack'ed, 📖 -> https://webpack.js.org/configuration/externals/
         vscode: "commonjs vscode", // the vscode-module is created on-the-fly and must be excluded. Add other modules that cannot be webpack'ed, 📖 -> https://webpack.js.org/configuration/externals/
-        keytar: "commonjs keytar",
         "spdx-exceptions": "commonjs spdx-exceptions",
         "spdx-license-ids": "commonjs spdx-license-ids",
         "spdx-license-ids/deprecated": "commonjs spdx-license-ids/deprecated",

diff --git a/packages/zowe-explorer/.vscodeignore b/packages/zowe-explorer/.vscodeignore
@@ -7,6 +7,7 @@
 !out/src/nls.metadata*.json
 !resources/**/*.png
 !resources/**/*.svg
+!prebuilds/**
 
 !CHANGELOG.md
 !LICENSE

diff --git a/packages/zowe-explorer/package.json b/packages/zowe-explorer/package.json
@@ -1905,12 +1905,12 @@
     ]
   },
   "scripts": {
-    "build": "gulp build && yarn license && webpack --mode development",
+    "build": "gulp build && yarn license && ts-node ./scripts/getSecretsPrebuilds.ts && webpack --mode development",
     "build:integration": "yarn createTestProfileData && yarn license && tsc --pretty --project tsconfig-tests.json",
     "test:unit": "jest \".*__tests__.*\\.unit\\.test\\.ts\" --coverage",
     "test:theia": "mocha ./out/__tests__/__theia__/*.theia.test.js --timeout 50000 --reporter mocha-multi-reporters --reporter-options configFile=.mocharc.json",
     "test": "yarn test:unit",
-    "vscode:prepublish": "gulp build && webpack --mode production && yarn updateStrings && yarn run compile-web",
+    "vscode:prepublish": "gulp build && ts-node ./scripts/getSecretsPrebuilds.ts && webpack --mode production && yarn updateStrings && yarn run compile-web",
     "updateStrings": "node ../../scripts/stringUpdateScript.js && prettier --write --loglevel warn ./i18n package.nls*",
     "package": "vsce package --allow-star-activation --yarn && node ../../scripts/mv-pack.js vscode-extension-for-zowe vsix",
     "license": "node ../../scripts/updateLicenses.js",
@@ -1934,7 +1934,6 @@
   },
   "devDependencies": {
     "@napi-rs/cli": "^2.16.1",
-    "@traeok/keytar-rs": "github:traeok/keytar-rs",
     "@types/chai": "^4.2.6",
     "@types/chai-as-promised": "^7.1.0",
     "@types/expect": "^1.20.3",
@@ -1972,6 +1971,7 @@
     "webpack-cli": "^3.3.11"
   },
   "dependencies": {
+    "@zowe/secrets-for-zowe-sdk": "7.18.0-next.1",
     "@zowe/zowe-explorer-api": "2.10.0-SNAPSHOT",
     "fs-extra": "8.0.1",
     "isbinaryfile": "4.0.4",

diff --git a/packages/zowe-explorer/scripts/getSecretsPrebuilds.ts b/packages/zowe-explorer/scripts/getSecretsPrebuilds.ts
@@ -0,0 +1,4 @@
+import { copySync } from "fs-extra";
+import { join, resolve } from "path";
+const secretsPkgDir = resolve(require.resolve("@zowe/secrets-for-zowe-sdk"), "..");
+copySync(join(secretsPkgDir, "prebuilds"), resolve(__dirname, "..", "prebuilds"));
diff --git a/packages/zowe-explorer/src/utils/ProfilesUtils.ts b/packages/zowe-explorer/src/utils/ProfilesUtils.ts
@@ -16,7 +16,7 @@ import * as globals from "../globals";
 import * as path from "path";
 import * as fs from "fs";
 import * as util from "util";
-import { getSecurityModules, IZoweTreeNode, ZoweTreeNode, getZoweDir, getFullPath, Gui } from "@zowe/zowe-explorer-api";
+import { IZoweTreeNode, ZoweTreeNode, getZoweDir, getFullPath, Gui } from "@zowe/zowe-explorer-api";
 import { Profiles } from "../Profiles";
 import * as nls from "vscode-nls";
 import { imperative, getImperativeConfig } from "@zowe/cli";
@@ -274,7 +274,8 @@ export class ProfilesUtils {
         ZoweLogger.info(localize("ProfilesUtils.getProfileInfo.usingDefault", "No custom credential managers found, using the default instead."));
         await ProfilesUtils.updateCredentialManagerSetting(globals.ZOWE_CLI_SCM);
         return new imperative.ProfileInfo("zowe", {
-            credMgrOverride: imperative.ProfileCredentials.defaultCredMgrWithKeytar(() => getSecurityModules("@traeok/keytar-rs", envTheia)),
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+            credMgrOverride: imperative.ProfileCredentials.defaultCredMgrWithKeytar(() => require("@zowe/secrets-for-zowe-sdk").keyring),
         });
     }
 

diff --git a/packages/zowe-explorer/webpack.config.js b/packages/zowe-explorer/webpack.config.js
@@ -40,7 +40,6 @@ const config = {
     externals: {
         // Add modules that cannot be webpack'ed, 📖 -> https://webpack.js.org/configuration/externals/
         vscode: "commonjs vscode", // the vscode-module is created on-the-fly and must be excluded. Add other modules that cannot be webpack'ed, 📖 -> https://webpack.js.org/configuration/externals/
-        keytar: "commonjs keytar",
         "spdx-exceptions": "commonjs spdx-exceptions",
         "spdx-license-ids": "commonjs spdx-license-ids",
         "spdx-license-ids/deprecated": "commonjs spdx-license-ids/deprecated",