Makes telemetry enabled by default (#936)

Author: meghfossa

Changelog.md

@@ -1,5 +1,10 @@
 # FOSSA CLI Changelog
 
+## v3.3.0
+- Telemetry: CLI collects telemetry by default. ([#936](https://github.com/fossas/fossa-cli/pull/936))
+
+Read more about telemetry: https://github.com/fossas/fossa-cli/blob/master/docs/telemetry.md. To opt-out of telemetry, provide `FOSSA_TELEMETRY_SCOPE` environment variable with value of: `off` in your shell prior to running fossa.
+
 ## v3.2.17
 - Archive upload: Fix a bug when trying to tar to a filename that already exists. ([#927](https://github.com/fossas/fossa-cli/pull/927))
 - Npm: Supports lockfile v3. ([#932](https://github.com/fossas/fossa-cli/pull/932))

install-latest.ps1

@@ -83,19 +83,18 @@ Write-Host "Notice"
 Write-Host "------"
 Write-Host ""
 Write-Host "FOSSA collects warnings, errors, and usage data to improve"
-Write-Host "the FOSSA CLI and your experience. The CLI DOES NOT collect"  
-Write-Host "telemetry by default, but this will change in future!"
+Write-Host "the FOSSA CLI and your experience."
+Write-Host ""
+Write-Host "Read more: https://github.com/fossas/fossa-cli/blob/master/docs/telemetry.md"
 Write-Host ""
 Write-Host "If you want to prevent any telemetry data from being sent to" 
-Write-Host "the server when a future version of fossa-cli enables telemetry"
-Write-Host "by default, you can pre-emptively opt out of telemetry by setting"
+Write-Host "the server, you can opt out of telemetry by setting"
 Write-Host "FOSSA_TELEMETRY_SCOPE environment variable to 'off' in your shell."
 Write-Host ""
 Write-Host "For example:"
 Write-Host "  `$env:FOSSA_TELEMETRY_SCOPE=off"
 Write-Host "   fossa analyze"
 Write-Host ""
-Write-Host "Read more: https://github.com/fossas/fossa-cli/blob/master/docs/telemetry.md"
 Write-Host ""
 Write-Host "Get started by running: fossa.exe --help"
 Write-Host "Running fossa.exe --version"

install-latest.sh

@@ -382,18 +382,17 @@ print_telemetry_disclaimer() {
   log_info "------"
   log_info ""
   log_info "FOSSA collects warnings, errors, and usage data to improve"
-	log_info "the FOSSA CLI and your experience. The CLI DOES NOT collect"  
-	log_info "telemetry by default, but this will change in future!"
+	log_info "the FOSSA CLI and your experience."  
+  log_info ""
+  log_info "Read more: https://github.com/fossas/fossa-cli/blob/master/docs/telemetry.md"
   log_info ""
   log_info "If you want to prevent any telemetry data from being sent to" 
-  log_info "the server when a future version of fossa-cli enables telemetry"
-  log_info "by default, you can pre-emptively opt out of telemetry by setting"
+  log_info "the server, you can opt out of telemetry by setting"
   log_info "FOSSA_TELEMETRY_SCOPE environment variable to 'off' in your shell."
   log_info ""
   log_info "For example:"
   log_info "   FOSSA_TELEMETRY_SCOPE=off fossa analyze"
   log_info ""
-  log_info "Read more: https://github.com/fossas/fossa-cli/blob/master/docs/telemetry.md"
   log_info ""
 }
 

src/App/Fossa/Config/Common.hs

@@ -272,7 +272,7 @@ collectAPIMetadata cfgfile cliMeta = maybe cliMeta (mergeFileCmdMetadata cliMeta
 
 collectTelemetrySink :: (Has (Lift IO) sig m, Has Diagnostics sig m) => Maybe ConfigFile -> EnvVars -> Maybe CommonOpts -> m (Maybe TelemetrySink)
 collectTelemetrySink maybeConfigFile envvars maybeOpts = do
-  let defaultScope = NoTelemetry
+  let defaultScope = FullTelemetry
   -- Precedence is
   --  (1) command line
   --  (2) environment variable

test/App/Fossa/Configuration/TelemetryConfigSpec.hs

@@ -78,10 +78,14 @@ spec :: Spec
 spec = do
   describe "telemetry configuration" $ do
     -- This needs to be updated when default telemetry model moves to opt-out.
-    it' "by default telemetry sink is nothing" $ do
+    it' "by default telemetry sink set to nothing, if api key is not provided" $ do
       sink <- collectTelemetrySink noConfig defaultEnvVars noOpts
       sink `shouldBe'` Nothing
 
+    it' "by default telemetry sink set to full telemetry" $ do
+      sink <- collectTelemetrySink noConfig defaultEnvVars (Just defaultCommonOpts{optAPIKey = Just mockApiKeyRaw})
+      sink `shouldBe'` Just (TelemetrySinkToEndpoint (ApiOpts Nothing mockApiKey defaultApiPollDelay))
+
     describe "command opts" $ do
       it' "should set sink to nothing, when off scope is provided via command opts" $ do
         sink <-