mobile: splitting out java utils from cronet (envoyproxy#25944)

moving the network utilities Envoy Mobile depends on out of the cronvoy directories and namespaces. Risk Level: medium: JNI typos cause failures Testing: relying on all utilities having existing tests Docs Changes: n/a Release Notes: n/a Signed-off-by: Alyssa Wilk <[email protected]> Co-authored-by: JP Simard <[email protected]>
lizan · Mar 9, 2023 · 34661f1 · 34661f1
1 parent ee172d2
commit 34661f1
Show file tree

Hide file tree

Showing 29 changed files with 90 additions and 43 deletions.
diff --git a/mobile/library/common/jni/android_jni_utility.cc b/mobile/library/common/jni/android_jni_utility.cc
@@ -20,7 +20,8 @@ bool is_cleartext_permitted(absl::string_view hostname) {
   envoy_data host = Envoy::Data::Utility::copyToBridgeData(hostname);
   JNIEnv* env = get_env();
   jstring java_host = native_data_to_string(env, host);
-  jclass jcls_AndroidNetworkLibrary = find_class("org.chromium.net.AndroidNetworkLibrary");
+  jclass jcls_AndroidNetworkLibrary =
+      find_class("io.envoyproxy.envoymobile.utilities.AndroidNetworkLibrary");
   jmethodID jmid_isCleartextTrafficPermitted = env->GetStaticMethodID(
       jcls_AndroidNetworkLibrary, "isCleartextTrafficPermitted", "(Ljava/lang/String;)Z");
   jboolean result = env->CallStaticBooleanMethod(jcls_AndroidNetworkLibrary,
@@ -37,7 +38,8 @@ bool is_cleartext_permitted(absl::string_view hostname) {
 void tag_socket(int ifd, int uid, int tag) {
 #if defined(__ANDROID_API__)
   JNIEnv* env = get_env();
-  jclass jcls_AndroidNetworkLibrary = find_class("org.chromium.net.AndroidNetworkLibrary");
+  jclass jcls_AndroidNetworkLibrary =
+      find_class("io.envoyproxy.envoymobile.utilities.AndroidNetworkLibrary");
   jmethodID jmid_tagSocket =
       env->GetStaticMethodID(jcls_AndroidNetworkLibrary, "tagSocket", "(III)V");
   env->CallStaticVoidMethod(jcls_AndroidNetworkLibrary, jmid_tagSocket, ifd, uid, tag);

diff --git a/mobile/library/common/jni/android_network_utility.cc b/mobile/library/common/jni/android_network_utility.cc
@@ -11,7 +11,8 @@
 // because AndroidNetworkLibray can be called in non-Android platform with mock interfaces.
 
 bool jvm_cert_is_issued_by_known_root(JNIEnv* env, jobject result) {
-  jclass jcls_AndroidCertVerifyResult = find_class("org.chromium.net.AndroidCertVerifyResult");
+  jclass jcls_AndroidCertVerifyResult =
+      find_class("io.envoyproxy.envoymobile.utilities.AndroidCertVerifyResult");
   jmethodID jmid_isIssuedByKnownRoot =
       env->GetMethodID(jcls_AndroidCertVerifyResult, "isIssuedByKnownRoot", "()Z");
   ASSERT(jmid_isIssuedByKnownRoot);
@@ -21,7 +22,8 @@ bool jvm_cert_is_issued_by_known_root(JNIEnv* env, jobject result) {
 }
 
 envoy_cert_verify_status_t jvm_cert_get_status(JNIEnv* env, jobject j_result) {
-  jclass jcls_AndroidCertVerifyResult = find_class("org.chromium.net.AndroidCertVerifyResult");
+  jclass jcls_AndroidCertVerifyResult =
+      find_class("io.envoyproxy.envoymobile.utilities.AndroidCertVerifyResult");
   jmethodID jmid_getStatus = env->GetMethodID(jcls_AndroidCertVerifyResult, "getStatus", "()I");
   ASSERT(jmid_getStatus);
   envoy_cert_verify_status_t result = CERT_VERIFY_STATUS_FAILED;
@@ -32,7 +34,8 @@ envoy_cert_verify_status_t jvm_cert_get_status(JNIEnv* env, jobject j_result) {
 }
 
 jobjectArray jvm_cert_get_certificate_chain_encoded(JNIEnv* env, jobject result) {
-  jclass jcls_AndroidCertVerifyResult = find_class("org.chromium.net.AndroidCertVerifyResult");
+  jclass jcls_AndroidCertVerifyResult =
+      find_class("io.envoyproxy.envoymobile.utilities.AndroidCertVerifyResult");
   jmethodID jmid_getCertificateChainEncoded =
       env->GetMethodID(jcls_AndroidCertVerifyResult, "getCertificateChainEncoded", "()[[B");
   jobjectArray certificate_chain =
@@ -58,10 +61,11 @@ static void ExtractCertVerifyResult(JNIEnv* env, jobject result, envoy_cert_veri
 jobject call_jvm_verify_x509_cert_chain(JNIEnv* env, const std::vector<std::string>& cert_chain,
                                         std::string auth_type, std::string host) {
   jni_log("[Envoy]", "jvm_verify_x509_cert_chain");
-  jclass jcls_AndroidNetworkLibrary = find_class("org.chromium.net.AndroidNetworkLibrary");
-  jmethodID jmid_verifyServerCertificates =
-      env->GetStaticMethodID(jcls_AndroidNetworkLibrary, "verifyServerCertificates",
-                             "([[B[B[B)Lorg/chromium/net/AndroidCertVerifyResult;");
+  jclass jcls_AndroidNetworkLibrary =
+      find_class("io.envoyproxy.envoymobile.utilities.AndroidNetworkLibrary");
+  jmethodID jmid_verifyServerCertificates = env->GetStaticMethodID(
+      jcls_AndroidNetworkLibrary, "verifyServerCertificates",
+      "([[B[B[B)Lio/envoyproxy/envoymobile/utilities/AndroidCertVerifyResult;");
   jobjectArray chain_byte_array = ToJavaArrayOfByteArray(env, cert_chain);
   jbyteArray auth_string = ToJavaByteArray(env, auth_type);
   jbyteArray host_string = ToJavaByteArray(env, host);

diff --git a/mobile/library/common/jni/jni_interface.cc b/mobile/library/common/jni/jni_interface.cc
@@ -1327,7 +1327,8 @@ extern "C" JNIEXPORT jint JNICALL Java_io_envoyproxy_envoymobile_engine_JniLibra
 static void jvm_add_test_root_certificate(const uint8_t* cert, size_t len) {
   jni_log("[Envoy]", "jvm_add_test_root_certificate");
   JNIEnv* env = get_env();
-  jclass jcls_AndroidNetworkLibrary = find_class("org.chromium.net.AndroidNetworkLibrary");
+  jclass jcls_AndroidNetworkLibrary =
+      find_class("io.envoyproxy.envoymobile.utilities.AndroidNetworkLibrary");
   jmethodID jmid_addTestRootCertificate =
       env->GetStaticMethodID(jcls_AndroidNetworkLibrary, "addTestRootCertificate", "([B)V");
 
@@ -1340,7 +1341,8 @@ static void jvm_add_test_root_certificate(const uint8_t* cert, size_t len) {
 static void jvm_clear_test_root_certificate() {
   jni_log("[Envoy]", "jvm_clear_test_root_certificate");
   JNIEnv* env = get_env();
-  jclass jcls_AndroidNetworkLibrary = find_class("org.chromium.net.AndroidNetworkLibrary");
+  jclass jcls_AndroidNetworkLibrary =
+      find_class("io.envoyproxy.envoymobile.utilities.AndroidNetworkLibrary");
   jmethodID jmid_clearTestRootCertificates =
       env->GetStaticMethodID(jcls_AndroidNetworkLibrary, "clearTestRootCertificates", "()V");
 

diff --git a/mobile/library/common/jni/jni_utility.h b/mobile/library/common/jni/jni_utility.h
@@ -31,7 +31,8 @@ void set_class_loader(jobject class_loader);
  * The method works on Android targets only as the `set_class_loader` method is not
  * called by JVM-only targets.
  *
- * @param class_name, the name of the class to find (i.e. "org.chromium.net.AndroidNetworkLibrary").
+ * @param class_name, the name of the class to find (i.e.
+ * "io.envoyproxy.envoymobile.utilities.AndroidNetworkLibrary").
  *
  * @return jclass, the class with a provided `class_name` or NULL if
  *         it couldn't be found.

diff --git a/mobile/library/java/io/envoyproxy/envoymobile/engine/BUILD b/mobile/library/java/io/envoyproxy/envoymobile/engine/BUILD
@@ -18,6 +18,7 @@ android_library(
     deps = [
         "//library/java/io/envoyproxy/envoymobile/engine:envoy_base_engine_lib",
         "//library/java/io/envoyproxy/envoymobile/engine/types:envoy_c_types_lib",
+        "//library/java/io/envoyproxy/envoymobile/utilities",
         "//library/java/org/chromium/net",
         "@maven//:androidx_annotation_annotation",
         "@maven//:androidx_core_core",

diff --git a/...chromium/net/AndroidCertVerifyResult.java → ...le/utilities/AndroidCertVerifyResult.java b/...chromium/net/AndroidCertVerifyResult.java → ...le/utilities/AndroidCertVerifyResult.java
@@ -1,4 +1,4 @@
-package org.chromium.net;
+package io.envoyproxy.envoymobile.utilities;
 
 import java.security.cert.CertificateEncodingException;
 import java.security.cert.X509Certificate;

diff --git a/...g/chromium/net/AndroidNetworkLibrary.java → ...bile/utilities/AndroidNetworkLibrary.java b/...g/chromium/net/AndroidNetworkLibrary.java → ...bile/utilities/AndroidNetworkLibrary.java
@@ -1,4 +1,4 @@
-package org.chromium.net;
+package io.envoyproxy.envoymobile.utilities;
 
 import android.net.TrafficStats;
 import android.os.ParcelFileDescriptor;

diff --git a/mobile/library/java/io/envoyproxy/envoymobile/utilities/BUILD b/mobile/library/java/io/envoyproxy/envoymobile/utilities/BUILD
@@ -0,0 +1,14 @@
+load("@build_bazel_rules_android//android:rules.bzl", "android_library")
+load("@rules_jvm_external//:defs.bzl", "artifact")
+
+licenses(["notice"])  # Apache 2
+
+android_library(
+    name = "utilities",
+    srcs = glob(["*.java"]),
+    manifest = "UtilitiesManifest.xml",
+    visibility = ["//visibility:public"],
+    deps = [
+        artifact("androidx.annotation:annotation"),
+    ],
+)
diff --git a/...chromium/net/CertVerifyStatusAndroid.java → ...le/utilities/CertVerifyStatusAndroid.java b/...chromium/net/CertVerifyStatusAndroid.java → ...le/utilities/CertVerifyStatusAndroid.java
@@ -1,4 +1,4 @@
-package org.chromium.net;
+package io.envoyproxy.envoymobile.utilities;
 
 import androidx.annotation.IntDef;
 

diff --git a/...y/java/org/chromium/net/ContextUtils.java → ...y/envoymobile/utilities/ContextUtils.java b/...y/java/org/chromium/net/ContextUtils.java → ...y/envoymobile/utilities/ContextUtils.java
@@ -1,4 +1,4 @@
-package org.chromium.net;
+package io.envoyproxy.envoymobile.utilities;
 
 import android.app.Activity;
 import android.app.Application;

diff --git a/...y/java/org/chromium/net/FakeX509Util.java → ...y/envoymobile/utilities/FakeX509Util.java b/...y/java/org/chromium/net/FakeX509Util.java → ...y/envoymobile/utilities/FakeX509Util.java
@@ -1,4 +1,4 @@
-package org.chromium.net;
+package io.envoyproxy.envoymobile.utilities;
 
 import java.util.ArrayList;
 import java.util.Arrays;

diff --git a/...a/org/chromium/net/StrictModeContext.java → ...oymobile/utilities/StrictModeContext.java b/...a/org/chromium/net/StrictModeContext.java → ...oymobile/utilities/StrictModeContext.java
@@ -1,4 +1,4 @@
-package org.chromium.net;
+package io.envoyproxy.envoymobile.utilities;
 
 import android.os.Build;
 import android.os.StrictMode;

diff --git a/...org/chromium/net/impl/ThreadStatsUid.java → ...envoymobile/utilities/ThreadStatsUid.java b/...org/chromium/net/impl/ThreadStatsUid.java → ...envoymobile/utilities/ThreadStatsUid.java
@@ -1,4 +1,4 @@
-package org.chromium.net.impl;
+package io.envoyproxy.envoymobile.utilities;
 
 import android.net.TrafficStats;
 import java.lang.reflect.InvocationTargetException;

diff --git a/mobile/library/java/io/envoyproxy/envoymobile/utilities/UtilitiesManifest.xml b/mobile/library/java/io/envoyproxy/envoymobile/utilities/UtilitiesManifest.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="io.envoyproxy.envoymobile.utilities">
+    <uses-sdk
+            android:minSdkVersion="21"
+            android:targetSdkVersion="29"/>
+
+</manifest>
diff --git a/...brary/java/org/chromium/net/X509Util.java → ...proxy/envoymobile/utilities/X509Util.java b/...brary/java/org/chromium/net/X509Util.java → ...proxy/envoymobile/utilities/X509Util.java
@@ -1,4 +1,4 @@
-package org.chromium.net;
+package io.envoyproxy.envoymobile.utilities;
 
 import android.content.BroadcastReceiver;
 import android.content.Context;

diff --git a/mobile/library/java/org/chromium/net/BUILD b/mobile/library/java/org/chromium/net/BUILD
@@ -12,6 +12,7 @@ android_library(
     manifest = "ChromiumNetManifest.xml",
     visibility = ["//visibility:public"],
     deps = [
+        "//library/java/io/envoyproxy/envoymobile/utilities",
         artifact("androidx.annotation:annotation"),
     ],
 )

diff --git a/mobile/library/java/org/chromium/net/impl/BUILD b/mobile/library/java/org/chromium/net/impl/BUILD
@@ -41,7 +41,6 @@ android_library(
         "Preconditions.java",
         "QuicExceptionImpl.java",
         "RequestFinishedInfoImpl.java",
-        "ThreadStatsUid.java",
         "UrlRequestBase.java",
         "UrlRequestBuilderImpl.java",
         "UrlResponseInfoImpl.java",
@@ -54,6 +53,7 @@ android_library(
         "//library/java/io/envoyproxy/envoymobile/engine:envoy_base_engine_lib",
         "//library/java/io/envoyproxy/envoymobile/engine:envoy_engine_lib",
         "//library/java/io/envoyproxy/envoymobile/engine/types:envoy_c_types_lib",
+        "//library/java/io/envoyproxy/envoymobile/utilities",
         "//library/java/org/chromium/net",
         "//library/java/org/chromium/net/urlconnection",
         artifact("androidx.annotation:annotation"),

diff --git a/mobile/library/java/org/chromium/net/impl/JavaUrlRequest.java b/mobile/library/java/org/chromium/net/impl/JavaUrlRequest.java
@@ -37,6 +37,7 @@
 import org.chromium.net.UrlResponseInfo;
 import org.chromium.net.impl.Executors.CheckedRunnable;
 import org.chromium.net.impl.Executors.DirectPreventingExecutor;
+import io.envoyproxy.envoymobile.utilities.ThreadStatsUid;
 
 /**
  * Pure java UrlRequest, backed by {@link HttpURLConnection}.

diff --git a/mobile/library/java/org/chromium/net/urlconnection/BUILD b/mobile/library/java/org/chromium/net/urlconnection/BUILD
@@ -23,6 +23,7 @@ android_library(
     manifest = "URLConnectionManifest.xml",
     visibility = ["//visibility:public"],
     deps = [
+        "//library/java/io/envoyproxy/envoymobile/utilities",
         "//library/java/org/chromium/net",
         artifact("androidx.annotation:annotation"),
     ],

diff --git a/mobile/library/kotlin/io/envoyproxy/envoymobile/BUILD b/mobile/library/kotlin/io/envoyproxy/envoymobile/BUILD
@@ -33,6 +33,7 @@ kt_android_library(
         "//library/java/io/envoyproxy/envoymobile/engine:envoy_base_engine_lib",
         "//library/java/io/envoyproxy/envoymobile/engine:envoy_engine_lib",
         "//library/java/io/envoyproxy/envoymobile/engine/types:envoy_c_types_lib",
+        "//library/java/io/envoyproxy/envoymobile/utilities",
     ],
 )
 

diff --git a/mobile/library/proguard.txt b/mobile/library/proguard.txt
@@ -11,11 +11,11 @@
     native <methods>;
 }
 
--keep, includedescriptorclasses class org.chromium.net.AndroidNetworkLibrary {
+-keep, includedescriptorclasses class io.envoyproxy.envoymobile.utilities.AndroidNetworkLibrary {
    <methods>;
 }
 
--keep, includedescriptorclasses class org.chromium.net.AndroidCertVerifyResult {
+-keep, includedescriptorclasses class io.envoyproxy.envoymobile.utilities.AndroidCertVerifyResult {
    <methods>;
 }
 

diff --git a/mobile/test/java/io/envoyproxy/envoymobile/utilities/BUILD b/mobile/test/java/io/envoyproxy/envoymobile/utilities/BUILD
@@ -0,0 +1,23 @@
+load("@envoy//bazel:envoy_build_system.bzl", "envoy_package")
+load("@envoy_mobile//bazel:kotlin_test.bzl", "envoy_mobile_android_test")
+
+licenses(["notice"])  # Apache 2
+
+envoy_package()
+
+envoy_mobile_android_test(
+    name = "certificate_verification_tests",
+    srcs = [
+        "CertificateVerificationTest.java",
+    ],
+    native_deps = [
+        "//test/common/jni:libenvoy_jni_with_test_extensions.so",
+        "//test/common/jni:libenvoy_jni_with_test_extensions_jnilib",
+    ],
+    deps = [
+        "//library/java/io/envoyproxy/envoymobile/engine:envoy_base_engine_lib",
+        "//library/java/io/envoyproxy/envoymobile/engine:envoy_engine_lib",
+        "//library/java/io/envoyproxy/envoymobile/utilities",
+        "//library/java/org/chromium/net",
+    ],
+)
diff --git a/...mium/net/CertificateVerificationTest.java → ...tilities/CertificateVerificationTest.java b/...mium/net/CertificateVerificationTest.java → ...tilities/CertificateVerificationTest.java
@@ -1,4 +1,4 @@
-package org.chromium.net;
+package io.envoyproxy.envoymobile.utilities;
 
 import static org.junit.Assert.assertEquals;
 

diff --git a/mobile/test/java/org/chromium/net/BUILD b/mobile/test/java/org/chromium/net/BUILD
@@ -28,6 +28,7 @@ envoy_mobile_android_test(
     deps = [
         "//library/java/io/envoyproxy/envoymobile/engine:envoy_base_engine_lib",
         "//library/java/io/envoyproxy/envoymobile/engine:envoy_engine_lib",
+        "//library/java/io/envoyproxy/envoymobile/utilities",
         "//library/java/org/chromium/net",
         "//library/java/org/chromium/net/impl:cronvoy",
         "//library/kotlin/io/envoyproxy/envoymobile:envoy_interfaces_lib",
@@ -36,22 +37,6 @@ envoy_mobile_android_test(
     ],
 )
 
-envoy_mobile_android_test(
-    name = "certificate_verification_tests",
-    srcs = [
-        "CertificateVerificationTest.java",
-    ],
-    native_deps = [
-        "//test/common/jni:libenvoy_jni_with_test_extensions.so",
-        "//test/common/jni:libenvoy_jni_with_test_extensions_jnilib",
-    ],
-    deps = [
-        "//library/java/io/envoyproxy/envoymobile/engine:envoy_base_engine_lib",
-        "//library/java/io/envoyproxy/envoymobile/engine:envoy_engine_lib",
-        "//library/java/org/chromium/net",
-    ],
-)
-
 envoy_mobile_android_test(
     name = "cronet_url_request_context_test",
     srcs = [

diff --git a/mobile/test/java/org/chromium/net/impl/BUILD b/mobile/test/java/org/chromium/net/impl/BUILD
@@ -25,6 +25,7 @@ envoy_mobile_android_test(
     deps = [
         "//library/java/io/envoyproxy/envoymobile/engine:envoy_base_engine_lib",
         "//library/java/io/envoyproxy/envoymobile/engine:envoy_engine_lib",
+        "//library/java/io/envoyproxy/envoymobile/utilities",
         "//library/java/org/chromium/net",
         "//library/java/org/chromium/net/impl:cronvoy",
         "//library/kotlin/io/envoyproxy/envoymobile:envoy_interfaces_lib",

diff --git a/mobile/test/java/org/chromium/net/testing/BUILD b/mobile/test/java/org/chromium/net/testing/BUILD
@@ -36,6 +36,7 @@ android_library(
     deps = [
         "//library/java/io/envoyproxy/envoymobile/engine:envoy_base_engine_lib",
         "//library/java/io/envoyproxy/envoymobile/engine:envoy_engine_lib",
+        "//library/java/io/envoyproxy/envoymobile/utilities",
         "//library/java/org/chromium/net",
         "//library/java/org/chromium/net/impl:cronvoy",
         "//library/kotlin/io/envoyproxy/envoymobile:envoy_interfaces_lib",

diff --git a/mobile/test/java/org/chromium/net/testing/CronetTestRule.java b/mobile/test/java/org/chromium/net/testing/CronetTestRule.java
@@ -33,7 +33,7 @@
 import org.junit.rules.TestRule;
 import org.junit.runner.Description;
 import org.junit.runners.model.Statement;
-import org.chromium.net.AndroidNetworkLibrary;
+import io.envoyproxy.envoymobile.utilities.AndroidNetworkLibrary;
 
 /**
  * Custom TestRule for Cronet instrumentation tests.

diff --git a/mobile/test/java/org/chromium/net/testing/Http2TestServerTest.java b/mobile/test/java/org/chromium/net/testing/Http2TestServerTest.java
@@ -9,7 +9,7 @@
 import android.content.Context;
 import androidx.test.core.app.ApplicationProvider;
 import androidx.test.ext.junit.runners.AndroidJUnit4;
-import org.chromium.net.AndroidNetworkLibrary;
+import io.envoyproxy.envoymobile.utilities.AndroidNetworkLibrary;
 import io.envoyproxy.envoymobile.AndroidEngineBuilder;
 import io.envoyproxy.envoymobile.Engine;
 import io.envoyproxy.envoymobile.EnvoyError;
@@ -40,7 +40,7 @@
 import org.robolectric.RobolectricTestRunner;
 import java.nio.charset.StandardCharsets;
 import org.chromium.net.testing.CertTestUtil;
-import org.chromium.net.FakeX509Util;
+import io.envoyproxy.envoymobile.utilities.FakeX509Util;
 
 @RunWith(RobolectricTestRunner.class)
 public class Http2TestServerTest {

diff --git a/mobile/test/java/org/chromium/net/urlconnection/BUILD b/mobile/test/java/org/chromium/net/urlconnection/BUILD
@@ -28,6 +28,7 @@ envoy_mobile_android_test(
     deps = [
         "//library/java/io/envoyproxy/envoymobile/engine:envoy_base_engine_lib",
         "//library/java/io/envoyproxy/envoymobile/engine:envoy_engine_lib",
+        "//library/java/io/envoyproxy/envoymobile/utilities",
         "//library/java/org/chromium/net",
         "//library/java/org/chromium/net/impl:cronvoy",
         "//library/java/org/chromium/net/urlconnection",