add docker & api route

[wvl94]

💡 PR Summary generated by FirstMate

Overview: Added Docker support and a new API route for fetching examples by ID.

Changes:
Dockerfile:

• Created a Dockerfile using Node.js 19-alpine for containerization.
• Set working directory, added user/group, and installed Git.

API Route Update:

• Added a new GET route /get/:id in exampleRouter.js for fetching example data.

Configuration Change:

• Updated default server port in appConfig.js from 8080 to 80 for consistency.

TLDR: Introduced Docker support and a new API route for fetching examples, while updating the server port configuration. Review the Dockerfile and 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 default server port change from 8080 to 80.
    ❌ Docker best practices: Implement multi-stage builds in Dockerfile for optimized image size.
    ❌ Security issues: Add grantAccessByPermissionMiddleware to '/get/:id' route for permission checks.

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

[firstmatebot]

You changed the default server port from 8080 to 80. This change seems important, so it might be smart to change the documentation accordingly. Update the documentation to reflect the new default port.

For example:

## Running the Application

To start the application, use:

```bash
npm start

The application will now run on port 80 by default.

[firstmatebot]

Your Dockerfile should implement multi-stage builds to optimize image size and improve build performance. Consider using a builder stage to install dependencies and build the application, then copy the necessary files to a smaller runtime image. Here's an example:

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

# Production stage
FROM node:19-alpine
WORKDIR /usr/src/app
COPY --from=builder /usr/src/app/dist ./
CMD ["npm", "start", "--no-update-notifier"]

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

[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]

I analysed the failed pipeline job Validate docker:

Failure Analysis

The pipeline crashed during the Docker build step, specifically when trying to execute the command RUN 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 suggests that the Dockerfile is attempting to install packages as a non-root user (appuser), which does not have the necessary permissions to modify the APK database. This issue is likely related to the Dockerfile configuration rather than the changes made in the PR.

Suggested Fix

To resolve the permission issue, you can modify the Dockerfile to switch to the root user before running the package installation command and then switch back to the non-root user afterward. Here’s how you can adjust the Dockerfile:

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

This change ensures that the apk add command runs with the necessary permissions, allowing the installation of the git package to succeed.