Impossible to disable telemetry for the CLI

[dhoko]

Preliminary Checks

• This issue is not a duplicate. Before opening a new issue, please search existing issues: https://github.com/gatsbyjs/gatsby/issues
• This issue is not a question, feature request, RFC, or anything other than a bug report directly related to Gatsby. Please post those things in GitHub Discussions: https://github.com/gatsbyjs/gatsby/discussions

Description

👋

If we follow the documentation here https://www.gatsbyjs.com/docs/telemetry/ we can expect to disable the telemetry, isn't it?
It turns out, we don't.

HTTP 1524465: createConnection analytics.gatsbyjs.com:443::::::::::::::::::::: [Object: null prototype] {   
  protocol: 'https:',                                                                                       
  slashes: true,                                                                                            
  auth: null,                                                                                               
  host: 'analytics.gatsbyjs.com',                                                                           
  port: 443,                                                                                                
  hostname: 'analytics.gatsbyjs.com',                                                                       
  hash: null,                                                                                               
  search: null,                                                                                             
  query: null,                                                                                              
  pathname: '/events',                                                                                      
  path: null,                                                                                               
  href: 'https://analytics.gatsbyjs.com/events',                                                            
  method: 'POST',                                                                                           
  headers: [Object: null prototype] {                                                                       
    'content-type': [ 'application/json' ],                                                                 
    'user-agent': [ 'create-gatsby:1.11.0' ],                                                               
    Accept: [ '*/*' ],                                                                                      
    'Content-Length': [ '261' ],                                                                            
    'Accept-Encoding': [ 'gzip,deflate' ],                                                                  
    Connection: [ 'close' ]                                                                                 

Here it's an old version of the CLI, but for the latest one I may be wrong but I don't see a change based on:

• import https://github.com/gatsbyjs/gatsby/blob/master/packages/create-gatsby/src/index.ts#L14
• ex https://github.com/gatsbyjs/gatsby/blob/master/packages/create-gatsby/src/index.ts#L388
  And the source https://github.com/gatsbyjs/gatsby/blob/master/packages/create-gatsby/src/tracking.ts

edit: Post tests, we have the same issue with the latest gatsy.
Ho, what do we have here, yet another call 😁

  $ npx gatsby --version
Gatsby CLI version: 4.5.1

HTTP 1533501: call onSocket 0 0
HTTP 1533501: createConnection analytics.gatsbyjs.com:443::::::::::::::::::::: [Object: null prototype] {
  protocol: 'https:',
  slashes: true,
  auth: null,
  host: 'analytics.gatsbyjs.com',
  port: 443,
  hostname: 'analytics.gatsbyjs.com',
  hash: null,
  search: null,
  query: null,
  pathname: '/events',
  path: null,
  href: 'https://analytics.gatsbyjs.com/events',
  method: 'POST',
  headers: [Object: null prototype] {
    'content-type': [ 'application/json' ],
    'user-agent': [ 'create-gatsby:2.5.0' ],
    Accept: [ '*/*' ],
    'Content-Length': [ '260' ],
    'Accept-Encoding': [ 'gzip,deflate' ],
    Connection: [ 'close' ]
  },
  agent: undefined,
  _defaultAgent: Agent {
    _events: [Object: null prototype] {
      free: [Function (anonymous)],
      newListener: [Function: maybeEnableKeylog]
    },
    _eventsCount: 2,
    _maxListeners: undefined,
    defaultPort: 443,
    protocol: 'https:',
    options: [Object: null prototype] { path: null },
    requests: [Object: null prototype] {},
    sockets: [Object: null prototype] {
      'analytics.gatsbyjs.com:443:::::::::::::::::::::': []
    },
    freeSockets: [Object: null prototype] {},
    keepAliveMsecs: 1000,
    keepAlive: false,
    maxSockets: Infinity,
    maxFreeSockets: 256,
    scheduling: 'lifo',
    maxTotalSockets: Infinity,
    totalSocketCount: 0,
    maxCachedSessions: 100,
    _sessionCache: { map: {}, list: [] },
    [Symbol(kCapture)]: false
  },
  servername: 'analytics.gatsbyjs.com',
  _agentKey: 'analytics.gatsbyjs.com:443:::::::::::::::::::::'
}
HTTP 1533501: sockets analytics.gatsbyjs.com:443::::::::::::::::::::: 1 1
HTTP 1533501: write ret = true
HTTP 1533501: outgoing message end.

Reproduction Link

https://github.com/gatsbyjs/gatsby/blob/master/packages/create-gatsby/src/tracking.ts

Steps to Reproduce

1. Follow the steps https://github.com/gatsbyjs/gatsby#-get-up-and-running-in-5-minutes
2. export NODE_DEBUG=http
3. npx gatsby telemetry --disable it works by adding to the env export GATSBY_TELEMETRY_DISABLED=1 then ex: gatsby develop

Expected Result

No call to the telemetry API.

The CLI should use this code instead of its own:

gatsby/packages/gatsby-telemetry/src/telemetry.ts

Lines 241 to 253 in 64ff3c6

	trackCli(
	type: string | Array<string> = ``,
	tags: ITelemetryTagsPayload = {},
	opts: ITelemetryOptsPayload = { debounce: false }
	): void {
	if (!this.isTrackingEnabled()) {
	return
	}
	if (typeof tags.siteHash === `undefined`) {
	tags.siteHash = this.siteHash
	}
	this.captureEvent(type, tags, opts)
	}

Actual Result

It's quite funny to see this

$ npx gatsby telemetry --disable

Telemetry collection disabled

HTTP 1532457: call onSocket 0 0
HTTP 1532457: createConnection analytics.gatsbyjs.com:443::::::::::::::::::::: [Object: null prototype] {
  protocol: 'https:',
  slashes: true,
  auth: null,
  host: 'analytics.gatsbyjs.com',
  port: 443,
  hostname: 'analytics.gatsbyjs.com',
  hash: null,
  search: null,
  query: null,
  pathname: '/events',
  path: null,
  href: 'https://analytics.gatsbyjs.com/events',
  method: 'POST',
  headers: [Object: null prototype] {
    'content-type': [ 'application/json' ],
    'user-agent': [ 'create-gatsby:2.5.0' ],
    Accept: [ '*/*' ],
    'Content-Length': [ '260' ],
    'Accept-Encoding': [ 'gzip,deflate' ],
    Connection: [ 'close' ]
  },
  agent: undefined,
  _defaultAgent: Agent {
    _events: [Object: null prototype] {
      free: [Function (anonymous)],
      newListener: [Function: maybeEnableKeylog]
    },
    _eventsCount: 2,
    _maxListeners: undefined,
    defaultPort: 443,
    protocol: 'https:',
    options: [Object: null prototype] { path: null },
    requests: [Object: null prototype] {},
    sockets: [Object: null prototype] {
      'analytics.gatsbyjs.com:443:::::::::::::::::::::': []
    },
    freeSockets: [Object: null prototype] {},
    keepAliveMsecs: 1000,
    keepAlive: false,
    maxSockets: Infinity,
    maxFreeSockets: 256,
    scheduling: 'lifo',
    maxTotalSockets: Infinity,
    totalSocketCount: 0,
    maxCachedSessions: 100,
    _sessionCache: { map: {}, list: [] },
    [Symbol(kCapture)]: false
  },
  servername: 'analytics.gatsbyjs.com',
  _agentKey: 'analytics.gatsbyjs.com:443:::::::::::::::::::::'
}
HTTP 1532457: sockets analytics.gatsbyjs.com:443::::::::::::::::::::: 1 1
HTTP 1532457: write ret = true
HTTP 1532457: outgoing message end.

Environment

System: Ubuntu 20.04LTS
Node 16 + npm 8

Config Flags

NODE_DEBUG=http
GATSBY_TELEMETRY_DISABLED=1

[LekoArts]

Thanks for the report, we'll get it fixed! :)

This was certainly not intentional, sorry for that. We didn't add gatsby-telemetry to create-gatsby to keep it lightweight but missed this portion when reimplementing it.