forked from codecombat/codecombat
-
Notifications
You must be signed in to change notification settings - Fork 0
/
server_setup.coffee
464 lines (385 loc) · 17 KB
/
server_setup.coffee
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
express = require 'express'
path = require 'path'
authentication = require 'passport'
useragent = require 'express-useragent'
fs = require 'graceful-fs'
log = require 'winston'
compressible = require 'compressible'
compression = require 'compression'
geoip = require '@basicer/geoip-lite'
database = require './server/commons/database'
perfmon = require './server/commons/perfmon'
baseRoute = require './server/routes/base'
logging = require './server/commons/logging'
config = require './server_config'
auth = require './server/commons/auth'
routes = require './server/routes'
UserHandler = require './server/handlers/user_handler'
slack = require './server/slack'
Mandate = require './server/models/Mandate'
global.tv4 = require 'tv4' # required for TreemaUtils to work
global.jsondiffpatch = require 'jsondiffpatch'
global.stripe = require('stripe')(config.stripe.secretKey)
errors = require './server/commons/errors'
request = require 'request'
Promise = require 'bluebird'
Promise.promisifyAll(request, {multiArgs: true})
Promise.promisifyAll(fs)
wrap = require 'co-express'
codePlayTags = require './server/lib/code-play-tags'
morgan = require 'morgan'
{countries} = require './app/core/utils'
productionLogging = (tokens, req, res) ->
status = res.statusCode
color = 32
if status >= 500 then color = 31
else if status >= 400 then color = 33
else if status >= 300 then color = 36
elapsed = (new Date()) - req._startTime
elapsedColor = if elapsed < 500 then 90 else 31
return null if status is 404 and /\/feedback/.test req.originalUrl # We know that these usually 404 by design (bad design?)
if (status isnt 200 and status isnt 201 and status isnt 204 and status isnt 304 and status isnt 302) or elapsed > 500
return "\x1b[90m#{req.method} #{req.originalUrl} \x1b[#{color}m#{res.statusCode} \x1b[#{elapsedColor}m#{elapsed}ms\x1b[0m"
null
developmentLogging = (tokens, req, res) ->
status = res.statusCode
color = 32
if status >= 500 then color = 31
else if status >= 400 then color = 33
else if status >= 300 then color = 36
elapsed = (new Date()) - req._startTime
elapsedColor = if elapsed < 500 then 90 else 31
s = "\x1b[90m#{req.method} #{req.originalUrl} \x1b[#{color}m#{res.statusCode} \x1b[#{elapsedColor}m#{elapsed}ms\x1b[0m"
s += ' (proxied)' if req.proxied
return s
setupDomainFilterMiddleware = (app) ->
if config.isProduction
unsafePaths = [
/^\/web-dev-iframe\.html$/
/^\/javascripts\/web-dev-listener\.js$/
]
app.use (req, res, next) ->
domainRegex = new RegExp("(.*\.)?(#{config.mainHostname}|#{config.unsafeContentHostname})")
domainPrefix = req.host.match(domainRegex)?[1] or ''
if _.any(unsafePaths, (pathRegex) -> pathRegex.test(req.path)) and (req.host isnt domainPrefix + config.unsafeContentHostname)
res.redirect('//' + domainPrefix + config.unsafeContentHostname + req.path)
else if not _.any(unsafePaths, (pathRegex) -> pathRegex.test(req.path)) and req.host is domainPrefix + config.unsafeContentHostname
res.redirect('//' + domainPrefix + config.mainHostname + req.path)
else
next()
setupErrorMiddleware = (app) ->
app.use (err, req, res, next) ->
if err
if err.name is 'MongoError' and err.code is 11000
err = new errors.Conflict('MongoDB conflict error.')
if err.code is 422 and err.response
err = new errors.UnprocessableEntity(err.response)
if err.code is 409 and err.response
err = new errors.Conflict(err.response)
# TODO: Make all errors use this
if err instanceof errors.NetworkError
return res.status(err.code).send(err.toJSON())
if err.status and 400 <= err.status < 500
res.status(err.status).send("Error #{err.status}")
return
res.status(err.status ? 500).send(error: "Something went wrong!")
message = "Express error: #{req.method} #{req.path}: #{err.message} \n #{err.stack}"
log.error "#{message}, stack: #{err.stack}"
if global.testing
console.log "#{message}, stack: #{err.stack}"
slack.sendSlackMessage(message, ['ops'], {papertrail: true})
else
next(err)
setupExpressMiddleware = (app) ->
if config.isProduction
morgan.format('prod', productionLogging)
app.use(morgan('prod'))
app.use compression filter: (req, res) ->
return false if req.headers.host is 'codecombat.com' # CloudFlare will gzip it for us on codecombat.com
compressible res.getHeader('Content-Type')
else if not global.testing
morgan.format('dev', developmentLogging)
app.use(morgan('dev'))
public_path = path.join(__dirname, 'public')
app.use('/', express.static(path.join(public_path, 'templates', 'static')))
if config.buildInfo.sha isnt 'dev' and config.isProduction
app.use("/#{config.buildInfo.sha}", express.static(public_path, maxAge: '1y'))
else
app.use('/dev', express.static(public_path, maxAge: 0)) # CloudFlare overrides maxAge, and we don't want local development caching.
app.use(express.static(public_path, maxAge: 0))
if config.proxy
# Don't proxy static files with sha prefixes, redirect them
regex = /\/[0-9a-f]{40}\/.*/
app.use (req, res, next) ->
if regex.test(req.path)
newPath = req.path.slice(41)
return res.redirect(newPath)
next()
setupProxyMiddleware app # TODO: Flatten setup into one function. This doesn't fit its function name.
app.use require('serve-favicon') path.join(__dirname, 'public', 'images', 'favicon.ico')
app.use require('cookie-parser')()
app.use require('body-parser').json limit: '25mb'
app.use require('body-parser').urlencoded extended: true, limit: '25mb'
app.use require('method-override')()
app.use require('cookie-session')
key: 'codecombat.sess'
secret: config.cookie_secret
setupPassportMiddleware = (app) ->
app.use(authentication.initialize())
if config.picoCTF
app.use authentication.authenticate('local', failureRedirect: config.picoCTF_login_URL)
require('./server/lib/picoctf').init app
else
app.use(authentication.session())
auth.setup()
setupCountryTaggingMiddleware = (app) ->
app.use (req, res, next) ->
return next() if req.country or req.user?.get('country')
return next() unless ip = req.headers['x-forwarded-for'] or req.ip or req.connection.remoteAddress
ip = ip.split(/,? /)[0] # If there are two IP addresses, say because of CloudFlare, we just take the first.
geo = geoip.lookup(ip)
if countryInfo = _.find(countries, countryCode: geo?.country)
req.country = countryInfo.country
next()
setupCountryRedirectMiddleware = (app, country='china', host='cn.codecombat.com') ->
hosts = host.split /;/g
shouldRedirectToCountryServer = (req) ->
reqHost = (req.hostname ? req.host).toLowerCase() # Work around express 3.0
return req.country is country and reqHost not in hosts and reqHost.indexOf(config.unsafeContentHostname) is -1
app.use (req, res, next) ->
if shouldRedirectToCountryServer(req) and hosts.length
res.writeHead 302, "Location": 'http://' + hosts[0] + req.url
res.end()
else
next()
setupOneSecondDelayMiddleware = (app) ->
if(config.slow_down)
app.use((req, res, next) -> setTimeout((-> next()), 1000))
setupMiddlewareToSendOldBrowserWarningWhenPlayersViewLevelDirectly = (app) ->
isOldBrowser = (req) ->
# https://github.com/biggora/express-useragent/blob/master/lib/express-useragent.js
return false unless ua = req.useragent
return true if ua.isiPad or ua.isiPod or ua.isiPhone or ua.isOpera
return false unless ua and ua.Browser in ['Chrome', 'Safari', 'Firefox', 'IE'] and ua.Version
b = ua.Browser
try
v = parseInt ua.Version.split('.')[0], 10
catch TypeError
log.error('ua.Version does not have a split function.', JSON.stringify(ua, null, ' '))
return false
return true if b is 'Chrome' and v < 17
return true if b is 'Safari' and v < 6
return true if b is 'Firefox' and v < 21
return true if b is 'IE' and v < 11
false
app.use '/play/', useragent.express()
app.use '/play/', (req, res, next) ->
return next() if req.path?.indexOf('web-dev-level') >= 0
return next() if req.query['try-old-browser-anyway'] or not isOldBrowser req
res.sendfile(path.join(__dirname, 'public', 'index_old_browser.html'))
setupRedirectMiddleware = (app) ->
app.all '/account/profile/*', (req, res, next) ->
nameOrID = req.path.split('/')[3]
res.redirect 301, "/user/#{nameOrID}/profile"
setupFeaturesMiddleware = (app) ->
app.use (req, res, next) ->
# TODO: Share these defaults with run-tests.js
req.features = features = {
freeOnly: false
}
if req.headers.host is 'cp.codecombat.com' or req.session.featureMode is 'code-play'
features.freeOnly = true
features.campaignSlugs = ['dungeon', 'forest', 'desert']
features.playViewsOnly = true
features.codePlay = true # for one-off changes. If they're shared across different scenarios, refactor
if config.picoCTF or req.session.featureMode is 'pico-ctf'
features.playOnly = true
if req.user
{ user } = req
if user.get('country') in ['china'] and not (user.isPremium() or user.get('stripe'))
features.freeOnly = true
next()
setupSecureMiddleware = (app) ->
# Cannot use express request `secure` property in production, due to
# cluster setup.
isSecure = ->
return @secure or @headers['x-forwarded-proto'] is 'https'
app.use (req, res, next) ->
req.isSecure = isSecure
next()
setupPerfMonMiddleware = (app) ->
app.use perfmon.middleware
setupAPIDocs = (app) ->
# TODO: Move this into routes, so they're consolidated
YAML = require 'yamljs'
swaggerDoc = YAML.load('./server/swagger.yaml')
swaggerUi = require 'swagger-ui-express'
app.use('/', swaggerUi.serve)
app.use('/api-docs', swaggerUi.setup(swaggerDoc))
exports.setupMiddleware = (app) ->
setupSecureMiddleware app
setupPerfMonMiddleware app
setupDomainFilterMiddleware app
setupQuickBailToMainHTML app
setupCountryTaggingMiddleware app
setupMiddlewareToSendOldBrowserWarningWhenPlayersViewLevelDirectly app
setupExpressMiddleware app
setupAPIDocs app # should happen after serving static files, so we serve the right favicon
setupPassportMiddleware app
setupFeaturesMiddleware app
setupUserDataRoute app
setupCountryRedirectMiddleware app, 'china', config.chinaDomain
setupCountryRedirectMiddleware app, 'brazil', config.brazilDomain
setupOneSecondDelayMiddleware app
setupRedirectMiddleware app
setupAjaxCaching app
setupJavascript404s app
###Routing function implementations###
setupAjaxCaching = (app) ->
# IE/Edge are more aggressive about caching than other browsers, so we'll override their caching here.
# Assumes our CDN will override these with its own caching rules.
app.get '/db/*', (req, res, next) ->
return next() unless req.xhr
# http://stackoverflow.com/questions/19999388/check-if-user-is-using-ie-with-jquery
userAgent = req.header('User-Agent') or ""
if userAgent.indexOf('MSIE ') > 0 or !!userAgent.match(/Trident.*rv\:11\.|Edge\/\d+/)
res.header 'Cache-Control', 'no-cache, no-store, must-revalidate'
res.header 'Pragma', 'no-cache'
res.header 'Expires', 0
next()
setupJavascript404s = (app) ->
app.get '/javascripts/*', (req, res) ->
res.status(404).send('Not found')
app.get(/^\/?[a-f0-9]{40}/, (req, res) ->
res.status(404).send('Wrong hash')
)
templates = {}
getStaticTemplate = (file) ->
# Don't cache templates in devlopment so you can just edit then.
return templates[file] if templates[file] and config.isProduction
templates[file] = fs.readFileAsync(path.join(__dirname, 'public', 'templates', 'static', file), 'utf8')
renderMain = wrap (template, req, res) ->
template = yield getStaticTemplate(template)
if req.features.codePlay
template = template.replace '<!-- CodePlay Tags Header -->', codePlayTags.header
template = template.replace '<!-- CodePlay Tags Footer -->', codePlayTags.footer
res.status(200).send template
setupQuickBailToMainHTML = (app) ->
fast = (template) ->
(req, res, next) ->
req.features = features = {}
if config.isProduction or true
res.header 'Cache-Control', 'public, max-age=60'
res.header 'Expires', 60
else
res.header 'Cache-Control', 'no-cache, no-store, must-revalidate'
res.header 'Pragma', 'no-cache'
res.header 'Expires', 0
if req.headers.host is 'cp.codecombat.com'
features.codePlay = true # for one-off changes. If they're shared across different scenarios, refactor
renderMain(template, req, res)
app.get '/', fast('home.html')
app.get '/about', fast('about.html')
app.get '/privacy', fast('privacy.html')
app.get '/legal', fast('legal.html')
app.get '/play', fast('overworld.html')
app.get '/play/level/:slug', fast('main.html')
app.get '/play/:slug', fast('main.html')
# Mongo-cache doesnt support the .exec() promise, so we manually wrap it.
getMandate = (app) ->
return new Promise (res, rej) ->
Mandate.findOne({}).cache(5 * 60 * 1000).exec (err, data) ->
return rej(err) if err
res(data)
setupUserDataRoute = (app) ->
shouldRedirectToCountryServer = (req, country, host) ->
reqHost = (req.hostname ? req.host).toLowerCase() # Work around express 3.0
hosts = host.split /;/g
if req.country is country and reqHost not in hosts and reqHost.indexOf(config.unsafeContentHostname) is -1
hosts[0]
else
undefined
app.get '/user-data', wrap (req, res) ->
res.header 'Cache-Control', 'no-cache, no-store, must-revalidate'
res.header 'Pragma', 'no-cache'
res.header 'Expires', 0
targetDomain = undefined
targetDomain ?= shouldRedirectToCountryServer(req, 'china', config.chinaDomain)
targetDomain ?= shouldRedirectToCountryServer(req, 'brazil', config.brazilDomain)
redirect = "window.location = 'https://#{targetDomain}' + window.location.pathname;" if targetDomain
# IMPORTANT: If you edit here, make sure app/assets/javascripts/run-tests.js puts in placeholders for
# running client tests on Travis.
sst = JSON.stringify(_.pick(req.session ? {}, 'amActually', 'featureMode'))
formattedUser = if req.user then JSON.stringify(UserHandler.formatEntity(req, req.user)).replace(/\//g, '\\/') else '{}'
try
mandate = yield getMandate()
configData = _.omit mandate?.toObject() or {}, '_id'
catch err
log.error "Error getting mandate config: #{err}"
configData = {}
domainRegex = new RegExp("(.*\.)?(#{config.mainHostname}|#{config.unsafeContentHostname})")
domainPrefix = (req.hostname ? req.host).match(domainRegex)?[1] or ''
configData.picoCTF = config.picoCTF
configData.production = config.isProduction
configData.codeNinjas = (req.hostname ? req.host) is 'coco.code.ninja'
configData.fullUnsafeContentHostname = domainPrefix + config.unsafeContentHostname
configData.buildInfo = config.buildInfo
if not _.isString(formattedUser)
throw new Error('Error serving user: #{formattedUser}')
res.header 'Content-Type', 'application/javascript; charset=utf8'
res.send [
"window.serverConfig = #{JSON.stringify(configData)};"
"window.userObject = #{formattedUser};",
"window.serverSession = #{sst};",
"window.features = #{JSON.stringify(req.features)};"
"window.me = {"
"\tget: function(attribute) { return window.userObject[attribute]; }"
"};"
redirect or ''
].join "\n"
setupFallbackRouteToIndex = (app) ->
app.all '*', (req, res) =>
res.header 'Cache-Control', 'no-cache, no-store, must-revalidate'
res.header 'Pragma', 'no-cache'
res.header 'Expires', 0
renderMain 'main.html', req, res
setupFacebookCrossDomainCommunicationRoute = (app) ->
app.get '/channel.html', (req, res) ->
res.sendfile path.join(__dirname, 'public', 'channel.html')
setupUpdateBillingRoute = (app) ->
app.get '/update-billing', (req, res) ->
res.sendfile path.join(__dirname, 'public', 'update-billing.html')
exports.setupRoutes = (app) ->
routes.setup(app)
baseRoute.setup app
setupFacebookCrossDomainCommunicationRoute app
setupUpdateBillingRoute app
setupFallbackRouteToIndex app
setupErrorMiddleware app
###Miscellaneous configuration functions###
exports.setupLogging = ->
logging.setup()
exports.connectToDatabase = ->
return if config.proxy
database.connect()
exports.setExpressConfigurationOptions = (app) ->
app.set('port', config.port)
app.set('views', __dirname + '/app/views')
app.set('view engine', 'jade')
app.set('view options', { layout: false })
app.set('env', if config.isProduction then 'production' else 'development')
app.set('json spaces', 0) if config.isProduction
setupProxyMiddleware = (app) ->
return if config.isProduction
return unless config.proxy
httpProxy = require 'http-proxy'
proxy = httpProxy.createProxyServer({
target: 'https://very.direct.codecombat.com'
secure: false
})
log.info 'Using dev proxy server'
app.use (req, res, next) ->
req.proxied = true
proxy.web req, res, (e) ->
console.warn("Failed to proxy: ", e)
res.status(502).send({message: 'Proxy failed'})