Bump hot-shots from 13.2.0 to 14.3.1 (#60887)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: 3 people

package-lock.json

@@ -217,7 +217,7 @@
     "helmet": "^8.1.0",
     "highlight.js": "^11.11.1",
     "highlightjs-curl": "^1.3.0",
-    "hot-shots": "^13.2.0",
+    "hot-shots": "^14.3.1",
     "html-entities": "^2.5.6",
     "http-proxy-middleware": "^3.0.5",
     "imurmurhash": "^0.1.4",

package.json

@@ -1,7 +1,7 @@
 import type { Response, NextFunction } from 'express'
 import { fetchWithRetry } from '@/frame/lib/fetch-utils'
 
-import statsd from '@/observability/lib/statsd'
+import statsd, { adaptForTimer } from '@/observability/lib/statsd'
 import { createLogger } from '@/observability/logger'
 import {
   firstVersionDeprecatedOnNewSite,
@@ -252,7 +252,7 @@ export default async function archivedEnterpriseVersions(
 
   const statsdTags = [`version:${requestedVersion}`]
   const startTime = Date.now()
-  const r = await statsd.asyncTimer(doGet, 'archive_enterprise_proxy', [
+  const r = await statsd.asyncTimer(adaptForTimer(doGet), 'archive_enterprise_proxy', [
     ...statsdTags,
     `path:${req.path}`,
   ])()

src/archives/middleware/archived-enterprise-versions.ts

@@ -1,7 +1,7 @@
 import { createHmac } from 'crypto'
 import { fetchWithRetry } from '@/frame/lib/fetch-utils'
 import { isNil } from 'lodash-es'
-import statsd from '@/observability/lib/statsd'
+import statsd, { adaptForTimer } from '@/observability/lib/statsd'
 import { report } from '@/observability/lib/failbot'
 import { MAX_REQUEST_TIMEOUT } from '@/frame/lib/constants'
 import { createLogger } from '@/observability/logger'
@@ -95,4 +95,6 @@ async function _publish(
   return response
 }
 
-export const publish = statsd.asyncTimer(_publish, 'hydro.response_time')
+const _publishTimed = statsd.asyncTimer(adaptForTimer(_publish), 'hydro.response_time')
+export const publish: typeof _publish = (...args) =>
+  _publishTimed(...(args as Parameters<typeof _publish>))

src/events/lib/hydro.ts

@@ -1,4 +1,4 @@
-import statsd from '@/observability/lib/statsd'
+import statsd, { adaptForTimer } from '@/observability/lib/statsd'
 import { loadUnversionedTree, loadSiteTree, loadPages, loadPageMap } from './page-data'
 import loadRedirects from '@/redirects/lib/precompile'
 import { createLogger } from '@/observability/logger'
@@ -17,12 +17,15 @@ type WarmServerResult = {
 // Instrument these functions so that
 // it's wrapped in a timer that reports to Datadog
 const dog = {
-  loadUnversionedTree: statsd.asyncTimer(loadUnversionedTree, 'load_unversioned_tree'),
-  loadSiteTree: statsd.asyncTimer(loadSiteTree, 'load_site_tree'),
-  loadPages: statsd.asyncTimer(loadPages, 'load_pages'),
-  loadPageMap: statsd.asyncTimer(loadPageMap, 'load_page_map'),
-  loadRedirects: statsd.asyncTimer(loadRedirects, 'load_redirects'),
-  warmServer: statsd.asyncTimer(warmServer, 'warm_server'),
+  loadUnversionedTree: statsd.asyncTimer(
+    adaptForTimer(loadUnversionedTree),
+    'load_unversioned_tree',
+  ),
+  loadSiteTree: statsd.asyncTimer(adaptForTimer(loadSiteTree), 'load_site_tree'),
+  loadPages: statsd.asyncTimer(adaptForTimer(loadPages), 'load_pages'),
+  loadPageMap: statsd.asyncTimer(adaptForTimer(loadPageMap), 'load_page_map'),
+  loadRedirects: statsd.asyncTimer(adaptForTimer(loadRedirects), 'load_redirects'),
+  warmServer: statsd.asyncTimer(adaptForTimer(warmServer), 'warm_server'),
 }
 
 // For multiple-triggered Promise sharing
@@ -59,7 +62,7 @@ async function warmServer(languagesOnly: string[] = []): Promise<WarmServerResul
   })
 
   stepStart = Date.now()
-  const pageMap = await dog.loadPageMap(pageList)
+  const pageMap = await dog.loadPageMap(pageList, [])
   logger.info('warm-server: loadPageMap complete', {
     durationMs: Date.now() - stepStart,
     permalinkCount: Object.keys(pageMap).length,

src/frame/lib/warm-server.ts

@@ -6,7 +6,7 @@ import { get } from 'lodash-es'
 import { buildMiniTocFromCollected, type CollectedHeading } from '@/frame/lib/get-mini-toc-items'
 import patterns from '@/frame/lib/patterns'
 import FailBot from '@/observability/lib/failbot'
-import statsd from '@/observability/lib/statsd'
+import statsd, { adaptForTimer } from '@/observability/lib/statsd'
 import type { ExtendedRequest } from '@/types'
 import { allVersions } from '@/versions/lib/all-versions'
 import { transformerRegistry } from '@/article-api/transformers'
@@ -31,7 +31,9 @@ async function buildRenderedPage(req: ExtendedRequest): Promise<string> {
     context.collectMiniToc = collectMiniToc
   }
 
-  const pageRenderTimed = statsd.asyncTimer(page.render, STATSD_KEY_RENDER, [`path:${path}`])
+  const pageRenderTimed = statsd.asyncTimer(adaptForTimer(page.render), STATSD_KEY_RENDER, [
+    `path:${path}`,
+  ])
 
   return (await pageRenderTimed(context)) as string
 }

src/frame/middleware/render-page.ts

@@ -1,4 +1,4 @@
-import StatsD from 'hot-shots'
+import StatsD, { TimerContext } from 'hot-shots'
 
 const {
   NODE_ENV,
@@ -33,3 +33,16 @@ const statsd = new StatsD({
 })
 
 export default statsd
+
+// hot-shots v14 changed asyncTimer/timer to inject a TimerContext as the
+// final argument of the wrapped function. This adapter lets callers keep
+// passing functions with their original signatures by appending an ignored
+// TimerContext parameter.
+export function adaptForTimer<P extends unknown[], R>(
+  fn: (...args: P) => Promise<R>,
+): (...args: [...P, TimerContext]) => Promise<R> {
+  return (...args) => {
+    const original = args.slice(0, -1) as P
+    return fn(...original)
+  }
+}

src/observability/lib/statsd.ts

@@ -9,7 +9,7 @@ When a user directly hits our API e.g. /api/search/v1?query=foo, they will hit t
 import { fetchWithRetry } from '@/frame/lib/fetch-utils'
 import { Request, Response, NextFunction } from 'express'
 import { errors } from '@elastic/elasticsearch'
-import statsd from '@/observability/lib/statsd'
+import statsd, { adaptForTimer } from '@/observability/lib/statsd'
 
 import { getPathWithoutVersion, getPathWithoutLanguage } from '@/frame/lib/path-utils'
 import { getGeneralSearchResults } from '@/search/lib/get-elasticsearch-results/general-search'
@@ -94,7 +94,11 @@ export default async function contextualizeGeneralSearch(
       }
     } else {
       const tags: string[] = [`indexName:${indexName}`, `toplevels:${searchParams.toplevel.length}`]
-      const timed = statsd.asyncTimer(getGeneralSearchResults, 'contextualize.search', tags)
+      const timed = statsd.asyncTimer(
+        adaptForTimer(getGeneralSearchResults),
+        'contextualize.search',
+        tags,
+      )
       const getGeneralSearchArgs = {
         indexName,
         searchParams,