kffl / bsdetector-server Goto Github PK

• Smell is based on traversing AST.
• Smell is detected when the number of characters in the identifier is less than 3.
• Smell is not detected when the number of characters in the identifier is greater than or equal to 3.

Allow repository upload for analysis

Switch statements should have at minimum 3 case clauses - instead it's better to use an if statement.

• Smell is based on traversing AST.
• Smell is detected when the number of case clauses in the switch statement is less than 3.
• Smell is not detected when the number of case clauses in the switch statement is greater than or equal to 3.

Related frontend issue:

kffl/bsdetector-client#22

Description

Acceptance criteria

• It should return number of: lines, repos, files analyzed and smells detected
• It should not require additional DB setup
• It should be able to initialize empty database

• Smell is based on traversing AST.
• Smell is detected when the number of characters in the identifier is greater than 30.
• Smell is not detected when the number of characters in the identifier is less than or equal to 30.

As of now, the app allows users to either paste the code for analysis or select a single file for upload. The latter should be extended to support uploading and analyzing multiple files at once.

• The app should allow users to analyze multiple files at once
• Maximum number of files uploaded for analysis should be 10

• Smell is based on traversing AST.
• Smell is detected when the number of functions for a chain with the dot operator is greater than 6.
• Smell is not detected when the number of functions for a chain with the dot operator is less than or equal to 6.

• Add social login via GitHub OAuth
• Allow users to choose private GitHub repo for analysis
• Session id/token shall not be saved in browsers history upon successful auth via GitHub, after user is redirected to backend service and his access code is traded for an access token - secure redirection back to frontend SPA.

• It should read JS code from textbox
• It should read JS code from attached file

Related frontend issue:

none

Description

Implement backend tests.

Acceptance criteria

• At least 2/3 of smells shall have tests set up
• If mocking AST nodes turns out to be too time consuming, these can alternatively be implemented as integration tests expecting a detection of defined smells in sample JS code.

Fetch a public github repo for analysis via download link.

• App will search the specified public GH repo for all js files and analyze them
• App will not analyze files larger than 1MB
• App will not analyze more than 50 js files at once
• App will not analyze .min.js files, bundled js files and other repo junk

• Smells are based on traversing AST.
• First smell is detected when the number of parameters for a regular function is greater than 5.
• First smell is not detected when the number of parameters for a regular function is less than or equal to 5.
• Second smell is detected when the number of parameters for an arrow function is greater than 4.
• Second smell is not detected when the number of parameters for an arrow function is less than or equal to 4.

• Backend CI/CD
• Frontend CI/CD
• End2end testing with cypress

Related frontend issue:

TBD

Description

Add detection of 'Too many consecutive brackets' code smell. It occurs if there are more than three subsequent brackets in one line of code.

Acceptance criteria

• It should detect more than 3 consecutive brackets (either ( or {)
• It should not highlight more than one occurrence per line of code

• It should build an AST out of sent code
• It should DFS through the AST

Add an option to analyze entire uploaded repo and parse JS files differently depending on whether these are scripts or modules.

• Allow repo upload in zip
• Analyze each js file in repo

• Smell is based on traversing AST.
• Smell is detected when the level of nested functions is greater than 3.
• Smell is not detected when the level of nested functions is less than or equal to 3.

• Smell is based on traversing AST.
• Smell is detected when the number of chars per line is greater than 140.
• Smell is not detected when the number of chars per line is less than or equal to 140.

• Smell is detected when the number of method code lines is greater than 40.
• Smell is not detected when the number of method code lines is less than or equal to 40.