Deserialize HAL responses

[viesti]

Seems that API Gateway responses are not deserialized currently. I don't know the proper place/way to do deserialization, but here might be a pointer do get the embedded data of the HAL response: https://github.com/portkey-cloud/aws-clj-sdk/blob/master/src/portkey/aws.clj#L182-L197.

[dchelimsky]

The whole response is not deserialized, or do you mean the body? Can you post what you're getting back and what you're expecting to get back?

[viesti]

Ah sorry, forgot to post a sample :(

user=> (aws/invoke apigw-client {:op :GetRestApis})
{}
user=> (-> (aws/invoke apigw-client {:op :GetRestApis}) meta :http-response :body slurp json/read-json keys)
(:_links :_embedded)

The HTTP response body in the metadata is a JSON string in HAL form. I guess it could be deserialized as the result of aws/invoke.

[viesti]

Just to clarify, the GetRestApis invocation is able to get the list of APIs.

I expected (aws/invoke apigw-client {:op :GetRestApis}) to return data in form given by the response spec:

user=> (s/describe (aws/response-spec-key apigw-client :GetRestApis))
(keys :opt-un [:cognitect.aws.apigateway.RestApis/position :cognitect.aws.apigateway.RestApis/items])

[dchelimsky]

Thanks for that additional detail. I expect the same thing you do!

FYI, you can also see the response structure like this:

 user=> (-> apigw-client aws/ops :GetRestApis :response)
 {:position string,
  :items
  [:seq-of
   {:endpointConfiguration  {:types [:seq-of string]},
    :description            string,
    :name                   string,
    :warnings               [:seq-of string],
    :apiKeySource           string,
    :policy                 string,
    :binaryMediaTypes       [:seq-of string],
    :id                     string,
    :createdDate            timestamp,
    :version                string,
    :minimumCompressionSize integer}]}

[viesti]

Had a quick look and found client/parse-http-response multimethod, which dispatches on the protocol name, which is rest-json for API Gateway. The content-type http header could further used for selecting how to parse the response:

user> (-> apigw (aws/invoke {:op :GetRestApis}) meta (get-in [:http-response :headers "content-type"]))
"application/hal+json"

[dchelimsky]

Thanks @viesti - that's the same path I'm on. Just haven't had time to focus on this issue.

[viesti]

No problem, just had an inspiration to look into this. Focus&time are Muses that I find hard to catch :)

[dchelimsky]

Happy muse-hunting! And thanks for checking in. This just might get some attention now ;)

[dchelimsky]

So I started to look into this and discovered (and fixed) an edge-case bug parsing json structures. This is fixed on master, and was necessary for me to move forward w/ the HAL issue. Will keep you posted.

[dchelimsky]

I've got a solution for this on the issue-30-hal-responsesbranch, but I have a few things I want to work through in the code before I merge it.

[viesti]

Nice! Good thing if this work generally improves the library :)

[dchelimsky]

Agreed! There are other services that also return HAL responses, so this is a bit more general than just apigw.

[viesti]

True, I found that out myself only recently.

[maxthoursie]

Sorry for the duplicate! I can verify that the issue-30-hal-responses branch solves my issue!

[dchelimsky]

Thanks for the feedback @maxthoursie. I'm aiming to get a release out today.

[dchelimsky]

Fix merged to master. Release later today.

[dchelimsky]

Released in 0.8.198.