Merge pull request #2118 from zowe/poc-1987-mvp

MVP: Imperative Event Emitter

packages/imperative/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to the Imperative package will be documented in this file.
 
+## Recent Changes
+
+- Enhancement: Add client-side event handling capabilities. [#1987](https://github.com/zowe/zowe-cli/pull/1987)
+
 ## `8.0.0-next.202405061946`
 
 - Enhancement: Consolidated the Zowe client log files into the same directory. [#2116](https://github.com/zowe/zowe-cli/issues/2116)

packages/imperative/__tests__/__integration__/imperative/__tests__/__integration__/cli/test/cli.imperative-test-cli.test.logging.integration.test.ts

@@ -264,7 +264,10 @@ describe("imperative-test-cli test logging command", () => {
 
                 // Set the ENV var for the script
                 const response = runCliScript(__dirname + "/__scripts__/test_logging_cmd.sh",
-                    TEST_ENVIRONMENT.workingDir, [], { IMPERATIVE_TEST_CLI_IMPERATIVE_LOG_LEVEL: "OFF" });
+                    TEST_ENVIRONMENT.workingDir, [], {
+                        IMPERATIVE_TEST_CLI_IMPERATIVE_LOG_LEVEL: "OFF",
+                        IMPERATIVE_TEST_CLI_APP_LOG_LEVEL: "OFF"
+                    });
                 expect(response.stderr.toString()).toBe("");
                 expect(response.status).toBe(0);
                 expect(response.stdout.toString()).toMatchSnapshot();

packages/imperative/src/cmd/__tests__/CommandProcessor.unit.test.ts

@@ -29,6 +29,7 @@ import { join } from "path";
 jest.mock("../src/syntax/SyntaxValidator");
 jest.mock("../src/utils/SharedOptions");
 jest.mock("../../utilities/src/ImperativeConfig");
+jest.mock("../../events/src/ImperativeEventEmitter");
 
 // Persist the original definitions of process.write
 const ORIGINAL_STDOUT_WRITE = process.stdout.write;

packages/imperative/src/config/__tests__/Config.api.unit.test.ts

@@ -19,6 +19,8 @@ import { IConfig } from "../src/doc/IConfig";
 import { IConfigLayer } from "../src/doc/IConfigLayer";
 import { IConfigProfile } from "../src/doc/IConfigProfile";
 
+jest.mock("../../events/src/ImperativeEventEmitter");
+
 const MY_APP = "my_app";
 
 const mergeConfig: IConfig = {

packages/imperative/src/config/__tests__/Config.secure.unit.test.ts

@@ -18,6 +18,7 @@ import { Config } from "../src/Config";
 import { IConfig } from "../src/doc/IConfig";
 import { IConfigSecure } from "../src/doc/IConfigSecure";
 import { IConfigVault } from "../src/doc/IConfigVault";
+import { ImperativeEventEmitter } from "../../events";
 
 const MY_APP = "my_app";
 
@@ -46,6 +47,9 @@ describe("Config secure tests", () => {
     });
 
     beforeEach(() => {
+        jest.spyOn(ImperativeEventEmitter, "initialize").mockImplementation();
+        Object.defineProperty(ImperativeEventEmitter, "instance", { value: { emitEvent: jest.fn() }});
+
         mockSecureLoad = jest.fn();
         mockSecureSave = jest.fn();
         mockVault = {

packages/imperative/src/config/__tests__/Config.unit.test.ts

@@ -19,6 +19,9 @@ import { ConfigConstants } from "../src/ConfigConstants";
 import * as JSONC from "comment-json";
 import { ConfigLayers, ConfigSecure } from "../src/api";
 
+
+jest.mock("../../events/src/ImperativeEventEmitter");
+
 const MY_APP = "my_app";
 
 describe("Config tests", () => {

packages/imperative/src/config/__tests__/ConfigAutoStore.unit.test.ts

@@ -10,6 +10,8 @@
 */
 
 jest.mock("../../logger/src/LoggerUtils");
+jest.mock("../../events/src/ImperativeEventEmitter");
+
 import { AbstractAuthHandler } from "../../imperative";
 import { SessConstants } from "../../rest";
 import { ImperativeConfig } from "../../utilities";

packages/imperative/src/config/__tests__/ProfileInfo.TeamConfig.unit.test.ts

@@ -35,6 +35,8 @@ import { IExtendersJsonOpts } from "../src/doc/IExtenderOpts";
 import { ConfigSchema } from "../src/ConfigSchema";
 import { Logger } from "../..";
 
+jest.mock("../../events/src/ImperativeEventEmitter");
+
 const testAppNm = "ProfInfoApp";
 const testEnvPrefix = testAppNm.toUpperCase();
 const profileTypes = ["zosmf", "tso", "base", "dummy"];

packages/imperative/src/config/src/Config.ts

@@ -31,6 +31,8 @@ import { ConfigUtils } from "./ConfigUtils";
 import { IConfigSchemaInfo } from "./doc/IConfigSchema";
 import { JsUtils } from "../../utilities/src/JsUtils";
 import { IConfigMergeOpts } from "./doc/IConfigMergeOpts";
+import { ImperativeEventEmitter } from "../../events";
+import { Logger } from "../../logger";
 
 /**
  * Enum used by Config class to maintain order of config layers
@@ -153,6 +155,8 @@ export class Config {
         myNewConfig.mVault = opts.vault;
         myNewConfig.mSecure = {};
 
+        ImperativeEventEmitter.initialize(app, { logger:Logger.getAppLogger() });
+
         // Populate configuration file layers
         await myNewConfig.reload(opts);
 

packages/imperative/src/config/src/ConfigUtils.ts

@@ -9,13 +9,18 @@
 *
 */
 
-import { normalize as pathNormalize } from "path";
+import { homedir as osHomedir } from "os";
+import { normalize as pathNormalize, join as pathJoin } from "path";
 import { existsSync as fsExistsSync } from "fs";
 
-import { CredentialManagerFactory } from "../../security";
+import { CredentialManagerFactory } from "../../security/src/CredentialManagerFactory";
 import { ICommandArguments } from "../../cmd";
 import { ImperativeConfig } from "../../utilities";
 import { ImperativeError } from "../../error";
+import { LoggerManager } from "../../logger/src/LoggerManager";
+import { LoggingConfigurer } from "../../imperative/src/LoggingConfigurer";
+import { Logger } from "../../logger/src/Logger";
+import { EnvironmentalVariableSettings } from "../../imperative/src/env/EnvironmentalVariableSettings";
 
 export class ConfigUtils {
     /**
@@ -114,4 +119,43 @@ export class ConfigUtils {
             additionalDetails: details
         });
     }
+
+
+    // _______________________________________________________________________
+    /**
+     * Perform a rudimentary initialization of some Imperative utilities.
+     * We must do this because VSCode apps do not typically call imperative.init.
+     * @internal
+     */
+    public static initImpUtils(appName: string) {
+        // create a rudimentary ImperativeConfig if it has not been initialized
+        if (ImperativeConfig.instance.loadedConfig == null) {
+            let homeDir: string = null;
+            const envVarPrefix = appName.toUpperCase();
+            const envVarNm = envVarPrefix + EnvironmentalVariableSettings.CLI_HOME_SUFFIX;
+            if (process.env[envVarNm] === undefined) {
+                // use OS home directory
+                homeDir = pathJoin(osHomedir(), "." + appName.toLowerCase());
+            } else {
+                // use the available environment variable
+                homeDir = pathNormalize(process.env[envVarNm]);
+            }
+            ImperativeConfig.instance.loadedConfig = {
+                name: appName,
+                defaultHome: homeDir,
+                envVariablePrefix: envVarPrefix
+            };
+            ImperativeConfig.instance.rootCommandName = appName;
+        }
+
+        // initialize logging
+        if (LoggerManager.instance.isLoggerInit === false) {
+            const loggingConfig = LoggingConfigurer.configureLogger(
+                ImperativeConfig.instance.cliHome, ImperativeConfig.instance.loadedConfig
+            );
+            Logger.initLogger(loggingConfig);
+        }
+        return Logger.getImperativeLogger();
+    }
+
 }

packages/imperative/src/config/src/ProfileInfo.ts

@@ -37,12 +37,9 @@ import { ICommandProfileProperty, ICommandArguments } from "../../cmd";
 import { IProfileLoaded, IProfileProperty, IProfileSchema } from "../../profiles";
 
 // for imperative operations
-import { EnvironmentalVariableSettings } from "../../imperative/src/env/EnvironmentalVariableSettings";
-import { LoggingConfigurer } from "../../imperative/src/LoggingConfigurer";
 import { CliUtils, ImperativeConfig } from "../../utilities";
 import { ImperativeExpect } from "../../expect";
 import { Logger, LoggerUtils } from "../../logger";
-import { LoggerManager } from "../../logger/src/LoggerManager";
 import {
     IOptionsForAddConnProps, ISession, Session, SessConstants, ConnectionPropsForSessCfg
 } from "../../rest";
@@ -180,7 +177,7 @@ export class ProfileInfo {
         this.mCredentials = new ProfileCredentials(this, profInfoOpts);
 
         // do enough Imperative stuff to let imperative utilities work
-        this.initImpUtils();
+        this.mImpLogger = ConfigUtils.initImpUtils(this.mAppName);
     }
 
     /**
@@ -969,42 +966,6 @@ export class ProfileInfo {
         }
     }
 
-    // _______________________________________________________________________
-    /**
-     * Perform a rudimentary initialization of some Imperative utilities.
-     * We must do this because VSCode apps do not typically call imperative.init.
-     */
-    private initImpUtils() {
-        // create a rudimentary ImperativeConfig if it has not been initialized
-        if (ImperativeConfig.instance.loadedConfig == null) {
-            let homeDir: string = null;
-            const envVarPrefix = this.mAppName.toUpperCase();
-            const envVarNm = envVarPrefix + EnvironmentalVariableSettings.CLI_HOME_SUFFIX;
-            if (process.env[envVarNm] === undefined) {
-                // use OS home directory
-                homeDir = path.join(os.homedir(), "." + this.mAppName.toLowerCase());
-            } else {
-                // use the available environment variable
-                homeDir = path.normalize(process.env[envVarNm]);
-            }
-            ImperativeConfig.instance.loadedConfig = {
-                name: this.mAppName,
-                defaultHome: homeDir,
-                envVariablePrefix: envVarPrefix
-            };
-            ImperativeConfig.instance.rootCommandName = this.mAppName;
-        }
-
-        // initialize logging
-        if (LoggerManager.instance.isLoggerInit === false) {
-            const loggingConfig = LoggingConfigurer.configureLogger(
-                ImperativeConfig.instance.cliHome, ImperativeConfig.instance.loadedConfig
-            );
-            Logger.initLogger(loggingConfig);
-        }
-        this.mImpLogger = Logger.getImperativeLogger();
-    }
-
     /**
      * Load any profile schema objects found on disk and cache them. For team
      * config, we check each config layer and load its schema JSON if there is

packages/imperative/src/config/src/api/ConfigSecure.ts

@@ -20,6 +20,8 @@ import { ConfigConstants } from "../ConfigConstants";
 import { IConfigProfile } from "../doc/IConfigProfile";
 import { CredentialManagerFactory } from "../../../security";
 import { ConfigUtils } from "../ConfigUtils";
+import { ImperativeEventEmitter } from "../../../events/src/ImperativeEventEmitter";
+import { ImperativeUserEvents } from "../../../events/src/ImperativeEventConstants";
 
 /**
  * API Class for manipulating config layers.
@@ -130,6 +132,7 @@ export class ConfigSecure extends ConfigApi {
      */
     public async directSave() {
         await this.mConfig.mVault.save(ConfigConstants.SECURE_ACCT, JSONC.stringify(this.mConfig.mSecure));
+        ImperativeEventEmitter.instance.emitEvent(ImperativeUserEvents.ON_VAULT_CHANGED);
     }
 
     // _______________________________________________________________________

packages/imperative/src/events/__tests__/__integration__/ImperativeEventEmitter.integration.test.ts

@@ -0,0 +1,101 @@
+/*
+* This program and the accompanying materials are made available under the terms of the
+* Eclipse Public License v2.0 which accompanies this distribution, and is available at
+* https://www.eclipse.org/legal/epl-v20.html
+*
+* SPDX-License-Identifier: EPL-2.0
+*
+* Copyright Contributors to the Zowe Project.
+*
+*/
+
+import { IImperativeEventJson, ImperativeEventEmitter, ImperativeSharedEvents } from "../../..";
+import { ITestEnvironment } from "../../../../__tests__/__src__/environment/doc/response/ITestEnvironment";
+import { TestLogger } from "../../../../__tests__/src/TestLogger";
+import * as TestUtil from "../../../../__tests__/src/TestUtil";
+import { SetupTestEnvironment } from "../../../../__tests__/__src__/environment/SetupTestEnvironment";
+import * as fs from "fs";
+import * as path from "path";
+
+let TEST_ENVIRONMENT: ITestEnvironment;
+const iee = ImperativeEventEmitter;
+const iee_s = ImperativeSharedEvents;
+let cwd = '';
+
+describe("Event Emitter", () => {
+    const mainModule = process.mainModule;
+    const testLogger = TestLogger.getTestLogger();
+
+    beforeAll(async () => {
+        (process.mainModule as any) = {
+            filename: __filename
+        };
+
+        TEST_ENVIRONMENT = await SetupTestEnvironment.createTestEnv({
+            cliHomeEnvVar: "ZOWE_CLI_HOME",
+            testName: "event_emitter"
+        });
+        cwd = TEST_ENVIRONMENT.workingDir;
+    });
+
+    beforeEach(() => {
+        iee.initialize("zowe", { logger: testLogger });
+    });
+
+    afterEach(() => {
+        iee.teardown();
+    });
+
+    afterAll(() => {
+        process.mainModule = mainModule;
+        TestUtil.rimraf(cwd);
+    });
+
+    const doesEventFileExists = (eventType: string) => {
+        const eventDir = iee.instance.getEventDir(eventType);
+        if (!fs.existsSync(eventDir)) return false;
+        if (fs.existsSync(path.join(eventDir, eventType))) return true;
+        return false;
+    };
+
+    describe("Shared Events", () => {
+        it("should create an event file upon first subscription if the file does not exist", () => {
+            const theEvent = iee_s.ON_CREDENTIAL_MANAGER_CHANGED;
+
+            expect(doesEventFileExists(theEvent)).toBeFalsy();
+
+            const subSpy = jest.fn();
+            iee.instance.subscribe(theEvent, subSpy);
+
+            expect(subSpy).not.toHaveBeenCalled();
+            expect(doesEventFileExists(theEvent)).toBeTruthy();
+
+            expect(iee.instance.getEventContents(theEvent)).toBeFalsy();
+
+            iee.instance.emitEvent(theEvent);
+
+            (iee.instance as any).subscriptions.get(theEvent)[1][0](); // simulate FSWatcher called
+
+            expect(doesEventFileExists(theEvent)).toBeTruthy();
+            const eventDetails: IImperativeEventJson = JSON.parse(iee.instance.getEventContents(theEvent));
+            expect(eventDetails.type).toEqual(theEvent);
+            expect(eventDetails.user).toBeFalsy();
+
+            expect(subSpy).toHaveBeenCalled();
+        });
+        it("should trigger subscriptions for all instances watching for onCredentialManagerChanged", () => { });
+        it("should not affect subscriptions from another instance when unsubscribing from events", () => { });
+    });
+
+    describe("User Events", () => {
+        it("should create an event file upon first subscription if the file does not exist", () => { });
+        it("should trigger subscriptions for all instances watching for onVaultChanged", () => { });
+        it("should not affect subscriptions from another instance when unsubscribing from events", () => { });
+    });
+
+    describe("Custom Events", () => {
+        it("should create an event file upon first subscription if the file does not exist", () => { });
+        it("should trigger subscriptions for all instances watching for onMyCustomEvent", () => { });
+        it("should not affect subscriptions from another instance when unsubscribing from events", () => { });
+    });
+});