Update telemetry systemCode

[camillecroci]

Description

Summary

Reliability is working on a new client metrics server and Ivo was very proactive in adding the tool kit side of this project but a WIP means that some change might still happen. And friends, they happened. We are now requiring a systemCode at the root level of the event (so same as the namespace) which means the telemetry code needed a bit of refactoring to provide it. From my understanding, the systemCode is not a required property and could be undefined when using that little magical guessSystemCode so I took on me to provide a default one (dotcom-tool-kit) but I am open to suggestion.

Edit: looks like that pr description is still perfectly relevant to the change I did, even though I completely changed the approach, lol. But yeah, now we provide the systemCode at the root level but still get it from scoped attribute, and we remove the systemCode from the attribute when passing them as data so the systemCode is not repeated.

Relevant motivation

I was very motivated.
But also it is for tool kit to be up to date with our latest change without having to do anything about it (apart from reviewing this pr I guess)

A bit more context

This was Ivo PR to add the metrics client.

Checklist:

• My branch has been rebased onto the latest commit on main (don't merge main into your branch) (although depending on how long this takes to be merged, I might need to rebase again)
• My commit messages are conventional commits, for example: feat(circleci): add support for nightly workflows, fix: set Heroku app name for staging apps too

[Copilot]

Pull request overview

Updates Tool Kit telemetry event shape to include a required root-level systemCode, aligning with the new client-metrics-server expectations.

Changes:

• Add systemCode to the TelemetryEvent type and require it in TelemetryRecorder.recordEvent.
• Update telemetry tests and test child-process fixture to provide systemCode.
• Update CLI task execution to provide a systemCode value when recording task completion metrics.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
lib/telemetry/src/types.ts	Adds systemCode to the telemetry event contract.
lib/telemetry/src/index.ts	Updates recordEvent API to require systemCode and includes it in emitted events.
lib/telemetry/test/index.test.ts	Updates tests to pass systemCode when recording events.
lib/telemetry/test/metricsProcess.mjs	Updates child-process test fixture to pass systemCode.
core/cli/src/tasks.ts	Computes a systemCode (with fallback) and passes it into telemetry events.
core/cli/src/install.ts	Removes prior systemCode-scoping behavior when loading hook installations.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[ivomurrell]

suggestion: I think users that call the recordEvent function shouldn't have to concern themselves with metadata explicitly, and the systemCode in particular is something that should be passed around in the scoped metadata rather than calling guessSystemCode with the same fallback every time we want to record an event. I think it makes more sense to move the fallback logic here and get the systemCode from the scoped attributes?

it will also resolve the breaking change Mx LLM is talking about which is a little bit of a concern even though no one has enabled the telemetry the function arguments are still processed and will cause a TypeError if you update the telemetry package but are still using another Tool Kit package that calls the old recordEvent function.

Suggested change

	recordEvent<N extends Namespace>(namespace: N, systemCode: string, details: NamespaceSchemas[N]) {
	const event: TelemetryEvent = {
	namespace: `dotcom-tool-kit.${namespace}`,
	systemCode,
	eventTimestamp: Date.now(),
	data: { ...this.attributes, ...details }
	recordEvent<N extends Namespace>(namespace: N, details: NamespaceSchemas[N]) {
	const data = { ...this.attributes, ...details }
	const event: TelemetryEvent = {
	namespace: `dotcom-tool-kit.${namespace}`,
	systemCode: data.systemCode || 'dotcom-tool-kit',
	eventTimestamp: Date.now(),
	data

[camillecroci]

OK it took me a while to understand but i got it now and ive updated it. Let me know if you want me to remove the 4 first commits that are now completely obsolete but I am happy for them to be a testimony of my naivety

[ivomurrell]

I encourage commit squashing whenever appropriate!

[ivomurrell]

exactly what i had in mind when i gave that long winded review comment before, thank you! 😻