Skip to content

Add validation to include/exlude jobs regular expressions#450

Merged
nikita-tkachenko-datadog merged 3 commits into
masterfrom
nikita-tkachenko/validate-include-exlude-regex
Jan 13, 2025
Merged

Add validation to include/exlude jobs regular expressions#450
nikita-tkachenko-datadog merged 3 commits into
masterfrom
nikita-tkachenko/validate-include-exlude-regex

Conversation

@nikita-tkachenko-datadog

@nikita-tkachenko-datadog nikita-tkachenko-datadog commented Sep 17, 2024

Copy link
Copy Markdown
Collaborator

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?

Adds validation to regular expressions for including/excluding jobs from tracing: regexes that cannot be compiled will not be saved.

Also updates the configuration to store compiled regexes, rather than strings (otherwise splitting the string and compiling the expressions is done on every job listener invocation, which is computationally expensive).

Description of the Change

Alternate Designs

Possible Drawbacks

Verification Process

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.

@nikita-tkachenko-datadog nikita-tkachenko-datadog added the changelog/Fixed Fixed features results into a bug fix version bump label Sep 17, 2024
}

@RequirePOST
public FormValidation doCheckIncluded(@QueryParameter("included") final String included) {

Check warning

Code scanning / Jenkins Security Scan

Stapler: Missing permission check

Potential missing permission check in DatadogGlobalConfiguration#doCheckIncluded
}

@RequirePOST
public FormValidation doCheckExcluded(@QueryParameter("excluded") final String excluded) {

Check warning

Code scanning / Jenkins Security Scan

Stapler: Missing permission check

Potential missing permission check in DatadogGlobalConfiguration#doCheckExcluded
@nikita-tkachenko-datadog
nikita-tkachenko-datadog force-pushed the nikita-tkachenko/configuration-refactoring-updated branch from 9efa308 to 94211bd Compare September 18, 2024 15:20
@nikita-tkachenko-datadog
nikita-tkachenko-datadog force-pushed the nikita-tkachenko/validate-include-exlude-regex branch 4 times, most recently from 3db94aa to 98e20c1 Compare September 19, 2024 15:23
@nikita-tkachenko-datadog
nikita-tkachenko-datadog force-pushed the nikita-tkachenko/configuration-refactoring-updated branch from 5f3a210 to d20b98e Compare October 11, 2024 11:01
@nikita-tkachenko-datadog
nikita-tkachenko-datadog force-pushed the nikita-tkachenko/configuration-refactoring-updated branch from d20b98e to b8e26e6 Compare November 20, 2024 10:03
@nikita-tkachenko-datadog
nikita-tkachenko-datadog force-pushed the nikita-tkachenko/configuration-refactoring-updated branch 2 times, most recently from 0404aa5 to 0260867 Compare December 5, 2024 15:55
Base automatically changed from nikita-tkachenko/configuration-refactoring-updated to master December 11, 2024 09:53
@nikita-tkachenko-datadog
nikita-tkachenko-datadog force-pushed the nikita-tkachenko/validate-include-exlude-regex branch from f362037 to f5fcdc1 Compare December 18, 2024 16:24
@nikita-tkachenko-datadog
nikita-tkachenko-datadog marked this pull request as ready for review January 7, 2025 11:13
@nikita-tkachenko-datadog nikita-tkachenko-datadog added changelog/Added Added features results into a minor version bump and removed changelog/Fixed Fixed features results into a bug fix version bump labels Jan 9, 2025

@drodriguezhdez drodriguezhdez left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Dropped some comments

String excludedEnvVar = System.getenv(EXCLUDED_PROPERTY);
if(StringUtils.isBlank(excludedEnvVar)){
if (StringUtils.isNotBlank(excludedEnvVar)) {
this.excluded = DatadogUtilities.cstrToList(excludedEnvVar, Pattern::compile);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

If a user has already a stored value that does not compile, this will throw an exception and won't be able to load the configuration, right?

Is it possible to have a unit test to check how this behaves?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

This is a good point, added a unit test to ensure the config can still be loaded in this case

this.excluded = DatadogUtilities.cstrToList(jobs, Pattern::compile);
}

public boolean isJobIncluded(@Nonnull final String jobName) {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Don't we need a isJobExcluded somewhere?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Yep, it's there on line 566

@nikita-tkachenko-datadog
nikita-tkachenko-datadog merged commit 99a6f88 into master Jan 13, 2025
@nikita-tkachenko-datadog
nikita-tkachenko-datadog deleted the nikita-tkachenko/validate-include-exlude-regex branch January 13, 2025 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog/Added Added features results into a minor version bump

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants