chore(docs): adding analytics #6350
There are no files selected for viewing
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| import { useEffect, useState } from "react"; | ||
| import useDocusaurusContext from "@docusaurus/useDocusaurusContext"; | ||
| import Link from "@docusaurus/Link"; | ||
| import { useLocation } from "@docusaurus/router"; | ||
|
|
||
| function getSiteId(env) { | ||
| if (env == "dev") { | ||
| return "4"; | ||
| } else if (env == "staging") { | ||
| return "5"; | ||
| } else { | ||
| return "6"; | ||
| } | ||
| } | ||
| function pushInstruction(name, ...args) { | ||
| return window._paq.push([name, ...args]); | ||
| } | ||
|
|
||
| export default function useMatomo() { | ||
| const { siteConfig } = useDocusaurusContext(); | ||
| const [showBanner, setShowBanner] = useState(false); | ||
| const location = useLocation(); | ||
|
|
||
| const env = siteConfig.customFields.MATOMO_ENV; | ||
| const urlBase = "https://noirlang.matomo.cloud/"; | ||
| const trackerUrl = `${urlBase}matomo.php`; | ||
| const srcUrl = `${urlBase}matomo.js`; | ||
|
|
||
| window._paq = window._paq || []; | ||
|
|
||
| useEffect(() => { | ||
| const storedConsent = localStorage.getItem("matomoConsent"); | ||
| if (storedConsent === null) { | ||
| setShowBanner(true); | ||
| } | ||
| }, []); | ||
|
|
||
| useEffect(() => { | ||
| pushInstruction("setTrackerUrl", trackerUrl); | ||
| pushInstruction("setSiteId", getSiteId(env)); | ||
| if (env !== "prod") { | ||
| pushInstruction("setSecureCookie", false); | ||
| } | ||
|
|
||
| const doc = document; | ||
| const scriptElement = doc.createElement("script"); | ||
| const scripts = doc.getElementsByTagName("script")[0]; | ||
|
|
||
| scriptElement.type = "text/javascript"; | ||
| scriptElement.async = true; | ||
| scriptElement.defer = true; | ||
| scriptElement.src = srcUrl; | ||
|
|
||
| if (scripts && scripts.parentNode) { | ||
| scripts.parentNode.insertBefore(scriptElement, scripts); | ||
| } | ||
| }, []); | ||
|
|
||
| useEffect(() => { | ||
| pushInstruction("trackPageView"); | ||
| }, [location]); | ||
|
|
||
| const optIn = () => { | ||
| pushInstruction("rememberConsentGiven"); | ||
| localStorage.setItem("matomoConsent", true); | ||
| setShowBanner(false); | ||
| }; | ||
|
|
||
| const optOut = () => { | ||
| pushInstruction("forgetConsentGiven"); | ||
| localStorage.setItem("matomoConsent", false); | ||
| setShowBanner(false); | ||
| }; | ||
|
|
||
| const debug = () => { | ||
| pushInstruction(function () { | ||
| console.log(this.getRememberedConsent()); | ||
| console.log(localStorage.getItem("matomoConsent")); | ||
| }); | ||
| }; | ||
|
|
||
| const reset = () => { | ||
| pushInstruction("forgetConsentGiven"); | ||
| localStorage.clear("matomoConsent"); | ||
| }; | ||
|
|
||
| if (!showBanner && env === "dev") { | ||
| return ( | ||
| <div id="optout-form"> | ||
| <div className="homepage_footer"> | ||
| <p>Debugging analytics</p> | ||
| <div className="homepage_cta_footer_container"> | ||
| <button | ||
| className="cta-button button button--secondary button--sm" | ||
| onClick={debug} | ||
| > | ||
| Debug | ||
| </button> | ||
| <button | ||
| className="cta-button button button--secondary button--sm" | ||
| onClick={reset} | ||
| > | ||
| Reset | ||
| </button> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ); | ||
| } else if (!showBanner) { | ||
| return null; | ||
| } | ||
|
|
||
| return ( | ||
| <div id="optout-form"> | ||
| <div className="homepage_footer"> | ||
| <p> | ||
| We value your privacy and we only collect statistics and essential | ||
| cookies. If you'd like to help us improve our websites, you can allow | ||
| cookies for tracking page views, time on site, and other analytics. | ||
| <br /> | ||
| <br /> | ||
| <Link to="https://aztec.network/privacy-policy/"> | ||
| Find out how we use cookies and how you can change your settings. | ||
| </Link> | ||
| </p> | ||
| <div className="homepage_cta_footer_container"> | ||
| <button | ||
| className="cta-button button button--primary button--sm" | ||
| onClick={optIn} | ||
| > | ||
| I accept cookies | ||
| </button> | ||
| <button | ||
| className="cta-button button button--secondary button--sm" | ||
| onClick={optOut} | ||
| > | ||
| I refuse cookies | ||
| </button> | ||
| {env === "dev" && ( | ||
| <button | ||
| className="cta-button button button--secondary button--sm" | ||
| onClick={debug} | ||
| > | ||
| Debug | ||
| </button> | ||
| )} | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ); | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds great for visual changes.
Apart from URLs, what is in processed docs that might need to be tested? Might just need a comment with what is not accurate between
docsvsprocessed_docs.Saw that CI is building
stagingdocs 👍There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agree that it would be useful to list all of the things that the preprocess step does.
i think its this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Exactly, it just adds the autogenerated stuff