Short-circuit StageData creation in trace generation

msbit01 commented 2 months ago

Requirements for Contributing to this repository

Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
The pull request must only fix one issue at the time.
The pull request must update the test suite to demonstrate the changed functionality.
After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see CONTRIBUTING.

What does this PR do?

This is a fix for https://github.com/jenkinsci/datadog-plugin/issues/429. This change will cause trace generation to short circuit before creating an unbounded number of StageData objects.

Description of the Change

Prevent creation of an unbounded number of StageData objects by limiting the number of objects created to be at most the number of characters allowed in the json object created from said objects. This is a conservative approach that could be refined but is simple and good enough in that it avoids unbounded object creation.

Alternate Designs

I considered computing the json and keeping track of the running length of the json object that would be created and checking to see if its length would exceed the limit. That would be a more precise approach than simply counting the number of stages but as my goal was just to bound the number of stages and not necessarily have the bound be perfect, I preferred this approach for its simplicity.

Possible Drawbacks

Verification Process

I confirmed that a test version of the plugin didn't result in the generation of millions of StageData objects as I had seen in previous tests.

Additional Notes

Release Notes

Review checklist (to be filled by reviewers)

[ ] Feature or bug fix MUST have appropriate tests (unit, integration, etc...)
[ ] PR title must be written as a CHANGELOG entry (see why)
[ ] Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
[ ] PR must have one changelog/ label attached. If applicable it should have the backward-incompatible label attached.
[ ] PR should not have do-not-merge/ label attached.
[ ] If Applicable, issue must have kind/ and severity/ labels attached at least.

tsmsbit commented 2 months ago

@nikita-tkachenko-datadog thanks for the rapid feedback! When do you think it would get released?

nikita-tkachenko-datadog commented 2 months ago

@nikita-tkachenko-datadog thanks for the rapid feedback! When do you think it would get released?

I will try to do a release tomorrow

jenkinsci / datadog-plugin