Skip to content
  • Spencer's avatar
    afb09ccf
    Transpile packages on demand, validate all TS projects (#146212) · afb09ccf
    Spencer authored
    ## Dearest Reviewers 👋 
    
    I've been working on this branch with @mistic and @tylersmalley and
    we're really confident in these changes. Additionally, this changes code
    in nearly every package in the repo so we don't plan to wait for reviews
    to get in before merging this. If you'd like to have a concern
    addressed, please feel free to leave a review, but assuming that nobody
    raises a blocker in the next 24 hours we plan to merge this EOD pacific
    tomorrow, 12/22.
    
    We'll be paying close attention to any issues this causes after merging
    and work on getting those fixed ASAP. 🚀
    
    ---
    
    The operations team is not confident that we'll have the time to achieve
    what we originally set out to accomplish by moving to Bazel with the
    time and resources we have available. We have also bought ourselves some
    headroom with improvements to babel-register, optimizer caching, and
    typescript project structure.
    
    In order to make sure we deliver packages as quickly as possible (many
    teams really want them), with a usable and familiar developer
    experience, this PR removes Bazel for building packages in favor of
    using the same JIT transpilation we use for plugins.
    
    Additionally, packages now use `kbn_references` (again, just copying the
    dx from plugins to packages).
    
    Because of the complex relationships between packages/plugins and in
    order to prepare ourselves for automatic dependency detection tools we
    plan to use in the future, this PR also introduces a "TS Project Linter"
    which will validate that every tsconfig.json file meets a few
    requirements:
    
    1. the chain of base config files extended by each config includes
    `tsconfig.base.json` and not `tsconfig.json`
    1. the `include` config is used, and not `files`
    2. the `exclude` config includes `target/**/*`
    3. the `outDir` compiler option is specified as `target/types`
    1. none of these compiler options are specified: `declaration`,
    `declarationMap`, `emitDeclarationOnly`, `skipLibCheck`, `target`,
    `paths`
    
    4. all references to other packages/plugins use their pkg id, ie:
    	
    	```js
        // valid
        {
          "kbn_references": ["@kbn/core"]
        }
        // not valid
        {
          "kbn_references": [{ "path": "../../../src/core/tsconfig.json" }]
        }
        ```
    
    5. only packages/plugins which are imported somewhere in the ts code are
    listed in `kbn_references`
    
    This linter is not only validating all of the tsconfig.json files, but
    it also will fix these config files to deal with just about any
    violation that can be produced. Just run `node scripts/ts_project_linter
    --fix` locally to apply these fixes, or let CI take care of
    automatically fixing things and pushing the changes to your PR.
    
    > **Example:** [`64e93e5`
    (#146212)](https://github.com/elastic/kibana/pull/146212/commits/64e93e580679dd55f4fdf19bd01402bc478a1a75
    
    )
    When I merged main into my PR it included a change which removed the
    `@kbn/core-injected-metadata-browser` package. After resolving the
    conflicts I missed a few tsconfig files which included references to the
    now removed package. The TS Project Linter identified that these
    references were removed from the code and pushed a change to the PR to
    remove them from the tsconfig.json files.
    
    ## No bazel? Does that mean no packages??
    Nope! We're still doing packages but we're pretty sure now that we won't
    be using Bazel to accomplish the 'distributed caching' and 'change-based
    tasks' portions of the packages project.
    
    This PR actually makes packages much easier to work with and will be
    followed up with the bundling benefits described by the original
    packages RFC. Then we'll work on documentation and advocacy for using
    packages for any and all new code.
    
    We're pretty confident that implementing distributed caching and
    change-based tasks will be necessary in the future, but because of
    recent improvements in the repo we think we can live without them for
    **at least** a year.
    
    ## Wait, there are still BUILD.bazel files in the repo
    Yes, there are still three webpack bundles which are built by Bazel: the
    `@kbn/ui-shared-deps-npm` DLL, `@kbn/ui-shared-deps-src` externals, and
    the `@kbn/monaco` workers. These three webpack bundles are still created
    during bootstrap and remotely cached using bazel. The next phase of this
    project is to figure out how to get the package bundling features
    described in the RFC with the current optimizer, and we expect these
    bundles to go away then. Until then any package that is used in those
    three bundles still needs to have a BUILD.bazel file so that they can be
    referenced by the remaining webpack builds.
    
    Co-authored-by: default avatarkibanamachine <42973632+kibanamachine@users.noreply.github.com>
    afb09ccf
    Transpile packages on demand, validate all TS projects (#146212)
    Spencer authored
    ## Dearest Reviewers 👋 
    
    I've been working on this branch with @mistic and @tylersmalley and
    we're really confident in these changes. Additionally, this changes code
    in nearly every package in the repo so we don't plan to wait for reviews
    to get in before merging this. If you'd like to have a concern
    addressed, please feel free to leave a review, but assuming that nobody
    raises a blocker in the next 24 hours we plan to merge this EOD pacific
    tomorrow, 12/22.
    
    We'll be paying close attention to any issues this causes after merging
    and work on getting those fixed ASAP. 🚀
    
    ---
    
    The operations team is not confident that we'll have the time to achieve
    what we originally set out to accomplish by moving to Bazel with the
    time and resources we have available. We have also bought ourselves some
    headroom with improvements to babel-register, optimizer caching, and
    typescript project structure.
    
    In order to make sure we deliver packages as quickly as possible (many
    teams really want them), with a usable and familiar developer
    experience, this PR removes Bazel for building packages in favor of
    using the same JIT transpilation we use for plugins.
    
    Additionally, packages now use `kbn_references` (again, just copying the
    dx from plugins to packages).
    
    Because of the complex relationships between packages/plugins and in
    order to prepare ourselves for automatic dependency detection tools we
    plan to use in the future, this PR also introduces a "TS Project Linter"
    which will validate that every tsconfig.json file meets a few
    requirements:
    
    1. the chain of base config files extended by each config includes
    `tsconfig.base.json` and not `tsconfig.json`
    1. the `include` config is used, and not `files`
    2. the `exclude` config includes `target/**/*`
    3. the `outDir` compiler option is specified as `target/types`
    1. none of these compiler options are specified: `declaration`,
    `declarationMap`, `emitDeclarationOnly`, `skipLibCheck`, `target`,
    `paths`
    
    4. all references to other packages/plugins use their pkg id, ie:
    	
    	```js
        // valid
        {
          "kbn_references": ["@kbn/core"]
        }
        // not valid
        {
          "kbn_references": [{ "path": "../../../src/core/tsconfig.json" }]
        }
        ```
    
    5. only packages/plugins which are imported somewhere in the ts code are
    listed in `kbn_references`
    
    This linter is not only validating all of the tsconfig.json files, but
    it also will fix these config files to deal with just about any
    violation that can be produced. Just run `node scripts/ts_project_linter
    --fix` locally to apply these fixes, or let CI take care of
    automatically fixing things and pushing the changes to your PR.
    
    > **Example:** [`64e93e5`
    (#146212)](https://github.com/elastic/kibana/pull/146212/commits/64e93e580679dd55f4fdf19bd01402bc478a1a75
    
    )
    When I merged main into my PR it included a change which removed the
    `@kbn/core-injected-metadata-browser` package. After resolving the
    conflicts I missed a few tsconfig files which included references to the
    now removed package. The TS Project Linter identified that these
    references were removed from the code and pushed a change to the PR to
    remove them from the tsconfig.json files.
    
    ## No bazel? Does that mean no packages??
    Nope! We're still doing packages but we're pretty sure now that we won't
    be using Bazel to accomplish the 'distributed caching' and 'change-based
    tasks' portions of the packages project.
    
    This PR actually makes packages much easier to work with and will be
    followed up with the bundling benefits described by the original
    packages RFC. Then we'll work on documentation and advocacy for using
    packages for any and all new code.
    
    We're pretty confident that implementing distributed caching and
    change-based tasks will be necessary in the future, but because of
    recent improvements in the repo we think we can live without them for
    **at least** a year.
    
    ## Wait, there are still BUILD.bazel files in the repo
    Yes, there are still three webpack bundles which are built by Bazel: the
    `@kbn/ui-shared-deps-npm` DLL, `@kbn/ui-shared-deps-src` externals, and
    the `@kbn/monaco` workers. These three webpack bundles are still created
    during bootstrap and remotely cached using bazel. The next phase of this
    project is to figure out how to get the package bundling features
    described in the RFC with the current optimizer, and we expect these
    bundles to go away then. Until then any package that is used in those
    three bundles still needs to have a BUILD.bazel file so that they can be
    referenced by the remaining webpack builds.
    
    Co-authored-by: default avatarkibanamachine <42973632+kibanamachine@users.noreply.github.com>
Loading