Implement GetBalance client call and server endpoint by jiyoonie9 · Pull Request #217 · TBD54566975/tbdex-kt

jiyoonie9 · 2024-03-29T05:37:07Z

Implemented GetBalance client method (with auth token)
Implemented GetBalance server endpoint and request handler (with auth token verification)
Wrote bare bones BalancesApi interface with 1 method, GetBalances(requesterDid: String) and implemented FakeBalancesApi
Wrote tests for the new client and server methods

…assing, but test vectors need to be fixed, also need to look at the new regex pattern decimalString and see if it still works with numbers with decimal

… failing.

…col-spec-changes

…ctor tests

…alance

…en check on getbalances handler method. formatting

diehuxx · 2024-03-31T16:59:30Z

httpclient/src/main/kotlin/tbdex/sdk/httpclient/TbdexHttpClient.kt

+   * @param pfiDid The decentralized identifier of the PFI.
+   * @param requesterDid The decentralized identifier of the entity requesting the balances.
+   * @return A list of [Balance] matching the request.
+   * @throws TbdexResponseException for request or response errors.


Thinking out loud: in tbdex-js, we have both TbdexRequestError and TbdexResponseError, representing errors that happen before and after the client call respectively. It's a slight misnomer to throw a RequestException for both request and response errors, so I'm making a mental note that in my next tidy-up PR, I may explore introducing a TbdexRequestException class. In any case, it's relatively low priority and outside the scope of this PR.

diehuxx · 2024-03-31T17:00:08Z

httpclient/src/main/kotlin/tbdex/sdk/httpclient/TbdexHttpClient.kt

+        val jsonNode = jsonMapper.readTree(responseString)
+        return jsonNode.get("data").elements()
+          .asSequence()
+          .map { Balance.parse(it.toString()) }


Nit/suggestion: Wrap this Balance.parse() in a try/catch that catches and re-throws as a TbdexResponseException.

httpserver/src/main/kotlin/tbdex/sdk/httpserver/handlers/GetBalances.kt

httpserver/src/main/kotlin/tbdex/sdk/httpserver/models/BalancesApi.kt

diehuxx · 2024-03-31T17:13:05Z

httpserver/src/test/kotlin/tbdex/sdk/httpserver/handlers/GetBalancesTest.kt

+      coVerify(exactly = 1) { callback.invoke(applicationCall) }
+      coVerify { applicationCall.respond(HttpStatusCode.OK, any<GetBalancesResponse>()) }


niceeee. thanks for setting this up. it'll be easy now to copy this pattern for other callback tests in this library.

diehuxx · 2024-03-31T17:17:49Z

httpserver/src/test/kotlin/tbdex/sdk/httpserver/handlers/GetBalancesTest.kt

i love to see such thorough testing

diehuxx

a few nits, but nothing blocking. great work.

Co-authored-by: Diane Huxley <dhuxley@tbd.email>

mistermoe · 2024-03-31T19:25:47Z

httpclient/src/main/kotlin/tbdex/sdk/httpclient/TbdexHttpClient.kt

+   * @return A list of [Balance] matching the request.
+   * @throws TbdexResponseException for request or response errors.
+   */
+  @Suppress("SwallowedException")


what exception gets swallowed?

the exception thrown if Balance.parse(it.toString()) fails in the try/catch, line 123. it gets re-thrown as TbdexResponseException as implemented per this suggestion

mistermoe · 2024-03-31T19:26:53Z

httpclient/src/main/kotlin/tbdex/sdk/httpclient/TbdexHttpClient.kt

+      .get()
+      .build()
+
+    val response: Response = client.newCall(request).execute()


ah does this throw an exception if the request fails? e.g. timeout, EHANGUP etc.

correct. from the docs:

Throws: IOException - if the request could not be executed due to cancellation, a connectivity problem or timeout. Because networks can fail during an exchange, it is possible that the remote server accepted the request before the failure. IllegalStateException - when the call has already been executed.

mistermoe · 2024-03-31T19:31:25Z

httpserver/src/main/kotlin/tbdex/sdk/httpserver/handlers/GetBalances.kt

