feat(vows): improve handling of ephemeral values #9620

0xpatrickdev · 2024-06-30T22:02:33Z

refs: #9308

Description

adds asPromise helper to VowTools for unwrapping Vow|Promise, ensuring proper handling of ephemeral promises
updates watch-utils to better handle values that are not storable durably, such as promises

Testing Considerations

This does not include tests that simulate an upgrade - only a heap zone is used in the included tests. See #9631

Upgrade Considerations

This PR includes changes we'd like to be in the initial release of vows.

cloudflare-workers-and-pages · 2024-06-30T22:02:52Z

Deploying agoric-sdk with Cloudflare Pages

Latest commit:	`ff92211`
Status:	✅ Deploy successful!
Preview URL:	https://45e89b2b.agoric-sdk.pages.dev
Branch Preview URL:	https://pc-watch-utils-as-promise.agoric-sdk.pages.dev

View logs

0xpatrickdev · 2024-07-01T00:48:41Z

packages/vow/src/types.js

+ * @param {Watcher<T, TResult1, TResult2, C>} [watcher]
+ * @param {C} [watcherArgs]
+ * @returns {Promise<TResult1 | TResult2>}
+ */


This is identical to the type for watch, minus the return line. We might consider extracting that logic and extending it, and/or using something like the PromiseToVow helper from @agoric/orchestration that should maybe live here instead:

agoric-sdk/packages/orchestration/src/internal.ts

Lines 3 to 16 in 194ac48

/**

* Converts a function type that returns a Promise to a function type that

* returns a Vow. If the input is not a function returning a Promise, it

* preserves the original type.

*

* @template T - The type to transform

*/

export type PromiseToVow<T> = T extends (

...args: infer Args

) => Promise<infer R>

? (...args: Args) => Vow<R>

: T extends (...args: infer Args) => infer R

? (...args: Args) => R

: T;

Shouldn't lines 14-15 above be removed since they're redundant?

michaelfig

Some F2-practice for you, and just a few minor things. 😉

packages/vow/src/vow.js

packages/vow/src/watch-utils.js

packages/vow/test/watch-utils.test.js

Co-authored-by: Michael FIG <[email protected]>

refs: #9308 ## Description - adds `asPromise` helper to `VowTools` for unwrapping `Vow|Promise`, ensuring proper handling of ephemeral promises - updates watch-utils to better handle values that are not storable durably, such as promises ### Testing Considerations This does not include tests that simulate an upgrade - only a heap zone is used in the included tests. See #9631 ### Upgrade Considerations This PR includes changes we'd like to be in the initial release of vows.

git rebase-todo ``` # Branch pc/as-vow label base-pc-as-vow pick b6b5f5f feat(vowTools): add asVow helper pick 0cdcd5f feat(vowTools): asVow should not wrap a vow as a vow label pc-as-vow reset base-pc-as-vow merge -C 0ad10c6 pc-as-vow # feat(vowTools): add asVow helper (#9577) # Branch pc/watch-utils-as-promise label base-pc-watch-utils-as-promise pick bf430a1 feat(watchUtils): add asPromise helper # To resolve conflicts in the following commit: # * In packages/vow/src/types.js, keep inbound changes and (after that) the # definition of VowTools. # * In packages/vow/test/watch-utils.test.js, keep only inbound changes and # limit them to start at "asPromise converts a vow to a promise" (i.e., # just the additions of # https://github.com/Agoric/agoric-sdk/pull/9620/files#diff-fd7cabcc7d1097036e2981c3262aa20612bec349f6e418d53324fc33b1b26946 ). pick c940d5c feat(vowTools): asPromise helper for unwrapping vows pick 8c27c67 feat(watchUtils): handle non-storables pick 3d5a3f3 feat(types): EVow pick 1c0b964 refactor: don't re-use index pick 274df18 fix(vow): clearer stored/non-stored values pick ff92211 refactor: 'extra' field for future properties label pc-watch-utils-as-promise reset base-pc-watch-utils-as-promise merge -C 8edf902 pc-watch-utils-as-promise # feat(vows): improve handling of ephemeral values (#9620) ```

0xpatrickdev requested a review from michaelfig July 1, 2024 00:21

0xpatrickdev marked this pull request as ready for review July 1, 2024 00:21

0xpatrickdev force-pushed the pc/watch-utils-as-promise branch from 1e779cd to ea54d44 Compare July 1, 2024 00:38

0xpatrickdev commented Jul 1, 2024

View reviewed changes

michaelfig approved these changes Jul 1, 2024

View reviewed changes

0xpatrickdev commented Jul 1, 2024

View reviewed changes

packages/vow/test/watch-utils.test.js Show resolved Hide resolved

gibson042 mentioned this pull request Jul 1, 2024

Upgrade-16 cherry-picks round 2 #9625

Merged

0xpatrickdev force-pushed the pc/watch-utils-as-promise branch 2 times, most recently from ac14194 to 80e9d83 Compare July 1, 2024 21:49

0xpatrickdev requested review from turadg and michaelfig July 1, 2024 21:52

0xpatrickdev and others added 7 commits July 1, 2024 17:58

feat(watchUtils): add asPromise helper

bf430a1

Co-authored-by: Michael FIG <[email protected]>

feat(vowTools): asPromise helper for unwrapping vows

c940d5c

feat(watchUtils): handle non-storables

8c27c67

Co-authored-by: Michael FIG <[email protected]>

feat(types): EVow

3d5a3f3

refactor: don't re-use index

1c0b964

fix(vow): clearer stored/non-stored values

274df18

refactor: 'extra' field for future properties

ff92211

0xpatrickdev force-pushed the pc/watch-utils-as-promise branch from 80e9d83 to ff92211 Compare July 1, 2024 22:08

turadg approved these changes Jul 1, 2024

View reviewed changes

0xpatrickdev changed the title ~~feat(vowTools): asPromise helper for unwrapping Vow|Promise~~ feat(vows): improve handling of ephemeral values Jul 1, 2024

0xpatrickdev added the automerge:rebase Automatically rebase updates, then merge label Jul 1, 2024

mergify bot merged commit 8edf902 into master Jul 1, 2024
85 checks passed

mergify bot deleted the pc/watch-utils-as-promise branch July 1, 2024 23:22

0xpatrickdev mentioned this pull request Jul 1, 2024

add support for Vows to smart-wallet #9308

Closed

gibson042 mentioned this pull request Jul 2, 2024

Upgrade-16 cherry-picks round 3 #9640

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(vows): improve handling of ephemeral values #9620

feat(vows): improve handling of ephemeral values #9620

0xpatrickdev commented Jun 30, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented Jun 30, 2024 •

edited

Loading

0xpatrickdev Jul 1, 2024 •

edited

Loading

michaelfig Jul 1, 2024

michaelfig left a comment

	/**
	* Converts a function type that returns a Promise to a function type that
	* returns a Vow. If the input is not a function returning a Promise, it
	* preserves the original type.
	*
	* @template T - The type to transform
	*/
	export type PromiseToVow<T> = T extends (
	...args: infer Args
	) => Promise<infer R>
	? (...args: Args) => Vow<R>
	: T extends (...args: infer Args) => infer R
	? (...args: Args) => R
	: T;

feat(vows): improve handling of ephemeral values #9620

feat(vows): improve handling of ephemeral values #9620

Conversation

0xpatrickdev commented Jun 30, 2024 • edited Loading

Description

Testing Considerations

Upgrade Considerations

cloudflare-workers-and-pages bot commented Jun 30, 2024 • edited Loading

Deploying agoric-sdk with Cloudflare Pages

0xpatrickdev Jul 1, 2024 • edited Loading

Choose a reason for hiding this comment

michaelfig Jul 1, 2024

Choose a reason for hiding this comment

michaelfig left a comment

Choose a reason for hiding this comment

0xpatrickdev commented Jun 30, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented Jun 30, 2024 •

edited

Loading

0xpatrickdev Jul 1, 2024 •

edited

Loading