packages/vite/src/node/plugins/optimizedDeps.ts

import fsp from 'node:fs/promises'
import colors from 'picocolors'
import type { ResolvedConfig } from '..'
import type { Plugin } from '../plugin'
import { DEP_VERSION_RE } from '../constants'
import { cleanUrl, createDebugger } from '../utils'
import { getDepsOptimizer, optimizedDepInfoFromFile } from '../optimizer'

export const ERR_OPTIMIZE_DEPS_PROCESSING_ERROR =
  'ERR_OPTIMIZE_DEPS_PROCESSING_ERROR'
export const ERR_OUTDATED_OPTIMIZED_DEP = 'ERR_OUTDATED_OPTIMIZED_DEP'

const debug = createDebugger('vite:optimize-deps')

export function optimizedDepsPlugin(config: ResolvedConfig): Plugin {
  return {
    name: 'vite:optimized-deps',

    resolveId(id, source, { ssr }) {
      if (getDepsOptimizer(config, ssr)?.isOptimizedDepFile(id)) {
        return id
      }
    },

    // this.load({ id }) isn't implemented in PluginContainer
    // The logic to register an id to wait until it is processed
    // is in importAnalysis, see call to delayDepsOptimizerUntil

    async load(id, options) {
      const ssr = options?.ssr === true
      const depsOptimizer = getDepsOptimizer(config, ssr)
      if (depsOptimizer?.isOptimizedDepFile(id)) {
        const metadata = depsOptimizer.metadata
        const file = cleanUrl(id)
        const versionMatch = id.match(DEP_VERSION_RE)
        const browserHash = versionMatch
          ? versionMatch[1].split('=')[1]
          : undefined

        // Search in both the currently optimized and newly discovered deps
        const info = optimizedDepInfoFromFile(metadata, file)
        if (info) {
          if (browserHash && info.browserHash !== browserHash) {
            throwOutdatedRequest(id)
          }
          try {
            // This is an entry point, it may still not be bundled
            await info.processing
          } catch {
            // If the refresh has not happened after timeout, Vite considers
            // something unexpected has happened. In this case, Vite
            // returns an empty response that will error.
            throwProcessingError(id)
            return
          }
          const newMetadata = depsOptimizer.metadata
          if (metadata !== newMetadata) {
            const currentInfo = optimizedDepInfoFromFile(newMetadata!, file)
            if (info.browserHash !== currentInfo?.browserHash) {
              throwOutdatedRequest(id)
            }
          }
        }
        debug?.(`load ${colors.cyan(file)}`)
        // Load the file from the cache instead of waiting for other plugin
        // load hooks to avoid race conditions, once processing is resolved,
        // we are sure that the file has been properly save to disk
        try {
          return await fsp.readFile(file, 'utf-8')
        } catch (e) {
          // Outdated non-entry points (CHUNK), loaded after a rerun
          throwOutdatedRequest(id)
        }
      }
    },
  }
}

export function optimizedDepsBuildPlugin(config: ResolvedConfig): Plugin {
  let buildStartCalled = false

  return {
    name: 'vite:optimized-deps-build',

    buildStart() {
      // Only reset the registered ids after a rebuild during build --watch
      if (!config.isWorker && buildStartCalled) {
        getDepsOptimizer(config)?.resetRegisteredIds()
      }
      buildStartCalled = true
    },

    async resolveId(id, importer, options) {
      const depsOptimizer = getDepsOptimizer(config)
      if (!depsOptimizer) return

      if (depsOptimizer.isOptimizedDepFile(id)) {
        return id
      } else {
        if (options?.custom?.['vite:pre-alias']) {
          // Skip registering the id if it is being resolved from the pre-alias plugin
          // When a optimized dep is aliased, we need to avoid waiting for it before optimizing
          return
        }
        const resolved = await this.resolve(id, importer, {
          ...options,
          skipSelf: true,
        })
        if (resolved && !resolved.external) {
          depsOptimizer.delayDepsOptimizerUntil(resolved.id, async () => {
            await this.load(resolved)
          })
        }
        return resolved
      }
    },

    async load(id) {
      const depsOptimizer = getDepsOptimizer(config)
      if (!depsOptimizer?.isOptimizedDepFile(id)) {
        return
      }

      depsOptimizer?.ensureFirstRun()

      const file = cleanUrl(id)
      // Search in both the currently optimized and newly discovered deps
      // If all the inputs are dependencies, we aren't going to get any
      const info = optimizedDepInfoFromFile(depsOptimizer.metadata, file)
      if (info) {
        await info.processing
        debug?.(`load ${colors.cyan(file)}`)
      } else {
        throw new Error(
          `Something unexpected happened while optimizing "${id}".`,
        )
      }

      // Load the file from the cache instead of waiting for other plugin
      // load hooks to avoid race conditions, once processing is resolved,
      // we are sure that the file has been properly save to disk
      return fsp.readFile(file, 'utf-8')
    },
  }
}

function throwProcessingError(id: string): never {
  const err: any = new Error(
    `Something unexpected happened while optimizing "${id}". ` +
      `The current page should have reloaded by now`,
  )
  err.code = ERR_OPTIMIZE_DEPS_PROCESSING_ERROR
  // This error will be caught by the transform middleware that will
  // send a 504 status code request timeout
  throw err
}

export function throwOutdatedRequest(id: string): never {
  const err: any = new Error(
    `There is a new version of the pre-bundle for "${id}", ` +
      `a page reload is going to ask for it.`,
  )
  err.code = ERR_OUTDATED_OPTIMIZED_DEP
  // This error will be caught by the transform middleware that will
  // send a 504 status code request timeout
  throw err
}