[Feature flag] Enable Slack app v2 installation flow
Summary
This issue is to rollout the updated Slack app installation flow on production,
that is currently behind the slack_app_use_v2_flow
feature flag.
This change is necessary to support the new Slack app model ("GBP", "v2"), although the app itself still has the same functionality. Also see the epic &7729 (closed).
Owners
- Team: ~"group::integrations"
- Most appropriate slack channel to reach out to:
#g_ecosystem_integrations
- Best individual to reach out to: @toupeira @.luke
- PM: @g.hickman
Stakeholders
Expectations
What are we expecting to happen?
After enabling the FF, the "Add to Slack" button will use the v2 installation flow and install the GBP version of the app.
Users will also see a new "Reinstall Slack app" button on the integration form when the app is already installed. This button works the same as the "Add to Slack" button and is necessary to reinstall the new version of the app in the Slack workspace.
When is the feature viable?
The updated app needs to be approved by Slack and published to the marketplace before we can enable the FF on gitlab.com. We'll do this in #356001 (closed).
We don't need to coordinate the exact timing since the updated app will still work with the v1 installation flow, we just need to wait until the marketplace listing is published before the v2 flow will work.
What might happen if this goes wrong?
Users might run into unexpected problems with the v2 installation flow.
What can we check for monitoring production after rollouts?
The app is installed through the slack_auth
action in Projects::Settings::SlacksController
.
- Kibana search for errors in this controller: https://log.gprd.gitlab.net/goto/55564f30-cb98-11ec-b73f-692cc1ae8214
- We can also look at
#database-lab
to see the progress of the rollout:- Projects with GBP app:
select * from slack_integrations where bot_user_id is not null
- Projects with Classic app:
select * from slack_integrations where bot_user_id is null
- Projects with GBP app:
Rollout Steps
Rollout on non-production environments
Note: We can do this after updating the app in the GitLab workspace in #355999 (closed)
- Ensure that the feature MRs have been deployed to non-production environments.
-
/chatops run auto_deploy status <merge-commit-of-your-feature>
-
-
Enable the feature globally on non-production environments. -
/chatops run feature set slack_app_use_v2_flow true --dev
-
/chatops run feature set slack_app_use_v2_flow true --staging
-
-
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.
Preparation before global rollout
-
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). -
Announce on the feature issue an estimated time this 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_TEAM_NAME
).
-
Incrementally roll out the feature. - If the feature flag in code has an actor, perform actor-based rollout.
-
/chatops run feature set slack_app_use_v2_flow <rollout-percentage> --actors
-
- If the feature flag in code does NOT have an actor, perform time-based rollout (random rollout).
-
/chatops run feature set slack_app_use_v2_flow <rollout-percentage> --random
-
- Enable the feature globally on production environment.
-
/chatops run feature set slack_app_use_v2_flow true
-
- If the feature flag in code has an actor, perform actor-based rollout.
-
Announce on the feature issue that the feature has been globally enabled. -
Wait for at least one day for the verification term.
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 slack_app_use_v2_flow
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 slack_app_use_v2_flow --dev
-
/chatops run feature delete slack_app_use_v2_flow --staging
-
/chatops run feature delete slack_app_use_v2_flow
-
-
Close this rollout issue.
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set slack_app_use_v2_flow false