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.}}

[firstmatebot]

PR Review

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

    ❌ Documentation drift: Update documentation for port changes (8080 and 80) in Dockerfile and appConfig.js.
    ❌ Security issues: Missing permission middleware on route '/get/:id'.
    ❌ Docker best practices: Implement multi-stage build in Dockerfile for smaller image size.

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

[firstmatebot]

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 was changed to 80. Ensure that the documentation reflects the correct ports for running the application.

Example documentation update:

## Running the Application

To start the application, use the following command:

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

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

Configuration

The application runs on port 80 by default unless specified otherwise in the environment variables.

[firstmatebot]

The route '/get/:id' is missing the grantAccessByPermissionMiddleware, which is essential for proper permission checks. Update the route definition to include this middleware as follows:

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

(Based on guideline 'Routes should check permissions')

[firstmatebot]

Consider using a multi-stage build in your Dockerfile to reduce the final image size and improve security. For example, you can create a build stage to install dependencies and a final stage to copy only the necessary files:

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')

[firstmatebot]

I analysed the failed pipeline job Validate docker:

Failure Analysis

The pipeline crashed during the Docker build step, specifically when executing the command to install Git using apk add --no-cache git. The logs indicate a permission issue:

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

This error suggests that the command is being run as a non-root user (appuser), which does not have the necessary permissions to install packages. The relevant line in the Dockerfile is:

USER appuser

This line sets the user context to appuser before the installation command, leading to the permission error.

Suggested Fix

To resolve this issue, you can modify the Dockerfile to install Git as the root user before switching to appuser. Here’s the suggested change:

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

This change ensures that the installation of Git occurs with the necessary permissions, allowing the Docker build to complete successfully.

[firstmatebot]

I analysed the failed pipeline job Validate docker:

Failure Analysis

The pipeline crashed during the Docker build step, specifically when executing the command to install git using apk. 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 apk add --no-cache git command is being executed as a non-root user (appuser), which does not have the necessary permissions to install packages. This issue likely existed prior to the current PR changes, as the relevant Dockerfile line is unchanged.

Suggested Fix

To resolve the permission issue, you can switch back to the root user before running the apk command and then switch back to appuser afterward. 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 required permissions while maintaining the application’s security by running the application as a non-root user afterward.