[proguard] Include proguard info in sourcefile attribute.

Instead of setting the sourcefile to PG when obfuscating Java, set it
to :chromium:{mapping file}:{channel}:{version code} so that

a) We can recognise chrome/webview stack frames by this string
b) The information required to uniquely identify the proguard mapping
   file in question is directly available in stack traces.

Bug: 1044585
Change-Id: Ib4fabccfb7693e5e97edc6f29be1cd6cb61fa1e6
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2036091
Commit-Queue: Tobias Sargeant <tobiasjs@chromium.org>
Reviewed-by: Andrew Grieve <agrieve@chromium.org>
Reviewed-by: Piotr Bialecki <bialpio@chromium.org>
Reviewed-by: Richard Coles <torne@chromium.org>
Cr-Commit-Position: refs/heads/master@{#740625}

android_webview/system_webview_apk_tmpl.gni

@@ -3,7 +3,6 @@
 # found in the LICENSE file.
 
 import("//android_webview/variables.gni")
-import("//base/android/proguard/proguard.gni")
 import("//build/config/android/config.gni")
 import("//build/config/android/rules.gni")
 import("//build/config/locales.gni")

android_webview/variables.gni

@@ -2,7 +2,7 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
-import("//chrome/android/channel.gni")
+import("//build/config/android/channel.gni")
 import("//weblayer/variables.gni")
 
 declare_args() {

base/android/proguard/enable_obfuscation.flags

@@ -4,5 +4,4 @@
 
 # As of August 11, 2016, obfuscation was found to save 660kb on our .dex size
 # and 53kb memory/process (through shrinking method/string counts).
--renamesourcefileattribute PG
 -repackageclasses ''

base/android/proguard/proguard.gni

-# Copyright 2018 The Chromium Authors. All rights reserved.
-# Use of this source code is governed by a BSD-style license that can be
-# found in the LICENSE file.
-
-declare_args() {
-  # Controls whether proguard obfuscation is enabled for targets
-  # configured to use it.
-  enable_proguard_obfuscation = true
-}

build/android/gyp/proguard.py

@@ -160,6 +160,7 @@ def _ParseOptions():
       '--disable-checkdiscard',
       action='store_true',
       help='Disable -checkdiscard directives')
+  parser.add_argument('--sourcefile', help='Value for source file attribute')
 
   options = parser.parse_args(args)
 
@@ -380,6 +381,10 @@ def _CreateDynamicConfig(options):
   public static final int SDK_INT return %s..9999;
 }""" % options.min_api)
 
+  if options.sourcefile:
+    ret.append("-renamesourcefileattribute '%s' # OMIT FROM EXPECTATIONS" %
+               options.sourcefile)
+
   if options.apply_mapping:
     ret.append("-applymapping '%s'" % os.path.abspath(options.apply_mapping))
   if options.repackage_classes:

build/android/gyp/util/diff_utils.py

@@ -10,11 +10,24 @@ import difflib
 from util import build_utils
 
 
+def _SkipOmitted(line):
+  """
+  Skip lines that are to be intentionally omitted from the expectations file.
+
+  This is required when the file to be compared against expectations contains
+  a line that changes from build to build because - for instance - it contains
+  version information.
+  """
+  if line.endswith('# OMIT FROM EXPECTATIONS\n'):
+    return '# THIS LINE WAS OMITTED\n'
+  return line
+
+
 def DiffFileContents(expected_path, actual_path):
   """Check file contents for equality and return the diff or None."""
   with open(expected_path) as f_expected, open(actual_path) as f_actual:
     expected_lines = f_expected.readlines()
-    actual_lines = f_actual.readlines()
+    actual_lines = [_SkipOmitted(line) for line in f_actual]
 
   if expected_lines == actual_lines:
     return None

build/config/android/channel.gni

+# Copyright 2014 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+declare_args() {
+  # The channel to build on Android: stable, beta, dev, canary, work, or
+  # default. "default" should be used on non-official builds.
+  android_channel = "default"
+}
+
+assert(android_channel == "default" || android_channel == "canary" ||
+           android_channel == "dev" || android_channel == "beta" ||
+           android_channel == "stable",
+       "Invalid channel: " + android_channel)

build/config/android/config.gni

@@ -200,6 +200,10 @@ if (is_android || is_chromeos) {
 
     # Enable the chrome build for devices without touchscreens.
     notouch_build = false
+
+    # Controls whether proguard obfuscation is enabled for targets
+    # configured to use it.
+    enable_proguard_obfuscation = true
   }
 
   assert(!(check_android_configuration && is_java_debug),

build/config/android/internal_rules.gni

@@ -987,6 +987,20 @@ if (enable_java_templates) {
         "@FileArg($_rebased_build_config:android:sdk_jars)",
       ]
 
+      if (enable_proguard_obfuscation) {
+        # This is generally the apk name, and serves to identify the mapping
+        # file that would be required to deobfuscate a stacktrace.
+        _mapping_id = get_path_info(_mapping_path, "name")
+        _suffix = ""
+        if (defined(invoker.proguard_sourcefile_suffix)) {
+          _suffix = "-${invoker.proguard_sourcefile_suffix}"
+        }
+        args += [
+          "--sourcefile",
+          "chromium-${_mapping_id}${_suffix}",
+        ]
+      }
+
       if (defined(invoker.disable_r8_outlining) &&
           invoker.disable_r8_outlining) {
         args += [ "--disable-outlining" ]
@@ -1156,6 +1170,7 @@ if (enable_java_templates) {
                                  "proguard_expectations_file",
                                  "proguard_jar_path",
                                  "proguard_mapping_path",
+                                 "proguard_sourcefile_suffix",
                                  "is_static_library",
                                  "testonly",
                                ])

build/config/android/rules.gni

@@ -5,6 +5,7 @@
 # Do not add any imports to non-//build directories here.
 # Some projects (e.g. V8) do not have non-build directories DEPS'ed in.
 
+import("//build/config/android/channel.gni")
 import("//build/config/android/config.gni")
 import("//build/config/android/internal_rules.gni")
 import("//build/config/clang/clang.gni")
@@ -2335,6 +2336,7 @@ if (enable_java_templates) {
 
     _proguard_enabled =
         defined(invoker.proguard_enabled) && invoker.proguard_enabled
+
     if (!_is_bundle_module && _proguard_enabled) {
       _proguard_mapping_path = "$_final_apk_path.mapping"
     }
@@ -2931,6 +2933,7 @@ if (enable_java_templates) {
           forward_variables_from(invoker, [ "proguard_jar_path" ])
           deps += _deps + [ ":$_compile_resources_target" ]
           proguard_mapping_path = _proguard_mapping_path
+          proguard_sourcefile_suffix = "$android_channel-$_version_code"
         } else {
           input_dex_filearg =
               "@FileArg(${_rebased_build_config}:final_dex:all_dex_files)"
@@ -4416,6 +4419,18 @@ if (enable_java_templates) {
     _proguard_enabled =
         defined(invoker.proguard_enabled) && invoker.proguard_enabled
 
+    if (_proguard_enabled) {
+      if (defined(invoker.version_code)) {
+        _version_code = invoker.version_code
+      } else {
+        _version_code = android_default_version_code
+      }
+
+      if (android_override_version_code != "") {
+        _version_code = android_override_version_code
+      }
+    }
+
     _bundle_base_path = "$root_build_dir/apks"
     if (defined(invoker.bundle_base_path)) {
       _bundle_base_path = invoker.bundle_base_path
@@ -4618,15 +4633,16 @@ if (enable_java_templates) {
               "/java/$_target_name.proguard_flags.expected"
         }
         dex(_sync_dex_target) {
-          enable_multidex = _enable_multidex
-          proguard_enabled = true
-          proguard_mapping_path = _proguard_mapping_path
           forward_variables_from(invoker,
                                  [
                                    "failed_proguard_expectation_file",
                                    "proguard_jar_path",
                                    "min_sdk_version",
                                  ])
+          enable_multidex = _enable_multidex
+          proguard_enabled = true
+          proguard_mapping_path = _proguard_mapping_path
+          proguard_sourcefile_suffix = "$android_channel-$_version_code"
           build_config = _build_config
 
           if (_verify_proguard_flags) {

chrome/android/channel.gni

-# Copyright 2014 The Chromium Authors. All rights reserved.
+# Copyright 2020 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
-declare_args() {
-  # The channel to build on Android: stable, beta, dev, canary, work, or
-  # default. "default" should be used on non-official builds.
-  android_channel = "default"
-}
-
-assert(android_channel == "default" || android_channel == "canary" ||
-           android_channel == "dev" || android_channel == "beta" ||
-           android_channel == "stable",
-       "Invalid channel: " + android_channel)
+# Keep internal compiling
+import("//build/config/android/channel.gni")

chrome/android/chrome_public_apk_tmpl.gni

@@ -4,7 +4,6 @@
 
 import("//android_webview/variables.gni")
 import("//base/android/linker/config.gni")
-import("//base/android/proguard/proguard.gni")
 import("//build/config/android/extract_unwind_tables.gni")
 import("//build/config/android/rules.gni")
 import("//build/config/compiler/compiler.gni")

chrome/android/java/monochrome_public_bundle.proguard_flags.expected

@@ -252,7 +252,6 @@
 
 # As of August 11, 2016, obfuscation was found to save 660kb on our .dex size
 # and 53kb memory/process (through shrinking method/string counts).
--renamesourcefileattribute PG
 -repackageclasses ''
 
 ################################################################################
@@ -750,6 +749,7 @@
 ################################################################################
 # Dynamically generated from build/android/gyp/proguard.py
 ################################################################################
+# THIS LINE WAS OMITTED
 -keep @interface org.chromium.base.annotations.VerifiesOnNMR1
 -keep,allowobfuscation,allowoptimization @org.chromium.base.annotations.VerifiesOnNMR1 class ** {
   <methods>;

chrome/android/java/src/org/chromium/chrome/browser/usage_stats/features.gni

@@ -2,8 +2,8 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
+import("//build/config/android/channel.gni")
 import("//build/config/android/config.gni")
-import("//chrome/android/channel.gni")
 
 declare_args() {
   enable_usage_stats = android_channel == "default" ||

chrome/android/modules/chrome_bundle_tmpl.gni

@@ -82,6 +82,9 @@ template("chrome_bundle") {
                            ])
     command_line_flags_file = "chrome-command-line"
     proguard_enabled = !is_java_debug
+    if (proguard_enabled) {
+      version_code = invoker.version_code
+    }
     enable_language_splits = true
     extra_modules = _extra_modules
     system_image_locale_whitelist = android_apk_locales

chrome/android/trichrome.gni

@@ -2,7 +2,6 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
-import("//base/android/proguard/proguard.gni")
 import("//build/config/android/config.gni")
 import("//build/config/android/rules.gni")
 import("//build/util/version.gni")

components/version_info/android/BUILD.gn

@@ -2,9 +2,9 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
+import("//build/config/android/channel.gni")
 import("//build/config/android/rules.gni")
 import("//build/util/process_version.gni")
-import("//chrome/android/channel.gni")
 
 _version_constants_java_file = "$target_gen_dir/java/org/chromium/components/version_info/VersionConstants.java"
 

device/vr/buildflags/buildflags.gni

@@ -5,7 +5,6 @@
 import("//build/config/chrome_build.gni")
 import("//build/config/chromecast_build.gni")
 import("//build/config/gclient_args.gni")
-import("//chrome/android/channel.gni")
 
 declare_args() {
   enable_gvr_services = is_android && !is_chromecast &&