Renamed expiresIn to expiresAt

Author: pmathew92

V4_MIGRATION_GUIDE.md

@@ -15,7 +15,7 @@ v4 of the Auth0 Android SDK includes significant build toolchain updates, update
 - [**Breaking Changes**](#breaking-changes)
   + [Classes Removed](#classes-removed)
   + [DPoP Configuration Moved to Builder](#dpop-configuration-moved-to-builder)
-  + [SSOCredentials.expiresIn Type Changed to Date](#ssocredentialsexpiresin-type-changed-to-date)
+  + [SSOCredentials.expiresIn Renamed to expiresAt](#ssocredentialsexpiresin-renamed-to-expiresat)
 - [**Default Values Changed**](#default-values-changed)
   + [Credentials Manager minTTL](#credentials-manager-minttl)
 - [**Behavior Changes**](#behavior-changes)
@@ -124,11 +124,11 @@ WebAuthProvider
 This change ensures that DPoP configuration is scoped to individual login requests rather than
 persisting across the entire application lifecycle.
 
-### `SSOCredentials.expiresIn` Type Changed to `Date`
+### `SSOCredentials.expiresIn` Renamed to `expiresAt`
 
-**Change:** The `expiresIn` property in `SSOCredentials` changed from `Int` to `Date`.
+**Change:** The `expiresIn` property in `SSOCredentials` has been renamed to `expiresAt` and its type changed from `Int` to `Date`.
 
-In v3, `expiresIn` held the raw number of seconds until the session transfer token expired. In v4, the SDK now automatically converts this value into an absolute `Date` (computed as current time + seconds) during deserialization, consistent with how `Credentials.expiresAt` works.
+In v3, `expiresIn` held the raw number of seconds until the session transfer token expired. In v4, the SDK now automatically converts this value into an absolute expiration `Date` (computed as current time + seconds) during deserialization, consistent with how `Credentials.expiresAt` works. The property has been renamed to `expiresAt` to reflect that it now represents an absolute point in time rather than a duration.
 
 **v3:**
 
@@ -141,10 +141,10 @@ val secondsUntilExpiry: Int = ssoCredentials.expiresIn
 
 ```kotlin
 val ssoCredentials: SSOCredentials = // ...
-val expirationDate: Date = ssoCredentials.expiresIn
+val expirationDate: Date = ssoCredentials.expiresAt
 ```
 
-**Impact:** If your code previously used `expiresIn` as a duration (e.g., to calculate an expiration time), you can now use it directly as the expiration `Date`.
+**Impact:** If your code references `ssoCredentials.expiresIn`, rename it to `ssoCredentials.expiresAt`. The value is now an absolute `Date` instead of a duration in seconds.
 
 ## Default Values Changed
 

auth0/src/main/java/com/auth0/android/request/internal/SSOCredentialsDeserializer.kt

@@ -60,11 +60,11 @@ internal open class SSOCredentialsDeserializer : JsonDeserializer<SSOCredentials
         idToken: String,
         issuedTokenType: String,
         tokenType: String,
-        expiresIn: Date,
+        expiresAt: Date,
         refreshToken: String?
     ): SSOCredentials {
         return SSOCredentials(
-            sessionTransferToken, idToken, issuedTokenType, tokenType, expiresIn, refreshToken
+            sessionTransferToken, idToken, issuedTokenType, tokenType, expiresAt, refreshToken
         )
     }
 }

auth0/src/main/java/com/auth0/android/result/SSOCredentials.kt

@@ -52,7 +52,7 @@ public data class SSOCredentials(
      *
      * @return the expiration Date of this session transfer token
      */
-    @field:SerializedName("expires_in") public val expiresIn: Date,
+    @field:SerializedName("expires_in") public val expiresAt: Date,
 
     /**
      *  Rotated refresh token. Only available when Refresh Token Rotation is enabled.
@@ -68,6 +68,6 @@ public data class SSOCredentials(
 ) {
 
     override fun toString(): String {
-        return "SSOCredentials(sessionTransferToken = ****, idToken = ****,issuedTokenType = $issuedTokenType, tokenType = $tokenType, expiresIn = $expiresIn, refreshToken = ****)"
+        return "SSOCredentials(sessionTransferToken = ****, idToken = ****,issuedTokenType = $issuedTokenType, tokenType = $tokenType, expiresAt = $expiresAt, refreshToken = ****)"
     }
 }

auth0/src/test/java/com/auth0/android/authentication/storage/CredentialsManagerTest.kt

@@ -334,7 +334,7 @@ public class CredentialsManagerTest {
         MatcherAssert.assertThat(credentials.tokenType, Is.`is`("token-type"))
         MatcherAssert.assertThat(credentials.issuedTokenType, Is.`is`("issued-token-type"))
         MatcherAssert.assertThat(credentials.refreshToken, Is.`is`("refresh-token"))
-        MatcherAssert.assertThat(credentials.expiresIn, Is.`is`(ssoExpiresAt))
+        MatcherAssert.assertThat(credentials.expiresAt, Is.`is`(ssoExpiresAt))
         verify(storage).store("com.auth0.refresh_token", credentials.refreshToken)
     }
 
@@ -427,7 +427,7 @@ public class CredentialsManagerTest {
         MatcherAssert.assertThat(credentials.tokenType, Is.`is`("token-type"))
         MatcherAssert.assertThat(credentials.issuedTokenType, Is.`is`("issued-token-type"))
         MatcherAssert.assertThat(credentials.refreshToken, Is.`is`("refresh-token"))
-        MatcherAssert.assertThat(credentials.expiresIn, Is.`is`(ssoExpiresAt))
+        MatcherAssert.assertThat(credentials.expiresAt, Is.`is`(ssoExpiresAt))
         verify(storage).store("com.auth0.refresh_token", credentials.refreshToken)
     }
 

auth0/src/test/java/com/auth0/android/authentication/storage/SecureCredentialsManagerTest.kt

@@ -348,7 +348,7 @@ public class SecureCredentialsManagerTest {
         MatcherAssert.assertThat(credentials.tokenType, Is.`is`("token-type"))
         MatcherAssert.assertThat(credentials.issuedTokenType, Is.`is`("issued-token-type"))
         MatcherAssert.assertThat(credentials.refreshToken, Is.`is`("refresh-token"))
-        MatcherAssert.assertThat(credentials.expiresIn, Is.`is`(ssoExpiresAt))
+        MatcherAssert.assertThat(credentials.expiresAt, Is.`is`(ssoExpiresAt))
         verify(storage).store(eq("com.auth0.credentials"), stringCaptor.capture())
         val encodedJson = stringCaptor.firstValue
         MatcherAssert.assertThat(encodedJson, Is.`is`(Matchers.notNullValue()))
@@ -528,7 +528,7 @@ public class SecureCredentialsManagerTest {
         MatcherAssert.assertThat(credentials.tokenType, Is.`is`("token-type"))
         MatcherAssert.assertThat(credentials.issuedTokenType, Is.`is`("issued-token-type"))
         MatcherAssert.assertThat(credentials.refreshToken, Is.`is`("refresh-token"))
-        MatcherAssert.assertThat(credentials.expiresIn, Is.`is`(ssoExpiresAt))
+        MatcherAssert.assertThat(credentials.expiresAt, Is.`is`(ssoExpiresAt))
         verify(storage).store(eq("com.auth0.credentials"), stringCaptor.capture())
         val encodedJson = stringCaptor.firstValue
         MatcherAssert.assertThat(encodedJson, Is.`is`(Matchers.notNullValue()))

auth0/src/test/java/com/auth0/android/request/internal/SSOCredentialsDeserializerMock.kt

@@ -11,11 +11,11 @@ internal class SSOCredentialsDeserializerMock : SSOCredentialsDeserializer() {
         idToken: String,
         issuedTokenType: String,
         tokenType: String,
-        expiresIn: Date,
+        expiresAt: Date,
         refreshToken: String?
     ): SSOCredentials {
         return SSOCredentialsMock.create(
-            sessionTransferToken, idToken, issuedTokenType, tokenType, refreshToken, expiresIn
+            sessionTransferToken, idToken, issuedTokenType, tokenType, refreshToken, expiresAt
         )
     }
 

auth0/src/test/java/com/auth0/android/request/internal/SSOCredentialsDeserializerTest.kt

@@ -26,8 +26,8 @@ public class SSOCredentialsDeserializerTest {
     public fun shouldSetExpiresInFromExpiresInSeconds() {
         val json = generateSSOCredentialsJSON()
         val credentials = gson.getAdapter(SSOCredentials::class.java).fromJson(json)
-        MatcherAssert.assertThat(credentials.expiresIn, Is.`is`(CoreMatchers.notNullValue()))
-        val expiresAt = credentials.expiresIn.time.toDouble()
+        MatcherAssert.assertThat(credentials.expiresAt, Is.`is`(CoreMatchers.notNullValue()))
+        val expiresAt = credentials.expiresAt.time.toDouble()
         val expectedExpiresAt = (CredentialsMock.CURRENT_TIME_MS + 300 * 1000).toDouble()
         MatcherAssert.assertThat(expiresAt, Is.`is`(Matchers.closeTo(expectedExpiresAt, 1.0)))
     }

auth0/src/test/java/com/auth0/android/result/SSOCredentialsMock.kt

@@ -12,10 +12,10 @@ public class SSOCredentialsMock {
             issuedTokenType: String,
             type: String,
             refreshToken: String?,
-            expiresIn: Date
+            expiresAt: Date
         ): SSOCredentials {
             return SSOCredentials(
-                accessToken, idToken, issuedTokenType, type, expiresIn, refreshToken
+                accessToken, idToken, issuedTokenType, type, expiresAt, refreshToken
             )
         }
     }