Prepare release 2.6.0 (#153)

* Fix Retrieve Existing request ID behavior for PROCESSING state (#95)

* Fix Retrieve Existing request ID behavior for PENDING state

* Add distinction between Pending & Processing

* Code cleanup (and research on proguard rules being handed to consumers) (#98)

* Add proguard rules to project for automatic client consumption

* Fix constant name after renaming class

* Concrete R8 rules are actually not needed

* Add enum for GrantType (#99)

* Update Robolectric dependency (#102)

* Update changelog

* Use Epoch usec for Analytics timestamp (#107)

* Add UT for Analytics (#108)

* Refresh Auth Token for Customer Request (#109)

* Initial support for Unauthorized Customer Request refresh

* Add useful docs about token refresh window

* Improve logging for CashAppCashAppPayImpl

* Use Duration instead of Long for better time handling

* Remove not needed call to interrupt

* Schedule auth token refresh on `startWithExistingCustomerRequest` when status is "pending"

* Support deferred auth token refresh upon authorize call

* Better thread safety and handling

* Update comment

* Add new Refreshing state (#110)

* Add Refreshing state

* Use better explicit tag for logging

* Abstract thread managment away from main class (#113)

* Redact PII for logs and metrics (#112)

* Redact PII for logs and metrics

* Add UTs for PiiString

* Swap redact with unredacted defaults

* Redact more fields; move redaction step to encoding

* Simplify internal class names (#115)

* Modify CashAppPayButton to allow for dynamic styles (#116)

* Modify CashAppPayButton to allow for dynamic styles

* Update CHANGELOG

* Update testing frameworks and link baseline

* Add PR template (#120)

* Logging abstraction (#119)

* Create new module for logging

* CashPayLogger implementation, and apply it to Analytics module

* Add CAP logger to Core module

* Create lint baseline file for logging module

* Fix tests

* Change Analytics implementation to log only Warn level or above

* Add support to observe logging changes

* Add some UT for logging module

* Add UTs for CashAppLoggerImpl

* Add some useful documentation to tests

* Set default PR template (#121)

* Make Initializer open to modification (#123)

* Update Spotless Plugin and Ktlint version (#124)

* Add minify rules (#125)

* Add consumer-rules for minify

* Bump release version; update release notes

* Add more minify rules

* Update Core dependency on OkHttp (#126)

* Add consumer-rules for minify

* Bump release version; update release notes

* Add more minify rules

* Update Core dependency on OkHttp

* Update Android target version (#133)

* Increase compile version to API 33

* Update CHANGELOG

* Update AGP to 8.1.2 (#134)

* Update AGP to 8.1.2

* Update Java version for CI to 17

* Update AGP & Gradle (#138)

* Update AGP and Gradle

* Update Robolectric dependency

* Pedro/sdk kotlin 1.8 (#139)

* Update AGP version

* Update Kotlin to 1.8.x, along with various library dependencies

* Update Dev App versions and baseline lint files

* Update AGP and dev app version

* Use reference_id param correctly (#145)

* Add Start Screen to split different playgrouds within Dev App

* Improve webview logs display

* Increase log history size

* Fix accountReferenceId param missing from network call

* Update some of the project libraries

* Fix test related to size of log history

* Minor changes based on PR feedback

* Reference id mixup fix (#147)

* Correct distinction between reference_id and account_reference_id

* Spotless apply

* Make function changes be backwards compatible

* Update CHANGELOG

* Fix UTs

* SDK: Upgrade build tooling (#149)

* WIP

* Update to Java 17

* Update lint baseline

* Attempt to update GH action

* Prepare release 2.6.0  (#152)

* WIP

* Update to Java 17

* Add new CAP styles (#151)

* Add new CAP styles

* Removed unused assets

* Suppress GradleDependency lint

* Fix lint errors

* Lint errors

* Fix UTs

* Documenation

---------

Co-authored-by: Pedro Veloso <pedroveloso@squareup.com>

* Bump version

---------

Co-authored-by: Pedro Veloso <pedroveloso@squareup.com>

* Logging lint-baseline update

---------

Co-authored-by: Pedro Veloso <pedroveloso@squareup.com>
Co-authored-by: Pedro Veloso <pedro.n.veloso@gmail.com>

Author: m-nogas

.github/workflows/build.yml

@@ -10,7 +10,7 @@ on:
   pull_request:
 
 env:
-  GRADLE_OPTS: "-Dorg.gradle.jvmargs=-Xmx2g -Dorg.gradle.daemon=false -Dkotlin.incremental=false"
+  GRADLE_OPTS: "-Xmx4g -Dorg.gradle.daemon=false -Dkotlin.incremental=false"
 
 jobs:
   build:
@@ -23,8 +23,8 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Validate Gradle Wrapper
-        uses: gradle/wrapper-validation-action@v1
+      - name: Gradle Setup
+        uses: gradle/gradle-build-action@v2
 
       - name: Configure JDK
         uses: actions/setup-java@v3
@@ -36,7 +36,7 @@ jobs:
         run: ./gradlew lint spotlessCheck
 
       - name: Unit Tests
-        run: ./gradlew testRelease testDebug
+        run: ./gradlew testRelease testDebug --stacktrace
 
       - name: Build
         run: ./gradlew core:assemble

CHANGELOG.md

@@ -1,3 +1,42 @@
+# 2.6.0
+## Breaking Changes
+- Introduces new button styles and deprecates existing styles. This is also replaces 
+`FollowThemeButtonStyle` with two new options: `FollowThemeButtonStyle.Polychrome` and 
+`FollowThemeButtonStyle.Monochrome`. To obtain different variants, 
+developers should use the XML `style` attribute to specify the variant they want, as follows:
+
+Polychrome Light Variant:
+```xml
+<app.cash.paykit.core.ui.CashAppPayButton
+      style="@style/CAPButtonStyle.Alt"
+      android:layout_height="54dp"
+      android:layout_width="match_parent"/>
+```
+
+Polychrome Dark Variant:
+```xml
+<app.cash.paykit.core.ui.CashAppPayButton
+      style="@style/CAPButtonStyle.Default"
+      android:layout_height="54dp"
+      android:layout_width="match_parent"/>
+```
+
+Monochrome Light Variant:
+```xml
+<app.cash.paykit.core.ui.CashAppPayButton
+      style="@style/CAPButtonStyle.MonochromeLight"
+      android:layout_height="54dp"
+      android:layout_width="match_parent"/>
+```
+
+Monochrome Dark Variant:
+```xml
+<app.cash.paykit.core.ui.CashAppPayButton
+      style="@style/CAPButtonStyle.MonochromeDark"
+      android:layout_height="54dp"
+      android:layout_width="match_parent"/>
+```
+
 # 2.5.0
 
  - Fix correct usage of `account_reference_id` in `OnFileAction`

analytics-core/build.gradle

@@ -25,11 +25,15 @@ android {
     }
   }
   compileOptions {
-    sourceCompatibility JavaVersion.VERSION_11
-    targetCompatibility JavaVersion.VERSION_11
+    sourceCompatibility JavaVersion.VERSION_17
+    targetCompatibility JavaVersion.VERSION_17
   }
+  kotlinOptions {
+    jvmTarget = "17"
+  }
+
   kotlin {
-    jvmToolchain(11)
+    jvmToolchain(17)
   }
 
   lintOptions {

analytics-core/lint-baseline.xml

@@ -1,4 +1,37 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<issues format="6" by="lint 8.2.1" type="baseline" client="gradle" dependencies="false" name="AGP (8.2.1)" variant="all" version="8.2.1">
+<issues format="6" by="lint 8.8.1" type="baseline" client="gradle" dependencies="false" name="AGP (8.8.1)" variant="all" version="8.8.1">
+
+    <issue
+        id="DefaultLocale"
+        message="Implicitly using the default locale is a common source of bugs: Use `String.format(Locale, ...)` instead"
+        errorLine1="            String.format(&quot;%s scheduled for delivery. id: %d&quot;, type, entryId),"
+        errorLine2="            ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~">
+        <location
+            file="src/main/java/app/cash/paykit/analytics/PayKitAnalytics.kt"
+            line="304"
+            column="13"/>
+    </issue>
+
+    <issue
+        id="DiscouragedApi"
+        message="Use of `scheduleAtFixedRate` is strongly discouraged because it can lead to unexpected behavior when Android processes become cached (tasks may unexpectedly execute hundreds or thousands of times in quick succession when a process changes from cached to uncached); prefer using `scheduleWithFixedDelay`"
+        errorLine1="      it.scheduleAtFixedRate({"
+        errorLine2="      ^">
+        <location
+            file="src/main/java/app/cash/paykit/analytics/PayKitAnalytics.kt"
+            line="133"
+            column="7"/>
+    </issue>
+
+    <issue
+        id="StringFormatTrivial"
+        message="This formatting string is trivial. Rather than using `String.format` to create your String, it will be more performant to concatenate your arguments with `+`. "
+        errorLine1="          logger.e(TAG, String.format(&quot;%s NOT scheduled for delivery!&quot;, type))"
+        errorLine2="                                      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~">
+        <location
+            file="src/main/java/app/cash/paykit/analytics/PayKitAnalytics.kt"
+            line="308"
+            column="39"/>
+    </issue>
 
 </issues>

analytics-core/src/main/java/app/cash/paykit/analytics/PayKitAnalytics.kt

@@ -130,10 +130,10 @@ class PayKitAnalytics constructor(
           options.interval.inWholeSeconds,
         ),
       )
-      it.scheduleAtFixedRate({
+      it.scheduleWithFixedDelay({
         if (shouldShutdown.compareAndSet(true, false)) {
           shutdown()
-          return@scheduleAtFixedRate
+          return@scheduleWithFixedDelay
         }
         startDelivery(false)
       }, options.delay.inWholeSeconds, options.interval.inWholeSeconds, TimeUnit.SECONDS)
@@ -301,11 +301,11 @@ class PayKitAnalytics constructor(
         if (entryId > 0) {
           logger.v(
             TAG,
-            String.format("%s scheduled for delivery. id: %d", type, entryId),
+            String.format(Locale.US, "%s scheduled for delivery. id: %d", type, entryId),
           )
           entryId
         } else {
-          logger.e(TAG, String.format("%s NOT scheduled for delivery!", type))
+          logger.e(TAG, String.format(Locale.US, "%s NOT scheduled for delivery!", type))
           null
         }
       } else {

analytics-core/src/test/java/app/cash/paykit/analytics/AnalyticsTest.kt

@@ -70,7 +70,7 @@ class AnalyticsTest {
     val mockExecutor: ScheduledExecutorService = mockk(relaxed = true)
     every { Executors.newSingleThreadScheduledExecutor() } returns mockExecutor
 
-    every { mockExecutor.scheduleAtFixedRate(any(), any(), any(), any()) } answers {
+    every { mockExecutor.scheduleWithFixedDelay(any(), any(), any(), any()) } answers {
       val task = this.args.first() as Runnable
       task.run()
       mockScheduledFuture

build.gradle

@@ -25,8 +25,8 @@ buildscript {
 }
 
 plugins {
-  id 'com.android.application' version '8.2.2' apply false
-  id 'com.android.library' version '8.2.2' apply false
+  id 'com.android.application' version '8.8.1' apply false
+  id 'com.android.library' version '8.8.1' apply false
   id 'org.jetbrains.kotlin.android' version '1.8.22' apply false
   id "com.diffplug.spotless" version "6.20.0"
   id "com.vanniktech.maven.publish.base" version "0.25.1"
@@ -52,12 +52,12 @@ subprojects { subproject ->
   }
 }
 
-def NEXT_VERSION = "2.5.1-SNAPSHOT"
+def NEXT_VERSION = "2.6.1"
 
 allprojects {
 
   group = 'app.cash.paykit'
-  version = '2.5.0'
+  version = '2.6.0'
 
   plugins.withId("com.vanniktech.maven.publish.base") {
     mavenPublishing {

core/build.gradle

@@ -34,11 +34,15 @@ android {
   }
 
   compileOptions {
-    sourceCompatibility JavaVersion.VERSION_11
-    targetCompatibility JavaVersion.VERSION_11
+    sourceCompatibility JavaVersion.VERSION_17
+    targetCompatibility JavaVersion.VERSION_17
   }
+  kotlinOptions {
+    jvmTarget = "17"
+  }
+
   kotlin {
-    jvmToolchain(11)
+    jvmToolchain(17)
   }
 
   resourcePrefix 'cap_'

core/lint-baseline.xml

@@ -1,4 +1,26 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<issues format="6" by="lint 8.2.1" type="baseline" client="gradle" dependencies="false" name="AGP (8.2.1)" variant="all" version="8.2.1">
+<issues format="6" by="lint 8.8.1" type="baseline" client="gradle" dependencies="false" name="AGP (8.8.1)" variant="all" version="8.8.1">
+
+    <issue
+        id="VectorPath"
+        message="Very long vector path (1157 characters), which is bad for performance. Considering reducing precision, removing minor details or rasterizing vector."
+        errorLine1="        android:pathData=&quot;M23.59,3.99C23.08,2.57 21.96,1.45 20.54,0.93C19.23,0.52 18.04,0.52 15.62,0.52H8.36L8.36,0.52C5.96,0.52 4.75,0.52 3.46,0.92C2.05,1.44 0.93,2.56 0.41,3.98C0,5.28 0,6.48 0,8.89V16.15C0,18.57 0,19.76 0.4,21.06C0.92,22.48 2.04,23.6 3.45,24.11C4.75,24.52 5.96,24.52 8.36,24.52H15.63C18.04,24.52 19.24,24.52 20.54,24.11C21.96,23.6 23.08,22.48 23.59,21.06C24,19.76 24,18.56 24,16.15V8.9C24,6.49 24,5.28 23.59,3.99ZM17.29,8.74L15.91,9.87C15.79,9.97 15.61,9.95 15.51,9.83C14.81,8.96 13.7,8.47 12.5,8.47C11.17,8.47 10.34,9.05 10.34,9.88C10.34,10.56 10.99,10.92 12.97,11.36C15.5,11.9 16.66,12.95 16.66,14.72C16.66,16.94 14.85,18.57 12.03,18.75L11.75,20.06C11.73,20.19 11.61,20.28 11.48,20.28H9.31C9.13,20.28 9,20.11 9.04,19.94L9.39,18.47C7.99,18.07 6.87,17.3 6.21,16.34C6.13,16.22 6.16,16.06 6.27,15.97L7.79,14.79C7.91,14.69 8.09,14.72 8.19,14.85C8.99,15.97 10.22,16.63 11.71,16.63C13.05,16.63 14.06,15.98 14.06,15.04C14.06,14.32 13.55,13.99 11.85,13.63C8.93,13.02 7.77,11.94 7.77,10.17C7.77,8.11 9.5,6.56 12.1,6.36L12.38,5C12.41,4.87 12.52,4.78 12.66,4.78H14.8C14.97,4.78 15.1,4.95 15.07,5.12L14.74,6.64C15.86,6.98 16.77,7.6 17.34,8.36C17.43,8.48 17.4,8.64 17.29,8.74Z&quot;"
+        errorLine2="                          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~">
+        <location
+            file="src/main/res/drawable/cap_logo_monochrome_dark.xml"
+            line="11"
+            column="27"/>
+    </issue>
+
+    <issue
+        id="VectorPath"
+        message="Very long vector path (1174 characters), which is bad for performance. Considering reducing precision, removing minor details or rasterizing vector."
+        errorLine1="        android:pathData=&quot;M21.04,0.93C19.73,0.52 18.54,0.52 16.12,0.52H8.86L8.86,0.52C6.46,0.52 5.25,0.52 3.96,0.92C2.55,1.44 1.43,2.56 0.91,3.98C0.5,5.28 0.5,6.48 0.5,8.89V16.15C0.5,18.57 0.5,19.76 0.9,21.06C1.42,22.48 2.54,23.6 3.95,24.11C5.25,24.52 6.46,24.52 8.86,24.52H16.13C18.54,24.52 19.74,24.52 21.04,24.11C22.46,23.6 23.58,22.48 24.09,21.06C24.5,19.76 24.5,18.56 24.5,16.15V8.9C24.5,6.49 24.5,5.28 24.09,3.99C23.58,2.57 22.46,1.45 21.04,0.93ZM17.79,8.74L16.41,9.87C16.29,9.97 16.11,9.95 16.01,9.83C15.31,8.96 14.2,8.47 13,8.47C11.67,8.47 10.84,9.05 10.84,9.88C10.84,10.56 11.49,10.92 13.47,11.36C16,11.9 17.16,12.95 17.16,14.72C17.16,16.94 15.35,18.57 12.53,18.75L12.25,20.06C12.23,20.19 12.11,20.28 11.98,20.28H9.81C9.63,20.28 9.5,20.11 9.54,19.94L9.89,18.47C8.49,18.07 7.37,17.3 6.71,16.34C6.63,16.22 6.66,16.06 6.77,15.97L8.29,14.79C8.41,14.69 8.59,14.72 8.69,14.85C9.49,15.97 10.72,16.63 12.21,16.63C13.55,16.63 14.56,15.98 14.56,15.04C14.56,14.32 14.05,13.99 12.35,13.63C9.43,13.02 8.27,11.94 8.27,10.17C8.27,8.11 10,6.56 12.6,6.36L12.88,5C12.91,4.87 13.02,4.78 13.16,4.78H15.3C15.47,4.78 15.6,4.95 15.57,5.12L15.24,6.64C16.36,6.98 17.27,7.6 17.84,8.36C17.93,8.48 17.9,8.64 17.79,8.74Z&quot;"
+        errorLine2="                          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~">
+        <location
+            file="src/main/res/drawable/cap_logo_monochrome_light.xml"
+            line="11"
+            column="27"/>
+    </issue>
 
 </issues>

core/src/main/java/app/cash/paykit/core/ui/CashAppPayButton.kt

@@ -20,7 +20,8 @@ import android.util.AttributeSet
 import android.widget.ImageButton
 
 /**
- * Cash App Pay button. Should be used in conjunction with either `CAPButtonStyle.Light` or `CAPButtonStyle.Dark` styles.
+ * Cash App Pay button. Should be used in conjunction with either `CAPButtonStyle.Default`,
+ * `CAPButtonStyle.Alt`, `CAPButtonStyle.MonochromeDark`, or `CAPButtonStyle.MonochromeLight` styles.
  *
  * **Note**: Due to its unmanaged nature, the button is merely a stylized button, it's up to developers
  * to trigger the correct action on button press, as well as manage any visibility states of the