Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Re-add accidentally removed CORS middleware #2075

Merged
merged 3 commits into from May 11, 2023
Merged

Re-add accidentally removed CORS middleware #2075

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9043734
Add CORS middleware
dhruvkb May 11, 2023
7ee5966
Prevent duplication in `INSTALLED_APPS`
dhruvkb May 11, 2023
550cf3d
Prevent duplication in middleware
dhruvkb May 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion api/conf/settings/base.py
View file
Open in desktop
Expand Up @@ -6,7 +6,6 @@
"django.contrib.messages",
"django.contrib.staticfiles",
# Third-party installed apps, more can be added in other settings files.
"corsheaders",
"sslserver",
]

Expand Down
6 changes: 4 additions & 2 deletions api/conf/settings/logging.py
View file
Open in desktop
Expand Up @@ -115,6 +115,8 @@ def health_check_filter(record: LogRecord) -> bool:

if not DEBUG:
# WARNING: Do not run in production long-term as it can impact performance.
MIDDLEWARE.append(
"api.middleware.force_debug_cursor_middleware.force_debug_cursor_middleware" # noqa: E501
middleware = (
"api.middleware.force_debug_cursor_middleware.force_debug_cursor_middleware"
)
if middleware not in MIDDLEWARE:
MIDDLEWARE.append(middleware)
Comment on lines +118 to +122
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on the comment, did we actually want to remove this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't try to understand or change this bit. It was added by @zackkrida in #945.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah this enables the middleware which lets us log all DB queries, so we should keep it!

11 changes: 5 additions & 6 deletions api/conf/settings/oauth2.py
View file
Open in desktop
Expand Up @@ -3,13 +3,12 @@
from conf.settings.base import INSTALLED_APPS, MIDDLEWARE


INSTALLED_APPS += [
"oauth2_provider",
]
if "oauth2_provider" not in INSTALLED_APPS:
INSTALLED_APPS.append("oauth2_provider")

MIDDLEWARE += [
"oauth2_provider.middleware.OAuth2TokenMiddleware",
]
middleware = "oauth2_provider.middleware.OAuth2TokenMiddleware"
if middleware not in MIDDLEWARE:
MIDDLEWARE.append(middleware)
Comment on lines +6 to +11
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to make INSTALLED_APPS and MIDDLEWARE sets so we could just call .add, or is order important?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The order is important. For example, the CORS middleware specifies that it should be set as early in the list as possible, hence https://github.com/WordPress/openverse/pull/2075/files#diff-1e4c90df768f3514290795d5e58d3b561644bd37e4dfdb9938b60083dd062d30R45


OAUTH2_PROVIDER = {
"SCOPES": {
Expand Down
5 changes: 2 additions & 3 deletions api/conf/settings/openverse.py
View file
Open in desktop
@@ -1,6 +1,5 @@
from conf.settings.base import INSTALLED_APPS


INSTALLED_APPS += [
"api",
]
if "api" not in INSTALLED_APPS:
INSTALLED_APPS.append("api")
5 changes: 2 additions & 3 deletions api/conf/settings/rest_framework.py
View file
Open in desktop
Expand Up @@ -3,9 +3,8 @@
from conf.settings.base import INSTALLED_APPS


INSTALLED_APPS += [
"rest_framework",
]
if "rest_framework" not in INSTALLED_APPS:
INSTALLED_APPS.append("rest_framework")


THROTTLE_ANON_BURST = config("THROTTLE_ANON_BURST", default="5/hour")
Expand Down
5 changes: 2 additions & 3 deletions api/conf/settings/s3.py
View file
Open in desktop
Expand Up @@ -10,9 +10,8 @@


if USE_S3:
INSTALLED_APPS += [
"storages",
]
if "storages" not in INSTALLED_APPS:
INSTALLED_APPS.append("storages")

STORAGES["default"]["BACKEND"] = "storages.backends.s3boto3.S3Boto3Storage"

Expand Down
9 changes: 9 additions & 0 deletions api/conf/settings/security.py
View file
Open in desktop
Expand Up @@ -2,6 +2,8 @@

from decouple import config

from conf.settings.base import INSTALLED_APPS, MIDDLEWARE


# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/
Expand Down Expand Up @@ -35,6 +37,13 @@
CSRF_TRUSTED_ORIGINS = ["https://*.openverse.engineering"]

# Allow anybody to access the API from any domain
if "corsheaders" not in INSTALLED_APPS:
INSTALLED_APPS.append("corsheaders")

middleware = "corsheaders.middleware.CorsMiddleware"
if middleware not in MIDDLEWARE:
MIDDLEWARE.insert(0, middleware)

CORS_ORIGIN_ALLOW_ALL = True

# Proxy handling, for production
Expand Down
5 changes: 2 additions & 3 deletions api/conf/settings/spectacular.py
View file
Open in desktop
Expand Up @@ -4,9 +4,8 @@
from conf.settings.misc import API_VERSION


INSTALLED_APPS += [
"drf_spectacular",
]
if "drf_spectacular" not in INSTALLED_APPS:
INSTALLED_APPS.append("drf_spectacular")

SPECTACULAR_SETTINGS = {
"TITLE": "Openverse API",
Expand Down