diff --git a/.eslintrc.yaml b/.eslintrc.yaml index aa13464b..5b7ce5ef 100644 --- a/.eslintrc.yaml +++ b/.eslintrc.yaml @@ -1,112 +1,104 @@ --- -parser: babel-eslint -root: true -extends: - - prettier -env: - es6: true - node: true -plugins: - - babel - - prettier -globals: - VERSION: true - describe: true - it: true - expect: true - jest: true - beforeAll: true - afterAll: true - beforeEach: true - afterEach: true - window: true - document: true -rules: - # https://github.com/prettier/eslint-plugin-prettier - prettier/prettier: - - error - - # https://github.com/babel/eslint-plugin-babel - babel/semi: error - - # https://eslint.org/docs/rules/array-callback-return - array-callback-return: error - - # https://eslint.org/docs/rules/curly - curly: - - error - - all - - # https://eslint.org/docs/rules/no-implicit-coercion - no-implicit-coercion: - - 'off' - - boolean: false - number: true - string: true - allow: [] - - # https://eslint.org/docs/rules/no-eval - no-eval: error - - # https://eslint.org/docs/rules/no-implied-eval - no-implied-eval: error - - # https://eslint.org/docs/rules/no-param-reassign - no-param-reassign: - - error - - props: true - - # https://eslint.org/docs/rules/no-return-assign - no-return-assign: error - - # https://eslint.org/docs/rules/no-self-compare - no-self-compare: error - - # https://eslint.org/docs/rules/radix - radix: error - - # https://eslint.org/docs/rules/no-array-constructor - no-array-constructor: error - - # https://eslint.org/docs/rules/no-new-wrappers - no-new-wrappers: error - - # https://eslint.org/docs/rules/no-cond-assign - no-cond-assign: error - - # https://eslint.org/docs/rules/no-use-before-define - no-use-before-define: - - error - - functions: false - - # https://eslint.org/docs/rules/eqeqeq - eqeqeq: error - - # Deprecations are required to turn enforce this - camelcase: warn - - # https://eslint.org/docs/rules/no-new-object - no-new-object: error - - # https://eslint.org/docs/rules/no-nested-ternary - no-nested-ternary: error - - # https://eslint.org/docs/rules/no-unused-vars - no-unused-vars: error - - # https://eslint.org/docs/rules/no-var - no-var: error - - # https://eslint.org/docs/rules/prefer-const - prefer-const: error - - # https://eslint.org/docs/rules/prefer-arrow-callback - prefer-arrow-callback: error - - # https://eslint.org/docs/rules/arrow-body-style - arrow-body-style: - - error - - as-needed - - # https://eslint.org/docs/rules/no-undef - no-undef: error + parser: babel-eslint + root: true + extends: + - prettier + - eslint:recommended # https://eslint.org/docs/rules/ + env: + es6: true + node: true + plugins: + - babel + - prettier + globals: + VERSION: true + describe: true + it: true + expect: true + jest: true + beforeAll: true + afterAll: true + beforeEach: true + afterEach: true + window: true # we *do* want to allow "window" and "document" in the browser JS SDK + document: true + rules: + # https://eslint.org/docs/rules/array-callback-return + array-callback-return: error + + # https://eslint.org/docs/rules/arrow-body-style + arrow-body-style: + - error + - as-needed + + # https://github.com/babel/eslint-plugin-babel + babel/semi: error + + # Deprecations are required to turn enforce this + camelcase: warn + + # https://eslint.org/docs/rules/curly + curly: + - error + - all + + # https://eslint.org/docs/rules/eqeqeq + eqeqeq: error + + # https://eslint.org/docs/rules/no-array-constructor + no-array-constructor: error + + # https://eslint.org/docs/rules/no-eval + no-eval: error + + # https://eslint.org/docs/rules/no-implicit-coercion + no-implicit-coercion: + - 'off' + - boolean: false + number: true + string: true + allow: [] + + # https://eslint.org/docs/rules/no-implied-eval + no-implied-eval: error + + # https://eslint.org/docs/rules/no-nested-ternary + no-nested-ternary: error + + # https://eslint.org/docs/rules/no-new-object + no-new-object: error + + # https://eslint.org/docs/rules/no-new-wrappers + no-new-wrappers: error + + # https://eslint.org/docs/rules/no-param-reassign + no-param-reassign: + - error + - props: true + + # https://eslint.org/docs/rules/no-return-assign + no-return-assign: error + + # https://eslint.org/docs/rules/no-self-compare + no-self-compare: error + + # https://eslint.org/docs/rules/no-use-before-define + no-use-before-define: + - error + - functions: false + + # https://eslint.org/docs/rules/no-var + no-var: error + + # https://eslint.org/docs/rules/prefer-arrow-callback + prefer-arrow-callback: error + + # https://eslint.org/docs/rules/prefer-const + prefer-const: error + + # https://github.com/prettier/eslint-plugin-prettier + prettier/prettier: + - error + + # https://eslint.org/docs/rules/radix + radix: error \ No newline at end of file diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 261eeb9e..00000000 --- a/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 00000000..e82de54e --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,13 @@ +Copyright 2016 Catamorphic, Co. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index f1a5e35d..c242332a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5412,7 +5412,8 @@ "version": "2.1.1", "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=", - "dev": true + "dev": true, + "optional": true }, "is-fullwidth-code-point": { "version": "2.0.0", @@ -6769,9 +6770,9 @@ "dev": true }, "launchdarkly-js-sdk-common": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/launchdarkly-js-sdk-common/-/launchdarkly-js-sdk-common-3.1.2.tgz", - "integrity": "sha512-R7OIP+io5cE3Q0lMzHFV5fc5+2ColJOzBPJOl/orUd5ip6Nla33UfZsTUV6xp58Lmgvx2XkXEe/Rn1uVEZ8i0w==", + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/launchdarkly-js-sdk-common/-/launchdarkly-js-sdk-common-3.2.2.tgz", + "integrity": "sha512-WBIMk3c1s3JGpSvDRZpDr0D4dDPsFkscDmcOoaoXnkW6PdacfUz9KKJ9bKTM+akNWE2DsZ3ttEz4rATEFeOnVA==", "requires": { "base64-js": "^1.3.0", "fast-deep-equal": "^2.0.1", diff --git a/package.json b/package.json index ec8e3237..9442af4c 100644 --- a/package.json +++ b/package.json @@ -80,7 +80,7 @@ }, "dependencies": { "escape-string-regexp": "^1.0.5", - "launchdarkly-js-sdk-common": "3.1.2" + "launchdarkly-js-sdk-common": "3.2.2" }, "repository": { "type": "git", diff --git a/src/GoalManager.js b/src/GoalManager.js index 2edee09d..af62fd04 100644 --- a/src/GoalManager.js +++ b/src/GoalManager.js @@ -73,7 +73,7 @@ export default function GoalManager(clientVars, readyCallback) { poll(checkUrl, interval); - if (!!(window.history && window.history.pushState)) { + if (window.history && window.history.pushState) { window.addEventListener('popstate', checkUrl); } else { window.addEventListener('hashchange', checkUrl); diff --git a/src/__tests__/LDClient-test.js b/src/__tests__/LDClient-test.js index b5987204..dbc77395 100644 --- a/src/__tests__/LDClient-test.js +++ b/src/__tests__/LDClient-test.js @@ -162,7 +162,7 @@ describe('LDClient', () => { describe('event flushing', () => { it('normally uses asynchronous XHR', async () => { - const config = { bootstrap: {}, flushInterval: 100000, fetchGoals: false }; + const config = { bootstrap: {}, flushInterval: 100000, fetchGoals: false, diagnosticOptOut: true }; const client = LDClient.initialize(envName, user, config); await client.waitForInitialization(); @@ -174,7 +174,7 @@ describe('LDClient', () => { }); async function setupClientAndTriggerUnload() { - const config = { bootstrap: {}, flushInterval: 100000, fetchGoals: false }; + const config = { bootstrap: {}, flushInterval: 100000, fetchGoals: false, diagnosticOptOut: true }; const client = LDClient.initialize(envName, user, config); await client.waitForInitialization(); diff --git a/src/browserPlatform.js b/src/browserPlatform.js index d07cc237..4ee7c378 100644 --- a/src/browserPlatform.js +++ b/src/browserPlatform.js @@ -120,6 +120,18 @@ export default function makeBrowserPlatform(options) { } ret.userAgent = 'JSClient'; + ret.version = VERSION; + + ret.diagnosticSdkData = { + name: 'js-client-sdk', + version: VERSION, + }; + + ret.diagnosticPlatformData = { + name: 'JS', + }; + + ret.diagnosticUseCombinedEvent = true; // the browser SDK uses the "diagnostic-combined" event format return ret; } diff --git a/src/index.js b/src/index.js index 098ac426..bb82f2c0 100644 --- a/src/index.js +++ b/src/index.js @@ -6,6 +6,7 @@ const goalsEvent = 'goalsReady'; const extraOptionDefs = { fetchGoals: { default: true }, hash: { type: 'string' }, + eventProcessor: { type: 'object' }, // used only in tests eventUrlTransformer: { type: 'function' }, }; @@ -62,7 +63,7 @@ export const createConsoleLogger = common.createConsoleLogger; export const version = VERSION; function deprecatedInitialize(env, user, options = {}) { - console && console.warn && console.warn(common.messages.deprecated('default export', 'named LDClient export')); + console && console.warn && console.warn(common.messages.deprecated('default export', 'named LDClient export')); // eslint-disable-line no-console return initialize(env, user, options); }