add skipInitialDelay() public method and action

Author: mikesposito

packages/profile-metrics-controller/CHANGELOG.md

@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - `ProfileMetricsController` contructor now accepts an optional `initialDelayDuration` parameter ([#7624](https://github.com/MetaMask/core/pull/7624))
   - The parameter can be used to override the default time-based delay for the first data collection after opt-in
+- Add `skipInitialDelay()` method to `ProfileMetricsController` ([#7624](https://github.com/MetaMask/core/pull/7624))
+  - The method can be also called through the `ProfileMetricsController:skipInitialDelay` action via messenger
 
 ### Changed
 

packages/profile-metrics-controller/src/ProfileMetricsController-method-action-types.ts

@@ -0,0 +1,20 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+
+import type { ProfileMetricsController } from './ProfileMetricsController';
+
+/**
+ * Skip the initial delay period by setting the end timestamp to the current time.
+ */
+export type ProfileMetricsControllerSkipInitialDelayAction = {
+  type: `ProfileMetricsController:skipInitialDelay`;
+  handler: ProfileMetricsController['skipInitialDelay'];
+};
+
+/**
+ * Union of all ProfileMetricsController action types.
+ */
+export type ProfileMetricsControllerMethodActions =
+  ProfileMetricsControllerSkipInitialDelayAction;

packages/profile-metrics-controller/src/ProfileMetricsController.test.ts

@@ -333,6 +333,24 @@ describe('ProfileMetricsController', () => {
     });
   });
 
+  describe('skipInitialDelay', () => {
+    it('sets the initial delay end timestamp to the current time', async () => {
+      const pastTimestamp = Date.now() - 10000;
+      await withController(
+        {
+          options: {
+            state: { initialDelayEndTimestamp: pastTimestamp },
+          },
+        },
+        async ({ controller }) => {
+          controller.skipInitialDelay();
+
+          expect(controller.state.initialDelayEndTimestamp).toBe(Date.now());
+        },
+      );
+    });
+  });
+
   describe('_executePoll', () => {
     describe('when the user has not opted in to profile metrics', () => {
       it('does not process the sync queue', async () => {

packages/profile-metrics-controller/src/ProfileMetricsController.ts

@@ -19,6 +19,7 @@ import { TransactionControllerTransactionSubmittedEvent } from '@metamask/transa
 import { Mutex } from 'async-mutex';
 
 import type { ProfileMetricsServiceMethodActions } from '.';
+import type { ProfileMetricsControllerMethodActions } from '.';
 import type { AccountWithScopes } from './ProfileMetricsService';
 
 /**
@@ -94,7 +95,7 @@ export function getDefaultProfileMetricsControllerState(): ProfileMetricsControl
   };
 }
 
-const MESSENGER_EXPOSED_METHODS = [] as const;
+const MESSENGER_EXPOSED_METHODS = ['skipInitialDelay'] as const;
 
 /**
  * Retrieves the state of the {@link ProfileMetricsController}.
@@ -109,7 +110,7 @@ export type ProfileMetricsControllerGetStateAction = ControllerGetStateAction<
  */
 export type ProfileMetricsControllerActions =
   | ProfileMetricsControllerGetStateAction
-  | ProfileMetricsServiceMethodActions;
+  | ProfileMetricsControllerMethodActions;
 
 /**
  * Actions from other messengers that {@link ProfileMetricsControllerMessenger} calls.
@@ -222,7 +223,7 @@ export class ProfileMetricsController extends StaticIntervalPollingController()<
       if (this.#assertUserOptedIn()) {
         // If the user has already opted in at the start of the session,
         // it must have opted in during onboarding, or during a previous session.
-        this.#skipInitialDelay();
+        this.skipInitialDelay();
       }
       this.#queueFirstSyncIfNeeded().catch(console.error);
       this.startPolling(null);
@@ -233,7 +234,7 @@ export class ProfileMetricsController extends StaticIntervalPollingController()<
     );
 
     this.messenger.subscribe('TransactionController:transactionSubmitted', () =>
-      this.#skipInitialDelay(),
+      this.skipInitialDelay(),
     );
 
     this.messenger.subscribe('AccountsController:accountAdded', (account) => {
@@ -247,6 +248,16 @@ export class ProfileMetricsController extends StaticIntervalPollingController()<
     this.setIntervalLength(interval);
   }
 
+  /**
+   * Skip the initial delay period by setting the end timestamp to the current time.
+   * Metrics will be sent on the next poll.
+   */
+  skipInitialDelay(): void {
+    this.update((state) => {
+      state.initialDelayEndTimestamp = Date.now();
+    });
+  }
+
   /**
    * Execute a single poll to sync user profile data.
    *
@@ -328,15 +339,6 @@ export class ProfileMetricsController extends StaticIntervalPollingController()<
     });
   }
 
-  /**
-   * Skip the initial delay period by setting the end timestamp to the current time.
-   */
-  #skipInitialDelay(): void {
-    this.update((state) => {
-      state.initialDelayEndTimestamp = Date.now();
-    });
-  }
-
   /**
    * Check if the initial delay end timestamp is in the past.
    *

packages/profile-metrics-controller/src/index.ts

@@ -18,3 +18,4 @@ export type {
 } from './ProfileMetricsService';
 export { ProfileMetricsService, serviceName } from './ProfileMetricsService';
 export type { ProfileMetricsServiceMethodActions } from './ProfileMetricsService-method-action-types';
+export type { ProfileMetricsControllerMethodActions } from './ProfileMetricsController-method-action-types';