[Android] Create module bridge for Telemetry API Client #4

benedict-lim-ahrefs · 2025-04-02T06:02:50Z

Background

Integrate telemetry API interface in Java for the Android Client

Details

04-07 16:03:35.244  6227  6227 I chromium: [INFO:cs_api_client_service.cc(49)] |>> Sending url : http://www.ahrefs.com/
04-07 16:03:35.245  6227  6227 I chromium: [INFO:cs_api_client_service.cc(62)] |>> Sending payload : {"k":"RrZUA7XvGI6R2DvyqbnE0w","n":"pageview","u":"http://www.ahrefs.com/","v":"C5D39C1ED3314D180C8716B56C84B359"}
04-07 16:03:35.245  6227  6227 I chromium: [INFO:web_request_helper.cc(242)] POST https://analytics.ahrefs.com/api/event
04-07 16:03:35.323  6227  6227 I chromium: [INFO:web_request_helper.cc(375)] [[OnResponse]] Response received
04-07 16:03:35.324  6227  6227 I chromium: [INFO:web_request_helper.cc(337)] Creating DataDecoder for WebRequestHelper
04-07 16:03:35.324  6227  6227 I chromium: [INFO:cs_api_client_module_bridge.cc(134)]  |>> CS post response code : 200
04-07 16:03:35.324  6227  6227 I chromium: [INFO:cs_api_client_module_bridge.cc(136)]  |>> CS post error code : 0

… cpp

benedict-lim-ahrefs · 2025-04-08T09:14:40Z

chrome/browser/cs/android/cs_api_client_service.cc

+  std::string profile_id = profile_->UniqueId();
+  dict.Set("v", profile_id);


Mostly copy paste from cs_handler.cc but set the unique ID from Profile derived from BrowserContext.

benedict-lim-ahrefs · 2025-04-08T09:15:32Z

chrome/browser/cs/android/cs_api_client_service.h

+
+using web_request_helper::WebRequestResult;
+
+class CSApiClientService : public KeyedService {


It has to be a KeyedService so that it can get BrowserContext required to retrieve the unique ID. So, I cannot reuse the existing cs_api_client.cc.

benedict-lim-ahrefs · 2025-04-08T09:16:01Z

chrome/browser/cs/android/cs_api_client_service_factory.cc

+  return instance.get();
+}
+
+CSApiClientServiceFactory::CSApiClientServiceFactory()


I followed the example of start_suggest_service_factory.cc.

benedict-lim-ahrefs · 2025-04-08T09:17:18Z

chrome/browser/cs/android/cs_api_client_module_bridge.cc

