Skip to content
This repository was archived by the owner on Jan 3, 2026. It is now read-only.

feat!: Headers should be Headers - #653

Merged
danielbankhead merged 26 commits into
mainfrom
headers-as-headers
Oct 29, 2024
Merged

feat!: Headers should be Headers#653
danielbankhead merged 26 commits into
mainfrom
headers-as-headers

Conversation

@danielbankhead

@danielbankhead danielbankhead commented Oct 9, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

Headers should be Headers:

  • Creates consistency throughout the client libraries; no need to check properties for different casing for generic {} objects
    • Example: The "Content-Type" to use is ambiguous here and can lead to problems that are difficult to debug:
      const headers: {
    'content-type': 'application/json',
    'Content-Type': 'text/xml',
  };
  • Creates an alignment with Request#headers
  • Clients or intermediates/middleware can easily append to an existing header or create it if it does exist, like so:
const headers = new Headers();

// creates, if not exist, or appends to an existing header
headers.append('x-goog-api-client', 'abc');

Migration Guide

Simply pass non-Headers into Headers.

old:

const headers = {"my-headers": "value"};

new:

const headers = new Headers({"my-headers": "value"});

Background

🦕

d-goog and others added 22 commits April 16, 2024 15:18
@d-goog
feat!: Upgrade to node-fetch v3
58c7dc2
@danielbankhead
Merge branch 'main' into upgrade-node-fetch
f8570d9
@d-goog
refactor: Use native FormData in testing
7fd2a95
@d-goog
Merge branch 'upgrade-node-fetch' of github.com:googleapis/gaxios int…
0cc7856 
…o upgrade-node-fetch
@d-goog
feat!: Improve spec compliance
a61cfa5
@d-goog
test(temp): Run 18+
35a73b1
@gcf-owl-bot
🦉 Updates from OwlBot post-processor
e7addeb 
See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md
@d-goog
feat: Improve types, streamline, and standardize
9816229
@d-goog
Merge branch 'main' of github.com:googleapis/gaxios into upgrade-node…
93bf4a8 
…-fetch
@d-goog
test: Adopt Headers type from merge
9164b87
@d-goog
feat: Introduce GaxiosOptionsPrepared for improved type guarantees
84faea8
@d-goog
feat: Ensure GaxiosOptionsPrepared.url is always a URL
4e6de5f
@d-goog
refactor: Clean-up Types & Resolve lint warnings
e6c2371
@d-goog
refactor: streamline .data for Response
98f7009
@d-goog
docs: Simplify example
4894e39
@d-goog
refactor: streamline, no error case
a7e2e83
@d-goog
feat: Basic GET Support for Request objects
8413f68 
`node-fetch` does not yet support webstreams, which is required for `.body` node-fetch/node-fetch#387
@d-goog
test: remove .only
04e264d
@d-goog
refactor: simplify httpMethodsToRetry
d163a90
@d-goog
chore: update nock
705fad3
@d-goog
test: cleanup
9e52755
@d-goog
feat!: Headers should be Headers
33dccb7
@danielbankhead
danielbankhead requested a review from a team October 9, 2024 20:19
@generated-files-bot

generated-files-bot Bot commented Oct 9, 2024

Copy link
Copy Markdown

Warning: This pull request is touching the following templated files:

@product-auto-label product-auto-label Bot added the size: xl Pull request size is extra large. label Oct 9, 2024
@danielbankhead danielbankhead mentioned this pull request Nov 4, 2025
Closed
@danielbankhead danielbankhead added do not merge Indicates a pull request not ready for merge, due to either quality or timing. next major: breaking change this is a change that we should wait to bundle into the next major version labels Oct 9, 2024
@danielbankhead danielbankhead removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Oct 25, 2024
@danielbankhead
danielbankhead requested a review from a team October 25, 2024 18:24
@product-auto-label product-auto-label Bot added size: m Pull request size is medium. and removed size: xl Pull request size is extra large. labels Oct 25, 2024
@sofisl

sofisl commented Oct 29, 2024

Copy link
Copy Markdown
Contributor

This, along with #600 and #621 are going to cause breaking changes in auth + google-api-nodejs-client (and any other dependents). Since we don't have that level of integration tests, I'd strongly recommend releasing an experimental version of this library manually once you've merged all the breaking changes (but without merging the actual new release) and seeing what breaks in auth and GANC. That way you can preview breaking tests and any other changes, and you can revert anything if necessary before we release a new version of gaxios. In the future though, we would ideally just have these tests connected.

@danielbankhead
danielbankhead merged commit de28c24 into main Oct 29, 2024
@danielbankhead
danielbankhead deleted the headers-as-headers branch October 29, 2024 21:13
@release-please release-please Bot mentioned this pull request Oct 29, 2024
Merged
@d-goog d-goog mentioned this pull request Feb 8, 2025
Merged
@coderabbitai coderabbitai Bot mentioned this pull request Jul 27, 2026
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer
@sofisl sofisl sofisl approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

next major: breaking change this is a change that we should wait to bundle into the next major version size: m Pull request size is medium.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

case sensitivity of headers should not matter

3 participants

@danielbankhead @sofisl @d-goog