fix(swingset)!: remove stats from vatAdmin API

The "Admin Node" returned by `vatAdmin~.createVatDynamically()` had a method named `adminData()`, which returned some statistics like the number of objects imported into the vat. This wasn't super-useful and exposes a little too much information about the kernel's internals, especially as GC starts to get more interesting. So we've decided to remove this API. closes #3331
Agoric · Jun 16, 2021 · bc053ef · bc053ef
1 parent da4991d
commit bc053ef
Show file tree

Hide file tree

Showing 5 changed files with 1 addition and 43 deletions.
diff --git a/packages/SwingSet/src/kernel/kernel.js b/packages/SwingSet/src/kernel/kernel.js
@@ -866,12 +866,6 @@ export default function buildKernel(
     });
   }
 
-  function collectVatStats(vatID) {
-    insistVatID(vatID);
-    const vatKeeper = kernelKeeper.provideVatKeeper(vatID);
-    return vatKeeper.vatStats();
-  }
-
   async function start() {
     if (started) {
       throw Error('kernel.start already called');
@@ -891,7 +885,6 @@ export default function buildKernel(
         // later when it is created and a root object is available
         return vatID;
       },
-      stats: collectVatStats,
       terminate: (vatID, reason) => terminateVat(vatID, true, reason),
     };
 

diff --git a/packages/SwingSet/src/kernel/vatAdmin/vatAdmin-src.js b/packages/SwingSet/src/kernel/vatAdmin/vatAdmin-src.js
@@ -20,11 +20,7 @@
 import { Far } from '@agoric/marshal';
 
 export function buildRootDeviceNode({ endowments, serialize }) {
-  const {
-    pushCreateVatEvent,
-    stats: kernelVatStatsFn,
-    terminate: kernelTerminateVatFn,
-  } = endowments;
+  const { pushCreateVatEvent, terminate: kernelTerminateVatFn } = endowments;
 
   // The Root Device Node.
   return Far('root', {
@@ -42,10 +38,5 @@ export function buildRootDeviceNode({ endowments, serialize }) {
     terminateWithFailure(vatID, reason) {
       kernelTerminateVatFn(vatID, serialize(reason));
     },
-    // Call the registered kernel function to request vat stats. Clean up the
-    // outgoing and incoming arguments.
-    adminStats(vatID) {
-      return kernelVatStatsFn(`${vatID}`);
-    },
   });
 }
diff --git a/packages/SwingSet/src/kernel/vatAdmin/vatAdminWrapper.js b/packages/SwingSet/src/kernel/vatAdmin/vatAdminWrapper.js
@@ -30,9 +30,6 @@ export function buildRootObject(vatPowers) {
       terminateWithFailure(reason) {
         D(vatAdminNode).terminateWithFailure(vatID, reason);
       },
-      adminData() {
-        return D(vatAdminNode).adminStats(vatID);
-      },
       done() {
         return doneP;
       },

diff --git a/packages/SwingSet/test/vat-admin/bootstrap.js b/packages/SwingSet/test/vat-admin/bootstrap.js
@@ -51,17 +51,6 @@ export function buildRootObject(vatPowers, vatParameters) {
             );
           return;
         }
-        case 'vatStats': {
-          log(`starting stats test`);
-          const { root, adminNode } = await E(vatAdminSvc).createVat(
-            bundles.newVatBundle,
-          );
-          log(await E(adminNode).adminData());
-          const c = E(root).createRcvr(1);
-          log(await E(c).increment(3));
-          log(await E(adminNode).adminData());
-          return;
-        }
         default:
           assert.fail(X`unknown argv mode '${argv[0]}'`);
       }

diff --git a/packages/SwingSet/test/vat-admin/test-innerVat.js b/packages/SwingSet/test/vat-admin/test-innerVat.js
@@ -70,15 +70,3 @@ test('error creating vat from non-bundle', async t => {
   ]);
   await c.run();
 });
-
-test('VatAdmin get vat stats', async t => {
-  const c = await doTestSetup(t, 'vatStats');
-  await c.run();
-  t.deepEqual(c.dump().log, [
-    'starting stats test',
-    '{"deviceCount":0,"objectCount":0,"promiseCount":0,"transcriptCount":0}',
-    '4',
-    '{"deviceCount":0,"objectCount":0,"promiseCount":2,"transcriptCount":2}',
-  ]);
-  await c.run();
-});