Stricten, test, and bugfix http-server #170

diehuxx · 2024-02-09T00:53:28Z

All Changes

Turn on typescript strict mode for the http-server package. Fix any bugs that strict mode reveals.
Add many many tests which cover the request handlers completely, except for callback edge cases, which will be reworked in a follow up PR.
Refactor how TbdexHttpServer calls the callbacks because the previous way actually did not work.
Remove fakes.ts. Flesh out the "fake" implementations of ExchangesApi and OfferingsApi as fully usable InMemory implementations. See in-memory-exchanges-api.ts and in-memory-offerings-api.ts. These do not yet have 100% test coverage simply because this PR already adds ~1200 lines of tests; I'll add more tests in a follow up PR.

Changes to external API

Add fully fleshed out InMemoryExchangesApi and InMemoryOfferingsApi. These are used as defaults in TbdexHttpServer, but may be worth documenting in their own right.

Items TODO in follow up PRs

Reach 100% test coverage of in-memory-exchanges-api.ts and in-memory-offerings-api.ts.
Solidify the behavior of callback functions in the request handlers. Specifically, how callbacks can/cannot alter the HTTP response, how to handle if a callback throws an error, and what exactly should be passed to callbacks.

changeset-bot · 2024-02-09T00:53:32Z

⚠️ No Changeset found

Latest commit: 43c1390

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions · 2024-02-13T22:34:04Z

TBDocs Report

🛑 Errors: 0
⚠️ Warnings: 12

@tbdex/protocol

Project entry file: packages/protocol/src/main.ts

@tbdex/http-client

Project entry file: packages/http-client/src/main.ts

📄 File: packages/http-client/src/errors/request-error.ts
⚠️ `extractor:ae-missing-release-tag`: "RequestErrorParams" is part of the package's API, but it is missing a release tag (`@alpha`, `@beta`, `@public`, or `@internal`) #L1
⚠️ `extractor:ae-undocumented`: Missing documentation for "RequestErrorParams". #L1
⚠️ `extractor:ae-undocumented`: Missing documentation for "recipientDid". #L13
⚠️ `extractor:ae-undocumented`: Missing documentation for "url". #L14

📄 File: packages/http-client/src/errors/request-token-error.ts
⚠️ `extractor:ae-missing-release-tag`: "RequestTokenErrorParams" is part of the package's API, but it is missing a release tag (`@alpha`, `@beta`, `@public`, or `@internal`) #L3
⚠️ `extractor:ae-undocumented`: Missing documentation for "RequestTokenErrorParams". #L3

📄 File: packages/http-client/src/errors/response-error.ts
⚠️ `extractor:ae-missing-release-tag`: "ResponseErrorParams" is part of the package's API, but it is missing a release tag (`@alpha`, `@beta`, `@public`, or `@internal`) #L3
⚠️ `extractor:ae-undocumented`: Missing documentation for "ResponseErrorParams". #L3
⚠️ `extractor:ae-undocumented`: Missing documentation for "statusCode". #L15
⚠️ `extractor:ae-undocumented`: Missing documentation for "details". #L16
⚠️ `extractor:ae-undocumented`: Missing documentation for "recipientDid". #L17
⚠️ `extractor:ae-undocumented`: Missing documentation for "url". #L18

@tbdex/http-server

Project entry file: packages/http-server/src/main.ts

TBDocs Report Updated at 2024-02-16T22:41:57Z 43c1390

packages/http-server/tests/get-exchanges.spec.ts

packages/http-server/src/http-server.ts

codecov · 2024-02-13T22:35:39Z

Codecov Report

Merging #170 (43c1390) into main (0702d91) will increase coverage by 3.49%.
The diff coverage is 88.09%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #170      +/-   ##
==========================================
+ Coverage   88.99%   92.48%   +3.49%     
==========================================
  Files          36       37       +1     
  Lines        2825     2995     +170     
  Branches      262      321      +59     
