From a2f3c2f1718b08a4d3a84a6c1be1d2fefd912ddf Mon Sep 17 00:00:00 2001
From: David Perez <david@livefront.com>
Date: Tue, 26 Mar 2024 11:23:51 -0500
Subject: [PATCH] Add 'Device-Identifier' header for auth-requests API (#1174)

---
 .../network/api/UnauthenticatedAuthRequestsApi.kt   |  2 ++
 .../network/service/NewAuthRequestServiceImpl.kt    |  3 ++-
 .../network/service/NewAuthRequestServiceTest.kt    | 13 +++++++++----
 3 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/api/UnauthenticatedAuthRequestsApi.kt b/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/api/UnauthenticatedAuthRequestsApi.kt
index 395b966ad2..36530e05f1 100644
--- a/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/api/UnauthenticatedAuthRequestsApi.kt
+++ b/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/api/UnauthenticatedAuthRequestsApi.kt
@@ -4,6 +4,7 @@ import com.x8bit.bitwarden.data.auth.datasource.network.model.AuthRequestRequest
 import com.x8bit.bitwarden.data.auth.datasource.network.model.AuthRequestsResponseJson
 import retrofit2.http.Body
 import retrofit2.http.GET
+import retrofit2.http.Header
 import retrofit2.http.POST
 import retrofit2.http.Path
 import retrofit2.http.Query
@@ -18,6 +19,7 @@ interface UnauthenticatedAuthRequestsApi {
      */
     @POST("/auth-requests")
     suspend fun createAuthRequest(
+        @Header("Device-Identifier") deviceIdentifier: String,
         @Body body: AuthRequestRequestJson,
     ): Result<AuthRequestsResponseJson.AuthRequest>
 
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/service/NewAuthRequestServiceImpl.kt b/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/service/NewAuthRequestServiceImpl.kt
index cd1d936397..c108373c6c 100644
--- a/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/service/NewAuthRequestServiceImpl.kt
+++ b/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/service/NewAuthRequestServiceImpl.kt
@@ -19,7 +19,8 @@ class NewAuthRequestServiceImpl(
         fingerprint: String,
     ): Result<AuthRequestsResponseJson.AuthRequest> =
         unauthenticatedAuthRequestsApi.createAuthRequest(
-            AuthRequestRequestJson(
+            deviceIdentifier = deviceId,
+            body = AuthRequestRequestJson(
                 email = email,
                 publicKey = publicKey,
                 deviceId = deviceId,
diff --git a/app/src/test/java/com/x8bit/bitwarden/data/auth/datasource/network/service/NewAuthRequestServiceTest.kt b/app/src/test/java/com/x8bit/bitwarden/data/auth/datasource/network/service/NewAuthRequestServiceTest.kt
index ec71e8bf53..bc63b9d17b 100644
--- a/app/src/test/java/com/x8bit/bitwarden/data/auth/datasource/network/service/NewAuthRequestServiceTest.kt
+++ b/app/src/test/java/com/x8bit/bitwarden/data/auth/datasource/network/service/NewAuthRequestServiceTest.kt
@@ -3,6 +3,7 @@ package com.x8bit.bitwarden.data.auth.datasource.network.service
 import com.x8bit.bitwarden.data.auth.datasource.network.api.UnauthenticatedAuthRequestsApi
 import com.x8bit.bitwarden.data.auth.datasource.network.model.AuthRequestsResponseJson
 import com.x8bit.bitwarden.data.platform.base.BaseServiceTest
+import com.x8bit.bitwarden.data.platform.util.asSuccess
 import kotlinx.coroutines.test.runTest
 import okhttp3.mockwebserver.MockResponse
 import org.junit.jupiter.api.Assertions.assertEquals
@@ -22,13 +23,15 @@ class NewAuthRequestServiceTest : BaseServiceTest() {
     fun `createAuthRequest when request response is Failure should return Failure`() = runTest {
         val response = MockResponse().setResponseCode(400)
         server.enqueue(response)
+        val deviceIdentifier = "4321"
         val actual = service.createAuthRequest(
             email = "test@gmail.com",
             publicKey = "1234",
-            deviceId = "4321",
+            deviceId = deviceIdentifier,
             accessCode = "accessCode",
             fingerprint = "fingerprint",
         )
+        assertEquals(deviceIdentifier, server.takeRequest().getHeader("Device-Identifier"))
         assertTrue(actual.isFailure)
     }
 
@@ -36,14 +39,16 @@ class NewAuthRequestServiceTest : BaseServiceTest() {
     fun `createAuthRequest when request response is Success should return Success`() = runTest {
         val response = MockResponse().setBody(AUTH_REQUEST_RESPONSE_JSON).setResponseCode(200)
         server.enqueue(response)
+        val deviceIdentifier = "4321"
         val actual = service.createAuthRequest(
             email = "test@gmail.com",
             publicKey = "1234",
-            deviceId = "4321",
+            deviceId = deviceIdentifier,
             accessCode = "accessCode",
             fingerprint = "fingerprint",
         )
-        assertEquals(Result.success(AUTH_REQUEST_RESPONSE), actual)
+        assertEquals(deviceIdentifier, server.takeRequest().getHeader("Device-Identifier"))
+        assertEquals(AUTH_REQUEST_RESPONSE.asSuccess(), actual)
     }
 
     @Test
@@ -65,7 +70,7 @@ class NewAuthRequestServiceTest : BaseServiceTest() {
             requestId = "1",
             accessCode = "accessCode",
         )
-        assertEquals(Result.success(AUTH_REQUEST_RESPONSE), actual)
+        assertEquals(AUTH_REQUEST_RESPONSE.asSuccess(), actual)
     }
 }