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

fix: always uppercase method option #259

Merged
merged 3 commits into from
Aug 16, 2023
Merged

fix: always uppercase method option #259

merged 3 commits into from
Aug 16, 2023

Conversation

murisceman
Copy link
Contributor

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

The JavaScript Fetch API supports lowercased get, post, delete, and put methods, but not the lowercased patch method. The method option in ofetch accepts a string | undefined, and the mentioned remark may be easy to forget without literal types. Therefore, it makes sense to standardize the behavior of all methods by converting them to uppercase. By convention, standardized methods are defined in all-uppercase, so this change should not break anything.

Additionally, the isPayloadMethod function already checks the method name by converting it to uppercase.

// Works
fetch('https://dummyjson.com/products/1', {
    method: 'PATCH',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ title: 'Test' }),
  })
    .then((res) => res.json())
    .then(console.log)

// Doesn't work
fetch('https://dummyjson.com/products/1', {
    method: 'patch', // <-- lowercased
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ title: 'Test' }),
  })
    .then((res) => res.json())
    .then(console.log)

// Works
fetch('https://dummyjson.com/products/1', {
    method: 'put', // <-- also lowercased, but it works
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ title: 'Test' }),
  })
    .then((res) => res.json())
    .then(console.log)

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

// Works
fetch('https://dummyjson.com/products/1', {
    method: 'PATCH',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ title: 'Test' }),
  })
    .then((res) => res.json())
    .then(console.log)

// Doesn't work
fetch('https://dummyjson.com/products/1', {
    method: 'patch', // <-- lowercased
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ title: 'Test' }),
  })
    .then((res) => res.json())
    .then(console.log)

// Works
fetch('https://dummyjson.com/products/1', {
    method: 'put', // <-- also lowercased, but it works
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ title: 'Test' }),
  })
    .then((res) => res.json())
    .then(console.log)
@pi0
Copy link
Member

pi0 commented Aug 1, 2023

THanks for pr. Do you have any reference about PATCH exception?

@murisceman
Copy link
Contributor Author

https://fetch.spec.whatwg.org/#methods

Copy link
Member

I can confirm patch exception - it's an unfortunate inconsistency and has been at the bottom of several 'bugs' I investigated.

@pi0 pi0 changed the title feat: uppercase method to support lowercased 'patch' fix: always uppercase method option Aug 16, 2023
Copy link
Member

@pi0 pi0 left a comment

Choose a reason for hiding this comment

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

Thanks!

@pi0 pi0 merged commit f5d94fa into unjs:main Aug 16, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants