Skip to content

Conversation

@louy
Copy link

@louy louy commented Feb 19, 2025

Description

Reading Headers.get('set-cookie') gives the initial value (empty array) until getMap is called

This PR fixes the bug

Related #2076

Type of change

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

Tested the code snippet in a local fork with reproduction mentioned in the issue ticket.

import {Headers} from '@whatwg-node/node-fetch'

const headers = new Headers({
  'set-cookie': ['a=b', 'c=d'],
});
console.log(headers.get('set-cookie'))

Test Environment:

  • OS: MacOS
  • @whatwg-node/node-fetch: 0.7.9
  • NodeJS: v22.11.0

Checklist:

  • I have followed the
    CONTRIBUTING doc and the
    style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests and linter rules pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Additional Context

Although it might seem that generating _map is overkill for reading the set-cookie header, if you look at the implementation of getMap you'll realise that _setCookie is populated by traversing the entire headers list, which is effectively what getMap does, so this seems to be the best solution without changing the Headers object significantly.

Summary by CodeRabbit

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced cookie header management to ensure consistent processing only after proper initialization, improving overall response reliability.

…not been initialised

Reading `Headers.get('set-cookie')` gives the initial value (empty array) until `getMap` is called

This PR fixes the bug
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 19, 2025

Walkthrough

The pull request refines the internal control flow in the PonyfillHeaders class within the packages/node-fetch/src/Headers.ts file. The _get, append, has, set, delete, forEach, _keys, _values, _entries, getSetCookie, and custom inspect methods now include checks to ensure that the internal _map property is initialized before interacting with the _setCookies array. No modifications were made to the public API or exported entities.

Changes

File Change Summary
packages/node-fetch/src/Headers.ts Updated _get, append, has, set, delete, forEach, _keys, _values, _entries, getSetCookie, and inspect methods to check _map initialization before modifying or accessing _setCookies.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant PonyfillHeaders

    Client->>PonyfillHeaders: Call _get("set-cookie")
    PonyfillHeaders->>PonyfillHeaders: Check if _map is initialized
    alt _map is not initialized
        PonyfillHeaders->>PonyfillHeaders: Initialize _map
    else _map is already initialized
        PonyfillHeaders->>PonyfillHeaders: Use existing _map
    end
    PonyfillHeaders-->>Client: Return 'set-cookie' values
Loading

Possibly related PRs

Poem

I'm a rabbit in the code, hopping with delight,
Checking cookies at dawn, making sure they're right.
With a twitch of my nose, I see the state align,
A conditional hop ensures things work just fine.
Code carrot crunches, sorted, oh so neat,
In headers' fields, the rhythm is extra sweet!
🥕🐇 Happy coding under the moonlit beat!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ad73f64 and a4b29db.

📒 Files selected for processing (1)
  • packages/node-fetch/src/Headers.ts (9 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/node-fetch/src/Headers.ts
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: unit / node 23
  • GitHub Check: unit / node 22
  • GitHub Check: unit / deno
  • GitHub Check: unit / bun
  • GitHub Check: unit / node 20
  • GitHub Check: unit / node 18
  • GitHub Check: server (undici)
  • GitHub Check: server (native)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@louy louy marked this pull request as ready for review February 19, 2025 19:37
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/node-fetch/src/Headers.ts (1)

22-23: LGTM! Fix ensures consistent behavior for 'set-cookie' headers.

The changes correctly ensure that _setCookies is populated by initializing _map when needed, fixing the bug where Headers.get('set-cookie') would return an empty result.

Add tests to verify the fix.

Consider adding tests to verify the behavior of Headers.get('set-cookie') before and after other operations that would initialize _map.

Would you like me to help generate test cases that cover this scenario?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2df827f and ad73f64.

📒 Files selected for processing (1)
  • packages/node-fetch/src/Headers.ts (1 hunks)

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.

1 participant