A3p test zcf bundle cap #8911

Chris-Hibbert · 2024-02-14T01:23:38Z

refs: #8868

Description

An a3p-integration test for #8807.

Security Considerations

N/A

Scaling Considerations

N/A

Documentation Considerations

N/A

Testing/Upgrade Considerations

This is a test that a bug fix had the appropriate effect.

The test takes advantage of the fact that the vatInfo held in swingstore (and returned by getVatDetails() in synthetic-chain) gives the bundleId of the ZCF in a contract vat rather than the bundleID of the contract itself.

packages/vats/package.json

mhofman · 2024-02-14T01:33:44Z

a3p-integration/proposals/c:probeZcfBundleCap/package.json

+{
+    "agoricProposal": {
+        "type": "/agoric.swingset.CoreEvalProposal",
+        "source": "submission"


I think the source needs to be subdir, but I'm not sure

It worked just fine this way. Was the "need" you refer a style rule, or is the fact that it works sufficient?

submission isn't a valid value:
https://github.com/Agoric/agoric-3-proposals/blob/c6e52be97d9c5b77abf72f2ab8896264b398ac47/packages/synthetic-chain/src/cli/proposals.ts#L21-L29

but the logic currenctly doesn't validate params; if it's not 'build' then it assumes 'subdir':
https://github.com/Agoric/agoric-3-proposals/blob/c6e52be97d9c5b77abf72f2ab8896264b398ac47/packages/synthetic-chain/src/cli/build.ts#L36-L37

so please change it to subdir

packages/vats/src/proposals/probeZcfBundle.js

mhofman · 2024-02-17T23:21:48Z

packages/vats/src/proposals/probeZcfBundle.js

+  options,
+) => {
+  console.log('probeZcfBundle start');
+  const { zoeRef, zcfRef, walletRef } = options.options;


I'm still confused how these options can get passed in. The way things are structured now, the submission is prepared before a3p proposals are run. However I think this proposal does not actually need to generate any bundle, so the submission could be manually written, with the template mechanism used to fill the probed bundle refs?

I think you're right. My current belief is that I want to cite the Zoe and ZCF bundles that will have been included in upgrade-15. I want to do a null upgrade of Zoe to trigger reversion to a stored ZCF bundle. If I can then do a null upgrade to a contract vat (e.g. WalletFactory) then I can compare the ZCF bundle used to the ZCF bundleID just used in upgrade-15.
So I'm looking for how I can find out those bundleIDs to use with the new (very clean!) template mechanism.

@turadg added a check so if the bundle has already been installed, it doesn't do it again. Including these bundle IDs in the manifest is necessary so I can have them to request an upgrade.

I don't understand how that's relevant. I actually don't understand why this test needs to install any new bundle ?

I mean I understand how one option is to do a full generation of core eval scripts and bundles, but I thought from the description we just wanted to "restart" the contracts. I suppose we may want to upgrade ZCF since the test checks it uses the new version

restarting the contracts would be fine.

When I used restartContract() without a bundleID, in place of E(walletAdminFacet).upgradeContract(walletRef.bundleID, privateArgs);, I got an error from the kernel that implied that it was trying to upgrade to an earlier version of the contract. checkAndUpdateFacetiousness() complained that I was trying to remove a facet, which would only make sense if walletFactory was trying to upgrade from a relatively modern version to the version on chain. I'll file a bug to investigate restartContract().

Since the only productive way to upgrade the wallet factory was using upgradeContract(), I needed a bundleId.

With ZCF, I need to pass the bundleID to E(zoeConfigFacet).updateZcfBundleId(zcfRef.bundleID); to tell Zoe to use a particular version of ZCF when upgrading the contracts. The point of this test is to validate that #8807 correctly fixes Zoe to store the ZCFBundleID. Before that PR, it clearly was not.

With the fix in commit 5a30b2d877, I was able to revert to restartContract for the second restart, but the first still needs to be an upgrade (in the test) so that we can tell whether it is using the original bundleId or the newly provided one.

mhofman

I'm still pretty confused by what this test tries to do. We should sync up

mhofman · 2024-02-23T22:45:23Z

packages/zoe/src/contractFacet/zcfZygote.js

-        await E(zoeInstanceAdmin).repairContractCompletionWatcher();
-        console.log(`Repaired contract completion watcher`);
+        // We don't wait because it's a cross-vat call (to Zoe) that can't be
+        // completed during this vat's start-up
+        E(zoeInstanceAdmin)
+          .repairContractCompletionWatcher()
+          .catch(() => {});


This is not strictly a testing change anymore, right?

correct.

I'd guess you're hinting that I should change something, presumably the commit logs, but I don't understand their impact. Is it sufficient that the latest commit has a feat tag, or do I need to change the PR's title or something else? Do I need to eventually need to check it in as a merge rather than a squash, or is there something else to be careful of?

The main problem is that this change is in a commit titled test:. This change should be in a separate commit, before the 'test' commit, describing this change in behavior.

The PR title says "test" but it's normal for other changes to be made to support a testing requirement. The problem is when the changelog leaves those changes out.

The commit makes two changes. One is the fix to startInstance.js. The other is a change to the test probe to take advantage of the fix and demonstrate that it fixes the problem. That second change has to update the test, so it can't precede it. I think it's important that the fix and the revelation of its effectiveness stay together.

If I amend the commit to call it a fix, and remember to not squish, would that be sufficient to update the changelog? If not how would you recommend I address this?

I think it's important that the fix and the revelation of its effectiveness stay together.

Up to you.

If I amend the commit to call it a fix, and remember to not squish, would that be sufficient to update the changelog?

Yes

Looks like it's still in a "test" commit.
d7ba684#diff-8dcfebb96abffde204086c5d660142e0c4c74a7bac0800f7c18447e0baad1979R472-R477

mhofman · 2024-02-23T22:46:35Z

packages/vats/src/proposals/probeZcfBundle.js

+  const { adminNode, root: zoeRoot } = await E(vatStore).get('zoe');
+  const zoeConfigFacet = await E(zoeRoot).getZoeConfigFacet();
+
+  // STEP 1: restart WF; it'll use the newest ZCF //////////////////


newest is ambiguous here, as it's not the zcf bundle that is being installed just below.

yeah, just the most recent known to Zoe. updated.

mhofman · 2024-02-23T22:49:28Z

packages/vats/src/proposals/probeZcfBundle.js

+  options,
+) => {
+  console.log('probeZcfBundle start');
+  const { zoeRef, zcfRef, walletRef } = options.options;


I mean I understand how one option is to do a full generation of core eval scripts and bundles, but I thought from the description we just wanted to "restart" the contracts. I suppose we may want to upgrade ZCF since the test checks it uses the new version

mhofman · 2024-02-23T22:51:40Z

a3p-integration/proposals/a:upgrade-next/probeZcfBundleCap.test.js

+  await evalBundles(SUBMISSION_DIR);
+
+  const detailsAfter = await getVatDetails('walletFactory');
+  t.true(detailsAfter.incarnation >= 3, 'wf incarnation after must be >= 3');


Suggested change

t.true(detailsAfter.incarnation >= 3, 'wf incarnation after must be >= 3');

t.true(detailsAfter.incarnation == detailsBefore.incarnation + 1, 'wf incarnation must increase');

mhofman · 2024-02-23T22:52:56Z

packages/builders/scripts/vats/probe-zcf-bundle.js

+      'getManifestForProbeZcfBundleCap',
+      {
+        zoeRef: publishRef(install('@agoric/vats/src/vat-zoe.js')),
+        zcfRef: publishRef(install('@agoric/zoe/src/contractFacet/vatRoot.js')),


Why can't zcfRef be the only ref, with a dummy implementation?

WalletRef: The fix in startInstance below wasn't present the previous time that the walletFactory was upgraded, so Zoe didn't remember the bundleId as it should have.

ZoeRef: adminNode.upgrade() requires a bundleCap. I'd be happy to re-use the already known one. This seems to be the most straightforward way to get it.

a3p-integration/proposals/a:upgrade-next/post.test.js

a3p-integration/proposals/b:restart-vats/package.json

a3p-integration/proposals/tsconfig.json

packages/vats/src/proposals/probeZcfBundle.js

turadg · 2024-02-27T17:06:46Z

packages/zoe/src/contractFacet/zcfZygote.js

-        await E(zoeInstanceAdmin).repairContractCompletionWatcher();
-        console.log(`Repaired contract completion watcher`);
+        // We don't wait because it's a cross-vat call (to Zoe) that can't be
+        // completed during this vat's start-up
+        E(zoeInstanceAdmin)
+          .repairContractCompletionWatcher()
+          .catch(() => {});


The main problem is that this change is in a commit titled test:. This change should be in a separate commit, before the 'test' commit, describing this change in behavior.

The PR title says "test" but it's normal for other changes to be made to support a testing requirement. The problem is when the changelog leaves those changes out.

packages/zoe/src/zoeService/startInstance.js

turadg

I left some requests. I'll review again when it's rebased on master or #9004

Chris-Hibbert · 2024-02-27T23:34:50Z

I left some requests. I'll review again when it's rebased on master or #9004

rebased onto #9004

turadg

The commits can be cleaned up a bit but not a blocker

turadg · 2024-02-27T23:37:53Z

a3p-integration/proposals/tsconfig.json

this should be squashed into the previous.

turadg · 2024-02-27T23:38:42Z

a3p-integration/proposals/a:upgrade-next/probeZcfBundleCap.test.js

@@ -0,0 +1,37 @@
+/* eslint-disable @jessie.js/safe-await-separator */


I think this isn't doing anything. also the best remedy is await null instead of suppression

Chris-Hibbert · 2024-04-16T21:59:15Z

@gibson042 commit 72c7574 contains an important fix to ZCF. It should be cherry-picked into upgrade15, and ZCF updated with a call to E(zoeConfigFacet).updateZcfBundleId(zcfRef.bundleID); so that upgrading contracts will get this new version of ZCF.

@gibson042

refs: #9246 ## Description Add a proposal to upgrade the ZCF bundle only, and run it as a core proposal during chain software upgrade. This is necessary for #9246 but not sufficient as the release also needs to include the fix from #8911. ### Security Considerations None ### Scaling Considerations None ### Documentation Considerations None ### Testing Considerations Will be tested end to end (make sure smart wallet can be upgraded) in #9206 ### Upgrade Considerations @gibson042 must do a partial cherry-pick of 72c7574#diff-8dcfebb96abffde204086c5d660142e0c4c74a7bac0800f7c18447e0baad1979 (the `zcfZygote.js` change) in the release-15 branch. Will be part of that chain software upgrade.

This fix is cherry-picked from #8911 for upgrade 15

Created by following the [pending MAINTAINERS.md](https://github.com/Agoric/agoric-sdk/pull/9235/files?short_path=39da3bd#diff-39da3bd6270d44ea37b6ed50bd42eeb9d93ac5e1639645871a69cbe08cbe29de), branching from dev-upgrade-15. NOTE: [scripts/have-news](https://github.com/Agoric/agoric-sdk/blob/master/scripts/have-news) has an undocumented dependency upon src-prefix="a" that was disrupted by my local [`diff.mnemonicPrefix=true`](https://git-scm.com/docs/diff-config/2.9.5#Documentation/diff-config.txt-diffmnemonicPrefix) configuration, resulting in empty output until I tracked down the issue. I've opened #9269 to track that. ## Packages that have NEWS.md updates ```diff --- c/golang/cosmos/CHANGELOG.md +++ w/golang/cosmos/CHANGELOG.md @@ -3,6 +3,21 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [0.35.0-u15.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/[email protected]...@agoric/[email protected]) (2024-04-20) + + +### Features + +* upgrade zcf: install bundle and call updateZcfBundleId() ([74662d7](74662d7)), closes [#9250](#9250) +* **cosmos:** Next upgrade is `agoric-upgrade-15` ([6a84bb1](6a84bb1)) + + +### Bug Fixes + +* various fixes and features for u15 ([21e6f7c](21e6f7c)) + + + ## [0.35.0-u14.1](https://github.com/gibson042/agoric-sdk/compare/@agoric/[email protected]...@agoric/[email protected]) (2024-03-12) --- c/packages/smart-wallet/CHANGELOG.md +++ w/packages/smart-wallet/CHANGELOG.md @@ -3,6 +3,20 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +### [0.5.4-u15.0](https://github.com/Agoric/agoric/compare/@agoric/[email protected]...@agoric/[email protected]) (2024-04-20) + + +### Features + +* **smart-wallet:** tryExitOffer reclaims withdrawn payments ([6f01f63](6f01f63)) + + +### Bug Fixes + +* in SmartWallet, if invitation is invalid, don't process offer ([29078f7](29078f7)) + + + ### [0.5.4-u14.1](https://github.com/Agoric/agoric/compare/@agoric/[email protected]...@agoric/[email protected]) (2024-03-12) **Note:** Version bump only for package @agoric/smart-wallet --- c/packages/vats/CHANGELOG.md +++ w/packages/vats/CHANGELOG.md @@ -3,6 +3,15 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +### [0.15.2-u15.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/[email protected]...@agoric/[email protected]) (2024-04-20) + + +### Features + +* upgrade zcf: install bundle and call updateZcfBundleId() ([74662d7](74662d7)), closes [#9250](#9250) + + + ### [0.15.2-u14.1](https://github.com/Agoric/agoric-sdk/compare/@agoric/[email protected]...@agoric/[email protected]) (2024-03-12) **Note:** Version bump only for package @agoric/vats --- c/packages/zoe/CHANGELOG.md +++ w/packages/zoe/CHANGELOG.md @@ -3,6 +3,15 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +### [0.26.3-u15.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/[email protected]...@agoric/[email protected]) (2024-04-20) + + +### Bug Fixes + +* fix ZCF to not await in first crank ([8e289fd](8e289fd)), closes [#8911](#8911) + + + ### [0.26.3-u14.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/[email protected]...@agoric/[email protected]) (2024-02-27) ```

Chris-Hibbert added the Zoe package: Zoe label Feb 14, 2024

Chris-Hibbert self-assigned this Feb 14, 2024

Chris-Hibbert marked this pull request as draft February 14, 2024 01:23

Chris-Hibbert force-pushed the a3p-test-zcfBundleCap branch from 3e544f5 to cc74195 Compare February 14, 2024 01:35

mhofman reviewed Feb 14, 2024

View reviewed changes

mhofman added the force:integration Force integration tests to run on PR label Feb 14, 2024

Chris-Hibbert force-pushed the 8445-a3p-tests-mastr branch from 0429a58 to 5298932 Compare February 17, 2024 00:42

Base automatically changed from 8445-a3p-tests-mastr to master February 17, 2024 23:04

mhofman reviewed Feb 17, 2024

View reviewed changes

Chris-Hibbert force-pushed the a3p-test-zcfBundleCap branch from edcf90e to 66e3202 Compare February 20, 2024 23:29

turadg force-pushed the a3p-test-zcfBundleCap branch from 66e3202 to 887615c Compare February 21, 2024 00:30

Chris-Hibbert force-pushed the a3p-test-zcfBundleCap branch 4 times, most recently from 219f9c2 to d7ba684 Compare February 23, 2024 21:56

mhofman reviewed Feb 23, 2024

View reviewed changes

Chris-Hibbert changed the title ~~WIP: A3p test zcf bundle cap~~ A3p test zcf bundle cap Feb 23, 2024

Chris-Hibbert marked this pull request as ready for review February 23, 2024 23:18

Chris-Hibbert requested a review from turadg February 24, 2024 00:04

Chris-Hibbert mentioned this pull request Feb 24, 2024

prepare updates for Upgrade 15 #8868

Closed

14 tasks

turadg requested changes Feb 27, 2024

View reviewed changes

Chris-Hibbert force-pushed the a3p-test-zcfBundleCap branch from a526621 to 97460a6 Compare February 27, 2024 21:21

turadg mentioned this pull request Feb 27, 2024

remove restart-vats from a3p #9004

Merged

Chris-Hibbert requested a review from turadg February 27, 2024 22:38

turadg reviewed Feb 27, 2024

View reviewed changes

Chris-Hibbert force-pushed the a3p-test-zcfBundleCap branch from 2bd8f2f to d2ca475 Compare February 27, 2024 23:33

Chris-Hibbert requested a review from turadg February 27, 2024 23:34

turadg approved these changes Feb 27, 2024

View reviewed changes

Chris-Hibbert force-pushed the a3p-test-zcfBundleCap branch from d2ca475 to afa0803 Compare February 28, 2024 00:54

Chris-Hibbert force-pushed the a3p-test-zcfBundleCap branch 2 times, most recently from 75a6159 to bcc0aa6 Compare February 28, 2024 18:19

Chris-Hibbert added the automerge:rebase Automatically rebase updates, then merge label Feb 28, 2024

turadg and others added 4 commits February 28, 2024 18:40

fix: gitignore for proposal packages

f9360c2

build: gitignore submission dirs

4c15ca7

fix: repair storage of zcfBundleCap and add a3p test

72c7574

test: extend time-out for test

003ed74

Chris-Hibbert force-pushed the a3p-test-zcfBundleCap branch from bcc0aa6 to 003ed74 Compare February 28, 2024 18:40

Chris-Hibbert mentioned this pull request Feb 28, 2024

8868 gen submissions #9009

Merged

mergify bot merged commit 111247f into master Feb 28, 2024
66 checks passed

mergify bot deleted the a3p-test-zcfBundleCap branch February 28, 2024 19:15

This was referenced Apr 16, 2024

enhance smart wallet behavior when invitation creation fails #9239

Closed

ZCF in upgrade-14 cannot restart a contract due to await in 1st crank #9246

Closed

Chris-Hibbert mentioned this pull request Apr 17, 2024

in upgrade-14, Zoe doesn't record new bundleCap when contracts are upgraded #9249

Closed

mhofman mentioned this pull request Apr 17, 2024

Upgrade ZCF only #9250

Merged

Chris-Hibbert added a commit that referenced this pull request Apr 18, 2024

fix: fix ZCF to not await in first crank

203c17e

This fix is cherry-picked from #8911 for upgrade 15

Chris-Hibbert mentioned this pull request Apr 18, 2024

repair ZCF to unblock contract upgrade #9254

Merged

Chris-Hibbert added a commit that referenced this pull request Apr 18, 2024

fix: fix ZCF to not await in first crank

edc9ab7

This fix is cherry-picked from #8911 for upgrade 15

Chris-Hibbert added a commit that referenced this pull request Apr 18, 2024

fix: fix ZCF to not await in first crank

34ce82d

This fix is cherry-picked from #8911 for upgrade 15

Chris-Hibbert added a commit that referenced this pull request Apr 18, 2024

fix: fix ZCF to not await in first crank

8e289fd

This fix is cherry-picked from #8911 for upgrade 15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

A3p test zcf bundle cap #8911

A3p test zcf bundle cap #8911

Chris-Hibbert commented Feb 14, 2024 •

edited

Loading

mhofman Feb 14, 2024

Chris-Hibbert Feb 27, 2024

turadg Feb 27, 2024

mhofman Feb 17, 2024

Chris-Hibbert Feb 20, 2024 •

edited

Loading

Chris-Hibbert Feb 23, 2024

mhofman Feb 23, 2024

mhofman Feb 23, 2024

Chris-Hibbert Feb 24, 2024

Chris-Hibbert Feb 26, 2024

mhofman left a comment

mhofman Feb 23, 2024

Chris-Hibbert Feb 26, 2024

turadg Feb 27, 2024

Chris-Hibbert Feb 27, 2024

turadg Feb 27, 2024 •

edited

Loading

Chris-Hibbert Feb 27, 2024

turadg Feb 27, 2024

mhofman Feb 23, 2024

Chris-Hibbert Feb 26, 2024

mhofman Feb 23, 2024

mhofman Feb 23, 2024

Chris-Hibbert Feb 27, 2024

mhofman Feb 23, 2024

Chris-Hibbert Feb 27, 2024

turadg Feb 27, 2024

turadg left a comment

Chris-Hibbert commented Feb 27, 2024

turadg left a comment

turadg Feb 27, 2024

turadg Feb 27, 2024

Chris-Hibbert commented Apr 16, 2024

	t.true(detailsAfter.incarnation >= 3, 'wf incarnation after must be >= 3');
	t.true(detailsAfter.incarnation == detailsBefore.incarnation + 1, 'wf incarnation must increase');

		@@ -0,0 +1,37 @@
		/* eslint-disable @jessie.js/safe-await-separator */

A3p test zcf bundle cap #8911

A3p test zcf bundle cap #8911

Conversation

Chris-Hibbert commented Feb 14, 2024 • edited Loading

Description

Security Considerations

Scaling Considerations

Documentation Considerations

Testing/Upgrade Considerations

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

Chris-Hibbert Feb 20, 2024 • edited Loading

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

mhofman 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

turadg Feb 27, 2024 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

turadg left a comment

Choose a reason for hiding this comment

Chris-Hibbert commented Feb 27, 2024

turadg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Chris-Hibbert commented Apr 16, 2024

Chris-Hibbert commented Feb 14, 2024 •

edited

Loading

Chris-Hibbert Feb 20, 2024 •

edited

Loading

turadg Feb 27, 2024 •

edited

Loading