Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(SwingSet): Improve config documentation, typing, and async function implementations #10538

Merged
merged 2 commits into from
Feb 4, 2025

Conversation

gibson042
Copy link
Member

Description

  • Document new config parameters (defaultReapGCKrefs and vat-level neverReap/reapGCKrefs, plus node-specific nodeOptions)
  • Remove obsolete config parameters (vat-level name/metered/virtualObjectCacheSize)
  • Improve the accuracy of SwingSet config types in both JSDoc and Patterns
  • Simplify some async functions for better comprehensibility and interactive debugging (e.g., vats and bundles both require one of sourceSpec/bundleSpec/bundle, but the former additionally support creationOptions/parameters options while the latter do not)

Security Considerations

None known.

Scaling Considerations

n/a

Documentation Considerations

None in particular.

Testing Considerations

n/a

Upgrade Considerations

n/a

@gibson042 gibson042 requested review from warner and mhofman November 20, 2024 19:32
@gibson042 gibson042 requested a review from a team as a code owner November 20, 2024 19:32
@gibson042 gibson042 force-pushed the gibson-2024-11-swingset-types branch from 635e902 to 1275fae Compare January 30, 2025 15:50
Copy link

cloudflare-workers-and-pages bot commented Jan 30, 2025

Deploying agoric-sdk with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0ac88bd
Status: ✅  Deploy successful!
Preview URL: https://492b18e2.agoric-sdk.pages.dev
Branch Preview URL: https://gibson-2024-11-swingset-type.agoric-sdk.pages.dev

View logs

@gibson042 gibson042 requested a review from michaelfig January 30, 2025 15:51
@gibson042 gibson042 force-pushed the gibson-2024-11-swingset-types branch from 016ac5e to c070769 Compare February 4, 2025 00:23
Copy link
Contributor

@siarhei-agoric siarhei-agoric left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@gibson042 gibson042 force-pushed the gibson-2024-11-swingset-types branch from c070769 to 0ac88bd Compare February 4, 2025 19:37
@gibson042 gibson042 added the automerge:rebase Automatically rebase updates, then merge label Feb 4, 2025
@mergify mergify bot merged commit b8d96c7 into master Feb 4, 2025
93 checks passed
@mergify mergify bot deleted the gibson-2024-11-swingset-types branch February 4, 2025 20:24
Copy link
Member

@mhofman mhofman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the late review. Mostly some question (and a small nit)

packages/SwingSet/src/typeGuards.js Show resolved Hide resolved
packages/SwingSet/src/typeGuards.js Show resolved Hide resolved
packages/SwingSet/tools/run-utils.js Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge:rebase Automatically rebase updates, then merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants