Merge pull request #1636 from OneSignal/add-ktlint

Add Code Formatter

Author: jmadler

.github/workflows/ci.yml

@@ -25,6 +25,10 @@ jobs:
             platforms;android-31
             build-tools;31.0.0
           cache: true
+      - name: "[Test] Linting"
+        working-directory: OneSignalSDK
+        run: |
+          ./gradlew ktlintCheck --console=plain
       - name: "[Test] SDK Unit Tests"
         working-directory: OneSignalSDK
         run: |

OneSignalSDK/build.gradle

@@ -13,6 +13,7 @@ buildscript {
         huaweiHMSPushVersion = '6.3.0.304'
         huaweiHMSLocationVersion = '4.0.0.300'
         kotlinVersion = '1.4.32'
+        ktlintVersion = '11.0.0'
         onesignalGradlePluginVersion = '[0.14.0, 0.99.99]'
     }
 
@@ -35,6 +36,8 @@ buildscript {
         classpath "com.huawei.agconnect:agcp:$huaweiAgconnectVersion"
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion"
 
+        classpath "org.jlleitschuh.gradle:ktlint-gradle:$ktlintVersion"
+
         // OneSignal-Gradle-Plugin - Local testing
         // classpath 'com.onesignal:onesignal-gradle-plugin:[0.8.1, 0.99.99]'
 

OneSignalSDK/onesignal/build.gradle

@@ -6,6 +6,7 @@ ext {
 
 apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
+apply plugin: 'org.jlleitschuh.gradle.ktlint'
 
 android {
     compileSdkVersion rootProject.buildVersions.compileSdkVersion

OneSignalSDK/onesignal/src/main/java/com/onesignal/ADMMessageHandlerJob.kt

@@ -49,4 +49,4 @@ class ADMMessageHandlerJob : ADMMessageHandlerJobBase() {
 
         PushRegistratorADM.fireCallback(null)
     }
-}
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/AlertDialogPrepromptForAndroidSettings.kt

@@ -41,7 +41,7 @@ object AlertDialogPrepromptForAndroidSettings {
         activity: Activity,
         titlePrefix: String,
         previouslyDeniedPostfix: String,
-        callback: Callback,
+        callback: Callback
     ) {
         val titleTemplate = activity.getString(R.string.permission_not_available_title)
         val title = titleTemplate.format(titlePrefix)

OneSignalSDK/onesignal/src/main/java/com/onesignal/BackgroundRunnable.kt

@@ -6,4 +6,4 @@ internal open class BackgroundRunnable : Runnable {
     override fun run() {
         Thread.currentThread().priority = Process.THREAD_PRIORITY_BACKGROUND
     }
-}
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/GenerateNotificationOpenIntent.kt

@@ -30,7 +30,7 @@ class GenerateNotificationOpenIntent(
             context.packageManager.getLaunchIntentForPackage(
                 context.packageName
             )
-            ?: return null
+                ?: return null
 
         // Removing "package" from the intent treats the app as if it was started externally.
         //   - This is exactly what an Android Launcher does.

OneSignalSDK/onesignal/src/main/java/com/onesignal/GenerateNotificationOpenIntentFromPushPayload.kt

@@ -17,7 +17,7 @@ object GenerateNotificationOpenIntentFromPushPayload {
     ): GenerateNotificationOpenIntent {
         val behavior = OSNotificationOpenBehaviorFromPushPayload(
             context,
-            fcmPayload,
+            fcmPayload
         )
 
         return GenerateNotificationOpenIntent(
@@ -34,9 +34,9 @@ object GenerateNotificationOpenIntentFromPushPayload {
     }
 
     private fun openBrowserIntent(
-        uri: Uri?,
+        uri: Uri?
     ): Intent? {
         if (uri == null) return null
         return OSUtils.openURLInBrowserIntent(uri)
     }
-}
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/IntentGeneratorForAttachingToNotifications.kt

@@ -12,13 +12,14 @@ class IntentGeneratorForAttachingToNotifications(
     private val notificationOpenedClassAndroid22AndOlder: Class<*> = NotificationOpenedReceiverAndroid22AndOlder::class.java
 
     fun getNewBaseIntent(
-        notificationId: Int,
+        notificationId: Int
     ): Intent {
         val intent =
-            if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.M)
+            if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.M) {
                 getNewBaseIntentAndroidAPI23Plus()
-            else
+            } else {
                 getNewBaseIntentAndroidAPI22AndOlder()
+            }
 
         return intent
             .putExtra(
@@ -29,7 +30,7 @@ class IntentGeneratorForAttachingToNotifications(
             //   tracking Activity instance around.
             .addFlags(
                 Intent.FLAG_ACTIVITY_SINGLE_TOP or
-                        Intent.FLAG_ACTIVITY_CLEAR_TOP
+                    Intent.FLAG_ACTIVITY_CLEAR_TOP
             )
     }
 
@@ -50,17 +51,17 @@ class IntentGeneratorForAttachingToNotifications(
         )
         intent.addFlags(
             Intent.FLAG_ACTIVITY_NEW_TASK or
-                    Intent.FLAG_ACTIVITY_MULTIPLE_TASK or
-                    Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
+                Intent.FLAG_ACTIVITY_MULTIPLE_TASK or
+                Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
         )
         return intent
     }
 
     fun getNewActionPendingIntent(
         requestCode: Int,
-        oneSignalIntent: Intent,
+        oneSignalIntent: Intent
     ): PendingIntent? {
-        val flags =  PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
+        val flags = PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
         return PendingIntent.getActivity(
             context,
             requestCode,

OneSignalSDK/onesignal/src/main/java/com/onesignal/LocationPermissionController.kt

@@ -36,7 +36,7 @@ object LocationPermissionController : PermissionsActivity.PermissionCallback {
 
     fun prompt(
         fallbackToSettings: Boolean,
-        androidPermissionString: String,
+        androidPermissionString: String
     ) {
         PermissionsActivity.startPrompt(
             fallbackToSettings,

OneSignalSDK/onesignal/src/main/java/com/onesignal/NavigateToAndroidSettingsForNotifications.kt

@@ -36,7 +36,7 @@ object NavigateToAndroidSettingsForNotifications {
         intent.action = "android.settings.APP_NOTIFICATION_SETTINGS"
         intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
 
-        //for Android 5-7
+        // for Android 5-7
         intent.putExtra("app_package", context.getPackageName())
         intent.putExtra("app_uid", context.getApplicationInfo().uid)
 

OneSignalSDK/onesignal/src/main/java/com/onesignal/NotificationOpenedReceiverBase.kt

@@ -42,4 +42,4 @@ abstract class NotificationOpenedReceiverBase : Activity() {
         NotificationOpenedProcessor.processFromContext(this, getIntent())
         finish()
     }
-}
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/NotificationPermissionController.kt

@@ -35,7 +35,7 @@ object NotificationPermissionController : PermissionsActivity.PermissionCallback
     private const val ANDROID_PERMISSION_STRING = "android.permission.POST_NOTIFICATIONS"
 
     private val callbacks:
-            MutableSet<OneSignal.PromptForPushNotificationPermissionResponseHandler> = HashSet()
+        MutableSet<OneSignal.PromptForPushNotificationPermissionResponseHandler> = HashSet()
     private var awaitingForReturnFromSystemSettings = false
 
     init {
@@ -45,11 +45,11 @@ object NotificationPermissionController : PermissionsActivity.PermissionCallback
     @ChecksSdkIntAtLeast(api = 33)
     val supportsNativePrompt =
         Build.VERSION.SDK_INT > 32 &&
-        OSUtils.getTargetSdkVersion(OneSignal.appContext) > 32
+            OSUtils.getTargetSdkVersion(OneSignal.appContext) > 32
 
     fun prompt(
         fallbackToSettings: Boolean,
-        callback: OneSignal.PromptForPushNotificationPermissionResponseHandler?,
+        callback: OneSignal.PromptForPushNotificationPermissionResponseHandler?
     ) {
         if (callback != null) callbacks.add(callback)
 
@@ -59,10 +59,11 @@ object NotificationPermissionController : PermissionsActivity.PermissionCallback
         }
 
         if (!supportsNativePrompt) {
-            if (fallbackToSettings)
+            if (fallbackToSettings) {
                 showFallbackAlertDialog()
-            else
+            } else {
                 fireCallBacks(false)
+            }
             return
         }
 
@@ -81,10 +82,11 @@ object NotificationPermissionController : PermissionsActivity.PermissionCallback
 
     override fun onReject(fallbackToSettings: Boolean) {
         val fallbackShown =
-            if (fallbackToSettings)
+            if (fallbackToSettings) {
                 showFallbackAlertDialog()
-            else
+            } else {
                 false
+            }
         if (!fallbackShown) fireCallBacks(false)
     }
 

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSBackgroundManager.kt

@@ -6,4 +6,4 @@ open class OSBackgroundManager {
         // DB access is a heavy task, dispatch to a thread if running on main thread
         if (OSUtils.isRunningOnMainThread()) Thread(runnable, threadName).start() else runnable.run()
     }
-}
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSFocusHandler.kt

@@ -28,8 +28,13 @@
 package com.onesignal
 
 import android.content.Context
-import android.os.Handler
-import androidx.work.*
+import androidx.work.Constraints
+import androidx.work.ExistingWorkPolicy
+import androidx.work.NetworkType
+import androidx.work.OneTimeWorkRequest
+import androidx.work.WorkManager
+import androidx.work.Worker
+import androidx.work.WorkerParameters
 import java.util.concurrent.TimeUnit
 
 class OSFocusHandler {
@@ -75,7 +80,7 @@ class OSFocusHandler {
         }
     }
 
-    fun startOnLostFocusWorker(tag: String, delay: Long, context: Context)  {
+    fun startOnLostFocusWorker(tag: String, delay: Long, context: Context) {
         val constraints = buildConstraints()
         val workRequest = OneTimeWorkRequest.Builder(OnLostFocusWorker::class.java)
             .setConstraints(constraints)

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSInAppMessageContent.kt

@@ -13,6 +13,7 @@ internal open class OSInAppMessageContent constructor(jsonObject: JSONObject) {
     var useHeightMargin: Boolean = true
     var useWidthMargin: Boolean = true
     var isFullBleed: Boolean = false
+
     // The following properties are populated from Javascript events
     var displayLocation: WebViewManager.Position? = null
     var displayDuration: Double? = null
@@ -26,4 +27,4 @@ internal open class OSInAppMessageContent constructor(jsonObject: JSONObject) {
         useWidthMargin = !(styles?.optBoolean(REMOVE_WIDTH_MARGIN, false) ?: false)
         isFullBleed = !useHeightMargin
     }
-}
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSInAppMessagePage.kt

@@ -1,6 +1,5 @@
 package com.onesignal
 
-
 import org.json.JSONException
 import org.json.JSONObject
 
@@ -26,4 +25,4 @@ internal open class OSInAppMessagePage constructor(jsonObject: JSONObject) {
         }
         return mainObj
     }
-}
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSInAppMessagePreviewHandler.kt

@@ -43,14 +43,16 @@ internal object OSInAppMessagePreviewHandler {
             return null
         }
 
-        if (!osCustom.has(NotificationBundleProcessor.PUSH_ADDITIONAL_DATA_KEY))
+        if (!osCustom.has(NotificationBundleProcessor.PUSH_ADDITIONAL_DATA_KEY)) {
             return null
+        }
 
         return osCustom.optJSONObject(NotificationBundleProcessor.PUSH_ADDITIONAL_DATA_KEY)?.let { additionalData ->
-            if (additionalData.has(NotificationBundleProcessor.IAM_PREVIEW_KEY))
+            if (additionalData.has(NotificationBundleProcessor.IAM_PREVIEW_KEY)) {
                 additionalData.optString(NotificationBundleProcessor.IAM_PREVIEW_KEY)
-            else
+            } else {
                 null
+            }
         }
     }
 

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationOpenAppSettings.kt

@@ -27,4 +27,4 @@ object OSNotificationOpenAppSettings {
             "com.onesignal.suppressLaunchURLs"
         )
     }
-}
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationOpenBehaviorFromPushPayload.kt

@@ -6,13 +6,13 @@ import org.json.JSONObject
 
 class OSNotificationOpenBehaviorFromPushPayload(
     private val context: Context,
-    private val fcmPayload: JSONObject,
+    private val fcmPayload: JSONObject
 ) {
 
     val shouldOpenApp: Boolean
         get() {
-            return OSNotificationOpenAppSettings.getShouldOpenActivity(context)
-                    && uri == null
+            return OSNotificationOpenAppSettings.getShouldOpenActivity(context) &&
+                uri == null
         }
 
     val uri: Uri?
@@ -31,5 +31,4 @@ class OSNotificationOpenBehaviorFromPushPayload(
 
             return null
         }
-
-}
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/influence/OSInfluenceConstants.kt

@@ -42,4 +42,4 @@ internal object OSInfluenceConstants {
     // Outcomes Channel Influence types
     const val PREFS_OS_OUTCOMES_CURRENT_NOTIFICATION_INFLUENCE = "PREFS_OS_OUTCOMES_CURRENT_SESSION"
     const val PREFS_OS_OUTCOMES_CURRENT_IAM_INFLUENCE = "PREFS_OS_OUTCOMES_CURRENT_IAM_INFLUENCE"
-}
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/influence/data/OSChannelTracker.kt

@@ -119,8 +119,8 @@ abstract class OSChannelTracker internal constructor(protected var dataRepositor
         try {
             timeProvider.run {
                 JSONObject()
-                        .put(idTag, id)
-                        .put(OSInfluenceConstants.TIME, currentTimeMillis)
+                    .put(idTag, id)
+                    .put(OSInfluenceConstants.TIME, currentTimeMillis)
             }.also { newInfluenceId ->
                 lastChannelObjectsReceived.put(newInfluenceId)
             }
@@ -152,11 +152,11 @@ abstract class OSChannelTracker internal constructor(protected var dataRepositor
 
     override fun toString(): String {
         return "OSChannelTracker{" +
-                "tag=" + idTag +
-                ", influenceType=" + influenceType +
-                ", indirectIds=" + indirectIds +
-                ", directId=" + directId +
-                '}'
+            "tag=" + idTag +
+            ", influenceType=" + influenceType +
+            ", indirectIds=" + indirectIds +
+            ", directId=" + directId +
+            '}'
     }
 
     override fun equals(other: Any?): Boolean {
@@ -171,4 +171,4 @@ abstract class OSChannelTracker internal constructor(protected var dataRepositor
         result = 31 * result + idTag.hashCode()
         return result
     }
-}
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/influence/data/OSInAppMessageTracker.kt

@@ -74,4 +74,4 @@ internal class OSInAppMessageTracker(dataRepository: OSInfluenceDataRepository,
         val influenceTypeToCache = influenceType ?: OSInfluenceType.UNATTRIBUTED
         dataRepository.cacheIAMInfluenceType(if (influenceTypeToCache === OSInfluenceType.DIRECT) OSInfluenceType.INDIRECT else influenceTypeToCache)
     }
-}
+}