@signalk/charts-plugin 2.3.0 → 3.0.0

package/src/plugin.js

@@ -1,233 +0,0 @@
-const debug = require('debug')('signalk-charts-plugin')
-const Promise = require('bluebird')
-const _ = require('lodash')
-const path = require('path')
-const fs = require('fs')
-const Charts = require('./charts')
-const {apiRoutePrefix} = require('./constants')
-
-const MIN_ZOOM = 1
-const MAX_ZOOM = 19
-
-module.exports = function(app) {
-  let chartProviders = []
-  let pluginStarted = false
-  const configBasePath = app.config.configPath
-  const defaultChartsPath = path.join(configBasePath, "/charts")
-  ensureDirectoryExists(defaultChartsPath)
-
-  function start(props) {
-    const chartPaths = _.isEmpty(props.chartPaths)
-      ? [defaultChartsPath]
-      : resolveUniqueChartPaths(props.chartPaths, configBasePath)
-    const onlineProviders = _.reduce(props.onlineChartProviders, (result, data) => {
-      const provider = convertOnlineProviderConfig(data)
-      result[provider.identifier] = provider
-      return result
-    }, {})
-    debug(`Start charts plugin. Chart paths: ${chartPaths.join(', ')}, online charts: ${onlineProviders.length}`)
-
-    const loadProviders = Promise.mapSeries(chartPaths, chartPath => Charts.findCharts(chartPath))
-      .then(list => _.reduce(list, (result, charts) => _.merge({}, result, charts), {}))
-    return loadProviders.then(charts => {
-      console.log(`Chart plugin: Found ${_.keys(charts).length} charts from ${chartPaths.join(', ')}`)
-      chartProviders = _.merge({}, charts, onlineProviders)
-      // Do not register routes if plugin has been started once already
-      pluginStarted === false && registerRoutes()
-      pluginStarted = true
-    }).catch(e => {
-      console.error(`Error loading chart providers`, e.message)
-      chartProviders = {}
-    })
-  }
-
-  function stop() {
-    debug("Chart plugin stopped")
-  }
-
-  function registerRoutes() {
-    app.get(apiRoutePrefix + '/charts/:identifier/:z([0-9]*)/:x([0-9]*)/:y([0-9]*)', (req, res) => {
-      const { identifier, z, x, y } = req.params
-      const provider = chartProviders[identifier]
-      if (!provider) {
-        res.sendStatus(404)
-        return
-      }
-      switch (provider._fileFormat) {
-        case 'directory':
-          return serveTileFromFilesystem(res, provider, z, x, y)
-        case 'mbtiles':
-          return serveTileFromMbtiles(res, provider, z, x, y)
-        default:
-          console.error(`Unknown chart provider fileformat ${provider._fileFormat}`)
-          res.status(500).send()
-      }
-    })
-
-    app.get(apiRoutePrefix + "/charts/:identifier", (req, res) => {
-      const { identifier } = req.params
-      const provider = chartProviders[identifier]
-      if (provider) {
-        return res.json(sanitizeProvider(provider))
-      } else {
-        return res.status(404).send('Not found')
-      }
-    })
-
-    app.get(apiRoutePrefix + "/charts", (req, res) => {
-      const sanitized = _.mapValues(chartProviders, sanitizeProvider)
-      res.json(sanitized)
-    })
-  }
-
-  return {
-    id: 'charts',
-    name: 'Signal K Charts',
-    description: 'Singal K Charts resource',
-    schema: {
-      title: 'Signal K Charts',
-      description: `Add one or more paths to find charts. Defaults to "${defaultChartsPath}"`,
-      type: 'object',
-      properties: {
-        chartPaths: {
-          type: 'array',
-          title: 'Chart paths',
-          items: {
-            type: 'string',
-            title: "Path",
-            description: `Path for chart files, relative to "${configBasePath}"`
-          }
-        },
-        onlineChartProviders: {
-          type: 'array',
-          title: 'Online chart providers',
-          items: {
-            type: 'object',
-            title: 'Provider',
-            required: ['name', 'minzoom', 'maxzoom', 'format', 'url'],
-            properties: {
-              name: {
-                type: 'string',
-                title: 'Name'
-              },
-              description: {
-                type: 'string',
-                title: 'Description'
-              },
-              minzoom: {
-                type: 'number',
-                title: `Minimum zoom level, between [${MIN_ZOOM}, ${MAX_ZOOM}]`,
-                maximum: MAX_ZOOM,
-                minimum: MIN_ZOOM,
-                default: MIN_ZOOM,
-              },
-              maxzoom: {
-                type: 'number',
-                title: `Maximum zoom level, between [${MIN_ZOOM}, ${MAX_ZOOM}]`,
-                maximum: MAX_ZOOM,
-                minimum: MIN_ZOOM,
-                default: 15,
-              },
-              serverType: {
-                type: 'string',
-                title: 'Server Type',
-                default: 'tilelayer',
-                enum: ['tilelayer', 'WMS']
-              },
-              format: {
-                type: 'string',
-                title: 'Format',
-                default: 'png',
-                enum: ['png', 'jpg']
-              },
-              url: {
-                type: 'string',
-                title: 'URL',
-                description: 'Map URL (for tilelayer include {z}, {x} and {y} parameters, e.g. "http://example.org/{z}/{x}/{y}.png")'
-              },
-              layers: {
-                type: 'array',
-                title: 'Layers',
-                description: '(WMS only) ',
-                items: {
-                    title: 'Layer Name',
-                    description: 'Name of layer to display',
-                    type: 'string'
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    start,
-    stop
-  }
-}
-
-
-const responseHttpOptions = {
-  headers: {
-    'Cache-Control': 'public, max-age=7776000' // 90 days
-  }
-}
-
-function resolveUniqueChartPaths(chartPaths, configBasePath) {
-  const paths = _.map(chartPaths, chartPath => path.resolve(configBasePath, chartPath))
-  return _.uniq(paths)
-}
-
-function convertOnlineProviderConfig(provider) {
-  const id = _.kebabCase(_.deburr(provider.name))
-  return {
-    name: provider.name,
-    description: provider.description,
-    bounds: [-180, -90, 180, 90],
-    minzoom: Math.min(Math.max(1, provider.minzoom), 19),
-    maxzoom: Math.min(Math.max(1, provider.maxzoom), 19),
-    format: provider.format,
-    scale: 'N/A',
-    identifier: id,
-    tilemapUrl: provider.url,
-    type: (provider.serverType) ? provider.serverType : 'tilelayer',
-    chartLayers: (provider.layers) ? provider.layers : null
-  }
-}
-
-function sanitizeProvider(provider) {
-  return _.omit(provider, ['_filePath', '_fileFormat', '_mbtilesHandle', '_flipY'])
-}
-
-function ensureDirectoryExists (path) {
-  if (!fs.existsSync(path)) {
-    fs.mkdirSync(path)
-  }
-}
-
-function serveTileFromFilesystem(res, provider, z, x, y) {
-  const {identifier, format, _flipY, _filePath} = provider
-  const flippedY = Math.pow(2, z) - 1 - y
-  const file = path.resolve(_filePath, `${z}/${x}/${_flipY ? flippedY : y}.${format}`)
-  res.sendFile(file, responseHttpOptions, (err) => {
-    if (err && err.code === 'ENOENT') {
-      res.sendStatus(404)
-    } else if (err) {
-      throw err
-    }
-  })
-}
-
-function serveTileFromMbtiles(res, provider, z, x, y) {
-  provider._mbtilesHandle.getTile(z, x, y, (err, tile, headers) => {
-    if (err && err.message && err.message === 'Tile does not exist') {
-      res.sendStatus(404)
-    } else if (err) {
-      console.error(`Error fetching tile ${provider.identifier}/${z}/${x}/${y}:`, err)
-      res.sendStatus(500)
-    } else {
-      headers['Cache-Control'] = responseHttpOptions.headers['Cache-Control']
-      res.writeHead(200, headers)
-      res.end(tile)
-    }
-  })
-}

package/test/charts/tms-tiles/tilemapresource.xml

@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-    <TileMap version="1.0.0" tilemapservice="http://tms.osgeo.org/1.0.0">
-      <Title>Översikt Svenska Sjökort</Title>
-      <Abstract></Abstract>
-      <Metadata scale="4000000" mime-type="text/xml" />
-      <SRS>EPSG:900913</SRS>
-      <BoundingBox minx="6.924150554004035" miny="53.14584310531994" maxx="25.541777414896345" maxy="66.0258911558707"/>
-      <Origin x="6.924150554004035" y="66.0258911558707" />
-      <TileFormat width="256" height="256" mime-type="image/png" extension="png"/>
-      <TileSets profile="mercator">
-        <TileSet href="4" units-per-pixel="9783.93961875" order="4"/>
-        <TileSet href="5" units-per-pixel="4891.969809375" order="5"/>
-   </TileSets>
-</TileMap>

package/test/charts/unpacked-tiles/metadata.json

@@ -1,15 +0,0 @@
-{
-    "profile": "mercator", 
-    "attribution": "NOAA", 
-    "name": "NOAA MBTiles test file", 
-    "format": "png", 
-    "basename": "MBTILES_19", 
-    "bounds": "-82.265625, 36.5978891331, -61.875, 31.952162238", 
-    "minzoom": "3", 
-    "version": "1", 
-    "maxzoom": "4", 
-    "tilejson": "2.0.0", 
-    "scheme": "xyz", 
-    "type": "overlay", 
-    "description": "CAROLINAS"
-}

package/test/expected-charts.json

@@ -1,53 +0,0 @@
-{
-  "test": {
-    "bounds": [
-      -82.265625,
-      36.5978891331,
-      -61.875,
-      31.952162238
-    ],
-    "description": "CAROLINAS",
-    "format": "png",
-    "identifier": "test",
-    "maxzoom": 5,
-    "minzoom": 3,
-    "name": "MBTILES_19",
-    "scale": "250000",
-    "tilemapUrl": "/signalk/v1/api/resources/charts/test/{z}/{x}/{y}",
-    "type": "tilelayer"
-  },
-  "tms-tiles": {
-    "bounds": [
-      6.924150554004035,
-      53.14584310531994,
-      25.541777414896345,
-      66.0258911558707
-    ],
-    "description": "Översikt Svenska Sjökort",
-    "format": "png",
-    "identifier": "tms-tiles",
-    "maxzoom": 5,
-    "minzoom": 4,
-    "name": "Översikt Svenska Sjökort",
-    "scale": "4000000",
-    "tilemapUrl": "/signalk/v1/api/resources/charts/tms-tiles/{z}/{x}/{y}",
-    "type": "tilelayer"
-  },
-  "unpacked-tiles": {
-    "bounds": [
-      -82.265625,
-      36.5978891331,
-      -61.875,
-      31.952162238
-    ],
-    "description": "CAROLINAS",
-    "format": "png",
-    "identifier": "unpacked-tiles",
-    "maxzoom": 4,
-    "minzoom": 3,
-    "name": "NOAA MBTiles test file",
-    "scale": "250000",
-    "tilemapUrl": "/signalk/v1/api/resources/charts/unpacked-tiles/{z}/{x}/{y}",
-    "type": "tilelayer"
-  }
-}

package/test/plugin-test.js

@@ -1,196 +0,0 @@
-'use strict'
-const fs = require('fs')
-const _ = require('lodash')
-const path = require('path')
-const http = require('http')
-const chai = require('chai')
-const chaiHttp = require('chai-http')
-const Promise = require('bluebird')
-const express = require('express')
-const expect = chai.expect
-const Plugin = require('../src/plugin')
-const expectedCharts = require('./expected-charts.json')
-
-chai.use(chaiHttp)
-
-describe('GET /resources/charts', () => {
-  let plugin
-  let testServer
-  beforeEach(() =>
-    createDefaultApp()
-      .then(({app, server}) => {
-      plugin = Plugin(app)
-      testServer = server
-    })
-  )
-  afterEach(done => testServer.close(() => done()))
-
-  it('returns all charts for default path', () => {
-    return plugin.start({})
-      .then(() => get(testServer, '/signalk/v1/api/resources/charts'))
-      .then(result => {
-        expect(result.status).to.equal(200)
-        const resultCharts = result.body
-        expect(_.keys(resultCharts).length).to.deep.equal(3)
-        expect(resultCharts).to.deep.equal(expectedCharts)
-      })
-  })
-
-  it('handle canonical paths', () => {
-    return plugin.start({chartPaths: ['charts', path.resolve(__dirname, 'charts').toString()]})
-      .then(() => get(testServer, '/signalk/v1/api/resources/charts'))
-      .then(result => {
-        expect(result.status).to.equal(200)
-        const resultCharts = result.body
-        expect(_.keys(resultCharts).length).to.deep.equal(3)
-      })
-  })
-
-  it('returns all charts for multiple paths', () => {
-    return plugin.start({chartPaths: ['charts', 'charts-2']})
-      .then(() => get(testServer, '/signalk/v1/api/resources/charts'))
-      .then(result => {
-        expect(result.status).to.equal(200)
-        const resultCharts = result.body
-        expect(_.keys(resultCharts).length).to.deep.equal(4)
-        expect(resultCharts['test2']).not.to.equal(undefined)
-      })
-  })
-
-  it('returns empty charts for custom path', () => {
-    return plugin.start({chartPaths: ['../src/']})
-      .then(() => get(testServer, '/signalk/v1/api/resources/charts'))
-      .then(result => {
-        expect(result.status).to.equal(200)
-        expect(result.body).to.deep.equal({})
-      })
-  })
-
-  it('returns online chart providers', () => {
-    return plugin.start({chartPaths: ['charts'], onlineChartProviders: [
-        {name: 'Test Name', minzoom: 2, maxzoom: 15, format: 'jpg', url: 'https://example.com'}
-      ]})
-      .then(() => get(testServer, '/signalk/v1/api/resources/charts'))
-      .then(result => {
-        expect(result.body['test-name']).to.deep.equal({
-          bounds: [-180, -90, 180, 90],
-          format: 'jpg',
-          identifier: 'test-name',
-          maxzoom: 15,
-          minzoom: 2,
-          name: 'Test Name',
-          scale: 'N/A',
-          tilemapUrl: 'https://example.com',
-          type: 'tilelayer'
-        })
-      })
-  })
-
-  it('returns one chart', () => {
-    const identifier = 'test'
-    return plugin.start({})
-      .then(() => get(testServer, `/signalk/v1/api/resources/charts/${identifier}`))
-      .then(result => {
-        expect(result.status).to.equal(200)
-        expect(result.body).to.deep.equal(expectedCharts[identifier])
-      })
-  })
-
-  it('returns 404 for unknown chart', () => {
-    return plugin.start({})
-      .then(() => get(testServer, `/signalk/v1/api/resources/charts/foo`))
-      .catch(e => e.response)
-      .then(result => {
-        expect(result.status).to.equal(404)
-      })
-  })
-})
-
-describe('GET /resources/charts/:identifier/:z/:x/:y', () => {
-  let plugin
-  let testServer
-  beforeEach(() =>
-    createDefaultApp()
-      .then(({app, server}) => {
-      plugin = Plugin(app)
-      testServer = server
-    })
-  )
-  afterEach(done => testServer.close(() => done()))
-
-  it('returns correct tile from MBTiles file', () => {
-    return plugin.start({})
-      .then(() => get(testServer, '/signalk/v1/api/resources/charts/test/4/5/6'))
-      .then(response => {
-        // unpacked-tiles contains same tiles as the test.mbtiles file
-        expectTileResponse(response, 'charts/unpacked-tiles/4/5/6.png', 'image/png')
-      })
-  })
-
-  it('returns correct tile from directory', () => {
-    const expectedTile = fs.readFileSync(path.resolve(__dirname, 'charts/unpacked-tiles/4/4/6.png'))
-    return plugin.start({})
-      .then(() => get(testServer, '/signalk/v1/api/resources/charts/unpacked-tiles/4/4/6'))
-      .then(response => {
-        expectTileResponse(response, 'charts/unpacked-tiles/4/4/6.png', 'image/png')
-      })
-  })
-
-  it('returns correct tile from TMS directory', () => {
-    const expectedTile = fs.readFileSync(path.resolve(__dirname, 'charts/tms-tiles/5/17/21.png'))
-    // Y-coordinate flipped
-    return plugin.start({})
-      .then(() => get(testServer, '/signalk/v1/api/resources/charts/tms-tiles/5/17/10'))
-      .then(response => {
-        expectTileResponse(response, 'charts/tms-tiles/5/17/21.png', 'image/png')
-      })
-  })
-
-  it('returns 404 for missing tile', () => {
-    return plugin.start({})
-      .then(() => get(testServer, '/signalk/v1/api/resources/charts/tms-tiles/5/55/10'))
-      .catch(e => e.response)
-      .then(response => {
-        expect(response.status).to.equal(404)
-      })
-  })
-
-  it('returns 404 for wrong chart identifier', () => {
-    return plugin.start({})
-      .then(() => get(testServer, '/signalk/v1/api/resources/charts/foo/4/4/6'))
-      .catch(e => e.response)
-      .then(response => {
-        expect(response.status).to.equal(404)
-      })
-  })
-})
-
-const expectTileResponse = (response, expectedTilePath, expectedFormat) => {
-  const expectedTile = fs.readFileSync(path.resolve(__dirname, expectedTilePath))
-  expect(response.status).to.equal(200)
-  expect(response.headers['content-type']).to.equal(expectedFormat)
-  expect(response.headers['cache-control']).to.equal('public, max-age=7776000')
-  expect(response.body.toString('hex')).to.deep.equal(expectedTile.toString('hex'))
-}
-
-const createDefaultApp = () => {
-  let app = express()
-  app.use(require('body-parser').json())
-  app.config = { configPath: path.resolve(__dirname) }
-  return new Promise((resolve, reject) => {
-    const server = http.createServer(app)
-    server.listen(() => {
-      const {port} = server.address()
-      app.set('port', port)
-      console.log(`Test server on port ${port}`)
-      resolve({app, server})
-    })
-  })
-}
-
-const get = (server, location) => {
-  const baseUrl = `http://localhost:${server.address().port}`
-  return chai
-    .request(baseUrl)
-    .get(location)
-}