[bootstrap] No longer build TS refs automatically

[tylersmalley]

The building of TS references is to address Typescript being otherwise unusable in an IDE. The time this task has taken has increased greatly over the past couple of weeks as teams have migrated to project references. Quite a few folks have reached out asking how to disable this, and after discussing with @kobelb we feel that we should make it opt-in for now.

Some options which have been discussed:

• Make it opt-out
• Make it opt-in
• Convert all packages to TS references and run build_ts_refs immediately as part of bootstrap instead of waiting until the end to begin.
• No longer build Typescript references by default during bootstrap, and instead let the developer run node scripts/build_ts_refs when they feel it's necessary.
• Move to build the references asynchronously, where the bootstrap will kick off this task. This is not completely strait-forward, as we need to figure out how to communicate this to the user and ensure we're not running multiple of these.
• Attempt to improve caching ([ts/build-refs] implement experimental remote cache #91012 provides BUILD_TS_REFS_CACHE_ENABLE=true)
• Build projects using Bazel (minimum 2+ months out from being able to move forward with this Migrate Kibana plugins from TS project references into Bazel #91056)
• Address performance issues with current Typescript usage. This is hard, and not currently documented. But you can get a trace:
  • rm -rf src/core/target && ./node_modules/.bin/tsc -b src/core/tsconfig.json --extendedDiagnostics --generateTrace trace_output
  • Open chrome://tracing/ in Chrome
  • Load trace.1.json
  • The pos references a line in types.1.json

More information on project references: https://github.com/elastic/kibana/blob/master/docs/developer/best-practices/typescript.asciidoc#project-references

[mistic]

LGTM

[tylersmalley]

@brianseeders, there are issues with running scripts/build_ts_refs with symlinked node modules, which was attempted here. What would be the best way to go about running that not the main workspace and not through tasks, but not block anything downstream?

[brianseeders]

@tylersmalley You could try creating a new task in tasks.groovy that does something like

// this could go directly in the tasks array in tasks.check() like this, or you could put it in a separate function
{
  dir("${env.WORKSPACE}/kibana") {
    kibanaPipeline.scriptTask('Build TS Refs', 'test/scripts/jenkins_build_ts_refs.sh')()
  }
}

This should let a task process switch back to the original workspace to run the script. Not super great, we have to be careful we don't have multiple things running out of that workspace that could conflict with each other. Other than that, it should get the job done I think.

[tylersmalley]

@elasticmachine merge upstream

[kibanamachine]

💔 Build Failed

• continuous-integration/kibana-ci/pull-request
• Commit: 1204547
• Storybooks Preview
• Pipeline Steps (look for red circles / failed steps)
• Interpreting CI Failures

Failed CI Steps

• Check Types

Metrics [docs]

✅ unchanged

History

• 💔 Build #107864 failed da7e037
• 💔 Build #107837 failed 2eb0bb4
• 💔 Build #107578 failed 20c12bfbcabf4380d8d5cb4fc9cfd80bb702a387
• 💛 Build #107548 was flaky 4435a312e6bac9578ba35829e7de851f34bf5377

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @tylersmalley

[tylersmalley]

Holding off on attempting to fix this for CI to see how #92513 does.