index.js 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. const express = require('express')
  2. const qs = require('querystring')
  3. const uppy = require('../uppy')
  4. const helmet = require('helmet')
  5. const morgan = require('morgan')
  6. const bodyParser = require('body-parser')
  7. // @ts-ignore
  8. const promBundle = require('express-prom-bundle')
  9. const session = require('express-session')
  10. const helper = require('./helper')
  11. // @ts-ignore
  12. const { version } = require('../../package.json')
  13. const app = express()
  14. // for server metrics tracking.
  15. const metricsMiddleware = promBundle({ includeMethod: true })
  16. const promClient = metricsMiddleware.promClient
  17. const collectDefaultMetrics = promClient.collectDefaultMetrics
  18. const promInterval = collectDefaultMetrics({ register: promClient.register, timeout: 5000 })
  19. // Add version as a prometheus gauge
  20. const versionGauge = new promClient.Gauge({ name: 'companion_version', help: 'npm version as an integer' })
  21. // @ts-ignore
  22. const numberVersion = version.replace(/\D/g, '') * 1
  23. versionGauge.set(numberVersion)
  24. if (app.get('env') !== 'test') {
  25. clearInterval(promInterval)
  26. }
  27. // log server requests.
  28. app.use(morgan('combined'))
  29. morgan.token('url', (req, res) => {
  30. const mask = (key) => {
  31. // don't log access_tokens in urls
  32. const query = Object.assign({}, req.query)
  33. // replace logged access token with xxxx character
  34. query[key] = 'x'.repeat(req.query[key].length)
  35. return `${req.path}?${qs.stringify(query)}`
  36. }
  37. if (req.query && req.query['access_token']) {
  38. return mask('access_token')
  39. } else if (req.query && req.query['uppyAuthToken']) {
  40. return mask('uppyAuthToken')
  41. }
  42. return req.originalUrl || req.url
  43. })
  44. // make app metrics available at '/metrics'.
  45. app.use(metricsMiddleware)
  46. app.use(bodyParser.json())
  47. app.use(bodyParser.urlencoded({ extended: false }))
  48. // Use helmet to secure Express headers
  49. app.use(helmet.frameguard())
  50. app.use(helmet.xssFilter())
  51. app.use(helmet.noSniff())
  52. app.use(helmet.ieNoOpen())
  53. app.disable('x-powered-by')
  54. const uppyOptions = helper.getUppyOptions()
  55. const sessionOptions = {
  56. secret: uppyOptions.secret,
  57. resave: true,
  58. saveUninitialized: true
  59. }
  60. if (process.env.COMPANION_REDIS_URL) {
  61. const RedisStore = require('connect-redis')(session)
  62. sessionOptions.store = new RedisStore({
  63. url: process.env.COMPANION_REDIS_URL
  64. })
  65. }
  66. if (process.env.COMPANION_COOKIE_DOMAIN) {
  67. sessionOptions.cookie = {
  68. domain: process.env.COMPANION_COOKIE_DOMAIN,
  69. maxAge: 24 * 60 * 60 * 1000 // 1 day
  70. }
  71. }
  72. app.use(session(sessionOptions))
  73. app.use((req, res, next) => {
  74. const protocol = process.env.COMPANION_PROTOCOL || 'http'
  75. // if endpoint urls are specified, then we only allow those endpoints
  76. // otherwise, we allow any client url to access companion.
  77. // here we also enforce that only the protocol allowed by companion is used.
  78. if (process.env.COMPANION_CLIENT_ORIGINS) {
  79. const whitelist = process.env.COMPANION_CLIENT_ORIGINS
  80. .split(',')
  81. .map((url) => helper.hasProtocol(url) ? url : `${protocol}://${url}`)
  82. // @ts-ignore
  83. if (req.headers.origin && whitelist.indexOf(req.headers.origin) > -1) {
  84. res.setHeader('Access-Control-Allow-Origin', req.headers.origin)
  85. }
  86. } else {
  87. res.setHeader('Access-Control-Allow-Origin', req.headers.origin || '*')
  88. }
  89. res.setHeader(
  90. 'Access-Control-Allow-Methods',
  91. 'GET, POST, OPTIONS, PUT, PATCH, DELETE'
  92. )
  93. res.setHeader(
  94. 'Access-Control-Allow-Headers',
  95. 'Authorization, Origin, Content-Type, Accept'
  96. )
  97. res.setHeader('Access-Control-Allow-Credentials', 'true')
  98. next()
  99. })
  100. // Routes
  101. app.get('/', (req, res) => {
  102. res.setHeader('Content-Type', 'text/plain')
  103. res.send(helper.buildHelpfulStartupMessage(uppyOptions))
  104. })
  105. // initialize uppy
  106. helper.validateConfig(uppyOptions)
  107. if (process.env.COMPANION_PATH) {
  108. app.use(process.env.COMPANION_PATH, uppy.app(uppyOptions))
  109. } else {
  110. app.use(uppy.app(uppyOptions))
  111. }
  112. app.use((req, res, next) => {
  113. return res.status(404).json({ message: 'Not Found' })
  114. })
  115. if (app.get('env') === 'production') {
  116. // @ts-ignore
  117. app.use((err, req, res, next) => {
  118. console.error('\x1b[31m', err, '\x1b[0m')
  119. res.status(err.status || 500).json({ message: 'Something went wrong' })
  120. })
  121. } else {
  122. // @ts-ignore
  123. app.use((err, req, res, next) => {
  124. console.error('\x1b[31m', err, '\x1b[0m')
  125. res.status(err.status || 500).json({ message: err.message, error: err })
  126. })
  127. }
  128. module.exports = { app, uppyOptions }