jest-plugin-must-assert - npm Package Compare versions

Comparing version 1.6.0 to 2.0.0

e2e/failing/__tests__/index.js

@@ -5,3 +5,13 @@ /**
  */
+const wait = require('wait-for-expect');
 
+test('unhandled promise rejections fail tests', () => {
+  Promise.resolve().then(() => {
+    throw new Error('oops');
+  });
+  return wait(() => {
+    expect(1).toBe(1);
+  });
+});
+
 test('no assertions, no code', () => {});
@@ -8,0 +18,0 @@

package.json

 {
   "name": "jest-plugin-must-assert",
-  "version": "1.6.0",
+  "version": "2.0.0",
   "description": "Jest plugin for async tests",
@@ -21,3 +21,3 @@ "main": "index.js",
   "jest": {
-    "testEnvironment": "node",
+    "testEnvironment": "jsdom",
     "testRegex": "src/__tests__/.*|(\\.|/)(test|spec)\\.[jt]sx?$"
@@ -32,3 +32,4 @@ },
     "prettier": "^1.16.4",
-    "strip-ansi": "^5.2.0"
+    "strip-ansi": "^5.2.0",
+    "wait-for-expect": "^3.0.1"
   },
@@ -35,0 +36,0 @@ "dependencies": {

src/__tests__/index.js

 const runJest = require('../runJest');
+const wait = require('wait-for-expect');
 
@@ -3,0 +4,0 @@ // A generous timeout as the e2e failing tests timeout in some cases (as intended)

src/index.js

@@ -0,13 +1,31 @@
+/**
+ * Implementation of Must assert plugin
+ *
+ * @author  Arthur Buldauskas <[e-mail]>
+ */
 const StackUtils = require('stack-utils');
-module.exports = patchJestAPI;
+const { getWrapper } = require('./wrap-test');
+const { getZones } = require('./zones');
 
-const EXPOSE_ERROR = Symbol('EXPOSE_ERROR');
-
+/**
+ * Responds to task invokations. Default implementation
+ *
+ * @throws
+ *
+ * @return Boolean Whether or not the task should be allowed to run
+ */
 function onInvokeTaskDefault({
+  // The zone ID which originated this task
   originZoneId,
+  // The current global zone ID currently executing
   currentZoneId,
+  // The name of the test from where this task originates
   testName,
+  // The type of the task being acted upon [micro || macro]Task
   taskType,
+  // Promise, setTimeout etc.
   taskSource,
 }) {
+  // Note that we do not use "testName" for this as they are not guaranteed to be
+  // unique
   if (originZoneId !== currentZoneId) {
@@ -21,139 +39,31 @@ throw new Error(
 
+/**
+ * Path Jest test API
+ *
+ * We will wrap every supported Jest method so that we can place every test
+ * that is declared with it's own Zone. Each test will have it's own zone, which
+ * will have a unique ID. There will be one global "current" zone ID, whenever an
+ * async event attempts to invoke a callback which is NOT from the current zone
+ * ID we will block it and log a warning.
+ *
+ * @return void
+ */
 function patchJestAPI({
+  // Set your own onInvoke task handler if you don't like the original behavior
   onInvokeTask = onInvokeTaskDefault,
+  // Logger override
   logger = console,
-  ignoreStack = [],
+  // Regex of what should be REMOVED from the stack traces of cancelled tasks
+  ignoreStack = [/Zone/, /zone\.js/, /node_modules/],
 }) {
-  const consoleMethods = Object.entries(global.console);
-  const restoreConsole = () =>
-    consoleMethods.forEach(([key, value]) => {
-      global.console[key] = value;
-    });
-
-  require('zone.js');
-  require('zone.js/dist/long-stack-trace-zone');
-  // NOTE: zone.js patches console methods, avoid that.
-  restoreConsole();
-
-  const stack = new StackUtils({
-    cwd: process.cwd(),
-    internals: StackUtils.nodeInternals()
-      .concat([/Zone/, /zone\.js/, /node_modules/])
-      .concat(ignoreStack),
+  const { enterZone, exitZone } = getZones({
+    onInvokeTask,
+    logger,
+    ignoreStack,
   });
-  // Zone sets itself as a global...
-  const Zone = global.Zone;
-  let currentZone = null;
-  let uniqueIdentifier = 0;
-  const uuid = () => ++uniqueIdentifier;
+  const wrapTest = getWrapper({ enterZone, exitZone });
 
-  const testNeedsAssertionCheck = () => {
-    // Some misconfigured test (eg overriding expect itself)
-    if (!(typeof expect !== 'undefined' && 'getState' in expect)) {
-      return false;
-    }
-    const state = expect.getState();
-    return (
-      typeof state.expectedAssertionsNumber !== 'number' &&
-      !state.isExpectingAssertions
-    );
-  };
-
-  const exitZone = () => (currentZone = null);
-  const enterZone = (callback, name, hasDoneCallback) => {
-    const id = uuid();
-    const zone = Zone.root
-      .fork({
-        name,
-        properties: {
-          id,
-        },
-        onHandleError(delegate, current, target, e) {
-          if (e && e[EXPOSE_ERROR]) {
-            logger.warn(`${e.message}\n\n${stack.clean(e.stack)}`);
-            return false;
-          }
-          throw e;
-        },
-        onInvokeTask(delegate, current, target, task, applyThis, applyArgs) {
-          let error;
-          let result = true;
-          try {
-            result = onInvokeTask({
-              originZoneId: current.get('id'),
-              currentZoneId: currentZone,
-              testName: name,
-              taskType: task.type,
-              taskSource: task.source,
-              logger: logger,
-            });
-          } catch (e) {
-            error = e;
-          }
-
-          if (error) {
-            error[EXPOSE_ERROR] = true;
-            error.task = task;
-            throw error;
-          }
-
-          if (!result) {
-            return;
-          }
-
-          return delegate.invokeTask(target, task, applyThis, applyArgs);
-        },
-      })
-      // We fork from the special stack-trace zone so that there is a trail leading
-      // back to the origin of the ignored tasks
-      .fork(Zone.longStackTraceZoneSpec);
-
-    currentZone = id;
-
-    return zone.wrap(hasDoneCallback ? callback : done => callback(done));
-  };
-
-  const wrapTest = (fn, name) => {
-    let testMustAssert;
-    const hasDoneCallback = fn.length > 0;
-
-    if (!hasDoneCallback) {
-      return () => {
-        const result = enterZone(fn, name, false)();
-
-        if (testNeedsAssertionCheck()) {
-          expect.hasAssertions();
-        }
-
-        if (
-          typeof result === 'object' &&
-          result != null &&
-          typeof result.then === 'function'
-        ) {
-          return result.then(exitZone, e => {
-            exitZone();
-            throw e;
-          });
-        }
-
-        exitZone();
-        return result;
-      };
-    }
-
-    return (doneOriginal, ...args) => {
-      const done = () => {
-        exitZone();
-        doneOriginal();
-      };
-      const result = enterZone(fn, name, true)(done, ...args);
-
-      if (testNeedsAssertionCheck()) {
-        expect.hasAssertions();
-      }
-
-      return result;
-    };
-  };
-
+  // TODO: Figure out a way to show the original test during errors instead of the
+  // wrapper below. AFAIK it's not doable unless we recompile the original fn and
+  // somehow append the extra checks...
   function enhanceJestImplementationWithAssertionCheck(jestTest) {
@@ -168,2 +78,3 @@ return function ehanchedJestMehod(name, fn, timeout) {
 
+  // TODO: Support .each
   const donotpatch = ['each', 'skip', 'todo'];
@@ -185,1 +96,6 @@
 }
+
+// Default export
+//
+// The plugin does nothing unless this is invoked
+module.exports = patchJestAPI;

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

Improved metrics

Total package byte prevSize

25995

increased by26.32%

Number of package files

19

increased by11.76%

Lines of code

677

increased by33.27%

Worsened metrics

Dev dependency count

8

increased by14.29%

No dependency changes