Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renaming and Moving helper functions and its folder on CSP Package #202242

Open
animehart opened this issue Nov 28, 2024 · 2 comments
Open

Renaming and Moving helper functions and its folder on CSP Package #202242

animehart opened this issue Nov 28, 2024 · 2 comments
Labels
Team:Cloud Security Cloud Security team related technical debt Improvement of the software architecture and operational architecture

Comments

@animehart
Copy link
Contributor

** Summary **

Currently Almost all of the Helper function in

x-pack/packages/kbn-cloud-security-posture/common/utils/helpers.ts

are related to queries, as mentioned in this discussion , at some point in the future it might become kitchen sink of common functions and it becomes hard to reorganize the structure later especially when other plugins starts using it.

The suggestion is to rename the folder to queries.ts as well as move non query related function to other file or as its own file

x-pack/packages/kbn-cloud-security-posture/common/queries.ts
@animehart animehart added the Team:Cloud Security Cloud Security team related label Nov 28, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-cloud-security-posture (Team:Cloud Security)

@animehart animehart added the technical debt Improvement of the software architecture and operational architecture label Nov 28, 2024
@seanrathier
Copy link
Contributor

seanrathier commented Nov 28, 2024

Since all of the kbn-cloud-security-posture shared package's exported functions are assumed to be commonly shared functions, it would be better for us to avoid naming the files and directories like utils and helpers. Furthermore, we should remove the common directory in favor of a more compact library structure

@oren-zohar oren-zohar changed the title [Cloud Security][Tech Debt] Renaming and Moving helper functions and its folder on CSP Package Renaming and Moving helper functions and its folder on CSP Package Dec 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Cloud Security Cloud Security team related technical debt Improvement of the software architecture and operational architecture
Projects
None yet
Development

No branches or pull requests

3 participants