[Usage Collection & Telemetry] Migrate to TS project references

[TinaHeiligers]

Summary

Now that the Kibana build system supports using TypeScript project references (#46773), the telemetry-related plugins must be migrated to participate. This is part of the overall effort tracked at #80508.

plugin	migration status
kibana_usage_collection	✅
newsfeed	✅
telemetry	✅
telemetry_collection_manager	✅
telemetry_management_section	✅
usage_collection	✅
telemetry_collection_xpack	✅

Migration order:

• 1. usage_collection (Usage collection plugins to ts project refs #81090)
• 2. telemetry_collection_manager (Usage collection plugins to ts project refs #81090)
• 3. telemetry (Usage collection plugins to ts project refs #81090)
• 4. kibana_usage_collection (Kibana usage collection to ts project refs #81265)
• 5. telemetry_collection_xpack (Telemetry collection xpack to ts project references #81269)
• 6. telemetry_management_section (has blockers) (Converts Telemetry Management Section to TS project refs #88073)
• Newsfeed can be migrated at any time (Extracts newsfeed plugin to ts project refs #81254).

Blockers (removed)

telemetry_management_section depends on migration of the following first:

• advancedSettings (Kibana app and presentation ts projects #87639)
• management ([DX] Management to TS projects #87660)
• home ([DX] Home & SO tagging OSS to TS projects #87610)
• data (Migrate App services plugins to TS projects #87294)
• bfetch (Migrate App services plugins to TS projects #87294)
• expressions (Migrate App services plugins to TS projects #87294)
• inspector (Add TS project references for inspector  #81792)
• uiActions (Migrate App services plugins to TS projects #87294)
• usageCollection (Usage collection plugins to ts project refs #81090)
• urlForwarding (Add tsconfig for url_forwarding #81177)
• kibanaLegacy (Add TS config for kibana_legacy #80992)
• telemetry (Usage collection plugins to ts project refs #81090)
• telemetryCollectionManager (Usage collection plugins to ts project refs #81090)

Acceptance criteria

The telemetry-related plugins can be referred to using a project reference, which means each...

• has a tsconfig.json file which conforms to the documented form
• references the dependencies
• emits type definitions for its public API
• compiles in tsc's build mode

Related information

• https://github.com/elastic/kibana/blob/master/docs/developer/best-practices/typescript.asciidoc#project-references
• https://www.typescriptlang.org/docs/handbook/project-references.html

[elasticmachine]

Pinging @elastic/kibana-telemetry (Team:KibanaTelemetry)

[Bamieh]

Thanks for creating the issue!

[TinaHeiligers]

@restrry QQ on the guide's instructions:

List the reference to your newly created project in all the Kibana tsconfig.json files that could import your project: tsconfig.json, test/tsconfig.json, x-pack/tsconfig.json, x-pack/test/tsconfig.json. And in all the plugin-specific tsconfig.refs.json for dependent plugins.

I see some non-xpack plugins (e.g. kibana-legacy) aren't listed as refs in https://github.com/elastic/kibana/blob/master/x-pack/tsconfig.json and I've added some telemetry related ones. When should we be adding non-xpack refs and should I remove the telemetry related ones from exclude in that file?

[mshustov]

I see some non-xpack plugins (e.g. kibana-legacy) aren't listed as refs in https://github.com/elastic/kibana/blob/master/x-pack/tsconfig.json and I've added some telemetry related ones.
When should we be adding non-xpack refs

That's okay, we do this to reduce number of processed for x-pack/tsconfig.json project.
node --max-old-space-size=6144 ./node_modules/.bin/tsc -p x-pack/tsconfig.json --extendedDiagnostics --noEmit
With project listed in refs: Files: 18224
without: Files: 18277

should I remove the telemetry related ones from exclude in that file?

Yes, you can delete them from excluded because src/plugins/** files do not belong to x-pack/tsconfig project.

We are going to delete all include & exclude sections as soon as all the code migrate to TS project refs.

[TinaHeiligers]

@restrry thanks!
I'm trying to migrate the telemetry_collection_xpack plugin in PR 81269 and keep running into the following error with typescript checks:

18:34:25  /dev/shm/workspace/parallel/13/kibana/src/dev/typescript/project.ts:33
18:34:25      throw error;
18:34:25      ^
18:34:25  [object Object]

When I run node scripts/type_check locally, I also get that error and it's not very descriptive as to where the problem is. The plugin only has one other as a dependency and the tsconfig.json is fairly simple but obviously something's wrong. Have you seen this before and, if so, how would I get around it?

For anyone who happens to come across the same issue, the resolution was to fix the formatting in the tsconfig.json files.

[TinaHeiligers]

@afharo Update: The blockers for migrating the telemetry_management_section plugin are still preventing us from finishing the work.

[elasticmachine]

Pinging @elastic/kibana-core (Team:Core)

[afharo]

Update: still these blockers:

➜  kibana git:(master) node scripts/find_plugins_without_ts_refs.js --id telemetryManagementSection
 info Dependencies haven't been migrated to TS project refs yet:
      advancedSettings
      management
      home
      data
      bfetch
      expressions
      uiActions

[TinaHeiligers]

Status update: The blockers listed previously are still holding up this work:

➜  kibana git:(master) node scripts/find_plugins_without_ts_refs.js --id telemetryManagementSection
 info Dependencies haven't been migrated to TS project refs yet:
      advancedSettings
      management
      home
      data
      bfetch
      expressions
      uiActions