From 4cbb40d2f1a4050c9944e7e1d9e0f5b204b7e37b Mon Sep 17 00:00:00 2001
From: Evan You <yyx990803@gmail.com>
Date: Tue, 22 Jun 2021 12:24:51 -0400
Subject: [PATCH] feat: support new URL(url, import.meta.url) usage

---
 docs/guide/assets.md                          | 26 +++++
 .../assets/__tests__/assets.spec.ts           | 13 +++
 packages/playground/assets/index.html         | 27 ++++++
 packages/vite/src/node/build.ts               |  2 +
 packages/vite/src/node/importGlob.ts          |  8 +-
 .../src/node/plugins/assetImportMetaUrl.ts    | 96 +++++++++++++++++++
 6 files changed, 169 insertions(+), 3 deletions(-)
 create mode 100644 packages/vite/src/node/plugins/assetImportMetaUrl.ts

diff --git a/docs/guide/assets.md b/docs/guide/assets.md
index c60711cdadfa23..2d974ece37d049 100644
--- a/docs/guide/assets.md
+++ b/docs/guide/assets.md
@@ -82,3 +82,29 @@ Note that:
 
 - You should always reference `public` assets using root absolute path - for example, `public/icon.png` should be referenced in source code as `/icon.png`.
 - Assets in `public` cannot be imported from JavaScript.
+
+## new URL(url, import.meta.url)
+
+[import.meta.url](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import.meta) is a native ESM feature that exposes the current module's URL. Combining it with the native [URL constructor](https://developer.mozilla.org/en-US/docs/Web/API/URL), we can obtain the full, resolved URL of a static asset using relative path from a JavaScript module:
+
+```js
+const imgUrl = new URL('./img.png', import.meta.url)
+
+document.getElementById('hero-img').src = imgUrl
+```
+
+This works natively in modern browsers - in fact, Vite doesn't need to process this code at all during development!
+
+This pattern also supports dynamic URLs via template literals:
+
+```js
+function getImageUrl(name) {
+  return new URL(`./dir/${name}.png`, import.meta.url).href
+}
+```
+
+During the production build, Vite will perform necessary transforms so that the URLs still point to the correct location even after bundling and asset hashing.
+
+::: warning Note: Does not work with SSR
+This pattern does not work if you are using Vite for Server-Side Rendering, because `import.meta.url` have different semantics in browsers vs. Node.js. The server bundle also cannot determine the client host URL ahead of time.
+:::
diff --git a/packages/playground/assets/__tests__/assets.spec.ts b/packages/playground/assets/__tests__/assets.spec.ts
index 1b38346e49c700..083148c59aff89 100644
--- a/packages/playground/assets/__tests__/assets.spec.ts
+++ b/packages/playground/assets/__tests__/assets.spec.ts
@@ -183,6 +183,19 @@ test('?url import', async () => {
   )
 })
 
