8000 refactor: Convert entry points to es module and create minified bundles by fayyazarshad · Pull Request #445 · optimizely/javascript-sdk · GitHub
[go: up one dir, main page]
Skip to content

refactor: Convert entry points to es module and create minified bundles #445

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

Merged
merged 16 commits into from
Apr 9, 2020
Merged

refactor: Convert entry points to es module and create minified bundles #445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
0ac6a76
Cleaned up other PR by fayyaz
zashraf1985 Apr 7, 2020
b89eed7
finalized the code
fayyazarshad Apr 7, 2020
5e07a49
added buble-loader to transpile es6 code for karma
zashraf1985 Apr 8, 2020
f3613ec
did some cleanup
zashraf1985 Apr 8, 2020
cb49cc5
cleaned up index.browser.js
zashraf1985 Apr 8, 2020
4f520cc
cleaned up node entry
zashraf1985 Apr 8, 2020
c6b3b62
cleaned up react native entry
zashraf1985 Apr 8, 2020
5cea14d
cleaned up test files
zashraf1985 Apr 8, 2020
32972e1
Merge branch 'master' into zeeshan/esmodule-conversion-entrypoints
zashraf1985 Apr 8, 2020
a6ffcbc
cleaned up rollup and package json
zashraf1985 Apr 8, 2020
03d5fee
incorporated review feedback
zashraf1985 Apr 9, 2020
ba997a1
Merge branch 'master' into zeeshan/esmodule-conversion-entrypoints
zashraf1985 Apr 9, 2020
69c2c7e
removed unused dependencies
zashraf1985 Apr 9, 2020
363814c
Added karma-chrome-launcher again to enable local testing
zashraf1985 Apr 9, 2020
7db4f75
removed hardcoded testapp branch from travis
zashraf1985 Apr 9, 2020
b51fe4c
changed es6 property shorthand to its full form to support es5
zashraf1985 Apr 9, 2020
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
3 changes: 2 additions & 1 deletion packages/optimizely-sdk/.eslintrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ module.exports = {
Promise: 'readonly',
},
parserOptions: {
ecmaVersion: 5,
ecmaVersion: 6,
sourceType: 'module',
},
rules: {
'no-prototype-builtins': 'off',
Expand Down
2 changes: 1 addition & 1 deletion packages/optimizely-sdk/karma.base.conf.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Copyright 2018, Optimizely
* Copyright 2018, 2020 Optimizely
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
262 changes: 141 additions & 121 deletions packages/optimizely-sdk/lib/index.browser.js
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Copyright 2016-2017, 2019, Optimizely
* Copyright 2016-2017, 2019-2020 Optimizely
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -13,146 +13,166 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var logging = require('@optimizely/js-sdk-logging');
var fns = require('./utils/fns');
var configValidator = require('./utils/config_validator');
var defaultErrorHandler = require('./plugins/error_handler');
var defaultEventDispatcher = require('./plugins/event_dispatcher/index.browser');
var enums = require('./utils/enums');
var eventProcessor = require('@optimizely/js-sdk-event-processor');
var loggerPlugin = require('./plugins/logger');
var Optimizely = require('./optimizely');
var eventProcessorConfigValidator = require('./utils/event_processor_config_validator');

var logger = logging.getLogger();
logging.setLogHandler(loggerPlugin.createLogger());
logging.setLogLevel(logging.LogLevel.INFO);
import {
getLogger,
setLogHandler,
setLogLevel,
setErrorHandler,
getErrorHandler,
LogLevel,
} from '@optimizely/js-sdk-logging';
import { LocalStoragePendingEventsDispatcher } from '@optimizely/js-sdk-event-processor';

import fns from './utils/fns';
import configValidator from './utils/config_validator';
import defaultErrorHandler from './plugins/error_handler';
import defaultEventDispatcher from './plugins/event_dispatcher/index.browser';
import enums from './utils/enums';
import loggerPlugin from './plugins/logger';
import Optimizely from './optimizely';
import eventProcessorConfigValidator from './utils/event_processor_config_validator';

var logger = getLogger();
setLogHandler(loggerPlugin.createLogger());
setLogLevel(LogLevel.INFO);

var MODULE_NAME = 'INDEX_BROWSER';

var DEFAULT_EVENT_BATCH_SIZE = 10;
var DEFAULT_EVENT_FLUSH_INTERVAL = 1000; // Unit is ms, default is 1s

var hasRetriedEvents = false;

/**
* Entry point into the Optimizely Browser SDK
* Creates an instance of the Optimizely class
* @param {Object} config
* @param {Object} config.datafile
* @param {Object} config.errorHandler
* @param {Object} config.eventDispatcher
* @param {Object} config.logger
* @param {Object} config.logLevel
* @param {Object} config.userProfileService
* @param {Object} config.eventBatchSize
* @param {Object} config.eventFlushInterval
* @return {Object} the Optimizely object
*/
module.exports = {
logging: loggerPlugin,
errorHandler: defaultErrorHandler,
eventDispatcher: defaultEventDispatcher,
enums: enums,
var createInstance = function(config) {
try {
config = config || {};

setLogger: logging.setLogHandler,
setLogLevel: logging.setLogLevel,

/**
* Creates an instance of the Optimizely class
* @param {Object} config
* @param {Object} config.datafile
* @param {Object} config.errorHandler
* @param {Object} config.eventDispatcher
* @param {Object} config.logger
* @param {Object} config.logLevel
* @param {Object} config.userProfileService
* @param {Object} config.eventBatchSize
* @param {Object} config.eventFlushInterval
* @return {Object} the Optimizely object
*/
createInstance: function(config) {
try {
config = config || {};
// TODO warn about setting per instance errorHandler / logger / logLevel
if (config.errorHandler) {
setErrorHandler(config.errorHandler);
}
if (config.logger) {
setLogHandler(config.logger);
// respect the logger's shouldLog functionality
setLogLevel(LogLevel.NOTSET);
}
if (config.logLevel !== undefined) {
setLogLevel(config.logLevel);
}

// TODO warn about setting per instance errorHandler / logger / logLevel
if (config.errorHandler) {
logging.setErrorHandler(config.errorHandler);
}
if (config.logger) {
logging.setLogHandler(config.logger);
// respect the logger's shouldLog functionality
logging.setLogLevel(logging.LogLevel.NOTSET);
}
if (config.logLevel !== undefined) {
logging.setLogLevel(config.logLevel);
}
try {
configValidator.validate(config);
config.isValidInstance = true;
} catch (ex) {
logger.error(ex);
config.isValidInstance = false;
}

try {
configValidator.validate(config);
config.isValidInstance = true;
} catch (ex) {
logger.error(ex);
config.isValidInstance = false;
var eventDispatcher;
// prettier-ignore
if (config.eventDispatcher == null) { // eslint-disable-line eqeqeq
// only wrap the event dispatcher with pending events retry if the user didnt override
eventDispatcher = new LocalStoragePendingEventsDispatcher({
eventDispatcher: defaultEventDispatcher,
});

if (!hasRetriedEvents) {
eventDispatcher.sendPendingEvents();
hasRetriedEvents = true;
}
} else {
eventDispatcher = config.eventDispatcher;
}

var eventDispatcher;
// prettier-ignore
if (config.eventDispatcher == null) { // eslint-disable-line eqeqeq
// only wrap the event dispatcher with pending events retry if the user didnt override
eventDispatcher = new eventProcessor.LocalStoragePendingEventsDispatcher({
eventDispatcher: defaultEventDispatcher,
});

if (!hasRetriedEvents) {
eventDispatcher.sendPendingEvents();
hasRetriedEvents = true;
}
} else {
eventDispatcher = config.eventDispatcher;
config = fns.assign(
{
clientEngine: enums.JAVASCRIPT_CLIENT_ENGINE,
eventBatchSize: DEFAULT_EVENT_BATCH_SIZE,
eventFlushInterval: DEFAULT_EVENT_FLUSH_INTERVAL,
},
config,
{
eventDispatcher: eventDispatcher,
// always get the OptimizelyLogger facade from logging
logger: logger,
errorHandler: getErrorHandler(),
}
);

config = fns.assign(
{
clientEngine: enums.JAVASCRIPT_CLIENT_ENGINE,
eventBatchSize: DEFAULT_EVENT_BATCH_SIZE,
eventFlushInterval: DEFAULT_EVENT_FLUSH_INTERVAL,
},
config,
{
eventDispatcher: eventDispatcher,
// always get the OptimizelyLogger facade from logging
logger: logger,
errorHandler: logging.getErrorHandler(),
}
if (!eventProcessorConfigValidator.validateEventBatchSize(config.eventBatchSize)) {
logger.warn('Invalid eventBatchSize %s, defaulting to %s', config.eventBatchSize, DEFAULT_EVENT_BATCH_SIZE);
config.eventBatchSize = DEFAULT_EVENT_BATCH_SIZE;
}
if (!eventProcessorConfigValidator.validateEventFlushInterval(config.eventFlushInterval)) {
logger.warn(
'Invalid eventFlushInterval %s, defaulting to %s',
config.eventFlushInterval,
DEFAULT_EVENT_FLUSH_INTERVAL
);
config.eventFlushInterval = DEFAULT_EVENT_FLUSH_INTERVAL;
}

if (!eventProcessorConfigValidator.validateEventBatchSize(config.eventBatchSize)) {
logger.warn('Invalid eventBatchSize %s, defaulting to %s', config.eventBatchSize, DEFAULT_EVENT_BATCH_SIZE);
config.eventBatchSize = DEFAULT_EVENT_BATCH_SIZE;
}
if (!eventProcessorConfigValidator.validateEventFlushInterval(config.eventFlushInterval)) {
logger.warn(
'Invalid eventFlushInterval %s, defaulting to %s',
config.eventFlushInterval,
DEFAULT_EVENT_FLUSH_INTERVAL
);
config.eventFlushInterval = DEFAULT_EVENT_FLUSH_INTERVAL;
}
var optimizely = new Optimizely(config);

var optimizely = new Optimizely(config);

try {
if (typeof window.addEventListener === 'function') {
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);
try {
if (typeof window.addEventListener === 'function') {
var unloadEvent = 'onpagehide' in window ? 'pagehide' : 'unload';
window.addEventListener(
unloadEvent,
function() {
optimizely.close();
},
false
);
}

return optimizely;
} catch (e) {
logger.error(e);
return null;
logger.error(enums.LOG_MESSAGES.UNABLE_TO_ATTACH_UNLOAD, MODULE_NAME, e.message);
}
},

__internalResetRetryState: function() {
hasRetriedEvents = false;
},
return optimizely;
} catch (e) {
logger.error(e);
return null;
}
};

var __internalResetRetryState = function() {
hasRetriedEvents = false;
};

/**
* Entry point into the Optimizely Browser SDK
*/
export {
loggerPlugin as logging,
defaultErrorHandler as errorHandler,
defaultEventDispatcher as eventDispatcher,
enums,
setLogHandler as setLogger,
setLogLevel,
createInstance,
__internalResetRetryState,
}

export default {
logging: loggerPlugin,
errorHandler: defaultErrorHandler,
eventDispatcher: defaultEventDispatcher,
enums: enums,
setLogger: setLogHandler,
setLogLevel: setLogLevel,
createInstance: createInstance,
__internalResetRetryState: __internalResetRetryState,
};
27 changes: 12 additions & 15 deletions packages/optimizely-sdk/lib/index.browser.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Copyright 2016-2019, Optimizely
* Copyright 2016-2020 Optimizely
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -13,19 +13,17 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var logging = require('@optimizely/js-sdk-logging');
var configValidator = require('./utils/config_validator');
var eventProcessor = require('@optimizely/js-sdk-event-processor');
var Optimizely = require('./optimizely');
var optimizelyFactory = require('./index.browser');
var packageJSON = require('../package.json');
var testData = require('./tests/test_data');
var eventProcessor = require('@optimizely/js-sdk-event-processor');
var eventProcessorConfigValidator = require('./utils/event_processor_config_validator');

var chai = require('chai');
var assert = chai.assert;
var sinon = require('sinon');
import { assert } from 'chai';
import sinon from 'sinon';
import * as logging from '@optimizely/js-sdk-logging';
import * as eventProcessor from '@optimizely/js-sdk-event-processor';

import Optimizely from './optimizely';
import testData from './tests/test_data';
import packageJSON from '../package.json';
import optimizelyFactory from './index.browser';
import configValidator from './utils/config_validator';
import eventProcessorConfigValidator from './utils/event_processor_config_validator';

var LocalStoragePendingEventsDispatcher = eventProcessor.LocalStoragePendingEventsDispatcher;

Expand Down Expand Up @@ -57,7 +55,6 @@ describe('javascript-sdk', function() {
sinon.stub(configValidator, 'validate');

xhr = sinon.useFakeXMLHttpRequest();
global.XMLHttpRequest = xhr;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this line not necessary?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looked redundant and removing it did not affect any tests.

requests = [];
xhr.onCreate = function(req) {
requests.push(req);
Expand Down
Loading
0