Add `keystone telemetry inform` command and update telemetry policy #9292

dcousens · 2024-08-15T04:38:24Z

This pull request adds a keystone telemetry inform command to print the consent notice - this is useful for testing:

> pnpm keystone telemetry inform
Keystone Telemetry
Keystone collects anonymous data when you run "keystone dev"

You can use "keystone telemetry --help" to update your preferences at any time

No telemetry data has been sent as part of this notice
Telemetry data will be sent the next time you run "keystone dev"

For more information, including how to opt-out see https://keystonejs.com/telemetry (updated 2024-08-20)

Additionally, as part of #9290 this pull request completes the new migration to a version 3 of the telemetry command.

Lastly, while reviewing #9290 and working on this pull request, I noticed that the database project event field was missing from our policy and JSON examples, but present in the code.

As in #9290, I will err on the side of missed consent for this and happily drop that information from the telemetry data being analysed as part of #9290.

codesandbox-ci · 2024-08-15T04:41:28Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 3dff2b2:

Sandbox	Source
@keystone-6/sandbox	Configuration

dcousens · 2024-08-15T04:42:08Z

docs/content/docs/reference/telemetry.md

@@ -63,6 +63,7 @@ Keystone collects telemetry information in the form of two different types of da
 We refer to these two different reports, as “device telemetry” and “project telemetry” respectively.

 These reports are forwarded to [https://telemetry.keystonejs.com/](https://telemetry.keystonejs.com/), and are reported separately to minimize any correlation between them insofar as the timing and grouping of that data, that an otherwise combined report may have. We are collecting these two reports for different reasons, and thus have no need to associate them.
+We differentiate and record the type and version of reports from the URL used by Keystone.


Moving forward, we'll use the /3 version in the endpoint to differentiate report schema versions in the same way we differentiate report types using /project and /device.

This makes that abundantly transparent.

dcousens · 2024-08-15T04:43:40Z

packages/core/src/lib/telemetry.ts

  console.log() // gap to help visiblity
+  console.log(`For more information, including how to opt-out see ${grey`https://keystonejs.com/telemetry`} (updated ${b`2024-08-15`})`)


As everyone will be re-informed as of #9290, this date helps to show that the information has been updated (however minor that change is)

… is sent

dcousens · 2024-08-19T23:29:15Z

docs/content/docs/reference/telemetry.md

    "@keystone-6/document-renderer": "1.1.2",
    "@keystone-6/fields-document": "5.0.2"
  },
+  "database": "postgresql",


@DavidMulder0 as in #9290, with this missed in our telemetry policy - I will set this field to NULL for any remaining telemetry data that is to be aggregated.

UPDATE ProjectEvent SET database = NULL;

dcousens · 2024-08-19T23:30:56Z

examples/custom-output-paths/my-types.ts

-  id?: import('./node_modules/.myprisma/client').Prisma.PostCreateInput['id']
-  title?: import('./node_modules/.myprisma/client').Prisma.PostCreateInput['title']
-  content?: import('./node_modules/.myprisma/client').Prisma.PostCreateInput['content']
-  publishDate?: import('./node_modules/.myprisma/client').Prisma.PostCreateInput['publishDate']


Unrelated, but this is problematic in different situations, only included in this pull request to reduce conflicts

packages/core/src/lib/telemetry.ts

kennedybaird · 2024-08-20T00:17:21Z

packages/core/src/lib/telemetry.ts


    // don't send telemetry before we inform the user, allowing opt-out
-    if (!telemetry.informedAt) return inform()
+    const telemetryDefaulted = getDefault(telemetry)
+    if (!telemetryDefaulted.informedAt) return inform(telemetryDefaulted, userConfig)


Suggest adding an explicit log here to remind that telemetry is active:

console.log('🛎️ Telemetry is enabled')

This is pretty neat, what about showing it is disabled too?

console.log('🛎️ Telemetry is enabled') // or console.log('✅ Telemetry is enabled')

and

console.log('❎ Telemetry is disabled')

At some stage I want to switch to declarative wording here rather than procedural, but we won't do that in this pull request

Example is Database unchanged versus Connecting to the database

@kennedybaird can we do this in a different pull request?
I want to merge and release this and #9290 as soon as possible

The suggested improvement might require a new set of wiring and functions, depending on how we do this

And, like in #8118 (see #8118 (comment)), the phrasing of this might resurface whether we want to try and manage our dependencies telemetry configuration too

packages/core/src/lib/telemetry.ts

kennedybaird · 2024-08-20T00:22:02Z

Added a couple of thoughts @dcousens - nice to see you jumping on this!

The only other comment is the "Package Unit Tests" failing, not sure exactly what's happening there.

dcousens · 2024-08-20T00:38:17Z

Fixed the Package Unit Tests in cd18302, jest isn't happy with dynamic imports, the same problem with #8820

dcousens added 6 commits August 15, 2024 12:30

prefer 'sent now' phrasing'

032cd5c

add strict object matches for telemetry tests

a42f104

add stricter telemetry tests and userConfig usage

ce0fce1

rename versions to packages

e3d7e2f

add inform command for inform notice, and add last updated date

36b9759

add differentiation emphasis to notice

7ea48b6

use record phrasing for type and version

639f619

dcousens commented Aug 15, 2024

View reviewed changes

dcousens changed the title ~~Add keystone telemetry inform command~~ Add keystone telemetry inform command and update telemetry policy Aug 15, 2024

dcousens added 5 commits August 15, 2024 16:30

dont throw if request has a DNS error

77e24a6

rename previous to lastSentData, update policy to show database field…

d442333

… is sent

add changeset for missing database field

fb001c3

move myprisma to node_modules/myprisma, no dot

ead420b

dont use gte comparison with date strings

1e8323a

dcousens force-pushed the telemetry-2 branch from bcd6fdd to 1e8323a Compare August 19, 2024 23:13

dcousens marked this pull request as ready for review August 19, 2024 23:16

dcousens added 3 commits August 20, 2024 09:18

revert keystonejs User-Agent

cccd82c

update policy updated date

24cac4a

upgrade telemetry endpoint to version 3

3145776

dcousens commented Aug 19, 2024

View reviewed changes

kennedybaird reviewed Aug 20, 2024

View reviewed changes

packages/core/src/lib/telemetry.ts Show resolved Hide resolved

kennedybaird reviewed Aug 20, 2024

View reviewed changes

packages/core/src/lib/telemetry.ts Outdated Show resolved Hide resolved

fix telemetry tests for jest

cd18302

add a line berak before printing status as part of inform

2884869

dcousens added 2 commits August 20, 2024 10:45

reduce linebreaks when printing inform

61079d9

vary the auxiliary verb situationally

3dff2b2

kennedybaird mentioned this pull request Aug 20, 2024

Update startup logs to include telemetry status #9299

Open

dcousens merged commit 19a734c into main Aug 20, 2024
42 of 43 checks passed

dcousens deleted the telemetry-2 branch August 20, 2024 01:15

kennedybaird approved these changes Aug 20, 2024

View reviewed changes

dcousens mentioned this pull request Aug 28, 2024

Version Packages #9312

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `keystone telemetry inform` command and update telemetry policy #9292

Add `keystone telemetry inform` command and update telemetry policy #9292

dcousens commented Aug 15, 2024 •

edited

Loading

codesandbox-ci bot commented Aug 15, 2024 •

edited

Loading

dcousens Aug 15, 2024 •

edited

Loading

dcousens Aug 15, 2024 •

edited

Loading

dcousens Aug 19, 2024

dcousens Aug 19, 2024

kennedybaird Aug 20, 2024

dcousens Aug 20, 2024 •

edited

Loading

dcousens Aug 20, 2024 •

edited

Loading

dcousens Aug 20, 2024 •

edited

Loading

dcousens Aug 20, 2024 •

edited

Loading

kennedybaird Aug 20, 2024

kennedybaird Aug 20, 2024

kennedybaird commented Aug 20, 2024

dcousens commented Aug 20, 2024

		console.log() // gap to help visiblity
		console.log(`For more information, including how to opt-out see ${grey`https://keystonejs.com/telemetry`} (updated ${b`2024-08-15`})`)

Add keystone telemetry inform command and update telemetry policy #9292

Add keystone telemetry inform command and update telemetry policy #9292

Conversation

dcousens commented Aug 15, 2024 • edited Loading

codesandbox-ci bot commented Aug 15, 2024 • edited Loading

dcousens Aug 15, 2024 • edited Loading

Choose a reason for hiding this comment

dcousens Aug 15, 2024 • edited Loading

Choose a reason for hiding this comment

dcousens Aug 19, 2024

Choose a reason for hiding this comment

dcousens Aug 19, 2024

Choose a reason for hiding this comment

kennedybaird Aug 20, 2024

Choose a reason for hiding this comment

dcousens Aug 20, 2024 • edited Loading

Choose a reason for hiding this comment

dcousens Aug 20, 2024 • edited Loading

Choose a reason for hiding this comment

dcousens Aug 20, 2024 • edited Loading

Choose a reason for hiding this comment

dcousens Aug 20, 2024 • edited Loading

Choose a reason for hiding this comment

kennedybaird Aug 20, 2024

Choose a reason for hiding this comment

kennedybaird Aug 20, 2024

Choose a reason for hiding this comment

kennedybaird commented Aug 20, 2024

dcousens commented Aug 20, 2024

Add `keystone telemetry inform` command and update telemetry policy #9292

Add `keystone telemetry inform` command and update telemetry policy #9292

dcousens commented Aug 15, 2024 •

edited

Loading

codesandbox-ci bot commented Aug 15, 2024 •

edited

Loading

dcousens Aug 15, 2024 •

edited

Loading

dcousens Aug 15, 2024 •

edited

Loading

dcousens Aug 20, 2024 •

edited

Loading

dcousens Aug 20, 2024 •

edited

Loading

dcousens Aug 20, 2024 •

edited

Loading

dcousens Aug 20, 2024 •

edited

Loading