Skip to content

BREAKING CHANGE: remove assert.failException property #2659

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 9, 2025

Conversation

mroderick
Copy link
Member

Fixes #2658

Purpose

Remove sinon.assert.failException, which makes sinon slightly smaller and makes tests run slightly faster.

Background

This was used for allowing customisation of the thrown error between sandboxes and for customisation for integrations (most likely from the days of BusterJS).

To my knowledge and what I've been able to find on GitHub, this has never had any production use by end users.

How to verify - mandatory

  1. Check out this branch
  2. npm install
  3. npm test

Checklist for author

  • npm run lint passes
  • References to standard library functions are cached.

@mroderick mroderick requested review from fatso83 and hexeberlin June 9, 2025 18:10
@mroderick mroderick added the semver:major changes will cause a new major version label Jun 9, 2025
Copy link

codecov bot commented Jun 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.82%. Comparing base (c720235) to head (b09dc5d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2659   +/-   ##
=======================================
  Coverage   95.82%   95.82%           
=======================================
  Files          39       39           
  Lines        1891     1891           
=======================================
  Hits         1812     1812           
  Misses         79       79           
Flag Coverage Δ
unit 95.82% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

This was used for allowing customisation of the thrown error between
sandboxes and for customisation for integrations (most likely from the
days of BusterJS).

To my knowledge and what I've been able to find on GitHub, this has
never had any _production_ use by end users.

BREAKING CHANGE: this removes assert.failException from the API
@mroderick mroderick force-pushed the remove-fail-exception branch from 87c7207 to b09dc5d Compare June 9, 2025 18:13
@fatso83 fatso83 merged commit fd10f13 into main Jun 9, 2025
14 checks passed
@fatso83 fatso83 deleted the remove-fail-exception branch June 9, 2025 21:30
@mroderick
Copy link
Member Author

This has been publish to the npm registry as [email protected].

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver:major changes will cause a new major version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecate sinon.assert.failException
2 participants