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

ci(appsec): fix ddwaf circular import #12013

Merged
merged 2 commits into from
Jan 25, 2025
Merged

Conversation

mabdinur
Copy link
Contributor

@mabdinur mabdinur commented Jan 21, 2025

Fix the following CI failures: https://gitlab.ddbuild.io/DataDog/apm-reliability/dd-trace-py/-/jobs/774636553

Reproduction:

from ddtrace.appsec._metrics import _set_waf_init_metric

The fix here is to avoid importing ddwaf from ddtrace.appsec._processor in ddtrace.appsec._metrics. Instead we can import ddwaf directly from ddtrace.appsec._ddwaf.

This issue does not occur if the ddtrace.appsec._processor module is imported before ddtrace.appsec._metrics. This is why we do not see this error in most of our appsec tests. However the order of imports is not guaranteed by the slots check. This explains the flakiness in this job.

Checklist

  • PR author has checked that all the criteria below are met
  • The PR description includes an overview of the change
  • The PR description articulates the motivation for the change
  • The change includes tests OR the PR description describes a testing strategy
  • The PR description notes risks associated with the change, if any
  • Newly-added code is easy to change
  • The change follows the library release note guidelines
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

Reviewer Checklist

  • Reviewer has checked that all the criteria below are met
  • Title is accurate
  • All changes are related to the pull request's stated goal
  • Avoids breaking API changes
  • Testing strategy adequately addresses listed risks
  • Newly-added code is easy to change
  • Release note makes sense to a user of the library
  • If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
  • Backport labels are set in a manner that is consistent with the release branch maintenance policy

Copy link
Contributor

CODEOWNERS have been resolved as:

ddtrace/appsec/_metrics.py                                              @DataDog/asm-python

@datadog-dd-trace-py-rkomorn
Copy link

Datadog Report

Branch report: munir/fix-ddwaf-circular-import
Commit report: 8b1c81e
Test service: dd-trace-py

✅ 0 Failed, 130 Passed, 1468 Skipped, 4m 28.11s Total duration (35m 41.38s time saved)

@pr-commenter
Copy link

pr-commenter bot commented Jan 21, 2025

Benchmarks

Benchmark execution time: 2025-01-21 19:35:29

Comparing candidate commit 8b1c81e in PR branch munir/fix-ddwaf-circular-import with baseline commit f198341 in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 362 metrics, 2 unstable metrics.

@mabdinur mabdinur closed this Jan 21, 2025
@mabdinur mabdinur reopened this Jan 24, 2025
@mabdinur mabdinur marked this pull request as ready for review January 24, 2025 18:50
@mabdinur mabdinur requested a review from a team as a code owner January 24, 2025 18:50
@mabdinur mabdinur enabled auto-merge (squash) January 24, 2025 19:36
@erikayasuda erikayasuda added the changelog/no-changelog A changelog entry is not required for this PR. label Jan 24, 2025
auto-merge was automatically disabled January 24, 2025 20:09

Pull request was closed

@erikayasuda erikayasuda reopened this Jan 24, 2025
@erikayasuda erikayasuda enabled auto-merge (squash) January 24, 2025 20:10
@erikayasuda erikayasuda merged commit 67e1c46 into main Jan 25, 2025
533 of 538 checks passed
@erikayasuda erikayasuda deleted the munir/fix-ddwaf-circular-import branch January 25, 2025 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog A changelog entry is not required for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants