@open-xchange/vite-plugin-ox-manifests 0.4.1 → 0.4.3

package/.gitlab-ci.yml

@@ -1,4 +1,4 @@
-image: node:15-alpine
+image: node:17-alpine
 
 stages:
   - test

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/vite-plugin-ox-manifests",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "description": "A vite plugin to concat and serve ox manifests",
   "main": "index.js",
   "type": "module",
@@ -14,7 +14,7 @@
   },
   "dependencies": {
     "@open-xchange/rollup-plugin-po2json": "^0.4.1",
-    "axios": "^0.21.1",
+    "axios": "^0.26.0",
     "chokidar": "^3.5.1",
     "fast-glob": "^3.2.5",
     "magic-string": "^0.25.7",
@@ -23,19 +23,19 @@
   "devDependencies": {
     "@open-xchange/vite-plugin-ox-externals": "^0.2.0-pre2",
     "@rollup/plugin-json": "^4.1.0",
-    "eslint": "^7.21.0",
+    "eslint": "^8.9.0",
     "eslint-config-standard": "^16.0.2",
     "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-jest": "^24.3.6",
+    "eslint-plugin-jest": "^26.1.1",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^4.3.1",
+    "eslint-plugin-promise": "^6.0.0",
     "express": "^4.17.1",
     "husky": "^7.0.1",
     "jest": "^27.0.5",
     "less": "^4.1.1",
     "rollup": "^2.40.0",
     "rollup-plugin-auto-external": "^2.0.0",
-    "vite": "^2.5.2"
+    "vite": "^2.8.3"
   },
   "lint-staged": {
     "*.js": "eslint --cache --fix"

package/src/plugins/gettext.js

@@ -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

@@ -11,10 +11,14 @@ const sendJSON = (res, data) => {
 
 export default function ({ watch } = {}) {
   let resolvedConfig
+  let manifestRegex
+  let depsRegex
 
   return {
     configResolved (config) {
       resolvedConfig = config
+      manifestRegex = new RegExp(`^${config.base}(api/manifest.json|manifests)$`)
+      depsRegex = new RegExp(`^${config.base}(api/deps.json|dependencies)$`)
     },
 
     async configureServer ({ ws, middlewares, moduleGraph }) {
@@ -34,13 +38,13 @@ export default function ({ watch } = {}) {
         const { path } = parseurl(req)
         if (req.method !== 'GET') return next()
 
-        if (path === '/api/manifest.json' || path === '/manifests') {
+        if (manifestRegex.test(path)) {
           const manifests = await this.getManifests()
           await addTimestamp(manifests)
           return sendJSON(res, manifests)
         }
 
-        if (path === '/api/deps.json' || path === '/dependencies') {
+        if (depsRegex.test(path)) {
           return sendJSON(res, {})
         }
 

package/test/deps/main.test.js

@@ -26,7 +26,7 @@ describe('deps', function () {
     })
     await server.listen(PORT)
 
-    const { data: deps } = await axios({ baseURL: `http://localhost:${PORT}/api/deps.json` })
+    const { data: deps } = await axios({ baseURL: `http://127.0.0.1:${PORT}/api/deps.json` })
     expect(deps).toEqual({})
   })
 })

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/gettext-multiple/main.test.js

@@ -40,9 +40,9 @@ describe('Multiple dictionaries gettext scenario', function () {
 
     const manifestFile = getFileFromBundle('manifest', bundle)
     const manifests = JSON.parse(manifestFile.source)
-    expect(Object.keys(manifests)).toHaveLength(8)
+    expect(Object.keys(manifests)).toHaveLength(9)
     expect(manifests['register.js'].meta.manifests[0].namespace).toEqual('test')
-    expect(manifests['../../foobar'].meta.manifests[0].namespace).toEqual('i18n')
+    expect(manifests['../../foobar.js'].meta.manifests[0].namespace).toEqual('i18n')
     expect(manifests['../../i18n'].meta.manifests[0].namespace).toEqual('i18n')
   })
 
@@ -58,7 +58,7 @@ describe('Multiple dictionaries gettext scenario', function () {
     })
     await server.listen(PORT)
 
-    const res = await axios({ baseURL: `http://localhost:${PORT}/api/manifest.json` })
+    const res = await axios({ baseURL: `http://127.0.0.1:${PORT}/api/manifest.json` })
     const manifests = res.data
 
     expect(manifests).toHaveLength(3)

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

@@ -35,7 +35,7 @@ describe('Simple gettext scenario', function () {
     const manifests = JSON.parse(manifestFile.source)
     expect(Object.keys(manifests)).toHaveLength(4)
     expect(manifests['register.js'].meta.manifests[0].namespace).toEqual('test')
-    expect(manifests['../../i18n'].meta.manifests[0].namespace).toEqual('i18n')
+    expect(manifests['../../i18n.js'].meta.manifests[0].namespace).toEqual('i18n')
   })
 
   it('works in dev mode', async function () {
@@ -50,7 +50,7 @@ describe('Simple gettext scenario', function () {
     })
     await server.listen(PORT)
 
-    const res = await axios({ baseURL: `http://localhost:${PORT}/api/manifest.json` })
+    const res = await axios({ baseURL: `http://127.0.0.1:${PORT}/api/manifest.json` })
     const manifests = res.data
 
     expect(manifests).toHaveLength(2)

package/test/html-relative-paths/index.js

@@ -1 +1,3 @@
+import './style.css'
+
 console.log('Hello world')

package/test/html-relative-paths/style.css

@@ -0,0 +1 @@
+body { background: green; }

package/test/manifest-multiple/main.test.js

@@ -60,7 +60,7 @@ describe('Multiple manifest scenario', function () {
     })
     await server.listen(PORT)
 
-    const res = await axios({ baseURL: `http://localhost:${PORT}/api/manifest.json` })
+    const res = await axios({ baseURL: `http://127.0.0.1:${PORT}/api/manifest.json` })
     const manifests = res.data
 
     expect(manifests).toHaveLength(4)

package/test/manifest-simple/main.test.js

@@ -44,7 +44,45 @@ describe('Simple manifest scenario', function () {
     })
     await server.listen(PORT)
 
-    const res = await axios({ baseURL: `http://localhost:${PORT}/api/manifest.json` })
+    const res = await axios({ baseURL: `http://127.0.0.1:${PORT}/api/manifest.json` })
+    const manifests = res.data
+
+    expect(Object.keys(manifests)).toHaveLength(1)
+    expect(manifests[0].namespace).toEqual('test')
+    expect(manifests[0].path).toContain('register')
+  })
+
+  it('works in dev mode with base set', async function () {
+    server = await createServer({
+      root: __dirname,
+      base: '/appsuite/',
+      logLevel: 'silent',
+      plugins: [vitePluginOxManifests({
+
+      })]
+    })
+    await server.listen(PORT)
+
+    const res = await axios({ baseURL: `http://127.0.0.1:${PORT}/appsuite/api/manifest.json` })
+    const manifests = res.data
+
+    expect(Object.keys(manifests)).toHaveLength(1)
+    expect(manifests[0].namespace).toEqual('test')
+    expect(manifests[0].path).toContain('register')
+  })
+
+  it('works in dev mode with base set (new endpoint)', async function () {
+    server = await createServer({
+      root: __dirname,
+      base: '/appsuite/',
+      logLevel: 'silent',
+      plugins: [vitePluginOxManifests({
+
+      })]
+    })
+    await server.listen(PORT)
+
+    const res = await axios({ baseURL: `http://127.0.0.1:${PORT}/appsuite/manifests` })
     const manifests = res.data
 
     expect(Object.keys(manifests)).toHaveLength(1)
@@ -62,7 +100,7 @@ describe('Simple manifest scenario', function () {
     })
     await server.listen(PORT)
 
-    const res = await axios({ baseURL: `http://localhost:${PORT}/register.js` })
+    const res = await axios({ baseURL: `http://127.0.0.1:${PORT}/register.js` })
     expect(res.data).toEqual("console.log('Hello world')\n")
   })
 })

package/test/settings-core/main.test.js

@@ -48,7 +48,7 @@ describe('Settings like in core', function () {
     })
     await server.listen(PORT)
 
-    const res = await axios({ baseURL: `http://localhost:${PORT}/api/manifest.json` })
+    const res = await axios({ baseURL: `http://127.0.0.1:${PORT}/api/manifest.json` })
     const manifests = res.data
 
     expect(manifests).toHaveLength(2)

package/test/settings-external/main.test.js

@@ -53,7 +53,7 @@ describe('Settings external', function () {
     })
     await server.listen(PORT)
 
-    const res = await axios({ baseURL: `http://localhost:${PORT}/api/manifest.json` })
+    const res = await axios({ baseURL: `http://127.0.0.1:${PORT}/api/manifest.json` })
     const manifests = res.data
 
     expect(manifests).toHaveLength(2)