WIP: Refactor/typescript 4

.babelrc

@@ -1,13 +1,16 @@
 {
   "presets": [
-    ["env", {
+    ["@babel/preset-env", {
+      "useBuiltIns": "entry",
+      "corejs": 2,
       "targets": {
         "node": "6",
         "uglify": true
       }
-    }]
+    }],
+    "@babel/preset-typescript"
   ],
   "plugins": [
-    "transform-runtime"
+    "@babel/plugin-transform-runtime"
   ]
 }

.eslintignore

@@ -0,0 +1,7 @@
+/dist
+/public
+node_modules
+/test
+/*.js
+
+lib/migrations

.gitignore

@@ -29,4 +29,7 @@ public/uploads/*
 /.nyc_output
 /coverage/
 
-.vscode/settings.json
+.vscode/settings.json
+
+/dist
+lib/**/*.js

.sequelizerc.example

@@ -1,9 +1,9 @@
 const path = require('path')
-const config = require('./lib/config')
+const config = require('./dist/config')
 
 module.exports = {
   config: path.resolve('config.js'),
-  'migrations-path': path.resolve('lib', 'migrations'),
-  'models-path': path.resolve('lib', 'models'),
+  'migrations-path': path.resolve('dist', 'migrations'),
+  'models-path': path.resolve('dist', 'models'),
   url: config.dbURL
 }

app.js

@@ -1,331 +1,3 @@
 'use strict'
-// app
-// external modules
-var express = require('express')
 
