From edf57044e0d87dd7d8bd5e3695a19a6fbeffaf7a Mon Sep 17 00:00:00 2001
From: Ruben Bridgewater <ruben@bridgewater.de>
Date: Fri, 26 Nov 2021 05:27:00 +0100
Subject: [PATCH] assert: allow arbitrary argument order in match() and
 doesNotMatch()

This allows assert.match() and assert.doesNotMatch() arguments to
be inserted in any order.

Signed-off-by: Ruben Bridgewater <ruben@bridgewater.de>
---
 doc/api/assert.md            | 10 +++++++
 lib/assert.js                | 30 +++++++++++++++++----
 test/parallel/test-assert.js | 52 +++++++++++++++++++++++++++++++++---
 3 files changed, 84 insertions(+), 8 deletions(-)

diff --git a/doc/api/assert.md b/doc/api/assert.md
index a22a6082c3a379..affe1778852a7f 100644
--- a/doc/api/assert.md
+++ b/doc/api/assert.md
@@ -890,11 +890,16 @@ parameter is an instance of an [`Error`][] then it will be thrown instead of the
 
 ## `assert.doesNotMatch(string, regexp[, message])`
 
+## `assert.doesNotMatch(regexp, string[, message])`
+
 <!-- YAML
 added:
   - v13.6.0
   - v12.16.0
 changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/41007
+    description: The argument order may now be "regexp, string".
   - version: v16.0.0
     pr-url: https://github.com/nodejs/node/pull/38111
     description: This API is no longer experimental.
@@ -1415,11 +1420,16 @@ let err;
 
 ## `assert.match(string, regexp[, message])`
 
+## `assert.match(regexp, string[, message])`
+
 <!-- YAML
 added:
   - v13.6.0
   - v12.16.0
 changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/41007
+    description: The argument order may now be "regexp, string".
   - version: v16.0.0
     pr-url: https://github.com/nodejs/node/pull/38111
     description: This API is no longer experimental.
diff --git a/lib/assert.js b/lib/assert.js
index 89949c01614fd4..2ea14adef80ec8 100644
--- a/lib/assert.js
+++ b/lib/assert.js
@@ -989,10 +989,17 @@ assert.ifError = function ifError(err) {
 
 function internalMatch(string, regexp, message, fn) {
   if (!isRegExp(regexp)) {
-    throw new ERR_INVALID_ARG_TYPE(
-      'regexp', 'RegExp', regexp
-    );
+    if (isRegExp(string)) {
+      const tmp = string;
+      string = regexp;
+      regexp = tmp;
+    } else {
+      throw new ERR_INVALID_ARG_TYPE(
+        'regexp', 'RegExp', regexp
+      );
+    }
   }
+
   const match = fn.name === 'match';
   if (typeof string !== 'string' ||
       RegExpPrototypeTest(regexp, string) !== match) {
@@ -1002,8 +1009,21 @@ function internalMatch(string, regexp, message, fn) {
 
     const generatedMessage = !message;
 
-    // 'The input was expected to not match the regular expression ' +
-    message = message || (typeof string !== 'string' ?
+    if (!message) {
+      if (typeof string !== 'string') {
+        message = 'The "string" argument must be of type string. ' +
+          `Received type ${typeof string} (${inspect(string)})`;
+      } else {
+        if (match) {
+          message = 'The input did not match the regular expression';
+        } else {
+          message = 'The input was expected to not match the regular ' +
+                    'expression';
+        }
+        message += ` ${inspect(regexp)}. Input:\n\n${inspect(string)}\n`;
+      }
+    }
+    message ||= (typeof string !== 'string' ?
       'The "string" argument must be of type string. Received type ' +
         `${typeof string} (${inspect(string)})` :
       (match ?
diff --git a/test/parallel/test-assert.js b/test/parallel/test-assert.js
index 84cce7e8a5e740..55e4daa2b1a71c 100644
--- a/test/parallel/test-assert.js
+++ b/test/parallel/test-assert.js
@@ -1372,11 +1372,34 @@ assert.throws(
 // Multiple assert.match() tests.
 {
   assert.throws(
-    () => assert.match(/abc/, 'string'),
+    () => assert.match(/abc/, 5),
     {
+      actual: 5,
+      expected: /abc/,
+      operator: 'match',
+      message: 'The "string" argument must be of type string. ' +
+               'Received type number (5)',
+      generatedMessage: true
+    }
+  );
+  assert.throws(
+    () => assert.match(5, 'string'),
+    {
+      name: 'TypeError',
       code: 'ERR_INVALID_ARG_TYPE',
       message: 'The "regexp" argument must be an instance of RegExp. ' +
-               "Received type string ('string')"
+               "Received type string ('string')",
+    }
+  );
+  assert.throws(
+    () => assert.match(/abc/, 'string'),
+    {
+      actual: 'string',
+      expected: /abc/,
+      operator: 'match',
+      message: 'The input did not match the regular expression /abc/. ' +
+               "Input:\n\n'string'\n",
+      generatedMessage: true
     }
   );
   assert.throws(
@@ -1422,8 +1445,31 @@ assert.throws(
 // Multiple assert.doesNotMatch() tests.
 {
   assert.throws(
-    () => assert.doesNotMatch(/abc/, 'string'),
+    () => assert.doesNotMatch(/string/, 5),
+    {
+      actual: 5,
+      expected: /string/,
+      operator: 'doesNotMatch',
+      message: 'The "string" argument must be of type string. ' +
+               'Received type number (5)',
+      generatedMessage: true
+    }
+  );
+  assert.throws(
+    () => assert.doesNotMatch(/string/, 'string'),
+    {
+      actual: 'string',
+      expected: /string/,
+      operator: 'doesNotMatch',
+      message: 'The input was expected to not match the regular expression ' +
+               "/string/. Input:\n\n'string'\n",
+      generatedMessage: true
+    }
+  );
+  assert.throws(
+    () => assert.doesNotMatch(5, 'string'),
     {
+      name: 'TypeError',
       code: 'ERR_INVALID_ARG_TYPE',
       message: 'The "regexp" argument must be an instance of RegExp. ' +
                "Received type string ('string')"