+void CSApiClientModuleBridge::Handle(
+  JNIEnv* env,
+  const JavaParamRef<jobject>& obj,
+  const JavaParamRef<jstring>& url


Mostly copy paste from cs_handler.cc but accept Java String as parameter. C++ GURL and Java GURL don't seem to be interoperable.

benedict-lim-ahrefs · 2025-04-08T09:23:10Z

chrome/browser/cs/android/BUILD.gn

+generate_jni("jni_headers") {
+    sources = [ "java/src/org/chromium/chrome/browser/cs/CSApiClientModuleBridge.java" ]
+}


Autogenerated at out/Default/gen/jni_headers/chrome/browser/cs/android/CSApiClientModuleBridge_jni.h.

benedict-lim-ahrefs · 2025-04-08T09:25:03Z

chrome/browser/profiles/chrome_browser_main_extra_parts_profiles.cc

@@ -275,6 +275,7 @@
 #include "chrome/browser/android/webapk/webapk_sync_service_factory.h"
 #include "chrome/browser/auxiliary_search/auxiliary_search_provider.h"
 #include "chrome/browser/commerce/merchant_viewer/merchant_viewer_data_manager_factory.h"
+#include "chrome/browser/cs/android/cs_api_client_service_factory.h"


In order to get Service class instance from Factory within Profile a.k.a BrowserContext, this has to be included.

benedict-lim-ahrefs · 2025-04-08T09:26:08Z

chrome/android/java/src/org/chromium/chrome/browser/app/ChromeActivity.java

+                        CSApiClientModuleBridge csApiClientModuleBridge =
+                            new CSApiClientModuleBridge(tab.getProfile());
+                        csApiClientModuleBridge.handle(url.getSpec());


This is the place for listening to every URL load. There are other specific areas which invokes loadUrl and onLoadUrl etc. but are not universally triggered.

benedict-lim-ahrefs · 2025-04-09T03:01:40Z

@nyinyithann

Although Chromium Android will be frozen for awhile, I think this PR is safe to merge because it does not affect the web client build, except perhaps the initial Ninja build taking some time to compile the Android files.

I am just afraid that there might be conflicts to resolve if I leave this PR unmerged for weeks and months. Please take a look whenever you have the time!

nyinyithann · 2025-04-09T04:53:21Z

Hey @benedict-lim-ahrefs,

Given that the Chromium Android project is currently on hold, I would recommend leaving the PR open instead of merging it into tt135/develop. This is because tt135/develop is based on the canary branch, and I need to continue merging with upstream branches until release time, at which point I will select a stable branch to merge into. This means I have to maintain the Android code and resolve merge conflicts each time I sync with upstream.
Once the Android project is resumed, I will be happy to assist in merging the PR with whichever upstream branch we are using at that time.

nyinyithann · 2025-04-09T05:00:37Z

Or you create your own branch out of tt135/develop and name it probably tt135/android/develop and merge the PR to it for the record. But I would not review the code at this time.

benedict-lim-ahrefs · 2025-04-09T06:03:22Z

This is because tt135/develop is based on the canary branch, and I need to continue merging with upstream branches until release time, at which point I will select a stable branch to merge into. This means I have to maintain the Android code and resolve merge conflicts each time I sync with upstream.

I see... That is a valid concern. In that case, I am fine to keep the PR open until further notice, and I will resolve the conflicts with the upstream branch when I return to the project.

Since I will not develop more features for Android, I will not create an tt135/android/develop intermediate branch.

feat: create android module bridge for cs_api_client

bd51f3f

benedict-lim-ahrefs self-assigned this Apr 2, 2025

benedict-lim-ahrefs marked this pull request as draft April 2, 2025 06:03

benedict-lim-ahrefs added 11 commits April 3, 2025 11:15

feat: create keyed service for web_request_helper (w/o impl yet)

18071b4

feat: create factory for cs_api_client_service

05ecb4f

feat: create cs_api_client_service instance from factory

b6fe258

feat: post data with profile id as identifier

c76c906

refactor: update class name

0929fe9

feat: define method to post cs data

0544b3c

refactor: generate jni method with correct data types for both java &…

bdb551b

… cpp

feat: send clickstream data on searchbar interaction (wip)

35bc307

fix: wrong staging api key

c374a88

feat: send clickstream data on page finish loaded

488e2bc

chore: remove duplicate dependencies

eb82f1f

benedict-lim-ahrefs commented Apr 8, 2025

View reviewed changes

benedict-lim-ahrefs marked this pull request as ready for review April 9, 2025 02:59

benedict-lim-ahrefs requested a review from nyinyithann April 9, 2025 02:59

benedict-lim-ahrefs marked this pull request as draft April 9, 2025 06:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Android] Create module bridge for Telemetry API Client #4

[Android] Create module bridge for Telemetry API Client #4

benedict-lim-ahrefs commented Apr 2, 2025 •

edited

Loading

benedict-lim-ahrefs Apr 8, 2025

benedict-lim-ahrefs Apr 8, 2025

benedict-lim-ahrefs Apr 8, 2025

benedict-lim-ahrefs Apr 8, 2025

benedict-lim-ahrefs Apr 8, 2025

benedict-lim-ahrefs Apr 8, 2025

benedict-lim-ahrefs Apr 8, 2025

benedict-lim-ahrefs commented Apr 9, 2025

nyinyithann commented Apr 9, 2025 •

edited

Loading

nyinyithann commented Apr 9, 2025

benedict-lim-ahrefs commented Apr 9, 2025

		std::string profile_id = profile_->UniqueId();
		dict.Set("v", profile_id);


		using web_request_helper::WebRequestResult;

		class CSApiClientService : public KeyedService {

[Android] Create module bridge for Telemetry API Client #4

Are you sure you want to change the base?

[Android] Create module bridge for Telemetry API Client #4

Conversation

benedict-lim-ahrefs commented Apr 2, 2025 • edited Loading

Background

Details

benedict-lim-ahrefs Apr 8, 2025

Choose a reason for hiding this comment

benedict-lim-ahrefs Apr 8, 2025

Choose a reason for hiding this comment

benedict-lim-ahrefs Apr 8, 2025

Choose a reason for hiding this comment

benedict-lim-ahrefs Apr 8, 2025

Choose a reason for hiding this comment

benedict-lim-ahrefs Apr 8, 2025

Choose a reason for hiding this comment

benedict-lim-ahrefs Apr 8, 2025

Choose a reason for hiding this comment

benedict-lim-ahrefs Apr 8, 2025

Choose a reason for hiding this comment

benedict-lim-ahrefs commented Apr 9, 2025

nyinyithann commented Apr 9, 2025 • edited Loading

nyinyithann commented Apr 9, 2025

benedict-lim-ahrefs commented Apr 9, 2025

benedict-lim-ahrefs commented Apr 2, 2025 •

edited

Loading

nyinyithann commented Apr 9, 2025 •

edited

Loading