==========================================
+ Hits         2514     2770     +256     
+ Misses        311      225      -86

Components	Coverage Δ
protocol	`93.39% <100.00%> (+<0.01%)`	⬆️
http-client	`93.63% <ø> (ø)`
http-server	`89.49% <87.86%> (+18.34%)`	⬆️

diehuxx · 2024-02-13T23:14:05Z

I'm deliberately not adding a changeset to this PR since I don't want to release a new version at this point. This PR adds a lot of tests and cleanup, but there is still more to come immediately afterward.

diehuxx · 2024-02-14T17:53:55Z

cc: @angiejones

packages/http-server/src/in-memory-exchanges-api.ts

packages/http-server/src/request-handlers/create-exchange.ts

KendallWeihe · 2024-02-15T13:25:03Z

This all makes sense to me (I only briefly glossed over the tests)

I'm deliberately not adding a changeset to this PR since I don't want to release a new version at this point. This PR adds a lot of tests and cleanup, but there is still more to come immediately afterward.

I think it may be good to list any breaking changes (changes to function signatures -- I call these "binary incompatibilities"), even if it's here in GitHub. But also, I'm not trying to promote unnecessary toil so I'm supportive of whatever we think is best. We have to manually cut releases so it's not like merging this will immediately break anything.

Great work!

mistermoe · 2024-02-15T17:01:02Z

yooo @diehuxx

Refactor how TbdexHttpServer calls the callbacks because the previous way actually did not work.

what was the issue?

jiyoontbd

nothing blocking, just a couple q's and comments! awesome work 🎉

packages/http-server/src/http-server.ts

packages/http-server/src/in-memory-exchanges-api.ts

jiyoontbd · 2024-02-15T04:57:57Z

packages/http-server/src/request-handlers/create-exchange.ts

  offeringsApi: OfferingsApi
  exchangesApi: ExchangesApi
 }

