From 108be949cd814ec8fc6214c6cdfa440c0dfd7e13 Mon Sep 17 00:00:00 2001
From: Evan You <yyx990803@gmail.com>
Date: Thu, 11 Feb 2021 17:26:37 -0500
Subject: [PATCH] fix(ssr): handle virtual modules during ssr

fix #1980
---
 .../ssr-vue/__tests__/ssr-vue.spec.ts         |  4 +++
 .../playground/ssr-vue/src/pages/Home.vue     |  2 ++
 packages/playground/ssr-vue/vite.config.js    | 18 ++++++++++++-
 .../vite/src/node/plugins/importAnalysis.ts   | 27 +++++++++----------
 .../src/node/server/middlewares/transform.ts  | 11 +++-----
 packages/vite/src/node/ssr/ssrModuleLoader.ts |  6 +++--
 packages/vite/src/node/utils.ts               |  8 +++++-
 7 files changed, 51 insertions(+), 25 deletions(-)

diff --git a/packages/playground/ssr-vue/__tests__/ssr-vue.spec.ts b/packages/playground/ssr-vue/__tests__/ssr-vue.spec.ts
index 24223b96c4967d..63a6034cc7b36d 100644
--- a/packages/playground/ssr-vue/__tests__/ssr-vue.spec.ts
+++ b/packages/playground/ssr-vue/__tests__/ssr-vue.spec.ts
@@ -93,6 +93,10 @@ test('jsx', async () => {
   expect(await page.textContent('.jsx')).toMatch('from JSX')
 })
 
