Feature - Added Optional Google Analytics tag for Status Page. #2567

clcninja · 2023-01-08T17:31:32Z

I have read and understand the pull request rules.

Description

This PR adds in a Google Analytics tag field for a Status Page (allowing different tags for different pages/domains).

Fixes #2180 (issue)

Type of change

User interface (UI)
New feature (non-breaking change which adds functionality)

Checklist

My code follows the style guidelines of this project
I ran ESLint and other linters for modified files
I have performed a self-review of my own code and tested it
I have commented my code, particularly in hard-to-understand areas
(including JSDoc for methods)
My changes generate no new warnings
My code needed automated testing. I have added them (this is optional task)

Screenshots (if any)

src/pages/StatusPage.vue

louislam · 2023-01-09T02:51:59Z

I am thinking, maybe we should use sever side rendering instead.

As the code have to put at beginning of <head>:
https://support.google.com/analytics/answer/1008080?hl=en#zippy=%2Cin-this-article

clcninja · 2023-01-09T19:24:59Z

Sounds good, I'll refactor it into server/status_page.js

Saibamen

Missing new i18n keys

server/model/status_page.js

server/database.js

server/model/status_page.js

server/modules/google-analytics.js

server/model/status_page.js

louislam · 2023-01-31T06:54:58Z

db/patch-add-google-analytics-status-page-tag.sql

@@ -0,0 +1,4 @@
+-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.
+BEGIN TRANSACTION;
+ALTER TABLE status_page ADD google_analytics_tag_id TEXT;


Should be VARCHAR

Fixed ✔️

louislam · 2023-01-31T06:56:55Z

My codes (GA3 and GA4) do not seem to be working, it is still empty after save.

UA-36889556-1
G-8Y5FKTE8S4

clcninja · 2023-01-31T11:29:22Z

My codes (GA3 and GA4) do not seem to be working, it is still empty after save.

UA-36889556-1

G-8Y5FKTE8S4

Ah that's getting blocked by the regex, apparently that looks different than what the google ads site specifies, I'll make it a bit less restrictive, obviously they have used different formats at different points.

louislam · 2023-01-31T11:31:55Z

My codes (GA3 and GA4) do not seem to be working, it is still empty after save.

UA-36889556-1

G-8Y5FKTE8S4

Ah that's getting blocked by the regex, apparently that looks different than what the google ads site specifies, I'll make it a bit less restrictive, obviously they have used different formats at different points.

Maybe remove this regex? Because Google will keep adding new code format which will be hard to handle in the future.

clcninja · 2023-01-31T13:20:16Z

My codes (GA3 and GA4) do not seem to be working, it is still empty after save.

UA-36889556-1

G-8Y5FKTE8S4

Ah that's getting blocked by the regex, apparently that looks different than what the google ads site specifies, I'll make it a bit less restrictive, obviously they have used different formats at different points.

Maybe remove this regex? Because Google will keep adding new code format which will be hard to handle in the future.

A good shout I think. I've removed it and updated the database field type.

…support.google.com/analytics/answer/9310895

…o prevent XXS.

…tics tag.

server/socket-handlers/status-page-socket-handler.js

…ytics

louislam · 2023-02-04T08:38:47Z

server/model/status_page.js

