feat: improve module provider validation and dispose handling (#3597)

* feat: improve BaseModuleProvider instanceof validation

- Enhance Symbol.hasInstance to validate version as valid semver
- Ensure dispose property is a function
- Add proper TSDoc documentation
- Create changeset for patch release

* fix: ensure dispose method proxy binding in AuthProvider

- Fix dispose method proxy handling to ensure proper binding when accessed through proxy
- Create changeset for patch release

* Update packages/modules/module/src/lib/provider/BaseModuleProvider.ts

Co-authored-by: Copilot <[email protected]>

* docs: add comment explaining use of 'in' operator in Symbol.hasInstance

- Clarify why we check prototype chain instead of own properties
- Explain duck-typing behavior for instanceof checks

* fix: resolve TypeScript errors in BaseModuleProvider Symbol.hasInstance

Use Record<string, unknown> type assertion instead of casting to BaseModuleProvider
to avoid accessing properties on object type errors reported by reviewdog.

---------

Co-authored-by: Copilot <[email protected]>

Author: odinr

.changeset/framework-module-instanceof-validation.md

@@ -0,0 +1,5 @@
+---
+"@equinor/fusion-framework-module": patch
+---
+
+Improve Symbol.hasInstance validation in BaseModuleProvider to ensure version is a valid semver and dispose is a function.

.changeset/framework-module-msal-dispose-proxy-fix.md

@@ -0,0 +1,5 @@
+---
+"@equinor/fusion-framework-module-msal": patch
+---
+
+Fix dispose method proxy handling in AuthProvider to ensure proper binding when accessed through proxy.

packages/modules/module/src/lib/provider/BaseModuleProvider.ts

@@ -1,9 +1,10 @@
+import { coerce } from 'semver';
+import { Subscription, type TeardownLogic } from 'rxjs';
+
 import SemanticVersion from '../semantic-version.js';
 
 import type { IModuleProvider } from './IModuleProvider.js';
 
-import { Subscription, type TeardownLogic } from 'rxjs';
-
 export type BaseModuleProviderCtorArgs<TConfig = unknown> = {
   version: string | SemanticVersion;
   config: TConfig;
@@ -15,6 +16,32 @@ export type BaseModuleProviderCtorArgs<TConfig = unknown> = {
  * this is the interface which is returned after enabling a module
  */
 export abstract class BaseModuleProvider<TConfig = unknown> implements IModuleProvider {
+  /**
+   * Custom instanceof check for module providers.
+   * Determines if an object is considered an instance of BaseModuleProvider
+   * by validating the structure and ensuring the version is a valid SemanticVersion
+   * and dispose is a function.
+   *
+   * @param instance - The object to check
+   * @returns True if the object has valid structure and property types, false otherwise
+   */
+  static [Symbol.hasInstance](instance: unknown): boolean {
+    const hasStructure =
+      instance !== null &&
+      typeof instance === 'object' &&
+      // Use 'in' operator to check prototype chain, allowing for duck-typing
+      // where inherited properties are acceptable for instanceof checks
+      'version' in instance &&
+      'dispose' in instance;
+    if (hasStructure) {
+      const obj = instance as Record<string, unknown>;
+      const version = coerce(String(obj.version));
+      const dispose = obj.dispose;
+      return !!version && typeof dispose === 'function';
+    }
+    return false;
+  }
+
   #version: SemanticVersion;
   #subscriptions: Subscription;
 

packages/modules/msal/src/v2/provider.ts

@@ -142,11 +142,13 @@ export class AuthProvider
   }
 
   _createProxyProvider_v2(): IAuthProvider {
-    return new Proxy(this, {
+    const proxy = new Proxy(this, {
       get: (target: AuthProvider, prop: keyof AuthProvider) => {
         switch (prop) {
           case 'version':
             return target.version;
+          case 'dispose':
+            return target.dispose.bind(target);
           case 'client':
             return target.client;
           // @ts-expect-error this is deprecated since version 5.0.1
@@ -170,5 +172,7 @@ export class AuthProvider
         }
       },
     });
+
+    return proxy;
   }
 }