Skip to content
Snippets Groups Projects

Integrate listing of existing custom headers into custom headers form for streaming audit events

All threads resolved!

What does this MR do and why?

This MR adds a read-only form on existing destinations to show the custom headers applied. This will be changed from read-only in the update mutation integration.

Overall it adds:

  • Custom headers to GraphQL query for destinations retrieval
  • Edit button to streaming items
  • Editing mode to streaming items to toggle the editor
  • Ability to set the editor to read-only when the item is passed in
  • 'Save' button rather than 'Add' button on editing
  • Section to the docs on the listing UI

Screenshots or screen recordings

Screen_Recording_2022-07-06_at_14.45.24

How to set up and validate locally

  1. Enable the feature flag :custom_headers_streaming_audit_events_ui: echo "Feature.enable(:custom_headers_streaming_audit_events_ui)" | rails c.
  2. Visit a group's audit events page e.g. http://gdk.test:3000/groups/gitlab-org/-/audit_events and look at the Streams tab.
  3. Add a new destination without header values.
  4. While adding, check the save button text is 'Add'.
  5. Select the edit button on the destination item and check the fields are read-only and no header values exist.
  6. Check the save button text is 'Save'.
  7. Add a new destination with header values.
  8. Select the edit button on the destination item and check the fields are read-only and the header values exist.

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 #361632 (closed)

