chrome-devtools-frontend

// Copyright 2020 The Chromium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. import * as Protocol from '../../generated/protocol.js'; import {type CookieExpectation, expectCookie} from '../../testing/Cookies.js'; import * as SDK from './sdk.js'; function ensureCookiesExistOrFailTest(cookies: SDK.Cookie.Cookie[]|null): cookies is SDK.Cookie.Cookie[] { if (!cookies) { assert.fail('expected cookies to exist'); return false; } return true; } describe('CookieParser', () => { function parseAndExpectSetCookies(setCookieString: string, cookieExpectations: CookieExpectation[]) { const cookies = SDK.CookieParser.CookieParser.parseSetCookie(setCookieString); if (ensureCookiesExistOrFailTest(cookies)) { assert.lengthOf( cookies, cookieExpectations.length, 'Expected number of parsed cookies to agree with number of expected cookies'); for (let i = 0; i < cookieExpectations.length; ++i) { expectCookie(cookies[i], cookieExpectations[i]); } } } describe('parseSetCookie', () => { it('parses basic cookies', () => { parseAndExpectSetCookies('foo=bar', [{name: 'foo', value: 'bar', size: 7}]); }); it('recognises expires attribute', () => { parseAndExpectSetCookies( 'foo=bar; expires=Wed, 21 Oct 2015 07:28:00 GMT;', [{name: 'foo', value: 'bar', expires: '2015-10-21T07:28:00.000Z', session: false, size: 47}]); parseAndExpectSetCookies( 'foo=bar; expires=Wed, 21 Oct 2015 07:28:00 GMT;', [{name: 'foo', value: 'bar', expires: '2015-10-21T07:28:00.000Z', session: false, size: 47}]); }); it('handles multiple SetCookies separated by line breaks', () => { parseAndExpectSetCookies( `a=b c=d f`, [{name: 'a', value: 'b', size: 10}, {name: 'c', value: 'd', size: 10}, {name: '', value: 'f', size: 1}]); }); it('handles multiple SetCookies ending with value and no semicolon separated by line breaks', () => { parseAndExpectSetCookies( `a=b; Secure c=d; Secure f`, [ {name: 'a', value: 'b', size: 18, secure: true}, {name: 'c', value: 'd', size: 18, secure: true}, {name: '', value: 'f', size: 1}, ]); }); it('handles path and domain values ', () => { parseAndExpectSetCookies( 'cookie1 = value; Path=/; Domain=.example.com;', [{name: 'cookie1', value: 'value', path: '/', domain: '.example.com', size: 45}]); }); it('handles a domain value with leading spaces', () => { parseAndExpectSetCookies( 'cookie1 = value; Path=/; Domain= .example.com;', [{name: 'cookie1', value: 'value', path: '/', domain: '.example.com', size: 47}]); }); it('handles multiple cookies with path and domain values', () => { parseAndExpectSetCookies( `cookie1 = value; Path=/; Domain= .example.com Cookie2 = value2; Path = /foo; Domain = foo.example.com`, [ {name: 'cookie1', value: 'value', path: '/', domain: '.example.com', size: 53}, {name: 'Cookie2', value: 'value2', path: '/foo', domain: 'foo.example.com', size: 55}, ]); }); it('handles multiple cookies with an invalid attribute', () => { const stub = sinon.stub(console, 'error'); parseAndExpectSetCookies( `cookie1 = value; expires = Mon, Oct 18 2010 17:00 GMT+0000; Domain =.example.com Cookie2 = value2; Path = /foo; DOMAIN = foo.example.com; HttpOnly; Secure; Discard;`, [ {name: 'cookie1', value: 'value', expires: 1287421200000, domain: '.example.com', session: false, size: 89}, { name: 'Cookie2', value: 'value2', path: '/foo', domain: 'foo.example.com', httpOnly: true, secure: true, size: 83, }, ]); assert.isTrue(stub.calledOnceWithExactly('Failed getting cookie attribute: Discard')); }); it('handles multiple cookies with an invalid attribute', () => { const stub = sinon.stub(console, 'error'); parseAndExpectSetCookies( `cookie1 = value; max-age= 1440; Domain =.example.com Cookie2 = value2; Path = /foo; DOMAIN = foo.example.com; HttpOnly; Secure; Discard;`, [ {name: 'cookie1', value: 'value', expires: 1287422640000, domain: '.example.com', session: false, size: 61}, { name: 'Cookie2', value: 'value2', path: '/foo', domain: 'foo.example.com', httpOnly: true, secure: true, size: 83, }, ]); assert.isTrue(stub.calledOnceWithExactly('Failed getting cookie attribute: Discard')); }); describe('handles the SameSite attribute', () => { it('with value Lax', () => { parseAndExpectSetCookies('cookie1 = value; HttpOnly; Secure; SameSite=Lax', [{ name: 'cookie1', value: 'value', httpOnly: true, secure: true, sameSite: Protocol.Network.CookieSameSite.Lax, size: 47, }]); }); it('with value None', () => { parseAndExpectSetCookies('cookie1 = value; HttpOnly; Secure; SameSite=None', [{ name: 'cookie1', value: 'value', httpOnly: true, secure: true, sameSite: Protocol.Network.CookieSameSite.None, size: 48, }]); }); it('with value Strict', () => { parseAndExpectSetCookies('cookie1 = value; HttpOnly; Secure; SameSite=Strict', [{ name: 'cookie1', value: 'value', httpOnly: true, secure: true, sameSite: Protocol.Network.CookieSameSite.Strict, size: 50, }]); }); }); it('handles cookies without a name', () => { parseAndExpectSetCookies( 'cookie1; Path=/; Domain=.example.com;', [{name: '', value: 'cookie1', path: '/', domain: '.example.com', size: 37}]); }); it('handles cookies without a value', () => { parseAndExpectSetCookies( 'cookie1=; Path=/; Domain=.example.com;', [{name: 'cookie1', value: '', path: '/', domain: '.example.com', size: 38}]); }); it('handles cookies with whitespace in the name', () => { parseAndExpectSetCookies( ' cookie 1 =value1; Path=/; Domain=.example.com;', [{name: 'cookie 1', value: 'value1', path: '/', domain: '.example.com', size: 50}]); }); describe('it handles the priority attribute', () => { it('with value Low', () => { parseAndExpectSetCookies('cookie1=; Path=/; Domain=.example.com; Priority=Low', [{ name: 'cookie1', value: '', path: '/', domain: '.example.com', priority: Protocol.Network.CookiePriority.Low, size: 51, }]); }); it('with value Medium', () => { parseAndExpectSetCookies('cookie1=; Path=/; Domain=.example.com; Priority=Medium', [{ name: 'cookie1', value: '', path: '/', domain: '.example.com', priority: Protocol.Network.CookiePriority.Medium, size: 54, }]); }); it('with value High', () => { parseAndExpectSetCookies('cookie1=; Path=/; Domain=.example.com; Priority=High', [{ name: 'cookie1', value: '', path: '/', domain: '.example.com', priority: Protocol.Network.CookiePriority.High, size: 52, }]); }); }); }); });