+  val authzHeader = call.request.headers[HttpHeaders.Authorization]
+  if (authzHeader == null) {
+    call.respond(
+      HttpStatusCode.Unauthorized,
+      ErrorResponse(
+        errors = listOf(
+          ErrorDetail(
+            detail = "Authorization header required"
+          )
+        )
+      )
+    )
+    return
+  }
+
+  val arr = authzHeader.split("Bearer ")
+  if (arr.size != 2) {
+    call.respond(
+      HttpStatusCode.Unauthorized,
+      ErrorResponse(
+        errors = listOf(
+          ErrorDetail(
+            detail = "Malformed Authorization header. Expected: Bearer TOKEN_HERE"
+          )
+        )
+      )
+    )
+    return
+  }
+
+  val token = arr[1]
+  val requesterDid: String
+  try {
+    requesterDid = RequestToken.verify(token, pfiDid)
+  } catch (e: Exception) {
+    call.respond(
+      HttpStatusCode.Unauthorized,
+      ErrorResponse(
+        errors = listOf(
+          ErrorDetail(
+            detail = "Could not verify Authorization header."
+          )
+        )
+      )
+    )
+    return


I haven't used ktor before but if it has the concept of middleware, maybe it'd be helpful to abstract this logic out into a verifyAuthzHeader middleware? and if ktor doesn't have the middleware concept, could just tuck this into a method and use it for all protected endpoints. (note for future PR)

yes. there is a ton of repeat here for all protected endpoints' request handler. Issue #227

nice. had a similar issue in swift TBD54566975/tbdex-swift#85

js could use some drying up also. will create an issue

here: TBD54566975/tbdex-js#223

mistermoe

great work @jiyoontbd !

kirahsapong

nice! couple comments, mostly just that balance endpoint is optional. once resolved lgtm

httpserver/src/main/kotlin/tbdex/sdk/httpserver/TbdexHttpServer.kt

kirahsapong · 2024-03-31T20:10:20Z

httpserver/src/main/kotlin/tbdex/sdk/httpserver/TbdexHttpServer.kt

+        )
+      }
+
+      get("/balances") {


this should be an optional endpoint

ooh, i added the suggested change you posted earlier, but actually instead o that, i'd like to wrap this in a condition that checks for a new config value balancesEnabled

i think it will be good for testing to still have balancesApi = config.balancesApi ?: FakeBalancesApi()

i thought it might be helpful to share how the optional endpoint is implemented in js right now: https://github.com/TBD54566975/tbdex-js/blob/main/packages/http-server/src/http-server.ts#L45

and also this comment thread on the PR for it: TBD54566975/tbdex-js#212 (comment)

@KendallWeihe's proposal was simplifying it by keeping consistent with the other fields, and having the consumer explicitly pass in FakeBalancesApi() when instantiating the server to indicate they wanted to opt in / enable it

but either approach is cool, prob just good to make sure its aligned. i can open an issue in JS to add a balancesEnabled config value if we want to go with it, lmk!

okey, i've aligned on essentially using balancesApi null check essentially the config on whether to enable balances. i like balancesEnabled config as it's slightly more explicit? but can see how things can go awry there too. let's revisit it if there's feedback from sdk consumers to change this

kirahsapong · 2024-03-31T20:14:36Z

httpserver/src/main/kotlin/tbdex/sdk/httpserver/handlers/GetBalances.kt

+  val authzHeader = call.request.headers[HttpHeaders.Authorization]
+  if (authzHeader == null) {
+    call.respond(
+      HttpStatusCode.Unauthorized,
+      ErrorResponse(
+        errors = listOf(
+          ErrorDetail(
+            detail = "Authorization header required"
+          )
+        )
+      )
+    )
+    return
+  }
+
+  val arr = authzHeader.split("Bearer ")
+  if (arr.size != 2) {
+    call.respond(
+      HttpStatusCode.Unauthorized,
+      ErrorResponse(
+        errors = listOf(
+          ErrorDetail(
+            detail = "Malformed Authorization header. Expected: Bearer TOKEN_HERE"
+          )
+        )
+      )
+    )
+    return
+  }
+
+  val token = arr[1]
+  val requesterDid: String
+  try {
+    requesterDid = RequestToken.verify(token, pfiDid)
+  } catch (e: Exception) {
+    call.respond(
+      HttpStatusCode.Unauthorized,
+      ErrorResponse(
+        errors = listOf(
+          ErrorDetail(
+            detail = "Could not verify Authorization header."
+          )
+        )
+      )
+    )
+    return


nice. had a similar issue in swift TBD54566975/tbdex-swift#85

js could use some drying up also. will create an issue

kirahsapong · 2024-03-31T20:14:42Z

httpserver/src/main/kotlin/tbdex/sdk/httpserver/handlers/GetBalances.kt

+  val authzHeader = call.request.headers[HttpHeaders.Authorization]
+  if (authzHeader == null) {
+    call.respond(
+      HttpStatusCode.Unauthorized,
+      ErrorResponse(
+        errors = listOf(
+          ErrorDetail(
+            detail = "Authorization header required"
+          )
+        )
+      )
+    )
+    return
+  }
+
+  val arr = authzHeader.split("Bearer ")
+  if (arr.size != 2) {
+    call.respond(
+      HttpStatusCode.Unauthorized,
+      ErrorResponse(
+        errors = listOf(
+          ErrorDetail(
+            detail = "Malformed Authorization header. Expected: Bearer TOKEN_HERE"
+          )
+        )
+      )
+    )
+    return
+  }
+
+  val token = arr[1]
+  val requesterDid: String
+  try {
+    requesterDid = RequestToken.verify(token, pfiDid)
+  } catch (e: Exception) {
+    call.respond(
+      HttpStatusCode.Unauthorized,
+      ErrorResponse(
+        errors = listOf(
+          ErrorDetail(
+            detail = "Could not verify Authorization header."
+          )
+        )
+      )
+    )
+    return


here: TBD54566975/tbdex-js#223

…r.kt Co-authored-by: kirahsapong <102400653+kirahsapong@users.noreply.github.com>

Jiyoon Koo added 12 commits March 25, 2024 23:33

adding balance, fixing offerings. wip

5894279

adding optional success field to close message

0dba7c2

fixing test data message and resource constructions. more tests are p…

f21cdf0

…assing, but test vectors need to be fixed, also need to look at the new regex pattern decimalString and see if it still works with numbers with decimal

in the middle of refactoring - all tests using test vectors are still…

35aa08d

… failing.

adding a todo

a1d2f91

Merge branch 'main' of github.com:TBD54566975/tbdex-kt into 207-proto…

09f4762

…col-spec-changes

refactoring method name in vector test

494156b

bumping submodule commit

6a57244

adding ktdocs

6b74577

more ktdocs

7a0ae63

adding balance and resource tests for balance. adding balance test ve…

18dd13f

…ctor tests

adding new client method to fetch balances

ceadf77

jiyoonie9 changed the base branch from main to 207-protocol-spec-changes March 29, 2024 05:37

jiyoonie9 linked an issue Mar 29, 2024 that may be closed by this pull request

Implement GET balance endpoint and client method #133

Closed

Jiyoon Koo added 2 commits March 29, 2024 14:31

wrote client tests

0ce5957

adding server endpoint for balance api

da2aafe

Base automatically changed from 207-protocol-spec-changes to main March 30, 2024 05:10

Jiyoon Koo added 5 commits March 30, 2024 01:19

Merge branch 'main' of github.com:TBD54566975/tbdex-kt into 133-get-b…

15d18d3

…alance

adding detekt fixes. still 1 test failing due to rfq schema error

8a31cda

Merge branch 'main' of github.com:TBD54566975/tbdex-kt into 133-get-b…

61a1446

…alance

adding requesterDid to balanceApi.getBalance param. doing an auth tok…

393e9eb

…en check on getbalances handler method. formatting

refactoring existing tests. add new test for getbalance

1fad2ed

jiyoonie9 changed the title ~~133 get balance~~ Implement GetBalance client call and server endpoint Mar 31, 2024

jiyoonie9 marked this pull request as ready for review March 31, 2024 04:13

jiyoonie9 requested review from KendallWeihe, ethanwlee, michaelneale, mistermoe, phoebe-lew and tomdaffurn as code owners March 31, 2024 04:13

jiyoonie9 requested review from diehuxx, kirahsapong and nitro-neal as code owners March 31, 2024 04:13

adding ktdoc for fakeBalancesApi#addBalance

01d6a12

diehuxx reviewed Mar 31, 2024

View reviewed changes

httpserver/src/main/kotlin/tbdex/sdk/httpserver/handlers/GetBalances.kt Outdated Show resolved Hide resolved

diehuxx reviewed Mar 31, 2024

View reviewed changes

httpserver/src/main/kotlin/tbdex/sdk/httpserver/handlers/GetBalances.kt Outdated Show resolved Hide resolved

diehuxx reviewed Mar 31, 2024

View reviewed changes

httpserver/src/main/kotlin/tbdex/sdk/httpserver/models/BalancesApi.kt Outdated Show resolved Hide resolved

diehuxx reviewed Mar 31, 2024

View reviewed changes

diehuxx approved these changes Mar 31, 2024

View reviewed changes

Jiyoon Koo and others added 2 commits March 31, 2024 14:49

Apply suggestions from code review

9f90c3c

Co-authored-by: Diane Huxley <dhuxley@tbd.email>

adding try catch around parsing balance and offering

0e8d498

mistermoe reviewed Mar 31, 2024

View reviewed changes

mistermoe approved these changes Mar 31, 2024

View reviewed changes

jiyoonie9 mentioned this pull request Mar 31, 2024

De-duplicate authz verification step #227

Open

kirahsapong approved these changes Mar 31, 2024

View reviewed changes

Jiyoon Koo and others added 4 commits March 31, 2024 16:33

Update httpserver/src/main/kotlin/tbdex/sdk/httpserver/TbdexHttpServe…

c67f00a

…r.kt Co-authored-by: kirahsapong <102400653+kirahsapong@users.noreply.github.com>

adding balancesEnabled config

43bf4c8

aligning with tbdex-js way of making balancesapi optional

f500e35

removed testserver

c71048d

jiyoonie9 merged commit d87adb2 into main Mar 31, 2024

jiyoonie9 deleted the 133-get-balance branch March 31, 2024 21:19

diehuxx mentioned this pull request Mar 31, 2024

Hash Rfq privateData #222

Merged

		coVerify(exactly = 1) { callback.invoke(applicationCall) }
		coVerify { applicationCall.respond(HttpStatusCode.OK, any<GetBalancesResponse>()) }

Conversation

jiyoonie9 commented Mar 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

diehuxx left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jiyoonie9 Mar 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mistermoe left a comment

Choose a reason for hiding this comment

Uh oh!

kirahsapong left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kirahsapong Mar 31, 2024 • edited by jiyoonie9 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jiyoonie9 commented Mar 29, 2024 •

edited

Loading

jiyoonie9 Mar 31, 2024 •

edited

Loading

kirahsapong Mar 31, 2024 •

edited by jiyoonie9

Loading