chore(all): Update KtLint to 1.5.0 (#3026)

Author: mattcreaser

.editorconfig

@@ -2,3 +2,12 @@
 #this is to match java checkstyle
 max_line_length=120
 ktlint_code_style=android_studio
+
+# Disabled rules
+ktlint_standard_class-signature = disabled # don't force parameters onto one line in constructors
+ktlint_standard_value-parameter-comment = disabled # Allow same-line comments in parameters
+
+# Disable ktlint on generated source code, see
+# https://github.com/JLLeitschuh/ktlint-gradle/issues/746
+[**/build/generated/**]
+ktlint = disabled

.idea/codeStyles/Project.xml

@@ -24,14 +24,14 @@ package com.amplifyframework.annotations
 @Suppress("DEPRECATION")
 @RequiresOptIn(
     level = RequiresOptIn.Level.ERROR,
-    message = "This API is internal to Amplify and should not be used. It could be removed or changed without notice.",
+    message = "This API is internal to Amplify and should not be used. It could be removed or changed without notice."
 )
 @Target(
     AnnotationTarget.CLASS,
     AnnotationTarget.TYPEALIAS,
     AnnotationTarget.FUNCTION,
     AnnotationTarget.PROPERTY,
     AnnotationTarget.FIELD,
-    AnnotationTarget.CONSTRUCTOR,
+    AnnotationTarget.CONSTRUCTOR
 )
 public annotation class InternalAmplifyApi

annotations/src/main/java/com/amplifyframework/annotations/InternalAmplifyApi.kt

@@ -24,14 +24,14 @@ package com.amplifyframework.annotations
 @Suppress("DEPRECATION")
 @RequiresOptIn(
     level = RequiresOptIn.Level.WARNING,
-    message = "This API is internal to Amplify and should not be used. It could be removed or changed without notice.",
+    message = "This API is internal to Amplify and should not be used. It could be removed or changed without notice."
 )
 @Target(
     AnnotationTarget.CLASS,
     AnnotationTarget.TYPEALIAS,
     AnnotationTarget.FUNCTION,
     AnnotationTarget.PROPERTY,
     AnnotationTarget.FIELD,
-    AnnotationTarget.CONSTRUCTOR,
+    AnnotationTarget.CONSTRUCTOR
 )
 public annotation class InternalApiWarning

annotations/src/main/java/com/amplifyframework/annotations/InternalApiWarning.kt

@@ -64,6 +64,7 @@ class PinpointAnalyticsCanaryTest {
         @JvmStatic
         fun setupBefore() {
             val context = ApplicationProvider.getApplicationContext<Context>()
+
             @RawRes val resourceId = Resources.getRawResourceId(context, CONFIGURATION_NAME)
             appId = readAppIdFromResource(context, resourceId)
             preferences = context.getSharedPreferences(
@@ -117,6 +118,7 @@ class PinpointAnalyticsCanaryTest {
     @Before
     fun flushEvents() {
         val context = ApplicationProvider.getApplicationContext<Context>()
+
         @RawRes val resourceId = Resources.getRawResourceId(context, CREDENTIALS_RESOURCE_NAME)
         val userAndPasswordPair = readCredentialsFromResource(context, resourceId)
         synchronousAuth.signOut()

aws-analytics-pinpoint/src/androidTest/java/com/amplifyframework/analytics/pinpoint/PinpointAnalyticsCanaryTest.kt

@@ -53,6 +53,7 @@ class PinpointAnalyticsInstrumentationTest {
     @Before
     fun flushEvents() {
         val context = ApplicationProvider.getApplicationContext<Context>()
+
         @RawRes val resourceId = Resources.getRawResourceId(context, CREDENTIALS_RESOURCE_NAME)
         val userAndPasswordPair = readCredentialsFromResource(context, resourceId)
         synchronousAuth.signOut()
@@ -286,18 +287,18 @@ class PinpointAnalyticsInstrumentationTest {
         Amplify.Analytics.identifyUser(uuid, pinpointUserProfile)
         Sleep.milliseconds(PINPOINT_ROUNDTRIP_TIMEOUT)
         var endpointResponse = fetchEndpointResponse()
-        var retry_count = 0
-        while (retry_count < MAX_RETRIES && endpointResponse.attributes.isNullOrEmpty()) {
+        var retryCount = 0
+        while (retryCount < MAX_RETRIES && endpointResponse.attributes.isNullOrEmpty()) {
             Sleep.milliseconds(DEFAULT_TIMEOUT)
             endpointResponse = fetchEndpointResponse()
-            retry_count++
+            retryCount++
         }
         assertCommonEndpointResponseProperties(endpointResponse)
         Assert.assertEquals(
             "User attribute value",
             endpointResponse.user!!
                 .userAttributes!!
-            ["SomeUserAttribute"]!!
+                ["SomeUserAttribute"]!!
             [0]
         )
     }
@@ -371,7 +372,7 @@ class PinpointAnalyticsInstrumentationTest {
     }
 
     companion object {
-        private const val EVENT_FLUSH_TIMEOUT_WAIT = 15 /* seconds */
+        private const val EVENT_FLUSH_TIMEOUT_WAIT = 15 // seconds
         private const val CREDENTIALS_RESOURCE_NAME = "credentials"
         private const val CONFIGURATION_NAME = "amplifyconfiguration"
         private const val COGNITO_CONFIGURATION_TIMEOUT = 10 * 1000L
@@ -385,10 +386,12 @@ class PinpointAnalyticsInstrumentationTest {
         private lateinit var appId: String
         private lateinit var uniqueId: String
         private lateinit var pinpointClient: PinpointClient
+
         @BeforeClass
         @JvmStatic
         fun setupBefore() {
             val context = ApplicationProvider.getApplicationContext<Context>()
+
             @RawRes val resourceId = Resources.getRawResourceId(context, CONFIGURATION_NAME)
             appId = readAppIdFromResource(context, resourceId)
             preferences = context.getSharedPreferences(

aws-analytics-pinpoint/src/androidTest/java/com/amplifyframework/analytics/pinpoint/PinpointAnalyticsInstrumentationTest.kt

@@ -67,6 +67,7 @@ class PinpointAnalyticsStressTest {
         @JvmStatic
         fun setupBefore() {
             val context = ApplicationProvider.getApplicationContext<Context>()
+
             @RawRes val resourceId = Resources.getRawResourceId(context, CONFIGURATION_NAME)
             appId = readAppIdFromResource(context, resourceId)
             preferences = context.getSharedPreferences(
@@ -120,6 +121,7 @@ class PinpointAnalyticsStressTest {
     @Before
     fun flushEvents() {
         val context = ApplicationProvider.getApplicationContext<Context>()
+
         @RawRes val resourceId = Resources.getRawResourceId(context, CREDENTIALS_RESOURCE_NAME)
         val userAndPasswordPair = readCredentialsFromResource(context, resourceId)
         synchronousAuth.signOut()

aws-analytics-pinpoint/src/androidTest/java/com/amplifyframework/analytics/pinpoint/PinpointAnalyticsStressTest.kt

@@ -69,9 +69,7 @@ class AWSPinpointAnalyticsPlugin @JvmOverloads constructor(
         awsPinpointAnalyticsPluginBehavior.flushEvents()
     }
 
-    override fun getPluginKey(): String {
-        return pluginKey
-    }
+    override fun getPluginKey(): String = pluginKey
 
     override fun configure(pluginConfiguration: JSONObject?, context: Context) {
         requireNotNull(pluginConfiguration)
@@ -127,13 +125,9 @@ class AWSPinpointAnalyticsPlugin @JvmOverloads constructor(
         )
     }
 
-    override fun getEscapeHatch(): PinpointClient {
-        return pinpointManager.pinpointClient
-    }
+    override fun getEscapeHatch(): PinpointClient = pinpointManager.pinpointClient
 
-    override fun getVersion(): String {
-        return BuildConfig.VERSION_NAME
-    }
+    override fun getVersion(): String = BuildConfig.VERSION_NAME
 
     /**
      * Options that can be specified to fine-tune the behavior of the Pinpoint Analytics Plugin.

aws-analytics-pinpoint/src/main/java/com/amplifyframework/analytics/pinpoint/AWSPinpointAnalyticsPlugin.kt

@@ -28,7 +28,7 @@ import com.amplifyframework.pinpoint.core.TargetingClient
 
 internal class AWSPinpointAnalyticsPluginBehavior(
     private val analyticsClient: AnalyticsClient,
-    private val targetingClient: TargetingClient,
+    private val targetingClient: TargetingClient
 ) : AnalyticsCategoryBehavior {
 
     override fun identifyUser(userId: String, profile: UserProfile?) = targetingClient.identifyUser(userId, profile)

aws-analytics-pinpoint/src/main/java/com/amplifyframework/analytics/pinpoint/AWSPinpointAnalyticsPluginBehavior.kt

@@ -26,7 +26,5 @@ enum class AnalyticsChannelEventName(val eventName: String) {
      */
     FLUSH_EVENTS("flushEvents");
 
-    override fun toString(): String {
-        return eventName
-    }
+    override fun toString(): String = eventName
 }

aws-analytics-pinpoint/src/main/java/com/amplifyframework/analytics/pinpoint/AnalyticsChannelEventName.kt

@@ -57,7 +57,7 @@ class AWSPinpointAnalyticsPluginBehaviorTest {
 
         awsPinpointAnalyticsPluginBehavior = AWSPinpointAnalyticsPluginBehavior(
             analyticsClientMock,
-            targetingClientMock,
+            targetingClientMock
         )
     }
 

aws-analytics-pinpoint/src/test/java/com/amplifyframework/analytics/pinpoint/AWSPinpointAnalyticsPluginBehaviorTest.kt

@@ -85,9 +85,8 @@ private fun getSelectionSet(node: PropertyContainerPath): SelectionSet {
     return selectionSet
 }
 
-private fun shouldProcessNode(node: PropertyContainerPath, includeRoot: Boolean): Boolean {
-    return includeRoot || node.getMetadata().parent != null
-}
+private fun shouldProcessNode(node: PropertyContainerPath, includeRoot: Boolean): Boolean =
+    includeRoot || node.getMetadata().parent != null
 
 private fun nodesInPath(node: PropertyContainerPath, includeRoot: Boolean): List<PropertyContainerPath> {
     var currentNode: PropertyContainerPath? = node

aws-api-appsync/src/main/java/com/amplifyframework/api/aws/SelectionSetExtensions.kt

@@ -57,6 +57,7 @@ class GraphQLLazyQueryInstrumentationTest {
         const val PARENT2_ID = "GraphQLLazyQueryInstrumentationTest-Parent2"
         const val HAS_ONE_CHILD1_ID = "GraphQLLazyQueryInstrumentationTest-HasOneChild1"
         const val HAS_ONE_CHILD2_ID = "GraphQLLazyQueryInstrumentationTest-HasOneChild2"
+
         @JvmStatic
         @BeforeClass
         fun setUp() {
@@ -177,7 +178,8 @@ class GraphQLLazyQueryInstrumentationTest {
     fun query_parent_with_includes() = runTest {
         // GIVEN
         val request = ModelQuery.get<Parent, ParentPath>(
-            Parent::class.java, Parent.ParentIdentifier(PARENT1_ID)
+            Parent::class.java,
+            Parent.ParentIdentifier(PARENT1_ID)
         ) {
             includes(it.child, it.children)
         }
@@ -199,7 +201,6 @@ class GraphQLLazyQueryInstrumentationTest {
 
     @Test
     fun query_list_with_no_includes() = runTest(timeout = LONG_TIMEOUT) {
-
         val request = ModelQuery.list(
             Parent::class.java,
             Parent.ID.beginsWith("GraphQLLazyQueryInstrumentationTest-Parent")
@@ -258,7 +259,6 @@ class GraphQLLazyQueryInstrumentationTest {
 
     @Test
     fun query_list_with_includes() = runTest {
-
         val request = ModelQuery.list<Parent, ParentPath>(
             Parent::class.java,
             Parent.ID.beginsWith("GraphQLLazyQueryInstrumentationTest-Parent")
@@ -302,7 +302,8 @@ class GraphQLLazyQueryInstrumentationTest {
     fun query_parent_with_no_child_with_includes() = runTest {
         // GIVEN
         val request = ModelQuery.get<Parent, ParentPath>(
-            Parent::class.java, Parent.ParentIdentifier("GraphQLLazyQueryInstrumentationTest.ParentWithNoChildren")
+            Parent::class.java,
+            Parent.ParentIdentifier("GraphQLLazyQueryInstrumentationTest.ParentWithNoChildren")
         ) {
             includes(it.child, it.children)
         }
@@ -362,7 +363,8 @@ class GraphQLLazyQueryInstrumentationTest {
     fun query_child_belongsTo_parent_with_includes() = runTest {
         // GIVEN
         val request = ModelQuery.get<HasManyChild, HasManyChildPath>(
-            HasManyChild::class.java, HasManyChildIdentifier("GraphQLLazyQueryInstrumentationTest-HasManyChild1")
+            HasManyChild::class.java,
+            HasManyChildIdentifier("GraphQLLazyQueryInstrumentationTest-HasManyChild1")
         ) {
             includes(it.parent)
         }

aws-api/src/androidTest/java/com/amplifyframework/api/aws/GraphQLLazyQueryInstrumentationTest.kt

@@ -29,14 +29,12 @@ internal class AWSApiSchemaRegistry {
         modelProvider.modelSchemas()
     }
 
-    fun getModelSchemaForModelClass(classSimpleName: String): ModelSchema {
-        return modelSchemaMap[classSimpleName] ?: throw ApiException(
+    fun getModelSchemaForModelClass(classSimpleName: String): ModelSchema =
+        modelSchemaMap[classSimpleName] ?: throw ApiException(
             "Model type of `$classSimpleName` not found.",
             "Please regenerate codegen models and verify the class is found in AmplifyModelProvider."
         )
-    }
 
-    fun <T : Model> getModelSchemaForModelClass(modelClass: Class<T>): ModelSchema {
-        return getModelSchemaForModelClass(modelClass.simpleName)
-    }
+    fun <T : Model> getModelSchemaForModelClass(modelClass: Class<T>): ModelSchema =
+        getModelSchemaForModelClass(modelClass.simpleName)
 }

aws-api/src/main/java/com/amplifyframework/api/aws/AWSApiSchemaRegistry.kt

@@ -36,27 +36,23 @@ abstract class AWSGraphQLOperation<R>(
 ) : GraphQLOperation<R>(graphQLRequest, responseFactory) {
 
     @Throws(ApiException::class)
-    override fun wrapResponse(jsonResponse: String): GraphQLResponse<R> {
-        return buildResponse(jsonResponse)
-    }
+    override fun wrapResponse(jsonResponse: String): GraphQLResponse<R> = buildResponse(jsonResponse)
 
     // This method should be used in place of GraphQLOperation.wrapResponse. In order to pass
     // apiName, we had to stop using the default GraphQLResponse.Factory buildResponse method
     // as there was no place to inject api name for adding to LazyModel
     @Throws(ApiException::class)
-    private fun buildResponse(jsonResponse: String): GraphQLResponse<R> {
-        return try {
-            (responseFactory as? GsonGraphQLResponseFactory)?.buildResponse(request, jsonResponse, apiName)
-                ?: throw ApiException(
-                    "Amplify encountered an error while deserializing an object. " +
-                        "GraphQLResponse.Factory was not of type GsonGraphQLResponseFactory",
-                    AmplifyException.REPORT_BUG_TO_AWS_SUGGESTION
-                )
-        } catch (cce: ClassCastException) {
-            throw ApiException(
-                "Amplify encountered an error while deserializing an object",
-                AmplifyException.TODO_RECOVERY_SUGGESTION
+    private fun buildResponse(jsonResponse: String): GraphQLResponse<R> = try {
+        (responseFactory as? GsonGraphQLResponseFactory)?.buildResponse(request, jsonResponse, apiName)
+            ?: throw ApiException(
+                "Amplify encountered an error while deserializing an object. " +
+                    "GraphQLResponse.Factory was not of type GsonGraphQLResponseFactory",
+                AmplifyException.REPORT_BUG_TO_AWS_SUGGESTION
             )
-        }
+    } catch (cce: ClassCastException) {
+        throw ApiException(
+            "Amplify encountered an error while deserializing an object",
+            AmplifyException.TODO_RECOVERY_SUGGESTION
+        )
     }
 }

aws-api/src/main/java/com/amplifyframework/api/aws/AWSGraphQLOperation.kt

@@ -51,9 +51,7 @@ internal class ApiLazyModelReference<M : Model> internal constructor(
         }
     }
 
-    override fun getIdentifier(): Map<String, Any> {
-        return keyMap
-    }
+    override fun getIdentifier(): Map<String, Any> = keyMap
 
     override suspend fun fetchModel(): M? {
         val cached = cachedValue.get()
@@ -85,7 +83,6 @@ internal class ApiLazyModelReference<M : Model> internal constructor(
     private suspend fun fetchInternal(): M? {
         // Use mutex to only allow 1 execution at a time
         mutex.withLock {
-
             // Quick return if value is already present
             val cached = cachedValue.get()
             if (cached != null) {

aws-api/src/main/java/com/amplifyframework/api/aws/ApiLazyModelReference.kt

@@ -32,14 +32,10 @@ import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
 
-internal class ApiLoadedModelList<out M : Model>(
-    override val items: List<M>
-) : LoadedModelList<M>
+internal class ApiLoadedModelList<out M : Model>(override val items: List<M>) : LoadedModelList<M>
 
-internal class ApiModelPage<out M : Model>(
-    override val items: List<M>,
-    override val nextToken: ApiPaginationToken?
-) : ModelPage<M>
+internal class ApiModelPage<out M : Model>(override val items: List<M>, override val nextToken: ApiPaginationToken?) :
+    ModelPage<M>
 
 internal class ApiPaginationToken(val nextToken: String) : PaginationToken
 
@@ -90,13 +86,12 @@ internal class ApiLazyModelList<out M : Model> constructor(
         }
     }
 
-    private fun createRequest(paginationToken: PaginationToken? = null): GraphQLRequest<ModelPage<M>> {
-        return AppSyncGraphQLRequestFactory.buildModelPageQuery(
+    private fun createRequest(paginationToken: PaginationToken? = null): GraphQLRequest<ModelPage<M>> =
+        AppSyncGraphQLRequestFactory.buildModelPageQuery(
             clazz,
             queryPredicate,
             (paginationToken as? ApiPaginationToken)?.nextToken
         )
-    }
 
     private fun createLazyException(exception: AmplifyException) =
         AmplifyException("Error lazy loading the model list.", exception, exception.message ?: "")