Skip to content

Add onpagehide event automatically in browser #294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add onpagehide event automatically in browser #294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 29 additions & 9 deletions packages/optimizely-sdk/lib/index.browser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ var logger = logging.getLogger();
logging.setLogHandler(loggerPlugin.createLogger());
logging.setLogLevel(logging.LogLevel.INFO);

var MODULE_NAME = 'INDEX_BROWSER';
var hasRetriedEvents = false;
/**
* Entry point into the Optimizely Browser SDK
Expand Down Expand Up @@ -101,16 +102,35 @@ module.exports = {
eventDispatcher = config.eventDispatcher;
}

config = fns.assignIn({
clientEngine: enums.JAVASCRIPT_CLIENT_ENGINE,
}, config, {
eventDispatcher: eventDispatcher,
// always get the OptimizelyLogger facade from logging
logger: logger,
errorHandler: logging.getErrorHandler(),
});
config = fns.assignIn(
{
clientEngine: enums.JAVASCRIPT_CLIENT_ENGINE,
},
config,
{
eventDispatcher: eventDispatcher,
// always get the OptimizelyLogger facade from logging
logger: logger,
errorHandler: logging.getErrorHandler(),
}
);

var optimizely = new Optimizely(config);

try {
var unloadEvent = 'onpagehide' in window ? 'pagehide' : 'unload';
window.addEventListener(
unloadEvent,
function() {
optimizely.close();
},
false
);
} catch (e) {
logger.error(enums.LOG_MESSAGES.UNABLE_TO_ATTACH_UNLOAD, MODULE_NAME, e.message);
}

return new Optimizely(config);
return optimizely;
} catch (e) {
logger.error(e);
return null;
Expand Down
18 changes: 18 additions & 0 deletions packages/optimizely-sdk/lib/index.browser.umdtests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
var configValidator = require('./utils/config_validator');
var enums = require('./utils/enums');
var logger = require('./plugins/logger');
var Optimizely = require('./optimizely');

var packageJSON = require('../package.json');
var eventDispatcher = require('./plugins/event_dispatcher/index.browser');
Expand All @@ -40,6 +41,7 @@ describe('javascript-sdk', function() {
logToConsole: false,
});
sinon.stub(configValidator, 'validate');
sinon.stub(Optimizely.prototype, 'close');

xhr = sinon.useFakeXMLHttpRequest();
global.XMLHttpRequest = xhr;
Expand All @@ -52,14 +54,18 @@ describe('javascript-sdk', function() {
sinon.spy(console, 'info');
sinon.spy(console, 'warn');
sinon.spy(console, 'error');

sinon.spy(window, 'addEventListener');
});

afterEach(function() {
console.log.restore();
console.info.restore();
console.warn.restore();
console.error.restore();
window.addEventListener.restore();
configValidator.validate.restore();
Optimizely.prototype.close.restore();
xhr.restore();
});

Expand Down Expand Up @@ -292,6 +298,18 @@ describe('javascript-sdk', function() {
var variation = optlyInstance.getVariation('testExperimentNotRunning', 'testUser');
assert.strictEqual(variation, null);
});

it('should hook into window `pagehide` event', function() {
var optlyInstance = window.optimizelySdk.createInstance({
datafile: testData.getTestProjectConfig(),
errorHandler: fakeErrorHandler,
eventDispatcher: eventDispatcher,
logger: silentLogger,
});

sinon.assert.calledOnce(window.addEventListener);
sinon.assert.calledWith(window.addEventListener, sinon.match('pagehide').or(sinon.match('unload')));
});
});
});
});
1 change: 1 addition & 0 deletions packages/optimizely-sdk/lib/utils/enums/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ exports.LOG_MESSAGES = {
UNKNOWN_MATCH_TYPE: '%s: Audience condition %s uses an unknown match type. You may need to upgrade to a newer release of the Optimizely SDK.',
UPDATED_OPTIMIZELY_CONFIG: '%s: Updated Optimizely config to revision %s (project id %s)',
OUT_OF_BOUNDS: '%s: Audience condition %s evaluated to UNKNOWN because the number value for user attribute "%s" is not in the range [-2^53, +2^53].',
UNABLE_TO_ATTACH_UNLOAD: '%s: unable to bind optimizely.close() to page unload event: "%s"',
};

exports.RESERVED_EVENT_KEYWORDS = {
Expand Down