Sessions (#19)

* geenrate the session on the client via crypto.randomUUID

* update readme

* set the session before dispatching an event to ensure Hellotext.session returns the same value

* update form_controller

* add jest config files

* add dedicated session model and move initialization code there

* update code

* add jsdoc for Response class

* add jsdoc for Response class

* update dist

* 1.8.3

Author: rockwellll

README.md

@@ -85,11 +85,18 @@ Short links redirections attaches a session identifier to the destination url as
 
 ### Get session
 
-It is possible to obtain the current session by simply calling `Hellotext.session`.
+It is possible to obtain the current session by simply calling `Hellotext.session`. When the session is present in the cookies,
+the value stored in the cookies is returned. Otherwise, a new session is generated via [crypto.randomUUID()](https://developer.mozilla.org/en-US/docs/Web/API/Crypto/randomUUID).
+The session is kept in the client and not sent to Hellotext's servers until an event is tracked.
+
+An event is tracked in the following cases
+
+- Explicitly calling `Hellotext.track` method.
+- When a form is submitted and the form data is sent to Hellotext.
 
 ```javascript
-await Hellotext.session
-// Returns bBJn9vR15yPaYkWmR2QK0jopMeNxrA6l
+Hellotext.session
+// Returns da834c54-97fa-44ef-bafd-2bd4fec60636
 ```
 
 If the session has not been set yet, the result returned will be `undefined`.

__tests__/api/sessions_test.js

@@ -20,10 +20,6 @@ afterEach(() => {
 });
 
 describe("when trying to call methods before initializing the class", () => {
-  it("raises an error when Hellotext.session is called",  () => {
-    expect(() => Hellotext.session).toThrowError()
-  });
-
   it("raises an error when Hellotext.track is called",  () => {
     expect(Hellotext.track("page.viewed")).rejects.toThrowError()
   });
@@ -196,23 +192,10 @@ describe("when hello_preview query parameter is present", () => {
     Hellotext.initialize(123)
   })
 
-  describe(".initialize", () => {
-    it("does not attempt to set the session", () => {
-      expect(getCookieValue("hello_session")).toEqual(undefined)
-    });
-  })
-
   describe(".track", () => {
     it("returns a success response without interacting with the API", async () => {
       const response = await Hellotext.track("page.viewed")
       expect(response.succeeded).toEqual(true)
     });
   })
 })
-
-describe('setSession', () => {
-  it('sets the session', () => {
-    Hellotext.setSession("12345")
-    expect(Hellotext.session).toEqual("12345")
-  })
-})

__tests__/hellotext_test.js

@@ -0,0 +1,3 @@
+module.exports = {
+  setupFiles: ['<rootDir>/jest.setup.js'], // Setup file to run before tests
+};

dist/hellotext.js

@@ -0,0 +1,7 @@
+global.crypto.randomUUID = () => {
+  return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+    const r = (Math.random() * 16) | 0;
+    const v = c === 'x' ? r : (r & 0x3) | 0x8;
+    return v.toString(16);
+  });
+};

jest.config.js

@@ -10,7 +10,6 @@ Object.defineProperty(exports, "Response", {
   }
 });
 exports.default = void 0;
-var _sessions = _interopRequireDefault(require("./sessions"));
 var _businesses = _interopRequireDefault(require("./businesses"));
 var _events = _interopRequireDefault(require("./events"));
 var _forms = _interopRequireDefault(require("./forms"));
