@open-xchange/vite-plugin-ox-manifests 0.2.2 → 0.4.0

package/README.md

@@ -25,8 +25,6 @@ return {
 You can provide the following options to the plugin:
 
 * watch `<boolean>` If set to true, it will watch any changes to manifest.json files and will automatically reload the vite-dev-server. Default: `true`
-* appsuiteUrl `<string>` If this string is provided, the dev-server will try to fetch manifests from that location and will merge them together with local manifests. Duplicate entries will be removed. Useful for plugin development which require core manifests. Default: `undefined`
-* manifestApiPath `<string>` The path where this plugin looks for manifests is `appsuiteUrl + manifestApiPath`. If developing against a common Kubernetes based App Suite deployment, this most like does not have to be changed.  Default: `'/api/manifest.json'`
 * entryPoints `<string> | <glob pattern>` Convenience method to specify additional entry points for the production build. The glob pattern will be resolved and injected into the `build.input` options of vite. Can be specified as a glob-pattern. Default: `undefined`
 * manifestsAsEntryPoints `<boolean>` If set to true, this will inject every entrypoint that is defined by a manifest.json file into the `build.input` options of vite. Default: `true`
 * 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`

package/index.js

@@ -3,18 +3,14 @@ import manifestsPlugin from './src/plugins/manifests.js'
 import relativePathsPlugin from './src/plugins/relative-paths.js'
 import settingsPlugin from './src/plugins/settings.js'
 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
  *
  * @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 {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 +19,6 @@ import additionalManifestsPlugin from './src/plugins/additional-manifests.js'
  */
 export default function ({
   watch = false,
-  appsuiteUrl,
-  additionalManifestUrls,
   entryPoints,
   manifestsAsEntryPoints = true,
   transformAbsolutePaths = true,
@@ -33,8 +27,6 @@ export default function ({
 } = {}) {
   const options = {
     watch,
-    appsuiteUrl,
-    additionalManifestUrls,
     entryPoints,
     manifestsAsEntryPoints,
     transformAbsolutePaths,
@@ -47,8 +39,6 @@ export default function ({
     settingsPlugin(options),
     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.2",
+  "version": "0.4.0",
   "description": "A vite plugin to concat and serve ox manifests",
   "main": "index.js",
   "type": "module",

package/src/plugins/gettext.js

@@ -43,6 +43,9 @@ export default function () {
     },
 
     getManifests () {
+      if (resolvedConfig.mode !== 'production') {
+        return manifests.map(({ namespace, path }) => ({ namespace, raw: `/@id/${path}.js`, path }))
+      }
       return manifests
     },
 

package/src/plugins/serve.js

@@ -26,7 +26,7 @@ export default function ({ watch } = {}) {
           if (!moduleNode) return
           const hmrTS = moduleNode.lastHMRTimestamp
           if (!hmrTS) return
-          manifest.timestamp = hmrTS
+          manifest.raw = `/${manifest.path}.js?t=${hmrTS}`
         })
       }
 
@@ -34,13 +34,13 @@ export default function ({ watch } = {}) {
         const { path } = parseurl(req)
         if (req.method !== 'GET') return next()
 
-        if (path === '/api/manifest.json') {
+        if (path === '/api/manifest.json' || path === '/manifests') {
           const manifests = await this.getManifests()
           await addTimestamp(manifests)
           return sendJSON(res, manifests)
         }
 
-        if (path === '/api/deps.json') {
+        if (path === '/api/deps.json' || path === '/dependencies') {
           return sendJSON(res, {})
         }
 

package/src/plugins/settings.js

@@ -64,7 +64,7 @@ export async function isSettingsFile (entry, resolvedConfig) {
 
 export default function ({ autoloadSettings } = {}) {
   const settingsModules = {}
-  let resolvedConfig
+  let resolvedConfig, moduleGraph
 
   return {
     configResolved (config) {
@@ -95,10 +95,22 @@ export default function ({ autoloadSettings } = {}) {
       return options
     },
 
+    configureServer ({ moduleGraph: mg }) {
+      moduleGraph = mg
+    },
+
     // specific call to collect all manifests
     getManifests () {
       return Object.entries(settingsModules).map(
-        ([path, m]) => ({ ...m, path: basepath(path.substr(resolvedConfig.root.length + 1)) })
+        ([path, m]) => {
+          const newPath = basepath(path.substr(resolvedConfig.root.length + 1))
+          const manifest = { ...m, path: newPath }
+          const moduleNode = moduleGraph?.idToModuleMap.get(path)
+          if (moduleNode?.lastHMRTimestamp) {
+            manifest.raw = `/${manifest.path}.js?t=${moduleNode.lastHMRTimestamp}`
+          }
+          return manifest
+        }
       )
     },
 

package/src/plugins/additional-manifests.js

@@ -1,18 +0,0 @@
-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/server-manifests.js

@@ -1,21 +0,0 @@
-import axios from 'axios'
-
-export default function ({ appsuiteUrl } = {}) {
-  let cache
-  return {
-    async getManifests () {
-      if (!appsuiteUrl) return []
-
-      if (cache) return cache
-
-      try {
-        const url = new URL('/api/manifest.json', appsuiteUrl)
-        const res = await axios.get(url.href)
-        return (cache = res.data)
-      } catch (e) {
-        console.error('Could not fetch server manifests', e)
-        return []
-      }
-    }
-  }
-}

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

@@ -1,104 +0,0 @@
-import { describe, it, expect, afterEach, jest } from '@jest/globals'
-import { createServer } from 'vite'
-import path from 'path'
-import vitePluginOxManifests from '../../index'
-import axios from 'axios'
-import express from 'express'
-import { getPort } from '../util'
-
-const PORT = getPort()
-const SERVER_PORT = getPort()
-
-describe('Server manifest scenario', function () {
-  let server, expressServer
-
-  afterEach(async function () {
-    if (server) {
-      await server.close()
-      server = null
-    }
-    if (expressServer) {
-      await expressServer.close()
-      expressServer = null
-    }
-  })
-
-  it('works in dev mode', async function () {
-    server = await createServer({
-      root: path.dirname(new URL(import.meta.url).pathname),
-      logLevel: 'silent',
-      plugins: [vitePluginOxManifests({
-        appsuiteUrl: `http://localhost:${SERVER_PORT}`
-      })]
-    })
-    await server.listen(PORT)
-
-    const app = express()
-    expressServer = app.listen(SERVER_PORT)
-    app.get('/api/manifest.json', (req, res) => {
-      res.json([{ namespace: 'server' }])
-    })
-
-    const res = await axios({ baseURL: `http://localhost:${PORT}/api/manifest.json` })
-    const manifests = res.data
-
-    expect(manifests).toHaveLength(2)
-    expect(manifests[1].namespace).toEqual('test')
-    expect(manifests[1].path).toContain('register')
-    expect(manifests[0].namespace).toEqual('server')
-  })
-
-  it('only fetches manifests once from server', async function () {
-    server = await createServer({
-      root: path.dirname(new URL(import.meta.url).pathname),
-      logLevel: 'silent',
-      plugins: [vitePluginOxManifests({
-        appsuiteUrl: `http://localhost:${SERVER_PORT}`
-      })]
-    })
-    await server.listen(PORT)
-
-    const app = express()
-    expressServer = app.listen(SERVER_PORT)
-    const respond = jest.fn((req, res) => {
-      res.json([{ namespace: 'server' }])
-    })
-    app.get('/api/manifest.json', respond)
-
-    expect(respond).not.toBeCalled()
-
-    await axios({ baseURL: `http://localhost:${PORT}/api/manifest.json` })
-
-    expect(respond).toBeCalledTimes(1)
-
-    await axios({ baseURL: `http://localhost:${PORT}/api/manifest.json` })
-
-    expect(respond).toBeCalledTimes(1)
-  })
-
-  it('overwrites existing manfests from server', async function () {
-    server = await createServer({
-      root: path.dirname(new URL(import.meta.url).pathname),
-      logLevel: 'silent',
-      plugins: [vitePluginOxManifests({
-        appsuiteUrl: `http://localhost:${SERVER_PORT}`
-      })]
-    })
-    await server.listen(PORT)
-
-    const app = express()
-    expressServer = app.listen(SERVER_PORT)
-    app.get('/api/manifest.json', (req, res) => {
-      // same as from client, but with additional property
-      res.json([{ namespace: 'test', path: 'register', other: 'test' }])
-    })
-
-    const res = await axios({ baseURL: `http://localhost:${PORT}/api/manifest.json` })
-    const manifests = res.data
-
-    expect(manifests).toHaveLength(1)
-    expect(manifests[0].namespace).toEqual('test')
-    expect(manifests[0].path).toEqual('register')
-    expect(manifests[0].other).toBeUndefined()
-  })
-})

package/test/server-manifests/manifest.json

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

package/test/server-manifests/register.js

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

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

@@ -1,64 +0,0 @@
-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

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

package/test/upstream-manifests/register.js

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