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

Add referer header. #713

Open
wants to merge 1 commit into
base: v3
Choose a base branch
from
Open

Conversation

phuang07
Copy link

Q A
Bug fix? yes
New feature? yes
BC breaks? yes
Related Issue Fixed #...
Need Doc update no

Describe your change

Add "referer" header before sending out request.

What problem is this fixing?

In order to prevent Algolia indexing from dev instances, we need a way to restrict indexing from only the live site.
Algolia provides a feature for API restriction, which can be used to restrict a site to interact with the index by defining a narrow privilege API.

However, this feature requires to set the referer header in order to work, the site has to send the "referer" header along with the request.

Currently, this module doesn't set the referer header. This patch fixes this by adding adding header, the referer, before sending out the request.

@DevinCodes
Copy link
Collaborator

DevinCodes commented Jan 27, 2023

Hey @phuang07 ,

Thank you for this PR. We're going to discuss internally if this is something we want to add by default in the API client, as it would require a change in other API clients as well and there are some edge cases to think about.

For the time being, you can work around this in your own code by setting a custom header with the API client when setting it up. This would allow you to add the referrer by default, and would unblock you right away. 🙂

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.

2 participants