Snippet integration verification #4106
Merged
Conversation
This file contains 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
aerosol
added
the
deploy-to-staging
aerosol
force-pushed
the
browserless-stack
branch
5 times, most recently
from
858a717
to
4aefdb4
Compare
- Floki will be used on production to parse site contents - Req will be used to handle redundant stuff like retrying etc.
Later on we'll use it to indicate verification errors
1. headless browsers aren't ignored if `window.__plausible` is defined 2. callback optionally supplies the event response HTTP status This will be later used to check whether the server acknowledged the verification event.
It: - tries to visit the site - defines window.__plausible, so the tracker doesn't ignore test events - sends a verification event and instruments the callback - awaits the callback to fire and returns the result
Only report CSP error if the snippet is already found
aerosol
force-pushed
the
browserless-stack
branch
from
c0d3245
to
4b383f0
Compare
ukutaht
reviewed
May 22, 2024
and act accordingly on diagnostics interoperation
zoldar
reviewed
May 23, 2024
| @@ -80,7 +81,8 @@ defmodule PlausibleWeb.StatsController do | |||
| !stats_start_date && can_see_stats? -> | |||
There was a problem hiding this comment.
Suggested change
| !stats_start_date && can_see_stats? -> | |
| can_see_stats? and not has_stats? -> |
as a follow-up to previous suggestion
zoldar
approved these changes
May 23, 2024
|
Oh one more thing that just came to my mind - running browserless in detached mode per default, explicitly named with an easy way to stop it (following example of minio setup). diff --git a/Makefile b/Makefile
index a85ee3b8f..527711a8d 100644
--- a/Makefile
+++ b/Makefile
@@ -38,7 +38,10 @@ postgres-stop: ## Stop and remove the postgres container
docker stop plausible_db && docker rm plausible_db
browserless:
- docker run -e "TOKEN=dummy_token" -p 3000:3000 --network host ghcr.io/browserless/chromium
+ docker run -d --rm -e "TOKEN=dummy_token" -p 3000:3000 --name plausible_browserless --network host ghcr.io/browserless/chromium
+
+browserless-stop:
+ docker stop plausible_browserlessWDYT? |
Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com>
Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com>
Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com>
Will do that in a follow-up maybe. For now it's quite convienent to be able to see the logs attached and being able to stop it with C-c. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes
This PR introduces a new feature - snippet integration verification.
The feature is exposed in two places:
record-2024-05-21-15-43-00-fled.jowl.mats.mp4
Note for reviewers
This PR is rather sizeable - reviewing commit by commit should make it bearable.
To play with it locally end to end, one has to
make browserless- this will instantiate a self-hosted browserless.io docker image.Please look at the tests first when in doubt.
How it works
Several modules implementing
Plausible.Verification.Checkrun in a pipeline, modifyingPlausible.Verification.State.The state is later on interpreted into
Plausible.Verification.Diagnostics.Rating, that carries the final result with, in case of failure, associated user-facing error and troubleshooting recommendation.At a higher level, this is coordinated by
Plausible.Live.VerificationLiveView, that can be either embedded standalone (onboarding) or as in a modal (settings). There are slight differences for each mode. For instance, onboarding verification still keeps waiting for the first organic page-view (but lets the user skip to the dashboard however).In general the following checks are made:
plausible()function is defined at the target site, sending a test verification event to the server, and checking ingestion response statusA bit more detailed descriptions can be found in each check's
moduledoc.The headless browser integration is done via browserless.io function REST API.
The most critical piece is
Diagnostics.Rating- we try to make it as accurate as possible, in order to help people troubleshoot their integrations without having to go through customer support. Tests should capture most of the scenarios we initially want to support.Feature flag
We'll deploy it behind
:verificationflag initially. Alternatively, verification can be enabled permanently by settingVERIFICATION_ENABLED=trueenvironment variable. That variable is on by default fordevenvironment, off otherwise.Documentation updates
Documentation/troubleshooting pages will require an update - pending.
Self-hosting
cc @ruslandoga - by default the feature is off and should not interfere with self-hosted deployments in any way.
We can later on add documentation on how to deploy it along with self-hosted browserless.io, if need be.
Gotchas
Tests
Changelog
Documentation
Dark mode