fix: changelog updates and codeql remarks on tests

Signed-off-by: zFernand0 <[email protected]>

packages/imperative/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to the Imperative package will be documented in this file.
 ## Recent Changes
 
 - Enhancement: Add client-side custom-event handling capabilities. [#2136](https://github.com/zowe/zowe-cli/pull/2136)
+- Next-Breaking: Refactored the Imperative Event Emitter class. [#2136](https://github.com/zowe/zowe-cli/pull/2136)
+  - Removed the `ImperativeEventEmitter` class.
+  - Added an `EventProcessor` class to handle event listening and emitting.
+  - Added an `EventOperator` class to handle creation and deletion of `EventProcessors`.
+  - Added an `EventUtils` class to contain all common utility methods for the Client Event Handling capabilities.
+  - Added `IEmitter`, `IWatcher`, and `IEmitterAndWatcher` interfaces to expose what application developers should see.
 
 ## `8.0.0-next.202405151329`
 

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

@@ -47,7 +47,7 @@ export class ConfigUtils {
      * Called once in `readProfilesFromDisk` and cached to minimize I/O operations.
      * @internal
      */
-    public static readExtendersJsonFromDisk(): IExtendersJsonOpts {
+    public static readExtendersJson(): IExtendersJsonOpts {
         const extenderJsonPath = pathJoin(ConfigUtils.getZoweDir(), "extenders.json");
         if (!fsExistsSync(extenderJsonPath)) {
             jsonfile.writeFileSync(extenderJsonPath, {

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

@@ -828,7 +828,7 @@ export class ProfileInfo {
             });
         }
 
-        this.mExtendersJson = ProfileInfo.readExtendersJsonFromDisk();
+        this.mExtendersJson = ConfigUtils.readExtendersJson();
         this.loadAllSchemas();
     }
 
@@ -1007,10 +1007,10 @@ export class ProfileInfo {
      * Reads the `extenders.json` file from the CLI home directory.
      * Called once in `readProfilesFromDisk` and cached to minimize I/O operations.
      * @internal
-     * @deprecated Please use `ConfigUtils.readExtendersJsonFromDisk` instead
+     * @deprecated Please use `ConfigUtils.readExtendersJson` instead
      */
     public static readExtendersJsonFromDisk(): IExtendersJsonOpts {
-        return ConfigUtils.readExtendersJsonFromDisk();
+        return ConfigUtils.readExtendersJson();
     }
 
     /**

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

@@ -9,7 +9,7 @@
 *
 */
 
-import { IImperativeEventJson as EventJson, EventUtils, IEventJson, ImperativeEventEmitter, ImperativeSharedEvents } from "../../..";
+import { EventOperator, EventTypes, EventUtils, IEventJson, ZoweSharedEvents } from "../../..";
 import { ITestEnvironment } from "../../../../__tests__/__src__/environment/doc/response/ITestEnvironment";
 import { TestLogger } from "../../../../__tests__/src/TestLogger";
 import * as TestUtil from "../../../../__tests__/src/TestUtil";
@@ -18,9 +18,8 @@ import * as fs from "fs";
 import * as path from "path";
 
 let TEST_ENVIRONMENT: ITestEnvironment;
-const iee = ImperativeEventEmitter;
-const iee_s = ImperativeSharedEvents;
 let cwd = '';
+const appName = "Zowe";
 
 describe("Event Emitter", () => {
     const mainModule = process.mainModule;
@@ -38,50 +37,47 @@ describe("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);
+    const doesEventFileExists = (eventName: string) => {
+        const eventType = EventUtils.isSharedEvent(eventName) ? EventTypes.ZoweSharedEvents :
+            EventUtils.isUserEvent(eventName) ? EventTypes.ZoweUserEvents : EventTypes.SharedEvents;
+
+        const eventDir = EventUtils.getEventDir(eventType, appName);
         if (!fs.existsSync(eventDir)) return false;
-        if (fs.existsSync(path.join(eventDir, eventType))) return true;
+        if (fs.existsSync(path.join(eventDir, appName, eventName))) 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;
+            const theEvent = ZoweSharedEvents.ON_CREDENTIAL_MANAGER_CHANGED;
+            const theProc = EventOperator.getZoweProcessor()
 
             expect(doesEventFileExists(theEvent)).toBeFalsy();
+            expect((theProc as any).subscribedEvents.get(theEvent)).toBeFalsy();
 
             const subSpy = jest.fn();
-            iee.instance.subscribe(theEvent, subSpy);
+            theProc.subscribeShared(theEvent, subSpy);
 
             expect(subSpy).not.toHaveBeenCalled();
             expect(doesEventFileExists(theEvent)).toBeTruthy();
 
-            expect(iee.instance.getEventContents(theEvent)).toBeFalsy();
-
-            iee.instance.emitEvent(theEvent);
+            theProc.emitEvent(theEvent);
 
-            (iee.instance as any).subscriptions.get(theEvent)[1][0](); // simulate FSWatcher called
+            (theProc as any).subscribedEvents.get(theEvent).subscriptions[0](); // simulate FSWatcher called
 
             expect(doesEventFileExists(theEvent)).toBeTruthy();
-            const eventDetails: IEventJson = JSON.parse(iee.instance.getEventContents(theEvent));
+            const eventDetails: IEventJson = (theProc as any).subscribedEvents.get(theEvent).toJson();
             expect(eventDetails.eventName).toEqual(theEvent);
-            expect(EventUtils.isUserEvent(eventDetails.eventName)).toBeTruthy();
+            expect(EventUtils.isSharedEvent(eventDetails.eventName)).toBeTruthy();
 
             expect(subSpy).toHaveBeenCalled();
+
+            EventOperator.deleteProcessor(appName);
         });
         it("should trigger subscriptions for all instances watching for onCredentialManagerChanged", () => { });
         it("should not affect subscriptions from another instance when unsubscribing from events", () => { });

packages/imperative/src/events/src/EventConstants.ts

@@ -10,7 +10,6 @@
 */
 
 
-// TO DO - flesh out these enums to include all expected user and shared events
 export enum ZoweUserEvents {
     ON_VAULT_CHANGED = "onVaultChanged"
 }
@@ -19,14 +18,6 @@ export enum ZoweSharedEvents {
     ON_CREDENTIAL_MANAGER_CHANGED = "onCredentialManagerChanged"
 }
 
-export enum SharedEvents {
-    CUSTOM_SHARED_EVENT = "customSharedEvent"
-}
-
-export enum UserEvents {
-    CUSTOM_USER_EVENT = "customUserEvent",
-}
-
 export enum EventTypes { ZoweUserEvents, ZoweSharedEvents, SharedEvents, UserEvents }
 
 export type EventCallback = () => void | PromiseLike<void>;

packages/imperative/src/events/src/EventOperator.ts

@@ -12,7 +12,6 @@
 import { EventProcessor } from "./EventProcessor";
 import { IEmitter, IEmitterAndWatcher, IProcessorTypes, IWatcher } from "./doc/IEventInstanceTypes";
 import { Logger } from "../../logger";
-import { EventUtils } from "./EventUtils";
 
 /**
  *  @internal Interface for Zowe-specific event processing, combining emitter and watcher functionalities.
@@ -46,13 +45,22 @@ export class EventOperator {
             const newInstance = new EventProcessor(appName, type, logger);
             this.instances.set(appName, newInstance);
         }
-        return this.instances.get(appName);
+        const procInstance = this.instances.get(appName);
+        if (procInstance.processorType !== type) {
+            procInstance.processorType = IProcessorTypes.BOTH;
+            // throw new ImperativeError({msg: "Not allowed to get the other hald"})
+        }
+        return procInstance;
     }
 
     /**
-     * Retrieves a Zowe-specific event processor.
+     * Retrieves a Zowe-specific event processor. The purpose of this method is for internal
+     * Imperative APIs to get a properly initialized processor. This processor will be used
+     * when applications (like Zowe Explorer) call Imperative APIs that trigger events. For
+     * example, when the user updates credentials from Zowe Explorer, this processor will be
+     * used to emit an `OnVaultChanged` event.
      *
-     * @internal
+     * @internal Not meant to be called by application developers
      * @static
      * @returns {IZoweProcessor} The Zowe event processor instance.
      */

packages/imperative/src/events/src/EventUtils.ts

@@ -34,7 +34,7 @@ export class EventUtils {
      * @returns {string[]} List of application names.
      */
     public static getListOfApps(): string[] {
-        const extendersJson = ConfigUtils.readExtendersJsonFromDisk();
+        const extendersJson = ConfigUtils.readExtendersJson();
         // We should not need to keep a reference to their sources
         return ["Zowe", ...Object.keys(extendersJson.profileTypes)];
 
@@ -147,11 +147,12 @@ export class EventUtils {
      * @return {IEventDisposable} An interface for managing the subscription.
      */
     public static createSubscription(eeInst: EventProcessor, eventName: string, eventType: EventTypes): IEventDisposable {
-        const dir = this.getEventDir(eventType, eeInst.appName);
-        this.ensureEventsDirExists(join(ConfigUtils.getZoweDir(), '.events'));
-        this.ensureEventsDirExists(join(ConfigUtils.getZoweDir(), dir));
+        const dir = EventUtils.getEventDir(eventType, eeInst.appName);
+        const zoweDir = ConfigUtils.getZoweDir();
+        this.ensureEventsDirExists(join(zoweDir, '.events'));
+        this.ensureEventsDirExists(join(zoweDir, dir));
 
-        const filePath = join(ConfigUtils.getZoweDir(), dir, eventName);
+        const filePath = join(zoweDir, dir, eventName);
         this.ensureFileExists(filePath);
 
         const newEvent = new Event({

packages/imperative/src/imperative/src/plugins/utilities/npm-interface/install.ts

@@ -26,7 +26,7 @@ import { UpdateImpConfig } from "../../../UpdateImpConfig";
 import { CredentialManagerOverride, ICredentialManagerNameMap } from "../../../../../security";
 import { IProfileTypeConfiguration } from "../../../../../profiles";
 import * as semver from "semver";
-import { ProfileInfo } from "../../../../../config";
+import { ConfigUtils, ProfileInfo } from "../../../../../config";
 import { IExtendersJsonOpts } from "../../../../../config/src/doc/IExtenderOpts";
 
 // Helper function to update extenders.json object during plugin install.
@@ -188,7 +188,7 @@ export async function install(packageLocation: string, registry: string, install
                     // Only update global schema if we were able to load it from disk
                     if (loadedSchema != null) {
                         const existingTypes = loadedSchema.map((obj) => obj.type);
-                        const extendersJson = ProfileInfo.readExtendersJsonFromDisk();
+                        const extendersJson = ConfigUtils.readExtendersJson();
 
                         // Determine new profile types to add to schema
                         let shouldUpdate = false;

packages/imperative/src/imperative/src/plugins/utilities/npm-interface/uninstall.ts

@@ -19,7 +19,7 @@ import { ImperativeError } from "../../../../../error";
 import { ExecUtils, TextUtils } from "../../../../../utilities";
 import { StdioOptions } from "child_process";
 import { findNpmOnPath } from "../NpmFunctions";
-import { ConfigSchema, ProfileInfo } from "../../../../../config";
+import { ConfigSchema, ConfigUtils, ProfileInfo } from "../../../../../config";
 import { IProfileTypeConfiguration } from "../../../../../profiles";
 
 const npmCmd = findNpmOnPath();
@@ -30,7 +30,7 @@ const npmCmd = findNpmOnPath();
  * @returns A list of types to remove from the schema
  */
 export const updateAndGetRemovedTypes = (npmPackage: string): string[] => {
-    const extendersJson = ProfileInfo.readExtendersJsonFromDisk();
+    const extendersJson = ConfigUtils.readExtendersJson();
     const pluginTypes = Object.keys(extendersJson.profileTypes)
         .filter((type) => extendersJson.profileTypes[type].from.includes(npmPackage));
     const typesToRemove: string[] = [];