refactor: filecoin api services events and tests #974

vasco-santos · 2023-10-12T18:55:52Z

Implements filecoin-api services, events and tests all over the place.

Note that some small follow ups are still needed and will be added as follow up:

CRON for piece/accept

alanshaw

Wow what a PR. In general this is great. My biggest concern is wrapping errors and losing valuable context.

packages/capabilities/src/types.ts

alanshaw · 2023-10-23T09:03:11Z

packages/capabilities/src/types.ts

+export type FilecoinAcceptFailure =
+  | InvalidContentPiece
+  | ProofNotFound
+  | Ucanto.Failure


I seem to recall gozala saying we shouldn't add generic Failure to these unions...(there are more instances of this).

well this looks to be everywhere... Even in the recent capabilities like RateLimit, Customer, ...
If I remove it, there are a lot of typescript failures, so I will keep it and we can consider doing this removal across the board

packages/capabilities/src/types.ts

packages/filecoin-api/src/storefront/service.js

packages/filecoin-api/test/context/mocks.js

alanshaw · 2023-10-23T11:19:09Z

packages/filecoin-api/test/events/aggregator.js

+ * @param {API.Test<AggregatorApi.TestEventsContext>} testFn
+ * @param {(context: AggregatorApi.TestEventsContext) => Promise<AggregatorApi.TestEventsContext>} mockContextFunction
+ */
+function wichMockableContext(testFn, mockContextFunction) {


I could not get this to work with the chain of type inference if I put this with templates to try to make it generic with all the contexts being inferred by caller. So keeping it for now to not spend more time

Can fix the typo though?

Suggested change

function wichMockableContext(testFn, mockContextFunction) {

function withMockableContext(testFn, mockContextFunction) {

packages/filecoin-client/src/dealer.js

alanshaw · 2023-10-23T11:23:25Z

packages/filecoin-client/test/deal-tracker.test.js

-          provider: 'f099'
-        }
-      }
+        12_345: {


linter wants this...

Fixes aggregate/accept receipt: 1. inclusion proof was wrongly here. It should only be in `piece/accept` because it is piece specific proof within an aggregate 2. added `aggregate` in receipt to be coherent with other receipts for `*/accept` Fixes filecoin/accept receipt: 1. added `piece` and `aggregate` in receipt to be coherent with other receipts for `*/accept` 2. swaped `aux` to be a property per storacha/w3up#974 (comment)

Implements `filecoin-api` services, events and tests all over the place. BREAKING CHANGE: see latest specs https://github.com/web3-storage/specs/blob/cbdb706f18567900c5c24d7fb16ccbaf93d0d023/w3-filecoin.md

🤖 I have created a release *beep* *boop* --- ## [11.0.0](capabilities-v10.2.0...capabilities-v11.0.0) (2023-10-24) ### ⚠ BREAKING CHANGES * see latest specs https://github.com/web3-storage/specs/blob/cbdb706f18567900c5c24d7fb16ccbaf93d0d023/w3-filecoin.md * filecoin client to use new capabilities * filecoin capabilities ### Bug Fixes * add missing ContentNotFound definition for filecoin offer failure ([c0b97bf](c0b97bf)) * add missing filecoin submit success and failure types ([c0b97bf](c0b97bf)) * client tests ([b0d9c3f](b0d9c3f)) * type errors ([c0b97bf](c0b97bf)) * upgrade ucanto in filecoin api ([c95fb54](c95fb54)) ### Code Refactoring * filecoin api services events and tests ([#974](#974)) ([953537b](953537b)) * filecoin capabilities ([c0b97bf](c0b97bf)) * filecoin client to use new capabilities ([b0d9c3f](b0d9c3f)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

🤖 I have created a release *beep* *boop* --- ## [2.0.0](filecoin-client-v1.4.0...filecoin-client-v2.0.0) (2023-10-24) ### ⚠ BREAKING CHANGES * see latest specs https://github.com/web3-storage/specs/blob/cbdb706f18567900c5c24d7fb16ccbaf93d0d023/w3-filecoin.md * filecoin client to use new capabilities ### Bug Fixes * client tests ([b0d9c3f](b0d9c3f)) * upgrade ucanto in filecoin api ([c95fb54](c95fb54)) ### Code Refactoring * filecoin api services events and tests ([#974](#974)) ([953537b](953537b)) * filecoin client to use new capabilities ([b0d9c3f](b0d9c3f)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: Vasco Santos <santos.vasco10@gmail.com>

🤖 I have created a release *beep* *boop* --- ## [2.0.0](filecoin-api-v1.4.4...filecoin-api-v2.0.0) (2023-10-24) ### ⚠ BREAKING CHANGES * see latest specs https://github.com/web3-storage/specs/blob/cbdb706f18567900c5c24d7fb16ccbaf93d0d023/w3-filecoin.md ### Features * upgrade to ucanto@9 ([#951](#951)) ([d72faf1](d72faf1)) ### Bug Fixes * upgrade ucanto in filecoin api ([c95fb54](c95fb54)) ### Code Refactoring * filecoin api services events and tests ([#974](#974)) ([953537b](953537b)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: Vasco Santos <santos.vasco10@gmail.com>

Alan Shaw added 2 commits October 5, 2023 16:23

feat: wip filecoin-api implementation

4562f13

feat: wip events

8142de1

vasco-santos force-pushed the refactor/filecoin-api-2 branch 12 times, most recently from 1ec5761 to 2d860d4 Compare October 19, 2023 16:53

vasco-santos changed the title ~~Refactor/filecoin api 2~~ refactor: filecoin api events and services Oct 19, 2023

vasco-santos changed the title ~~refactor: filecoin api events and services~~ refactor: filecoin api services events and tests Oct 19, 2023

vasco-santos changed the base branch from main to refactor/filecoin-api October 19, 2023 17:37

vasco-santos changed the base branch from refactor/filecoin-api to refactor/filecoin-client October 19, 2023 17:37

vasco-santos force-pushed the refactor/filecoin-api-2 branch 2 times, most recently from ee803fa to 3289cc1 Compare October 19, 2023 21:50

vasco-santos marked this pull request as ready for review October 19, 2023 21:52

vasco-santos requested a review from alanshaw October 19, 2023 21:52

vasco-santos force-pushed the refactor/filecoin-api-2 branch 4 times, most recently from c78b7e3 to def20a3 Compare October 20, 2023 15:44

refactor: filecoin api 2

127b110

vasco-santos force-pushed the refactor/filecoin-api-2 branch from def20a3 to 127b110 Compare October 20, 2023 17:23

alanshaw requested changes Oct 23, 2023

View reviewed changes

refactor: aux property

7cacbbe

vasco-santos added 13 commits October 23, 2023 17:00

refactor: simplify errors

46a87f9

refactor: add type for deal info reducer

57c4e05

refactor: add type for deal info reducer

fab21b9

refactor: storefront config renamed to options

712c9d2

refactor: rename store error to record not found

6d424f1

refactor: make has fail when not found like get

d3c9f54

fix: client test

206be46

refactor: test interfaces in tests

8e9df57

refactor: test interfaces in tests

084c969

chore: remove todo

bb056f6

fix: imports of test interface

ae02947

fix: remove unused imports

d8cde3c

fix: imports

1fc9313

vasco-santos requested a review from alanshaw October 23, 2023 16:03

alanshaw approved these changes Oct 23, 2023

View reviewed changes

vasco-santos merged commit 3bab254 into refactor/filecoin-client Oct 23, 2023
13 of 14 checks passed

vasco-santos deleted the refactor/filecoin-api-2 branch October 23, 2023 20:38

vasco-santos mentioned this pull request Oct 23, 2023

refactor: filecoin api #944

Closed

This was referenced Oct 24, 2023

chore(main): release filecoin-api 2.0.0 #954

Merged

chore(main): release capabilities 11.0.0 #994

Merged

chore(main): release filecoin-client 2.0.0 #993

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: filecoin api services events and tests #974

refactor: filecoin api services events and tests #974

vasco-santos commented Oct 12, 2023 •

edited

Loading

alanshaw left a comment

alanshaw Oct 23, 2023

vasco-santos Oct 23, 2023

alanshaw Oct 23, 2023

vasco-santos Oct 23, 2023

alanshaw Oct 23, 2023

alanshaw Oct 23, 2023

vasco-santos Oct 23, 2023

	function wichMockableContext(testFn, mockContextFunction) {
	function withMockableContext(testFn, mockContextFunction) {

refactor: filecoin api services events and tests #974

refactor: filecoin api services events and tests #974

Conversation

vasco-santos commented Oct 12, 2023 • edited Loading

alanshaw left a comment

Choose a reason for hiding this comment

alanshaw Oct 23, 2023

Choose a reason for hiding this comment

vasco-santos Oct 23, 2023

Choose a reason for hiding this comment

alanshaw Oct 23, 2023

Choose a reason for hiding this comment

vasco-santos Oct 23, 2023

Choose a reason for hiding this comment

alanshaw Oct 23, 2023

Choose a reason for hiding this comment

alanshaw Oct 23, 2023

Choose a reason for hiding this comment

vasco-santos Oct 23, 2023

Choose a reason for hiding this comment

vasco-santos commented Oct 12, 2023 •

edited

Loading