Skip to content
Snippets Groups Projects

Add auditEventsStreamingHeadersDestroy Mutation

Merged Max Woolf requested to merge 361217-delete-streaming-header into master
All threads resolved!

What does this MR do and why?

  • Adds a new graphQL mutation auditEventsStreamingHeadersDestroy to destroy a custom header on a streaming destination.

Screenshots or screen recordings

These are strongly recommended to assist reviewers and reduce the time to merge your change.

How to set up and validate locally

  • Enable the streaming_audit_event_headers feature flag.
  • Create an Ultimate group.
  • Create a streaming destination. (Group -> Security & Compliance -> Audit Events -> Streams)
  • Using GraphQL, create a header.
mutation {
  auditEventsStreamingHeadersCreate(input: { destinationId: "gid://gitlab/AuditEvents::ExternalAuditEventDestination/ID GOES HERE", key: "X-Foo", value: "bar" }) {
    errors
    clientMutationId
    header {
      id
      value
      key
    }
  }
}
  • Using the returned ID value, delete the same header.
mutation {
  auditEventsStreamingHeadersDestroy(input: { headerId: "gid://gitlab/AuditEvents::Streaming::Header/7" }) {
    errors
    clientMutationId
  }
}
  • Ensure that the header has been deleted from the database.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #361217 (closed)

