feat(rest)!: update to AFJ 0.2.0

[janrtvld]

I think the switch to tsoa has improved the OpenAPI spec quite a lot. However, there are a few drawbacks (mainly related to the issues lukeautry/tsoa#1268, lukeautry/tsoa#1267 & lukeautry/tsoa#1266).

I think it is fine for now, but if there are better alternatives i'd be happy to change it. It isn't that much work if we don't combine it with a major AFJ release :).

[berendsliedrecht]

Not any major notes.

I think something that we can improve upon, in a follow-up would PR would be to generalize the error handling of an apicall.

Recordnotfound will always return 404, if we don't know we return 500, etc.

It could be as simlpe as:

handleHttpErrors(() => {
  return {status: 200}
})

const handleHttpErrors = (cb: (...args: any[]) => void | Promise<void>) => {
  try {
    cb()
  } catch(e) {
    if(e instanceof RecordNotFoundError) {
      return {status: 404, message: "Record not found"}
    }
  }
}

[berendsliedrecht]

Not an important comment, but it would be nice if we could handle the internalservererror(500, ...) wihtout specifying it like this all the time. Will think about this.

[berendsliedrecht]

Is there a reason why we explicitly pass 404 to NotFound? Shouldn't that be handled by the function as 404 == not-found?

[berendsliedrecht]

We should look into generating this... even if it will be

{
  "did": "string",
  "isDid": "boolean"
}

[janrtvld]

What do you mean? Generating examples instead of defining them ourselves?

[berendsliedrecht]

Yeah, and even the generating it like this would be fine. However, we shouldn't over engineer it :).

[janrtvld]

I looked into a cleaner way to handle the errors with a handleError function, but when you don't use @Res() notFoundError: TsoaResponse<404, { reason: string }> tsoa doesn't seem to infer the types for the OpenAPI spec.

[TimoGlastra]

Some feedback from my side:

• In the credentials API I think it would be nice to keep the endpoints for a specific record with the credentialRecordId in it. (like we have with proofs still). This is best practice when building REST APIs.
• there are types in the swagger ui that I'm not sure will work with the current API. Maybe we can exclude those from the API for now (e.g. linkedAttachments don't think will work because of the difference in interface <-> json keys)

Also, @janrtvld Maybe we can merge this PR into a separate branch and start making incremental PRs?

[janrtvld]

I have changed the credentials Api to use the credentialRecord Id in the endpoint. I have also excluded the Routing and Attachment properties from the API.

if there isn't anything else i think we can merge this. If we want to add more i'm fine working on a separate branch.

[TimoGlastra]

Great! I think there were also messages that you can pass to the oob apis. Have you tested whether that works?

[TimoGlastra]

It seems the create-offer method is missing in the API. But we can add that in a separate PR

Have opened issue for create-invitation: #156

[TimoGlastra]

Some other parameters to remove:

• appendedAttachments from oob/create-invitation
• routing + appendedAttachments from oob/receive-invitation
• routing from oob/receive-invitation-url

[codecov-commenter]

Codecov Report

Merging #148 (e70aa01) into main (c0351c5) will decrease coverage by 0.83%.
The diff coverage is 84.16%.

@@            Coverage Diff             @@
##             main     #148      +/-   ##
==========================================
- Coverage   87.07%   86.24%   -0.84%     
==========================================
  Files          45       21      -24     
  Lines         681     1163     +482     
  Branches       92      260     +168     
==========================================
+ Hits          593     1003     +410     
- Misses         76      146      +70     
- Partials       12       14       +2     

Impacted Files	Coverage Δ
packages/rest/src/routes/routes.ts	86.58% <ø> (ø)
packages/rest/src/utils/util.ts	100.00% <ø> (ø)
packages/rest/src/utils/webhook.ts	100.00% <ø> (ø)
packages/rest/src/utils/agent.ts	62.96% <50.00%> (ø)
packages/rest/src/server.ts	79.59% <70.58%> (-11.84%)	⬇️
...st/src/controllers/credentials/SchemaController.ts	82.35% <77.77%> (+3.78%)	⬆️
...lers/credentials/CredentialDefinitionController.ts	87.87% <83.33%> (+3.26%)	⬆️
...rc/controllers/connections/ConnectionController.ts	83.92% <84.09%> (+3.92%)	⬆️
...rc/controllers/credentials/CredentialController.ts	87.36% <84.28%> (+5.66%)	⬆️
...ges/rest/src/controllers/proofs/ProofController.ts	83.51% <85.96%> (+2.74%)	⬆️
... and 24 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[TimoGlastra]

Ready to merge 👀 ???