suppress deprecation warnings in generated code (#1395)

* suppress deprecation warnings in generated code

* Fixed some warnings

* added an option to check for warnings and fail

Author: vtrifonov

test-app/app/build.gradle

@@ -411,6 +411,13 @@ task addDependenciesFromAppResourcesLibraries {
     }
 }
 
+if (failOnCompilationWarningsEnabled()) {
+    tasks.withType(JavaCompile) {
+        options.compilerArgs << '-Xlint:all' << "-Werror"
+        options.deprecation = true
+    }
+}
+
 tasks.whenTaskAdded({ org.gradle.api.DefaultTask currentTask ->
     if (currentTask =~ /generate.+BuildConfig/) {
         currentTask.finalizedBy(extractAllJars)
@@ -445,7 +452,15 @@ task runSbg(type: JavaExec) {
 
     workingDir "$BUILD_TOOLS_PATH"
     main "-jar"
-    args "static-binding-generator.jar"
+
+    def paramz = new ArrayList<String>()
+    paramz.add("static-binding-generator.jar")
+
+    if (failOnCompilationWarningsEnabled()) {
+        paramz.add("-show-deprecation-warnings")
+    }
+
+    args paramz
 
     doFirst {
         new File("$OUTPUT_JAVA_DIR/com/tns/gen").deleteDir()
@@ -459,6 +474,10 @@ task ensureMetadataOutDir {
     }
 }
 
+def failOnCompilationWarningsEnabled() {
+    return project.hasProperty("failOnCompilationWarnings") && (failOnCompilationWarnings || failOnCompilationWarnings.toBoolean())
+}
+
 def explodeAar(File compileDependency, File outputDir) {
     logger.info("explodeAar: Extracting ${compileDependency.path} -> ${outputDir.path}")
 

test-app/app/src/debug/java/com/tns/ErrorReport.java

@@ -318,6 +318,7 @@ private class Pager extends FragmentStatePagerAdapter {
 
         int tabCount;
 
+        @SuppressWarnings("deprecation")
         public Pager(FragmentManager fm, int tabCount) {
             super(fm);
             this.tabCount = tabCount;

test-app/app/src/debug/java/com/tns/NativeScriptSyncService.java

@@ -40,7 +40,7 @@ public class NativeScriptSyncService {
 
     public NativeScriptSyncService(Runtime runtime, Logger logger, Context context) {
         this.runtime = runtime;
-        this.logger = logger;
+        NativeScriptSyncService.logger = logger;
         this.context = context;
 
         syncPath = SYNC_ROOT_SOURCE_DIR + context.getPackageName() + SYNC_SOURCE_DIR;

test-app/app/src/debug/java/com/tns/NativeScriptSyncServiceSocketImpl.java

@@ -25,7 +25,7 @@ public class NativeScriptSyncServiceSocketImpl {
 
     public NativeScriptSyncServiceSocketImpl(Runtime runtime, Logger logger, Context context) {
         this.runtime = runtime;
-        this.logger = logger;
+        NativeScriptSyncServiceSocketImpl.logger = logger;
         this.context = context;
         DEVICE_APP_DIR = this.context.getFilesDir().getAbsolutePath() + "/app";
     }

test-app/app/src/main/java/com/tns/DefaultExtractPolicy.java

@@ -15,6 +15,8 @@
 import android.content.pm.PackageManager;
 import android.content.pm.PackageManager.NameNotFoundException;
 
+import androidx.core.content.pm.PackageInfoCompat;
+
 import com.tns.Logger;
 import com.tns.ExtractPolicy;
 import com.tns.FileExtractor;
@@ -67,9 +69,9 @@ public String getAssetsThumb(Context context) {
     private String generateAssetsThumb(Context context) {
         try {
             PackageInfo packageInfo = context.getPackageManager().getPackageInfo(context.getPackageName(), 0);
-            int code = packageInfo.versionCode;
+            long code = PackageInfoCompat.getLongVersionCode(packageInfo);
             long updateTime = packageInfo.lastUpdateTime;
-            return String.valueOf(updateTime) + "-" + String.valueOf(code);
+            return updateTime + "-" + code;
         } catch (NameNotFoundException e) {
             logger.write("Error while getting current assets thumb");
             e.printStackTrace();

test-app/app/src/main/java/com/tns/RuntimeHelper.java

@@ -34,10 +34,10 @@ private static boolean hasErrorIntent(Context context) {
             // empty file just to check if there was a raised uncaught error by
             // ErrorReport
             if (Util.isDebuggableApp(context)) {
-                String fileName = "";
+                String fileName;
 
                 try {
-                    Class ErrReport = Class.forName("com.tns.ErrorReport");
+                    Class<?> ErrReport = Class.forName("com.tns.ErrorReport");
                     Field field = ErrReport.getDeclaredField("ERROR_FILE_NAME");
                     fileName = (String) field.get(null);
                 } catch (Exception e) {
@@ -310,10 +310,10 @@ public static void initLiveSync(Runtime runtime, Logger logger, Context context)
         // runtime needs to be initialized before the NativeScriptSyncService is enabled because it uses runtime.runScript(...)
         try {
             @SuppressWarnings("unchecked")
-            Class NativeScriptSyncService = Class.forName("com.tns.NativeScriptSyncServiceSocketImpl");
+            Class<?> NativeScriptSyncService = Class.forName("com.tns.NativeScriptSyncServiceSocketImpl");
 
             @SuppressWarnings("unchecked")
-            Constructor cons = NativeScriptSyncService.getConstructor(new Class[]{Runtime.class, Logger.class, Context.class});
+            Constructor<?> cons = NativeScriptSyncService.getConstructor(new Class<?>[]{Runtime.class, Logger.class, Context.class});
             Object syncService = cons.newInstance(runtime, logger, context);
 
             @SuppressWarnings("unchecked")

test-app/app/src/main/java/com/tns/Util.java

@@ -11,15 +11,17 @@
 import android.content.pm.PackageManager.NameNotFoundException;
 import android.os.Bundle;
 
+import androidx.core.content.pm.PackageInfoCompat;
+
 public final class Util {
     private Util() {
     }
 
     public static String getDexThumb(Context context) throws NameNotFoundException {
         PackageInfo packageInfo = context.getPackageManager().getPackageInfo(context.getPackageName(), 0);
-        int code = packageInfo.versionCode;
+        long code = PackageInfoCompat.getLongVersionCode(packageInfo);
         long updateTime = packageInfo.lastUpdateTime;
-        return String.valueOf(updateTime) + "-" + String.valueOf(code);
+        return updateTime + "-" + code;
     }
 
     public static boolean isDebuggableApp(Context context) {

test-app/build-tools/static-binding-generator/src/main/java/org/nativescript/staticbindinggenerator/Generator.java

@@ -78,13 +78,13 @@ public class Generator {
     private Set<String> nonPublicNestedClasses;
 
     public Generator(File outputDir, List<DataRow> libs) throws IOException {
-        this(outputDir, libs, false, false);
+        this(outputDir, libs, false);
     }
 
-    public Generator(File outputDir, List<DataRow> libs, boolean suppressCallJSMethodExceptions, boolean throwOnError) throws IOException {
+    public Generator(File outputDir, List<DataRow> libs, boolean suppressCallJSMethodExceptions) throws IOException {
         this.outputDir = outputDir;
         this.libs = libs;
-        this.fileSystemHelper = new FileSystemHelperImpl(throwOnError);
+        this.fileSystemHelper = new FileSystemHelperImpl(InputParameters.getCurrent().getThrowOnError());
         ClassesCollection classesCollection = readClasses(libs);
         this.classes = classesCollection.getRegularClasses();
         this.nonPublicNestedClasses = classesCollection.getNonPublicNestedClasses();
@@ -443,16 +443,19 @@ private void writeMethodsToWriter(Writer writer, GenericHierarchyView genericHie
         for (ReifiedJavaMethod abstractMethod : inheritedMethodsView.getNonImplementedMethods()) {
             writer.writeln();
             writer.writeln();
-            methodsWriter.writeMethod(abstractMethod);
+            methodsWriter.writeMethod(abstractMethod, false);
         }
 
-        for (ReifiedJavaMethod overridableMethod : inheritedMethodsView.getOverridableImplementedMethods()) {
+        List<ReifiedJavaMethod> overridableImplementedMethods = inheritedMethodsView.getOverridableImplementedMethods();
+
+        for (ReifiedJavaMethod overridableMethod : overridableImplementedMethods) {
             for (String userImplementedMethodName : userImplementedMethods) {
                 if (overridableMethod.getName().equals(userImplementedMethodName)) {
                     if (areAllArgumentsAndReturnTypePublic(overridableMethod)) {
                         writer.writeln();
                         writer.writeln();
-                        methodsWriter.writeMethod(overridableMethod);
+                        boolean isUserImplemented = !overridableMethod.isDeprecated() || !hasNonDeprecatedImplementation(overridableMethod, overridableImplementedMethods);
+                        methodsWriter.writeMethod(overridableMethod, isUserImplemented);
                     }
                 }
             }
@@ -471,6 +474,22 @@ private void writeMethodsToWriter(Writer writer, GenericHierarchyView genericHie
         methodsWriter.writeInternalRuntimeEqualsMethod();
     }
 
+    /**
+     * Checks whether in the list of implemented methods there's another method with the same name which is not deprecated.
+     * In that case we'll consider that method as user implemented, but not the current one
+     *
+     * @private
+     * @param {ReifiedJavaMethod} currentMethod The method to check.
+     * @param {List<ReifiedJavaMethod>} allOverridableMethods The list will all the overridable methods to check in.
+     * @returns {boolean} Returns true or false.
+     */
+    private boolean hasNonDeprecatedImplementation(ReifiedJavaMethod currentMethod, List<ReifiedJavaMethod> allOverridableMethods) {
+        return allOverridableMethods.stream().anyMatch(method ->
+                method != currentMethod
+                        && method.getName().equals(currentMethod.getName())
+                        && !method.isDeprecated());
+    }
+
     private boolean hasOverriddenOnCreateMethod(List<String> overriddenMethods) {
         return overriddenMethods.contains("onCreate");
     }

test-app/build-tools/static-binding-generator/src/main/java/org/nativescript/staticbindinggenerator/InputParameters.java

@@ -0,0 +1,59 @@
+package org.nativescript.staticbindinggenerator;
+
+public class InputParameters {
+
+    // if the flag is passed the deprecation warnings will not be suppressed
+    private static final String SHOW_DEPRECATION_WARNINGS = "-show-deprecation-warnings";
+    // if the flag is passed the generation will exit on error
+    private static final String THROW_ON_ERROR = "-throw-on-error";
+
+    private static InputParameters current = new InputParameters();
+
+    private boolean showDeprecationWarnings;
+    private boolean throwOnError;
+
+    public InputParameters() {
+        this.showDeprecationWarnings = false;
+        this.throwOnError = false;
+    }
+
+    public void setShowDeprecationWarnings(boolean value) {
+        this.showDeprecationWarnings = value;
+    }
+
+    public boolean getSuppressDeprecationWarnings() {
+        return !showDeprecationWarnings;
+    }
+
+    public void setThrowOnError(boolean value) {
+        this.throwOnError = value;
+    }
+
+    public boolean getThrowOnError() {
+        return throwOnError;
+    }
+
+    public static void parseCommand(String[] args) {
+        InputParameters inputParameters = new InputParameters();
+
+        if (args != null) {
+            for (int i = 0; i < args.length; i++) {
+                String commandArg = args[i];
+
+                if (commandArg.equals(SHOW_DEPRECATION_WARNINGS)) {
+                    inputParameters.setShowDeprecationWarnings(true);
+                }
+
+                if (commandArg.equals(THROW_ON_ERROR)) {
+                    inputParameters.setThrowOnError(true);
+                }
+            }
+        }
+
+        InputParameters.current = inputParameters;
+    }
+
+    public static InputParameters getCurrent() {
+        return InputParameters.current;
+    }
+}

test-app/build-tools/static-binding-generator/src/main/java/org/nativescript/staticbindinggenerator/Main.java

@@ -33,6 +33,8 @@ public class Main {
     }
 
     public static void main(String[] args) throws IOException, ClassNotFoundException {
+        InputParameters.parseCommand(args);
+
         validateInput();
 
         getWorkerExcludeFile();
@@ -44,7 +46,7 @@ public static void main(String[] args) throws IOException, ClassNotFoundExceptio
 
         // generate java bindings
         String inputBindingFilename = Paths.get(System.getProperty("user.dir"), SBG_BINDINGS_NAME).toString();
-        Generator generator = new Generator(outputDir, rows, isSuppressCallJSMethodExceptionsEnabled(), false);
+        Generator generator = new Generator(outputDir, rows, isSuppressCallJSMethodExceptionsEnabled());
         generator.writeBindings(inputBindingFilename);
     }