[Security Solutions] Removes tech debt of exporting all from linter rule for security_solution plugin #120188
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FrankHassanabad
added
v8.0.0
v8.1.0
release_note:skip
FrankHassanabad
changed the title
💚 Build Succeeded
Metrics [docs]Public APIs missing comments
Any counts in public APIs
Async chunks
Public APIs missing exports
Page load bundle
History
To update your PR or re-run it, just comment with: |
yctercero
reviewed
Dec 2, 2021
| @@ -14,7 +14,7 @@ import { TimelineEventsDetailsItem } from '../../../../common/search_strategy'; | |||
| import { useRuleWithFallback } from '../../../detections/containers/detection_engine/rules/use_rule_with_fallback'; | |||
|
|
|||
| import { TestProviders, TestProvidersComponent } from '../../mock'; | |||
| import { TimelineId } from '../../../../common'; | |||
| import { TimelineId } from '../../../../common/types'; | |||
There was a problem hiding this comment.
can this be a import type?
There was a problem hiding this comment.
These can, but most of the times these are auto-inferred by typescript. There are linter rules for forcing these with an auto-fix as well so I am not going to overly worry about them in these few cases for this PR.
yctercero
reviewed
Dec 2, 2021
| @@ -14,7 +14,8 @@ import { BrowserFields } from '../../containers/source'; | |||
| import { OnUpdateColumns } from '../../../timelines/components/timeline/events'; | |||
| import * as i18n from './translations'; | |||
| import { EventFieldsData } from './types'; | |||
| import { BrowserField, ColumnHeaderOptions } from '../../../../common'; | |||
| import { ColumnHeaderOptions } from '../../../../common/types'; | |||
There was a problem hiding this comment.
Same here, can these be import type?
There was a problem hiding this comment.
These can, but most of the times these are auto-inferred by typescript. There are linter rules for forcing these with an auto-fix as well so I am not going to overly worry about them in these few cases for this PR.
yctercero
approved these changes
Dec 2, 2021
FrankHassanabad
removed
the
auto-backport
FrankHassanabad
added a commit
to FrankHassanabad/kibana
that referenced
this pull request
Dec 2, 2021
…ule for security_solution plugin (elastic#120188) ## Summary See: elastic#110903 This removes the top level API `export *` spots from: * `security_solution` plugin by removing _all_ the exports from `security_solution/common/index.ts` since non of those were shared outside this plugin. Look at the metrics from the build below and you will see _huge_ drops off numbers across the board for required API documentation to the page load size. In the file `security_solution/common/index.ts` I now put the advice of: ``` // Careful of exporting anything from this file as any file(s) you export here will cause your page bundle size to increase. // If you're using functions/types/etc... internally it's best to import directly from their paths than expose the functions/types/etc... here. // You should _only_ expose functions/types/etc... that need to be shared with other plugins here. ``` But really I doubt we will have to share anything from `security_solutions` plugin to another plugin or expose it for anyone else. So I think this is 👍 the way forward to not expose anything directly from `security_solution/common/index.ts` anymore.
FrankHassanabad
added a commit
that referenced
this pull request
Dec 2, 2021
…ule for security_solution plugin (#120188) (#120270) ## Summary See: #110903 This removes the top level API `export *` spots from: * `security_solution` plugin by removing _all_ the exports from `security_solution/common/index.ts` since non of those were shared outside this plugin. Look at the metrics from the build below and you will see _huge_ drops off numbers across the board for required API documentation to the page load size. In the file `security_solution/common/index.ts` I now put the advice of: ``` // Careful of exporting anything from this file as any file(s) you export here will cause your page bundle size to increase. // If you're using functions/types/etc... internally it's best to import directly from their paths than expose the functions/types/etc... here. // You should _only_ expose functions/types/etc... that need to be shared with other plugins here. ``` But really I doubt we will have to share anything from `security_solutions` plugin to another plugin or expose it for anyone else. So I think this is 👍 the way forward to not expose anything directly from `security_solution/common/index.ts` anymore.
TinLe
pushed a commit
to TinLe/kibana
that referenced
this pull request
Dec 22, 2021
…ule for security_solution plugin (elastic#120188) ## Summary See: elastic#110903 This removes the top level API `export *` spots from: * `security_solution` plugin by removing _all_ the exports from `security_solution/common/index.ts` since non of those were shared outside this plugin. Look at the metrics from the build below and you will see _huge_ drops off numbers across the board for required API documentation to the page load size. In the file `security_solution/common/index.ts` I now put the advice of: ``` // Careful of exporting anything from this file as any file(s) you export here will cause your page bundle size to increase. // If you're using functions/types/etc... internally it's best to import directly from their paths than expose the functions/types/etc... here. // You should _only_ expose functions/types/etc... that need to be shared with other plugins here. ``` But really I doubt we will have to share anything from `security_solutions` plugin to another plugin or expose it for anyone else. So I think this is 👍 the way forward to not expose anything directly from `security_solution/common/index.ts` anymore.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
See: #110903
This removes the top level API
export *spots from:security_solutionpluginby removing all the exports from
security_solution/common/index.tssince non of those were shared outside this plugin. Look at the metrics from the build below and you will see huge drops off numbers across the board for required API documentation to the page load size.In the file
security_solution/common/index.tsI now put the advice of:But really I doubt we will have to share anything from
security_solutionsplugin to another plugin or expose it for anyone else. So I think this is 👍 the way forward to not expose anything directly fromsecurity_solution/common/index.tsanymore.