-var ejs = require('ejs')
-var passport = require('passport')
-var methodOverride = require('method-override')
-var cookieParser = require('cookie-parser')
-var session = require('express-session')
-var SequelizeStore = require('connect-session-sequelize')(session.Store)
-var fs = require('fs')
-var path = require('path')
-
-var morgan = require('morgan')
-var passportSocketIo = require('passport.socketio')
-var helmet = require('helmet')
-var i18n = require('i18n')
-var flash = require('connect-flash')
-var apiMetrics = require('prometheus-api-metrics')
-
-// core
-var config = require('./lib/config')
-var logger = require('./lib/logger')
-var response = require('./lib/response')
-var models = require('./lib/models')
-var csp = require('./lib/csp')
-const { Environment } = require('./lib/config/enum')
-
-const { versionCheckMiddleware, checkVersion } = require('./lib/web/middleware/checkVersion')
-
-function createHttpServer () {
-  if (config.useSSL) {
-    const ca = (function () {
-      let i, len
-      const results = []
-      for (i = 0, len = config.sslCAPath.length; i < len; i++) {
-        results.push(fs.readFileSync(config.sslCAPath[i], 'utf8'))
-      }
-      return results
-    })()
-    const options = {
-      key: fs.readFileSync(config.sslKeyPath, 'utf8'),
-      cert: fs.readFileSync(config.sslCertPath, 'utf8'),
-      ca: ca,
-      dhparam: fs.readFileSync(config.dhParamPath, 'utf8'),
-      requestCert: false,
-      rejectUnauthorized: false
-    }
-    return require('https').createServer(options, app)
-  } else {
-    return require('http').createServer(app)
-  }
-}
-
-// server setup
-var app = express()
-var server = createHttpServer()
-
-// API and process monitoring with Prometheus for Node.js micro-service
-app.use(apiMetrics({
-  metricsPath: '/metrics/router',
-  excludeRoutes: ['/metrics/codimd']
-}))
-
-// logger
-app.use(morgan('combined', {
-  stream: logger.stream
-}))
-
-// socket io
-var io = require('socket.io')(server)
-io.engine.ws = new (require('ws').Server)({
-  noServer: true,
-  perMessageDeflate: false
-})
-
-// others
-var realtime = require('./lib/realtime/realtime.js')
-
-// assign socket io to realtime
-realtime.io = io
-
-// methodOverride
-app.use(methodOverride('_method'))
-
-// session store
-var sessionStore = new SequelizeStore({
-  db: models.sequelize
-})
-
-// use hsts to tell https users stick to this
-if (config.hsts.enable) {
-  app.use(helmet.hsts({
-    maxAge: config.hsts.maxAgeSeconds,
-    includeSubdomains: config.hsts.includeSubdomains,
-    preload: config.hsts.preload
-  }))
-} else if (config.useSSL) {
-  logger.info('Consider enabling HSTS for extra security:')
-  logger.info('https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security')
-}
-
-// Add referrer policy to improve privacy
-app.use(
-  helmet.referrerPolicy({
-    policy: 'same-origin'
-  })
-)
-
-// Generate a random nonce per request, for CSP with inline scripts
-app.use(csp.addNonceToLocals)
-
-// use Content-Security-Policy to limit XSS, dangerous plugins, etc.
-// https://helmetjs.github.io/docs/csp/
-if (config.csp.enable) {
-  app.use(helmet.contentSecurityPolicy({
-    directives: csp.computeDirectives()
-  }))
-} else {
-  logger.info('Content-Security-Policy is disabled. This may be a security risk.')
-}
-
-i18n.configure({
-  locales: ['en', 'zh-CN', 'zh-TW', 'fr', 'de', 'ja', 'es', 'ca', 'el', 'pt', 'it', 'tr', 'ru', 'nl', 'hr', 'pl', 'uk', 'hi', 'sv', 'eo', 'da', 'ko', 'id', 'sr'],
-  cookie: 'locale',
-  directory: path.join(__dirname, '/locales'),
-  updateFiles: config.updateI18nFiles
-})
-
-app.use(cookieParser())
-
-app.use(i18n.init)
-
-// routes without sessions
-// static files
-app.use('/', express.static(path.join(__dirname, '/public'), { maxAge: config.staticCacheTime, index: false }))
-app.use('/docs', express.static(path.resolve(__dirname, config.docsPath), { maxAge: config.staticCacheTime }))
-app.use('/uploads', express.static(path.resolve(__dirname, config.uploadsPath), { maxAge: config.staticCacheTime }))
-app.use('/default.md', express.static(path.resolve(__dirname, config.defaultNotePath), { maxAge: config.staticCacheTime }))
-app.use(require('./lib/metrics').router)
-
-// session
-app.use(session({
-  name: config.sessionName,
-  secret: config.sessionSecret,
-  resave: false, // don't save session if unmodified
-  saveUninitialized: true, // always create session to ensure the origin
-  rolling: true, // reset maxAge on every response
-  cookie: {
-    maxAge: config.sessionLife
-  },
-  store: sessionStore
-}))
-
-// session resumption
-var tlsSessionStore = {}
-server.on('newSession', function (id, data, cb) {
-  tlsSessionStore[id.toString('hex')] = data
-  cb()
-})
-server.on('resumeSession', function (id, cb) {
-  cb(null, tlsSessionStore[id.toString('hex')] || null)
-})
-
-// middleware which blocks requests when we're too busy
-app.use(require('./lib/middleware/tooBusy'))
-
-app.use(flash())
-
-// passport
-app.use(passport.initialize())
-app.use(passport.session())
-
-// check uri is valid before going further
-app.use(require('./lib/middleware/checkURIValid'))
-// redirect url without trailing slashes
-app.use(require('./lib/middleware/redirectWithoutTrailingSlashes'))
-app.use(require('./lib/middleware/codiMDVersion'))
-
-if (config.autoVersionCheck && process.env.NODE_ENV === Environment.production) {
-  checkVersion(app)
-  app.use(versionCheckMiddleware)
-}
-
-// routes need sessions
-// template files
-app.set('views', config.viewPath)
-// set render engine
-app.engine('ejs', ejs.renderFile)
-// set view engine
-app.set('view engine', 'ejs')
-// set generally available variables for all views
-app.locals.useCDN = config.useCDN
-app.locals.serverURL = config.serverURL
-app.locals.sourceURL = config.sourceURL
-app.locals.privacyPolicyURL = config.privacyPolicyURL
-app.locals.allowAnonymous = config.allowAnonymous
-app.locals.allowAnonymousEdits = config.allowAnonymousEdits
-app.locals.permission = config.permission
-app.locals.allowPDFExport = config.allowPDFExport
-app.locals.authProviders = {
-  facebook: config.isFacebookEnable,
-  twitter: config.isTwitterEnable,
-  github: config.isGitHubEnable,
-  bitbucket: config.isBitbucketEnable,
-  gitlab: config.isGitLabEnable,
-  mattermost: config.isMattermostEnable,
-  dropbox: config.isDropboxEnable,
-  google: config.isGoogleEnable,
-  ldap: config.isLDAPEnable,
-  ldapProviderName: config.ldap.providerName,
-  saml: config.isSAMLEnable,
-  oauth2: config.isOAuth2Enable,
-  oauth2ProviderName: config.oauth2.providerName,
-  openID: config.isOpenIDEnable,
-  email: config.isEmailEnable,
-  allowEmailRegister: config.allowEmailRegister
-}
-app.locals.versionInfo = {
-  latest: true,
-  versionItem: null
-}
-
-// Export/Import menu items
-app.locals.enableDropBoxSave = config.isDropboxEnable
-app.locals.enableGitHubGist = config.isGitHubEnable
-app.locals.enableGitlabSnippets = config.isGitlabSnippetsEnable
-
-app.use(require('./lib/routes').router)
-
-// response not found if no any route matxches
-app.get('*', function (req, res) {
-  response.errorNotFound(req, res)
-})
-
-// socket.io secure
-io.use(realtime.secure)
-// socket.io auth
-io.use(passportSocketIo.authorize({
-  cookieParser: cookieParser,
-  key: config.sessionName,
-  secret: config.sessionSecret,
-  store: sessionStore,
-  success: realtime.onAuthorizeSuccess,
-  fail: realtime.onAuthorizeFail
-}))
-// socket.io heartbeat
-io.set('heartbeat interval', config.heartbeatInterval)
-io.set('heartbeat timeout', config.heartbeatTimeout)
-// socket.io connection
-io.sockets.on('connection', realtime.connection)
-
-// listen
-function startListen () {
-  var address
-  var listenCallback = function () {
-    var schema = config.useSSL ? 'HTTPS' : 'HTTP'
-    logger.info('%s Server listening at %s', schema, address)
-    realtime.maintenance = false
-  }
-
-  // use unix domain socket if 'path' is specified
-  if (config.path) {
-    address = config.path
-    server.listen(config.path, listenCallback)
-  } else {
-    address = config.host + ':' + config.port
-    server.listen(config.port, config.host, listenCallback)
-  }
-}
-
-// sync db then start listen
-models.sequelize.sync().then(function () {
-  // check if realtime is ready
-  if (realtime.isReady()) {
-    models.Revision.checkAllNotesRevision(function (err, notes) {
-      if (err) throw new Error(err)
-      if (!notes || notes.length <= 0) return startListen()
-    })
-  } else {
-    throw new Error('server still not ready after db synced')
-  }
-}).catch(err => {
-  logger.error('Can\'t sync database')
-  logger.error(err.stack)
-  logger.error('Process will exit now.')
-  process.exit(1)
-})
-
-// log uncaught exception
-process.on('uncaughtException', function (err) {
-  logger.error('An uncaught exception has occured.')
-  logger.error(err)
-  console.error(err)
-  logger.error('Process will exit now.')
-  process.exit(1)
-})
-
-// install exit handler
-function handleTermSignals () {
-  logger.info('CodiMD has been killed by signal, try to exit gracefully...')
-  realtime.maintenance = true
-  realtime.terminate()
-  // disconnect all socket.io clients
-  Object.keys(io.sockets.sockets).forEach(function (key) {
-    var socket = io.sockets.sockets[key]
-    // notify client server going into maintenance status
-    socket.emit('maintenance')
-    setTimeout(function () {
-      socket.disconnect(true)
-    }, 0)
-  })
-  var checkCleanTimer = setInterval(function () {
-    if (realtime.isReady()) {
-      models.Revision.checkAllNotesRevision(function (err, notes) {
-        if (err) return logger.error(err)
-        if (!notes || notes.length <= 0) {
-          clearInterval(checkCleanTimer)
-          return process.exit(0)
-        }
-      })
-    }
-  }, 100)
-  setTimeout(() => {
-    process.exit(1)
-  }, 5000)
-}
-process.on('SIGINT', handleTermSignals)
-process.on('SIGTERM', handleTermSignals)
-process.on('SIGQUIT', handleTermSignals)
+require('./dist/app.js')