Skip to content

Documentation potentially out of date regarding 'browserEvents' for version 0.5.4a #4

@aianta

Description

@aianta

From the Browser Events documentation we are given the config example below.

let configurationObject = {
    logUIConfiguration: {
        endpoint: 'ws://path-to-server:8000/ws/endpoint/',
        authorisationToken: 'AUTHTOKEN',  // The authorisation token.
        verbose: true,
        browserEvents: {
            // See the Browser Events Wiki page.
        }
    },
...

However in buildVersion: 0.5.4a, and commit 09d1658e0d0678dc6be81e04a739dc1e17d48c4a of the master branch, in config.js we have:

    var initConfigObjects = function(suppliedConfigObject) {
        Helpers.extendObject(_configProperties, Defaults.dispatcher);  // Apply the defaults for the dispatcher.
        Helpers.extendObject(_configProperties, suppliedConfigObject.logUIConfiguration);  // Apply the logUIConfiguration values from the supplied config object.

        _applicationSpecificData = suppliedConfigObject.applicationSpecificData;
        _trackingConfig = suppliedConfigObject.trackingConfiguration;
        _browserEvents = suppliedConfigObject.browserEvents;

        return true;
    };

Showing that browserEvents should be on the same level as applicationSpecificData rather than nested within logUIConfiguration as shown in the documentation. After moving browserEvents like so:

{
  logUIConfiguration: {
      endpoint: 'ws://localhost:8000/ws/endpoint/',
      authorisationToken: 'TOKEN',
      verbose: true
  },
  applicationSpecificData: {
      userID: 123,
  },
  browserEvents: {
    trackCursor: false
  },
...

my configuration took effect.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions