Merge pull request #1439 from hackmdio/release/2.0.0

Release 2.0.0

Author: Yukaii

.gitignore

@@ -1,5 +1,4 @@
 node_modules
-package-lock.json
 composer.phar
 composer.lock
 .env.*.php

.travis.yml

@@ -7,7 +7,7 @@ node_js:
   - "12"
 
 dist: xenial
-cache: yarn
+cache: npm
 
 matrix:
   fast_finish: true
@@ -19,8 +19,8 @@ matrix:
     - node_js: "12"
 
 script:
-  - yarn test:ci
-  - yarn build
+  - npm run test:ci
+  - npm run build
 
 jobs:
   include:

Procfile

@@ -0,0 +1 @@
+web: ./bin/heroku_start.sh

README.md

@@ -44,7 +44,7 @@ HackMD team is committed to keep CodiMD open source. All contributions are welco
 You would find all documentation here: [CodiMD Documentation](https://hackmd.io/c/codimd-documentation)
 
 ### Deployment
-If you want to spin up an instance and start using immediately, see [Docker deployment](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-documentation#Deployment).
+If you want to spin up an instance and start using immediately, see [Docker deployment](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-docker-deployment).
 If you want to contribute to the project, start with [manual deployment](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-manual-deployment).
 
 ### Configuration

app.js

@@ -24,6 +24,9 @@ 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) {
@@ -66,7 +69,7 @@ io.engine.ws = new (require('ws').Server)({
 })
 
 // others
-var realtime = require('./lib/realtime.js')
+var realtime = require('./lib/realtime/realtime.js')
 
 // assign socket io to realtime
 realtime.io = io
@@ -153,7 +156,7 @@ server.on('resumeSession', function (id, cb) {
 })
 
 // middleware which blocks requests when we're too busy
-app.use(require('./lib/web/middleware/tooBusy'))
+app.use(require('./lib/middleware/tooBusy'))
 
 app.use(flash())
 
@@ -162,10 +165,15 @@ app.use(passport.initialize())
 app.use(passport.session())
 
 // check uri is valid before going further
-app.use(require('./lib/web/middleware/checkURIValid'))
+app.use(require('./lib/middleware/checkURIValid'))
 // redirect url without trailing slashes
-app.use(require('./lib/web/middleware/redirectWithoutTrailingSlashes'))
-app.use(require('./lib/web/middleware/codiMDVersion'))
+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
@@ -186,6 +194,7 @@ app.locals.authProviders = {
   facebook: config.isFacebookEnable,
   twitter: config.isTwitterEnable,
   github: config.isGitHubEnable,
+  bitbucket: config.isBitbucketEnable,
   gitlab: config.isGitLabEnable,
   mattermost: config.isMattermostEnable,
   dropbox: config.isDropboxEnable,
@@ -199,23 +208,21 @@ app.locals.authProviders = {
   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/web/baseRouter'))
-app.use(require('./lib/web/statusRouter'))
-app.use(require('./lib/web/auth'))
-app.use(require('./lib/web/historyRouter'))
-app.use(require('./lib/web/userRouter'))
-app.use(require('./lib/web/imageRouter'))
-app.use(require('./lib/web/noteRouter'))
+app.use(require('./lib/routes').router)
 
 // response not found if no any route matxches
 app.get('*', function (req, res) {
-  response.errorNotFound(res)
+  response.errorNotFound(req, res)
 })
 
 // socket.io secure

app.json

@@ -15,124 +15,132 @@
             "description": "Let npm also install development build tool",
             "value": "false"
         },
-        "HMD_SESSION_SECRET": {
+        "CMD_SESSION_SECRET": {
             "description": "Secret used to secure session cookies.",
             "required": false
         },
-        "HMD_HSTS_ENABLE": {
+        "CMD_HSTS_ENABLE": {
             "description": "whether to also use HSTS if HTTPS is enabled",
             "required": false
         },
-        "HMD_HSTS_MAX_AGE": {
+        "CMD_HSTS_MAX_AGE": {
             "description": "max duration, in seconds, to tell clients to keep HSTS status",
             "required": false
         },
-        "HMD_HSTS_INCLUDE_SUBDOMAINS": {
+        "CMD_HSTS_INCLUDE_SUBDOMAINS": {
             "description": "whether to tell clients to also regard subdomains as HSTS hosts",
             "required": false
         },
-        "HMD_HSTS_PRELOAD": {
+        "CMD_HSTS_PRELOAD": {
             "description": "whether to allow at all adding of the site to HSTS preloads (e.g. in browsers)",
             "required": false
         },
-        "HMD_DOMAIN": {
+        "CMD_DOMAIN": {
             "description": "domain name",
             "required": false
         },
-        "HMD_URL_PATH": {
+        "CMD_URL_PATH": {
             "description": "sub url path, like `www.example.com/<URL_PATH>`",
             "required": false
         },
-        "HMD_ALLOW_ORIGIN": {
+        "CMD_ALLOW_ORIGIN": {
             "description": "domain name whitelist (use comma to separate)",
             "required": false,
             "value": "localhost"
         },
-        "HMD_PROTOCOL_USESSL": {
+        "CMD_PROTOCOL_USESSL": {
             "description": "set to use ssl protocol for resources path (only applied when domain is set)",
             "required": false
         },
-        "HMD_URL_ADDPORT": {
+        "CMD_URL_ADDPORT": {
             "description": "set to add port on callback url (port 80 or 443 won't applied) (only applied when domain is set)",
             "required": false
         },
-        "HMD_FACEBOOK_CLIENTID": {
+        "CMD_FACEBOOK_CLIENTID": {
             "description": "Facebook API client id",
             "required": false
         },
-        "HMD_FACEBOOK_CLIENTSECRET": {
+        "CMD_FACEBOOK_CLIENTSECRET": {
             "description": "Facebook API client secret",
             "required": false
         },
-        "HMD_TWITTER_CONSUMERKEY": {
+        "CMD_TWITTER_CONSUMERKEY": {
             "description": "Twitter API consumer key",
             "required": false
         },
-        "HMD_TWITTER_CONSUMERSECRET": {
+        "CMD_TWITTER_CONSUMERSECRET": {
             "description": "Twitter API consumer secret",
             "required": false
         },
-        "HMD_GITHUB_CLIENTID": {
+        "CMD_GITHUB_CLIENTID": {
             "description": "GitHub API client id",
             "required": false
         },
-        "HMD_GITHUB_CLIENTSECRET": {
+        "CMD_GITHUB_CLIENTSECRET": {
             "description": "GitHub API client secret",
             "required": false
         },
-        "HMD_GITLAB_BASEURL": {
+        "CMD_BITBUCKET_CLIENTID": {
+            "description": "Bitbucket API client id",
+            "required": false
+        },
+        "CMD_BITBUCKET_CLIENTSECRET": {
+            "description": "Bitbucket API client secret",
+            "required": false
+        },
+        "CMD_GITLAB_BASEURL": {
             "description": "GitLab authentication endpoint, set to use other endpoint than GitLab.com (optional)",
             "required": false
         },
-        "HMD_GITLAB_CLIENTID": {
+        "CMD_GITLAB_CLIENTID": {
             "description": "GitLab API client id",
             "required": false
         },
-        "HMD_GITLAB_CLIENTSECRET": {
+        "CMD_GITLAB_CLIENTSECRET": {
             "description": "GitLab API client secret",
             "required": false
         },
-        "HMD_GITLAB_SCOPE": {
+        "CMD_GITLAB_SCOPE": {
             "description": "GitLab API client scope (optional)",
             "required": false
         },
-        "HMD_MATTERMOST_BASEURL": {
+        "CMD_MATTERMOST_BASEURL": {
             "description": "Mattermost authentication endpoint",
             "required": false
         },
-        "HMD_MATTERMOST_CLIENTID": {
+        "CMD_MATTERMOST_CLIENTID": {
             "description": "Mattermost API client id",
             "required": false
         },
-        "HMD_MATTERMOST_CLIENTSECRET": {
+        "CMD_MATTERMOST_CLIENTSECRET": {
             "description": "Mattermost API client secret",
             "required": false
         },
-        "HMD_DROPBOX_CLIENTID": {
+        "CMD_DROPBOX_CLIENTID": {
             "description": "Dropbox API client id",
             "required": false
         },
-        "HMD_DROPBOX_CLIENTSECRET": {
+        "CMD_DROPBOX_CLIENTSECRET": {
             "description": "Dropbox API client secret",
             "required": false
         },
-        "HMD_DROPBOX_APP_KEY": {
+        "CMD_DROPBOX_APP_KEY": {
             "description": "Dropbox app key (for import/export)",
             "required": false
         },
-        "HMD_GOOGLE_CLIENTID": {
+        "CMD_GOOGLE_CLIENTID": {
             "description": "Google API client id",
             "required": false
         },
-        "HMD_GOOGLE_CLIENTSECRET": {
+        "CMD_GOOGLE_CLIENTSECRET": {
             "description": "Google API client secret",
             "required": false
         },
-        "HMD_IMGUR_CLIENTID": {
+        "CMD_IMGUR_CLIENTID": {
             "description": "Imgur API client id",
             "required": false
         },
-        "HMD_ALLOW_PDF_EXPORT": {
+        "CMD_ALLOW_PDF_EXPORT": {
             "description": "Enable or disable PDF exports",
             "required": false
         }

bin/heroku

@@ -4,17 +4,7 @@ set -e
 
 if [ ! -z "$DYNO" ]; then
   # setup config files
-  cat << EOF > .sequelizerc
-var path = require('path');
-
-module.exports = {
-    'config':          path.resolve('config.json'),
-    'migrations-path': path.resolve('lib', 'migrations'),
-    'models-path':     path.resolve('lib', 'models'),
-    'url':             process.env.DATABASE_URL
-}
-
-EOF
+  cp .sequelizerc.example .sequelizerc
 
     cat << EOF > config.json
 

bin/heroku_start.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -euo pipefail
+
+CMD_DB_URL="$DATABASE_URL" CMD_PORT="$PORT" npm run start

bin/setup

@@ -8,12 +8,11 @@ if [ -d .git ]; then
   cd "$(git rev-parse --show-toplevel)"
 fi
 
-if ! type yarn > /dev/null
+if ! type npm > /dev/null
 then
   cat << EOF
-yarn is not installed, please install Node.js, npm and yarn.
+npm is not installed, please install Node.js and npm.
 Read more on Node.js official website: https://nodejs.org
-And for yarn package manager at: https://yarnpkg.com/en/
 Setup will not be run
 EOF
   exit 0
@@ -29,14 +28,13 @@ if [ ! -f .sequelizerc ]; then
 fi
 
 echo "install packages"
-yarn install --pure-lockfile
-yarn install --production=false --pure-lockfile
+npm install
 
 cat << EOF
 
 
 Edit the following config file to setup CodiMD server and client.
-Read more info at https://github.com/hackmdio/codimd#configuration-files
+Read more info at https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-configuration
 
 * config.json           -- CodiMD config
 * .sequelizerc          -- db config

deployments/Dockerfile

@@ -5,14 +5,13 @@ COPY --chown=hackmd:hackmd . .
 RUN set -xe && \
     git reset --hard && \
     git clean -fx && \
-    yarn install && \
-    yarn build && \
-    yarn install --production=true && \
+    npm install && \
+    npm run build && \
     cp ./deployments/docker-entrypoint.sh ./ && \
     cp .sequelizerc.example .sequelizerc && \
     rm -rf .git .gitignore .travis.yml .dockerignore .editorconfig .babelrc .mailmap .sequelizerc.example \
         test docs contribute \
-        yarn.lock webpack.prod.js webpack.htmlexport.js webpack.dev.js webpack.common.js \
+        package-lock.json webpack.prod.js webpack.htmlexport.js webpack.dev.js webpack.common.js \
         config.json.example README.md CONTRIBUTING.md AUTHORS
 
 FROM hackmdio/runtime:1.0.6