@open-xchange/vite-plugin-ox-manifests 0.4.2 → 0.4.4-pre2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/vite-plugin-ox-manifests",
-  "version": "0.4.2",
+  "version": "0.4.4-pre2",
   "description": "A vite plugin to concat and serve ox manifests",
   "main": "index.js",
   "type": "module",

package/src/plugins/gettext.js

@@ -1,5 +1,5 @@
 import { applyInputToOptions } from '../util.js'
-import path from 'path'
+import path, { posix } from 'path'
 import { readdir } from 'fs/promises'
 import { normalizePath } from 'vite'
 import { parsePoFile, namespacesFrom } from '@open-xchange/rollup-plugin-po2json/lib/po2json.js'
@@ -44,7 +44,7 @@ export default function () {
 
     getManifests () {
       if (resolvedConfig.mode !== 'production') {
-        return manifests.map(({ namespace, path }) => ({ namespace, raw: `/@id/${path}.js`, path }))
+        return manifests.map(({ namespace, path }) => ({ namespace, raw: posix.join(resolvedConfig.base, `/@id/${path}.js`), path }))
       }
       return manifests
     },
@@ -54,9 +54,11 @@ export default function () {
         const chunk = bundle[file]
         if (!chunk.facadeModuleId) continue
 
-        Object.keys(chunk.modules).forEach(id => {
+        const modules = Object.keys(chunk.modules)
+        if (modules.length === 0) modules.push(chunk.facadeModuleId)
+        modules.forEach(id => {
           const meta = this.getModuleInfo(id)?.meta
-          if (!meta?.gettext?.dictionary === true) return
+          if (meta?.gettext?.dictionary !== true) return
 
           meta.manifests = meta.manifests || []
           meta.manifests.push({ namespace: 'i18n' })

package/src/plugins/serve.js

@@ -1,4 +1,4 @@
-import path from 'path'
+import path, { posix } from 'path'
 import parseurl from 'parseurl'
 import chokidar from 'chokidar'
 
@@ -30,7 +30,7 @@ export default function ({ watch } = {}) {
           if (!moduleNode) return
           const hmrTS = moduleNode.lastHMRTimestamp
           if (!hmrTS) return
-          manifest.raw = `/${manifest.path}.js?t=${hmrTS}`
+          manifest.raw = posix.join(resolvedConfig.base, `/${manifest.path}.js?t=${hmrTS}`)
         })
       }
 

package/src/plugins/settings.js

@@ -1,6 +1,6 @@
 import fastGlob from 'fast-glob'
 import fs from 'fs'
-import path from 'path'
+import path, { posix } from 'path'
 import { applyInputToOptions, basepath } from '../util.js'
 
 function getRequirements (entry) {
@@ -17,7 +17,7 @@ function getRequirements (entry) {
     const moduleInfo = this.getModuleInfo(first)
     if (moduleInfo.isEntry) {
       if (moduleInfo.meta?.manifests) {
-        entryPoints.push.apply(entryPoints, moduleInfo.meta.manifests)
+        entryPoints.push.apply(entryPoints, moduleInfo.meta.manifests.map(manifest => ({ requires: 'true', ...manifest })))
         continue
       }
     }
@@ -33,6 +33,7 @@ function getRequirements (entry) {
 function mergeRequirements (requirements) {
   if (requirements.length === 0) return
   if (requirements.length === 1) return requirements[0]
+  if (requirements.includes('true')) return
   return requirements.map(c => {
     // check if is just a simple string
     if (/^[-\w]*$/.test(c)) return c
@@ -107,7 +108,7 @@ export default function ({ autoloadSettings } = {}) {
           const manifest = { ...m, path: newPath }
           const moduleNode = moduleGraph?.idToModuleMap.get(path)
           if (moduleNode?.lastHMRTimestamp) {
-            manifest.raw = `/${manifest.path}.js?t=${moduleNode.lastHMRTimestamp}`
+            manifest.raw = posix.join(resolvedConfig.base, `/${manifest.path}.js?t=${moduleNode.lastHMRTimestamp}`)
           }
           return manifest
         }

package/src/util.js

@@ -38,3 +38,20 @@ export function deepMergeObject (a, b) {
 
   return result
 }
+
+export function waitForReload (server) {
+  return new Promise(resolve => {
+    const prev = server.ws.send
+    server.ws.send = function ({ type } = {}) {
+      try {
+        return prev.apply(this, arguments)
+      } finally {
+        if (type === 'full-reload') resolve()
+      }
+    }
+  })
+}
+
+export function wait (millis) {
+  return new Promise(resolve => setTimeout(resolve, millis))
+}

package/test/gettext-chunked/another_chunk.js

@@ -0,0 +1,4 @@
+import gt from 'gettext'
+
+export const five = 5
+export default gt('five')

package/test/gettext-chunked/i18n/de_DE.po

@@ -0,0 +1,16 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"PO-Revision-Date: 2014-01-15 14:13+0100\n"
+"Last-Translator: Julian Bäume <julian.baeume@open-xchange.com>\n"
+"Language-Team: German <julian.baeume@open-xchange.com>\n"
+"Language: de_DE\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"X-Generator: Lokalize 1.5\n"
+
+#: module:i18n
+msgid "Hello world!"
+msgstr "Hallo Welt!"

package/test/gettext-chunked/i18n/en_US.po

@@ -0,0 +1,16 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"PO-Revision-Date: 2014-01-15 14:13+0100\n"
+"Last-Translator: Julian Bäume <julian.baeume@open-xchange.com>\n"
+"Language-Team: German <julian.baeume@open-xchange.com>\n"
+"Language: en_US\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"X-Generator: Lokalize 1.5\n"
+
+#: module:i18n
+msgid "Hello world!"
+msgstr ""

package/test/gettext-chunked/main.test.js

@@ -0,0 +1,68 @@
+import { describe, it, expect, afterEach } from '@jest/globals'
+import { build, createServer } from 'vite'
+import path from 'path'
+import vitePluginOxManifests from '../../index'
+import rollupPluginPo2Json from '@open-xchange/rollup-plugin-po2json'
+import { getFileFromBundle, getPort } from '../util'
+import axios from 'axios'
+
+const PORT = getPort()
+const __dirname = path.dirname(new URL(import.meta.url).pathname)
+
+describe('Dictionary in modules with dynamic imports', function () {
+  let server
+
+  afterEach(async function () {
+    if (server) {
+      await server.close()
+      server = null
+    }
+  })
+
+  it('works', async function () {
+    const bundle = await build({
+      root: __dirname,
+      logLevel: 'silent',
+      build: {
+        write: false,
+        rollupOptions: {
+          input: { }
+        }
+      },
+      plugins: [rollupPluginPo2Json({
+        poFiles: __dirname + '/i18n/*.po'
+      }), vitePluginOxManifests({
+
+      })]
+    })
+
+    const manifestFile = getFileFromBundle('manifest', bundle)
+    const manifests = JSON.parse(manifestFile.source)
+    expect(Object.keys(manifests)).toHaveLength(6)
+    expect(manifests['register.js'].meta.manifests[0].namespace).toEqual('test')
+    expect(manifests['../../i18n.js'].meta.gettext.dictionary).toEqual(true)
+    expect(manifests['../../i18n.js'].meta.manifests[0].namespace).toEqual('i18n')
+  })
+
+  it('works in dev mode', async function () {
+    server = await createServer({
+      root: __dirname,
+      logLevel: 'silent',
+      plugins: [rollupPluginPo2Json({
+        poFiles: __dirname + '/i18n/*.po'
+      }), vitePluginOxManifests({
+
+      })]
+    })
+    await server.listen(PORT)
+
+    const res = await axios({ baseURL: `http://127.0.0.1:${PORT}/api/manifest.json` })
+    const manifests = res.data
+
+    expect(manifests).toHaveLength(2)
+    expect(manifests[0].namespace).toEqual('i18n')
+    expect(manifests[0].path).toEqual('i18n')
+    expect(manifests[1].namespace).toEqual('test')
+    expect(manifests[1].path).toContain('register')
+  })
+})

package/test/gettext-chunked/manifest.json

@@ -0,0 +1,3 @@
+{
+    "namespace": "test"
+}

package/test/gettext-chunked/register.js

@@ -0,0 +1,6 @@
+import gt from 'gettext'
+
+export async function doSomethingDynamic () {
+  const { five } = await import('./another_chunk.js')
+  console.log(gt('Hello world!'), five)
+}

package/test/hmr/main.test.js

@@ -0,0 +1,122 @@
+import { describe, it, expect, beforeEach, afterEach } from '@jest/globals'
+import { createServer } from 'vite'
+import path from 'path'
+import vitePluginOxManifests from '../../index'
+import { getPort } from '../util'
+import axios from 'axios'
+import { readFileSync, writeFileSync } from 'fs'
+import { waitForReload } from '../../src/util'
+import vitePluginOxExternals from '@open-xchange/vite-plugin-ox-externals'
+
+const __dirname = path.dirname(new URL(import.meta.url).pathname)
+const files = ['register.js', 'settings.js']
+const PORT = getPort()
+
+describe('HMR', function () {
+  let server, data
+
+  beforeEach(function () {
+    data = files.map(f => readFileSync(path.join(__dirname, f)))
+  })
+
+  afterEach(async function () {
+    data.forEach((d, i) => writeFileSync(path.join(__dirname, files[i]), d))
+    data = null
+    await server?.close()
+    server = null
+  })
+
+  it('adds timestamps to manifest files', async function () {
+    server = await createServer({
+      root: __dirname,
+      logLevel: 'silent',
+      plugins: [vitePluginOxManifests({
+
+      }), vitePluginOxExternals({
+        prefix: '$'
+      })]
+    })
+    await server.listen(PORT)
+
+    // fetch this file to start watcher
+    await axios({ baseURL: `http://127.0.0.1:${PORT}/register.js` })
+
+    const { data: manifests } = await axios({ baseURL: `http://127.0.0.1:${PORT}/manifests` })
+    expect(Object.keys(manifests)).toHaveLength(2)
+    expect(manifests[1]).not.toContain('raw')
+
+    writeFileSync(path.join(__dirname, 'register.js'), 'console.log("Changed")')
+
+    await waitForReload(server)
+
+    const { data: manifestsWithHMR } = await axios({ baseURL: `http://127.0.0.1:${PORT}/manifests` })
+    expect(Object.keys(manifestsWithHMR)).toHaveLength(2)
+    expect(manifestsWithHMR[1].namespace).toEqual('test')
+    expect(manifestsWithHMR[1].raw).toMatch(/\/register\.js\?t=\d+/)
+  })
+
+  it('adds timestamps to settings manifest files', async function () {
+    server = await createServer({
+      root: __dirname,
+      logLevel: 'silent',
+      plugins: [vitePluginOxManifests({
+
+      }), vitePluginOxExternals({
+        prefix: '$'
+      })]
+    })
+    await server.listen(PORT)
+
+    // fetch this file to start watcher
+    await axios({ baseURL: `http://127.0.0.1:${PORT}/settings.js` })
+
+    const { data: manifests } = await axios({ baseURL: `http://127.0.0.1:${PORT}/manifests` })
+    expect(Object.keys(manifests)).toHaveLength(2)
+    expect(manifests[0]).not.toContain('raw')
+
+    writeFileSync(path.join(__dirname, 'settings.js'), `/* a comment */${data[1].toString()}`)
+
+    await waitForReload(server)
+
+    const { data: manifestsWithHMR } = await axios({ baseURL: `http://127.0.0.1:${PORT}/manifests` })
+    expect(Object.keys(manifestsWithHMR)).toHaveLength(2)
+    expect(manifestsWithHMR[0].namespace).toEqual('settings')
+    expect(manifestsWithHMR[0].raw).toMatch(/\/settings\.js\?t=\d+/)
+  })
+
+  it('includes base-path in manifests', async function () {
+    server = await createServer({
+      root: __dirname,
+      logLevel: 'silent',
+      base: '/appsuite',
+      plugins: [vitePluginOxManifests({
+
+      }), vitePluginOxExternals({
+        prefix: '$'
+      })]
+    })
+    await server.listen(PORT)
+
+    // fetch this file to start watcher
+    await axios({ baseURL: `http://127.0.0.1:${PORT}/appsuite/register.js` })
+    await axios({ baseURL: `http://127.0.0.1:${PORT}/appsuite/settings.js` })
+
+    const { data: manifests } = await axios({ baseURL: `http://127.0.0.1:${PORT}/appsuite/manifests` })
+    expect(Object.keys(manifests)).toHaveLength(2)
+    expect(manifests[0]).not.toContain('raw')
+    expect(manifests[1]).not.toContain('raw')
+
+    writeFileSync(path.join(__dirname, 'register.js'), 'console.log("Changed")')
+    await waitForReload(server)
+
+    writeFileSync(path.join(__dirname, 'settings.js'), `/* a comment */${data[1].toString()}`)
+    await waitForReload(server)
+
+    const { data: manifestsWithHMR } = await axios({ baseURL: `http://127.0.0.1:${PORT}/appsuite/manifests` })
+    expect(Object.keys(manifestsWithHMR)).toHaveLength(2)
+    expect(manifestsWithHMR[0].namespace).toEqual('settings')
+    expect(manifestsWithHMR[0].raw).toMatch(/\/appsuite\/settings\.js\?t=\d+/)
+    expect(manifestsWithHMR[1].namespace).toEqual('test')
+    expect(manifestsWithHMR[1].raw).toMatch(/\/appsuite\/register\.js\?t=\d+/)
+  })
+})

package/test/hmr/manifest.json

@@ -0,0 +1,3 @@
+{
+  "namespace": "test"
+}

package/test/hmr/register.js

@@ -0,0 +1 @@
+console.log('Hello world!')

package/test/hmr/settings.js

@@ -0,0 +1,3 @@
+import { Settings } from '$/io.ox/core/settings'
+
+export const settings = new Settings('test', () => {})

package/test/settings-with-requirements/index.js

@@ -1,3 +1,4 @@
 import { settings } from './settings'
+import { settings as other } from './other-settings'
 
-console.log('Hello world', settings)
+console.log('Hello world', settings, other)

package/test/settings-with-requirements/main.test.js

@@ -22,8 +22,30 @@ describe('Settings like in core, with requirements', function () {
     })
     const manifestFile = getFileFromBundle('manifest', bundle)
     const manifests = JSON.parse(manifestFile.source)
-    expect(Object.keys(manifests)).toHaveLength(2)
+    expect(Object.keys(manifests)).toHaveLength(4)
     expect(manifests['settings.js'].meta.manifests[0].namespace).toEqual('settings')
     expect(manifests['settings.js'].meta.manifests[0].requires).toEqual('cap')
   })
+
+  it('merges requirements for manifests', async () => {
+    const bundle = await build({
+      root: path.dirname(new URL(import.meta.url).pathname),
+      logLevel: 'silent',
+      build: {
+        write: false,
+        rollupOptions: {
+          input: {},
+          external: ['@/io.ox/core/settings']
+        }
+      },
+      plugins: [vitePluginOxManifests({
+
+      })]
+    })
+
+    const manifestFile = getFileFromBundle('manifest', bundle)
+    const manifests = JSON.parse(manifestFile.source)
+    expect(Object.keys(manifests)).toHaveLength(4)
+    expect(manifests['other-settings.js'].meta.manifests[0].requires).toBeUndefined()
+  })
 })

package/test/settings-with-requirements/manifest.json

@@ -1,5 +1,8 @@
-{
+[{
   "namespace": "test",
   "path": "index",
   "requires": "cap"
-}
+}, {
+  "namespace": "test",
+  "path": "other"
+}]

package/test/settings-with-requirements/other-settings.js

@@ -0,0 +1,3 @@
+import { Settings } from '@/io.ox/core/settings'
+
+export const settings = new Settings('other', () => {})

package/test/settings-with-requirements/other.js

@@ -0,0 +1,3 @@
+import { settings as other } from './other-settings'
+
+console.log('Hello world', other)