Fix some types

Author: watson

integration-tests/debugger/snapshot-time-budget.spec.js

@@ -66,7 +66,8 @@ describe('Dynamic Instrumentation', function () {
             }))
 
             // Trigger once; this run is expected to be slow and mark fields with "timeout"
-            const result1 = await breakpoint.triggerBreakpoint()
+            const result1 = /** @type {import('axios').AxiosResponse<{ paused: number }>} */
+              (await breakpoint.triggerBreakpoint())
             assert.ok(
               result1.data.paused >= 1_000,
               `expected thread to be paused for at least 1 second, but was paused for ~${result1.data.paused}ms`

integration-tests/debugger/target-app/snapshot-time-budget.js

@@ -1,11 +1,13 @@
 'use strict'
 
+// @ts-expect-error This code is running in a sandbox where dd-trace is available
 require('dd-trace/init')
 
 // @ts-expect-error This code is running in a sandbox where fastify is available
 const Fastify = require('fastify')
 const {
   LARGE_OBJECT_SKIP_THRESHOLD
+  // @ts-expect-error This code is running in a sandbox where dd-trace is available
 } = require('dd-trace/packages/dd-trace/src/debugger/devtools_client/snapshot/constants')
 
 const fastify = Fastify({ logger: { level: 'error' } })

integration-tests/debugger/utils.js

@@ -41,7 +41,7 @@ const pollInterval = 0.1
  *
  * @typedef {BreakpointInfo & {
  *   rcConfig: object|null,
- *   triggerBreakpoint: (url: string) => Promise<import('axios').AxiosResponse<unknown>>,
+ *   triggerBreakpoint: () => Promise<import('axios').AxiosResponse<unknown>>,
  *   generateRemoteConfig: (overrides?: object) => object,
  *   generateProbeConfig: BoundGenerateProbeConfigFn
  * }} EnrichedBreakpoint
@@ -66,6 +66,7 @@ const pollInterval = 0.1
  *   once installed.
  * @property {(overrides?: object) => object} generateRemoteConfig - Generates RC for the primary breakpoint.
  * @property {BoundGenerateProbeConfigFn} generateProbeConfig - Generates probe config for the primary breakpoint.
+ * @property {() => Promise<object>} snapshotReceived - Waits for a snapshot to be received from the test app.
  */
 
 module.exports = {
@@ -132,7 +133,7 @@ function setup ({ env, testApp, testAppSource, dependencies, silent, stdioHandle
     generateProbeConfig: generateProbeConfig.bind(null, breakpoints[0]),
 
     snapshotReceived () {
-      return new Promise((/** @type {(value?: object) => void} */ resolve) => {
+      return new Promise((/** @type {(value: object) => void} */ resolve) => {
         t.agent.on('debugger-input', ({ payload: [{ debugger: { snapshot } }] }) => {
           resolve(snapshot)
         })

packages/dd-trace/test/debugger/devtools_client/utils.js

@@ -7,6 +7,12 @@ module.exports = {
   getRequestOptions
 }
 
+/**
+ * @typedef {object} RequestOptions
+ * @property {string} method
+ * @property {string} path
+ */
+
 /**
  * @typedef {object} ProbeConfig
  * @property {string} id
@@ -63,7 +69,7 @@ function generateProbeConfig (breakpoint, overrides = {}) {
  * Get the request options from a request spy call
  *
  * @param {sinon.SinonSpy} request - The request spy to get the options from.
- * @returns {unknown} - The 2nd argument to the `request` function (i.e. the request options).
+ * @returns {RequestOptions} - The 2nd argument to the `request` function (i.e. the request options).
  */
 function getRequestOptions (request) {
   return request.lastCall.args[1]