Set telemetry options with CLI (#395)

* Set telemetry options with CLI

* Updated the build process to reflect recent urgent file moves

* Review findings, build failures, and tests

* More workarounds for alexferl/vyper#71

* Slight improvement for code coverage

Author: clairbee

.github/workflows/build.yml

@@ -52,12 +52,12 @@ jobs:
           . ~/.bashrc
           . ~/.bash_profile
           mamba activate env-build
-          cp .github/LICENSE.txt .github/apache20.svg partcad
+          cp LICENSE.txt apache20.svg partcad
           (cd partcad && python -m build)
           mamba deactivate
 
           mamba activate env-build-cli
-          cp .github/LICENSE.txt .github/apache20.svg README.md partcad-cli
+          cp LICENSE.txt apache20.svg README.md partcad-cli
           python -m pip install -r partcad/requirements.txt
           python -m pip install --no-index --find-links=partcad/dist partcad
           (cd partcad-cli && python -m build)

.vscode/launch.json

@@ -7,7 +7,7 @@
   "compounds": [
     // {
     //   "name": "Debug: PartCAD Development",
-    //   "configurations": ["Debug: partcad status", "Debug: partcad init", "Debug: partcad add --help"]
+    //   "configurations": ["Debug: partcad system status", "Debug: partcad init", "Debug: partcad add --help"]
     // },
     // {
     //   "name": "Debug: PartCAD Testing",
@@ -19,7 +19,7 @@
     // },
     // {
     //   "name": "Debug: PartCAD Full Suite",
-    //   "configurations": ["Debug: partcad status", "Debug: partcad init"]
+    //   "configurations": ["Debug: partcad system status", "Debug: partcad init"]
     // },
     // {
     //   "name": "Debug: PartCAD Testing",
@@ -186,12 +186,12 @@
       }
     },
     {
-      "name": "Debug: partcad status",
+      "name": "Debug: partcad system status",
       "type": "debugpy",
       "request": "launch",
       "program": "partcad-cli/src/partcad_cli/click/command.py",
       "args": [
-        "status"
+        "system status"
       ],
       "console": "integratedTerminal",
       "cwd": "${workspaceFolder}",

.vscode/settings.json

@@ -79,6 +79,7 @@
     "nlopt",
     "NOCOMMIT",
     "nptyping",
+    "ollama",
     "openscad",
     "packagecloud",
     "partcad",

docs/source/features.rst

@@ -202,6 +202,16 @@ Alternatively, you can disable telemetry by setting the following environment va
 
     PC_TELEMETRY_TYPE="none"
 
+You can also change telemetry settings using CLI:
+
+  .. code-block:: bash
+
+    pc system set telemetry type none
+    # or, if you want to collect data about PartCAD performance in your organization:
+    pc system set telemetry type sentry
+    pc system set telemetry env <you-org-name>
+    pc system set telemetry sentryDsn <your-sentry-dsn>
+
 Private Repositories
 --------------------
 

docs/source/installation.rst

@@ -99,4 +99,4 @@ If necessary, PartCAD tools are automatically retrieving the contents of this
 repository and all other required repositories and packages. No manual action is needed is need to `install` it.
 
 However, if you suspect that something is wrong with locally cached files,
-use ``pc status`` to investigate and to determine the location of the cached files.
+use ``pc system status`` to investigate and to determine the location of the cached files.

docs/source/troubleshooting.rst

@@ -12,11 +12,11 @@ configuration, model declarations and definitions.
 Status
 ------
 
-The status of PartCAD context can be evaluated using the ``status`` command.
+The status of PartCAD context can be evaluated using the ``system status`` command.
 
   .. code-block:: shell
 
-    pc status
+    pc system status
 
 Pay attention to any exception or error message produced by the
 ``status`` command.

docs/source/tutorial.rst

@@ -223,7 +223,7 @@ PartCAD maintains an internal state to keep track of dependencies of a project.
 
   .. code-block:: shell
 
-    pc reset
+    pc system reset
 
 =================
 VS Code Extension

features/config.feature

@@ -59,7 +59,7 @@ Feature: `pc config` command
     And environment variable "PC_CACHE_MEMORY_DOUBLE_CACHE_MAX_ENTRY_SIZE" is set to "101"
     And environment variable "PC_CACHE_DEPENDENCIES_IGNORE" is set to "true"
     And environment variable "PC_TELEMETRY_TYPE" is set to "sentry"
-    And environment variable "PC_TELEMETRY_PERFORMANCE" is set to "true"
+    And environment variable "PC_TELEMETRY_PERFORMANCE" is set to "false"
     And environment variable "PC_TELEMETRY_FAILURES" is set to "true"
     And environment variable "PC_TELEMETRY_DEBUG" is set to "false"
     And environment variable "PC_TELEMETRY_SENTRY_SHUTDOWN_TIMEOUT" is set to "11"
@@ -84,7 +84,7 @@ Feature: `pc config` command
     And STDOUT should contain "cache_memory_double_cache_max_entry_size: 101"
     And STDOUT should contain "cache_dependencies_ignore: True"
     And STDOUT should contain "'type': 'sentry'"
-    And STDOUT should contain "'performance': True"
+    And STDOUT should contain "'performance': False"
     And STDOUT should contain "'failures': True"
     And STDOUT should contain "'debug': False"
     And STDOUT should contain "'sentry_shutdown_timeout': 11"
@@ -172,7 +172,7 @@ Feature: `pc config` command
           sentryAttachStacktrace: true
           sentryTracesSampleRate: 0.43
       """
-    When I run "pc --threads-max=1111 --ollama-num-thread=2222 --max-script-correction=3333 --max-model-generation=4444 --max-geometric-modeling=5555 --openai-api-key=abcdef12345 --google-api-key=fedcba54321 --internal-state-dir=/tmp/sandbox/home/.partcad --python-sandbox=pypy --force-update --cache --cache-max-entry-size=102 --cache-min-entry-size=12 --cache-memory-max-entry-size=102 --cache-memory-double-cache-max-entry-size=102 --cache-dependencies-ignore --telemetry-debug --telemetry-sentry-traces-sample-rate=0.35 --telemetry-sentry-attach-stacktrace=no --telemetry-sentry-shutdown-timeout=44 config"
+    When I run "pc --threads-max=1111 --ollama-num-thread=2222 --max-script-correction=3333 --max-model-generation=4444 --max-geometric-modeling=5555 --openai-api-key=abcdef12345 --google-api-key=fedcba54321 --internal-state-dir=/tmp/sandbox/home/.partcad --python-sandbox=pypy --force-update --cache --cache-max-entry-size=102 --cache-min-entry-size=12 --cache-memory-max-entry-size=102 --cache-memory-double-cache-max-entry-size=102 --cache-dependencies-ignore --telemetry-type=sentry --telemetry-debug --telemetry-sentry-traces-sample-rate=0.35 --telemetry-sentry-attach-stacktrace=no --telemetry-sentry-shutdown-timeout=44 config"
     Then the command should exit with a status code of "0"
     And STDOUT should contain "threads_max: 1111"
     And STDOUT should contain "ollama_num_thread: 2222"

features/docs.feature

@@ -147,7 +147,7 @@ Feature: `pc render` command
     Then the command should exit with a status code of "0"
     When I run "pc --help"
     Then the command should exit with a status code of "0"
-    When I run "pc status"
+    When I run "pc system status"
     Then the command should exit with a status code of "0"
 
   # TODO: Failure to pip install from GH repo

features/pc.feature

@@ -29,7 +29,7 @@ Feature: `pc` command
   @pc-verbose @pc-status
   Scenario: Show DEBUG messages with increased verbosity
     Given environment variable "PC_NO_ANSI" is set to "1"
-    When I run "pc -v status"
+    When I run "pc -v system status"
     Then the command should exit with a status code of "0"
     # TODO-62: @alexanderilyin: check that DEBUG prefix is present
     And STDERR should contain "PartCAD version:"
@@ -42,7 +42,7 @@ Feature: `pc` command
 
   @pc-quiet @pc-status
   Scenario: Do not show INFO messages with decreased verbosity
-    When I run "pc --no-ansi -q status"
+    When I run "pc --no-ansi -q system status"
     Then the command should exit with a status code of "0"
     And STDOUT should not contain "INFO:partcad:PartCAD version:"
     And STDOUT should not contain "INFO:partcad:Internal data storage location:" with path
@@ -54,7 +54,7 @@ Feature: `pc` command
 
   @pc-no-ansi @pc-status
   Scenario: Do not show ANSI codes
-    When I run "pc --no-ansi status"
+    When I run "pc --no-ansi system status"
     Then the command should exit with a status code of "0"
     And STDERR should contain "INFO:partcad:PartCAD version:"
     And STDERR should contain "INFO:partcad:Internal data storage location:" with path