[Feature flag] Rollout of `standalone_finding_modal`
Summary
This issue is to rollout the feature on production, that is currently behind the standalone_finding_modal
feature flag.
Owners
- Team: groupthreat insights Threat InsightsTangerine
- Most appropriate Slack channel to reach out to:
#g_govern_threat_insights_tangerine
- Best individual to reach out to:
@mokhax
@dpisek
- PM:
@thiagocsf
Stakeholders
Expectations
What are we expecting to happen?
The modal that shows details for a security finding on the pipeline-security tab should be visually different, but apart from that, there should be feature parity.
Example of the current and updated UI:
current | after |
---|---|
![]() |
![]() |
When is the feature viable?
Date | Change | Complete | Notes |
---|---|---|---|
2023-06-29 | Staging: enable on test projects |
|
|
2023-06-30 | Staging: enable globally |
|
|
2023-07-04 | Production: enable on test projects |
|
|
2023-07-10 | Production: enable globally | ||
2023-07-17 | Production: enable by default |
What might happen if this goes wrong?
What can we monitor to detect problems with this?
Consider mentioning checks for 5xx errors or other anomalies like an increase in redirects (302 HTTP response status)
What can we check for monitoring production after rollouts?
Consider adding links to check for Sentry errors, Production logs for 5xx, 302s, etc.
Rollout Steps
Note: Please make sure to run the chatops commands in the slack channel that gets impacted by the command.
Rollout on non-production environments
-
Verify the MR with the feature flag is merged to master. -
Verify that the feature MRs have been deployed to non-production environments with: -
/chatops run auto_deploy status <merge-commit-of-your-feature>
-
-
Enable the feature globally on non-production environments. -
/chatops run feature set standalone_finding_modal true --dev --staging --staging-ref
-
-
Verify that the feature works as expected. Posting the QA result in this issue is preferable. The best environment to validate the feature in is staging-canary as this is the first environment deployed to. Note you will need to make sure you are configured to use canary as outlined here when accessing the staging environment in order to make sure you are testing appropriately.
Specific rollout on production
For visibility, all /chatops
commands that target production should be executed in the #production
slack channel and cross-posted (with the command results) to the responsible team's slack channel (#g_govern_threat_insights_tangerine
).
-
Ensure that the feature MRs have been deployed to both production and canary. -
/chatops run auto_deploy status <merge-commit-of-your-feature>
-
Depending on the type of actor you are using, pick one of these options: -
If you're using project-actor, you must enable the feature on these entries: -
/chatops run feature set --project=gitlab-org/gitlab,gitlab-org/gitlab-foss,gitlab-com/www-gitlab-com standalone_finding_modal true
-
If you're using group-actor, you must enable the feature on these entries: -
/chatops run feature set --group=gitlab-org,gitlab-com standalone_finding_modal true
-
If you're using user-actor, you must enable the feature on these entries: -
/chatops run feature set --user=<your-username> standalone_finding_modal true
-
-
-
-
-
-
Verify that the feature works on the specific entries. Posting the QA result in this issue is preferable.
Preparation before global rollout
-
Set a milestone to the rollout issue to signal for enabling and removing the feature flag when it is stable. -
Check if the feature flag change needs to be accompanied with a change management issue. Cross link the issue here if it does. -
Ensure that you or a representative in development can be available for at least 2 hours after feature flag updates in production. If a different developer will be covering, or an exception is needed, please inform the oncall SRE by using the @sre-oncall
Slack alias. -
Ensure that documentation has been updated (More info). -
Leave a comment on the feature issue announcing estimated time when this feature flag will be enabled on GitLab.com. -
Ensure that any breaking changes have been announced following the release post process to ensure GitLab customers are aware. -
Notify #support_gitlab-com
and your team channel (more guidance when this is necessary in the dev docs).
Global rollout on production
For visibility, all /chatops
commands that target production should be executed in the #production
slack channel and cross-posted (with the command results) to the responsible team's slack channel (#g_govern_threat_insights_tangerine
).
-
Incrementally roll out the feature. -
If the feature flag in code has an actor, perform actor-based rollout. -
/chatops run feature set standalone_finding_modal <rollout-percentage> --actors
-
If the feature flag in code does NOT have an actor, perform time-based rollout (random rollout). -
/chatops run feature set standalone_finding_modal <rollout-percentage> --random
-
Enable the feature globally on production environment. -
/chatops run feature set standalone_finding_modal true
-
-
-
-
-
Leave a comment on the feature issue announcing that the feature has been globally enabled. -
Wait for at least one day for the verification term.
(Optional) Release the feature with the feature flag
If you're still unsure whether the feature is deemed stable but want to release it in the current milestone, you can change the default state of the feature flag to be enabled. To do so, follow these steps:
-
Create a merge request with the following changes. Ask for review and merge it. -
Set the default_enabled
attribute in the feature flag definition totrue
. -
Review what warrants a changelog entry and decide if a changelog entry is needed.
-
-
Ensure that the default-enabling MR has been included in the release package. If the merge request was deployed before the monthly release was tagged, the feature can be officially announced in a release blog post. -
/chatops run release check <merge-request-url> <milestone>
-
-
Consider cleaning up the feature flag from all environments by running these chatops command in #production
channel. Otherwise these settings may override the default enabled.-
/chatops run feature delete standalone_finding_modal --dev --staging --staging-ref --production
-
-
Close the feature issue to indicate the feature will be released in the current milestone. -
Set the next milestone to this rollout issue for scheduling the flag removal. -
(Optional) You can create a separate issue for scheduling the steps below to Release the feature. -
Set the title to "[Feature flag] Cleanup standalone_finding_modal
". -
Execute the /copy_metadata https://gitlab.com/gitlab-org/gitlab/-/issues/386265
quick action to copy the labels from this rollout issue. -
Link this rollout issue as a related issue. -
Close this rollout issue.
-
WARNING: This approach has the downside that it makes it difficult for us to clean up the flag. For example, on-premise users could disable the feature on their GitLab instance. But when you remove the flag at some point, they suddenly see the feature as enabled and they can't roll it back to the previous behavior. To avoid this potential breaking change, use this approach only for urgent matters.
Release the feature
After the feature has been deemed stable, the clean up should be done as soon as possible to permanently enable the feature and reduce complexity in the codebase.
You can either create a follow-up issue for Feature Flag Cleanup or use the checklist below in this same issue.
-
Create a merge request to remove standalone_finding_modal
feature flag. Ask for review and merge it.-
Remove all references to the feature flag from the codebase. -
Remove the YAML definitions for the feature from the repository. -
Create a changelog entry.
-
-
Ensure that the cleanup MR has been included in the release package. If the merge request was deployed before the monthly release was tagged, the feature can be officially announced in a release blog post. -
/chatops run release check <merge-request-url> <milestone>
-
-
Close the feature issue to indicate the feature will be released in the current milestone. -
Clean up the feature flag from all environments by running these chatops command in #production
channel:-
/chatops run feature delete standalone_finding_modal --dev --staging --staging-ref --production
-
-
Close this rollout issue.
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set standalone_finding_modal false
Manual testing outline
Projects
- FF enabled: https://gitlab.com/gitlab-org/govern/threat-insights-demos/verification-projects/security-reports-verification-for-386265-ff-enabled/-/pipelines/933477916/security
- FF disabled: https://gitlab.com/gitlab-org/govern/threat-insights-demos/verification-projects/security-reports-verification-for-386265-ff-disabled/-/pipelines/933509071/security
Content Rendering
-
False positive alert ✅ (see #386265 (comment 1471942739) -
Finding details -
Testing on different report types, as some sections are only used by certain tools (e.g.: request/response only on DAST) -
Generic report section -
Making sure that all types render correctly. (note: there is now a limit on how deeply nested generic-report items can be, this is due to the limit of how deeply nested a GraphQL query can be)
-
-
Dismissal comments ✅ -
Related MRs section -
Related Issue section -
Solution section -
Security Training (note: needs special setup on project-level)
-
Functionality
-
Dismissal -
With comment -
Undo dismissal -
Making sure that the dismissal also reflects in the pipeline report and the appropriate toast massage appears
-
-
Issue creation -
GitLab -
Jira: project with Jira integration enabled
-
-
MR Creation and patch download