Add missing hook and tests

MetaMask · Dec 18, 2024 · c7c2c50 · c7c2c50
1 parent 7b60d82
commit c7c2c50
Show file tree

Hide file tree

Showing 3 changed files with 79 additions and 2 deletions.
diff --git a/packages/snaps-rpc-methods/jest.config.js b/packages/snaps-rpc-methods/jest.config.js
@@ -10,8 +10,8 @@ module.exports = deepmerge(baseConfig, {
   ],
   coverageThreshold: {
     global: {
-      branches: 92.95,
-      functions: 97.44,
+      branches: 92.98,
+      functions: 97.46,
       lines: 97.93,
       statements: 97.52,
     },

diff --git a/packages/snaps-simulation/src/simulation.test.ts b/packages/snaps-simulation/src/simulation.test.ts
@@ -233,6 +233,75 @@ describe('getPermittedHooks', () => {
   const { runSaga, store } = createStore(getMockOptions());
   const controllerMessenger = getRootControllerMessenger();
 
+  it('returns the `hasPermission` hook', async () => {
+    const { snapId, close } = await getMockServer({
+      manifest: getSnapManifest(),
+    });
+
+    const location = detectSnapLocation(snapId, {
+      allowLocal: true,
+    });
+
+    const snapFiles = await fetchSnap(snapId, location);
+
+    const { hasPermission } = getPermittedHooks(
+      snapId,
+      snapFiles,
+      controllerMessenger,
+      runSaga,
+    );
+
+    expect(hasPermission('snap_manageState')).toBe(true);
+
+    await close();
+  });
+
+  it('returns the `getUnlockPromise` hook', async () => {
+    const { snapId, close } = await getMockServer({
+      manifest: getSnapManifest(),
+    });
+
+    const location = detectSnapLocation(snapId, {
+      allowLocal: true,
+    });
+
+    const snapFiles = await fetchSnap(snapId, location);
+
+    const { getUnlockPromise } = getPermittedHooks(
+      snapId,
+      snapFiles,
+      controllerMessenger,
+      runSaga,
+    );
+
+    expect(await getUnlockPromise(true)).toBeUndefined();
+
+    await close();
+  });
+
+  it('returns the `getIsLocked` hook', async () => {
+    const { snapId, close } = await getMockServer({
+      manifest: getSnapManifest(),
+    });
+
+    const location = detectSnapLocation(snapId, {
+      allowLocal: true,
+    });
+
+    const snapFiles = await fetchSnap(snapId, location);
+
+    const { getIsLocked } = getPermittedHooks(
+      snapId,
+      snapFiles,
+      controllerMessenger,
+      runSaga,
+    );
+
+    expect(getIsLocked()).toBe(false);
+
+    await close();
+  });
+
   it('returns the `getSnapFile` hook', async () => {
     const value = JSON.stringify({ bar: 'baz' });
     const { snapId, close } = await getMockServer({

diff --git a/packages/snaps-simulation/src/simulation.ts b/packages/snaps-simulation/src/simulation.ts
@@ -139,6 +139,13 @@ export type PermittedMiddlewareHooks = {
    */
   getUnlockPromise: (shouldShowUnlockRequest: boolean) => Promise<void>;
 
+  /**
+   * A hook that returns whether the client is locked or not.
+   *
+   * @returns A boolean flag signaling whether the client is locked.
+   */
+  getIsLocked: () => boolean;
+
   /**
    * A hook that returns the Snap's auxiliary file for the given path. This hook
    * is bound to the Snap ID.
@@ -390,6 +397,7 @@ export function getPermittedHooks(
   return {
     hasPermission: () => true,
     getUnlockPromise: asyncResolve(),
+    getIsLocked: () => false,
 
     getSnapFile: async (path: string, encoding: AuxiliaryFileEncoding) =>
       await getSnapFile(snapFiles.auxiliaryFiles, path, encoding),