@@ -26,11 +25,6 @@ var API = /*#__PURE__*/function () {
     _classCallCheck(this, API);
   }
   _createClass(API, null, [{
-    key: "sessions",
-    value: function sessions(businessId) {
-      return new _sessions.default(businessId);
-    }
-  }, {
     key: "businesses",
     get: function get() {
       return _businesses.default;

jest.setup.js

@@ -15,6 +15,13 @@ function _classPrivateFieldLooseBase(receiver, privateKey) { if (!Object.prototy
 var id = 0;
 function _classPrivateFieldLooseKey(name) { return "__private_" + id++ + "_" + name; }
 var _success = /*#__PURE__*/_classPrivateFieldLooseKey("success");
+/**
+ * Response class
+ * @class
+ * @classdesc Represents a response from the API
+ * @property {Boolean} succeeded
+ * @property {Object} data
+ */
 var Response = /*#__PURE__*/function () {
   function Response(success, response) {
     _classCallCheck(this, Response);
@@ -25,11 +32,21 @@ var Response = /*#__PURE__*/function () {
     this.response = response;
     _classPrivateFieldLooseBase(this, _success)[_success] = success;
   }
+
+  /**
+   * Get the response data
+   * @returns {*}
+   */
   _createClass(Response, [{
     key: "data",
     get: function get() {
       return this.response;
     }
+
+    /**
+     * Parse the response as JSON
+     * @returns {Promise<*>}
+     */
   }, {
     key: "json",
     value: function () {
@@ -41,11 +58,20 @@ var Response = /*#__PURE__*/function () {
       }
       return json;
     }()
+    /**
+     * Has the request failed?
+     * @returns {boolean}
+     */
   }, {
     key: "failed",
     get: function get() {
       return _classPrivateFieldLooseBase(this, _success)[_success] === false;
     }
+
+    /**
+     * Has the request succeeded?
+     * @returns {boolean}
+     */
   }, {
     key: "succeeded",
     get: function get() {

lib/api/index.js

@@ -79,9 +79,6 @@ var _default = /*#__PURE__*/function (_Controller) {
         }
         this.buttonTarget.style.display = 'none';
         this.element.querySelectorAll('input').forEach(input => input.disabled = true);
-        if (!data.identified) {
-          _hellotext.default.setSession(data.session);
-        }
         this.completed();
       });
       function submit(_x) {

lib/api/response.js

@@ -5,10 +5,11 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _core = require("./core");
-var _api = _interopRequireDefault(require("./api"));
+var _api = _interopRequireWildcard(require("./api"));
 var _models = require("./models");
 var _errors = require("./errors");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
@@ -24,7 +25,6 @@ var id = 0;
 function _classPrivateFieldLooseKey(name) { return "__private_" + id++ + "_" + name; }
 var _session = /*#__PURE__*/_classPrivateFieldLooseKey("session");
 var _query = /*#__PURE__*/_classPrivateFieldLooseKey("query");
-var _mintAnonymousSession = /*#__PURE__*/_classPrivateFieldLooseKey("mintAnonymousSession");
 var Hellotext = /*#__PURE__*/function () {
   function Hellotext() {
     _classCallCheck(this, Hellotext);
@@ -39,24 +39,10 @@ var Hellotext = /*#__PURE__*/function () {
      */
     function initialize(business, config) {
       _core.Configuration.assign(config);
+      _models.Session.initialize();
       _classPrivateFieldLooseBase(this, _query)[_query] = new _models.Query();
       this.business = new _models.Business(business);
       this.forms = new _models.FormCollection();
-      if (_classPrivateFieldLooseBase(this, _query)[_query].inPreviewMode) return;
-      if (_core.Configuration.session) {
-        _classPrivateFieldLooseBase(this, _session)[_session] = _core.Configuration.session;
-      } else if (_classPrivateFieldLooseBase(this, _query)[_query].session) {
-        _classPrivateFieldLooseBase(this, _session)[_session] = _models.Cookies.set('hello_session', _classPrivateFieldLooseBase(this, _query)[_query].session);
-      } else if (_core.Configuration.autoGenerateSession) {
-        _classPrivateFieldLooseBase(this, _mintAnonymousSession)[_mintAnonymousSession]().then(response => {
-          _classPrivateFieldLooseBase(this, _session)[_session] = _models.Cookies.set('hello_session', response.id);
-        });
-      }
-    }
-  }, {
-    key: "setSession",
-    value: function setSession(value) {
-      _classPrivateFieldLooseBase(this, _session)[_session] = _models.Cookies.set('hello_session', value);
     }
 
     /**
@@ -121,10 +107,7 @@ var Hellotext = /*#__PURE__*/function () {
   }, {
     key: "session",
     get: function get() {
-      if (this.notInitialized) {
-        throw new _errors.NotInitializedError();
-      }
-      return _classPrivateFieldLooseBase(this, _session)[_session];
+      return _models.Session.session;
     }
 
     /**
@@ -134,7 +117,7 @@ var Hellotext = /*#__PURE__*/function () {
   }, {
     key: "isInitialized",
     get: function get() {
-      return _classPrivateFieldLooseBase(this, _session)[_session] !== undefined;
+      return _models.Session.session !== undefined;
     }
 
     // private
@@ -158,21 +141,6 @@ var Hellotext = /*#__PURE__*/function () {
   }]);
   return Hellotext;
 }();
-function _mintAnonymousSession2() {
-  return _mintAnonymousSession3.apply(this, arguments);
-}
-function _mintAnonymousSession3() {
-  _mintAnonymousSession3 = _asyncToGenerator(function* () {
-    if (this.notInitialized) {
-      throw new _errors.NotInitializedError();
-    }
-    return _api.default.sessions(this.business.id).create();
-  });
-  return _mintAnonymousSession3.apply(this, arguments);
-}
-Object.defineProperty(Hellotext, _mintAnonymousSession, {
-  value: _mintAnonymousSession2
-});
 Object.defineProperty(Hellotext, _session, {
   writable: true,
   value: void 0

lib/api/sessions.js

@@ -33,8 +33,15 @@ Object.defineProperty(exports, "Query", {
     return _query.Query;
   }
 });
+Object.defineProperty(exports, "Session", {
+  enumerable: true,
+  get: function get() {
+    return _session.Session;
+  }
+});
 var _business = require("./business");
 var _form = require("./form");
 var _query = require("./query");
 var _cookies = require("./cookies");
-var _form_collection = require("./form_collection");
+var _form_collection = require("./form_collection");
+var _session = require("./session");

lib/controllers/form_controller.js

@@ -0,0 +1,55 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Session = void 0;
+var _core = require("../core");
+var _index = require("./index");
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _classPrivateFieldLooseBase(receiver, privateKey) { if (!Object.prototype.hasOwnProperty.call(receiver, privateKey)) { throw new TypeError("attempted to use private field on non-instance"); } return receiver; }
+var id = 0;
+function _classPrivateFieldLooseKey(name) { return "__private_" + id++ + "_" + name; }
+var _session = /*#__PURE__*/_classPrivateFieldLooseKey("session");
+var _query = /*#__PURE__*/_classPrivateFieldLooseKey("query");
+var Session = /*#__PURE__*/function () {
+  function Session() {
+    _classCallCheck(this, Session);
+  }
+  _createClass(Session, null, [{
+    key: "session",
+    get: function get() {
+      return _classPrivateFieldLooseBase(this, _session)[_session];
+    },
+    set: function set(value) {
+      _classPrivateFieldLooseBase(this, _session)[_session] = value;
+      _index.Cookies.set('hello_session', value);
+    }
+  }, {
+    key: "initialize",
+    value: function initialize() {
+      _classPrivateFieldLooseBase(this, _query)[_query] = new _index.Query();
+      if (_core.Configuration.session) {
+        this.session = _core.Configuration.session;
+      } else if (_classPrivateFieldLooseBase(this, _query)[_query].session) {
+        this.session = _classPrivateFieldLooseBase(this, _query)[_query].session;
+      } else if (_core.Configuration.autoGenerateSession) {
+        this.session = crypto.randomUUID();
+      }
+    }
+  }]);
+  return Session;
+}();
+exports.Session = Session;
+Object.defineProperty(Session, _session, {
+  writable: true,
+  value: void 0
+});
+Object.defineProperty(Session, _query, {
+  writable: true,
+  value: void 0
+});

lib/hellotext.js

@@ -1,6 +1,6 @@
 {
   "name": "@hellotext/hellotext",
-  "version": "1.8.2",
+  "version": "1.8.3",
   "description": "Hellotext JavaScript Client",
   "source": "src/index.js",
   "main": "lib/index.js",