oncall-engine/engine/pyproject.toml
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

86 lines
2 KiB
TOML

[tool.isort]
profile = "black"
line_length=120
float_to_top=true
py_version=311
extend_skip_glob = "**/migrations/**"
[tool.black]
line-length = 120
target-version = ["py311"]
force-exclude = "migrations"
[tool.mypy]
mypy_path = "$MYPY_CONFIG_FILE_DIR/type_stubs"
implicit_reexport = true
plugins = [
"mypy_django_plugin.main",
"mypy_drf_plugin.main",
]
exclude = [
# TOML's double-quoted strings require escaping backslashes
"tests/test_.*\\.py$", # test files
"migrations/\\d*.*\\.py", # migration files
]
disable_error_code = [
"abstract",
"annotation-unchecked",
"arg-type",
"assignment",
"attr-defined",
"call-arg",
"call-overload",
"has-type",
"index",
"misc",
"name-defined",
"operator",
"return-value",
"typeddict-item",
"union-attr",
]
# mypy per-module options
[[tool.mypy.overrides]]
module = [
# the following setting should eventually be removed, one module at a time.
# It's only being added to temporarily surpress the:
# "module is installed, but missing library stubs or py.typed marker" errors
# we can slowly either start to add library stubs ourselves, or try and upgrade these libraries to see if
# a newer version includes type stubs
"anymail.*",
"celery.utils.debug",
"debug_toolbar.*",
"django_deprecate_fields.*",
"django_migration_linter",
"django_sns_view.*",
"factory.*",
"fcm_django.*",
"firebase_admin.*",
"googleapiclient.discovery.*",
"google.oauth2.credentials.*",
"httpretty.*",
"humanize.*",
"ipware.*",
"markdown2.*",
"mirage.*",
"ordered_model.*",
"phonenumbers.*",
"polymorphic.*",
"pyroscope.*",
"ratelimit.*",
"recurring_ical_events.*",
"rest_polymorphic.*",
"slackclient.*",
"slackviewer.*",
"social_core.*",
"social_django.*",
"twilio.*",
"uwsgidecorators.*",
"whitenoise.*",
"uwsgi.*",
]
ignore_missing_imports = true
[tool.django-stubs]
django_settings_module = "settings.dev"