@signalk/app-dock 1.2.0 → 1.3.0

package/test/plugin.test.js

@@ -1,696 +0,0 @@
-'use strict'
-
-const { describe, it } = require('node:test')
-const assert = require('node:assert/strict')
-const path = require('path')
-const fs = require('fs')
-
-const pluginFactory = require('../plugin/index.js')
-
-function createMockApp(webapps = []) {
-  return {
-    webapps,
-    debug: () => {},
-    error: () => {},
-    savePluginOptions: (opts, cb) => cb(null),
-    readPluginOptions: () => ({}),
-    registerPutHandler: () => {},
-    handleMessage: () => {},
-    getSelfPath: () => null
-  }
-}
-
-const MOCK_WEBAPPS = [
-  {
-    name: '@signalk/freeboard-sk',
-    signalk: { displayName: 'Freeboard-SK', appIcon: './assets/icons/icon-72x72.png' }
-  },
-  {
-    name: '@mxtommy/kip',
-    signalk: { displayName: 'KIP Instrument MFD', appIcon: 'assets/icon-72x72.png' }
-  },
-  {
-    name: '@signalk/app-dock',
-    signalk: { displayName: 'App Dock' }
-  },
-  {
-    name: '@signalk/server-admin-ui',
-    signalk: { displayName: 'Admin UI' }
-  }
-]
-
-describe('plugin identity', () => {
-  it('returns correct id and name', () => {
-    const plugin = pluginFactory(createMockApp())
-    assert.equal(plugin.id, 'signalk-app-dock')
-    assert.equal(plugin.name, 'App Dock')
-  })
-
-  it('has required plugin interface methods', () => {
-    const plugin = pluginFactory(createMockApp())
-    assert.equal(typeof plugin.start, 'function')
-    assert.equal(typeof plugin.stop, 'function')
-    assert.equal(typeof plugin.registerWithRouter, 'function')
-  })
-})
-
-describe('schema', () => {
-  it('defines all expected properties', () => {
-    const plugin = pluginFactory(createMockApp())
-    const props = Object.keys(plugin.schema.properties)
-    assert.ok(props.includes('position'))
-    assert.ok(props.includes('iframeMode'))
-    assert.ok(props.includes('iconSize'))
-    assert.ok(props.includes('magnification'))
-    assert.ok(props.includes('magnificationScale'))
-    assert.ok(props.includes('apps'))
-    assert.ok(!props.includes('triggerCorner'), 'triggerCorner should be removed')
-    assert.ok(!props.includes('longPressActivation'), 'longPressActivation should be removed')
-  })
-
-  it('position enum contains all four edges', () => {
-    const plugin = pluginFactory(createMockApp())
-    const posEnum = plugin.schema.properties.position.enum
-    assert.deepEqual(posEnum, ['bottom', 'top', 'left', 'right'])
-  })
-
-  it('apps items require url', () => {
-    const plugin = pluginFactory(createMockApp())
-    const items = plugin.schema.properties.apps.items
-    assert.deepEqual(items.required, ['url'])
-  })
-
-  it('defines showNightModeButton with default true', () => {
-    const plugin = pluginFactory(createMockApp())
-    const prop = plugin.schema.properties.showNightModeButton
-    assert.equal(prop.type, 'boolean')
-    assert.equal(prop.default, true)
-  })
-
-  it('defines showExitButton with default false', () => {
-    const plugin = pluginFactory(createMockApp())
-    const prop = plugin.schema.properties.showExitButton
-    assert.equal(prop.type, 'boolean')
-    assert.equal(prop.default, false)
-  })
-
-  it('defines tourDismissed with default false', () => {
-    const plugin = pluginFactory(createMockApp())
-    const prop = plugin.schema.properties.tourDismissed
-    assert.equal(prop.type, 'boolean')
-    assert.equal(prop.default, false)
-  })
-})
-
-describe('webapp discovery', () => {
-  it('filters out @signalk/app-dock and admin-ui from /webapps', (t, done) => {
-    const app = createMockApp(MOCK_WEBAPPS)
-    const plugin = pluginFactory(app)
-    const routes = {}
-    const router = {
-      get: (path, handler) => {
-        routes[path] = handler
-      },
-      post: () => {}
-    }
-    plugin.registerWithRouter(router)
-
-    const res = {
-      json: (data) => {
-        assert.equal(data.length, 2)
-        assert.ok(data.every((w) => w.name !== '@signalk/app-dock'))
-        assert.ok(data.every((w) => w.name !== '@signalk/server-admin-ui'))
-        done()
-      }
-    }
-    routes['/webapps']({}, res)
-  })
-
-  it('maps webapp metadata correctly', (t, done) => {
-    const app = createMockApp(MOCK_WEBAPPS)
-    const plugin = pluginFactory(app)
-    const routes = {}
-    const router = {
-      get: (path, handler) => {
-        routes[path] = handler
-      },
-      post: () => {}
-    }
-    plugin.registerWithRouter(router)
-
-    const res = {
-      json: (data) => {
-        const fb = data.find((w) => w.name === '@signalk/freeboard-sk')
-        assert.equal(fb.label, 'Freeboard-SK')
-        assert.equal(fb.url, '/@signalk/freeboard-sk/')
-        assert.equal(fb.icon, '/@signalk/freeboard-sk/assets/icons/icon-72x72.png')
-        done()
-      }
-    }
-    routes['/webapps']({}, res)
-  })
-
-  it('handles missing signalk metadata gracefully', (t, done) => {
-    const app = createMockApp([{ name: 'bare-plugin' }])
-    const plugin = pluginFactory(app)
-    const routes = {}
-    const router = {
-      get: (path, handler) => {
-        routes[path] = handler
-      },
-      post: () => {}
-    }
-    plugin.registerWithRouter(router)
-
-    const res = {
-      json: (data) => {
-        assert.equal(data.length, 1)
-        assert.equal(data[0].label, 'bare-plugin')
-        assert.equal(data[0].icon, null)
-        done()
-      }
-    }
-    routes['/webapps']({}, res)
-  })
-
-  it('returns empty array when app.webapps is undefined', (t, done) => {
-    const app = createMockApp()
-    delete app.webapps
-    const plugin = pluginFactory(app)
-    const routes = {}
-    const router = {
-      get: (path, handler) => {
-        routes[path] = handler
-      },
-      post: () => {}
-    }
-    plugin.registerWithRouter(router)
-
-    const res = {
-      json: (data) => {
-        assert.deepEqual(data, [])
-        done()
-      }
-    }
-    routes['/webapps']({}, res)
-  })
-})
-
-describe('settings endpoint', () => {
-  it('returns plugin settings with resolved apps', (t, done) => {
-    const app = createMockApp()
-    const plugin = pluginFactory(app)
-    plugin.start({ position: 'left', iconSize: 64, apps: [] })
-
-    const routes = {}
-    const router = {
-      get: (path, handler) => {
-        routes[path] = handler
-      },
-      post: () => {}
-    }
-    plugin.registerWithRouter(router)
-
-    const res = {
-      json: (data) => {
-        assert.equal(data.position, 'left')
-        assert.equal(data.iconSize, 64)
-        assert.ok(Array.isArray(data.apps))
-        done()
-      }
-    }
-    routes['/settings']({}, res)
-  })
-
-  it('serves the saved configuration before the plugin has started', (t, done) => {
-    const app = createMockApp()
-    app.readPluginOptions = () => ({
-      enabled: false,
-      configuration: {
-        position: 'right',
-        apps: [
-          { url: '/a/', label: 'A', enabled: true },
-          { url: '/b/', label: 'B', enabled: false }
-        ]
-      }
-    })
-    const plugin = pluginFactory(app)
-
-    const routes = {}
-    plugin.registerWithRouter({
-      get: (path, handler) => {
-        routes[path] = handler
-      },
-      post: () => {}
-    })
-
-    const res = {
-      json: (data) => {
-        assert.equal(data.position, 'right')
-        assert.deepEqual(data.apps, [{ label: 'A', url: '/a/', icon: null, color: null, autostart: false }])
-        done()
-      }
-    }
-    routes['/settings']({}, res)
-  })
-
-  it('serves no apps when the saved apps value is not an array', (t, done) => {
-    const app = createMockApp()
-    app.readPluginOptions = () => ({ enabled: false, configuration: { apps: {} } })
-    const plugin = pluginFactory(app)
-
-    const routes = {}
-    plugin.registerWithRouter({
-      get: (path, handler) => {
-        routes[path] = handler
-      },
-      post: () => {}
-    })
-
-    const res = {
-      json: (data) => {
-        assert.deepEqual(data.apps, [])
-        done()
-      }
-    }
-    routes['/settings']({}, res)
-  })
-
-  it('serves the saved configuration after stop()', (t, done) => {
-    const app = createMockApp()
-    app.readPluginOptions = () => ({ enabled: false, configuration: { position: 'top', apps: [] } })
-    const plugin = pluginFactory(app)
-    plugin.start({ position: 'left', apps: [{ url: '/a/', label: 'A' }] })
-    plugin.stop()
-
-    const routes = {}
-    plugin.registerWithRouter({
-      get: (path, handler) => {
-        routes[path] = handler
-      },
-      post: () => {}
-    })
-
-    const res = {
-      json: (data) => {
-        assert.equal(data.position, 'top')
-        assert.deepEqual(data.apps, [])
-        done()
-      }
-    }
-    routes['/settings']({}, res)
-  })
-})
-
-describe('default apps seeding', () => {
-  it('seeds default apps when config has no apps key', () => {
-    const app = createMockApp()
-    let savedOptions = null
-    app.savePluginOptions = (opts, cb) => {
-      savedOptions = opts
-      cb(null)
-    }
-
-    const plugin = pluginFactory(app)
-    plugin.start({})
-
-    assert.ok(savedOptions)
-    assert.equal(savedOptions.apps[0].url, '/@signalk/freeboard-sk/')
-    assert.equal(savedOptions.apps[0].autostart, true)
-    assert.equal(savedOptions.apps[1].url, '/@halos-org/skip/')
-    assert.equal(savedOptions.apps[1].autostart, false)
-    assert.equal(savedOptions.apps[2].url, '/admin/')
-    assert.equal(savedOptions.apps[2].label, 'Settings')
-  })
-
-  it('does not seed when apps array already exists (even if empty)', () => {
-    const app = createMockApp()
-    let saveCalled = false
-    app.savePluginOptions = () => {
-      saveCalled = true
-    }
-
-    const plugin = pluginFactory(app)
-    plugin.start({ apps: [] })
-
-    assert.equal(saveCalled, false)
-  })
-
-  it('preserves existing configured apps', () => {
-    const app = createMockApp()
-    let saveCalled = false
-    app.savePluginOptions = () => {
-      saveCalled = true
-    }
-
-    const plugin = pluginFactory(app)
-    const existing = [{ enabled: true, url: '/custom-app/', label: 'Custom', icon: '', color: '' }]
-    plugin.start({ apps: existing })
-
-    assert.equal(saveCalled, false)
-  })
-
-  it('respects enabled:false when resolving apps', () => {
-    const app = createMockApp()
-    app.savePluginOptions = (_, cb) => cb(null)
-    const plugin = pluginFactory(app)
-
-    const configured = [
-      { enabled: false, url: '/@signalk/freeboard-sk/', label: '', icon: '', color: '' },
-      { enabled: true, url: '/@mxtommy/kip/', label: '', icon: '', color: '' }
-    ]
-    plugin.start({ apps: configured })
-
-    const routes = {}
-    const router = {
-      get: (path, handler) => {
-        routes[path] = handler
-      },
-      post: () => {}
-    }
-    plugin.registerWithRouter(router)
-
-    let resolved
-    routes['/settings'](
-      {},
-      {
-        json: (d) => {
-          resolved = d
-        }
-      }
-    )
-    assert.ok(!resolved.apps.some((a) => a.url === '/@signalk/freeboard-sk/'))
-    assert.ok(resolved.apps.some((a) => a.url === '/@mxtommy/kip/'))
-  })
-})
-
-describe('package.json', () => {
-  const pkg = JSON.parse(fs.readFileSync(path.join(__dirname, '..', 'package.json'), 'utf-8'))
-
-  it('has signalk-node-server-plugin keyword', () => {
-    assert.ok(pkg.keywords.includes('signalk-node-server-plugin'))
-  })
-
-  it('has signalk-webapp keyword', () => {
-    assert.ok(pkg.keywords.includes('signalk-webapp'))
-  })
-
-  it('has signalk-plugin-configurator keyword', () => {
-    assert.ok(pkg.keywords.includes('signalk-plugin-configurator'))
-  })
-
-  it('main points to plugin/index.js', () => {
-    assert.equal(pkg.main, 'plugin/index.js')
-    assert.ok(fs.existsSync(path.join(__dirname, '..', pkg.main)))
-  })
-})
-
-describe('night mode PUT handler', () => {
-  it('registers PUT handler when showNightModeButton is true', () => {
-    let registered = false
-    const app = createMockApp()
-    app.registerPutHandler = (context, path, callback, sourceId) => {
-      registered = true
-      assert.equal(context, 'vessels.self')
-      assert.equal(path, 'environment.mode')
-      assert.equal(sourceId, 'signalk-app-dock')
-    }
-
-    const plugin = pluginFactory(app)
-    const originalSetTimeout = globalThis.setTimeout
-    globalThis.setTimeout = (fn) => fn()
-    try {
-      plugin.start({ showNightModeButton: true, apps: [] })
-    } finally {
-      globalThis.setTimeout = originalSetTimeout
-    }
-    assert.ok(registered)
-  })
-
-  it('does not register PUT handler when showNightModeButton is false', () => {
-    let registered = false
-    const app = createMockApp()
-    app.registerPutHandler = () => {
-      registered = true
-    }
-
-    const plugin = pluginFactory(app)
-    const originalSetTimeout = globalThis.setTimeout
-    globalThis.setTimeout = (fn) => fn()
-    try {
-      plugin.start({ showNightModeButton: false, apps: [] })
-    } finally {
-      globalThis.setTimeout = originalSetTimeout
-    }
-    assert.equal(registered, false)
-  })
-
-  it('PUT handler accepts valid mode values and emits delta', () => {
-    const app = createMockApp()
-    let handlerCallback
-    let emittedDelta = null
-    app.registerPutHandler = (ctx, path, cb) => {
-      handlerCallback = cb
-    }
-    app.handleMessage = (id, delta) => {
-      emittedDelta = delta
-    }
-
-    const plugin = pluginFactory(app)
-    const originalSetTimeout = globalThis.setTimeout
-    globalThis.setTimeout = (fn) => fn()
-    try {
-      plugin.start({ showNightModeButton: true, apps: [] })
-    } finally {
-      globalThis.setTimeout = originalSetTimeout
-    }
-
-    const result = handlerCallback('vessels.self', 'environment.mode', 'night', () => {})
-    assert.equal(result.state, 'COMPLETED')
-    assert.equal(result.statusCode, 200)
-    assert.equal(emittedDelta.updates[0].values[0].path, 'environment.mode')
-    assert.equal(emittedDelta.updates[0].values[0].value, 'night')
-  })
-
-  it('PUT handler rejects invalid mode values', () => {
-    const app = createMockApp()
-    let handlerCallback
-    app.registerPutHandler = (ctx, path, cb) => {
-      handlerCallback = cb
-    }
-
-    const plugin = pluginFactory(app)
-    const originalSetTimeout = globalThis.setTimeout
-    globalThis.setTimeout = (fn) => fn()
-    try {
-      plugin.start({ showNightModeButton: true, apps: [] })
-    } finally {
-      globalThis.setTimeout = originalSetTimeout
-    }
-
-    const result = handlerCallback('vessels.self', 'environment.mode', 'invalid', () => {})
-    assert.equal(result.statusCode, 400)
-  })
-})
-
-describe('dismiss-tour endpoint', () => {
-  it('saves tourDismissed: true and responds', (t, done) => {
-    const app = createMockApp()
-    let saved = null
-    app.savePluginOptions = (opts, cb) => {
-      saved = opts
-      cb(null)
-    }
-    const plugin = pluginFactory(app)
-    plugin.start({ apps: [], position: 'left' })
-
-    const routes = { get: {}, post: {} }
-    const router = {
-      get: (path, handler) => {
-        routes.get[path] = handler
-      },
-      post: (path, handler) => {
-        routes.post[path] = handler
-      }
-    }
-    plugin.registerWithRouter(router)
-
-    const res = {
-      json: (data) => {
-        assert.equal(data.tourDismissed, true)
-        assert.equal(saved.tourDismissed, true)
-        assert.equal(saved.position, 'left')
-        done()
-      }
-    }
-    routes.post['/dismiss-tour']({}, res)
-  })
-
-  it('keeps the saved configuration when the plugin is not running', (t, done) => {
-    const app = createMockApp()
-    const apps = [{ url: '/a/', label: 'A', enabled: true }]
-    app.readPluginOptions = () => ({ enabled: false, configuration: { position: 'right', apps } })
-    let saved = null
-    app.savePluginOptions = (opts, cb) => {
-      saved = opts
-      cb(null)
-    }
-    const plugin = pluginFactory(app)
-
-    const routes = {}
-    plugin.registerWithRouter({
-      get: () => {},
-      post: (path, handler) => {
-        routes[path] = handler
-      }
-    })
-
-    const res = {
-      json: (data) => {
-        assert.equal(data.tourDismissed, true)
-        assert.deepEqual(saved, { position: 'right', apps, tourDismissed: true })
-        done()
-      }
-    }
-    routes['/dismiss-tour']({}, res)
-  })
-})
-
-describe('mode endpoint', () => {
-  it('returns day when no mode is set', (t, done) => {
-    const app = createMockApp()
-    const plugin = pluginFactory(app)
-    const routes = {}
-    const router = {
-      get: (path, handler) => {
-        routes[path] = handler
-      },
-      post: () => {}
-    }
-    plugin.registerWithRouter(router)
-
-    const res = {
-      json: (data) => {
-        assert.equal(data.value, 'day')
-        done()
-      }
-    }
-    routes['/mode']({}, res)
-  })
-
-  it('returns current mode when set', (t, done) => {
-    const app = createMockApp()
-    app.getSelfPath = (path) => {
-      if (path === 'environment.mode') return { value: 'night' }
-      return null
-    }
-    const plugin = pluginFactory(app)
-    const routes = {}
-    const router = {
-      get: (path, handler) => {
-        routes[path] = handler
-      },
-      post: () => {}
-    }
-    plugin.registerWithRouter(router)
-
-    const res = {
-      json: (data) => {
-        assert.equal(data.value, 'night')
-        done()
-      }
-    }
-    routes['/mode']({}, res)
-  })
-})
-
-describe('route access', () => {
-  // Records each route with the level it is registered at: 'admin' for a
-  // route registered on the router itself, the access() level otherwise.
-  function recordingRouter({ withAccess }) {
-    const levels = {}
-    const registrar = (level) => ({
-      get: (path) => {
-        levels[`GET ${path}`] = level
-      },
-      post: (path) => {
-        levels[`POST ${path}`] = level
-      }
-    })
-    const router = registrar('admin')
-    if (withAccess) router.access = registrar
-    return { router, levels }
-  }
-
-  it('opens /settings and /mode to readonly users and /dismiss-tour to readwrite users', () => {
-    const plugin = pluginFactory(createMockApp())
-    const { router, levels } = recordingRouter({ withAccess: true })
-    plugin.registerWithRouter(router)
-
-    assert.deepEqual(levels, {
-      'GET /settings': 'readonly',
-      'GET /webapps': 'admin',
-      'GET /mode': 'readonly',
-      'POST /dismiss-tour': 'readwrite'
-    })
-  })
-
-  it('registers every route on the router itself when it has no access()', () => {
-    const plugin = pluginFactory(createMockApp())
-    const { router, levels } = recordingRouter({ withAccess: false })
-    plugin.registerWithRouter(router)
-
-    assert.deepEqual(levels, {
-      'GET /settings': 'admin',
-      'GET /webapps': 'admin',
-      'GET /mode': 'admin',
-      'POST /dismiss-tour': 'admin'
-    })
-  })
-})
-
-describe('public files', () => {
-  const publicDir = path.join(__dirname, '..', 'public')
-
-  it('index.html exists', () => {
-    assert.ok(fs.existsSync(path.join(publicDir, 'index.html')))
-  })
-
-  it('dock.js exists', () => {
-    assert.ok(fs.existsSync(path.join(publicDir, 'dock.js')))
-  })
-
-  it('dock.css exists', () => {
-    assert.ok(fs.existsSync(path.join(publicDir, 'dock.css')))
-  })
-
-  it('remoteEntry.js exists (Module Federation)', () => {
-    assert.ok(fs.existsSync(path.join(publicDir, 'remoteEntry.js')))
-  })
-
-  it('app-icon.svg exists', () => {
-    assert.ok(fs.existsSync(path.join(publicDir, 'app-icon.svg')))
-  })
-
-  it('icon-settings.svg exists', () => {
-    assert.ok(fs.existsSync(path.join(publicDir, 'icon-settings.svg')))
-  })
-
-  it('manifest.webmanifest exists and is valid JSON with required PWA fields', () => {
-    const manifestPath = path.join(publicDir, 'manifest.webmanifest')
-    assert.ok(fs.existsSync(manifestPath))
-    const manifest = JSON.parse(fs.readFileSync(manifestPath, 'utf8'))
-    assert.equal(typeof manifest.name, 'string')
-    assert.equal(typeof manifest.start_url, 'string')
-    assert.equal(manifest.display, 'standalone')
-    assert.ok(Array.isArray(manifest.icons) && manifest.icons.length > 0)
-  })
-
-  it('app-icon-180.png exists (apple-touch-icon)', () => {
-    assert.ok(fs.existsSync(path.join(publicDir, 'app-icon-180.png')))
-  })
-
-  it('app-icon-maskable.svg exists', () => {
-    assert.ok(fs.existsSync(path.join(publicDir, 'app-icon-maskable.svg')))
-  })
-})