+test('virtual module', async () => {
+  expect(await page.textContent('.virtual')).toMatch('hi')
+})
+
 test('hydration', async () => {
   expect(await page.textContent('button')).toMatch('0')
   await page.click('button')
diff --git a/packages/playground/ssr-vue/src/pages/Home.vue b/packages/playground/ssr-vue/src/pages/Home.vue
index 29e93f3e3cde16..35260df7dae30f 100644
--- a/packages/playground/ssr-vue/src/pages/Home.vue
+++ b/packages/playground/ssr-vue/src/pages/Home.vue
@@ -5,9 +5,11 @@
   </p>
   <button @click="state.count++">count is: {{ state.count }}</button>
   <Foo />
+  <p class="virtual">msg from virtual module: {{ foo.msg }}</p>
 </template>
 
 <script setup>
+import foo from '@foo'
 import { reactive, defineAsyncComponent } from 'vue'
 const Foo = defineAsyncComponent(() => import('../components/Foo').then(mod => mod.Foo))
 
diff --git a/packages/playground/ssr-vue/vite.config.js b/packages/playground/ssr-vue/vite.config.js
index 3c3ba42947a538..897b47ca7c2ec8 100644
--- a/packages/playground/ssr-vue/vite.config.js
+++ b/packages/playground/ssr-vue/vite.config.js
@@ -5,7 +5,23 @@ const vueJsx = require('@vitejs/plugin-vue-jsx')
  * @type {import('vite').UserConfig}
  */
 module.exports = {
-  plugins: [vuePlugin(), vueJsx()],
+  plugins: [
+    vuePlugin(),
+    vueJsx(),
+    {
+      name: 'virtual',
+      resolveId(id) {
+        if (id === '@foo') {
+          return id
+        }
+      },
+      load(id) {
+        if (id === '@foo') {
+          return `export default { msg: 'hi' }`
+        }
+      }
+    }
+  ],
   build: {
     minify: false
   }
diff --git a/packages/vite/src/node/plugins/importAnalysis.ts b/packages/vite/src/node/plugins/importAnalysis.ts
index 085bcd6ed13e1a..48eacf08c2b500 100644
--- a/packages/vite/src/node/plugins/importAnalysis.ts
+++ b/packages/vite/src/node/plugins/importAnalysis.ts
@@ -203,25 +203,24 @@ export function importAnalysisPlugin(config: ResolvedConfig): Plugin {
             VALID_ID_PREFIX + resolved.id.replace('\0', NULL_BYTE_PLACEHOLDER)
         }
 
-        // mark non-js/css imports with `?import`
+        // make the URL browser-valid if not SSR
         if (!ssr) {
+          // mark non-js/css imports with `?import`
           url = markExplicitImport(url)
-        }
 
-        // for relative js/css imports, inherit importer's version query
-        // do not do this for unknown type imports, otherwise the appended
-        // query can break 3rd party plugin's extension checks.
-        if (isRelative && !/[\?&]import\b/.test(url)) {
-          const versionMatch = importer.match(DEP_VERSION_RE)
-          if (versionMatch) {
-            url = injectQuery(url, versionMatch[1])
+          // for relative js/css imports, inherit importer's version query
+          // do not do this for unknown type imports, otherwise the appended
+          // query can break 3rd party plugin's extension checks.
+          if (isRelative && !/[\?&]import\b/.test(url)) {
+            const versionMatch = importer.match(DEP_VERSION_RE)
+            if (versionMatch) {
+              url = injectQuery(url, versionMatch[1])
+            }
           }
-        }
 
-        // check if the dep has been hmr updated. If yes, we need to attach
-        // its last updated timestamp to force the browser to fetch the most
-        // up-to-date version of this module.
-        if (!ssr) {
+          // check if the dep has been hmr updated. If yes, we need to attach
+          // its last updated timestamp to force the browser to fetch the most
+          // up-to-date version of this module.
           try {
             const depModule = await moduleGraph.ensureEntryFromUrl(url)
             if (depModule.lastHMRTimestamp > 0) {
diff --git a/packages/vite/src/node/server/middlewares/transform.ts b/packages/vite/src/node/server/middlewares/transform.ts
index fd96921d8ea564..2937f927427a1e 100644
--- a/packages/vite/src/node/server/middlewares/transform.ts
+++ b/packages/vite/src/node/server/middlewares/transform.ts
@@ -8,7 +8,8 @@ import {
   isJSRequest,
   prettifyUrl,
   removeImportQuery,
-  removeTimestampQuery
+  removeTimestampQuery,
+  unwrapId
 } from '../../utils'
 import { send } from '../send'
 import { transformRequest } from '../transformRequest'
@@ -18,8 +19,7 @@ import {
   CLIENT_PUBLIC_PATH,
   DEP_CACHE_DIR,
   DEP_VERSION_RE,
-  NULL_BYTE_PLACEHOLDER,
-  VALID_ID_PREFIX
+  NULL_BYTE_PLACEHOLDER
 } from '../../constants'
 import { isCSSRequest, isDirectCSSRequest } from '../../plugins/css'
 
@@ -111,12 +111,9 @@ export function transformMiddleware(
       ) {
         // strip ?import
         url = removeImportQuery(url)
-
         // Strip valid id prefix. This is preprended to resolved Ids that are
         // not valid browser import specifiers by the importAnalysis plugin.
-        if (url.startsWith(VALID_ID_PREFIX)) {
-          url = url.slice(VALID_ID_PREFIX.length)
-        }
+        url = unwrapId(url)
 
         // for CSS, we need to differentiate between normal CSS requests and
         // imports
diff --git a/packages/vite/src/node/ssr/ssrModuleLoader.ts b/packages/vite/src/node/ssr/ssrModuleLoader.ts
index 98cd0d237c7f38..384f43c9d1d5d8 100644
--- a/packages/vite/src/node/ssr/ssrModuleLoader.ts
+++ b/packages/vite/src/node/ssr/ssrModuleLoader.ts
@@ -1,7 +1,7 @@
 import fs from 'fs'
 import path from 'path'
 import { ViteDevServer } from '..'
-import { cleanUrl, resolveFrom } from '../utils'
+import { cleanUrl, resolveFrom, unwrapId } from '../utils'
 import { ssrRewriteStacktrace } from './ssrStacktrace'
 import {
   ssrExportAllKey,
@@ -23,6 +23,8 @@ export async function ssrLoadModule(
   context: SSRContext = { global: isolated ? Object.create(global) : global },
   urlStack: string[] = []
 ): Promise<Record<string, any>> {
+  url = unwrapId(url)
+
   if (urlStack.includes(url)) {
     server.config.logger.warn(
       `Circular dependency: ${urlStack.join(' -> ')} -> ${url}`
@@ -72,7 +74,7 @@ export async function ssrLoadModule(
     if (isExternal(dep)) {
       return nodeRequire(dep, mod.file, server.config.root)
     } else {
-      return moduleGraph.urlToModuleMap.get(dep)?.ssrModule
+      return moduleGraph.urlToModuleMap.get(unwrapId(dep))?.ssrModule
     }
   }
 
diff --git a/packages/vite/src/node/utils.ts b/packages/vite/src/node/utils.ts
index a539d0edf3e176..d2f6810c077e0a 100644
--- a/packages/vite/src/node/utils.ts
+++ b/packages/vite/src/node/utils.ts
@@ -4,7 +4,7 @@ import fs from 'fs'
 import os from 'os'
 import path from 'path'
 import { parse as parseUrl } from 'url'
-import { FS_PREFIX, DEFAULT_EXTENSIONS } from './constants'
+import { FS_PREFIX, DEFAULT_EXTENSIONS, VALID_ID_PREFIX } from './constants'
 import resolve from 'resolve'
 import builtins from 'builtin-modules'
 import { FSWatcher } from 'chokidar'
@@ -13,6 +13,12 @@ export function slash(p: string): string {
   return p.replace(/\\/g, '/')
 }
 
+// Strip valid id prefix. This is preprended to resolved Ids that are
+// not valid browser import specifiers by the importAnalysis plugin.
+export function unwrapId(id: string): string {
+  return id.startsWith(VALID_ID_PREFIX) ? id.slice(VALID_ID_PREFIX.length) : id
+}
+
 export const flattenId = (id: string) => id.replace(/[\/\.]/g, '_')
 
 export function isBuiltin(id: string): boolean {