Edited by Max Woolf

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Max Woolf changed milestone to %15.1

    changed milestone to %15.1

  • assigned to @mwoolf

  • Suggested Reviewers (beta)

    The individuals below may be good candidates to participate in the review based on various factors.

    You can use slash commands in comments to quickly assign /assign_reviewer @user1.

    Suggested Reviewers
    @alexkalderimis, @eread, @kerrizor, @rspeicher, @dbalexandre

    If you do not believe these suggestions are useful, please apply the label Bad Suggested Reviewer. You can also provide feedback for this feature on this issue: https://gitlab.com/gitlab-org/gitlab/-/issues/357923.

    Automatically generated by Suggested Reviewers Bot - an experimental ML-based recommendation engine created by ~"group::applied ml".

    Edited by GitLab Reviewer-Recommender Bot
  • 1 Warning
    :warning: 6e25b72b: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines.
    2 Messages
    :book: CHANGELOG missing:

    If you want to create a changelog entry for GitLab FOSS, add the Changelog trailer to the commit message you want to add to the changelog.

    If you want to create a changelog entry for GitLab EE, also add the EE: true trailer to your commit message.

    If this merge request doesn't need a CHANGELOG entry, feel free to ignore this message.

    :book: This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge.

    If needed, you can retry the :repeat: danger-review job that generated this comment.

    Documentation review

    The following files require a review from a technical writer:

    • doc/administration/audit_event_streaming.md
    • doc/api/graphql/reference/index.md

    The review does not need to block merging this merge request. See the:

    Reviewer roulette

    Changes that require review have been detected!

    Please refer to the table below for assigning reviewers and maintainers suggested by Danger in the specified category:

    Category Reviewer Maintainer
    backend Niko Belokolodov (@nbelokolodov) (UTC+8, 7 hours ahead of @mwoolf) Luke Duncalfe (@.luke) (UTC+12, 11 hours ahead of @mwoolf)

    To spread load more evenly across eligible reviewers, Danger has picked a candidate for each review slot, based on their timezone. Feel free to override these selections if you think someone else would be better-suited or use the GitLab Review Workload Dashboard to find other available reviewers.

    To read more on how to use the reviewer roulette, please take a look at the Engineering workflow and code review guidelines. Please consider assigning a reviewer or maintainer who is a domain expert in the area of the merge request.

    Once you've decided who will review this merge request, assign them as a reviewer! Danger does not automatically notify them for you.

    Generated by :no_entry_sign: Danger

  • Max Woolf changed target branch from 361216-create-streaming-event-headers to master

    changed target branch from 361216-create-streaming-event-headers to master

  • Max Woolf added 3291 commits

    added 3291 commits

    • cfce4f9c...f9da613c - 3283 commits from branch master
    • d28d185e - Create audit stream HTTP header model
    • d348ce8d - Add graphql support for audit streaming headers
    • 305ff5cc - Custom headers for audit streams
    • 84e0e8f8 - Backend reviewer suggestions applied
    • 7960eb35 - Database reviewer suggestions applied
    • ee3c5cf4 - Database maintainer suggestions
    • 147097e1 - Backend maintainer suggestions resolved
    • 35aa60fd - Add auditEventsStreamingHeadersDestroy Mutation

    Compare with previous version

  • Max Woolf changed target branch from master to 361216-create-streaming-event-headers

    changed target branch from master to 361216-create-streaming-event-headers

  • Max Woolf added 1 commit

    added 1 commit

    • 844463a1 - Add auditEventsStreamingHeadersDestroy Mutation

    Compare with previous version

  • Max Woolf marked this merge request as ready

    marked this merge request as ready

  • Allure report

    allure-report-publisher generated test report!

    review-qa-blocking: :exclamation: test report for 35aa60fd

    expand test summary
    +---------------------------------------------------------------------------+
    |                              suites summary                               |
    +----------------------+--------+--------+---------+-------+-------+--------+
    |                      | passed | failed | skipped | flaky | total | result |
    +----------------------+--------+--------+---------+-------+-------+--------+
    | Create               | 23     | 0      | 2       | 22    | 25    | ❗     |
    | Manage               | 36     | 0      | 2       | 37    | 38    | ❗     |
    | Verify               | 12     | 0      | 1       | 12    | 13    | ❗     |
    | Plan                 | 48     | 0      | 1       | 45    | 49    | ❗     |
    | Protect              | 2      | 0      | 0       | 2     | 2     | ❗     |
    | Version sanity check | 0      | 0      | 1       | 0     | 1     | ➖     |
    | Configure            | 0      | 0      | 1       | 0     | 1     | ➖     |
    | Package              | 0      | 0      | 1       | 0     | 1     | ➖     |
    +----------------------+--------+--------+---------+-------+-------+--------+
    | Total                | 121    | 0      | 9       | 118   | 130   | ❗     |
    +----------------------+--------+--------+---------+-------+-------+--------+

    package-and-qa-ff-enabled: :x: test report for 35aa60fd

    expand test summary
    +---------------------------------------------------------------------------+
    |                              suites summary                               |
    +----------------------+--------+--------+---------+-------+-------+--------+
    |                      | passed | failed | skipped | flaky | total | result |
    +----------------------+--------+--------+---------+-------+-------+--------+
    | Package              | 0      | 0      | 9       | 0     | 9     | ➖     |
    | Secure               | 51     | 0      | 5       | 8     | 56    | ❗     |
    | Create               | 422    | 0      | 18      | 23    | 440   | ❗     |
    | Manage               | 289    | 1      | 11      | 0     | 301   | ❌     |
    | Plan                 | 154    | 0      | 3       | 0     | 157   | ✅     |
    | Verify               | 109    | 0      | 7       | 0     | 116   | ✅     |
    | Configure            | 0      | 0      | 9       | 0     | 9     | ➖     |
    | Fulfillment          | 6      | 0      | 30      | 0     | 36    | ✅     |
    | Product Intelligence | 6      | 0      | 0       | 0     | 6     | ✅     |
    | Protect              | 6      | 0      | 0       | 0     | 6     | ✅     |
    | Release              | 16     | 0      | 0       | 0     | 16    | ✅     |
    | Version sanity check | 0      | 0      | 3       | 3     | 3     | ➖     |
    +----------------------+--------+--------+---------+-------+-------+--------+
    | Total                | 1059   | 1      | 95      | 34    | 1155  | ❌     |
    +----------------------+--------+--------+---------+-------+-------+--------+

    package-and-qa-ff-disabled: :x: test report for 35aa60fd

    expand test summary
    +---------------------------------------------------------------------------+
    |                              suites summary                               |
    +----------------------+--------+--------+---------+-------+-------+--------+
    |                      | passed | failed | skipped | flaky | total | result |
    +----------------------+--------+--------+---------+-------+-------+--------+
    | Verify               | 120    | 0      | 9       | 0     | 129   | ✅     |
    | Configure            | 0      | 0      | 9       | 0     | 9     | ➖     |
    | Create               | 447    | 0      | 18      | 27    | 465   | ❗     |
    | Manage               | 302    | 1      | 12      | 0     | 315   | ❌     |
    | Plan                 | 159    | 0      | 3       | 0     | 162   | ✅     |
    | Secure               | 60     | 0      | 6       | 12    | 66    | ❗     |
    | Fulfillment          | 6      | 0      | 33      | 0     | 39    | ✅     |
    | Product Intelligence | 6      | 0      | 0       | 0     | 6     | ✅     |
    | Package              | 0      | 0      | 9       | 0     | 9     | ➖     |
    | Release              | 18     | 0      | 0       | 0     | 18    | ✅     |
    | Version sanity check | 0      | 0      | 3       | 3     | 3     | ➖     |
    | Protect              | 6      | 0      | 0       | 0     | 6     | ✅     |
    +----------------------+--------+--------+---------+-------+-------+--------+
    | Total                | 1124   | 1      | 102     | 42    | 1227  | ❌     |
    +----------------------+--------+--------+---------+-------+-------+--------+
  • Max Woolf changed the description

    changed the description

  • Max Woolf requested review from @eread

    requested review from @eread

  • Max Woolf deleted the 361216-create-streaming-event-headers branch. This merge request now targets the master branch

    deleted the 361216-create-streaming-event-headers branch. This merge request now targets the master branch

  • Max Woolf added 317 commits

    added 317 commits

    Compare with previous version

  • Max Woolf
  • Max Woolf requested review from @huzaifaiftikhar1

    requested review from @huzaifaiftikhar1

  • Evan Read
  • Evan Read approved this merge request

    approved this merge request

  • :wave: @eread, thanks for approving this merge request.

    This is the first time the merge request is approved. To ensure full test coverage, a new pipeline has been started.

    For more info, please refer to the following links:

  • Evan Read removed review request for @eread

    removed review request for @eread

  • Huzaifa Iftikhar removed review request for @huzaifaiftikhar1

    removed review request for @huzaifaiftikhar1

  • removed workflowin dev label

  • Max Woolf added 486 commits

    added 486 commits

    Compare with previous version

  • Max Woolf requested review from @huzaifaiftikhar1

    requested review from @huzaifaiftikhar1

  • Huzaifa Iftikhar removed review request for @huzaifaiftikhar1

    removed review request for @huzaifaiftikhar1

  • Huzaifa Iftikhar
  • Max Woolf added 1 commit

    added 1 commit

    • 2696c53c - Backend reviewer suggestions

    Compare with previous version

  • Max Woolf requested review from @huzaifaiftikhar1

    requested review from @huzaifaiftikhar1

  • Huzaifa Iftikhar approved this merge request

    approved this merge request

  • Huzaifa Iftikhar requested review from @.luke and removed review request for @huzaifaiftikhar1

    requested review from @.luke and removed review request for @huzaifaiftikhar1

  • Luke Duncalfe
  • Luke Duncalfe resolved all threads

    resolved all threads

  • Luke Duncalfe added 1 commit

    added 1 commit

    • 285454e1 - Apply 1 suggestion(s) to 1 file(s)

    Compare with previous version

  • Luke Duncalfe approved this merge request

    approved this merge request

  • Luke Duncalfe enabled an automatic merge when the pipeline for 87fabe51 succeeds

    enabled an automatic merge when the pipeline for 87fabe51 succeeds

  • @mwoolf Looks great :heart_eyes:! I've added a Changelog: added trailer to the squash commit. Thanks @huzaifaiftikhar1 for your review :bow:. Set to merge when the pipeline succeeds :rocket:.

  • merged

  • Luke Duncalfe mentioned in commit c858bde6

    mentioned in commit c858bde6

  • added workflowstaging label and removed workflowcanary label

  • no schema change; no impact on data warehouse

  • Max Woolf mentioned in merge request !90717 (merged)

    mentioned in merge request !90717 (merged)

  • Please register or sign in to reply
    Loading