Revert "Drop @segment/canonical. Also uprade some libs (#213)"

This reverts commit d4d70e3.

Author: juliofarah

HISTORY.md

@@ -9,9 +9,6 @@
 # 4.1.5 / 2020-09-20
 
 - Remove `@segment/canonical` in favor of `document.querySelector`
-
-# 4.1.5 / 2020-09-17
-
 - Replace @ndhoule/defaults with merging via ES6 spread syntax
 
 # 4.1.4 / 2020-09-16

karma.conf.ts

@@ -44,7 +44,6 @@ module.exports = function(config) {
         module: "commonjs",
         target: "ES5",
         allowJs: false,
-        esModuleInterop: true
       },
       include: ['test'],
       exclude: ['node_modules', 'lib', 'test-e2e/*.ts']

lib/analytics.ts

@@ -8,13 +8,11 @@ import {
   SegmentIntegration,
   PageDefaults
 } from './types';
-
-import { pageDefaults } from './pageDefaults';
-
-import cloneDeep from 'lodash.clonedeep';
-import pick from 'lodash.pick';
 var url = require('component-url');
 
+import cloneDeep from 'lodash.clonedeep'
+import pick from 'lodash.pick'
+
 var _analytics = global.analytics;
 
 /*
@@ -45,6 +43,7 @@ var memory = require('./memory');
 var nextTick = require('next-tick');
 var normalize = require('./normalize');
 var on = require('component-event').bind;
+var pageDefaults = require('./pageDefaults');
 var prevent = require('@segment/prevent-default');
 var store = require('./store');
 var user = require('./user');

lib/pageDefaults.ts

@@ -1,17 +1,32 @@
 import { PageDefaults } from './types';
 import includes from 'lodash.includes'
+import canonical from '@segment/canonical'
 import url from 'component-url'
 
+/**
+ * Return a default `options.context.page` object.
+ *
+ * https://segment.com/docs/spec/page/#properties
+ */
+
+function pageDefaults(): PageDefaults {
+  return {
+    path: canonicalPath(),
+    referrer: document.referrer,
+    search: location.search,
+    title: document.title,
+    url: canonicalUrl(location.search)
+  };
+}
+
 /**
  * Return the canonical path for the page.
  */
 
