feat: add account sync analytics & add state helpers

[mathieuartu]

Explanation

This PR adds various account syncing improvements.

• New UserStorageController state keys hasAccountSyncingSyncedAtLeastOnce and isAccountSyncingReadyToBeDispatched
• onAccountSyncErroneousSituation analytics callback to track how often erroneous situations happen during account syncing
• Set hasAccountSyncingSyncedAtLeastOnce also for a profile id first sync ever in UserStorageController

References

Changelog

@metamask/profile-sync-controller

• ADDED: new UserStorageController state keys hasAccountSyncingSyncedAtLeastOnce and isAccountSyncingReadyToBeDispatched
• ADDED: onAccountSyncErroneousSituation analytics callback to track how often erroneous situations happen during account syncing
• FIXED: set hasAccountSyncingSyncedAtLeastOnce also for a profile id first sync ever in UserStorageController

Checklist

• I've updated the test suite for new or updated code as appropriate
• I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
• I've highlighted breaking changes using the "BREAKING" category above as appropriate
• I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

[mathieuartu]

@metamaskbot publish-preview

[github-actions]

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.

{
  "@metamask-previews/accounts-controller": "19.0.0-preview-913143f",
  "@metamask-previews/address-book-controller": "6.0.1-preview-913143f",
  "@metamask-previews/announcement-controller": "7.0.1-preview-913143f",
  "@metamask-previews/approval-controller": "7.1.1-preview-913143f",
  "@metamask-previews/assets-controllers": "44.0.0-preview-913143f",
  "@metamask-previews/base-controller": "7.0.2-preview-913143f",
  "@metamask-previews/build-utils": "3.0.1-preview-913143f",
  "@metamask-previews/chain-controller": "0.1.3-preview-913143f",
  "@metamask-previews/composable-controller": "9.0.1-preview-913143f",
  "@metamask-previews/controller-utils": "11.4.3-preview-913143f",
  "@metamask-previews/ens-controller": "15.0.0-preview-913143f",
  "@metamask-previews/eth-json-rpc-provider": "4.1.6-preview-913143f",
  "@metamask-previews/gas-fee-controller": "22.0.1-preview-913143f",
  "@metamask-previews/json-rpc-engine": "10.0.1-preview-913143f",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.5-preview-913143f",
  "@metamask-previews/keyring-controller": "18.0.0-preview-913143f",
  "@metamask-previews/logging-controller": "6.0.2-preview-913143f",
  "@metamask-previews/message-manager": "11.0.1-preview-913143f",
  "@metamask-previews/multichain": "0.0.0-preview-913143f",
  "@metamask-previews/name-controller": "8.0.1-preview-913143f",
  "@metamask-previews/network-controller": "22.0.2-preview-913143f",
  "@metamask-previews/notification-controller": "7.0.0-preview-913143f",
  "@metamask-previews/notification-services-controller": "0.13.0-preview-913143f",
  "@metamask-previews/permission-controller": "11.0.3-preview-913143f",
  "@metamask-previews/permission-log-controller": "3.0.1-preview-913143f",
  "@metamask-previews/phishing-controller": "12.3.0-preview-913143f",
  "@metamask-previews/polling-controller": "12.0.1-preview-913143f",
  "@metamask-previews/preferences-controller": "14.0.0-preview-913143f",
  "@metamask-previews/profile-sync-controller": "1.0.1-preview-913143f",
  "@metamask-previews/queued-request-controller": "7.0.1-preview-913143f",
  "@metamask-previews/rate-limit-controller": "6.0.1-preview-913143f",
  "@metamask-previews/selected-network-controller": "19.0.0-preview-913143f",
  "@metamask-previews/signature-controller": "22.0.0-preview-913143f",
  "@metamask-previews/transaction-controller": "39.0.0-preview-913143f",
  "@metamask-previews/user-operation-controller": "18.0.0-preview-913143f"
}

[Matt561]

LGTM!