@@ -53,6 +54,13 @@ class StatusPage extends BeanModel {

        const head = $("head");

+        if (statusPage.googleAnalyticsTagId) {
+            let escapedGoogleAnalyticsScript = jsesc(googleAnalytics.getGoogleAnalyticsScript(statusPage.googleAnalyticsTagId), {


I think jsesc is wrongly used, as getGoogleAnalyticsScript() returns with <script> tag which is not purely a javascript. I will fix it

louislam reviewed Jan 9, 2023

View reviewed changes

src/pages/StatusPage.vue Outdated Show resolved Hide resolved

Saibamen suggested changes Jan 10, 2023

View reviewed changes

server/model/status_page.js Outdated Show resolved Hide resolved

server/database.js Outdated Show resolved Hide resolved

server/model/status_page.js Outdated Show resolved Hide resolved

clcninja force-pushed the feature-google-analytics branch from 3194f48 to 7b36bfc Compare January 10, 2023 20:29

clcninja requested review from Saibamen and louislam and removed request for Saibamen and louislam January 10, 2023 20:30

Computroniks reviewed Jan 10, 2023

View reviewed changes

server/modules/google-analytics.js Outdated Show resolved Hide resolved

Computroniks suggested changes Jan 11, 2023

View reviewed changes

server/modules/google-analytics.js Outdated Show resolved Hide resolved

server/modules/google-analytics.js Outdated Show resolved Hide resolved

louislam added the question Further information is requested label Jan 12, 2023

louislam reviewed Jan 12, 2023

View reviewed changes

server/modules/google-analytics.js Outdated Show resolved Hide resolved

Saibamen approved these changes Jan 12, 2023

View reviewed changes

clcninja force-pushed the feature-google-analytics branch from 63e3ea7 to 01456bc Compare January 13, 2023 19:34

clcninja requested a review from louislam January 15, 2023 12:23

louislam added this to the 1.20.0 milestone Jan 15, 2023

louislam reviewed Jan 21, 2023

View reviewed changes

server/model/status_page.js Outdated Show resolved Hide resolved

clcninja requested a review from louislam January 22, 2023 16:59

clcninja force-pushed the feature-google-analytics branch 3 times, most recently from 60a48cd to 760a61b Compare January 24, 2023 20:45

louislam removed the question Further information is requested label Jan 25, 2023

louislam added the question Further information is requested label Jan 31, 2023

louislam reviewed Jan 31, 2023

View reviewed changes

c and others added 10 commits February 2, 2023 21:51

Feature - Added Optional Google Analytics tag for Status Page.

29e24e0

Feature - Google Analytics - Addressing PR Comments.

99c0b8c

Feature - Google Analytics - Use Regex to validate UA as per https://…

2b3a389

…support.google.com/analytics/answer/9310895

Feature - Google Analytics - Added JSDoc to Google Analytics functions.

fb29997

Feature - Google Analytics - Simplified Module & Escaped the Script t…

3ff0cbe

…o prevent XXS.

Google Analytics - Simplified retrieving Tag ID from Status Page.

c08d8a5

Google Analytics - Moved string to updated file.

5a94a3f

Feature - Google Analytics - Change TEXT type to VARCHAR.

3afe801

Feature - Google Analytics - Removed regex to validate a Google Analy…

913bb61

…tics tag.

Drop en.js

f153082

clcninja force-pushed the feature-google-analytics branch from 7209db5 to f153082 Compare February 2, 2023 21:52

Saibamen suggested changes Feb 3, 2023

View reviewed changes

server/socket-handlers/status-page-socket-handler.js Outdated Show resolved Hide resolved

Feature - Google Analytics - Removed unused import.

a823ed8

clcninja requested a review from Saibamen February 3, 2023 11:49

louislam removed the question Further information is requested label Feb 4, 2023

Merge remote-tracking branch 'origin/master' into feature-google-anal…

10c6f3b

…ytics

louislam reviewed Feb 4, 2023

View reviewed changes

louislam added 2 commits February 4, 2023 16:58

Relocate and fix jsesc issue

5f2affb

Trim

afadfe3

louislam merged commit 06dc61b into louislam:master Feb 4, 2023

stbc mentioned this pull request Feb 17, 2023

Support for Matomo #2795

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature - Added Optional Google Analytics tag for Status Page. #2567

Feature - Added Optional Google Analytics tag for Status Page. #2567

clcninja commented Jan 8, 2023 •

edited

Loading

louislam commented Jan 9, 2023

clcninja commented Jan 9, 2023

Saibamen left a comment

louislam Jan 31, 2023

clcninja Jan 31, 2023

louislam commented Jan 31, 2023

clcninja commented Jan 31, 2023

louislam commented Jan 31, 2023 •

edited

Loading

clcninja commented Jan 31, 2023

louislam Feb 4, 2023 •

edited

Loading

Feature - Added Optional Google Analytics tag for Status Page. #2567

Feature - Added Optional Google Analytics tag for Status Page. #2567

Conversation

clcninja commented Jan 8, 2023 • edited Loading

Description

Type of change

Checklist

Screenshots (if any)

louislam commented Jan 9, 2023

clcninja commented Jan 9, 2023

Saibamen left a comment

Choose a reason for hiding this comment

louislam Jan 31, 2023

Choose a reason for hiding this comment

clcninja Jan 31, 2023

Choose a reason for hiding this comment

louislam commented Jan 31, 2023

clcninja commented Jan 31, 2023

louislam commented Jan 31, 2023 • edited Loading

clcninja commented Jan 31, 2023

louislam Feb 4, 2023 • edited Loading

Choose a reason for hiding this comment

clcninja commented Jan 8, 2023 •

edited

Loading

louislam commented Jan 31, 2023 •

edited

Loading

louislam Feb 4, 2023 •

edited

Loading