-const canonicalPath = (): string => {
-  const canon = document.querySelector("link[rel='canonical']")
+function canonicalPath(): string {
+  const canon = canonical();
   if (!canon) return window.location.pathname;
-  const href = canon.getAttribute("href")
-
-  const parsed = url.parse(href);
+  const parsed = url.parse(canon);
   return parsed.pathname;
 }
 
@@ -20,35 +35,16 @@ const canonicalPath = (): string => {
  * and strip the hash.
  */
 
-const canonicalUrl = (search: string): string => {
-  const canon = document.querySelector("link[rel='canonical']")
-  if (canon) {
-    const href = canon.getAttribute("href")
-    return includes(href, '?') ? href : href + search;
-  }
-
+function canonicalUrl(search: string): string {
+  const canon = canonical();
+  if (canon) return includes(canon, '?') ? canon : canon + search;
   const url = window.location.href;
   const i = url.indexOf('#');
   return i === -1 ? url : url.slice(0, i);
 }
 
-/**
- * Return a default `options.context.page` object.
- *
- * https://segment.com/docs/spec/page/#properties
+/*
+ * Exports.
  */
 
-export const pageDefaults = (): PageDefaults => {
-  const path = canonicalPath()
-  const { referrer, title } = document
-  const { search } = location
-  const url = canonicalUrl(search)
-
-  return {
-    path,
-    referrer,
-    search,
-    title,
-    url
-  };
-}
+module.exports = pageDefaults;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/analytics.js-core",
   "author": "Segment <friends@segment.com>",
-  "version": "4.1.7",
+  "version": "4.1.5",
   "description": "The hassle-free way to integrate analytics into any web application.",
   "types": "lib/index.d.ts",
   "keywords": [
@@ -30,6 +30,7 @@
   },
   "homepage": "https://github.com/segmentio/analytics.js-core#readme",
   "dependencies": {
+    "@segment/canonical": "^1.0.0",
     "@segment/cookie": "^1.1.5",
     "@segment/is-meta": "^1.0.0",
     "@segment/isodate": "^1.0.2",
@@ -71,8 +72,6 @@
     "@types/mocha": "^7.0.2",
     "@types/node": "^14.0.6",
     "@types/node-fetch": "^2.5.7",
-    "@types/proclaim": "^3.6.1",
-    "@types/sinon": "^9.0.5",
     "@typescript-eslint/eslint-plugin": "^4.1.0",
     "@typescript-eslint/parser": "^4.1.0",
     "assert": "1.5.0",
@@ -109,7 +108,7 @@
     "prettier-eslint-cli": "5.0.0",
     "proclaim": "^3.5.1",
     "puppeteer": "^5.3.0",
-    "sinon": "^1.17.7",
+    "sinon": "^1.7.3",
     "snyk": "^1.393.0",
     "ts-node": "^8.10.2",
     "typescript": "^4.0.2",

test/analytics.test.ts

@@ -1,13 +1,13 @@
 import assignIn from 'lodash.assignin'
-import { pageDefaults} from '../build/pageDefaults';
-import assert from 'proclaim'
 
 var Analytics = require('../build').constructor;
 var Facade = require('segmentio-facade');
 var analytics = require('../build');
+var assert = require('proclaim');
 var bind = require('component-event').bind;
 var createIntegration = require('@segment/analytics.js-integration');
 var type = require('component-type');
+var pageDefaults = require('../build/pageDefaults');
 var sinon = require('sinon');
 var tick = require('next-tick');
 var trigger = require('compat-trigger-event');

test/pageDefaults.test.ts

@@ -4,8 +4,7 @@
     "module": "commonjs",
     "target": "ES5",
     "allowJs": true,
-    "outDir": "build",
-    "lib": ["dom"]
+    "outDir": "build"
   },
   "include": ["lib"],
   "exclude": ["node_modules", "*.md", "Makefile", "karma.*", "test", "test-e2e"]

tsconfig.json

@@ -474,6 +474,10 @@
   dependencies:
     utf8-encode "1"
 
+"@segment/canonical@^1.0.0":
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/@segment/canonical/-/canonical-1.0.0.tgz#9adb1a731d29ab975493bf17a4ce4952985c4920"
+
 "@segment/cookie@^1.1.5":
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/@segment/cookie/-/cookie-1.2.0.tgz#17ee237c90dbf2c03643b06c53ccb49cbd7d9980"
@@ -1029,11 +1033,14 @@
   resolved "https://registry.yarnpkg.com/@types/parse-json/-/parse-json-4.0.0.tgz#2f8bb441434d163b35fb8ffdccd7138927ffb8c0"
   integrity sha512-//oorEZjL6sbPcKUaCdIGlIUeH26mgzimjBB77G6XRgnDl/L5wOnpyBGRe/Mmf5CVW3PwEBE1NjiMZ/ssFh4wA==
 
+<<<<<<< HEAD
 "@types/proclaim@^3.6.1":
   version "3.6.2"
   resolved "https://registry.yarnpkg.com/@types/proclaim/-/proclaim-3.6.2.tgz#8d3ba03f5cf370d518c719bd0223203f10e97998"
   integrity sha512-A3yo/rvft8rQjxjmXsWAY2b/AWcV2GK5Lc03Iis9niiZV7HnFqys8ngy7mDAoUk9XCW1n4tnHRUFIFQuAFb77A==
 
+=======
+>>>>>>> parent of d4d70e3... Drop @segment/canonical.  Also uprade some libs (#213)
 "@types/qs@*":
   version "6.9.6"
   resolved "https://registry.yarnpkg.com/@types/qs/-/qs-6.9.6.tgz#df9c3c8b31a247ec315e6996566be3171df4b3b1"
@@ -1074,6 +1081,7 @@
     "@types/mime" "^1"
     "@types/node" "*"
 
+<<<<<<< HEAD
 "@types/sinon@^9.0.5":
   version "9.0.11"
   resolved "https://registry.yarnpkg.com/@types/sinon/-/sinon-9.0.11.tgz#7af202dda5253a847b511c929d8b6dda170562eb"
@@ -1086,6 +1094,8 @@
   resolved "https://registry.yarnpkg.com/@types/sinonjs__fake-timers/-/sinonjs__fake-timers-6.0.2.tgz#3a84cf5ec3249439015e14049bd3161419bf9eae"
   integrity sha512-dIPoZ3g5gcx9zZEszaxLSVTvMReD3xxyyDnQUjA6IYDG9Ba2AV0otMPs+77sG9ojB4Qr2N2Vk5RnKeuA0X/0bg==
 
+=======
+>>>>>>> parent of d4d70e3... Drop @segment/canonical.  Also uprade some libs (#213)
 "@types/sizzle@*":
   version "2.3.2"
   resolved "https://registry.yarnpkg.com/@types/sizzle/-/sizzle-2.3.2.tgz#a811b8c18e2babab7d542b3365887ae2e4d9de47"
@@ -4367,7 +4377,6 @@ form-data@~2.3.2:
 formatio@1.1.1:
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/formatio/-/formatio-1.1.1.tgz#5ed3ccd636551097383465d996199100e86161e9"
-  integrity sha1-XtPM1jZVEJc4NGXZlhmRAOhhYek=
   dependencies:
     samsam "~1.1"
 
@@ -6692,7 +6701,6 @@ loglevel@^1.4.1, loglevel@^1.6.0:
 lolex@1.3.2:
   version "1.3.2"
   resolved "https://registry.yarnpkg.com/lolex/-/lolex-1.3.2.tgz#7c3da62ffcb30f0f5a80a2566ca24e45d8a01f31"
-  integrity sha1-fD2mL/yzDw9agKJWbKJORdigHzE=
 
 longest@^1.0.1:
   version "1.0.1"
@@ -8759,12 +8767,10 @@ safe-regex@^1.1.0:
 samsam@1.1.2:
   version "1.1.2"
   resolved "https://registry.yarnpkg.com/samsam/-/samsam-1.1.2.tgz#bec11fdc83a9fda063401210e40176c3024d1567"
-  integrity sha1-vsEf3IOp/aBjQBIQ5AF2wwJNFWc=
 
 samsam@~1.1:
   version "1.1.3"
   resolved "https://registry.yarnpkg.com/samsam/-/samsam-1.1.3.tgz#9f5087419b4d091f232571e7fa52e90b0f552621"
-  integrity sha1-n1CHQZtNCR8jJXHn+lLpCw9VJiE=
 
 sauce-connect-launcher@^1.2.2:
   version "1.3.2"
@@ -8994,10 +9000,9 @@ simple-concat@^1.0.0:
   resolved "https://registry.yarnpkg.com/simple-concat/-/simple-concat-1.0.1.tgz#f46976082ba35c2263f1c8ab5edfe26c41c9552f"
   integrity sha512-cSFtAPtRhljv69IK0hTVZQ+OfE9nePi/rtJmw5UjHeVyVroEqJXP1sFztKUy1qU+xvz3u/sfYJLa947b7nAN2Q==
 
-sinon@^1.17.7:
+sinon@^1.7.3:
   version "1.17.7"
   resolved "https://registry.yarnpkg.com/sinon/-/sinon-1.17.7.tgz#4542a4f49ba0c45c05eb2e9dd9d203e2b8efe0bf"
-  integrity sha1-RUKk9JugxFwF6y6d2dID4rjv4L8=
   dependencies:
     formatio "1.1.1"
     lolex "1.3.2"
@@ -10531,7 +10536,13 @@ util@0.10.3:
   dependencies:
     inherits "2.0.1"
 
-"util@>=0.10.3 <1", util@^0.12.1:
+"util@>=0.10.3 <1":
+  version "0.11.0"
+  resolved "https://registry.yarnpkg.com/util/-/util-0.11.0.tgz#c5f391beb244103d799b21077a926fef8769e1fb"
+  dependencies:
+    inherits "2.0.3"
+
+util@^0.12.1:
   version "0.12.3"
   resolved "https://registry.yarnpkg.com/util/-/util-0.12.3.tgz#971bb0292d2cc0c892dab7c6a5d37c2bec707888"
   integrity sha512-I8XkoQwE+fPQEhy9v012V+TSdH2kp9ts29i20TaaDUXsg7x/onePbhFJUExBfv/2ay1ZOp/Vsm3nDlmnFGSAog==