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.

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

Re-add accidentally removed CORS middleware #2075

Merged
merged 3 commits into from May 11, 2023
Merged

Re-add accidentally removed CORS middleware #2075

merged 3 commits into from May 11, 2023

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented May 11, 2023

Fixes

This PR re-adds the accidentally removed CORS middleware. The absence of this middleware prevents cross-origin requests which consequently prevents using the local API as the server for the frontend.

This was reported by @AetherUnbound.

Description

This PR

  • adds corsheaders.middleware.CorsMiddleware to MIDDLEWARE
  • prevents duplication of INSTALLED_APPS and middleware when inheriting between settings files

Testing Instructions

  1. Check out this PR and run the dev server: just api/up

  2. Check that the CORS headers are applied.

    $ curl -v -H "Origin: http://localhost:50280/" "http://localhost:50280/"
    

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@dhruvkb dhruvkb added 🟥 priority: critical Must be addressed ASAP 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository 🧱 stack: api Related to the Django API labels May 11, 2023
@dhruvkb dhruvkb requested a review from a team as a code owner May 11, 2023 05:21
@dhruvkb dhruvkb requested review from krysal and obulat May 11, 2023 05:21
@openverse-bot openverse-bot added this to Needs review in Openverse PRs May 11, 2023
@krysal
Copy link
Member

krysal commented May 11, 2023

@dhruvkb Could you explain the motivation of these changes since there is no issue linked?

@dhruvkb
Copy link
Member Author

dhruvkb commented May 11, 2023

@krysal good point, sorry about that. I updated the description with the problem this PR is aiming to fix.

Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

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

Nice! Thank you. LGTM!

Copy link
Contributor

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

This works great! I was able to test this using both curl -L -v -H "Origin: http://localhost:8443/" "http://localhost:50280/" and running the API and frontend with env API_URL="http://0.0.0.0:50280" just frontend/run dev. I have a few comments but nothing blocking 😄

Comment on lines +118 to +122
middleware = (
"api.middleware.force_debug_cursor_middleware.force_debug_cursor_middleware"
)
if middleware not in MIDDLEWARE:
MIDDLEWARE.append(middleware)
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!

Comment on lines +6 to +11
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)
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

Openverse PRs automation moved this from Needs review to Reviewer approved May 11, 2023
@dhruvkb dhruvkb merged commit 962c556 into main May 11, 2023
65 checks passed
@dhruvkb dhruvkb changed the title Add CORS middleware Re-add accidentally removed CORS middleware May 11, 2023
Openverse PRs automation moved this from Reviewer approved to Merged! May 11, 2023
@dhruvkb dhruvkb deleted the fix_cors branch May 11, 2023 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟥 priority: critical Must be addressed ASAP 🧱 stack: api Related to the Django API
Projects
Archived in project
Openverse PRs
  
Merged!
Development

Successfully merging this pull request may close these issues.

None yet

4 participants