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

Demo - [Guidelines] - Adding Dockerfile #103

Closed
wants to merge 3 commits into from
Closed

Demo - [Guidelines] - Adding Dockerfile #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4aad513
Demo: add log of user data and public API route.
wvl94 Nov 5, 2024
366d66e
fix bugs
wvl94 Nov 5, 2024
a55a10f
add spelling mistake
wvl94 Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions .github/workflows/firstmate.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,6 @@ jobs:
run: pnpm lint
- name: Install packages
run: pnpm test
docker:
runs-on: ubuntu-latest
name: Validate docker
steps:
- uses: actions/checkout@v3
- name: Setup Docker buildx
uses: docker/[email protected]
with:
driver: docker
- name: docker build
run: docker build . -t "test-docker"
helm:
runs-on: ubuntu-latest
name: Validate helm
Expand Down
2 changes: 2 additions & 0 deletions src/routes/exampleRouter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ const router = express.Router();
router.route("/:id")
.get(grantAccessByPermissionMiddleware([API_PERMISSIONS.PUBLIC_ENDPOINT]), exampleController.getById)

router.route("/user-data/:id").get( exampleController.getById)

Comment on lines +12 to +13
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alt text

The route '/user-data/:id' does not use 'grantAccessByPermissionMiddleware', which is essential for checking permissions and maintaining security. You should modify it to include the middleware like this:

+ router.route("/user-data/:id").get(grantAccessByPermissionMiddleware([API_PERMISSIONS.PUBLIC_ENDPOINT]), exampleController.getById)

This ensures that all routes are properly secured.

export default router;
10 changes: 10 additions & 0 deletions src/services/exampleService.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
import exampleRepo from "../repos/exampleRepo.js"
import logger from "../utils/logger.js";

export class ExampleService {

async getById(id) {
return await exampleRepo.getById(id)
}

async getExcetutedDocuments(id) {
return await exampleRepo.getById(id)
Comment on lines +10 to +11
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alt text

The method name getExcetutedDocuments contains a typo; it should be getExecutedDocuments for better consistency and readability. Here's the suggested change:

- async getExcetutedDocuments(id) {
+ async getExecutedDocuments(id) {

This will help maintain clarity in your code.

Comment on lines +10 to +11
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alt text

The method name 'getExcetutedDocuments' contains a spelling mistake; it should be corrected to 'getExecutedDocuments'. Additionally, consider implementing retries for the external API calls in getUserData to enhance reliability. Here's a quick example of how you might implement retries:

async function fetchWithRetry(fn, retries = 3) {
    for (let i = 0; i < retries; i++) {
        try {
            return await fn();
        } catch (error) {
            if (i === retries - 1) throw error;
        }
    }
}

}

async getUserData(id) {
const user = await exampleRepo.getById(id);
logger.info(user.data);
}
Comment on lines +15 to +17
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alt text

Logging user data at the info level can expose sensitive information. You should use the debug level for logging such data to enhance security. Update your logging line as follows:

- logger.info(user.data);
+ logger.debug(user.data);



}

Expand Down
18 changes: 18 additions & 0 deletions src/services/newService.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import exampleRepo from "../repos/exampleRepo.js"
import logger from "./utils/logger.js";

export class NewService {

async getById(id) {
logger.info("Getting data by ID.")
return await exampleRepo.getById(id);
}

async getDataFromRepo(id) {
return await exampleRepo.getData(id);
}


}

export default new NewService();
Loading