Skip to content
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

Fix: Add input validation for safe logarithm calculations in AugenPriceSpike #8439

Conversation

JosueNina
Copy link
Contributor

Description

Added validation to ensure that previousPoint and previousPoint2 are non-zero before performing the logarithm operation to prevent division by zero and avoid log(0) errors. Additionally, included a unit test to verify the correctness of the validation logic.

Related Issue

Closes #8435

Motivation and Context

This change is necessary to ensure that logarithm calculations are safe, preventing runtime errors from division by zero and undefined log(0) operations. This improves the stability and reliability of the application by ensuring that invalid input values are properly handled.

Requires Documentation Change

No, this change does not require updates to documentation as it only involves input validation and adding a unit test.

How Has This Been Tested?

Tested the validation logic with unit tests, verifying that the inputs to the logarithm calculation are correctly checked for non-zero values. The unit test confirmed that division by zero and log(0) cases are handled properly, preventing runtime errors.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Refactor (non-breaking change which improves implementation)
  • Performance (non-breaking change which improves performance. Please add associated performance test and results)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Non-functional change (xml comments/documentation/etc)

Checklist:

  • My code follows the code style of this project.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • My branch follows the naming convention bug-<issue#>-<description> or feature-<issue#>-<description>

- Ensure both previousPoint and previousPoint2 are non-zero.
- Prevent division by zero and undefined errors.
- Add unit test to verity the new validation logic.
@JosueNina JosueNina force-pushed the bug-8435-augen-price-spike-runtime-error branch from 094fc3a to e5ea56d Compare December 3, 2024 19:34
Copy link
Member

@Martin-Molinero Martin-Molinero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@Martin-Molinero Martin-Molinero merged commit 8123e76 into QuantConnect:master Dec 3, 2024
5 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

AugenPriceSpike
2 participants