Review DockerFiles

[offtherailz]

Description

Actually the docker file of MapStore downloads release binary by default in any case.

This is quite confusing, because if we build on a different branch, we get anyway the latest version of the war. This doesn't happen on our build servers because we override the variable MAPSTORE_WEBAPP_SRC to customize the file path.

• It could be better to get the docker file builds file from the current build folder (MAPSTORE_WEBAPP_SRC) , creating a docker image consistent with the current branch, without any needing to customize. Something like ./web/target/mapstore.war (in product ./product/target/mapastore.war)
• maybe avoid multiple copies of mapstore.war and allow override of the mapstore.war as a volume also on run time.
• Properly document docker image usage (and cases with printing profile).
• Moreover could be good if we can reuse the same docker file to build a docker image for projects. We have to study a solution, maybe using docker layers, reusing the docker file of the sub-module.

What kind of improvement you want to add? (check one with "x", remove the others)

• Minor changes to existing features
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Other... Please describe:

Other useful information

[brynsofz]

@randomorder @offtherailz
After a quick look at the repo, I think we can improve the Dockerfile and CI process. The main issue is that the Dockerfile downloads the release binary by default, so when building from different branches, we still get the latest release instead of the current branch's build. This creates confusion since the Docker image doesn't match what we're actually working on.

Dockerfile:

Change the default source to use local builds:

ARG MAPSTORE_WEBAPP_SRC="./web/target/mapstore.war"

Or add runtime volume for WAR overrides:

VOLUME [ "${MAPSTORE_WEBAPP_DST}" ]

This makes Docker images consistent with the current branch by default, while still allowing runtime customization.

CI suggestion:

Add Docker builds to the existing workflow:

- name: "Build Docker image with local WAR"
  run: docker build -t mapstore:${{ github.sha }} --build-arg MAPSTORE_WEBAPP_SRC=./product/target/mapstore.war .

This ensures every branch gets tested with its own Docker image.
Let me know what you think and we can discuss in details later.

[offtherailz]

I agree in all points. Moreover we have to properly document on map store documentation how to use the image.
I know it is usually done on docker hub too. So maybe docker hub should link MapStore doc (or the opposite) indicating how to see the doc for proper version

[randomorder]

I am fine with this change:

ARG MAPSTORE_WEBAPP_SRC="./web/target/mapstore.war"

Also please remove the ports override here
It was introduced here but I don't see the point of it.

Check for regressions on the CI/CD and the impact on the compose stacks (one and two) and helm chart of the projects @brynsofz

Get in touch with @offtherailz to understand how to propagate the Dockerfile from the submodule into the mapstore projects (copy on project creation or just use the main one from the submodule?).
Copying allow for local changes to the file and prevents unwanted updates in the project. Referencing the submodule dockerfile would ensure it's always up to date with latest changes but requires an update the the existing builds.

Let me know your thoughs about this last point before moving on with the change.

An update to the README and MapStore Developer guide are a deliverable of this task too.

[brynsofz]

@randomorder @offtherailz
Currently, the Dockerfile is copied to the mapstore projects on project creation, but the different is not that much (or mostly the same as the Dockerfile in the submodule). I think the reason we are still doing that because the current build process is starting from script build.sh, then it will build the war file, and lastly the docker image.

Im thinking about including the build.sh (or the war file creation process) into the Dockerfile as the main solution. By doing that, we can fix have the docker image consistent with the branches, and also later, we can reference the Dockerfile in submodule for all of the mapstore projects.

So the implementation may consist 2 parts:

1. Update the Dockerfile in the root Mapstore to include the war file creation process into the Dockerfile. Ensure everything is working fine.
2. Update the build and the mapstore projects to reference from the Dockerfile in the submodule, no need to copy the Dockerfile on project creation.

I aslo have a draft implementation, fyi:

FROM node:20-slim AS builder

ARG MAPSTORE_VERSION=""
ARG MAVEN_PROFILES=""

# Install Java and Maven for building
RUN apt-get update && \
    apt-get install -y openjdk-17-jdk maven git && \
    apt-get clean && \
    rm -rf /var/lib/apt/lists/*

# Copy package files first for better layer caching
WORKDIR /build
COPY package*.json ./
COPY pom.xml ./

# Copy source code
COPY . /build/

# Build MapStore2 with optional version and profiles
RUN npm install && \
    npm run fe:build && \
    rm -rf node_modules && \
    cd java && \
    if [ -n "$MAPSTORE_VERSION" ] && [ -n "$MAVEN_PROFILES" ]; then \
        mvn clean install -Dmapstore2.version="$MAPSTORE_VERSION" -P"$MAVEN_PROFILES" -Dmaven.test.skip=true; \
    elif [ -n "$MAPSTORE_VERSION" ]; then \
        mvn clean install -Dmapstore2.version="$MAPSTORE_VERSION" -Dmaven.test.skip=true; \
    else \
        mvn clean install -Dmaven.test.skip=true; \
    fi && \
    cd .. && \
    if [ -n "$MAPSTORE_VERSION" ] && [ -n "$MAVEN_PROFILES" ]; then \
        mvn clean install -Dmapstore2.version="$MAPSTORE_VERSION" -P"$MAVEN_PROFILES" -Dmaven.test.skip=true; \
    elif [ -n "$MAPSTORE_VERSION" ]; then \
        mvn clean install -Dmapstore2.version="$MAPSTORE_VERSION" -Dmaven.test.skip=true; \
    else \
        mvn clean install -Dmaven.test.skip=true; \
    fi && \
    mvn clean -f java/pom.xml

FROM tomcat:9-jdk11 AS mother
WORKDIR /mapstore

# Copy the built WAR from builder stage
COPY --from=builder /build/product/target/mapstore.war /mapstore/
COPY ./docker/* /mapstore/docker/

# Continue with the current process

What do you think about this?

[brynsofz]

@offtherailz can you review about the above comment? then I, @randomorder and you can have a call together to discuss about this.

[offtherailz]

MapStore subprojects are like MapStore project, with their own build.sh and their own, custom, mapstore.war.
Basically they are created using createProject script. This will create a folder with MapStore as a git sub-module.

The only difference is that the final war will be in web/target/ instead of product/target.
How can you refer the docker file in the upper folder and override the copy operation? If it is possible, LGTM.