Don't return NodeJS.Timer from setTimeout and setInterval (#622)

Co-authored-by: Kiko Beats <josefrancisco.verdu@gmail.com>

.changeset/slimy-hairs-lay.md

@@ -0,0 +1,7 @@
+---
+"@edge-runtime/ponyfill": patch
+"@edge-runtime/primitives": patch
+"@edge-runtime/vm": patch
+---
+
+Don't return `NodeJS.Timer` from `setTimeout` and `setInterval`

packages/ponyfill/src/index.js

@@ -26,6 +26,8 @@ function edge() {
     ReadableStreamDefaultReader,
     Request,
     Response,
+    setInterval,
+    setTimeout,
     structuredClone,
     SubtleCrypto,
     TextDecoder,

packages/primitives/src/primitives/load.js

@@ -97,6 +97,18 @@ export function load(scopedContext = {}) {
   })
   assign(context, { console: consoleImpl.console })
 
+  /** @type {import('../../type-definitions/timer')} */
+  const timeoutImpl = requireWithFakeGlobalScope({
+    context,
+    id: 'timeout.js',
+    sourceCode: injectSourceCode('./timer.js'),
+    scopedContext,
+  })
+  assign(context, {
+    setTimeout: timeoutImpl.setTimeout,
+    setInterval: timeoutImpl.setInterval,
+  })
+
   /** @type {import('../../type-definitions/events')} */
   const eventsImpl = requireWithFakeGlobalScope({
     context,

packages/primitives/src/primitives/timer.js

@@ -0,0 +1,10 @@
+const timeoutProxy = new Proxy(setTimeout, {
+  apply: (target, thisArg, args) => {
+    const timeout = Reflect.apply(target, thisArg, args)
+    // Returns integer value of timeout ID
+    return timeout[Symbol.toPrimitive]()
+  },
+})
+
+export { timeoutProxy as setTimeout }
+export { timeoutProxy as setInterval }

packages/primitives/type-definitions/index.d.ts

@@ -9,3 +9,4 @@ export * from './streams'
 export * from './text-encoding-streams'
 export * from './structured-clone'
 export * from './url'
+export * from './timer'

packages/primitives/type-definitions/timer.d.ts

@@ -0,0 +1,5 @@
+declare const _setTimeout: typeof Number
+declare const _setInterval: typeof Number
+
+export { _setTimeout as setTimeout }
+export { _setInterval as setInterval }

packages/vm/src/edge-vm.ts

@@ -140,7 +140,7 @@ function patchInstanceOf(item: string, ctx: any) {
         }
       })
     `,
-    ctx
+    ctx,
   )
 }
 
@@ -155,9 +155,9 @@ function registerUnhandledRejectionHandlers(handlers: RejectionHandler[]) {
       'unhandledRejection',
       function invokeRejectionHandlers(reason, promise) {
         unhandledRejectionHandlers.forEach((handler) =>
-          handler({ reason, promise })
+          handler({ reason, promise }),
         )
-      }
+      },
     )
   }
   unhandledRejectionHandlers = handlers
@@ -294,6 +294,8 @@ export type EdgeContext = VMContext & {
   ReadableStreamDefaultReader: typeof EdgePrimitives.ReadableStreamDefaultReader
   Request: typeof EdgePrimitives.Request
   Response: typeof EdgePrimitives.Response
+  setTimeout: typeof EdgePrimitives.setTimeout
+  setInterval: typeof EdgePrimitives.setInterval
   structuredClone: typeof EdgePrimitives.structuredClone
   SubtleCrypto: typeof EdgePrimitives.SubtleCrypto
   TextDecoder: typeof EdgePrimitives.TextDecoder
@@ -315,8 +317,6 @@ function addPrimitives(context: VMContext) {
   defineProperty(context, 'Symbol', { value: Symbol })
   defineProperty(context, 'clearInterval', { value: clearInterval })
   defineProperty(context, 'clearTimeout', { value: clearTimeout })
-  defineProperty(context, 'setInterval', { value: setInterval })
-  defineProperty(context, 'setTimeout', { value: setTimeout })
   defineProperty(context, 'queueMicrotask', { value: queueMicrotask })
   defineProperty(context, 'EdgeRuntime', { value: 'edge-runtime' })
 
@@ -383,6 +383,10 @@ function addPrimitives(context: VMContext) {
 
       // Console
       'console',
+
+      // Timers
+      'setTimeout',
+      'setInterval',
     ],
   })
 
@@ -404,7 +408,7 @@ function defineProperties(
     exports: Record<string, any>
     enumerable?: string[]
     nonenumerable?: string[]
-  }
+  },
 ) {
   for (const property of options.enumerable ?? []) {
     if (!options.exports[property]) {
@@ -433,7 +437,7 @@ function defineProperties(
  * implemented in the provided context.
  */
 function getTransferablePrimitivesFromContext(
-  context: Context
+  context: Context,
 ): Record<(typeof transferableConstructors)[number], unknown> {
   const keys = transferableConstructors.join(',')
   const stringifedObject = `({${keys}})`

packages/vm/tests/edge-runtime.test.ts

@@ -622,3 +622,21 @@ describe('Event handlers', () => {
     expect((runtime as any).__rejectionHandlers).toBeUndefined()
   })
 })
+
+describe('`Timers`', () => {
+  it.each(['setTimeout', 'setInterval'])(
+    '%s function should return integer',
+    async (f) => {
+      const runtime = new EdgeVM()
+      expect(() => {
+        runtime.evaluate(`
+        const timer = ${f}(() => {}, 1000);
+        timer.unref();
+      `)
+      }).toThrow({
+        name: 'Error',
+        message: `timer.unref is not a function`,
+      })
+    },
+  )
+})