@open-xchange/vite-plugin-ox-manifests 0.4.0 → 0.4.2-pre1

package/.gitlab-ci.yml

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

package/README.md

@@ -30,6 +30,7 @@ You can provide the following options to the plugin:
 * transformAbsolutePaths `<boolean>` If set to true, every absolute path will be transformed into a relative path. This is especially useful, if the production path is not clear at build time. E.g. if you do not know, whether appsuite will be served under `/appsuite`. Default: `true`
 * autoloadSettings `<boolean>` If set to true, this plugin tries to auto-detect files that export settings. Prerequisites are, that the file imports `Settings` from the `io.ox/core/settings` module and have a named export called `settings`. Default true
 * supportedEntryExtensions `<string[]>` This array defines the extensions, that are to expect as entry points. For example, if a manifest.json have `"path": "index"`, it will look for `index.js`, `index.mjs` or `index.ts` next to the manifest.json. Default: `['js', 'mjs', 'ts']`
+* meta `<object>` An object that will be translated into a meta.json file in the root directory.
 
 ## Examples
 

package/index.js

@@ -4,6 +4,7 @@ import relativePathsPlugin from './src/plugins/relative-paths.js'
 import settingsPlugin from './src/plugins/settings.js'
 import servePlugin from './src/plugins/serve.js'
 import gettextPlugin from './src/plugins/gettext.js'
+import metaPlugin from './src/plugins/meta.js'
 import { deepMergeObject } from './src/util.js'
 
 /**
@@ -16,6 +17,7 @@ import { deepMergeObject } from './src/util.js'
  * @param {boolean} [options.transformAbsolutePaths=true] - If this is set to true, every path in the html-files is transformed to a relative path. Additionally, every preloaded file will also be loaded relative to the index.html
  * @param {boolean} [options.autoloadSettings=true] - If disabled, settings will not be automatically detected and therefore have to provide a manual manifest.json.
  * @param supportedEntryExtensions {string[]=['js', 'mjs', 'ts']} - An array of valid file-extensions for entry points.
+ * @param {object} [options.meta] - An object that will be translated into a meta.json file in the root directory.
  */
 export default function ({
   watch = false,
@@ -23,7 +25,8 @@ export default function ({
   manifestsAsEntryPoints = true,
   transformAbsolutePaths = true,
   autoloadSettings = true,
-  supportedEntryExtensions = ['js', 'mjs', 'ts']
+  supportedEntryExtensions = ['js', 'mjs', 'ts'],
+  meta
 } = {}) {
   const options = {
     watch,
@@ -31,7 +34,8 @@ export default function ({
     manifestsAsEntryPoints,
     transformAbsolutePaths,
     autoloadSettings,
-    supportedEntryExtensions
+    supportedEntryExtensions,
+    meta
   }
 
   const plugins = [
@@ -40,6 +44,7 @@ export default function ({
     relativePathsPlugin(options),
     servePlugin(options),
     gettextPlugin(options),
+    metaPlugin(options),
     // manifest plugin last
     manifestsPlugin(options)
   ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/vite-plugin-ox-manifests",
-  "version": "0.4.0",
+  "version": "0.4.2-pre1",
   "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/meta.js

@@ -0,0 +1,13 @@
+export default function ({ meta } = {}) {
+  return {
+    generateBundle () {
+      if (!meta || Object.keys(meta).length === 0) return
+
+      this.emitFile({
+        fileName: 'meta.json',
+        type: 'asset',
+        source: JSON.stringify(meta)
+      })
+    }
+  }
+}

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

@@ -0,0 +1,25 @@
+import { describe, it, expect } from '@jest/globals'
+import { build } from 'vite'
+import path from 'path'
+import vitePluginOxManifests from '../../index'
+import { getFileFromBundle } from '../util'
+
+const __dirname = path.dirname(new URL(import.meta.url).pathname)
+
+describe('Meta option', function () {
+  it('works', async function () {
+    const bundle = await build({
+      root: __dirname,
+      logLevel: 'silent',
+      build: { write: false, rollupOptions: { input: {} } },
+      plugins: [vitePluginOxManifests({
+        meta: {
+          version: '1.2.3'
+        }
+      })]
+    })
+
+    const metaFile = getFileFromBundle('meta.json', bundle)
+    expect(JSON.parse(metaFile.source)).toEqual({ version: '1.2.3' })
+  })
+})

package/test/meta/manifest.json

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

package/test/meta/register.js

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

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)