From c289d9a203afa764ded4a77ff4197873bfffd0c3 Mon Sep 17 00:00:00 2001 From: Vandan Date: Thu, 20 Apr 2023 14:42:38 -0700 Subject: [PATCH 01/14] Add Usabilla feedback script Added a file for custom js that can be added into all generated pages. --- docusaurus.config.js | 1 + static/js/custom-script.js | 3 +++ 2 files changed, 4 insertions(+) create mode 100644 static/js/custom-script.js diff --git a/docusaurus.config.js b/docusaurus.config.js index dcb3c8894d9..5951ff008f4 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -29,6 +29,7 @@ const config = { scripts: [ { src: "https://plausible.io/js/script.js", defer: true, "data-domain": "docs.metamask.io" }, + { src: "/js/custom-script.js", defer: true, async: true }, ], presets: [ diff --git a/static/js/custom-script.js b/static/js/custom-script.js new file mode 100644 index 00000000000..695901ed7c4 --- /dev/null +++ b/static/js/custom-script.js @@ -0,0 +1,3 @@ + +window.lightningjs||function(n){var e="lightningjs";function t(e,t){var r,i,a,o,d,c;return t&&(t+=(/\?/.test(t)?"&":"?")+"lv=1"),n[e]||(r=window,i=document,a=e,o=i.location.protocol,d="load",c=0,function(){n[a]=function(){var t=arguments,i=this,o=++c,d=i&&i!=r&&i.id||0;function s(){return s.id=o,n[a].apply(s,arguments)}return(e.s=e.s||[]).push([o,d,t]),s.then=function(n,t,r){var i=e.fh[o]=e.fh[o]||[],a=e.eh[o]=e.eh[o]||[],d=e.ph[o]=e.ph[o]||[];return n&&i.push(n),t&&a.push(t),r&&d.push(r),s},s};var e=n[a]._={};function s(){e.P(d),e.w=1,n[a]("_load")}e.fh={},e.eh={},e.ph={},e.l=t?t.replace(/^\/\//,("https:"==o?o:"http:")+"//"):t,e.p={0:+new Date},e.P=function(n){e.p[n]=new Date-e.p[0]},e.w&&s(),r.addEventListener?r.addEventListener(d,s,!1):r.attachEvent("onload",s);var l=function(){function n(){return["<",o,"><",t,"><",r,' src="',e.l,'">"].join("")}var t="body",r="script",o="html",d=i[t];if(!d)return setTimeout(l,100);e.P(1);var c,s=i.createElement("div"),h=s.appendChild(i.createElement("div")),u=i.createElement("iframe");s.style.display="none",d.insertBefore(s,d.firstChild).id="lightningjs-"+a,u.frameBorder="0",u.id="lightningjs-frame-"+a,/MSIE[ ]+6/.test(navigator.userAgent)&&(u.src="javascript:false"),u.allowTransparency="true",h.appendChild(u);try{u.contentWindow.document.open()}catch(n){e.domain=i.domain,c="javascript:var d=document.open();d.domain='"+i.domain+"';",u.src=c+"void(0);"}try{var p=u.contentWindow.document;p.write(n()),p.close()}catch(e){u.src=c+'d.write("'+n().replace(/"/g,String.fromCharCode(92)+'"')+'");d.close();'}e.P(2)};e.l&&l()}()),n[e].lv="1",n[e]}var r=window.lightningjs=t(e);r.require=t,r.modules=n}({});window.usabilla_live = lightningjs.require("usabilla_live", "//w.usabilla.com/f157d4305b77.js"); + \ No newline at end of file From 19266758ab14370db90c1e55053db4f3d3196d7d Mon Sep 17 00:00:00 2001 From: Vandan Date: Thu, 20 Apr 2023 16:55:25 -0700 Subject: [PATCH 02/14] Update docusaurus.config.js Co-authored-by: Zachary Belford --- docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 5951ff008f4..357c6f641cb 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -29,7 +29,7 @@ const config = { scripts: [ { src: "https://plausible.io/js/script.js", defer: true, "data-domain": "docs.metamask.io" }, - { src: "/js/custom-script.js", defer: true, async: true }, + { src: `${process.env.DEST ? '/' + process.env.DEST : ''}/js/custom-script.js`, defer: true, async: true }, ], presets: [ From f0d28b9a57e9b2655a4ea3a84e1b88fc10a8a441 Mon Sep 17 00:00:00 2001 From: Vandan Date: Thu, 20 Apr 2023 17:02:18 -0700 Subject: [PATCH 03/14] Exclude custom js script file from linting The custom scripts will typically be provided by third parties in a condensed format that doesn't need to be as structured or readable. --- .eslintignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.eslintignore b/.eslintignore index 9b4fa7e2c7f..4133f973a17 100644 --- a/.eslintignore +++ b/.eslintignore @@ -1,2 +1,3 @@ /build -/.yarn \ No newline at end of file +/.yarn +/static/js/custom-script.js From 2352f7d214606786d90029916c1523bd8f48f813 Mon Sep 17 00:00:00 2001 From: Vandan Date: Thu, 20 Apr 2023 17:23:06 -0700 Subject: [PATCH 04/14] Potential fix for custom-script in preview builds Try removing extra '/' that's showing up in the preview URL for the custom-script.js --- docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 357c6f641cb..87a6158f4d2 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -29,7 +29,7 @@ const config = { scripts: [ { src: "https://plausible.io/js/script.js", defer: true, "data-domain": "docs.metamask.io" }, - { src: `${process.env.DEST ? '/' + process.env.DEST : ''}/js/custom-script.js`, defer: true, async: true }, + { src: `${process.env.DEST ? process.env.DEST : ''}/js/custom-script.js`, defer: true, async: true }, ], presets: [ From 7d697c131496d54f75363c1ac10d76cd5e9556c6 Mon Sep 17 00:00:00 2001 From: Vandan Date: Thu, 20 Apr 2023 18:24:51 -0700 Subject: [PATCH 05/14] Try resolve function for preview URL on feedback script the require.resolve function appears to work for preview reference to the custom css. Checking if we can use it for the custom-script.js as well. --- docusaurus.config.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 87a6158f4d2..f83fd298e49 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -29,7 +29,8 @@ const config = { scripts: [ { src: "https://plausible.io/js/script.js", defer: true, "data-domain": "docs.metamask.io" }, - { src: `${process.env.DEST ? process.env.DEST : ''}/js/custom-script.js`, defer: true, async: true }, + { src: `${process.env.DEST ? require.resolve("./static/js/custom-script.js") : '/js/custom-script.js'}`, defer: true, async: true }, + // { src: `${process.env.DEST ? '/' + process.env.DEST : ''}/js/custom-script.js`, defer: true, async: true }, ], presets: [ From 6af63f1a80f57b95d12afdae407eeb03ae4e70d7 Mon Sep 17 00:00:00 2001 From: Vandan Date: Thu, 20 Apr 2023 19:50:55 -0700 Subject: [PATCH 06/14] Revert "Try resolve function for preview URL on feedback script" This reverts commit 7d697c131496d54f75363c1ac10d76cd5e9556c6. --- docusaurus.config.js | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index f83fd298e49..87a6158f4d2 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -29,8 +29,7 @@ const config = { scripts: [ { src: "https://plausible.io/js/script.js", defer: true, "data-domain": "docs.metamask.io" }, - { src: `${process.env.DEST ? require.resolve("./static/js/custom-script.js") : '/js/custom-script.js'}`, defer: true, async: true }, - // { src: `${process.env.DEST ? '/' + process.env.DEST : ''}/js/custom-script.js`, defer: true, async: true }, + { src: `${process.env.DEST ? process.env.DEST : ''}/js/custom-script.js`, defer: true, async: true }, ], presets: [ From a0d2121f3550ba7ea30ddc630889341ab35785a0 Mon Sep 17 00:00:00 2001 From: Vandan Date: Wed, 26 Apr 2023 22:33:34 -0700 Subject: [PATCH 07/14] Reverted to a version that works locally --- static/js/{custom-script.js => feedback-script.js} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename static/js/{custom-script.js => feedback-script.js} (100%) diff --git a/static/js/custom-script.js b/static/js/feedback-script.js similarity index 100% rename from static/js/custom-script.js rename to static/js/feedback-script.js From 62a0975f58c3058f9e40ab90fccfc97d46e4455e Mon Sep 17 00:00:00 2001 From: Vandan Date: Wed, 26 Apr 2023 22:45:01 -0700 Subject: [PATCH 08/14] Update to version that works locally --- .eslintignore | 2 +- docusaurus.config.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.eslintignore b/.eslintignore index 4133f973a17..0523503b0df 100644 --- a/.eslintignore +++ b/.eslintignore @@ -1,3 +1,3 @@ /build /.yarn -/static/js/custom-script.js +/static/js/feedback-script.js \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 87a6158f4d2..9c01e107d79 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -29,7 +29,7 @@ const config = { scripts: [ { src: "https://plausible.io/js/script.js", defer: true, "data-domain": "docs.metamask.io" }, - { src: `${process.env.DEST ? process.env.DEST : ''}/js/custom-script.js`, defer: true, async: true }, + { src: '/js/feedback-script.js', defer: true, async: true }, ], presets: [ From 29f37e61fd227a8a7c8e5d8bb00f396a9db9d7cc Mon Sep 17 00:00:00 2001 From: Vandan Date: Wed, 26 Apr 2023 22:55:17 -0700 Subject: [PATCH 09/14] Fix local build with Zach's suggestion --- docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 9c01e107d79..778c052783c 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -29,7 +29,7 @@ const config = { scripts: [ { src: "https://plausible.io/js/script.js", defer: true, "data-domain": "docs.metamask.io" }, - { src: '/js/feedback-script.js', defer: true, async: true }, + { src: `${process.env.DEST ? '/' + process.env.DEST : '/'}js/feedback-script.js`, defer: true, async: true }, ], presets: [ From 668da177f03a807020a79af03982697dba9e7c36 Mon Sep 17 00:00:00 2001 From: Vandan Date: Wed, 26 Apr 2023 23:39:16 -0700 Subject: [PATCH 10/14] Remove '/' for preview path --- docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 778c052783c..319e6de31af 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -29,7 +29,7 @@ const config = { scripts: [ { src: "https://plausible.io/js/script.js", defer: true, "data-domain": "docs.metamask.io" }, - { src: `${process.env.DEST ? '/' + process.env.DEST : '/'}js/feedback-script.js`, defer: true, async: true }, + { src: `${process.env.DEST ? process.env.DEST : '/'}js/feedback-script.js`, defer: true, async: true }, ], presets: [ From 2e3dd59a62e2dc744607e2812e320467a9f31e52 Mon Sep 17 00:00:00 2001 From: Vandan Date: Wed, 26 Apr 2023 23:43:56 -0700 Subject: [PATCH 11/14] Update docusaurus.config.js --- docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 319e6de31af..778c052783c 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -29,7 +29,7 @@ const config = { scripts: [ { src: "https://plausible.io/js/script.js", defer: true, "data-domain": "docs.metamask.io" }, - { src: `${process.env.DEST ? process.env.DEST : '/'}js/feedback-script.js`, defer: true, async: true }, + { src: `${process.env.DEST ? '/' + process.env.DEST : '/'}js/feedback-script.js`, defer: true, async: true }, ], presets: [ From 80db0909c18aac70f47a3051855b846dc280d1e4 Mon Sep 17 00:00:00 2001 From: Vandan Date: Wed, 26 Apr 2023 23:45:26 -0700 Subject: [PATCH 12/14] Update docusaurus.config.js --- docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 778c052783c..5eb03f970a2 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -29,7 +29,7 @@ const config = { scripts: [ { src: "https://plausible.io/js/script.js", defer: true, "data-domain": "docs.metamask.io" }, - { src: `${process.env.DEST ? '/' + process.env.DEST : '/'}js/feedback-script.js`, defer: true, async: true }, + { src: `${process.env.DEST ? process.env.DEST + '/' : '/'}js/feedback-script.js`, defer: true, async: true }, ], presets: [ From c30e54c8e72cadb7c20fd59a7e65490958f4faaf Mon Sep 17 00:00:00 2001 From: Vandan Date: Wed, 26 Apr 2023 23:53:20 -0700 Subject: [PATCH 13/14] Update docusaurus.config.js --- docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 5eb03f970a2..9f74e328d0c 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -29,7 +29,7 @@ const config = { scripts: [ { src: "https://plausible.io/js/script.js", defer: true, "data-domain": "docs.metamask.io" }, - { src: `${process.env.DEST ? process.env.DEST + '/' : '/'}js/feedback-script.js`, defer: true, async: true }, + { src: `${process.env.DEST ? process.env.DEST : ''}/js/feedback-script.js`, defer: true, async: true }, ], presets: [ From 831ee33e813f30d778f6d3de4d09ada7786478db Mon Sep 17 00:00:00 2001 From: Alexandra Tran Date: Tue, 31 Oct 2023 22:14:38 -0700 Subject: [PATCH 14/14] eslint ignore --- docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 3938c32c775..e80d445b36d 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -33,7 +33,7 @@ const config = { scripts: [ { src: "https://cmp.osano.com/AzZMxHTbQDOQD8c1J/a2e89f0e-f467-4542-bfea-30ea2c1a6648/osano.js" }, { src: "https://plausible.io/js/script.js", defer: true, "data-domain": "docs.metamask.io" }, - { src: `${process.env.DEST ? process.env.DEST : ''}/js/feedback-script.js`, defer: true, async: true }, + { src: `${process.env.DEST ? process.env.DEST : ''}/js/feedback-script.js`, defer: true, async: true }, // eslint-disable-line { src: "/js/getfeedback.js", defer: true, async: true }, ],