| 1 |
var expect; |
| 2 |
|
| 3 |
expect = require("expect.js"); |
| 4 |
|
| 5 |
describe("Corser", function () { |
| 6 |
|
| 7 |
var corser, req, res; |
| 8 |
|
| 9 |
beforeEach(function () { |
| 10 |
corser = require("../lib/corser"); |
| 11 |
// Prepare mocks. |
| 12 |
req = { |
| 13 |
headers: {} |
| 14 |
}; |
| 15 |
res = { |
| 16 |
setHeader: function (name, value) { |
| 17 |
this.headers[name.toLowerCase()] = value; |
| 18 |
}, |
| 19 |
headers: {}, |
| 20 |
writeHead: function (status) { |
| 21 |
this.status = status; |
| 22 |
}, |
| 23 |
status: null, |
| 24 |
end: function () { |
| 25 |
this.ended = true; |
| 26 |
}, |
| 27 |
ended: false |
| 28 |
}; |
| 29 |
}); |
| 30 |
|
| 31 |
it("should not add any headers if the \"Origin\" header is not present in the request", function (done) { |
| 32 |
var requestListener; |
| 33 |
requestListener = corser.create(); |
| 34 |
requestListener(req, res, function () { |
| 35 |
expect(Object.keys(res.headers).length).to.equal(0); |
| 36 |
done(); |
| 37 |
}); |
| 38 |
}); |
| 39 |
|
| 40 |
it("should not add any headers if the given origin does not match one of the origins in the list of origins", function (done) { |
| 41 |
var requestListener, origins; |
| 42 |
origins = ["example.com"]; |
| 43 |
// Test with array. |
| 44 |
requestListener = corser.create({ |
| 45 |
origins: origins |
| 46 |
}); |
| 47 |
req.headers["origin"] = "fake.com"; |
| 48 |
requestListener(req, res, function () { |
| 49 |
expect(Object.keys(res.headers).length).to.equal(0); |
| 50 |
// Test with function. |
| 51 |
requestListener = corser.create({ |
| 52 |
origins: function (originHeader, callback) { |
| 53 |
callback(null, origins.indexOf(originHeader) !== -1); |
| 54 |
} |
| 55 |
}); |
| 56 |
requestListener(req, res, function () { |
| 57 |
expect(Object.keys(res.headers).length).to.equal(0); |
| 58 |
done(); |
| 59 |
}); |
| 60 |
}); |
| 61 |
}); |
| 62 |
|
| 63 |
it("should support passing a function as origins and it should work both synchronously and asynchronously", function (done) { |
| 64 |
var requestListener, origins; |
| 65 |
origins = ["example.com"]; |
| 66 |
// Test with asynchronous function. |
| 67 |
requestListener = corser.create({ |
| 68 |
origins: function (originHeader, callback) { |
| 69 |
process.nextTick(function() { |
| 70 |
callback(null, origins.indexOf(originHeader) !== -1); |
| 71 |
}); |
| 72 |
} |
| 73 |
}); |
| 74 |
req.headers["origin"] = "fake.com"; |
| 75 |
requestListener(req, res, function () { |
| 76 |
expect(Object.keys(res.headers).length).to.equal(0); |
| 77 |
req.headers["origin"] = "example.com"; |
| 78 |
requestListener(req, res, function () { |
| 79 |
expect(Object.keys(res.headers).length).to.equal(1); |
| 80 |
// Test with synchronous function. |
| 81 |
requestListener = corser.create({ |
| 82 |
origins: function (originHeader, callback) { |
| 83 |
callback(null, origins.indexOf(originHeader) !== -1); |
| 84 |
} |
| 85 |
}); |
| 86 |
res.headers = {}; |
| 87 |
requestListener(req, res, function () { |
| 88 |
expect(Object.keys(res.headers).length).to.equal(1); |
| 89 |
req.headers["origin"] = "fake.com"; |
| 90 |
res.headers = {}; |
| 91 |
requestListener(req, res, function () { |
| 92 |
expect(Object.keys(res.headers).length).to.equal(0); |
| 93 |
done(); |
| 94 |
}); |
| 95 |
}); |
| 96 |
}); |
| 97 |
}); |
| 98 |
}); |
| 99 |
|
| 100 |
it("should not accept any non-boolean value as the second parameter of an match origin callback", function (done) { |
| 101 |
var requestListener; |
| 102 |
req.headers["origin"] = "example.com"; |
| 103 |
// Test undefined. |
| 104 |
requestListener = corser.create({ |
| 105 |
origins: function (originHeader, callback) { |
| 106 |
callback(null); |
| 107 |
} |
| 108 |
}); |
| 109 |
requestListener(req, res, function () { |
| 110 |
expect(Object.keys(res.headers).length).to.equal(0); |
| 111 |
// Test null. |
| 112 |
requestListener = corser.create({ |
| 113 |
origins: function (originHeader, callback) { |
| 114 |
callback(null, null); |
| 115 |
} |
| 116 |
}); |
| 117 |
requestListener(req, res, function () { |
| 118 |
expect(Object.keys(res.headers).length).to.equal(0); |
| 119 |
// Test number. |
| 120 |
requestListener = corser.create({ |
| 121 |
origins: function (originHeader, callback) { |
| 122 |
callback(null, 4711); |
| 123 |
} |
| 124 |
}); |
| 125 |
requestListener(req, res, function () { |
| 126 |
expect(Object.keys(res.headers).length).to.equal(0); |
| 127 |
// Test string. |
| 128 |
requestListener = corser.create({ |
| 129 |
origins: function (originHeader, callback) { |
| 130 |
callback(null, "test"); |
| 131 |
} |
| 132 |
}); |
| 133 |
requestListener(req, res, function () { |
| 134 |
expect(Object.keys(res.headers).length).to.equal(0); |
| 135 |
done(); |
| 136 |
}); |
| 137 |
}); |
| 138 |
}); |
| 139 |
}); |
| 140 |
}); |
| 141 |
|
| 142 |
it("should expose errors encountered in the match origin callback", function (done) { |
| 143 |
var requestListener; |
| 144 |
requestListener = corser.create({ |
| 145 |
origins: function (originHeader, callback) { |
| 146 |
callback({ |
| 147 |
message: "Something went wrong!", |
| 148 |
status: 500 |
| 149 |
}); |
| 150 |
} |
| 151 |
}); |
| 152 |
req.headers["origin"] = "example.com"; |
| 153 |
requestListener(req, res, function (err) { |
| 154 |
expect(err).to.not.be(undefined); |
| 155 |
done(); |
| 156 |
}); |
| 157 |
}); |
| 158 |
|
| 159 |
it("should not add any headers if the given origin is not a case-sentitive match of one of the origins in the list of origins", function (done) { |
| 160 |
var requestListener; |
| 161 |
requestListener = corser.create({ |
| 162 |
origins: ["example.com"] |
| 163 |
}); |
| 164 |
req.headers["origin"] = "eXaMpLe.cOm"; |
| 165 |
requestListener(req, res, function () { |
| 166 |
expect(Object.keys(res.headers).length).to.equal(0); |
| 167 |
done(); |
| 168 |
}); |
| 169 |
}); |
| 170 |
|
| 171 |
describe("An actual request", function () { |
| 172 |
|
| 173 |
it("should add an Access-Control-Allow-Origin header of \"*\" for any given origin if the list of origins in unbound", function (done) { |
| 174 |
var requestListener; |
| 175 |
requestListener = corser.create(); |
| 176 |
req.headers["origin"] = "example.org"; |
| 177 |
requestListener(req, res, function () { |
| 178 |
expect(res.headers["access-control-allow-origin"]).to.equal("*"); |
| 179 |
done(); |
| 180 |
}); |
| 181 |
}); |
| 182 |
|
| 183 |
it("should add an Access-Control-Allow-Origin header of \"example.com\" if the given origin matches one of the origins in the list of origins", function (done) { |
| 184 |
var requestListener; |
| 185 |
requestListener = corser.create({ |
| 186 |
origins: ["example.com"] |
| 187 |
}); |
| 188 |
req.headers["origin"] = "example.com"; |
| 189 |
requestListener(req, res, function () { |
| 190 |
expect(res.headers["access-control-allow-origin"]).to.equal("example.com"); |
| 191 |
done(); |
| 192 |
}); |
| 193 |
}); |
| 194 |
|
| 195 |
it("should add an Access-Control-Allow-Origin header of \"example.com\" and an Access-Control-Allow-Credentials header of \"true\" if credentials are supported and the list of origins in unbound", function (done) { |
| 196 |
var requestListener; |
| 197 |
requestListener = corser.create({ |
| 198 |
supportsCredentials: true |
| 199 |
}); |
| 200 |
req.headers["origin"] = "example.com"; |
| 201 |
requestListener(req, res, function () { |
| 202 |
expect(res.headers["access-control-allow-origin"]).to.equal("example.com"); |
| 203 |
expect(res.headers["access-control-allow-credentials"]).to.equal("true"); |
| 204 |
done(); |
| 205 |
}); |
| 206 |
}); |
| 207 |
|
| 208 |
it("should add an Access-Control-Allow-Origin header of \"example.com\" and an Access-Control-Allow-Credentials header of \"true\" if credentials are supported and the given origin matches one of the origins in the list of origins", function (done) { |
| 209 |
var requestListener, origins; |
| 210 |
origins = ["example.com"]; |
| 211 |
// Test with array. |
| 212 |
requestListener = corser.create({ |
| 213 |
origins: origins, |
| 214 |
supportsCredentials: true |
| 215 |
}); |
| 216 |
req.headers["origin"] = "example.com"; |
| 217 |
requestListener(req, res, function () { |
| 218 |
expect(res.headers["access-control-allow-origin"]).to.equal("example.com"); |
| 219 |
expect(res.headers["access-control-allow-credentials"]).to.equal("true"); |
| 220 |
// Test with function. |
| 221 |
requestListener = corser.create({ |
| 222 |
origins: function (origin, callback) { |
| 223 |
callback(null, origins.indexOf(origin) !== -1); |
| 224 |
}, |
| 225 |
supportsCredentials: true |
| 226 |
}); |
| 227 |
res.headers = {}; |
| 228 |
requestListener(req, res, function () { |
| 229 |
expect(res.headers["access-control-allow-origin"]).to.equal("example.com"); |
| 230 |
expect(res.headers["access-control-allow-credentials"]).to.equal("true"); |
| 231 |
done(); |
| 232 |
}); |
| 233 |
}); |
| 234 |
}); |
| 235 |
|
| 236 |
it("should not add an Access-Control-Allow-Headers header if there are no response headers to expose", function (done) { |
| 237 |
var requestListener; |
| 238 |
requestListener = corser.create(); |
| 239 |
req.headers["origin"] = "example.com"; |
| 240 |
requestListener(req, res, function () { |
| 241 |
expect(res.headers["access-control-allow-headers"]).to.equal(undefined); |
| 242 |
done(); |
| 243 |
}); |
| 244 |
}); |
| 245 |
|
| 246 |
it("should add an Access-Control-Expose-Headers header with all the exposed response headers if there are response headers to expose", function (done) { |
| 247 |
var requestListener; |
| 248 |
requestListener = corser.create({ |
| 249 |
responseHeaders: corser.simpleResponseHeaders.concat(["X-Corser"]) |
| 250 |
}); |
| 251 |
req.headers["origin"] = "example.com"; |
| 252 |
requestListener(req, res, function () { |
| 253 |
expect(res.headers["access-control-expose-headers"]).to.equal("x-corser"); |
| 254 |
done(); |
| 255 |
}); |
| 256 |
}); |
| 257 |
|
| 258 |
}); |
| 259 |
|
| 260 |
describe("A preflight request", function () { |
| 261 |
|
| 262 |
beforeEach(function () { |
| 263 |
req.method = "OPTIONS"; |
| 264 |
}); |
| 265 |
|
| 266 |
it("should not add any headers if an Access-Control-Request-Method header is not present in the request", function (done) { |
| 267 |
var requestListener; |
| 268 |
requestListener = corser.create({ |
| 269 |
endPreflightRequests: false |
| 270 |
}); |
| 271 |
req.headers["origin"] = "example.com"; |
| 272 |
requestListener(req, res, function () { |
| 273 |
expect(Object.keys(res.headers).length).to.equal(0); |
| 274 |
done(); |
| 275 |
}); |
| 276 |
}); |
| 277 |
|
| 278 |
it("should not add any headers if the Access-Control-Request-Method header contains a non-simple method", function (done) { |
| 279 |
var requestListener; |
| 280 |
requestListener = corser.create({ |
| 281 |
endPreflightRequests: false |
| 282 |
}); |
| 283 |
req.headers["origin"] = "example.com"; |
| 284 |
req.headers["access-control-request-method"] = "PUT"; |
| 285 |
requestListener(req, res, function () { |
| 286 |
expect(Object.keys(res.headers).length).to.equal(0); |
| 287 |
done(); |
| 288 |
}); |
| 289 |
}); |
| 290 |
|
| 291 |
it("should not add any headers if the Access-Control-Request-Headers header contains a non-simple request header", function (done) { |
| 292 |
var requestListener; |
| 293 |
requestListener = corser.create({ |
| 294 |
endPreflightRequests: false |
| 295 |
}); |
| 296 |
req.headers["origin"] = "example.com"; |
| 297 |
req.headers["access-control-request-method"] = "GET"; |
| 298 |
req.headers["access-control-request-headers"] = "X-Corser"; |
| 299 |
requestListener(req, res, function () { |
| 300 |
expect(Object.keys(res.headers).length).to.equal(0); |
| 301 |
done(); |
| 302 |
}); |
| 303 |
}); |
| 304 |
|
| 305 |
it("should add an Access-Control-Allow-Origin header of \"*\" for any given origin if the list of origins in unbound", function (done) { |
| 306 |
var requestListener; |
| 307 |
requestListener = corser.create({ |
| 308 |
endPreflightRequests: false |
| 309 |
}); |
| 310 |
req.headers["origin"] = "example.org"; |
| 311 |
req.headers["access-control-request-method"] = "GET"; |
| 312 |
requestListener(req, res, function () { |
| 313 |
expect(res.headers["access-control-allow-origin"]).to.equal("*"); |
| 314 |
done(); |
| 315 |
}); |
| 316 |
}); |
| 317 |
|
| 318 |
it("should add an Access-Control-Allow-Origin header of \"example.com\" if the given origin matches one of the origins in the list of origins", function (done) { |
| 319 |
var requestListener; |
| 320 |
requestListener = corser.create({ |
| 321 |
origins: ["example.com"], |
| 322 |
endPreflightRequests: false |
| 323 |
}); |
| 324 |
req.headers["origin"] = "example.com"; |
| 325 |
req.headers["access-control-request-method"] = "GET"; |
| 326 |
requestListener(req, res, function () { |
| 327 |
expect(res.headers["access-control-allow-origin"]).to.equal("example.com"); |
| 328 |
done(); |
| 329 |
}); |
| 330 |
}); |
| 331 |
|
| 332 |
it("should add an Access-Control-Allow-Origin header of \"example.com\" and an Access-Control-Allow-Credentials header of \"true\" if credentials are supported and the list of origins in unbound", function (done) { |
| 333 |
var requestListener; |
| 334 |
requestListener = corser.create({ |
| 335 |
supportsCredentials: true, |
| 336 |
endPreflightRequests: false |
| 337 |
}); |
| 338 |
req.headers["origin"] = "example.com"; |
| 339 |
req.headers["access-control-request-method"] = "GET"; |
| 340 |
requestListener(req, res, function () { |
| 341 |
expect(res.headers["access-control-allow-origin"]).to.equal("example.com"); |
| 342 |
expect(res.headers["access-control-allow-credentials"]).to.equal("true"); |
| 343 |
done(); |
| 344 |
}); |
| 345 |
}); |
| 346 |
|
| 347 |
it("should add an Access-Control-Allow-Origin header of \"example.com\" and an Access-Control-Allow-Credentials header of \"true\" if credentials are supported and the given origin matches one of the origins in the list of origins", function (done) { |
| 348 |
var requestListener; |
| 349 |
requestListener = corser.create({ |
| 350 |
origins: ["example.com"], |
| 351 |
supportsCredentials: true, |
| 352 |
endPreflightRequests: false |
| 353 |
}); |
| 354 |
req.headers["origin"] = "example.com"; |
| 355 |
req.headers["access-control-request-method"] = "GET"; |
| 356 |
requestListener(req, res, function () { |
| 357 |
expect(res.headers["access-control-allow-origin"]).to.equal("example.com"); |
| 358 |
expect(res.headers["access-control-allow-credentials"]).to.equal("true"); |
| 359 |
done(); |
| 360 |
}); |
| 361 |
}); |
| 362 |
|
| 363 |
it("should add an Access-Control-Allow-Origin header even though Origin was not added to the list of request headers", function (done) { |
| 364 |
var requestListener; |
| 365 |
requestListener = corser.create({ |
| 366 |
endPreflightRequests: false |
| 367 |
}); |
| 368 |
req.headers["origin"] = "example.com"; |
| 369 |
req.headers["access-control-request-method"] = "GET"; |
| 370 |
req.headers["access-control-request-headers"] = "Origin"; |
| 371 |
requestListener(req, res, function () { |
| 372 |
expect(res.headers["access-control-allow-origin"]).not.to.equal(undefined); |
| 373 |
done(); |
| 374 |
}); |
| 375 |
}); |
| 376 |
|
| 377 |
it("should add an Access-Control-Max-Age header of \"50\" if maxAge is set", function (done) { |
| 378 |
var requestListener; |
| 379 |
requestListener = corser.create({ |
| 380 |
maxAge: 50, |
| 381 |
endPreflightRequests: false |
| 382 |
}); |
| 383 |
req.headers["origin"] = "example.com"; |
| 384 |
req.headers["access-control-request-method"] = "GET"; |
| 385 |
requestListener(req, res, function () { |
| 386 |
expect(res.headers["access-control-max-age"]).to.equal(50); |
| 387 |
done(); |
| 388 |
}); |
| 389 |
}); |
| 390 |
|
| 391 |
it("should add an Access-Control-Allow-Methods header with all methods that are in the list of methods", function (done) { |
| 392 |
var requestListener; |
| 393 |
requestListener = corser.create({ |
| 394 |
endPreflightRequests: false |
| 395 |
}); |
| 396 |
req.headers["origin"] = "example.com"; |
| 397 |
req.headers["access-control-request-method"] = "GET"; |
| 398 |
requestListener(req, res, function () { |
| 399 |
expect(res.headers["access-control-allow-methods"]).to.equal(corser.simpleMethods.join(",")); |
| 400 |
done(); |
| 401 |
}); |
| 402 |
}); |
| 403 |
|
| 404 |
it("should add an Access-Control-Allow-Headers header with all request headers that are in the list of request headers", function (done) { |
| 405 |
var requestListener; |
| 406 |
requestListener = corser.create({ |
| 407 |
endPreflightRequests: false |
| 408 |
}); |
| 409 |
req.headers["origin"] = "example.com"; |
| 410 |
req.headers["access-control-request-method"] = "GET"; |
| 411 |
requestListener(req, res, function () { |
| 412 |
expect(res.headers["access-control-allow-headers"]).to.equal(corser.simpleRequestHeaders.join(",")); |
| 413 |
done(); |
| 414 |
}); |
| 415 |
}); |
| 416 |
|
| 417 |
it("should add an Access-Control-Allow-Headers header that includes x-corser even though the name of the header in the Access-Control-Request-Headers header is not a case-sensitive match", function (done) { |
| 418 |
var requestListener, requestHeaders; |
| 419 |
requestHeaders = corser.simpleRequestHeaders.concat(["x-corser"]); |
| 420 |
requestListener = corser.create({ |
| 421 |
requestHeaders: requestHeaders, |
| 422 |
endPreflightRequests: false |
| 423 |
}); |
| 424 |
req.headers["origin"] = "example.com"; |
| 425 |
req.headers["access-control-request-method"] = "GET"; |
| 426 |
req.headers["access-control-request-headers"] = "X-Corser"; |
| 427 |
requestListener(req, res, function () { |
| 428 |
expect(res.headers["access-control-allow-headers"]).to.eql(requestHeaders.join(",")); |
| 429 |
done(); |
| 430 |
}); |
| 431 |
}); |
| 432 |
|
| 433 |
it("should end preflight requests by default", function () { |
| 434 |
var requestListener; |
| 435 |
requestListener = corser.create(); |
| 436 |
req.headers["origin"] = "example.org"; |
| 437 |
req.headers["access-control-request-method"] = "GET"; |
| 438 |
requestListener(req, res); |
| 439 |
expect(res.status).to.be(204); |
| 440 |
expect(res.ended).to.be(true); |
| 441 |
}); |
| 442 |
|
| 443 |
}); |
| 444 |
|
| 445 |
}); |