+test('new URL(..., import.meta.url)', async () => {
+  expect(await page.textContent('.import-meta-url')).toMatch(assetMatch)
+})
+
+test('new URL(`${dynamic}`, import.meta.url)', async () => {
+  expect(await page.textContent('.dynamic-import-meta-url-1')).toMatch(
+    isBuild ? 'data:image/png;base64' : '/foo/nested/icon.png'
+  )
+  expect(await page.textContent('.dynamic-import-meta-url-2')).toMatch(
+    assetMatch
+  )
+})
+
 if (isBuild) {
   test('manifest', async () => {
     const manifest = readManifest('foo')
diff --git a/packages/playground/assets/index.html b/packages/playground/assets/index.html
index a578e64388b740..8668fa03b4f483 100644
--- a/packages/playground/assets/index.html
+++ b/packages/playground/assets/index.html
@@ -118,6 +118,20 @@ <h2>?raw import</h2>
 <h2>?url import</h2>
 <code class="url"></code>
 
+<h2>new URL('...', import.meta.url)</h2>
+<img class="import-meta-url-img" />
+<code class="import-meta-url"></code>
+
+<h2>new URL(`./${dynamic}`, import.meta.url)</h2>
+<p>
+  <img class="dynamic-import-meta-url-img-1" />
+  <code class="dynamic-import-meta-url-1"></code>
+</p>
+<p>
+  <img class="dynamic-import-meta-url-img-2" />
+  <code class="dynamic-import-meta-url-2"></code>
+</p>
+
 <script type="module">
   import './css/fonts.css'
   import './css/css-url.css'
@@ -144,6 +158,19 @@ <h2>?url import</h2>
   import fooUrl from './foo.js?url'
   text('.url', fooUrl)
 
+  const metaUrl = new URL('./nested/asset.png', import.meta.url)
+  text('.import-meta-url', metaUrl)
+  document.querySelector('.import-meta-url-img').src = metaUrl
+
+  function testDynamicImportMetaUrl(name, i) {
+    const metaUrl = new URL(`./nested/${name}.png`, import.meta.url)
+    text(`.dynamic-import-meta-url-${i}`, metaUrl)
+    document.querySelector(`.dynamic-import-meta-url-img-${i}`).src = metaUrl
+  }
+
+  testDynamicImportMetaUrl('icon', 1)
+  testDynamicImportMetaUrl('asset', 2)
+
   function text(el, text) {
     document.querySelector(el).textContent = text
   }
diff --git a/packages/vite/src/node/build.ts b/packages/vite/src/node/build.ts
index 0c023d8c477596..5ee42a06f414de 100644
--- a/packages/vite/src/node/build.ts
+++ b/packages/vite/src/node/build.ts
@@ -37,6 +37,7 @@ import { ssrManifestPlugin } from './ssr/ssrManifestPlugin'
 import { isCSSRequest } from './plugins/css'
 import { DepOptimizationMetadata } from './optimizer'
 import { scanImports } from './optimizer/scan'
+import { assetImportMetaUrlPlugin } from './plugins/assetImportMetaUrl'
 
 export interface BuildOptions {
   /**
@@ -270,6 +271,7 @@ export function resolveBuildPlugins(config: ResolvedConfig): {
         warnOnError: true,
         exclude: [/node_modules/]
       }),
+      assetImportMetaUrlPlugin(config),
       ...(options.rollupOptions.plugins || [])
     ],
     post: [
diff --git a/packages/vite/src/node/importGlob.ts b/packages/vite/src/node/importGlob.ts
index 75a57953894e36..29fbca7569cc6c 100644
--- a/packages/vite/src/node/importGlob.ts
+++ b/packages/vite/src/node/importGlob.ts
@@ -26,6 +26,8 @@ export async function transformImportGlob(
   base: string
 }> {
   const isEager = source.slice(pos, pos + 21) === 'import.meta.globEager'
+  const isEagerDefault =
+    isEager && source.slice(pos + 21, pos + 28) === 'Default'
 
   const err = (msg: string) => {
     const e = new Error(`Invalid glob import syntax: ${msg}`)
@@ -79,9 +81,9 @@ export async function transformImportGlob(
     imports.push(importee)
     const identifier = `__glob_${importIndex}_${i}`
     if (isEager) {
-      importsString += `import * as ${identifier} from ${JSON.stringify(
-        importee
-      )};`
+      importsString += `import ${
+        isEagerDefault ? `` : `* as `
+      }${identifier} from ${JSON.stringify(importee)};`
       entries += ` ${JSON.stringify(file)}: ${identifier},`
     } else {
       let imp = `import(${JSON.stringify(importee)})`
diff --git a/packages/vite/src/node/plugins/assetImportMetaUrl.ts b/packages/vite/src/node/plugins/assetImportMetaUrl.ts
new file mode 100644
index 00000000000000..19723a29fbca67
--- /dev/null
+++ b/packages/vite/src/node/plugins/assetImportMetaUrl.ts
@@ -0,0 +1,96 @@
+import { Plugin } from '../plugin'
+import MagicString from 'magic-string'
+import path from 'path'
+import { fileToUrl } from './asset'
+import { ResolvedConfig } from '../config'
+
+const importMetaUrlRE =
+  /\bnew\s+URL\s*\(\s*('[^']+'|"[^"]+"|`[^`]+`)\s*,\s*import\.meta\.url\s*\)/g
+
+/**
+ * Convert `new URL('./foo.png', import.meta.url)` to its resolved built URL
+ *
+ * Supports tempalte string with dynamic segments:
+ * ```
+ * new URL(`./dir/${name}.png`, import.meta.url)
+ * // transformed to
+ * import.meta.globEager('./dir/**.png')[`./dir/${name}.png`].default
+ * ```
+ */
+export function assetImportMetaUrlPlugin(config: ResolvedConfig): Plugin {
+  return {
+    name: 'asset-import-meta-url',
+    async transform(code, id, ssr) {
+      if (code.includes('new URL') && code.includes(`import.meta.url`)) {
+        let s: MagicString | null = null
+        let match: RegExpExecArray | null
+        while ((match = importMetaUrlRE.exec(code))) {
+          const { 0: exp, 1: rawUrl, index } = match
+
+          if (ssr) {
+            this.error(
+              `\`new URL(url, import.meta.url)\` is not supported in SSR.`,
+              index
+            )
+          }
+
+          if (!s) s = new MagicString(code)
+
+          // potential dynamic template string
+          if (rawUrl[0] === '`' && /\$\{/.test(rawUrl)) {
+            const ast = this.parse(rawUrl)
+            const templateLiteral = (ast as any).body[0].expression
+            if (templateLiteral.expressions.length) {
+              const pattern = buildGlobPattern(templateLiteral)
+              // Note: native import.meta.url is not supported in the baseline
+              // target so we use window.location here -
+              s.overwrite(
+                index,
+                index + exp.length,
+                `new URL(import.meta.globEagerDefault(${JSON.stringify(
+                  pattern
+                )})[${rawUrl}], window.location)`
+              )
+              continue
+            }
+          }
+
+          const url = rawUrl.slice(1, -1)
+          const file = path.resolve(path.dirname(id), url)
+          const builtUrl = await fileToUrl(file, config, this)
+          s.overwrite(
+            index,
+            index + exp.length,
+            `new URL(${JSON.stringify(builtUrl)}, window.location)`
+          )
+        }
+        if (s) {
+          return {
+            code: s.toString(),
+            map: config.build.sourcemap ? s.generateMap({ hires: true }) : null
+          }
+        }
+      }
+      return null
+    }
+  }
+}
+
+function buildGlobPattern(ast: any) {
+  let pattern = ''
+  let lastElementIndex = -1
+  for (const exp of ast.expressions) {
+    for (let i = lastElementIndex + 1; i < ast.quasis.length; i++) {
+      const el = ast.quasis[i]
+      if (el.end < exp.start) {
+        pattern += el.value.raw
+        lastElementIndex = i
+      }
+    }
+    pattern += '**'
+  }
+  for (let i = lastElementIndex + 1; i < ast.quasis.length; i++) {
+    pattern += ast.quasis[i].value.raw
+  }
+  return pattern
+}