vaadin / vaadin-usage-statistics Goto Github PK

Development-time usage statistics collector.

License: Apache License 2.0

HTML 64.79% JavaScript 35.21%

vaadin-usage-statistics's Introduction

Gathers usage statistics for components used during application development

To be able to understand and focus development more efficiently, Vaadin gathers product usage statistics during development time and ties this to users who are logged in to their Vaadin account. No statistics or other data is collected from the users of the applications based on any Vaadin technologies.

Statistics are only gathered when the application is in development mode. Statistics are automatically disabled and the statistics gathering code is automatically excluded from production builds.

Collected data

Vaadin products used in the application, including version numbers
Frameworks used in the application, including version numbers
Flow features used in the application, including version numers
The first and last time a product was used
The first time statistics were gathered
Your Vaadin user account
Whether you are a Vaadin Pro user or not (true/false)
Browser user-agent string
The IP address the statistics is sent from

Opting out

npm and Vaadin 14+ (using npm)

Using npm, you can disable it for the machine by running

npm explore @vaadin/vaadin-usage-statistics -- npm run disable

or you can disable it for the project by adding

   "vaadin": { "disableUsageStatistics": true }

to your project package.json and running npm install again (remove node_modules if needed).

You can verify this by checking that vaadin-usage-statistics.js contains an empty function.

Vaadin 10 - 14 (using Bower)

Add to your pom.xml:

<dependency>
  <groupId>org.webjars.bowergithub.vaadin</groupId>
  <artifactId>vaadin-usage-statistics</artifactId>
  <version>1.0.0-optout</version>
</dependency>

Bower

To opt-out from statistics, install the no-op version of the vaadin-usage-statistics package using

bower install --save vaadin/vaadin-usage-statistics#optout

You can verify this by checking that vaadin-usage-statistics.html is empty.

If you have any questions on the use of the statistics, please contact [email protected].

vaadin-usage-statistics's People

Contributors

Stargazers

Watchers

Forkers

alvarezguille legioth romulocintra pks-os pleku peterblazejewicz

vaadin-usage-statistics's Issues

optout + build failed

Hi,

While running:

npm install --production
npm explore @vaadin/vaadin-usage-statistics -- npm run disable
polymer build
...
�[31merror�[39m:	Promise rejection: Error: Could not load @vaadin/vaadin-usage-statistics/vaadin-usage-statistics.js (imported by node_modules/%40vaadin/vaadin-element-mixin/vaadin-element-mixin.js): ENOENT: no such file or directory, open '@vaadin/vaadin-usage-statistics/vaadin-usage-statistics.js'
�[31merror�[39m:	Error: Could not load @vaadin/vaadin-usage-statistics/vaadin-usage-statistics.js (imported by node_modules/%40vaadin/vaadin-element-mixin/vaadin-element-mixin.js): ENOENT: no such file or directory, open '@vaadin/vaadin-usage-statistics/vaadin-usage-statistics.js'

If I enable the stats again, the build works

Even disabled, vaadin-usage-statistics pollutes `window.localStorage`

Per the instructions on how to opt-out, the vaadin-usage-statistics.js file is indeed empty:

$ cat ./node_modules/@vaadin/vaadin-usage-statistics/vaadin-usage-statistics.js 
export const usageStatistics = function() {
  /* do nothing */
};

However, in the browser, the window.localStorage object continues to have usage statistics inserted. Running the following code in the console reveals the violation:

for (let i = 0; i < localStorage.length; i++) {
  console.log(i, localStorage.key(i));
}

Console output:

0 vaadin.statistics.firstuse
1 vaadin.statistics.basket

Using optout branch with bower --force-latest.

It seems Bower with --force-latest has problems to use the optout branch, even when we define the commit hash in resolutions.

Excerpt from bower.json:

{
  "dependencies": {
    "vaadin-grid": "vaadin/vaadin-grid#5.0.4",
    "vaadin-usage-statistics": "vaadin/vaadin-usage-statistics#optout"
  },
  "resolutions": {
    "vaadin-usage-statistics": "e-tag:61ea340"
  }
}

options in package.json

It would be nice to have an option in the package.json file to avoid using the vaadin-stats module instead of running a command.

Exemple: package.json

{
  ...
  anonymousStatistics: false     // or vaadinStats: false
  ...
}

Missing export with "npm i --ignore-script"

Hello,

When installing a project with npm install --ignore-script, the usageStatistics method is not exported in the vaadin-usage-statistics.js file. This is the actual content:

import './vaadin-usage-statistics-collect.js';

Thus, making it unusable as soon as you want to build a project using a vaadin component.

A solution could be to change the default content to the following:

export { usageStatistics } from './vaadin-usage-statistics-collect.js';

What do you think ?
I'd tried to make a PR myself, but I'm a little lost on how/which file I should modify to commit the changes. How vaadin-usage-statistics-collect.html is transpiled into vaadin-usage-statistics-collect.js ?
Thanks for reading my issue and keep up the good work !

npm version should not depend on Polymer 3

We should not convert this repo using modulizer.

Currently, when executing following command:

yarn add @vaadin/vaadin-usage-statistics

The output looks like this:

success Saved 3 new dependencies.
info Direct dependencies
└─ @vaadin/[email protected]
info All dependencies
├─ @polymer/[email protected]
├─ @vaadin/[email protected]
└─ @webcomponents/[email protected]

Related to vaadin/router#32

Create TypeScript definitions for P3

Child of vaadin/vaadin-core#186

Note: it might make sense to create vaadin-usage-statistics.d.ts manually.

Remove list of Vaadin elements

There is no way that this can work if you list Vaadin elements to check for. The list is already outdated / missing elements.

Output message only once per installation

With the latest Flow, that uses shrinkwrap packages, you see the info message three times during npm install

> @vaadin/[email protected] postinstall .../node_modules/@vaadin/vaadin-core-shrinkwrap/node_modules/@vaadin/vaadin-usage-statistics
> node check.js


    Vaadin collects development time usage statistics to improve this product. To opt-out, either run:
    npm explore @vaadin/vaadin-usage-statistics -- npm run disable
    to store disable statistics for the machine, or add
    "vaadin": { "disableUsageStatistics": true }
    to the project package.json and re-run npm install to disable statistics for the project.

    For more details, see https://github.com/vaadin/vaadin-usage-statistics
  

> @vaadin/[email protected] postinstall .../node_modules/@vaadin/vaadin-shrinkwrap/node_modules/@vaadin/vaadin-usage-statistics
> node check.js


    Vaadin collects development time usage statistics to improve this product. To opt-out, either run:
    npm explore @vaadin/vaadin-usage-statistics -- npm run disable
    to store disable statistics for the machine, or add
    "vaadin": { "disableUsageStatistics": true }
    to the project package.json and re-run npm install to disable statistics for the project.

    For more details, see https://github.com/vaadin/vaadin-usage-statistics
  

> @vaadin/[email protected] postinstall .../node_modules/@vaadin/vaadin-usage-statistics
> node check.js


    Vaadin collects development time usage statistics to improve this product. To opt-out, either run:
    npm explore @vaadin/vaadin-usage-statistics -- npm run disable
    to store disable statistics for the machine, or add
    "vaadin": { "disableUsageStatistics": true }
    to the project package.json and re-run npm install to disable statistics for the project.

    For more details, see https://github.com/vaadin/vaadin-usage-statistics