Add exchange state machine #168

diehuxx · 2024-02-09T00:34:17Z

This state machine class Exchange will be used to great effect in a follow-up PR in the http-server package.

changeset-bot · 2024-02-09T00:34:21Z

🦋 Changeset detected

Latest commit: e755787

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@tbdex/protocol	Patch
@tbdex/http-client	Patch
@tbdex/http-server	Patch

Not sure what this means? Click here to learn what changesets are.

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

github-actions · 2024-02-09T00:36:11Z

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-13T17:54:29Z e755787

codecov · 2024-02-09T00:43:15Z

Codecov Report

Merging #168 (e755787) into main (552675c) will increase coverage by 3.58%.
Report is 3 commits behind head on main.
The diff coverage is 96.82%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #168      +/-   ##
==========================================
+ Coverage   85.55%   89.13%   +3.58%     
==========================================
  Files          35       36       +1     
  Lines        2803     2871      +68     
  Branches      234      268      +34     
==========================================
+ Hits         2398     2559     +161     
+ Misses        405      312      -93

Components	Coverage Δ
protocol	`93.51% <96.82%> (+3.49%)`	⬆️
http-client	`93.62% <ø> (+6.83%)`	⬆️
http-server	`71.15% <ø> (-0.41%)`	⬇️

mistermoe

amajing

jiyoonie9 · 2024-02-13T03:52:35Z

packages/protocol/tests/exchange.spec.ts

+    it('adds an Rfq', async () => {
+      const aliceDid = await DevTools.createDid()
+      const pfiDid = await DevTools.createDid()
+      const rfq = Rfq.create({


i think we have devtool methods to create messages

is it possible to have a top level beforeEach() where the messages are defined for each nested describe() tests? then you don't have to repeat them for each nested describe()

The devtool methods are useful for creating a message with any random metadata, but it's more concise to use the .create() methods in this case so we can specify to, from, and exchangeId.

I updated beforeEach() according to your suggestion.

jiyoonie9 · 2024-02-13T03:53:35Z

packages/protocol/tests/exchange.spec.ts

+          exchangeId : rfq.metadata.exchangeId,
+        },
+        data: {
+          reason: 'I dont like u anymore'


jiyoonie9 · 2024-02-13T03:58:20Z

packages/protocol/tests/exchange.spec.ts

+          }
+        }
+      })
+


i think this test is checking for the messages we can't add after rfq - could we have similar "negative" tests for quote, order, orderstatus, and close?

i.e.

quote: cannot add orderstatus after quote

order: cannot add rfq or quote after order

orderstatus: cannot add rfq, quote, order after orderstatus

Good call. Done.

jiyoonie9 · 2024-02-13T04:01:05Z

.changeset/green-cheetahs-share.md

@@ -0,0 +1,5 @@
+---


do they tho? i feel like cheetahs aren't good at sharing.

green cheetahs are envious cheetahs

* 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)

diehuxx requested review from michaelneale, mistermoe, jiyoonie9, phoebe-lew, KendallWeihe and kirahsapong as code owners February 9, 2024 00:34

diehuxx force-pushed the exchange-state-machine branch from d49e4fc to 8a5ee23 Compare February 9, 2024 00:36

Add exchange state machine

ced180a

diehuxx force-pushed the exchange-state-machine branch from 8a5ee23 to ced180a Compare February 9, 2024 00:40

Diane Huxley added 2 commits February 8, 2024 18:00

Fix tsdoc warnings

6007783

lint

26a2917

mistermoe approved these changes Feb 12, 2024

View reviewed changes

Changeset

9054e08

jiyoonie9 approved these changes Feb 13, 2024

View reviewed changes

Diane Huxley added 2 commits February 13, 2024 09:41

Additional tests

448a772

Fix

e755787

diehuxx force-pushed the exchange-state-machine branch from b42642a to e755787 Compare February 13, 2024 17:52

diehuxx merged commit 589edc3 into main Feb 13, 2024
16 of 17 checks passed

diehuxx deleted the exchange-state-machine branch February 13, 2024 17:58

jiyoonie9 mentioned this pull request Feb 16, 2024

Add Exchange state machine class TBD54566975/tbdex-kt#173

Open

This was referenced Feb 23, 2024

[http-server] multiple Orders can be sent for a single exchange #64

Closed

[http-server] add exchangeId lock #65

Open

kirahsapong mentioned this pull request Mar 2, 2024

Distinguish between success and failure in Close message TBD54566975/tbdex#242

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add exchange state machine #168

Add exchange state machine #168

diehuxx commented Feb 9, 2024

changeset-bot bot commented Feb 9, 2024 •

edited

Loading

github-actions bot commented Feb 9, 2024 •

edited

Loading

codecov bot commented Feb 9, 2024 •

edited

Loading

mistermoe left a comment

jiyoonie9 Feb 13, 2024

jiyoonie9 Feb 13, 2024

diehuxx Feb 13, 2024

jiyoonie9 Feb 13, 2024

jiyoonie9 Feb 13, 2024

diehuxx Feb 13, 2024

jiyoonie9 Feb 13, 2024

diehuxx Feb 13, 2024

Add exchange state machine #168

Add exchange state machine #168

Conversation

diehuxx commented Feb 9, 2024

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

🦋 Changeset detected

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

@tbdex/protocol

@tbdex/http-client

@tbdex/http-server

codecov bot commented Feb 9, 2024 • edited Loading

Codecov Report

mistermoe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

changeset-bot bot commented Feb 9, 2024 •

edited

Loading

github-actions bot commented Feb 9, 2024 •

edited

Loading

codecov bot commented Feb 9, 2024 •

edited

Loading