refactor: align with Promise.withResolvers() (#15171)

Author: patak-dev

packages/vite/src/node/optimizer/index.ts

@@ -166,11 +166,6 @@ export interface DepOptimizationResult {
   cancel: () => void
 }
 
-export interface DepOptimizationProcessing {
-  promise: Promise<void>
-  resolve: () => void
-}
-
 export interface OptimizedDepInfo {
   id: string
   file: string
@@ -885,14 +880,6 @@ export async function addManuallyIncludedOptimizeDeps(
   }
 }
 
-export function newDepOptimizationProcessing(): DepOptimizationProcessing {
-  let resolve: () => void
-  const promise = new Promise((_resolve) => {
-    resolve = _resolve
-  }) as Promise<void>
-  return { promise, resolve: resolve! }
-}
-
 // Convert to { id: src }
 export function depsFromOptimizedDepInfo(
   depsInfo: Record<string, OptimizedDepInfo>,

packages/vite/src/node/optimizer/optimizer.ts

@@ -1,5 +1,6 @@
 import colors from 'picocolors'
-import { createDebugger, getHash } from '../utils'
+import { createDebugger, getHash, promiseWithResolvers } from '../utils'
+import type { PromiseWithResolvers } from '../utils'
 import { getDepOptimizationConfig } from '../config'
 import type { ResolvedConfig, ViteDevServer } from '..'
 import {
@@ -14,17 +15,11 @@ import {
   getOptimizedDepPath,
   initDepsOptimizerMetadata,
   loadCachedDepOptimizationMetadata,
-  newDepOptimizationProcessing,
   optimizeServerSsrDeps,
   runOptimizeDeps,
   toDiscoveredDependencies,
 } from '.'
-import type {
-  DepOptimizationProcessing,
-  DepOptimizationResult,
-  DepsOptimizer,
-  OptimizedDepInfo,
-} from '.'
+import type { DepOptimizationResult, DepsOptimizer, OptimizedDepInfo } from '.'
 
 const debug = createDebugger('vite:deps')
 
@@ -142,8 +137,8 @@ async function createDepsOptimizer(
     }
   }
 
-  let depOptimizationProcessing = newDepOptimizationProcessing()
-  let depOptimizationProcessingQueue: DepOptimizationProcessing[] = []
+  let depOptimizationProcessing = promiseWithResolvers<void>()
+  let depOptimizationProcessingQueue: PromiseWithResolvers<void>[] = []
   const resolveEnqueuedProcessingPromises = () => {
     // Resolve all the processings (including the ones which were delayed)
     for (const processing of depOptimizationProcessingQueue) {
@@ -269,7 +264,7 @@ async function createDepsOptimizer(
 
     // Create a new promise for the next rerun, discovered missing
     // dependencies will be assigned this promise from this point
-    depOptimizationProcessing = newDepOptimizationProcessing()
+    depOptimizationProcessing = promiseWithResolvers()
   }
 
   function prepareKnownDeps() {

packages/vite/src/node/utils.ts

@@ -1331,3 +1331,18 @@ export function isDevServer(
 ): server is ViteDevServer {
   return 'pluginContainer' in server
 }
+
+export interface PromiseWithResolvers<T> {
+  promise: Promise<T>
+  resolve: (value: T | PromiseLike<T>) => void
+  reject: (reason?: any) => void
+}
+export function promiseWithResolvers<T>(): PromiseWithResolvers<T> {
+  let resolve: any
+  let reject: any
+  const promise = new Promise<T>((_resolve, _reject) => {
+    resolve = _resolve
+    reject = _reject
+  })
+  return { promise, resolve, reject }
+}

playground/test-utils.ts

@@ -267,12 +267,7 @@ async function untilBrowserLog(
   target?: string | RegExp | Array<string | RegExp>,
   expectOrder = true,
 ): Promise<string[]> {
-  let resolve: () => void
-  let reject: (reason: any) => void
-  const promise = new Promise<void>((_resolve, _reject) => {
-    resolve = _resolve
-    reject = _reject
-  })
+  const { promise, resolve, reject } = promiseWithResolvers<void>()
 
   const logs = []
 
@@ -363,3 +358,18 @@ export async function killProcess(
     serverProcess.kill('SIGTERM', { forceKillAfterTimeout: 2000 })
   }
 }
+
+export interface PromiseWithResolvers<T> {
+  promise: Promise<T>
+  resolve: (value: T | PromiseLike<T>) => void
+  reject: (reason?: any) => void
+}
+export function promiseWithResolvers<T>(): PromiseWithResolvers<T> {
+  let resolve: any
+  let reject: any
+  const promise = new Promise<T>((_resolve, _reject) => {
+    resolve = _resolve
+    reject = _reject
+  })
+  return { promise, resolve, reject }
+}