[Feature flag] Enable self-managed sign in flow in the GitLab for Jira App (Jira Connect)

Summary

This issue is to rollout the self-managed sign in flow in the GitLab for Jira App on production, that is currently behind the jira_connect_oauth_self_managed feature flag.

Rollout plan

Enable the feature on GitLab.com as soon as %15.7 is released. Remove the feature flag with %15.8

Owners

Team: ~"group::integrations"
Most appropriate slack channel to reach out to: #g_ecosystem_integrations
Best individual to reach out to: @justin_ho
PM: @g.hickman

Stakeholders

backend : @Andysoiron

Expectations

What are we expecting to happen?

The self-managed option should be availabe on the GitLab for Jira app

When is the feature viable?

The settings are already configured for GitLab.com. Self-managed instances need to follow the setup guide.

What might happen if this goes wrong?

Users might end up with JiraConnectInstallation records on self-managed instances that need to be cleanued up on case the installation doesn't work.

In case we need to disable the feature again after the release, we can clean up installations with the following script:

JiraConnectInstallation.each do |installation|
  next unless installation.proxy?
  JiraConnectInstallations::UpdateService.execute(installation, { instance_url: nil })
end

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

Rollout on non-production environments

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 jira_connect_oauth_self_managed true --dev
- /chatops run feature set jira_connect_oauth_self_managed 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.

Specific rollout on production

Ensure that the feature MRs have been deployed to both production and canary.
- /chatops run auto_deploy status <merge-commit-of-your-feature>
If you're using project-actor, you must enable the feature on these entries:
- /chatops run feature set --project=gitlab-org/gitlab jira_connect_oauth_self_managed true
- /chatops run feature set --project=gitlab-org/gitlab-foss jira_connect_oauth_self_managed true
- /chatops run feature set --project=gitlab-com/www-gitlab-com jira_connect_oauth_self_managed true
If you're using group-actor, you must enable the feature on these entries:
- /chatops run feature set --group=gitlab-org jira_connect_oauth_self_managed true
- /chatops run feature set --group=gitlab-com jira_connect_oauth_self_managed true
If you're using user-actor, you must enable the feature on these entries:
- /chatops run feature set --user=<your-username> jira_connect_oauth_self_managed true
Verify that the feature works on the specific entries. Posting the QA result in this issue is preferable.

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_ecosystem_integrations).

Incrementally roll out the feature.
- If the feature flag in code has an actor, perform actor-based rollout.
  - /chatops run feature set jira_connect_oauth_self_managed <rollout-percentage> --actors
- If the feature flag in code does NOT have an actor, perform time-based rollout (random rollout).
  - /chatops run feature set jira_connect_oauth_self_managed <rollout-percentage> --random
- Enable the feature globally on production environment.
  - /chatops run feature set jira_connect_oauth_self_managed true
Announce on the feature issue 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:

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.

Rollback Steps

This feature can be disabled by running the following Chatops command:

Run the following script on the production rails console:

JiraConnectInstallation.each do |installation|
  next unless installation.proxy?
  JiraConnectInstallations::UpdateService.execute(installation, { instance_url: nil })
end

On Slack run:

/chatops run feature set jira_connect_oauth_self_managed false

Availability & Testing

For validation after enabling the feature flag let's

while logged into instance
- complete the installation flow with gitlab.com project
- complete the installation flow with self managed project
while not logged into instance
- complete the installation flow with gitlab.com project
- complete the installation flow with self managed project

Note on followups

@sgregory2 to implement an orchestrated test using the strategy employed in: https://gitlab.com/gitlab-org/manage/integrations/jira-connect-test-tool
Suggestion: currently the Rails application branch from and maintain feature state based on flags and state passed to methods. It passes this state down to the Jira connect Vue app, which also independently manages it's own state based on the same feature flags. It would be win for testability and mitigating possible sync issues between the front and backend if:
- There was a single source of truth regarding the entry point into the different connect app logic branches.
- We leaned heavily on a "prop" driven approach where state propagates down
- The flow reduce the logical branching based on this state
- We have more confidence in the test cases (we can more easily assume the behavior)

Edited Jan 09, 2023 by Sean Gregory