@open-xchange/vite-plugin-ox-manifests 0.2.0-pre8 → 0.2.2

package/.gitlab-ci.yml

@@ -4,6 +4,9 @@ stages:
   - test
 
 unit tests:
+  variables:
+    KUBERNETES_CPU_REQUEST: 2
+    KUBERNETES_CPU_LIMIT: 3
   stage: test
   script:
     - apk add git

package/index.js

@@ -6,6 +6,7 @@ import servePlugin from './src/plugins/serve.js'
 import serverManifestPlugin from './src/plugins/server-manifests.js'
 import gettextPlugin from './src/plugins/gettext.js'
 import { deepMergeObject } from './src/util.js'
+import additionalManifestsPlugin from './src/plugins/additional-manifests.js'
 
 /**
  * Creates a vite-plugin to include manifests in dev and production mode
@@ -13,7 +14,7 @@ import { deepMergeObject } from './src/util.js'
  * @param {object} [options]
  * @param {boolean} [options.watch=false] - If set to true, this plugin will watch manifest changes and reload the ui
  * @param {string} [options.appsuiteUrl] - When used in dev-mode, the dev-server can merge the local manifests with the manifest-files from the appsuiteUrl server.
- * @param {string} [options.manifestApiPathPath='/api/manifest.json'] - The path at appsuiteUrl for manifest files. I omitted, no manifests from a server will be used.
+ * @param {Array} [options.additionalManifestUrls] - You can add additional urls which can point to manifest files during development. This parameter will be ignored in production
  * @param {string} [options.entryPoints] - Convenience method to specify additional entry points for the production build. Can be specified as a glob-pattern.
  * @param {boolean} [options.manifestsAsEntryPoints=true] - Specifies, that every path in a manifest is used as an entry-point for the production build.
  * @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
@@ -23,8 +24,8 @@ import { deepMergeObject } from './src/util.js'
 export default function ({
   watch = false,
   appsuiteUrl,
+  additionalManifestUrls,
   entryPoints,
-  manifestApiPath = '/api/manifest.json',
   manifestsAsEntryPoints = true,
   transformAbsolutePaths = true,
   autoloadSettings = true,
@@ -33,8 +34,8 @@ export default function ({
   const options = {
     watch,
     appsuiteUrl,
+    additionalManifestUrls,
     entryPoints,
-    manifestApiPath,
     manifestsAsEntryPoints,
     transformAbsolutePaths,
     autoloadSettings,
@@ -47,6 +48,7 @@ export default function ({
     relativePathsPlugin(options),
     servePlugin(options),
     serverManifestPlugin(options),
+    additionalManifestsPlugin(options),
     gettextPlugin(options),
     // manifest plugin last
     manifestsPlugin(options)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/vite-plugin-ox-manifests",
-  "version": "0.2.0-pre8",
+  "version": "0.2.2",
   "description": "A vite plugin to concat and serve ox manifests",
   "main": "index.js",
   "type": "module",
@@ -35,7 +35,7 @@
     "less": "^4.1.1",
     "rollup": "^2.40.0",
     "rollup-plugin-auto-external": "^2.0.0",
-    "vite": "^2.4.2"
+    "vite": "^2.5.2"
   },
   "lint-staged": {
     "*.js": "eslint --cache --fix"

package/src/plugins/additional-manifests.js

@@ -0,0 +1,18 @@
+import axios from 'axios'
+
+export default function ({ additionalManifestUrls = [] } = {}) {
+  return {
+    async getManifests () {
+      const manifestSets = await Promise.all(additionalManifestUrls.map(async url => {
+        try {
+          const res = await axios.get(url)
+          return res.data
+        } catch (e) {
+          console.error(`Could not fetch manifest ${url}`, e)
+          return []
+        }
+      }))
+      return manifestSets.flat(1)
+    }
+  }
+}

package/src/plugins/manifests.js

@@ -23,19 +23,6 @@ async function getManifestEntryFile (basePath, extensions) {
   throw new Error(`Cannot find file "${basePath}"`)
 }
 
-const getViteManifestFor = (() => {
-  let cache
-  return (id, viteManifests, supportedEntryExtensions) => {
-    if (!cache) {
-      cache = {}
-      Object.values(viteManifests).forEach(manifest => {
-        cache[manifest.file] = manifest
-      })
-    }
-    return supportedEntryExtensions.reduce((memo, ext) => memo || cache[`${id}.${ext}`], null)
-  }
-})()
-
 export default function ({ supportedEntryExtensions, entryPoints, manifestsAsEntryPoints } = {}) {
   const manifestModules = {}
   let resolvedConfig
@@ -131,44 +118,17 @@ export default function ({ supportedEntryExtensions, entryPoints, manifestsAsEnt
 
     async generateBundle (options, bundle) {
       const viteManifests = await viteManifestPlugin.getManifests(options, bundle)
-      const oxManifests = []
 
-      for (const file in bundle) {
-        const chunk = bundle[file]
+      for (const entry in viteManifests) {
+        const chunk = bundle[viteManifests[entry].file]
         if (!chunk.facadeModuleId) continue
-        if (chunk.isDynamicEntry) {
-          const path = basepath(chunk.fileName).replace(/\\/g, '/')
-          const manifest = {
-            namespace: 'dynamicEntry',
-            path
-          }
-          const manifestInfo = getViteManifestFor(manifest.path, viteManifests, supportedEntryExtensions)
-          const dependencies = [].concat(manifestInfo.imports || []).concat(manifestInfo.css || []).map(i => {
-            if (viteManifests[i] && viteManifests[i].file) return viteManifests[i].file
-            return i
-          }).filter(Boolean)
-          if (dependencies.length) manifest.dependencies = dependencies
-          oxManifests.push(manifest)
-        }
-        const meta = this.getModuleInfo(chunk.facadeModuleId).meta
-        if (!meta?.manifests) continue
-
-        meta.manifests.forEach((data) => {
-          const manifest = { ...data, path: basepath(chunk.fileName).replace(/\\/g, '/') }
-          const manifestInfo = getViteManifestFor(manifest.path, viteManifests, supportedEntryExtensions)
-          const dependencies = [].concat(manifestInfo.imports || []).concat(manifestInfo.css || []).map(i => {
-            if (viteManifests[i] && viteManifests[i].file) return viteManifests[i].file
-            return i
-          }).filter(Boolean)
-          if (dependencies.length) manifest.dependencies = dependencies
-          oxManifests.push(manifest)
-        })
+        viteManifests[entry].meta = this.getModuleInfo(chunk.facadeModuleId).meta
       }
 
       this.emitFile({
         fileName: 'manifest.json',
         type: 'asset',
-        source: JSON.stringify(oxManifests)
+        source: JSON.stringify(viteManifests)
       })
     }
   }

package/src/plugins/relative-paths.js

@@ -5,13 +5,18 @@ export default function ({ transformAbsolutePaths } = {}) {
   return {
     transform (code, id) {
       if (id === 'vite/preload-helper') {
-        const mapCode = 'return Promise.all(deps.map((dep) => {'
-        if (code.indexOf(mapCode) < 0) {
+        // 2.5.2 transformation
+        if (code.search(/const base = '[^']*'/) >= 0) {
+          const s = new MagicString(code.replace(/const base = '[^']*'/, 'const base = \'./\''))
+          return { code: s.toString(), map: s.generateMap({ hires: true }) }
+        } else if (code.indexOf('return Promise.all(deps.map((dep) => {')) {
+          // pre 2.5 transformation
+          const code = 'return Promise.all(deps.map((dep) => {'
+          const s = new MagicString(code.replace(code, `${code}\ndep = dep.startsWith('/') ? \`.\${dep}\` : \`./\${dep}\``))
+          return { code: s.toString(), map: s.generateMap({ hires: true }) }
+        } else {
           throw new Error(`Cannot transform preload helper. Consider upgrading "${name}".`)
         }
-
-        const s = new MagicString(code.replace(mapCode, `${mapCode}\ndep = dep.startsWith('/') ? \`.\${dep}\` : \`./\${dep}\``))
-        return { code: s.toString(), map: s.generateMap({ hires: true }) }
       }
     },
 

package/src/plugins/serve.js

@@ -2,7 +2,14 @@ import path from 'path'
 import parseurl from 'parseurl'
 import chokidar from 'chokidar'
 
-export default function ({ watch, manifestApiPath } = {}) {
+const sendJSON = (res, data) => {
+  res.statusCode = 200
+  res.setHeader('Content-Type', 'application/json')
+  res.write(JSON.stringify(data))
+  return res.end()
+}
+
+export default function ({ watch } = {}) {
   let resolvedConfig
 
   return {
@@ -25,14 +32,18 @@ export default function ({ watch, manifestApiPath } = {}) {
 
       middlewares.use(async (req, res, next) => {
         const { path } = parseurl(req)
-        if (path === manifestApiPath && req.method === 'GET') {
-          res.statusCode = 200
-          res.setHeader('Content-Type', 'application/json')
+        if (req.method !== 'GET') return next()
+
+        if (path === '/api/manifest.json') {
           const manifests = await this.getManifests()
           await addTimestamp(manifests)
-          res.write(JSON.stringify(manifests))
-          return res.end()
+          return sendJSON(res, manifests)
         }
+
+        if (path === '/api/deps.json') {
+          return sendJSON(res, {})
+        }
+
         next()
       })
 

package/test/deps/main.test.js

@@ -0,0 +1,32 @@
+import { describe, it, expect, afterEach } from '@jest/globals'
+import { createServer } from 'vite'
+import path from 'path'
+import vitePluginOxManifests from '../../index'
+import { getPort } from '../util'
+import axios from 'axios'
+
+const PORT = getPort()
+const __dirname = path.dirname(new URL(import.meta.url).pathname)
+
+describe('deps', function () {
+  let server
+
+  afterEach(async function () {
+    if (server) {
+      await server.close()
+      server = null
+    }
+  })
+
+  it('deliver empty deps in dev mode', async function () {
+    server = await createServer({
+      root: __dirname,
+      logLevel: 'silent',
+      plugins: [vitePluginOxManifests({})]
+    })
+    await server.listen(PORT)
+
+    const { data: deps } = await axios({ baseURL: `http://localhost:${PORT}/api/deps.json` })
+    expect(deps).toEqual({})
+  })
+})

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

@@ -40,13 +40,10 @@ describe('Multiple dictionaries gettext scenario', function () {
 
     const manifestFile = getFileFromBundle('manifest', bundle)
     const manifests = JSON.parse(manifestFile.source)
-    expect(manifests).toHaveLength(3)
-    expect(manifests[0].namespace).toEqual('test')
-    expect(manifests[0].path).toContain('register')
-    expect(manifests[1].namespace).toEqual('i18n')
-    expect(manifests[1].path).toContain('foobar')
-    expect(manifests[2].namespace).toEqual('i18n')
-    expect(manifests[2].path).toContain('i18n')
+    expect(Object.keys(manifests)).toHaveLength(8)
+    expect(manifests['register.js'].meta.manifests[0].namespace).toEqual('test')
+    expect(manifests['../../foobar'].meta.manifests[0].namespace).toEqual('i18n')
+    expect(manifests['../../i18n'].meta.manifests[0].namespace).toEqual('i18n')
   })
 
   it('works in dev mode', async function () {

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

@@ -33,11 +33,9 @@ describe('Simple gettext scenario', function () {
 
     const manifestFile = getFileFromBundle('manifest', bundle)
     const manifests = JSON.parse(manifestFile.source)
-    expect(manifests).toHaveLength(2)
-    expect(manifests[0].namespace).toEqual('test')
-    expect(manifests[0].path).toContain('register')
-    expect(manifests[1].namespace).toEqual('i18n')
-    expect(manifests[1].path).toContain('i18n')
+    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')
   })
 
   it('works in dev mode', async function () {

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

@@ -19,9 +19,8 @@ describe('Manifest with dependencies', function () {
 
     const manifestFile = getFileFromBundle('manifest', bundle)
     const manifests = JSON.parse(manifestFile.source)
-    expect(manifests).toHaveLength(1)
-    expect(manifests[0].namespace).toEqual('test')
-    expect(manifests[0].path).toContain('register')
-    expect(manifests[0].dependencies).toHaveLength(1)
+    expect(Object.keys(manifests)).toHaveLength(1)
+    expect(manifests['register.js'].meta.manifests[0].namespace).toEqual('test')
+    expect(manifests['register.js'].css).toHaveLength(1)
   })
 })

package/test/manifest-dynamic-deps/main.test.js

@@ -22,8 +22,7 @@ describe('Manifest with dynamic dependencies', function () {
     const manifestFile = getFileFromBundle('manifest', bundle)
     const manifests = JSON.parse(manifestFile.source)
 
-    const [registerModule] = manifests.filter(m => m.namespace === 'test')
-    expect(registerModule.dependencies).toHaveLength(1)
-    expect(manifests.filter(m => m.namespace === 'dynamicEntry')).toHaveLength(1)
+    expect(manifests['register.js'].css).toHaveLength(1)
+    expect(manifests['register.js'].dynamicImports).toHaveLength(1)
   })
 })

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

@@ -38,23 +38,14 @@ describe('Multiple manifest scenario', function () {
 
     const manifestFile = getFileFromBundle('manifest', bundle)
     const manifests = JSON.parse(manifestFile.source)
-    expect(manifests).toHaveLength(4)
-
-    const entry1Index = manifests.findIndex(m => m.path.indexOf('entry1') >= 0)
-    expect(manifests[entry1Index].namespace).toEqual('test')
-    expect(manifests[entry1Index].path).toContain('entry1')
+    expect(Object.keys(manifests)).toHaveLength(2)
 
-    const otherNSIndex = manifests.findIndex(m => m.namespace === 'other')
-    expect(manifests[otherNSIndex].namespace).toEqual('other')
-    expect(manifests[otherNSIndex].path).toContain('entry2')
+    expect(manifests['entry1.js'].meta.manifests[0].namespace).toEqual('test')
 
-    const lastIndex = manifests.findIndex(({ path, namespace }) => path.indexOf('entry2') >= 0 && namespace === 'test')
-    expect(manifests[lastIndex].namespace).toEqual('test')
-    expect(manifests[lastIndex].path).toContain('entry2')
-
-    const settingsIndex = manifests.findIndex(m => m.namespace === 'settings')
-    expect(manifests[settingsIndex].namespace).toEqual('settings')
-    expect(manifests[settingsIndex].path).toContain('entry2')
+    expect(manifests['sub/entry2.js'].meta.manifests).toHaveLength(3)
+    expect(manifests['sub/entry2.js'].meta.manifests.find(m => m.namespace === 'other').namespace).toEqual('other')
+    expect(manifests['sub/entry2.js'].meta.manifests.find(m => m.namespace === 'test').namespace).toEqual('test')
+    expect(manifests['sub/entry2.js'].meta.manifests.find(m => m.namespace === 'settings').namespace).toEqual('settings')
   })
 
   it('works in dev mode', async function () {

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

@@ -30,9 +30,8 @@ describe('Simple manifest scenario', function () {
 
     const manifestFile = getFileFromBundle('manifest', bundle)
     const manifests = JSON.parse(manifestFile.source)
-    expect(manifests).toHaveLength(1)
-    expect(manifests[0].namespace).toEqual('test')
-    expect(manifests[0].path).toContain('register')
+    expect(Object.keys(manifests)).toHaveLength(1)
+    expect(manifests['register.js'].meta.manifests[0].namespace).toEqual('test')
   })
 
   it('works in dev mode', async function () {
@@ -48,7 +47,7 @@ describe('Simple manifest scenario', function () {
     const res = await axios({ baseURL: `http://localhost:${PORT}/api/manifest.json` })
     const manifests = res.data
 
-    expect(manifests).toHaveLength(1)
+    expect(Object.keys(manifests)).toHaveLength(1)
     expect(manifests[0].namespace).toEqual('test')
     expect(manifests[0].path).toContain('register')
   })

package/test/preload-helper-bundled/main.test.js

@@ -22,12 +22,11 @@ describe('Preload helper bundled', function () {
     })
 
     const index = getFileFromBundle('index', bundle)
-    // eslint-disable-next-line no-template-curly-in-string
-    expect(index.code).toContain('dep = dep.startsWith("/") ? `.${dep}` : `./${dep}`')
+    expect(index.code).toContain('const __vitePreload = function preload')
 
     const manifestFile = getFileFromBundle('manifest', bundle)
     const manifests = JSON.parse(manifestFile.source)
-    expect(manifests).toHaveLength(2)
-    expect(manifests[0].dependencies).toBeUndefined()
+    expect(Object.keys(manifests)).toHaveLength(2)
+    expect(manifests['index.js'].dependencies).toBeUndefined()
   })
 })

package/test/preload-helper-separate/main.test.js

@@ -23,14 +23,12 @@ describe('Preload helper separate', function () {
       })]
     })
     const preloadHelper = getFileFromBundle('preload', bundle)
-    // eslint-disable-next-line no-template-curly-in-string
-    expect(preloadHelper.code).toContain('dep = dep.startsWith("/") ? `.${dep}` : `./${dep}`')
+    expect(preloadHelper.code).toContain('const __vitePreload = function preload')
 
     const manifestFile = getFileFromBundle('manifest', bundle)
     const manifests = JSON.parse(manifestFile.source)
-    expect(manifests).toHaveLength(3)
-    const [mainManifest] = manifests.filter(m => m.namespace === 'test')
-    expect(mainManifest.dependencies).toHaveLength(1)
-    expect(mainManifest.dependencies[0]).toContain('preload-helper')
+    expect(Object.keys(manifests)).toHaveLength(4)
+    expect(manifests['index.js'].imports).toHaveLength(1)
+    expect(manifests['index.js'].imports[0]).toContain('preload-helper')
   })
 })

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

@@ -34,8 +34,8 @@ describe('Settings like in core', function () {
     })
     const manifestFile = getFileFromBundle('manifest', bundle)
     const manifests = JSON.parse(manifestFile.source)
-    expect(manifests).toHaveLength(2)
-    expect(manifests[1].namespace).toEqual('settings')
+    expect(Object.keys(manifests)).toHaveLength(2)
+    expect(manifests['settings.js'].meta.manifests[0].namespace).toEqual('settings')
   })
 
   it('works in dev mode', async function () {

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

@@ -37,8 +37,8 @@ describe('Settings external', function () {
 
     const manifestFile = getFileFromBundle('manifest', bundle)
     const manifests = JSON.parse(manifestFile.source)
-    expect(manifests).toHaveLength(2)
-    expect(manifests[1].namespace).toEqual('settings')
+    expect(Object.keys(manifests)).toHaveLength(2)
+    expect(manifests['settings.js'].meta.manifests[0].namespace).toEqual('settings')
   })
 
   it('works in dev mode', async function () {

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

@@ -24,7 +24,7 @@ describe('Settings typescript', function () {
     })
     const manifestFile = getFileFromBundle('manifest', bundle)
     const manifests = JSON.parse(manifestFile.source)
-    expect(manifests).toHaveLength(2)
-    expect(manifests[1].namespace).toEqual('settings')
+    expect(Object.keys(manifests)).toHaveLength(2)
+    expect(manifests['settings.ts'].meta.manifests[0].namespace).toEqual('settings')
   })
 })

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

@@ -22,8 +22,8 @@ describe('Settings like in core, with requirements', function () {
     })
     const manifestFile = getFileFromBundle('manifest', bundle)
     const manifests = JSON.parse(manifestFile.source)
-    expect(manifests).toHaveLength(2)
-    expect(manifests[1].namespace).toEqual('settings')
-    expect(manifests[1].requires).toEqual('cap')
+    expect(Object.keys(manifests)).toHaveLength(2)
+    expect(manifests['settings.js'].meta.manifests[0].namespace).toEqual('settings')
+    expect(manifests['settings.js'].meta.manifests[0].requires).toEqual('cap')
   })
 })

package/test/upstream-manifests/main.test.js

@@ -0,0 +1,64 @@
+import { describe, it, expect, 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 express from 'express'
+
+const __dirname = path.dirname(new URL(import.meta.url).pathname)
+const PORT = getPort()
+const MANIFEST_PORT = getPort()
+const OTHER_PORT = getPort()
+
+describe('Additional upstream manifests', function () {
+  let server, manifestServer, otherServer
+
+  afterEach(async function () {
+    if (server) {
+      await server.close()
+      server = null
+    }
+    if (manifestServer) {
+      await manifestServer.close()
+      manifestServer = null
+    }
+    if (otherServer) {
+      await otherServer.close()
+      otherServer = null
+    }
+  })
+
+  it('works in dev mode', async function () {
+    server = await createServer({
+      root: __dirname,
+      logLevel: 'silent',
+      plugins: [vitePluginOxManifests({
+        appsuiteUrl: `http://localhost:${MANIFEST_PORT}`,
+        additionalManifestUrls: [`http://localhost:${OTHER_PORT}/path/to/file.json`]
+      })]
+    })
+    await server.listen(PORT)
+
+    // create a manifest server
+    const app = express()
+    manifestServer = app.listen(MANIFEST_PORT)
+    app.get('/api/manifest.json', (req, res) => {
+      res.json([{ namespace: 'server' }])
+    })
+
+    // create other server with random endpoint
+    const app2 = express()
+    otherServer = app2.listen(OTHER_PORT)
+    app2.get('/path/to/file.json', (req, res) => {
+      res.json([{ namespace: 'other' }])
+    })
+
+    const res = await axios({ baseURL: `http://localhost:${PORT}/api/manifest.json` })
+    const manifests = res.data
+    expect(Object.keys(manifests)).toHaveLength(3)
+    expect(manifests.map(m => m.namespace)).toContain('test')
+    expect(manifests.map(m => m.namespace)).toContain('server')
+    expect(manifests.map(m => m.namespace)).toContain('other')
+  })
+})

package/test/upstream-manifests/manifest.json

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

package/test/upstream-manifests/register.js

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