Add configuration to unused files #6782

yenienserrano · 2024-06-19T16:45:59Z

Description

Add eslint settings to know which export is not being used and to identify unused files.

Tasks

Add linter rule to detect unused exports
Add knip tool and script to detect unused files
Fix package scripts for main plugin related to lint the code
Fix package script form main plugin related to fomat the code with prettier
Remove unused files
Move some imports to import from index.{js,ts} instead of specific file

Issues Resolved

Identify unused files #6748

Evidence

Knip

yarn knip
yarn run v1.22.22
$ knip --files
✂️  Excellent, Knip found no issues.
✨  Done in 4.47s.

Details

yarn lint:public | grep 'import/no-unused-modules'
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
  1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
  1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
  1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found      import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
  1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found                          import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
  1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
  1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found         import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
  1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
  1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1    error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found                                                                                                                                                                                                                                                                                                                                                                                        import/no-unused-modules
  1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
  1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
  1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
  1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
    1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
  1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
     1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1    error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1    error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
  1:1  error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
   1:1   error  Definition for rule 'import/no-unused-modules' was not found  import/no-unused-modules
error Command failed with exit code 1.

Test

Run the yarn knip.
In the main plugin you should not have any unused files.
Add a file that is not used anywhere and re-run the command
The file should appear as unused
Smoke test of the application
Everything should work as it should

Check List

All tests pass
- yarn test:jest
New functionality includes testing.
New functionality has been documented.
Update CHANGELOG.md
Commits are signed per the DCO using --signoff

plugins/main/package.json

Co-authored-by: Antonio <34042064+Desvelao@users.noreply.github.com>

plugins/main/package.json

plugins/main/server/routes/wazuh-elastic.ts

plugins/wazuh-check-updates/package.json

plugins/wazuh-core/package.json

JuanGarriuz · 2024-06-26T11:38:33Z

Test

Knip no issues 🟢

yarn knip                             
yarn run v1.22.19
warning Skipping preferred cache folder "/home/node/.cache/yarn" because it is not writable.
warning Selected the next writable cache folder in the list, will be "/tmp/.yarn-cache-1000".
$ knip --files
✂️  Excellent, Knip found no issues.
Done in 8.39s.

Knip issues 🟢

yarn knip
yarn run v1.22.19
warning Skipping preferred cache folder "/home/node/.cache/yarn" because it is not writable.
warning Selected the next writable cache folder in the list, will be "/tmp/.yarn-cache-1000".
$ knip --files
public/react-services/interfaces/no-export.js
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

…o enhancement/6748-identify-unused-files

Desvelao · 2024-06-26T15:05:47Z

🟢 Test

In the main plugin you should not have any unused files:

node@osd:~/kbn/plugins/wazuh$ yarn knip
yarn run v1.22.19
warning Skipping preferred cache folder "/home/node/.cache/yarn" because it is not writable.
warning Selected the next writable cache folder in the list, will be "/tmp/.yarn-cache-1000".
$ knip --files
✂️  Excellent, Knip found no issues.
Done in 11.62s.

Adding a unused file:

node@osd:~/kbn/plugins/wazuh$ yarn knip 
yarn run v1.22.19
warning Skipping preferred cache folder "/home/node/.cache/yarn" because it is not writable.
warning Selected the next writable cache folder in the list, will be "/tmp/.yarn-cache-1000".
$ knip --files
common/unused_file.ts
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

github-actions · 2024-06-26T15:08:42Z

Wazuh Check Updates plugin code coverage (Jest) test	%	values
Statements	76.44%	( 172 / 225 )
Branches	58.65%	( 61 / 104 )
Functions	61.7%	( 29 / 47 )
Lines	76.44%	( 172 / 225 )

github-actions · 2024-06-26T15:08:54Z

Wazuh Core plugin code coverage (Jest) test	%	values
Statements	45.96%	( 399 / 868 )
Branches	41.97%	( 157 / 374 )
Functions	44.01%	( 136 / 309 )
Lines	46.16%	( 397 / 860 )

