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

MSC4138: Update allowed HTTP methods in CORS responses #4138

Merged
merged 2 commits into from
Sep 2, 2024

Conversation

turt2live
Copy link
Member

@turt2live turt2live commented May 3, 2024

Rendered

In line with matrix-org/matrix-spec#1700, the following disclosure applies:

I am Director of Standards Development at The Matrix.org Foundation C.I.C., Matrix Spec Core Team (SCT) member, employed by Element, and operate the t2bot.io service. This proposal is written and published with my role as a member of the SCT.

Related: matrix-org/matrix-js-sdk#4188

FCP tickyboxes

@turt2live turt2live changed the title MSC: Update allowed HTTP methods in CORS responses MSC4138: Update allowed HTTP methods in CORS responses May 3, 2024
@turt2live turt2live marked this pull request as ready for review May 3, 2024 18:20
@turt2live turt2live added proposal A matrix spec change proposal client-server Client-Server API kind:maintenance MSC which clarifies/updates existing spec needs-implementation This MSC does not have a qualifying implementation for the SCT to review. The MSC cannot enter FCP. labels May 3, 2024
Copy link
Member Author

Choose a reason for hiding this comment

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

Implementation requirements:

  • None, in my opinion. See "unstable prefix" section for rationale.

@turt2live turt2live removed the needs-implementation This MSC does not have a qualifying implementation for the SCT to review. The MSC cannot enter FCP. label May 3, 2024
girlbossceo added a commit to girlbossceo/conduwuit that referenced this pull request May 3, 2024
@clokep
Copy link
Member

clokep commented May 3, 2024

Seems quite reasonable!

@mscbot fcp merge

@mscbot
Copy link
Collaborator

mscbot commented May 3, 2024

Team member @clokep has proposed to merge this. The next step is review by the rest of the tagged people:

Once at least 75% of reviewers approve (and there are no outstanding concerns), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for information about what commands tagged team members can give me.

@mscbot mscbot added proposed-final-comment-period Currently awaiting signoff of a majority of team members in order to enter the final comment period. disposition-merge labels May 3, 2024
girlbossceo added a commit to girlbossceo/conduwuit that referenced this pull request May 6, 2024
girlbossceo added a commit to girlbossceo/conduwuit that referenced this pull request May 6, 2024
The following methods are *not* included because they don't have foreseeable use in Matrix:

* `CONNECT`
* `TRACE`
Copy link
Member

Choose a reason for hiding this comment

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

I might suggest that this could be an MSC where we propose a literal update to the text of the spec: the current spec just plucks a recommendation out of thin air with no explanation of why it's recommended, but this MSC contains a bunch of useful context. I know you're trying to write it without including a reference to an in-review MSC in the spec, but I'm finding the result quite obtuse: "future use" just makes me wonder why the server wouldn't add those methods when it has an endpoint that actually uses them.

I would suggest something along the lines of, "if you implement all of the Matrix spec, you'll need this set, however this expanded set would be safe and sensible should you ever implement any MSCs that use them"?

Copy link
Member

Choose a reason for hiding this comment

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

or maybe something along the lines of "... if you implement any other endpoints that use other HTTP methods, make sure that you also include those methods on CORS".

Copy link
Member Author

Choose a reason for hiding this comment

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

#4138 (comment) is in line with this thread.

Will update the MSC.

@ara4n
Copy link
Member

ara4n commented May 13, 2024

it feels weird to be allowing methods without matching MSCs that demand them, but not enough to block it.

The [`Access-Control-Allow-Methods` header's recommended value](https://spec.matrix.org/v1.10/client-server-api/#web-browser-clients)
is updated to include the following:

* `PATCH` - A plausibly useful HTTP method for future use.
Copy link
Member

Choose a reason for hiding this comment

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

#4133 now wants to use this.

@mscbot
Copy link
Collaborator

mscbot commented Aug 28, 2024

🔔 This is now entering its final comment period, as per the review above. 🔔

@mscbot mscbot added final-comment-period This MSC has entered a final comment period in interest to approval, postpone, or delete in 5 days. and removed proposed-final-comment-period Currently awaiting signoff of a majority of team members in order to enter the final comment period. labels Aug 28, 2024
@mscbot
Copy link
Collaborator

mscbot commented Sep 2, 2024

The final comment period, with a disposition to merge, as per the review above, is now complete.

@mscbot mscbot added finished-final-comment-period and removed disposition-merge final-comment-period This MSC has entered a final comment period in interest to approval, postpone, or delete in 5 days. labels Sep 2, 2024
@anoadragon453 anoadragon453 merged commit abaaaee into main Sep 2, 2024
1 check passed
@anoadragon453 anoadragon453 deleted the travis/msc/update-cors branch September 2, 2024 16:41
@turt2live
Copy link
Member Author

updated by #4187

@turt2live turt2live added spec-pr-missing Proposal has been implemented and is being used in the wild but hasn't yet been added to the spec and removed finished-final-comment-period labels Sep 9, 2024
@turt2live
Copy link
Member Author

Partially addressed by matrix-org/matrix-spec#1995

@zecakeh
Copy link
Contributor

zecakeh commented Nov 21, 2024

Second spec PR: matrix-org/matrix-spec#2011

@turt2live turt2live added spec-pr-in-review A proposal which has been PR'd against the spec and is in review and removed spec-pr-missing Proposal has been implemented and is being used in the wild but hasn't yet been added to the spec labels Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client-server Client-Server API kind:maintenance MSC which clarifies/updates existing spec proposal A matrix spec change proposal spec-pr-in-review A proposal which has been PR'd against the spec and is in review
Projects
Status: Requires spec PR review
Development

Successfully merging this pull request may close these issues.

8 participants