docs: improve Puppeteer integration guide#1253
Merged
Merged
Conversation
- Fix critical bug: initResp was missing rules, making autoconsent non-functional (no CMPs would be detected) - Add rule loading from shipped JSON bundles - Update config to match current Config type (add disabledCmps, isMainWorld, prehideTimeout, enableFilterList, enableHeuristicDetection, full logs sub-object) - Fix broken link to api.md (was at root, now points to docs/) - Add handling for informational messages (cmpDetected, popupFound, etc.) - Modernize from CommonJS require() to ESM imports - Add config reference table and rules section Co-authored-by: Maxim Tsoy <maks.tsoy@gmail.com>
|
Cursor Agent can help with this pull request. Just |
Co-authored-by: Maxim Tsoy <maks.tsoy@gmail.com>
Co-authored-by: Maxim Tsoy <maks.tsoy@gmail.com>
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit bfa090c. Configure here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #1152
Task/Issue URL: N/A
Description:
The
docs/puppeteer.mdguide had several issues that would prevent users from successfully integrating autoconsent with Puppeteer. This PR fixes all of them:Critical fix:
initRespmessage was missing therulesfield — without rules, autoconsent would never detect or handle any CMPs. Added rule loading from the shipped JSON bundles.Accuracy fixes:
autoconsentConfigobject to match the actualConfigtype inlib/types.ts:disabledCmps,isMainWorld,prehideTimeout,enableFilterList,enableHeuristicDetectionlogssub-object with all current keys (lifecycle,rulesteps,detectionsteps,evals,errors,messages,waits)enableHeuristicAction(the actual field isenableHeuristicDetection)api.md(was pointing to root, now correctly points todocs/api.md)Usability improvements:
cmpDetected,popupFound,optOutResult,autoconsentDone,autoconsentError) so users can monitor the consent flowrequire()to ESMimportsyntax, usingimport.meta.resolve+fileURLToPathinstead ofcreateRequireSteps to test this PR:
docs/puppeteer.mdfor accuracy againstlib/types.ts(Config type) andlib/messages.ts(message types)npm run lintpassesnpm run test:libpasses