Merge pull request #179 from immutable/feat/game-bridge-passport-id

[DX-2756] feat: get passport id

Author: nattb8

sample/Assets/Scenes/AuthenticatedScene.unity

@@ -286,7 +286,7 @@ MonoBehaviour:
   m_TargetGraphic: {fileID: 416242725}
   m_HandleRect: {fileID: 416242724}
   m_Direction: 0
-  m_Value: 0
+  m_Value: 1
   m_Size: 1
   m_NumberOfSteps: 0
   m_OnValueChanged:

sample/Assets/Scenes/UnauthenticatedScene.unity

@@ -208,6 +208,12 @@ public async void GetEmail()
         ShowOutput(email ?? "No email");
     }
 
+    public async void GetPassportId()
+    {
+        string passportId = await passport.GetPassportId();
+        ShowOutput(passportId ?? "No Passport ID");
+    }
+
     public void ShowTransfer()
     {
         AuthenticatedCanvas.gameObject.SetActive(false);

sample/Assets/Scripts/AuthenticatedScript.cs

@@ -16,6 +16,7 @@ public static class PassportFunction
         public const string GET_ID_TOKEN = "getIdToken";
         public const string LOGOUT = "logout";
         public const string GET_EMAIL = "getEmail";
+        public const string GET_PASSPORT_ID = "getPassportId";
 
         public static class IMX
         {

src/Packages/Passport/Runtime/Resources/index.html

@@ -642,6 +642,12 @@ public async UniTask<string> GetEmail()
             return response.GetStringResult();
         }
 
+        public async UniTask<string> GetPassportId()
+        {
+            string response = await communicationsManager.Call(PassportFunction.GET_PASSPORT_ID);
+            return response.GetStringResult();
+        }
+
         public async UniTask<string> GetAccessToken()
         {
             string response = await communicationsManager.Call(PassportFunction.GET_ACCESS_TOKEN);

src/Packages/Passport/Runtime/Scripts/Private/PassportFunction.cs

@@ -257,6 +257,18 @@ public async UniTask<string> GetEmail()
             return email;
         }
 
+        /// <summary>
+        /// Retrieves the Passport ID of the user whose credentials are currently stored.
+        /// <returns>
+        /// The Passport ID, otherwise null
+        /// </returns>
+        /// </summary>
+        public async UniTask<string> GetPassportId()
+        {
+            string passportId = await GetPassportImpl().GetPassportId();
+            return passportId;
+        }
+
         /// <summary>
         /// Gets the currently saved access token without verifying its validity.
         /// <returns>

src/Packages/Passport/Runtime/Scripts/Private/PassportImpl.cs

@@ -42,6 +42,7 @@ public class PassportImplTests
         internal static string ID_TOKEN_KEY = "idToken";
         internal static string ADDRESS = "0xaddress";
         internal static string EMAIL = "[email protected]";
+        internal static string PASSPORT_ID = "email|123457890";
         internal static string SIGNATURE = "0xsignature";
         internal static string MESSAGE = "message";
         internal static string CODE = "IMX";
@@ -918,6 +919,33 @@ public async Task GetEmail_Failed()
             Assert.AreEqual(PassportFunction.GET_EMAIL, communicationsManager.fxName);
             Assert.True(String.IsNullOrEmpty(communicationsManager.data));
         }
+
+        [Test]
+        public async Task GetPassportId_Success()
+        {
+            var response = new StringResponse
+            {
+                success = true,
+                result = PASSPORT_ID
+            };
+            communicationsManager.AddMockResponse(response);
+
+            var passportId = await passport.GetPassportId();
+
+            Assert.AreEqual(PASSPORT_ID, passportId);
+            Assert.AreEqual(PassportFunction.GET_PASSPORT_ID, communicationsManager.fxName);
+            Assert.True(String.IsNullOrEmpty(communicationsManager.data));
+        }
+
+        [Test]
+        public async Task GetPassportId_Failed()
+        {
+            var passportId = await passport.GetPassportId();
+
+            Assert.Null(passportId);
+            Assert.AreEqual(PassportFunction.GET_PASSPORT_ID, communicationsManager.fxName);
+            Assert.True(String.IsNullOrEmpty(communicationsManager.data));
+        }
     }
 
     internal class MockBrowserCommsManager : IBrowserCommunicationsManager