Add custom headers form to streaming audit events

changed milestone to %15.1

added Category:Audit Events GraphQL customer devopsmanage documentation feature flag featureaddition frontend groupcompliance priority3 sectiondev typefeature workflowin dev labels

assigned to @rob.hunt

added 18 commits

1c2635f8...8ca6b6cd - 17 commits from branch master
191cd0c1 - Add feature flag and basic table structure

Compare with previous version

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
`@marin`, `@rspeicher`, `@mayra-cabrera`, `@dbalexandre`, `@tkuah`

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".

	2 Warnings
	This merge request is quite big (726 lines changed), please consider splitting it into multiple merge requests.
	This merge request changed files with disabled eslint rules. Please consider fixing them.

2 Messages

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.

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:

Metadata for the *.md files that you've changed. The first few lines of each *.md file identify the stage and group most closely associated with your docs change.
The Technical Writer assigned for that stage and group.
Documentation workflows for information on when to assign a merge request for review.

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
backend	Niko Belokolodov (`@nbelokolodov`) (UTC+8, 7 hours ahead of `@rob.hunt`)	Bob Van Landuyt (`@reprazent`) (UTC+2, 1 hour ahead of `@rob.hunt`)
frontend	Anna Vovchenko (`@anna_vovchenko`) (UTC+3, 2 hours ahead of `@rob.hunt`)	Natalia Tepluhina (`@ntepluhina`) (UTC+2, 1 hour ahead of `@rob.hunt`)
UX	Philip Joyce (`@philipjoyce`) (UTC+1, same timezone as `@rob.hunt`)	Amelia Bauerly (`@ameliabauerly`) (UTC-7, 8 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 danger-review job that generated this comment.

Generated by Danger

Bundle size analysis [beta]

This compares changes in bundle size for entry points between the commits 1b3dbe97 and d613e0e4

Special assets

Entrypoint / Name	Size before	Size after	Diff	Diff in percent
average	3.54 MB	3.54 MB	+1.09 KB	0.0 %
mainChunk	1.98 MB	1.98 MB	-	0.0 %

Significant Growth: 5

Expand

Entrypoint / Name	Size before	Size after	Diff	Diff in percent
pages.projects.releases.edit	1.56 MB	1.61 MB	+55.24 KB	3.5 %
pages.projects.releases.new	1.56 MB	1.61 MB	+55.24 KB	3.5 %
pages.projects.audit_events	1.39 MB	1.42 MB	+29.37 KB	2.1 %
pages.groups.audit_events	1.22 MB	1.25 MB	+28.96 KB	2.3 %
pages.admin.audit_logs	1.22 MB	1.25 MB	+28.96 KB	2.3 %

Your MR has at least one entrypoint growing significantly (more > 1 KB or 2%). If you write new or extend existing features, this is expected and there is nothing to worry about.

Please consider pinging someone from the FE Foundations (@dmishunov, @justin_ho, @mikegreiling or @nmezzopera) for review, if you are unsure about the size increase.

Note: We do not have exact data for 1b3dbe97. So we have used data from: 2e888a8a.
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

Allure report

allure-report-publisher generated test report!

review-qa-blocking: test report for d613e0e4

expand test summary

+---------------------------------------------------------------------------+
|                              suites summary                               |
+----------------------+--------+--------+---------+-------+-------+--------+
|                      | passed | failed | skipped | flaky | total | result |
+----------------------+--------+--------+---------+-------+-------+--------+
| Verify               | 12     | 0      | 1       | 12    | 13    | ❗     |
| Create               | 23     | 0      | 2       | 23    | 25    | ❗     |
| Plan                 | 48     | 0      | 1       | 48    | 49    | ❗     |
| Manage               | 37     | 0      | 2       | 37    | 39    | ❗     |
| Version sanity check | 0      | 0      | 1       | 0     | 1     | ➖     |
| Configure            | 0      | 0      | 1       | 0     | 1     | ➖     |
| Package              | 0      | 0      | 1       | 0     | 1     | ➖     |
| Protect              | 2      | 0      | 0       | 2     | 2     | ❗     |
| Secure               | 2      | 0      | 0       | 2     | 2     | ❗     |
+----------------------+--------+--------+---------+-------+-------+--------+
| Total                | 124    | 0      | 9       | 124   | 133   | ❗     |
+----------------------+--------+--------+---------+-------+-------+--------+

package-and-qa-ff-enabled: test report for d613e0e4

expand test summary

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

package-and-qa-ff-disabled: test report for d613e0e4

expand test summary

+---------------------------------------------------------------------------+
|                              suites summary                               |
+----------------------+--------+--------+---------+-------+-------+--------+
|                      | passed | failed | skipped | flaky | total | result |
+----------------------+--------+--------+---------+-------+-------+--------+
| Verify               | 120    | 0      | 9       | 0     | 129   | ✅     |
| Create               | 450    | 0      | 18      | 3     | 468   | ❗     |
| Plan                 | 162    | 0      | 0       | 0     | 162   | ✅     |
| Manage               | 321    | 0      | 9       | 11    | 330   | ❗     |
| Fulfillment          | 6      | 0      | 33      | 0     | 39    | ✅     |
| Package              | 0      | 0      | 9       | 0     | 9     | ➖     |
| Product Intelligence | 6      | 0      | 0       | 0     | 6     | ✅     |
| Release              | 18     | 0      | 0       | 0     | 18    | ✅     |
| Secure               | 63     | 0      | 6       | 3     | 69    | ❗     |
| Configure            | 0      | 0      | 9       | 0     | 9     | ➖     |
| Version sanity check | 0      | 0      | 3       | 0     | 3     | ➖     |
| Protect              | 6      | 0      | 0       | 0     | 6     | ✅     |
+----------------------+--------+--------+---------+-------+-------+--------+
| Total                | 1152   | 0      | 96      | 17    | 1248  | ❗     |
+----------------------+--------+--------+---------+-------+-------+--------+

The gitlab-qa-mirror downstream pipeline for !90135 (191cd0c1) failed!
The gitlab-qa-mirror downstream pipeline for !90135 (191cd0c1) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (51807acb) failed!
The gitlab-qa-mirror downstream pipeline for !90135 (51807acb) failed!
The gitlab-qa-mirror downstream pipeline for !90135 (ffbc3d8a) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (ffbc3d8a) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (9f306222) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (9f306222) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (430e3771) failed!
The gitlab-qa-mirror downstream pipeline for !90135 (310b9731) failed!
The gitlab-qa-mirror downstream pipeline for !90135 (310b9731) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (3cf014e8) failed!
The gitlab-qa-mirror downstream pipeline for !90135 (3cf014e8) failed!
The gitlab-qa-mirror downstream pipeline for !90135 (c1112200) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (c1112200) failed!
The gitlab-qa-mirror downstream pipeline for !90135 (0d8c8e21) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (0d8c8e21) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (f545bfd7) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (f545bfd7) failed!
The gitlab-qa-mirror downstream pipeline for !90135 (a3f3e452) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (a3f3e452) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (7d487c1c) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (7d487c1c) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (b0ecb3f8) failed!
The gitlab-qa-mirror downstream pipeline for !90135 (b0ecb3f8) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (c48a64ea) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (c48a64ea) failed!
The gitlab-qa-mirror downstream pipeline for !90135 (9509f801) failed!
The gitlab-qa-mirror downstream pipeline for !90135 (9509f801) failed!
The gitlab-qa-mirror downstream pipeline for !90135 (fe759a02) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (fe759a02) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (170aaf06) failed!
The gitlab-qa-mirror downstream pipeline for !90135 (170aaf06) failed!
The gitlab-qa-mirror downstream pipeline for !90135 (8177f0d9) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (8177f0d9) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (d613e0e4) passed.
The gitlab-qa-mirror downstream pipeline for !90135 (d613e0e4) passed.

added 495 commits

191cd0c1...62c49a02 - 493 commits from branch master
be7c13b5 - Add feature flag and basic table structure
51807acb - Added row functionality to headers list and maximum limit

Compare with previous version

added 206 commits

51807acb...e9e6f43f - 203 commits from branch master
9dad0a26 - Add feature flag and basic table structure
d374e142 - Added row functionality to headers list and maximum limit
be297c03 - Added validation to stop duplicate headers and fixed styling

Compare with previous version

added 1 commit

ffbc3d8a - Refactored to provide and use a unique ID instead of the index

Compare with previous version

added 21 commits

ffbc3d8a...ab6bc824 - 16 commits from branch master
5191fdea - Add feature flag and basic table structure
6b04e368 - Added row functionality to headers list and maximum limit
92dd8b90 - Added validation to stop duplicate headers and fixed styling
33e44389 - Refactored to provide and use a unique ID instead of the index
9f306222 - Fixing reactivity on setting of items data. Still haven't fixed delete

Compare with previous version

added 155 commits

9f306222...a6c786e5 - 150 commits from branch master
b5f9b7ab - Add feature flag and basic table structure
e17eb56e - Added row functionality to headers list and maximum limit
577b71ed - Added validation to stop duplicate headers and fixed styling
f2aca62b - Refactored to provide and use a unique ID instead of the index
430e3771 - Fixing reactivity on setting of items data. Still haven't fixed delete

Compare with previous version

changed milestone to %15.2

added missed:15.1 label

added 99 commits

430e3771...fa45c13b - 92 commits from branch master
d490fae9 - Add feature flag and basic table structure
4515e147 - Added row functionality to headers list and maximum limit
98f12d38 - Added validation to stop duplicate headers and fixed styling
13260510 - Refactored to provide and use a unique ID instead of the index
1a7690a6 - Fixing reactivity on setting of items data. Still haven't fixed delete
896be5d8 - Fixed deletion and reverted back to index rather than id for now
130303de - Added tests and updated snapshots

Compare with previous version

added 1 commit

310b9731 - Removed improvements not related to adding the new form fields

Compare with previous version

added 29 commits

310b9731...5fd1a932 - 20 commits from branch master
c2eb713b - Add feature flag and basic table structure
60dc0331 - Added row functionality to headers list and maximum limit
ff533db4 - Added validation to stop duplicate headers and fixed styling
e8c0ab28 - Refactored to provide and use a unique ID instead of the index
d1ffd1af - Fixing reactivity on setting of items data. Still haven't fixed delete
8f351a88 - Fixed deletion and reverted back to index rather than id for now
855ef2c4 - Added tests and updated snapshots
bb86fc6d - Removed improvements not related to adding the new form fields
3cf014e8 - Streamlining specs to use shallow mounting where we can

Compare with previous version

added 28 commits

3cf014e8...f412ecf6 - 27 commits from branch master
8dc76869 - Add custom headers form to audit events streaming UI using feature flag

Compare with previous version

added 1 commit

c1112200 - Add custom headers form to audit events streaming UI using feature flag

Compare with previous version

marked this merge request as ready

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

changed the description

removed workflowin dev label

added 7 commits

c1112200...43344756 - 6 commits from branch master
0d8c8e21 - Add custom headers form to audit events streaming UI using feature flag

Compare with previous version

changed the description

@eread would you mind taking a look at the documentation changes in this MR? I'm trying to capture the new UI behind the feature flag however it doesn't save or delete the data yet, so it's a bit tricky

This is part of the epic we're looking to make good headway on in %15.2, so there will be further documentation changes in this area over the course of the milestone.

requested review from @eread

@mwoolf as you've been working on the backend aspects of this feature, would you mind doing the initial review of the small number of backend changes in this MR?

requested review from @mwoolf

@jiaan as a frontend groupcompliance expert, I would love to get you to do the initial review of the frontend changes in this MR, especially as this is the base for the next several MRs for this feature. However, I also know that you're super busy right now, so if you can't do a true review, it would be great if you could do a cursory check-over to make sure I'm not doing anything too stupid

requested review from @jiaan

approved this merge request

removed review request for @mwoolf

@mwoolf, 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:

added 108 commits

0d8c8e21...007223d2 - 107 commits from branch master
f545bfd7 - Add custom headers form to audit events streaming UI using feature flag

Compare with previous version

requested review from @toupeira

@seggenberger as a groupcompliance expert, would you mind reviewing this change from a UX perspective?

requested review from @seggenberger

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.

mentioned in issue #362504 (closed)

approved this merge request

Suggestion (non-blocking): This is outside the scope of this MR, but WDYT about adding the active tab to the URL and setting the active tab based on the URL? That way reloading the page wouldn't navigate away from the Streams tab and users could also bookmark it.

Question: I'm seeing some weird behaviour where the empty state is flashed the first time I click on the streams tab.

Screen_Recording_2022-06-22_at_14.16.26

added 84 commits

f545bfd7...61c62be6 - 82 commits from branch master
43feca8d - Add custom headers form to audit events streaming UI using feature flag
a3f3e452 - Frontend reviewer feedback

Compare with previous version

approved this merge request

removed review request for @jiaan

removed review request for @toupeira

added Technical Writing docsfeature labels

removed review request for @eread

added 369 commits

a3f3e452...2a7146e2 - 367 commits from branch master
69e694a3 - Add custom headers form to audit events streaming UI using feature flag
997e43fe - Changed docs based upon tech writers reviewers suggestions

Compare with previous version

requested review from @eread

removed review request for @eread

added 143 commits

997e43fe...e2db9d07 - 142 commits from branch master
7d487c1c - Add custom headers form to audit events streaming UI using feature flag

Compare with previous version

requested review from @eread

added priority1 label and removed priority3 label

approved this merge request

changed the description

requested review from @ntepluhina

@rob.hunt @seggenberger since the Active checkbox is disabled, what do you think about making it disabled checked? That could provide some visual confirmation that the header value is active, even if a user can't actually interact with the checkbox.