add docker & api route

[wvl94]

💡 PR Summary generated by FirstMate

Overview: Added Docker support and a new API route for enhanced functionality.

Changes:
Dockerfile creation:

• Added a Dockerfile to containerize the application using Node.js 19-alpine.
• Set environment variable for PORT and configured user permissions.

API route update:

• Introduced a new GET route /get/:id in exampleRouter.js for fetching data by ID.

Configuration change:

• Updated appConfig.js to change default server port from 8080 to 80.

TLDR: This PR adds Docker support, introduces a new API route, and modifies the default server port. Review the Dockerfile and new route in exampleRouter.js for key changes.

_{^{Generated by FirstMate and automatically updated on every commit.}}

[firstmate]

PR Review

⚠️ It seems that you can still improve the quality of your PR:

    ❌ Documentation drift: Update documentation for port changes in Dockerfile and appConfig.js.
    ❌ Security issues: Add grantAccessByPermissionMiddleware to '/get/:id' route for permission checks.
    ❌ Docker best practices: Implement multi-stage builds in Dockerfile for efficiency and security.

_{^{Generated by Firstmate to make sure you can focus on coding new features.}}

[firstmate]

You changed the application to run on port 8080 in the Dockerfile. This change seems important, so it might be smart to change the documentation accordingly. Additionally, the default server port in appConfig.js has been changed to 80. Ensure the documentation reflects the correct port settings for running the application.

Example documentation update:

## Running the Application

To run the application, use the following command:

```bash
docker run -p 8080:8080 your-image-name

The application will be accessible at http://localhost:8080.

[firstmate]

The newly added route '/get/:id' does not use the grantAccessByPermissionMiddleware for permission checks, which is against the guidelines. You should update the route to include the middleware like this:

router.route("/get/:id").get(grantAccessByPermissionMiddleware([API_PERMISSIONS.PUBLIC_ENDPOINT]), exampleController.getById);

This will ensure that all routes adhere to the security requirements.

(Based on guideline 'Routes should check permissions')

[firstmate]

Your Dockerfile should implement multi-stage builds to enhance build efficiency and security. Consider separating the build and production stages as follows:

FROM node:19-alpine AS build
WORKDIR /usr/src/app
COPY package*.json ./
RUN npm install
COPY . .

FROM node:19-alpine
WORKDIR /usr/src/app
COPY --from=build /usr/src/app .
EXPOSE 8080
CMD ["npm", "start", "--no-update-notifier"]

(Based on guideline 'Dockerfiles should use multi-stage builds')

[firstmate]

I analysed the failed pipeline job Validate docker:

Failure Analysis

The pipeline crashed during the Docker build step, specifically when attempting to install git using the command apk add --no-cache git. The error message indicates a permission issue:

ERROR: Unable to lock database: Permission denied
ERROR: Failed to open apk database: Permission denied

This suggests that the RUN command is being executed as a non-root user (appuser), which does not have the necessary permissions to install packages. This issue likely existed before the current PR changes, as the Dockerfile structure indicates that the USER appuser line precedes the apk add command.

Suggested Fix

To resolve the permission issue, you can modify the Dockerfile to switch back to the root user before installing git, and then switch back to appuser afterward. Here’s how you can adjust the Dockerfile:

-    USER appuser
+    USER root
     RUN apk add --no-cache git
+    USER appuser

This change allows the installation of git to proceed with the necessary permissions while maintaining the intended user context for subsequent commands.

[firstmate]

I analysed the failed pipeline job Validate docker:

Failure Analysis

The pipeline crashed during the Docker build step, specifically when attempting to install git using the command apk add --no-cache git. The error message indicates a permission issue:

ERROR: Unable to lock database: Permission denied
ERROR: Failed to open apk database: Permission denied

This suggests that the RUN command is being executed as a non-root user (appuser), which does not have the necessary permissions to install packages. This issue likely existed before the current PR changes, as the Dockerfile structure indicates that the USER appuser line precedes the apk add command.

Suggested Fix

To resolve the permission issue, you can switch back to the root user before running the apk add command and then switch back to appuser. Modify the Dockerfile as follows:

- USER appuser
+ USER root
RUN apk add --no-cache git
+ USER appuser

This change allows the installation of git with the necessary permissions while maintaining the application’s security by running the application as a non-root user afterward.