Add events to Google Analytics with Node #245

HrithikSampson · 2023-10-19T09:03:39Z

What does this PR do?

The function created will be triggered by configured Appwrite events and report these events to Google Analytics

Test Plan

I have checked the functionality by creating a dummy webapp and triggering event in Google Analytics by login and logout
Video Link: https://drive.google.com/file/d/1CONrh9BpSRaEv3JcdshtexRKQDRCUOU5/view?usp=sharing

Related PRs and Issues

🚀 Feature: Add events to Google Analytics templates #230

Have you read the Contributing Guidelines on issues?

Yes

…analytics

gewenyu99

Hey, great start, we need to refactor the code a bit to fit our code standards and make things easier to read. Thank you so much!

appwrite.json

node/events-to-ga/src/main.js

HrithikSampson · 2023-10-21T12:54:32Z

Hi @gewenyu99 I have changed the code and pushed the changes
Here I have again tested it : https://drive.google.com/file/d/1Sa8Z20OgK1jI9oj4IiI8ppWXkeFU-pAM/view?usp=sharing

Thanks for the review comments

loks0n · 2023-10-26T15:16:50Z

node/events-to-ga/package.json

+  "license": "ISC",
+  "dependencies": {
+    "node-appwrite": "^11.0.0",
+    "node-fetch": "^3.3.2",


Can we use fetch from undici module?
You can see examples in other templates

loks0n · 2023-10-26T15:21:28Z

node/events-to-ga/src/main.js

+const ga4MeasurementId = process.env.GA4_MEASUREMENT_ID;
+const ga4secret = process.env.GA4_API_SECRET;


Can we just use these process.env inline? Just a style thing

stnguyen90

Great PR! 🤯 We left some comments during the review, please check them out.

node/events-to-ga/README.md

node/events-to-ga/package.json

node/events-to-ga/src/utils.js

node/events-to-ga/src/main.js

node/events-to-ga/src/utils.js

Haimantika · 2023-10-30T15:08:21Z

Hi @HrithikSampson can you please work on the suggested changes and request a re-review by tomorrow? We can add the hacktoberfest-accepted label then

HrithikSampson · 2023-10-30T16:07:54Z

Ok I will do it by tomorrow

loks0n · 2023-10-31T12:21:12Z

node/events-to-ga/README.md

@@ -0,0 +1,124 @@
+<!-- Name your function -->


Can you remove the markdown comments like this?

loks0n · 2023-10-31T12:21:37Z

node/events-to-ga/src/main.js

+import { fetch } from "undici";
+import { verifyHeaders, formatIntoGoogleAnalyticsEvent } from "./utils.js";
+
+/* Appwrite function */


Can you remove this comment?

loks0n · 2023-10-31T12:21:41Z

node/events-to-ga/src/main.js

+/* Appwrite function */
+
+export default async ({ res, req, log, error }) => {
+  // Listen for Appwrite events


Can you remove this comment?

loks0n · 2023-10-31T12:22:58Z

node/events-to-ga/src/utils.js

+ */
+export function verifyHeaders(req) {
+  if (req.headers["x-appwrite-user-id"] == "") {
+    throw `x-appwrite-user-id value in req.headers is not there`;


Can you do throw new Error("...") here instead? and below

loks0n · 2023-10-31T12:23:04Z

node/events-to-ga/src/utils.js

+    throw `x-appwrite-user-id value in req.headers is not there`;
+  }
+  if (req.headers["x-appwrite-trigger"] != "event") {
+    throw `Not triggered by event but by ${req.headers["x-appwrite-trigger"]}`;


Can you do throw new Error("...") here instead?

loks0n · 2023-10-31T12:24:30Z

node/events-to-ga/package.json

+    "undici": "^5.27.0"
+  },
+  "devDependencies": {
+    "prettier": "^3.0.3"


Can we also add a .pretterrc.json with the same settings as other template?

node/events-to-ga/src/utils.js

loks0n · 2023-10-31T12:28:03Z

node/events-to-ga/src/utils.js

+    if (i % 2 == 0) oddElemArray.push(splitArray[i]);
+    else
+      wildCardArray.push([
+        `${oldElemArray[oldElemArray.length - 1]}Id`,
+        splitArray[i],
+      ]);


Please add curly braces here, we prefer to use common syntax so the template is accessible

loks0n · 2023-10-31T12:28:37Z

node/events-to-ga/src/main.js

+      user_id: `${req.headers["x-appwrite-user-id"]}`,
+      events: [
+        {
+          // Event names must have all characters as alphanumeric.


Is this comment necessary?

HrithikSampson · 2023-10-31T13:33:52Z

Testing Video: https://drive.google.com/file/d/1Guw74H-xbZm1Xl2mlIlNBnMYVUBuhrAr/view?usp=sharing

Hi @Haimantika, I have requested for rereview

stnguyen90 · 2023-10-31T15:21:58Z

node/events-to-ga/src/utils.js

+    if (i % 2 == 0) oddElemArray.push(splitArray[i]);
+    else
+      wildCardArray.push([
+        `${oddElemArray[oddElemArray.length - 1]}Id`,


Hmm this will result in something like databasesId, right? It would be better if it was singular to match how we typically have it.

Also, this algorithm won't work for events like teams.*.memberships.*.update.status

is it because of no 's' in update because that I can resolve but I cant find out a way to get [status,prefs,name,email,password] unless I consider them that these will not go to the wildcard array

can I do that

Can I assume the length of the words in wildCard array is more than 12 or somethiing to distinguish it

is it because of no 's' in update because that I can resolve but I cant find out a way to get [status,prefs,name,email,password] unless I consider them that these will not go to the wildcard array

Because not every odd element is an ID. Although...I guess it's fine that status ends up in the params...

Can I assume the length of the words in wildCard array is more than 12 or somethiing to distinguish it

No, an ID isn't necessarily more than 12 chars.

HrithikSampson · 2023-10-31T15:47:11Z

stnguyen90

Please see #245 (comment)

…analytics

stnguyen90

See #245 (comment)

gewenyu99 · 2024-04-08T20:16:55Z

Hey there! There were a lot of big PRs during this Hacktoberfest, and we wanted to give everyone ample time to collaborate with our engineering team. If you were able to merge your PRs during October, amazing. If it’s still not merged, don’t worry about it either. Either way, we’ve got your Hacktoberfest swag minted and ready to ship.

Please comment with your Discord username here so we can contact you about your shipping information to deliver your Hacktoberfest swag.

HrithikSampson · 2024-04-09T00:15:49Z

Hi,
my discord username is hrithik9619

gewenyu99 · 2024-04-19T16:14:50Z

Be in touch soon!

feat: Deploying Appwrite function to report appwrite event to google …

c78b17f

…analytics

gewenyu99 requested review from Meldiron and vermakhushboo October 19, 2023 15:34

gewenyu99 suggested changes Oct 19, 2023

View reviewed changes

HrithikSampson force-pushed the feat-events-to-ga-node branch 8 times, most recently from 93b4c47 to df0b4ef Compare October 21, 2023 12:50

stnguyen90 requested a review from gewenyu99 October 26, 2023 15:09

loks0n reviewed Oct 26, 2023

View reviewed changes

stnguyen90 requested changes Oct 26, 2023

View reviewed changes

loks0n self-requested a review October 27, 2023 09:26

loks0n assigned HrithikSampson Oct 27, 2023

loks0n removed request for Meldiron and vermakhushboo October 30, 2023 10:05

HrithikSampson force-pushed the feat-events-to-ga-node branch 5 times, most recently from 692a880 to 2310fbb Compare October 31, 2023 12:30

loks0n requested changes Oct 31, 2023

View reviewed changes

HrithikSampson force-pushed the feat-events-to-ga-node branch from 2310fbb to 79551ff Compare October 31, 2023 12:32

HrithikSampson force-pushed the feat-events-to-ga-node branch from de93988 to 55edded Compare October 31, 2023 12:43

HrithikSampson requested review from stnguyen90 and loks0n October 31, 2023 12:46

HrithikSampson force-pushed the feat-events-to-ga-node branch 10 times, most recently from 7ea30ce to 4098807 Compare October 31, 2023 13:19

stnguyen90 added the hacktoberfest-accepted label Oct 31, 2023

stnguyen90 requested changes Oct 31, 2023

View reviewed changes

stnguyen90 changed the title ~~Feat events to ga node~~ Add events to Google Analytics with Node Oct 31, 2023

HrithikSampson force-pushed the feat-events-to-ga-node branch from 4098807 to 887c231 Compare October 31, 2023 15:34

HrithikSampson requested a review from stnguyen90 October 31, 2023 15:47

stnguyen90 requested changes Oct 31, 2023

View reviewed changes

HrithikSampson force-pushed the feat-events-to-ga-node branch from 887c231 to a549fcd Compare October 31, 2023 16:25

feat: Deploying Appwrite function to report appwrite event to google …

d3d4895

…analytics

HrithikSampson force-pushed the feat-events-to-ga-node branch from a549fcd to d3d4895 Compare October 31, 2023 16:28

HrithikSampson requested a review from stnguyen90 October 31, 2023 16:34

stnguyen90 requested changes Oct 31, 2023

View reviewed changes

github-actions bot mentioned this pull request Nov 1, 2023

PRs Opened in October 2023 appwrite/.github#93

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add events to Google Analytics with Node #245

Add events to Google Analytics with Node #245

HrithikSampson commented Oct 19, 2023 •

edited by stnguyen90

Loading

gewenyu99 left a comment

HrithikSampson commented Oct 21, 2023

loks0n Oct 26, 2023 •

edited

Loading

loks0n Oct 26, 2023

stnguyen90 left a comment

Haimantika commented Oct 30, 2023

HrithikSampson commented Oct 30, 2023

loks0n Oct 31, 2023

loks0n Oct 31, 2023

loks0n Oct 31, 2023

loks0n Oct 31, 2023

loks0n Oct 31, 2023

loks0n Oct 31, 2023

loks0n Oct 31, 2023

loks0n Oct 31, 2023

HrithikSampson commented Oct 31, 2023

stnguyen90 Oct 31, 2023

stnguyen90 Oct 31, 2023

HrithikSampson Oct 31, 2023

HrithikSampson Oct 31, 2023

HrithikSampson Oct 31, 2023

stnguyen90 Oct 31, 2023

stnguyen90 Oct 31, 2023

HrithikSampson commented Oct 31, 2023

stnguyen90 left a comment

stnguyen90 left a comment

gewenyu99 commented Apr 8, 2024

HrithikSampson commented Apr 9, 2024

gewenyu99 commented Apr 19, 2024

		const ga4MeasurementId = process.env.GA4_MEASUREMENT_ID;
		const ga4secret = process.env.GA4_API_SECRET;

Add events to Google Analytics with Node #245

Are you sure you want to change the base?

Add events to Google Analytics with Node #245

Conversation

HrithikSampson commented Oct 19, 2023 • edited by stnguyen90 Loading

What does this PR do?

Test Plan

Related PRs and Issues

Have you read the Contributing Guidelines on issues?

gewenyu99 left a comment

Choose a reason for hiding this comment

HrithikSampson commented Oct 21, 2023

loks0n Oct 26, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stnguyen90 left a comment

Choose a reason for hiding this comment

Haimantika commented Oct 30, 2023

HrithikSampson commented Oct 30, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HrithikSampson commented Oct 31, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HrithikSampson commented Oct 31, 2023

stnguyen90 left a comment

Choose a reason for hiding this comment

stnguyen90 left a comment

Choose a reason for hiding this comment

gewenyu99 commented Apr 8, 2024

HrithikSampson commented Apr 9, 2024

gewenyu99 commented Apr 19, 2024

HrithikSampson commented Oct 19, 2023 •

edited by stnguyen90

Loading

loks0n Oct 26, 2023 •

edited

Loading