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.

Sign up for GitHub

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

Jump to bottom

281 separate database logic from service layer #282

Merged
merged 52 commits into from
Sep 27, 2023
Merged

281 separate database logic from service layer #282

merged 52 commits into from
Sep 27, 2023

Conversation

seansica
Copy link
Contributor

@seansica seansica commented Aug 31, 2023 •
edited
Loading

Closes #281

Description:

This pull request introduces a refactored version of one of the service layer modules. The changes serve as a proof of concept for the comprehensive refactoring approach we aim to adopt across all other services.

Key Changes:

  • Transitioned service layer to use classes instead of functions.
  • Abstracted shared/common functions to eliminate code duplication.
  • Introduced a dedicated exceptions module for enhanced error handling.
  • Decoupled database logic, migrating it to a dedicated repository (DAO) layer.
  • Transitioned from using callbacks to Promises.

Next Steps:

Developers should use the project-orion branch as a base for subsequent refactorings. Please ensure all new changes are modeled after this proof of concept to maintain consistency across services.

seansica added 19 commits August 28, 2023 10:45
@seansica
Refactor matrices controller & service to use ES6 async/await notatio…
6c17230 
…n and implement new DAO/repository layer to separate DB logic from service layer
@seansica
Add new exceptions module to store custom Exception classes
bdb3feb
@seansica
Refactor matrices-service to use new exceptions module
90fbb43
@seansica
Add a few logging statements
19595fd
@seansica
Implement DTO classes for passing data between DAO, Service, and Cont…
7371856 
…roller layers
@seansica
Refactored user-accounts-service and user-accounts-controller to use …
0d342e3 
…ES8 syntax
@seansica
Remove callback from CollectionIndex.find within collection-indexes-s…
b9c1443 
…ervice.retrieveAll
@seansica
Fix use of async matrix aggregation
f3b28ea
@seansica
Upgrade mongoose from 6.5.1 to 7.5.0 as part of shift to ES8
8017090
@seansica
Add dotenv template and load envFile in VS Code launch.json for quick…
bbd794e 
… loading REST API configuration
@seansica
Create data access object for Teams model
59f8515
@seansica
Decouple database logic from user-accounts-service
4211408
@seansica
Refactor exception handling in matrices-service (still a WIP)
70e74a5
@seansica
Remove redundant async/await and some other small logging-related cha…
4192b0b 
…nges
@seansica
Add data access object for UserAccounts model
cc2cd46
@seansica
Add new exception classes
367effe
@seansica
Remove unnecessary DTO classes
d56b486
@seansica
Add more exception classes
69e84d9
@seansica
Overhaul error handling in matrices service & repository
25aa1b2
@seansica seansica changed the title 281 separate database logic from service layer Draft: 281 separate database logic from service layer Aug 31, 2023
@seansica seansica changed the base branch from develop to project-orion September 20, 2023 15:35
@seansica seansica marked this pull request as ready for review September 20, 2023 15:47
@seansica seansica changed the title Draft: 281 separate database logic from service layer 281 separate database logic from service layer Sep 20, 2023
@seansica seansica requested a review from ElJocko September 20, 2023 15:51
@seansica
Migrate pagination module to static method in _base.service
b38905d
@seansica
Remove all log statements from matrices-service + disable no-useless-…
f8b83a2 
…catch
@seansica
Disable class-methods-use-this on _base.repository save method
48cff9b
@seansica
Fix document preprocessing in _base.service create method
7b64c2e
@seansica
Remove all log statements from _base.service + disable no-useless-catch
dad913f
@seansica
Fix props passed to UserAccount model
11dbe2c
@seansica
Temporarily revert mongoose from 7.5.0 to 6.12.0 to allow static chec…
364f8dd 
…ks to succeed (will upgrade package once all services are refactored from callbacks to promises)
@seansica
Restored callback-oriented functions for user-accounts, teams-service…
2f4a8f2 
…, and collection-indexes
@seansica
Convert user-accounts-repository to class-based implementation
4fcc65b
@seansica
Rename _abstract.repository retrieve functions that end in ById to in…
0f88a37 
…stead end in ByStixId
@seansica
Pass the Matrix model to the superclass via super instead of setting …
d02369a 
…this.model in the subclass
@sonarqubecloud
Copy link

SonarCloud Quality Gate failed.    Quality Gate failed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 19 Code Smells

No Coverage information No Coverage information
6.4% 6.4% Duplication

idea Catch issues before they fail your Quality Gate with our IDE extension sonarlint SonarLint

@codecov
Copy link

codecov bot commented Sep 27, 2023

Codecov Report

Attention: 498 lines in your changes are missing coverage. Please review.

Files Coverage Δ
app/lib/attack-prefix-ids.js 100.00% <100.00%> (ø)
app/models/campaign-model.js 100.00% <100.00%> (ø)
app/models/collection-model.js 100.00% <100.00%> (ø)
app/models/data-component-model.js 100.00% <100.00%> (ø)
app/models/data-source-model.js 100.00% <100.00%> (ø)
app/models/group-model.js 100.00% <100.00%> (ø)
app/models/identity-model.js 100.00% <100.00%> (ø)
app/models/marking-definition-model.js 100.00% <100.00%> (ø)
app/models/matrix-model.js 100.00% <100.00%> (ø)
app/models/note-model.js 100.00% <100.00%> (ø)
... and 18 more

📢 Thoughts on this report? Let us know!.

@seansica
Copy link
Contributor Author

@ElJocko Changes since last review:

  • Refactor the save method
  • Move the pagination method to _base.service as a static method and delete the pagination module
  • Remove logger statements from service layer
  • Fix the failing static checks pipeline
  • Downgraded mongoose back to 6.12.0

This should be good to merge now.

@seansica seansica merged commit 02f9860 into project-orion Sep 27, 2023
2 of 5 checks passed
@seansica seansica deleted the 281-separate-database-logic-from-service-layer branch September 28, 2023 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ElJocko ElJocko Awaiting requested review from ElJocko

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@seansica