Test mutation fix and fail #1315

Mav55 · 2025-08-05T10:57:14Z

Which Jira task belongs to this PR?

Why did I implement it this way?

Checklist before requesting a review

I have performed a self-review of my code
This pull request is as small as possible and only tackles one problem
I have added tests that cover the functionality / test the bug
For new facets: I have checked all points from this list: https://www.notion.so/lifi/New-Facet-Contract-Checklist-157f0ff14ac78095a2b8f999d655622e
I have updated any required documentation

Checklist for reviewer (DO NOT DEPLOY and contracts BEFORE CHECKING THIS!!!)

I have checked that any arbitrary calls to external contracts are validated and or restricted
I have checked that any privileged calls (i.e. storage modifications) are validated and or restricted
I have ensured that any new contracts have had AT A MINIMUM 1 preliminary audit conducted on by <company/auditor>

Adjust Mutation Test Run

- Add test for refundExcessNative modifier to fix surviving mutant on line 139 - Add isBridgeAvailable function with intentionally incomplete test coverage - This will test both mutation testing detection and resolution

- Add test_swapAndStartBridgeTokensViaOptimismBridge_RefundsExcessETH() - Tests that excess ETH is refunded when using swapAndStartBridgeTokensViaOptimismBridge - Will catch if refundExcessNative modifier is removed (mutation on line 139) - Sends 1 ETH when only 0.1 ETH needed, verifies 0.9 ETH refund

- Simplify the test logic to directly check total ETH spent vs sent - With refundExcessNative: user loses ~0.1 ETH + gas - Without refundExcessNative: user loses full 1 ETH + gas - More reliable detection of missing refund modifier

- Add synchronize, opened, reopened triggers for immediate PR events - Add workflow_run trigger to run after mutation testing completes - This ensures PR summary runs both on PR changes and after mutation testing finishes

- Replace gh-find-current-pr with custom PR detection logic - Handle both pull_request and workflow_run trigger contexts - Add proper error handling for GitHub API responses - Add debugging output for API responses - Use proper jq error handling with '// empty' fallback

- Replace GIT_ACTIONS_BOT_PAT_CLASSIC with built-in GITHUB_TOKEN - Add security-events: read permission for code scanning API access - This should resolve the 'Bad credentials' errors in the workflow

- Add logging for both PR-specific and all alerts queries - Show what tools are available in the alerts - Fall back to all alerts if PR filter returns no results - This will help identify why mutation testing results aren't being found

Test mutation testing: fix existing mutant and create new one

coderabbitai · 2025-08-05T10:57:23Z

Walkthrough

This update introduces two new GitHub Actions workflows for mutation testing and its reporting, adds two external functions to the OptimismBridgeFacet contract for bridge availability checks, and implements a new test in the corresponding test suite to verify refund logic when excess ETH is sent during swaps.

Changes

Cohort / File(s)	Change Summary
GitHub Actions: Mutation Testing Workflows `.github/workflows/mutationTestingAlertsReview.yml`, `.github/workflows/olympixMutationTesting.yml`	Added two new workflow files: one to automate running mutation testing on Solidity contracts in batches and upload results to GitHub Code Scanning, and another to generate and post a mutation testing summary comment on pull requests based on code scanning alerts. The workflows include logic for batching, sequential processing, robust error handling, and integration with GitHub APIs for reporting and commenting.
OptimismBridgeFacet Contract `src/Facets/OptimismBridgeFacet.sol`	Introduced two new external functions named `isBridgeAvailable` with different signatures and logic. Both functions check bridge availability for a given token address, handling the zero address case with distinct semantics and mutability (pure and view). No other contract logic was modified.
OptimismBridgeFacet Test `test/solidity/Facets/OptimismBridgeFacet.t.sol`	Added a new test function to verify that excess ETH sent during a swap and bridge operation is properly refunded to the user. The test sets up the required data, performs the operation, and asserts that only the necessary amount is spent, confirming the presence and effect of the `refundExcessNative` modifier.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15–20 minutes

Suggested labels

AuditNotRequired

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)

JIRA integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

.github/workflows/olympixMutationTesting.yml (1)
1-111: Fix YAML formatting issues.

The workflow logic is well-structured with proper batching, error handling, and GitHub Code Scanning integration. However, there are several formatting issues that should be addressed:
-          echo "Processing ALL contracts in src/ to maintain consistent mutation testing state"
-          files=$(find src/ -name "*.sol" -type f)
-          
+          echo "Processing ALL contracts in src/ to maintain consistent mutation testing state"
+          files=$(find src/ -name "*.sol" -type f)
+
Apply similar fixes to remove trailing spaces on lines 42, 51, 56, 62, 69, 84 and add a newline at the end of the file.
.github/workflows/mutationTestingAlertsReview.yml (1)
1-347: Fix extensive YAML formatting issues.

The workflow provides comprehensive mutation testing result summarization with proper error handling, API integration, and PR comment management. However, there are numerous trailing spaces throughout the file that should be cleaned up.
# Apply these fixes throughout the file:
# Remove trailing spaces on lines: 44, 48, 53, 56, 60, 63, 69, 84, 88, 92, 96, 113, 118, 124, 128, 133, 147, 150, 155, 158, 163, 166, 171, 173, 187, 200, 204, 207, 211, 213, 237, 243, 261, 263, 288, 299, 301, 306, 313, 314, 331, 347
# Add newline at end of file
+
Consider using a YAML formatter or linter in your IDE to automatically handle these formatting issues.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 08dd996 and d0138ab.

📒 Files selected for processing (4)

.github/workflows/mutationTestingAlertsReview.yml (1 hunks)
.github/workflows/olympixMutationTesting.yml (1 hunks)
src/Facets/OptimismBridgeFacet.sol (2 hunks)
test/solidity/Facets/OptimismBridgeFacet.t.sol (1 hunks)

🧰 Additional context used

📓 Path-based instructions (5)

{src/**/*.sol,test/solidity/**/*.sol,script/**/*.sol}