Add cross-product uuid to all telemetry events

[mattseddon]

This PR adds the creation/loading of a company-wide telemetry UUID to our analytics calls for cross-product analytics.

Have a look at the notion spec and LMK if you think I have missed anything.

[mattseddon]

[F] Doesn't even have a types file

[mattseddon]

Can we trust this library

[rogermparent]

Appears this NPM port also doesn't support Windows

It currently supports OS X and Unix operating systems (Unix support is according to the XDG specification). Windows support is not yet implemented, but a pull request adding that would be greatly appreciated!

[mattseddon]

Thanks for cross-referencing from Notion.

[mattseddon]

I've looked at the source code for both the Python and Javascript implementations.

For windows in Python we have:

    if system == "win32":
        if appauthor is None:
            appauthor = appname
        const = roaming and "CSIDL_APPDATA" or "CSIDL_LOCAL_APPDATA"
        path = os.path.normpath(_get_win_folder(const))
        if appname:
            if appauthor is not False:
                path = os.path.join(path, appauthor, appname)
            else:
                path = os.path.join(path, appname)
...
    return path

For JS:

var appendNameVersion = function (dir, appname, version) {
  if (appname) {
    dir = path.join(dir, appname);
    if (version) {
      dir = path.join(dir, version);
    }
  }
  return dir;
};

...


  userConfigDir: function (appname, appauthor, version, roaming) {
    var dir = roaming ? process.env.APPDATA : process.env.LOCALAPPDATA;
    return appendNameVersion(dir, appname, version);
  }

so if process.env.APPDATA is correct and provided we should get the desired result by calling userConfigDir(join('iterative', 'telemetry') (spec here)

[mattseddon]

From the spec

from shutil import copy
from pathlib import Path
from appdirs import user_config_dir

# DVC backwards-compatibility
old = Path(user_config_dir("dvc/user_id", "iterative"))
# cross-product path
new = Path(user_config_dir("iterative/telemetry", False))

if old.exists() and not new.exists():
    copy(old, new)

[mattseddon]

This has been updated to:

import json
from shutil import copy
from pathlib import Path
from appdirs import user_config_dir

# DVC backwards-compatibility
old = Path(user_config_dir("dvc/user_id", "iterative"))
# cross-product path
new = Path(user_config_dir("iterative/telemetry", False))

uid = generate_id() # see above
if new.exists():
    uid = new.read_text().strip()
if old.exits():
    uid = json.load(old.open())["user_id"]
    new.write_text(uid)
else old.exists():  # only for non-DVC packages:
    # write legacy file in case DVC is installed later
    old.write_text(f'{{"user_id": "{uid}"}}')

Pretty sure the last statement should be just else.

[mattseddon]

Please re-review so we can clear this one down.

[qlty-cloud-legacy]

Code Climate has analyzed commit a37afa3 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 90.7% (85% is the threshold).

This pull request will bring the total coverage in the repository to 96.8% (-0.1% change).

View more on Code Climate.