feat: track clicks!

Author: NagariaHussain

linklite/linklite/doctype/short_link/short_link.json

@@ -4,7 +4,7 @@
  "autoname": "field:short_link",
  "creation": "2024-12-21 12:43:49.300176",
  "doctype": "DocType",
- "engine": "InnoDB",
+ "engine": "MyISAM",
  "field_order": [
   "destination_url",
   "column_break_awjo",
@@ -39,8 +39,13 @@
   }
  ],
  "index_web_pages_for_search": 1,
- "links": [],
- "modified": "2024-12-21 12:45:50.795245",
+ "links": [
+  {
+   "link_doctype": "Short Link Click",
+   "link_fieldname": "link"
+  }
+ ],
+ "modified": "2024-12-21 13:04:17.613091",
  "modified_by": "Administrator",
  "module": "LinkLite",
  "name": "Short Link",
@@ -63,4 +68,4 @@
  "sort_field": "creation",
  "sort_order": "DESC",
  "states": []
-}
+}

linklite/linklite/doctype/short_link_click/__init__.py

@@ -0,0 +1,8 @@
+// Copyright (c) 2024, Build With Hussain and contributors
+// For license information, please see license.txt
+
+// frappe.ui.form.on("Short Link Click", {
+// 	refresh(frm) {
+
+// 	},
+// });

linklite/linklite/doctype/short_link_click/short_link_click.js

@@ -0,0 +1,91 @@
+{
+ "actions": [],
+ "allow_rename": 1,
+ "creation": "2024-12-21 12:51:40.642856",
+ "doctype": "DocType",
+ "engine": "InnoDB",
+ "field_order": [
+  "ip",
+  "user_agent",
+  "link",
+  "column_break_fifj",
+  "referrer",
+  "utm",
+  "section_break_uflm",
+  "amended_from"
+ ],
+ "fields": [
+  {
+   "fieldname": "section_break_uflm",
+   "fieldtype": "Section Break"
+  },
+  {
+   "fieldname": "amended_from",
+   "fieldtype": "Link",
+   "label": "Amended From",
+   "no_copy": 1,
+   "options": "Short Link Click",
+   "print_hide": 1,
+   "read_only": 1,
+   "search_index": 1
+  },
+  {
+   "fieldname": "ip",
+   "fieldtype": "Data",
+   "label": "IP"
+  },
+  {
+   "fieldname": "user_agent",
+   "fieldtype": "Data",
+   "label": "User Agent"
+  },
+  {
+   "fieldname": "column_break_fifj",
+   "fieldtype": "Column Break"
+  },
+  {
+   "fieldname": "referrer",
+   "fieldtype": "Data",
+   "label": "Referrer"
+  },
+  {
+   "fieldname": "utm",
+   "fieldtype": "Data",
+   "label": "UTM"
+  },
+  {
+   "fieldname": "link",
+   "fieldtype": "Link",
+   "in_list_view": 1,
+   "label": "Link",
+   "options": "Short Link",
+   "reqd": 1
+  }
+ ],
+ "index_web_pages_for_search": 1,
+ "is_submittable": 1,
+ "links": [],
+ "modified": "2024-12-21 12:52:51.135308",
+ "modified_by": "Administrator",
+ "module": "LinkLite",
+ "name": "Short Link Click",
+ "owner": "Administrator",
+ "permissions": [
+  {
+   "create": 1,
+   "delete": 1,
+   "email": 1,
+   "export": 1,
+   "print": 1,
+   "read": 1,
+   "report": 1,
+   "role": "System Manager",
+   "share": 1,
+   "submit": 1,
+   "write": 1
+  }
+ ],
+ "sort_field": "creation",
+ "sort_order": "DESC",
+ "states": []
+}

linklite/linklite/doctype/short_link_click/short_link_click.json

@@ -0,0 +1,9 @@
+# Copyright (c) 2024, Build With Hussain and contributors
+# For license information, please see license.txt
+
+# import frappe
+from frappe.model.document import Document
+
+
+class ShortLinkClick(Document):
+	pass

linklite/linklite/doctype/short_link_click/short_link_click.py

@@ -0,0 +1,30 @@
+# Copyright (c) 2024, Build With Hussain and Contributors
+# See license.txt
+
+# import frappe
+from frappe.tests import IntegrationTestCase, UnitTestCase
+
+
+# On IntegrationTestCase, the doctype test records and all
+# link-field test record depdendencies are recursively loaded
+# Use these module variables to add/remove to/from that list
+EXTRA_TEST_RECORD_DEPENDENCIES = []  # eg. ["User"]
+IGNORE_TEST_RECORD_DEPENDENCIES = []  # eg. ["User"]
+
+
+class UnitTestShortLinkClick(UnitTestCase):
+	"""
+	Unit tests for ShortLinkClick.
+	Use this class for testing individual functions and methods.
+	"""
+
+	pass
+
+
+class IntegrationTestShortLinkClick(IntegrationTestCase):
+	"""
+	Integration tests for ShortLinkClick.
+	Use this class for testing interactions between multiple components.
+	"""
+
+	pass

linklite/linklite/doctype/short_link_click/test_short_link_click.py

@@ -1,14 +1,26 @@
 import frappe
-
 from frappe.website.path_resolver import resolve_path as original_resolve_path
 
+
 def path_resolver(path: str):
-	# if we want to handle the short link
+	# TODO: not handling "/gin?q=abc"
 	if frappe.db.exists("Short Link", {"short_link": path}):
-		# we want to redirect
-		destination = frappe.db.get_value("Short Link", {"short_link": path}, "destination_url")
-		frappe.redirect(destination)
+		short_link = frappe.db.get_value(
+			"Short Link", {"short_link": path}, ["destination_url", "name"], as_dict=True
+		)
+
+		click = frappe.new_doc("Short Link Click")
+
+		request_headers = frappe.request.headers
+		click.ip = request_headers.get("X-Real-Ip")
+		click.user_agent = request_headers.get("User-Agent")
+		click.referrer = request_headers.get("Referer")
+
+		click.link = short_link.name
+		click.insert().submit()
+		frappe.db.commit() # to remove once MyISAM
 
+		frappe.redirect(short_link.destination_url)
 
 	# else pass it on!
 	return original_resolve_path(path)