oncall-engine/engine/apps/api/serializers
Joey Orlando 59f727d4f5
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
..
__init__.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
alert.py Improve OpenAPI schema coverage (#3629) 2024-01-12 15:11:22 +00:00
alert_group.py Add permalinks field to the alert groups list view in internal api (#4100) 2024-03-22 12:31:44 +00:00
alert_group_escalation_snapshot.py cleanup CustomButton backend code + add ngrok/express outgoing webhook e2e test (#2544) 2024-03-28 15:37:22 +00:00
alert_group_table_settings.py Fix alert group columns validation (#3577) 2023-12-15 17:15:50 +00:00
alert_receive_channel.py Fix validation of integration name when team is not present in request data (#4132) 2024-03-29 04:57:27 +00:00
alert_receive_channel_connection.py Backend support for "connected" integrations (#4030) 2024-03-07 17:47:33 +00:00
alerts_field_cache_buster_mixin.py Fix broken openapi schema + add integration test (#3364) 2023-11-16 12:15:05 +00:00
channel_filter.py Alert group payload labels (#3434) 2023-11-27 17:53:54 +00:00
custom_serializers.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
escalation_chain.py Fix team changing on PUT request if team is not in request data (#3530) 2023-12-07 14:44:52 +00:00
escalation_policy.py cleanup CustomButton backend code + add ngrok/express outgoing webhook e2e test (#2544) 2024-03-28 15:37:22 +00:00
integration_heartbeat.py Improve OpenAPI schema coverage (#3629) 2024-01-12 15:11:22 +00:00
labels.py Support prescribed labels (#3848) 2024-02-20 14:42:51 +08:00
live_setting.py Allow no-auth SMTP connection for email notifications (#759) 2022-11-03 16:18:37 +00:00
on_call_shifts.py Disable updates for API/terraform shifts in internal API (#3224) 2023-10-31 15:08:07 +00:00
organization.py add grafana_incident_enabled to GET /organization internal API response (#4129) 2024-03-27 21:46:19 +00:00
organization_slack_settings.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
paging.py Updates to POST /direct_paging internal API endpoint to support Grafana Incident use-cases (#3232) 2023-11-01 17:19:44 -04:00
public_api_token.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
resolution_note.py Resolution note source mobile app (#3174) 2023-10-20 15:22:45 +01:00
schedule_base.py Refactor gaps and empty shift checks (#3785) 2024-01-31 15:25:06 +01:00
schedule_calendar.py Refactor gaps and empty shift checks (#3785) 2024-01-31 15:25:06 +01:00
schedule_ical.py Refactor gaps and empty shift checks (#3785) 2024-01-31 15:25:06 +01:00
schedule_polymorphic.py add mypy static type checker to backend codebase (#2151) 2023-06-12 12:50:33 -04:00
schedule_reminder.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
schedule_web.py Refactor gaps and empty shift checks (#3785) 2024-01-31 15:25:06 +01:00
shift_swap.py Add optional param to return shift swaps detailed user information (#2923) 2023-08-31 14:46:45 +00:00
slack_channel.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
slack_user_identity.py Improve OpenAPI schema coverage (#3629) 2024-01-12 15:11:22 +00:00
team.py Fix calculating number of oncall users per team (#3773) 2024-01-29 14:32:03 +00:00
telegram.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
user.py Google OAuth2 flow + fetch Google Calendar OOO events (#4067) 2024-04-02 14:59:03 -04:00
user_group.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
user_notification_policy.py Fix duplicate orders on routes and escalation policies (#2568) 2023-07-18 17:17:53 +00:00
webhook.py Allow setting integration_filter to null in webhooks internal API (#4011) 2024-03-05 17:11:47 +00:00