-export function createExchange(options: CreateExchangeOpts): RequestHandler {
+export async function createExchange(req: Request, res: Response, options: CreateExchangeOpts): Promise<any> {


could you explain the change from returning RequestHandler to Promise<any> ? i also am noticing that req and res are included as params as opposed to being abstracted away in the RequestHandler type definition

I just pushed a commit changing the return type of this function to Promise<void>, explanation in this comment thread.

We're not longer using RequestHandler because the usage of this function has changed (see this comment for details). Previously, createExchange would return a function, which would be consumed by the express.js router like this:

this.api.post('/exchanges/:exchangeId/rfq', createExchange({ callback: this.callbacks['rfq'], offeringsApi, exchangesApi, }))

Now, createExchange does NOT return a function. It is consumed as a curried function by the express js router like this

this.api.post('/exchanges/:exchangeId/rfq', (req: Request, res: Response) => createExchange(req, res, { callback: this.callbacks['rfq'], offeringsApi, exchangesApi, })

packages/http-server/src/request-handlers/create-exchange.ts

packages/http-server/src/request-handlers/get-exchanges.ts

jiyoontbd · 2024-02-15T16:56:08Z

packages/http-server/src/request-handlers/get-offerings.ts

-  return async function (request, response) {
-    const queryParams = request.query as GetOfferingsFilter
-    const offerings = await offeringsApi.getOfferings({ filter: queryParams || {} })
+  const filter: GetOfferingsFilter = {


i like this explicit typing, but was request.query as GetOfferingsFilter not working as expected?

Using as in typescript is like telling the compiler "just trust me bro", so it's good to avoid it unless we as programmers are pretty confident. Since request.query could realistically be anything, it's better to select the specific fields we want and use filter: GetOfferingsFilter to help us remember which fields we need.

packages/http-server/src/request-handlers/submit-close.ts

packages/http-server/tests/get-exchanges.spec.ts

packages/http-server/tests/submit-close.spec.ts

diehuxx · 2024-02-15T18:28:11Z

yooo @diehuxx

Refactor how TbdexHttpServer calls the callbacks because the previous way actually did not work.

what was the issue?

TL;DR functional programming is confusing.

Previously, in the listen method, we set the routes for the server like so:

this.api.get('/offerings', getOfferings({
      callback: this.callbacks['offerings'], offeringsApi
    }))

This calls this.callbacks['offerings'] at the time when server.listen() is called, which means that this.callbacks['offerings'] is always undefined because we haven't set our callbacks yet. What we actually want to do is get the callback when we handle an incoming message. I've done that like so:

    this.api.get('/offerings', (req, res) =>
      getOfferings(req, res, {
        callback: this.callbacks['offerings'],
        offeringsApi
      })
    )

The arrow method (req, res) => ... isn't called until the server handles an incoming request, which means this.callbacks['offerings'] isn't called until we handle a request. This allows us to do this:

const api = new TbdexHttpServer()
const server = api.listen()
api.onSubmitRfq(() => console.log('We received an RFQ'))
// When an RFQ is submitted, it prints
// "We received an RFQ"

// We can also overwrite the old callback
api.onSubmitRfq(() => console.log('TBDex is my best friend'))
// When an RFQ is submitted, it prints
// "TBDex is my best friend"

packages/http-server/src/request-handlers/get-offerings.ts

kirahsapong · 2024-02-15T20:55:24Z

packages/http-server/tests/create-exchange.spec.ts

+import { InMemoryExchangesApi } from '../src/in-memory-exchanges-api.js'
+import { InMemoryOfferingsApi } from '../src/in-memory-offerings-api.js'
+import { PortableDid } from '@web5/dids'
+import Sinon from 'sinon'

 describe('POST /exchanges/:exchangeId/rfq', () => {


i feel like we have a race condition happening here as it fails occasionally but maybe im gaslighting myself

Which test(s) specifically are failing? I haven't seen any flakiness but I can investigate if you let me know where to look.

kirahsapong

nyce!

* main: Version Packages (#167) Update web5/dids, web5/credentials, web5/crypto, web5/common to latest (#177)

Co-authored-by: Jiyoon Koo <[email protected]>

* main: Stricten, test, and bugfix http-server (#170) Version Packages (#167) Update web5/dids, web5/credentials, web5/crypto, web5/common to latest (#177) Add exchange state machine (#168) Stricten http-client (#169) Make `pfiDid` required property in `TbdexHttpServer` (#166)

* main: Add external_id field (#163) Stricten, test, and bugfix http-server (#170) Version Packages (#167) Update web5/dids, web5/credentials, web5/crypto, web5/common to latest (#177)

Base automatically changed from exchange-state-machine to main February 13, 2024 17:58

Stricten, test, and bugfix http-server

e60d7ae

diehuxx force-pushed the ts-strict-http-server branch from 6ae9c0a to e60d7ae Compare February 13, 2024 22:32

github-advanced-security bot found potential problems Feb 13, 2024

View reviewed changes

diehuxx marked this pull request as ready for review February 13, 2024 23:09

diehuxx requested review from michaelneale, mistermoe, jiyoontbd, phoebe-lew, KendallWeihe and kirahsapong as code owners February 13, 2024 23:09

KendallWeihe reviewed Feb 15, 2024

View reviewed changes

packages/http-server/src/in-memory-exchanges-api.ts Outdated Show resolved Hide resolved

KendallWeihe reviewed Feb 15, 2024

View reviewed changes

packages/http-server/src/in-memory-exchanges-api.ts Outdated Show resolved Hide resolved

KendallWeihe reviewed Feb 15, 2024

View reviewed changes

packages/http-server/src/request-handlers/create-exchange.ts Outdated Show resolved Hide resolved

jiyoontbd approved these changes Feb 15, 2024

View reviewed changes

mistermoe approved these changes Feb 15, 2024

View reviewed changes

kirahsapong reviewed Feb 15, 2024

View reviewed changes

packages/http-server/src/request-handlers/get-offerings.ts Outdated Show resolved Hide resolved

kirahsapong reviewed Feb 15, 2024

View reviewed changes

kirahsapong approved these changes Feb 15, 2024

View reviewed changes

jiyoontbd mentioned this pull request Feb 16, 2024

Use Exchange state machine in http-server TBD54566975/tbdex-kt#174

Open

diehuxx mentioned this pull request Feb 16, 2024

Rename GetExchanges query param id to exchangeIds TBD54566975/tbdex#239

Closed

PR comments

79f1958

Merge branch 'main' into ts-strict-http-server

ab0bc39

* main: Version Packages (#167) Update web5/dids, web5/credentials, web5/crypto, web5/common to latest (#177)

diehuxx force-pushed the ts-strict-http-server branch from f5bfd05 to ab0bc39 Compare February 16, 2024 22:38

Update packages/http-server/tests/submit-close.spec.ts

43c1390

Co-authored-by: Jiyoon Koo <[email protected]>

diehuxx merged commit ebefc54 into main Feb 16, 2024
15 of 17 checks passed

diehuxx deleted the ts-strict-http-server branch February 16, 2024 22:42

jiyoontbd mentioned this pull request Feb 17, 2024

POST /exchanges/:id/order figure out what to do with callback result if anything #10

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Stricten, test, and bugfix http-server #170

Stricten, test, and bugfix http-server #170

diehuxx commented Feb 9, 2024 •

edited

Loading

changeset-bot bot commented Feb 9, 2024 •

edited

Loading

github-actions bot commented Feb 13, 2024 •

edited

Loading

codecov bot commented Feb 13, 2024 •

edited

Loading

diehuxx commented Feb 13, 2024

diehuxx commented Feb 14, 2024

KendallWeihe commented Feb 15, 2024 •

edited

Loading

mistermoe commented Feb 15, 2024

jiyoontbd left a comment

jiyoontbd Feb 15, 2024

diehuxx Feb 16, 2024

jiyoontbd Feb 15, 2024

diehuxx Feb 16, 2024

diehuxx commented Feb 15, 2024

kirahsapong Feb 15, 2024

diehuxx Feb 16, 2024

kirahsapong left a comment

Stricten, test, and bugfix http-server #170

Stricten, test, and bugfix http-server #170

Conversation

diehuxx commented Feb 9, 2024 • edited Loading

All Changes

Changes to external API

Items TODO in follow up PRs

changeset-bot bot commented Feb 9, 2024 • edited Loading

⚠️ No Changeset found

github-actions bot commented Feb 13, 2024 • edited Loading

@tbdex/protocol

@tbdex/http-client

@tbdex/http-server

codecov bot commented Feb 13, 2024 • edited Loading

Codecov Report

diehuxx commented Feb 13, 2024

diehuxx commented Feb 14, 2024

KendallWeihe commented Feb 15, 2024 • edited Loading

mistermoe commented Feb 15, 2024

jiyoontbd left a comment

Choose a reason for hiding this comment

jiyoontbd Feb 15, 2024

Choose a reason for hiding this comment

diehuxx Feb 16, 2024

Choose a reason for hiding this comment

jiyoontbd Feb 15, 2024

Choose a reason for hiding this comment

diehuxx Feb 16, 2024

Choose a reason for hiding this comment

diehuxx commented Feb 15, 2024

kirahsapong Feb 15, 2024

Choose a reason for hiding this comment

diehuxx Feb 16, 2024

Choose a reason for hiding this comment

kirahsapong left a comment

Choose a reason for hiding this comment

diehuxx commented Feb 9, 2024 •

edited

Loading

changeset-bot bot commented Feb 9, 2024 •

edited

Loading

github-actions bot commented Feb 13, 2024 •

edited

Loading

codecov bot commented Feb 13, 2024 •

edited

Loading

KendallWeihe commented Feb 15, 2024 •

edited

Loading