fix: Allow for a log limit setting on the assertion object, that when…

… true, will truncate the error.message that is returned via a failing assertion. The limit for the log message will be set to a default if none was provided
sinonjs · Dec 12, 2022 · f71d859 · f71d859
1 parent 62caa67
commit f71d859
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/lib/sinon/assert.js b/lib/sinon/assert.js
@@ -15,8 +15,11 @@ var forEach = arrayProto.forEach;
 var join = arrayProto.join;
 var splice = arrayProto.splice;
 
-function createAssertObject() {
+var DEFAULT_LOG_LIMIT = 10000;
+
+function createAssertObject(shouldLimitAssertionLogs) {
     var assert;
+    var assertionLogLimit;
 
     function verifyIsStub() {
         var args = arraySlice(arguments);
@@ -117,6 +120,9 @@ function createAssertObject() {
         failException: "AssertError",
 
         fail: function fail(message) {
+            if (shouldLimitAssertionLogs) {
+                message.substring(0, assertionLogLimit ?? DEFAULT_LOG_LIMIT);
+            }
             var error = new Error(message);
             error.name = this.failException || assert.failException;
 

diff --git a/lib/sinon/sandbox.js b/lib/sinon/sandbox.js
@@ -38,6 +38,7 @@ function Sandbox() {
     var sandbox = this;
     var fakeRestorers = [];
     var promiseLib;
+    var shouldLimitAssertionLogs;
 
     var collection = [];
     var loggedLeakWarning = false;
@@ -56,7 +57,7 @@ function Sandbox() {
         }
     }
 
-    sandbox.assert = sinonAssert.createAssertObject();
+    sandbox.assert = sinonAssert.createAssertObject(shouldLimitAssertionLogs);
 
     sandbox.serverPrototype = fakeServer;