Skip to content

Fix MeiliSearch analytics tracking #2888

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.

Sign up for GitHub

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

Jump to bottom
Merged
pwizla merged 19 commits into from
Dec 9, 2025
Merged

Fix MeiliSearch analytics tracking #2888

pwizla merged 19 commits into from
Dec 9, 2025

Conversation

@pwizla
Copy link
Collaborator

@pwizla pwizla commented Dec 4, 2025

This PR improves Meilisearch analytics by binding search requests to a monthly rotating, pseudonymous user ID while respecting Do Not Track:

  • Generates/stores msUserId in localStorage and rotates monthly (UTC)
  • Sends X-MS-USER-ID only on Meilisearch /indexes/*/search requests; no personally identifiable information
  • Honors Do No Track (no ID created/sent) and restores fetch on unmount
  • Updates the “Usage information” page to disclose metrics and the identifier with a note
  • Click/conversion events are out of scope and unchanged

@pwizla pwizla self-assigned this Dec 4, 2025
@pwizla pwizla requested a review from meganelacheny as a code owner December 4, 2025 15:31
@strapi-cla
Copy link

strapi-cla commented Dec 4, 2025 •
edited
Loading

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ pwizla
❌ web-flow
You have signed the CLA already but the status is still pending? Let us recheck it.

@vercel
Copy link

vercel bot commented Dec 4, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
documentation Ready Ready Preview Comment Dec 5, 2025 3:10pm

@github-actions github-actions bot added internal PRs created by the Strapi core team pr: updated content PRs updating existing documentation content source: repo PRs/issues not targeting a specific documentation but rather affecting the whole repo labels Dec 4, 2025
pwizla
pwizla commented Dec 4, 2025
View reviewed changes
@pwizla
Remove key declarations in sidebar
6408d50 
Only useful for later Docusaurus upgrades
@pwizla pwizla force-pushed the repo/fix-meilisearch-analytics branch from 5570f19 to 3047ea2 Compare December 5, 2025 14:56
@web-flow
docs(search): route docsearch via same-origin API and attach X-MS-USE…
9088dd3 
…R-ID; add root API proxy; forward Meilisearch host/key via headers\n\n- Add api/indexes/[indexUid]/search.js to proxy POST /api/indexes/:indexUid/search to Meilisearch and set X-MS-USER-ID server-side\n- Keep host/apiKey in docusaurus.config.js but pass via headers (X-Meili-Host, X-Meili-Api-Key) to avoid literals in server code\n- Update SearchBar to use same-origin /api host; respect DNT and monthly rotation for msUserId\n- Restore search UI while enabling user-bound analytics without CORS issues
@pwizla pwizla added the flag: don't merge This PR should not be merged at the moment label Dec 5, 2025
@web-flow
docs(search): keep only root API route and fix path to /api/indexes/s…
4a96f63 
…trapi-docs/search\n\n- Remove duplicate function under docusaurus/api\n- Replace dynamic [indexUid] route with fixed strapi-docs path to match our single index\n- Keep header-forwarded host/key and X-MS-USER-ID support
@pwizla pwizla removed the flag: don't merge This PR should not be merged at the moment label Dec 9, 2025
@pwizla pwizla merged commit 7ada99f into main Dec 9, 2025
3 of 5 checks passed
@pwizla pwizla deleted the repo/fix-meilisearch-analytics branch December 9, 2025 15:15
@pwizla pwizla added this to the 6.14.0 milestone Dec 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@meganelacheny meganelacheny Awaiting requested review from meganelacheny

Assignees

@pwizla pwizla

Labels

internal PRs created by the Strapi core team pr: updated content PRs updating existing documentation content source: repo PRs/issues not targeting a specific documentation but rather affecting the whole repo

Projects

None yet

Milestone

6.14.0

Development

Successfully merging this pull request may close these issues.

3 participants

@pwizla @strapi-cla @web-flow