jest-mock - npm Package Compare versions

Comparing version 29.1.0 to 29.1.1

build/index.d.ts

@@ -287,2 +287,3 @@ /**
     : never;
+  private _spyOnProperty;
   clearAllMocks(): void;
@@ -289,0 +290,0 @@ resetAllMocks(): void;

build/index.js

@@ -285,6 +285,3 @@ 'use strict';
 
-          if (
-            propDesc !== undefined &&
-            !(propDesc.get && prop == '__proto__')
-          ) {
+          if ((propDesc !== undefined && !propDesc.get) || object.__esModule) {
             slots.add(prop);
@@ -647,3 +644,2 @@ }
     this._getSlots(metadata.members).forEach(slot => {
-      let slotMock;
       const slotMetadata = (metadata.members && metadata.members[slot]) || {};
@@ -658,32 +654,3 @@
       } else {
-        slotMock = this._generateMock(slotMetadata, callbacks, refs); // For superclass accessor properties the subclass metadata contains the definitions
-        // for the getter and setter methods, and the superclass refs to them.
-        // The mock implementations are not available until the callbacks have been executed.
-        // Missing getter and setter refs will be resolved as their callbacks have been
-        // stacked before the setting of the accessor definition is stacked.
-
-        if (
-          slotMetadata.members?.get?.ref !== undefined ||
-          slotMetadata.members?.set?.ref !== undefined
-        ) {
-          callbacks.push(
-            (function (ref) {
-              return () => Object.defineProperty(mock, slot, ref);
-            })(slotMock)
-          );
-        } else if (
-          (slotMetadata.members?.get || slotMetadata.members?.set) &&
-          slotMetadata.members?.configurable &&
-          slotMetadata.members?.enumerable
-        ) {
-          // In some cases, e.g. third-party APIs, a 'prototype' ancestor to be
-          // mocked has a function property called 'get'.  In this circumstance
-          // the 'prototype' property cannot be redefined and doing so causes an
-          // exception. Checks have been added for the 'configurable' and
-          // 'enumberable' properties present on true accessor property
-          // descriptors to prevent the attempt to replace the API.
-          Object.defineProperty(mock, slot, slotMock);
-        } else {
-          mock[slot] = slotMock;
-        }
+        mock[slot] = this._generateMock(slotMetadata, callbacks, refs);
       }
@@ -778,32 +745,6 @@ });
           return;
-        }
+        } // @ts-expect-error no index signature
 
-        let descriptor = Object.getOwnPropertyDescriptor(component, slot);
-        let proto = Object.getPrototypeOf(component);
+        const slotMetadata = this.getMetadata(component[slot], refs);
 
-        while (!descriptor && proto !== null) {
-          descriptor = Object.getOwnPropertyDescriptor(proto, slot);
-          proto = Object.getPrototypeOf(proto);
-        }
-
-        let slotMetadata = null;
-
-        if (descriptor?.get || descriptor?.set) {
-          // Specific case required for mocking class definitions imported via modules.
-          // In this case the class definitions are stored in accessor properties.
-          // All getters were previously ignored except where the containing object had __esModule == true
-          // Now getters are mocked the class definitions must still be read.
-          // @ts-expect-error ignore type mismatch
-          if (component.__esModule) {
-            // @ts-expect-error no index signature
-            slotMetadata = this.getMetadata(component[slot], refs);
-          } else {
-            // @ts-expect-error ignore type mismatch
-            slotMetadata = this.getMetadata(descriptor, refs);
-          }
-        } else {
-          // @ts-expect-error no index signature
-          slotMetadata = this.getMetadata(component[slot], refs);
-        }
-
         if (slotMetadata) {
@@ -847,27 +788,101 @@ if (!members) {
   spyOn(object, methodKey, accessType) {
-    if (!object) {
+    if (accessType) {
+      return this._spyOnProperty(object, methodKey, accessType);
+    }
+
+    if (typeof object !== 'object' && typeof object !== 'function') {
       throw new Error(
-        `spyOn could not find an object to spy upon for ${String(methodKey)}`
+        `Cannot spyOn on a primitive value; ${this._typeOf(object)} given`
       );
     }
 
-    if (!methodKey) {
-      throw new Error('No property name supplied');
+    const original = object[methodKey];
+
+    if (!this.isMockFunction(original)) {
+      if (typeof original !== 'function') {
+        throw new Error(
+          `Cannot spy the ${String(
+            methodKey
+          )} property because it is not a function; ${this._typeOf(
+            original
+          )} given instead`
+        );
+      }
+
+      const isMethodOwner = Object.prototype.hasOwnProperty.call(
+        object,
+        methodKey
+      );
+      let descriptor = Object.getOwnPropertyDescriptor(object, methodKey);
+      let proto = Object.getPrototypeOf(object);
+
+      while (!descriptor && proto !== null) {
+        descriptor = Object.getOwnPropertyDescriptor(proto, methodKey);
+        proto = Object.getPrototypeOf(proto);
+      }
+
+      let mock;
+
+      if (descriptor && descriptor.get) {
+        const originalGet = descriptor.get;
+        mock = this._makeComponent(
+          {
+            type: 'function'
+          },
+          () => {
+            descriptor.get = originalGet;
+            Object.defineProperty(object, methodKey, descriptor);
+          }
+        );
+
+        descriptor.get = () => mock;
+
+        Object.defineProperty(object, methodKey, descriptor);
+      } else {
+        mock = this._makeComponent(
+          {
+            type: 'function'
+          },
+          () => {
+            if (isMethodOwner) {
+              object[methodKey] = original;
+            } else {
+              delete object[methodKey];
+            }
+          }
+        ); // @ts-expect-error overriding original method with a Mock
+
+        object[methodKey] = mock;
+      }
+
+      mock.mockImplementation(function () {
+        return original.apply(this, arguments);
+      });
     }
 
-    if (accessType && accessType != 'get' && accessType != 'set') {
-      throw new Error('Invalid accessType supplied');
+    return object[methodKey];
+  }
+
+  _spyOnProperty(obj, propertyKey, accessType) {
+    if (typeof obj !== 'object' && typeof obj !== 'function') {
+      throw new Error(
+        `Cannot spyOn on a primitive value; ${this._typeOf(obj)} given`
+      );
     }
 
-    if (typeof object !== 'object' && typeof object !== 'function') {
+    if (!obj) {
       throw new Error(
-        `Cannot spyOn on a primitive value; ${this._typeOf(object)} given`
+        `spyOn could not find an object to spy upon for ${String(propertyKey)}`
       );
     }
 
-    let descriptor = Object.getOwnPropertyDescriptor(object, methodKey);
-    let proto = Object.getPrototypeOf(object);
+    if (!propertyKey) {
+      throw new Error('No property name supplied');
+    }
 
+    let descriptor = Object.getOwnPropertyDescriptor(obj, propertyKey);
+    let proto = Object.getPrototypeOf(obj);
+
     while (!descriptor && proto !== null) {
-      descriptor = Object.getOwnPropertyDescriptor(proto, methodKey);
+      descriptor = Object.getOwnPropertyDescriptor(proto, propertyKey);
       proto = Object.getPrototypeOf(proto);
@@ -877,39 +892,31 @@ }
     if (!descriptor) {
-      throw new Error(`${String(methodKey)} property does not exist`);
+      throw new Error(`${String(propertyKey)} property does not exist`);
     }
 
     if (!descriptor.configurable) {
-      throw new Error(`${String(methodKey)} is not declared configurable`);
+      throw new Error(`${String(propertyKey)} is not declared configurable`);
     }
 
-    if (this.isMockFunction(descriptor.value)) {
-      return object[methodKey];
-    } else if (accessType == 'get' && this.isMockFunction(descriptor.get)) {
-      return descriptor.get;
-    } else if (accessType == 'set' && this.isMockFunction(descriptor.set)) {
-      return descriptor.set;
-    }
-
-    if (accessType) {
-      if (typeof descriptor[accessType] !== 'function') {
-        throw new Error(`Cannot spy the ${String(accessType)} ${String(
-          methodKey
-        )} property because it is not a function;
-          ${this._typeOf(descriptor?.[accessType])} given instead`);
-      }
-    } else if (typeof descriptor.value !== 'function') {
+    if (!descriptor[accessType]) {
       throw new Error(
-        `Cannot spy the ${String(
-          methodKey
-        )} property because it is not a function; ${this._typeOf(
-          descriptor.value
-        )} given instead`
+        `Property ${String(
+          propertyKey
+        )} does not have access type ${accessType}`
       );
     }
 
-    let mock;
+    const original = descriptor[accessType];
 
-    if (accessType == 'get' && descriptor['get']) {
-      const originalAccessor = descriptor['get'];
-      mock = this._makeComponent(
+    if (!this.isMockFunction(original)) {
+      if (typeof original !== 'function') {
+        throw new Error(
+          `Cannot spy the ${String(
+            propertyKey
+          )} property because it is not a function; ${this._typeOf(
+            original
+          )} given instead`
+        );
+      }
+
+      descriptor[accessType] = this._makeComponent(
         {
@@ -919,53 +926,15 @@ type: 'function'
         () => {
-          descriptor[accessType] = originalAccessor;
-          Object.defineProperty(object, methodKey, descriptor);
+          // @ts-expect-error: mock is assignable
+          descriptor[accessType] = original;
+          Object.defineProperty(obj, propertyKey, descriptor);
         }
       );
-      descriptor[accessType] = mock;
-      mock.mockImplementation(function () {
-        return originalAccessor.call(this);
+      descriptor[accessType].mockImplementation(function () {
+        // @ts-expect-error - wrong context
+        return original.apply(this, arguments);
       });
-      Object.defineProperty(object, methodKey, descriptor);
-    } else if (accessType == 'set' && descriptor['set']) {
-      const originalAccessor = descriptor['set'];
-      mock = this._makeComponent(
-        {
-          type: 'function'
-        },
-        () => {
-          descriptor[accessType] = originalAccessor;
-          Object.defineProperty(object, methodKey, descriptor);
-        }
-      );
-      descriptor[accessType] = mock;
-      mock.mockImplementation(function () {
-        return originalAccessor.call(this, arguments[0]);
-      });
-      Object.defineProperty(object, methodKey, descriptor);
-    } else {
-      const isMethodOwner = Object.prototype.hasOwnProperty.call(
-        object,
-        methodKey
-      );
-      const original = descriptor;
-      mock = this._makeComponent(
-        {
-          type: 'function'
-        },
-        () => {
-          if (isMethodOwner) {
-            object[methodKey] = original.value;
-          } else {
-            delete object[methodKey];
-          }
-        }
-      ); // @ts-expect-error overriding original method with a Mock
-
-      object[methodKey] = mock;
-      mock.mockImplementation(function () {
-        return original.value.apply(this, arguments);
-      });
     }
 
-    return mock;
+    Object.defineProperty(obj, propertyKey, descriptor);
+    return descriptor[accessType];
   }
@@ -972,0 +941,0 @@

package.json

 {
   "name": "jest-mock",
-  "version": "29.1.0",
+  "version": "29.1.1",
   "repository": {
@@ -34,3 +34,3 @@ "type": "git",
   },
-  "gitHead": "51f10300daf90db003a1749ceaed1084c4f74811"
+  "gitHead": "fd9cd900ad0904421a3d97661fdc3337194da1f9"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

42400

decreased by-5.02%

Lines of code

1149

decreased by-3.12%

No dependency changes