cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 

Contributing to No-vary-search header implementation

ugur
Making moves

Hi!

Would it be possible to contribute to the No-vary-search header implementation if someone was very highly motivated to get it to the finish line? 

 

Here is the related thread in Github - 

 

Thanks!

2 REPLIES 2

siffemcon
Contributor

You could comment on that issue stating your interest.

You could also email valentin.gosu@gmail.com stating your interest - see https://bugzilla.mozilla.org/show_bug.cgi?id=1967294.

uaber435
Making moves

 

  • Acknowledgment of Interest:
    Thank you for showing interest in contributing to the No-vary-search header implementation. Your motivation to see this feature through is highly appreciated.

  • Understanding the Feature:
    Before contributing, it’s important to have a clear understanding of what the No-vary-search header does. Essentially, it instructs caching mechanisms to ignore URL query parameters when deciding whether cached content is valid.

  • Review the Existing Discussion:
    Go through the related GitHub thread carefully. Familiarize yourself with previous comments, proposed solutions, and any ongoing discussions. This helps avoid duplicate efforts.

  • Set Up Your Development Environment:
    Ensure your local environment is ready for testing. Clone the repository, set up necessary dependencies, and confirm that the project builds correctly.

  • Identify Gaps:
    Pinpoint areas in the current implementation that require work. It could be missing test coverage, incomplete header handling, or documentation gaps.

  • Practical Example for Testing (Airport Travel):
    When implementing or testing the No-vary-search header, use realistic scenarios. For instance, consider an airport travel website where search queries for flights include parameters like destination, date, and passenger_count. By using the No-vary-search header, cached pages can serve multiple queries that essentially return the same flight results, improving speed and efficiency.

  • Write Tests:
    Ensure you write comprehensive unit and integration tests. Simulate multiple search queries and verify that the caching behaves as expected when the header is applied.

  • Code Review:
    Once your implementation is ready, submit a pull request and request a code review. Be open to suggestions and iterate based on feedback from maintainers.

  • Documentation:
    Update relevant documentation to explain how the No-vary-search header works, including examples like the airport travel scenario. Clear docs help future contributors and end-users.

  • Performance Considerations:
    Check the performance impact of your implementation. Ensure that applying the header does not inadvertently slow down page loads or cache retrieval.

  • Community Collaboration:
    Engage with the community on GitHub or relevant forums. Answer questions, clarify doubts, and encourage others who might want to contribute.

  • Follow-Up:
    After merging, monitor any related issues or bug reports. Continuous improvement ensures that the header implementation remains stable and effective.