oncall-engine/engine/apps/api/alert_group_table_columns.py

33 lines
1.4 KiB
Python
Raw Permalink Normal View History

import typing
Google OAuth2 flow + fetch Google Calendar OOO events (#4067) # What this PR does The following is deployed under a feature flag. **How it works** 1. The user clicks on the "Connect using your Google account" button in the user profile settings modal 2. The UI makes a call to `GET /api/internal/v1/login/google-oauth2`. The backend has now been configured to add `apps.social_auth.backends.GoogleOAuth2` as a "`social_auth` backend". 3. The backend will respond w/ a URL which points to the Google OAuth2 consent screen. The frontend then proceeds by sending the user to this page. This URL includes the following query parameters (amongst others): - `redirect_uri` - this will send the user back to `/api/internal/v1/complete/google-oauth2` (ie. make another API call to the OnCall backend to finalize the Google OAuth2 flow) - `state` - this represents an `apps.auth_token.models.GoogleOAuth2Token` token. This allows us to identify the OnCall user once they've linked their Google account. 4. Once redirected back to `/api/internal/v1/complete/google-oauth2`, this will complete the OAuth2 flow. At this point, the backend has access to several pieces of information about the Google user, including their `access_token` and `refresh_token`. We persist these (encrypted) for future use to fetch the user's out-of-office calendar events 5. The response from the API call in 4 above ☝️ is HTTP 302 (redirect) to `/a/grafana-oncall-app/users/me` (ie. open the user profile settings modal). At this point the user will see that their account has been connected and they can further configure the settings ![image](https://github.com/grafana/oncall/assets/9406895/c7673055-8485-4f9a-98df-b4f7347229ce) ## Which issue(s) this PR closes Closes https://github.com/grafana/oncall-private/issues/2584 ## Checklist - [x] Unit, integration, and e2e (if applicable) tests updated - [x] Documentation added (or `pr:no public docs` PR label added if not required) - will be done in https://github.com/grafana/oncall-private/issues/2591 - [x] Added the relevant release notes label (see labels prefixed w/ `release:`). These labels dictate how your PR will show up in the autogenerated release notes. - will be done in https://github.com/grafana/oncall-private/issues/2591 --------- Co-authored-by: Dominik <dominik.broj@grafana.com> Co-authored-by: Maxim Mordasov <maxim.mordasov@grafana.com>
2024-04-02 14:59:03 -04:00
from apps.user_management.constants import default_columns
from apps.user_management.types import AlertGroupTableColumns
if typing.TYPE_CHECKING:
from apps.user_management.models import User
def alert_group_table_user_settings(user: "User") -> AlertGroupTableColumns:
"""
Returns user settings for alert group table columns. The flag "default" shows that user has default settings for
visible columns. It's used by frontend to enable/disable `reset` button.
This function uses lazy update to update columns settings for organization and for user.
"""
default_organization_columns = default_columns()
if not user.organization.alert_group_table_columns:
user.organization.update_alert_group_table_columns(default_organization_columns)
organization_columns = user.organization.alert_group_table_columns
if user.alert_group_table_selected_columns:
visible_columns = [
column for column in user.alert_group_table_selected_columns if column in organization_columns
]
else:
visible_columns = default_organization_columns
user.update_alert_group_table_selected_columns(visible_columns)
hidden_columns = [column for column in organization_columns if column not in visible_columns]
return {
"visible": visible_columns,
"hidden": hidden_columns,
"default": visible_columns == default_organization_columns,
}