apply() — vue Function Reference

Architecture documentation for the apply() function in server.ts from the vue codebase.

Function typescript ServerRenderer BundleRenderer calls 2

Entity Profile

ServerRenderer→ BundleRenderer→ apply() — vue Function Reference

Dependency Diagram

graph TD
  dbfa2018_ca28_4a7e_bd4e_3f2e5fcb1d8a["apply()"]
  e36c9e55_f0f7_f114_a58b_ccdd13b9e292["VueSSRServerPlugin"]
  dbfa2018_ca28_4a7e_bd4e_3f2e5fcb1d8a -->|defined in| e36c9e55_f0f7_f114_a58b_ccdd13b9e292
  165ad625_fe2f_2841_ca25_48bc6fda664f["validate()"]
  dbfa2018_ca28_4a7e_bd4e_3f2e5fcb1d8a -->|calls| 165ad625_fe2f_2841_ca25_48bc6fda664f
  67bc246a_b935_05a8_c244_11f687e4f578["onEmit()"]
  dbfa2018_ca28_4a7e_bd4e_3f2e5fcb1d8a -->|calls| 67bc246a_b935_05a8_c244_11f687e4f578
  style dbfa2018_ca28_4a7e_bd4e_3f2e5fcb1d8a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/server-renderer/src/webpack-plugin/server.ts lines 14–73

  apply(compiler) {
    validate(compiler)

    const stage = 'PROCESS_ASSETS_STAGE_OPTIMIZE_TRANSFER'
    onEmit(compiler, 'vue-server-plugin', stage, (compilation, cb) => {
      const stats = compilation.getStats().toJson()
      const entryName = Object.keys(stats.entrypoints)[0]
      const entryInfo = stats.entrypoints[entryName]

      if (!entryInfo) {
        // #5553
        return cb()
      }

      const entryAssets = entryInfo.assets.map(getAssetName).filter(isJS)

      if (entryAssets.length > 1) {
        throw new Error(
          `Server-side bundle should have one single entry file. ` +
            `Avoid using CommonsChunkPlugin in the server config.`
        )
      }

      const entry = entryAssets[0]
      if (!entry || typeof entry !== 'string') {
        throw new Error(
          `Entry "${entryName}" not found. Did you specify the correct entry option?`
        )
      }

      const bundle = {
        entry,
        files: {},
        maps: {}
      }

      Object.keys(compilation.assets).forEach(name => {
        if (isJS(name)) {
          bundle.files[name] = compilation.assets[name].source()
        } else if (name.match(/\.js\.map$/)) {
          bundle.maps[name.replace(/\.map$/, '')] = JSON.parse(
            compilation.assets[name].source()
          )
        }
        // do not emit anything else for server
        delete compilation.assets[name]
      })

      const json = JSON.stringify(bundle, null, 2)
      //@ts-expect-error
      const filename = this.options.filename

      compilation.assets[filename] = {
        source: () => json,
        size: () => json.length
      }

      cb()
    })
  }