Merge branch 'release/1.4.0'

Author: johnwier

CHANGELOG.md

@@ -2,6 +2,11 @@
 Notable changes to the project
 
 ## [Unreleased]
+## [1.4.0] - 2020-12-1
+### Changed
+- Remove CMP v1 support
+- Reader should also check consent and optout
+- Add support to determine TLD for cookies
 
 ## [1.3.3] - 2020-07-27
 ### Changed

karma.conf.js

@@ -18,6 +18,7 @@ module.exports = (config) => {
         reporters: ['mocha', 'bamboo'],
 
         browsers: ['ChromeHeadlessNoSandbox'],
+        //browsers: ['Safari'],
         customLaunchers: {
             ChromeHeadlessNoSandbox: {
                 base: 'ChromeHeadless',

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "pubcid",
-  "version": "1.3.3",
+  "version": "1.4.0",
   "description": "Publisher Common ID",
   "scripts": {
     "lint": "eslint src/**/*.js",
@@ -34,6 +34,7 @@
     "karma-chrome-launcher": "^2.2.0",
     "karma-mocha": "^1.3.0",
     "karma-mocha-reporter": "^2.2.5",
+    "karma-safari-applescript-launcher": "^0.1.0",
     "karma-sauce-launcher": "^2.0.2",
     "karma-sourcemap-loader": "^0.3.7",
     "karma-webpack": "^4.0.2",

package.json

@@ -1,19 +1,15 @@
 import {Tcf} from "../drivers/tcf";
-import {Cmp} from "../drivers/cmp";
 import {LocalProxy} from "./localProxy";
 import {SafeFrameProxy} from "./safeFrameProxy";
 import {FrameProxy} from "./frameProxy";
 
 /**
- * Figure out which driver to use for the site.  TCF driver takes priority over CMP
+ * Create the driver to use for the site.
  * @returns {*}
  */
 export function createProxy() {
     let proxy;
     proxy = _createProxy(new Tcf());
-    if (!proxy) {
-        proxy = _createProxy(new Cmp());
-    }
     return proxy;
 }
 

src/lib/consenthandler/drivers/cmp.js

@@ -0,0 +1,2 @@
+export const COOKIE = 'cookie';
+export const LOCAL_STORAGE = 'html5';

src/lib/consenthandler/proxy/proxyFactory.js

@@ -2,19 +2,23 @@
  * Set a cookie
  * @param {string} name Name of the cookie
  * @param {string} value Value of the cookie
- * @param {number} expires Expiration interval in minutes
- * @param {string} domain Domain of the cookie
- * @param {string} path Path of the cookie.
- * @param {string} sameSite Strict, Lax, or None
+ * @param {number} [expires] Expiration interval in minutes
+ * @param {string} [domain] Domain of the cookie
+ * @param {string} [path] Path of the cookie.
+ * @param {string} [sameSite] Strict, Lax, or None
  */
 export function setCookie(name, value, expires, domain = '', path = '/', sameSite) {
-    if (name) {
-        const expTime = new Date();
-        expTime.setTime(expTime.getTime() + expires * 1000 * 60);
+   if (name) {
+        let expTime;
+        if (expires) {
+            expTime = new Date();
+            expTime.setTime(expTime.getTime() + expires * 1000 * 60);
+        }
+
         window.document.cookie = name + '=' + encodeURIComponent(value) +
             ';path=' + path +
             ((domain) ? ';domain=' + domain : '') +
-            ';expires=' + expTime.toUTCString() +
+            ((expTime) ? ';expires=' + expTime.toUTCString() : '') +
             ((sameSite) ? ';SameSite=' + sameSite : '');
     }
 }
@@ -33,21 +37,27 @@ export function getCookie(name) {
 }
 
 /**
- * Delete a cookie
+ * Delete a cookie.  Name, domain, and path all have to match in order to delete a cookie correctly.
+ * SameSite is optional.  Firefox complains if sameSite is omitted or None when the connection isn't secure.
  * @param {string} name Name of the cookie
+ * @param {string} [domain] Domain of the cookie
+ * @param {string} [path] Path of the cookie.
+ * @param {string} [sameSite] Strict, Lax, or None
  */
-export function delCookie(name) {
-    setCookie(name, '', -1);
+export function delCookie(name, domain, path, sameSite) {
+    setCookie(name, '', -1, domain, path, sameSite);
 }
 
 /**
- * Delete all cookies
+ * Delete all cookies.  This is a testing aid and shouldn't be used in production.
+ * @param {string} [domain] Domain of the cookie*
+ * @param {string} [path] Path of the cookie.
  */
-export function clearAllCookies() {
+export function clearAllCookies(domain, path) {
     document.cookie.split(';').forEach(s=>{
         const name = s.split('=')[0];
         if (name) {
-            delCookie(name);
+            delCookie(name.trim(), domain, path);
         }
     });
 }
@@ -58,4 +68,4 @@ export function clearAllCookies() {
  */
 export function isCookieSupported() {
     return (window.navigator.cookieEnabled || !!document.cookie.length);
-}
+}