github-actions · 2024-06-26T15:13:42Z

Main plugin code coverage (Jest) test	%	values
Statements	13.65%	( 3993 / 29233 )
Branches	9.1%	( 1743 / 19149 )
Functions	13.36%	( 944 / 7065 )
Lines	13.84%	( 3890 / 28093 )

Desvelao

LGTM!

yenienserrano added 2 commits June 19, 2024 18:39

Add config and dependencies

69be282

Remove unused files

f50f783

Desvelao reviewed Jun 20, 2024

View reviewed changes

plugins/main/package.json Outdated Show resolved Hide resolved

Desvelao assigned yenienserrano Jun 20, 2024

Desvelao linked an issue Jun 24, 2024 that may be closed by this pull request

Identify unused files #6748

Closed

1 task

yenienserrano and others added 8 commits June 24, 2024 16:15

Merge branch '4.9.0' into enhancement/6748-identify-unused-files

2f3c162

Update plugins/main/package.json

bedaf00

Co-authored-by: Antonio <34042064+Desvelao@users.noreply.github.com>

Remove unused files

dbd22f5

Add knip ignore script folder

a960909

Change imports index file

787ccdc

Remove old visualizations

5e53ca1

Fix yarn lint command

0b747e4

Add lint and knip all plugins

f00a26c

yenienserrano marked this pull request as ready for review June 24, 2024 20:43

Desvelao reviewed Jun 25, 2024

View reviewed changes

plugins/main/package.json Outdated Show resolved Hide resolved

Desvelao reviewed Jun 25, 2024

View reviewed changes

plugins/main/server/routes/wazuh-elastic.ts Show resolved Hide resolved

Desvelao reviewed Jun 25, 2024

View reviewed changes

plugins/wazuh-check-updates/package.json Outdated Show resolved Hide resolved

Desvelao reviewed Jun 25, 2024

View reviewed changes

plugins/wazuh-core/package.json Outdated Show resolved Hide resolved

yenienserrano and others added 3 commits June 25, 2024 15:07

Change typescript devDependencies

3baa080

Add changelog remove endpoints

9607d65

Merge branch '4.9.0' into enhancement/6748-identify-unused-files

8f5da87

JuanGarriuz self-requested a review June 25, 2024 14:41

Merge branch '4.9.0' of https://github.com/wazuh/wazuh-kibana-app int…

6684dc7

…o enhancement/6748-identify-unused-files

fix(changelog): edit entry

fd613a1

Desvelao approved these changes Jun 26, 2024

View reviewed changes

JuanGarriuz approved these changes Jun 27, 2024

View reviewed changes

Desvelao merged commit 06f52c2 into 4.9.0 Jun 27, 2024
4 checks passed

Desvelao deleted the enhancement/6748-identify-unused-files branch June 27, 2024 07:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add configuration to unused files #6782

Add configuration to unused files #6782

yenienserrano commented Jun 19, 2024 •

edited by Desvelao

Loading

JuanGarriuz commented Jun 26, 2024

Desvelao commented Jun 26, 2024

github-actions bot commented Jun 26, 2024

github-actions bot commented Jun 26, 2024

github-actions bot commented Jun 26, 2024

Desvelao left a comment

Add configuration to unused files #6782

Add configuration to unused files #6782

Conversation

yenienserrano commented Jun 19, 2024 • edited by Desvelao Loading

Description

Tasks

Issues Resolved

Evidence

Test

Check List

JuanGarriuz commented Jun 26, 2024

Test

Knip no issues 🟢

Knip issues 🟢

Desvelao commented Jun 26, 2024

github-actions bot commented Jun 26, 2024

github-actions bot commented Jun 26, 2024

github-actions bot commented Jun 26, 2024

Desvelao left a comment

Choose a reason for hiding this comment

yenienserrano commented Jun 19, 2024 •

edited by Desvelao

Loading