feat: support custom compileSdk setting (#1431)

* feat: support custom compileSdk setting
* chore: apply suggestions from code review
* chore: apply cdv-gradle-config-defaults.json suggestion
* fix: set compile sdk when null
* fix: move compileSdk null check to gradle
* fix: compile sdk requirement warning & display in gradle per subproject

Co-authored-by: Norman Breau <norman@nbsolutions.ca>

framework/build.gradle

@@ -26,6 +26,8 @@ buildscript {
         // Android Gradle Plugin (AGP) Build Tools
         classpath "com.android.tools.build:gradle:${cordovaConfig.AGP_VERSION}"
     }
+
+    cdvHelpers.verifyCordovaConfigForBuild()
 }
 
 allprojects {
@@ -42,7 +44,7 @@ allprojects {
 apply plugin: 'com.android.library'
 
 android {
-    compileSdkVersion cordovaConfig.SDK_VERSION
+    compileSdkVersion cordovaConfig.COMPILE_SDK_VERSION
     buildToolsVersion cordovaConfig.BUILD_TOOLS_VERSION
 
     compileOptions {

framework/cdv-gradle-config-defaults.json

@@ -1,6 +1,7 @@
 {
     "MIN_SDK_VERSION": 22,
     "SDK_VERSION": 32,
+    "COMPILE_SDK_VERSION": null,
     "GRADLE_VERSION": "7.4.2",
     "MIN_BUILD_TOOLS_VERSION": "32.0.0",
     "AGP_VERSION": "7.1.0",

framework/cordova.gradle

@@ -161,6 +161,9 @@ def doApplyCordovaConfigCustomization() {
     if (project.hasProperty('cdvSdkVersion')) {
         cordovaConfig.SDK_VERSION = Integer.parseInt('' + cdvSdkVersion)
     }
+    if (project.hasProperty('cdvCompileSdkVersion')) {
+        cordovaConfig.COMPILE_SDK_VERSION = Integer.parseInt('' + cdvCompileSdkVersion)
+    }
     if (project.hasProperty('cdvMaxSdkVersion')) {
         cordovaConfig.MAX_SDK_VERSION = Integer.parseInt('' + cdvMaxSdkVersion)
     }
@@ -190,6 +193,12 @@ def doApplyCordovaConfigCustomization() {
     }
 }
 
+def doVerifyCordovaConfigForBuild() {
+    if (cordovaConfig.COMPILE_SDK_VERSION < cordovaConfig.SDK_VERSION) {
+        println "The \"compileSdkVersion\" (${cordovaConfig.COMPILE_SDK_VERSION}) should be greater than or equal to the the \"targetSdkVersion\" (${cordovaConfig.SDK_VERSION})."
+    }
+}
+
 // Properties exported here are visible to all plugins.
 ext {
     def defaultsFilePath = './cdv-gradle-config-defaults.json'
@@ -210,6 +219,10 @@ ext {
     def jsonFile = new File(targetConfigFilePath)
     cordovaConfig = new groovy.json.JsonSlurper().parseText(jsonFile.text)
 
+    if (cordovaConfig.COMPILE_SDK_VERSION == null) {
+        cordovaConfig.COMPILE_SDK_VERSION = cordovaConfig.SDK_VERSION
+    }
+
     // Apply Gradle Properties
     doApplyCordovaConfigCustomization()
 
@@ -227,6 +240,8 @@ ext {
     cdvHelpers.getConfigXml = { doGetConfigXml() }
     // Returns the value for the desired <preference>. Added in 4.1.0.
     cdvHelpers.getConfigPreference = { name, defaultValue -> doGetConfigPreference(name, defaultValue) }
+    // Display warnings if any cordova config is not proper for build.
+    cdvHelpers.verifyCordovaConfigForBuild = { doVerifyCordovaConfigForBuild() }
 }
 
 buildscript {