Edited by Robert Hunt

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
  • Robert Hunt changed milestone to %15.2

    changed milestone to %15.2

  • assigned to @rob.hunt

  • Robert Hunt mentioned in merge request !91691 (merged)

    mentioned in merge request !91691 (merged)

  • 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
    @mayra-cabrera, @eread, @dbalexandre, @marin, @dzaporozhets

    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
  • A deleted user added documentation label

    added documentation label

  • 1 Warning
    :warning: This merge request changed files with disabled eslint rules. Please consider fixing them.
    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.

    Documentation review

    The following files require a review from a technical writer:

    • doc/administration/audit_event_streaming.md

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

    Disabled eslint rules

    The following files have disabled eslint rules. Please consider fixing them:

    • ee/app/assets/javascripts/audit_events/constants.js

    Run the following command for more details

    node_modules/.bin/eslint --report-unused-disable-directives --no-inline-config \
      'ee/app/assets/javascripts/audit_events/constants.js'

    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
    frontend Payton Burdette (@pburdette) (UTC-4, 5 hours behind @rob.hunt) Phil Hughes (@iamphill) (UTC+1, same timezone as @rob.hunt)
    UX Annabel Dunstone Gray (@annabeldunstone) (UTC-6, 7 hours behind @rob.hunt) Jeremy Elder (@jeldergl) (UTC-5, 6 hours behind @rob.hunt)

    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.

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

    Generated by :no_entry_sign: Danger

  • Bundle size analysis [beta]

    This compares changes in bundle size for entry points between the commits 37530085 and 2217e3b2

    :sparkles: Special assets

    Entrypoint / Name Size before Size after Diff Diff in percent
    average 3.44 MB 3.44 MB - 0.0 %
    mainChunk 1.88 MB 1.88 MB - 0.0 %

    Note: We do not have exact data for 37530085. So we have used data from: 5415e709.
    The target commit was too new, so we used the latest commit from master we have info on.
    It might help to rerun the bundle-size-review job
    This might mean that you have a few false positives in this report. If something unrelated to your code changes is reported, you can check this comparison in order to see if they caused this change.

    Please look at the full report for more details


    Read more about how this report works.

    Generated by :no_entry_sign: Danger

  • Robert Hunt added 1 commit

    added 1 commit

    • 5921f7da - Adds the ability to show a read-only form on an existing destination

    Compare with previous version

  • Robert Hunt changed target branch from master to 361631-integrate-custom-headers-creation-graphql-into-custom-headers-form-for-streaming-audit-events

    changed target branch from master to 361631-integrate-custom-headers-creation-graphql-into-custom-headers-form-for-streaming-audit-events

  • Allure report

    allure-report-publisher generated test report!

    review-qa-blocking: :exclamation: test report for 2217e3b2

    expand test summary
    +-----------------------------------------------------------------------------------------+
    |                                     suites summary                                      |
    +------------------------------------+--------+--------+---------+-------+-------+--------+
    |                                    | passed | failed | skipped | flaky | total | result |
    +------------------------------------+--------+--------+---------+-------+-------+--------+
    | Manage                             | 38     | 0      | 2       | 37    | 40    | ❗     |
    | Create                             | 23     | 0      | 2       | 23    | 25    | ❗     |
    | Plan                               | 47     | 0      | 1       | 41    | 48    | ❗     |
    | Version sanity check               | 0      | 0      | 1       | 0     | 1     | ➖     |
    | Verify                             | 12     | 0      | 1       | 12    | 13    | ❗     |
    | Configure                          | 0      | 0      | 1       | 0     | 1     | ➖     |
    | Protect                            | 2      | 0      | 0       | 2     | 2     | ❗     |
    | Secure                             | 2      | 0      | 0       | 2     | 2     | ❗     |
    | Feature flag handler sanity checks | 9      | 0      | 0       | 9     | 9     | ❗     |
    | Package                            | 0      | 0      | 1       | 0     | 1     | ➖     |
    +------------------------------------+--------+--------+---------+-------+-------+--------+
    | Total                              | 133    | 0      | 9       | 126   | 142   | ❗     |
    +------------------------------------+--------+--------+---------+-------+-------+--------+

    package-and-qa-ff-enabled: :x: test report for 88ffdca9

    expand test summary
    +---------------------------------------------------------------------------+
    |                              suites summary                               |
    +----------------------+--------+--------+---------+-------+-------+--------+
    |                      | passed | failed | skipped | flaky | total | result |
    +----------------------+--------+--------+---------+-------+-------+--------+
    | Manage               | 310    | 0      | 9       | 10    | 319   | ❗     |
    | Verify               | 112    | 0      | 9       | 0     | 121   | ✅     |
    | Release              | 14     | 0      | 0       | 0     | 14    | ✅     |
    | Secure               | 61     | 0      | 6       | 2     | 67    | ❗     |
    | Fulfillment          | 6      | 0      | 33      | 0     | 39    | ✅     |
    | Configure            | 0      | 0      | 9       | 0     | 9     | ➖     |
    | Plan                 | 157    | 0      | 0       | 0     | 157   | ✅     |
    | Create               | 418    | 1      | 18      | 3     | 437   | ❌     |
    | Package              | 0      | 0      | 9       | 0     | 9     | ➖     |
    | Version sanity check | 0      | 0      | 3       | 0     | 3     | ➖     |
    | Protect              | 6      | 0      | 0       | 0     | 6     | ✅     |
    | Product Intelligence | 4      | 0      | 0       | 0     | 4     | ✅     |
    +----------------------+--------+--------+---------+-------+-------+--------+
    | Total                | 1088   | 1      | 96      | 15    | 1185  | ❌     |
    +----------------------+--------+--------+---------+-------+-------+--------+

    package-and-qa-ff-disabled: :exclamation: test report for 88ffdca9

    expand test summary
    +---------------------------------------------------------------------------+
    |                              suites summary                               |
    +----------------------+--------+--------+---------+-------+-------+--------+
    |                      | passed | failed | skipped | flaky | total | result |
    +----------------------+--------+--------+---------+-------+-------+--------+
    | Create               | 450    | 0      | 18      | 2     | 468   | ❗     |
    | Manage               | 321    | 0      | 9       | 10    | 330   | ❗     |
    | Verify               | 120    | 0      | 9       | 0     | 129   | ✅     |
    | Fulfillment          | 6      | 0      | 33      | 0     | 39    | ✅     |
    | Secure               | 63     | 0      | 6       | 3     | 69    | ❗     |
    | Plan                 | 162    | 0      | 0       | 0     | 162   | ✅     |
    | Release              | 18     | 0      | 0       | 0     | 18    | ✅     |
    | Product Intelligence | 6      | 0      | 0       | 0     | 6     | ✅     |
    | Configure            | 0      | 0      | 9       | 0     | 9     | ➖     |
    | Package              | 0      | 0      | 9       | 0     | 9     | ➖     |
    | Version sanity check | 0      | 0      | 3       | 0     | 3     | ➖     |
    | Protect              | 6      | 0      | 0       | 0     | 6     | ✅     |
    +----------------------+--------+--------+---------+-------+-------+--------+
    | Total                | 1152   | 0      | 96      | 15    | 1248  | ❗     |
    +----------------------+--------+--------+---------+-------+-------+--------+
  • Robert Hunt added 133 commits

    added 133 commits

    • 5921f7da...8accadf9 - 73 commits from branch 361631-integrate-custom-headers-creation-graphql-into-custom-headers-form-for-streaming-audit-events
    • 2aeb89dd - Migrate i_code_review_user_approve_mr to snowplow
    • 2434bc09 - Update MR link
    • aac69b0b - GraphQL: lists the groups to where a project can be transferred to
    • 016b5757 - Use guard clause
    • 7c1ddc41 - Refactor codeQuality inline findings
    • 359906aa - Refactor parseCodeQuality functionality
    • 8f7858fd - Remove logs js files
    • a2e26070 - Add page size selector to issues list having options for 20, 50 and 100
    • 33ec54d2 - Remove logs files causing error in spec
    • 0d0adf9c - Improve performance of finding related branches
    • 4341a5c6 - Fix specs for deleted code
    • 13afbb2b - Update translations in pot file
    • c845fb68 - Migrate `form_errors` in `groups_projects/new` form to Pajamas alert
    • 14a70c89 - Update frontend tests to vue-test-utils
    • 0d910e89 - Send root_namespace_id to the Projects::ProjectDeletedEvent
    • c5f8acda - Better test description
    • e4f8c1a2 - Use const for event name, switch to bracket notation in specs
    • 65c4dd71 - Migrated tabs in Web IDE to GlTabs
    • c750a4f4 - Removed custom overriding of the border color from tabs
    • 4f23bbdb - Hid the generated tabs content element
    • 64484912 - Exclude partial indexes when determining if a foreign key is indexed
    • 3bd30808 - Add git_rate_limit_users_allowlist column to application_settings
    • 7c76c47b - Fix broken link to knapsack_report.rb
    • 06a93870 - Feature search bar scope tokens
    • ee156b13 - Clarify MR message when missing required approvals
    • 73eb92f7 - Merge branch 'pms-approvals-missing-message' into 'master'
    • 8fa0e5ca - Merge branch 'anti-abuse/17-create-allowlist-db-and-api' into 'master'
    • 5997b38c - Add curly brackets to fix the matcher in ruby 3
    • 0423d88b - Add curly brackets to fix the matcher in ruby 3
    • e6a02aa9 - Fix job failure
    • 6a6337cf - Merge branch 'kassio/invalidate-pages-internal-api-cache-on-project-delete' into 'master'
    • bbfda1a4 - Merge branch...
    • 3a15c7c6 - Merge branch 'fix-ExcessiveProjectsDownloadBanService-ruby3-spec' into 'master'
    • 492622a5 - Merge branch 'cngo-update-frontend-specs' into 'master'
    • 2e3a6563 - Remove design resolved discussions popover
    • ca643b08 - Merge branch '241555-design-sidebar-link-button-accordion-migration' into 'master'
    • a95c4677 - Merge branch 'tbulva-expanded-searchbar-scopes' into 'master'
    • 45cf6db2 - Terminology update from node to site in Geo background verification docs
    • 0f3d88f6 - Merge branch 'sranasinghe-master-patch-75505' into 'master'
    • d32c00b1 - Merge branch 'fix-open_api_strategy_spec-ruby3' into 'master'
    • 2f78399a - Merge branch '364424-add-page-size-selector-to-issues' into 'master'
    • c6a697d7 - Update changelog for 15.1.2
    • 6b26034e - Merge branch 'improve-related-branches-performance' into 'master'
    • 26d4315d - Merge branch 'jay_mccure-master-patch-64005' into 'master'
    • b674a076 - Merge branch 'michold-approve_mr_snowplow' into 'master'
    • aaa37ce5 - Merge branch '360188-delete-pod-logs-ui-code-3' into 'master'
    • 24b06139 - Fix BulkImport pipeline retries
    • be48040c - Merge branch 'rodrigo/365131-fix-bulk-import-retry' into 'master'
    • 09878690 - Merge branch '344425-gl-tabs' into 'master'
    • a3e669cf - Merge branch 'jnnkl-codequality-findings-diff-inline' into 'master'
    • f81402ba - Update submit license usage data documentation
    • 71c96c8c - Merge branch '4405_update_documentation_about_submitting_license_usage_data' into 'master'
    • 453a159a - Stream audit event on merge request create
    • 0a4bd434 - Merge branch 'Add-streaming-audit-event-on-mr-create' into 'master'
    • a87ef2de - Merge branch...
    • 84adf80e - Merge branch 'exclude-partial-indexes-from-schema-spec' into 'master'
    • bc091220 - Add new custom headers when a new destination is created
    • 81a57479 - Adds the ability to show a read-only form on an existing destination
    • ac28ccd0 - DONE:
    • 88ffdca9 - DONE:

    Compare with previous version

  • Robert Hunt added 6 commits

    added 6 commits

    • 88ffdca9...92b76227 - 3 commits from branch 361631-integrate-custom-headers-creation-graphql-into-custom-headers-form-for-streaming-audit-events
    • fdc29835 - Adds the ability to show a read-only form on an existing destination
    • f7d23874 - DONE:
    • 0c9d4325 - DONE:

    Compare with previous version

  • removed backend label

  • A deleted user added databasereview pending label
  • removed database label

  • Robert Hunt added 1 commit

    added 1 commit

    • 9590f046 - Adds the ability to show a read-only form on an existing destination

    Compare with previous version

  • Robert Hunt added 169 commits

    added 169 commits

    • 9590f046...3bc7e41d - 168 commits from branch 361631-integrate-custom-headers-creation-graphql-into-custom-headers-form-for-streaming-audit-events
    • c65ecd8f - Adds the ability to show a read-only form on an existing destination

    Compare with previous version

  • Robert Hunt marked this merge request as ready

    marked this merge request as ready

  • Robert Hunt marked the checklist item I have evaluated the MR acceptance checklist for this MR. as completed

    marked the checklist item I have evaluated the MR acceptance checklist for this MR. as completed

  • Robert Hunt added 50 commits

    added 50 commits

    • c65ecd8f...34605997 - 49 commits from branch 361631-integrate-custom-headers-creation-graphql-into-custom-headers-form-for-streaming-audit-events
    • dfc8f8e3 - Adds the ability to show a read-only form on an existing destination

    Compare with previous version

  • Robert Hunt
  • Robert Hunt requested review from @eread

    requested review from @eread

  • Evan Read
  • Evan Read
  • Evan Read removed review request for @eread

    removed review request for @eread

  • Robert Hunt added 170 commits

    added 170 commits

    • dfc8f8e3...67ad7c93 - 169 commits from branch 361631-integrate-custom-headers-creation-graphql-into-custom-headers-form-for-streaming-audit-events
    • 2d1ac713 - Adds the ability to show a read-only form on an existing destination

    Compare with previous version

  • Robert Hunt requested review from @eread

    requested review from @eread

  • Robert Hunt added 17 commits

    added 17 commits

    • 2d1ac713...76d04043 - 16 commits from branch 361631-integrate-custom-headers-creation-graphql-into-custom-headers-form-for-streaming-audit-events
    • 09c86e81 - Adds the ability to show a read-only form on an existing destination

    Compare with previous version

  • Robert Hunt added 1 commit

    added 1 commit

    • aa4357d7 - Adds the ability to show a read-only form on an existing destination

    Compare with previous version

  • Robert Hunt
  • Robert Hunt added 1 commit

    added 1 commit

    • c397f61d - Adds the ability to show a read-only form on an existing destination

    Compare with previous version

  • 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

  • Robert Hunt added 197 commits

    added 197 commits

    • c397f61d...6e5fc521 - 196 commits from branch 361631-integrate-custom-headers-creation-graphql-into-custom-headers-form-for-streaming-audit-events
    • 8a9c70c9 - Adds the ability to show a read-only form on an existing destination

    Compare with previous version

  • Robert Hunt added 194 commits

    added 194 commits

    • 8a9c70c9...bdc8d5ab - 193 commits from branch 361631-integrate-custom-headers-creation-graphql-into-custom-headers-form-for-streaming-audit-events
    • d5250334 - Adds the ability to show a read-only form on an existing destination

    Compare with previous version

  • Robert Hunt added 185 commits

    added 185 commits

    • d5250334...46d59677 - 184 commits from branch 361631-integrate-custom-headers-creation-graphql-into-custom-headers-form-for-streaming-audit-events
    • 30482f32 - Adds the ability to show a read-only form on an existing destination

    Compare with previous version

  • Robert Hunt deleted the 361631-integrate-custom-headers-creation-graphql-into-custom-headers-form-for-streaming-audit-events branch. This merge request now targets the master branch

    deleted the 361631-integrate-custom-headers-creation-graphql-into-custom-headers-form-for-streaming-audit-events branch. This merge request now targets the master branch

  • Robert Hunt added 244 commits

    added 244 commits

    Compare with previous version

  • added UX label

  • Please wait for Reviewer Roulette to suggest a designer for UX review, and then assign them as Reviewer. This helps evenly distribute reviews across UX.

  • requested review from @annabeldunstone

  • Robert Hunt requested review from @hmehra

    requested review from @hmehra

  • Robert Hunt added 45 commits

    added 45 commits

    Compare with previous version

  • Robert Hunt added 1 commit

    added 1 commit

    • e4fd40e0 - Adds the ability to show a read-only form on an existing destination

    Compare with previous version

  • removed review request for @annabeldunstone

  • mentioned in issue #367963 (closed)

  • requested review from @annabeldunstone

  • Robert Hunt added 405 commits

    added 405 commits

    Compare with previous version

  • Robert Hunt added 29 commits

    added 29 commits

    Compare with previous version

  • Annabel Dunstone Gray approved this merge request

    approved this merge request

  • removed review request for @annabeldunstone

  • Hinam Mehra
  • Hinam Mehra
  • Hinam Mehra
  • Hinam Mehra approved this merge request

    approved this merge request

  • Hinam Mehra removed review request for @hmehra

    removed review request for @hmehra

  • Robert Hunt changed milestone to %15.3

    changed milestone to %15.3

  • Robert Hunt added 137 commits

    added 137 commits

    Compare with previous version

  • mentioned in issue #368221 (closed)

  • Robert Hunt added 7 commits

    added 7 commits

    Compare with previous version

  • Robert Hunt requested review from @iamphill

    requested review from @iamphill

  • Phil Hughes approved this merge request

    approved this merge request

  • Phil Hughes resolved all threads

    resolved all threads

  • Phil Hughes enabled an automatic merge when the pipeline for e7056016 succeeds

    enabled an automatic merge when the pipeline for e7056016 succeeds

  • merged

  • Phil Hughes mentioned in commit a55a8bd1

    mentioned in commit a55a8bd1

  • Robert Hunt mentioned in merge request !91986 (merged)

    mentioned in merge request !91986 (merged)

  • added workflowstaging label and removed workflowcanary label

  • Please register or sign in to reply
    Loading