@exodus/headless 5.0.0-rc.27 → 5.0.0-rc.28

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.0.0-rc.28](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@5.0.0-rc.27...@exodus/headless@5.0.0-rc.28) (2024-07-29)
+
+### Features
+
+- **headless:** add timeout log for plugin methods ([#8044](https://github.com/ExodusMovement/exodus-hydra/issues/8044)) ([1fb051f](https://github.com/ExodusMovement/exodus-hydra/commit/1fb051fcb0478b7a3278efe8922339984fda0539))
+
 ## [5.0.0-rc.27](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@5.0.0-rc.26...@exodus/headless@5.0.0-rc.27) (2024-07-25)
 
 ### Bug Fixes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/headless",
-  "version": "5.0.0-rc.27",
+  "version": "5.0.0-rc.28",
   "description": "The platform-agnostic Exodus wallet SDK",
   "author": "Exodus Movement, Inc.",
   "main": "src/index.js",
@@ -70,7 +70,8 @@
     "bip39": "^2.6.0",
     "events": "^3.3.0",
     "lodash": "npm:@exodus/lodash@^4.17.21-exodus.2",
-    "minimalistic-assert": "^1.0.1"
+    "minimalistic-assert": "^1.0.1",
+    "ms": "^2.1.3"
   },
   "devDependencies": {
     "@exodus/ab-testing": "^7.5.1",
@@ -98,7 +99,7 @@
     "@exodus/models": "^11.9.0",
     "@exodus/nfts": "^9.3.3",
     "@exodus/personal-notes": "^3.6.2",
-    "@exodus/referrals": "^8.6.2",
+    "@exodus/referrals": "^8.7.3",
     "@exodus/solana-lib": "^2.0.0",
     "@exodus/solana-meta": "^1.0.2",
     "@exodus/storage-encrypted": "^1.4.1",
@@ -114,5 +115,5 @@
     "msw": "^2.0.0",
     "p-defer": "^4.0.0"
   },
-  "gitHead": "3995391eb48639b2d60ced5224a6a8f4902a2466"
+  "gitHead": "95f2c3ed980cac4564367a8b0b3cc7d0badbe1f1"
 }

package/src/index.js

@@ -28,6 +28,7 @@ import transactionSigner from '@exodus/tx-signer'
 import typeforce from '@exodus/typeforce'
 import wallet from '@exodus/wallet'
 import walletAccounts from '@exodus/wallet-accounts'
+import ms from 'ms'
 
 import createApi from './api'
 import createDependencies from './dependencies'
@@ -156,6 +157,7 @@ const createExodus = (opts) => {
       application,
       plugins: ioc.getByType('plugin'),
       logger: ioc.get('createLogger')('attachPlugins'),
+      pluginTimeout: config?.ioc?.pluginMethodsTimeout || ms('5s'),
     })
 
     return createApi({ ioc, port, config, debug, logger: ioc.get('createLogger')('createApi') })

package/src/plugins/attach.js

@@ -7,20 +7,24 @@ const LIFECYCLE_METHOD_TO_HOOK_NAME = Object.fromEntries(
   ])
 )
 
-const attachPlugins = ({ plugins, application, logger }) => {
-  const timeFn = (fn, name) => {
-    const pluginWrapper = async (...args) => {
+const attachPlugins = ({ plugins, application, logger, pluginTimeout }) => {
+  const lifecycleFuncWrapper = (fn, name) => {
+    const timeFn = async (...args) => {
+      const timeoutPid = setTimeout(() => {
+        logger.warn(`${name} reached time out of ${pluginTimeout}ms and is still running ...`)
+      }, pluginTimeout)
       const start = Date.now()
       try {
         return await fn(...args)
       } finally {
         logger.debug(name, `${Date.now() - start}ms`)
+        clearTimeout(timeoutPid)
       }
     }
 
-    Object.defineProperty(pluginWrapper, 'name', { value: name, writable: false })
+    Object.defineProperty(timeFn, 'name', { value: name, writable: false })
 
-    return pluginWrapper
+    return timeFn
   }
 
   Object.entries(plugins).forEach(([name, lifecycleMethods]) => {
@@ -29,7 +33,7 @@ const attachPlugins = ({ plugins, application, logger }) => {
     for (const [lifecycleMethod, fn] of entries) {
       const hookName = LIFECYCLE_METHOD_TO_HOOK_NAME[lifecycleMethod]
       if (hookName) {
-        application.hook(hookName, timeFn(fn, `plugin ${name}.${lifecycleMethod}`))
+        application.hook(hookName, lifecycleFuncWrapper(fn, `plugin ${name}.${lifecycleMethod}`))
       } else {
         logger.error(`plugin "${name}" declares unsupported lifecycle method "${lifecycleMethod}"`)
       }