[ENH] Enabled possiblity of injecting custom plausible link to the docker container at runtime

[rmanaem]

• Closes Setup Docker multi-stage builds for env runtime changes #433

Changes proposed in this pull request:

NOTE: If this pull request is to be released, the release label must be applied once the review process is done to avoid the local and remote from going out of sync as a consequence of the bump version workflow run

Checklist

This section is for the PR reviewer

• PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see our Contributing Guidelines for more info)
• PR has a label for the release changelog or skip-release (to be applied by maintainers only)
• PR links to GitHub issue with mention Closes #XXXX
• Tests pass
• Checks pass
• If the PR changes the participant-level and/or the dataset-level result file, the query-tool-results files in the neurobagel_examples repo have been regenerated

For new features:

• Tests have been added

For bug fixes:

• There is at least one test that would fail under the original bug conditions.

Summary by Sourcery

Switch the base image to node:20-alpine and copy the built files to an nginx:alpine image. Inject a custom plausible link to the docker container at runtime using environment variables.

Build:

• Use a multi-stage build to reduce the final image size.

Deployment:

• Add an entrypoint script to inject a custom plausible link if the PLAUSIBLE_DOMAIN and PLAUSIBLE_SRC environment variables are set.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request enables the injection of a custom Plausible Analytics script into the Docker container at runtime. This is achieved by adding environment variables for the Plausible domain and source, and using a shell script to inject the script into the index.html file during container startup.

Sequence diagram for Docker container startup with Plausible script injection

sequenceDiagram
    participant Container as Docker Container
    participant Entrypoint as entrypoint.sh
    participant HTML as index.html

    Container->>Entrypoint: Start container with PLAUSIBLE_DOMAIN and PLAUSIBLE_SRC
    activate Entrypoint
    alt Environment variables present
        Entrypoint->>HTML: Read index.html
        Entrypoint->>HTML: Inject Plausible script using sed
    end
    Entrypoint->>Container: Execute nginx
    deactivate Entrypoint

Loading

File-Level Changes

Change	Details	Files
Modified the Dockerfile to use a multi-stage build process.	Changed the base image to node:20-alpine for the build stage. Added a new stage using nginx:alpine for the final image. Copied the built application from the build stage to the nginx html directory. Copied the entrypoint.sh script to the final image. Set the entrypoint to the entrypoint.sh script.	Dockerfile
Added a shell script to inject the Plausible Analytics script.	Checks for the presence of PLAUSIBLE_DOMAIN and PLAUSIBLE_SRC environment variables. If both variables are present, it constructs the Plausible script tag. Uses sed to inject the script tag into the index.html file. Executes the command passed as argument to the script.	entrypoint.sh

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#433	Investigate a process to search-replace specific place-holder strings after the app is built	✅
#433	Add a custom entrypoint that does the search-replace work	✅
#433	See if we can reuse this to replace the need to build the tool every time to read the .env files	✅

Possibly linked issues

• Setup Docker multi-stage builds for env runtime changes #433: The PR closes the issue by adding a custom entrypoint that injects the custom plausible link.
• Setup Docker multi-stage builds for env runtime changes #433: The PR closes the issue by allowing the user to configure the plausible link at runtime, effectively allowing them to exclude it by not setting it.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[netlify]

✅ Deploy Preview for neurobagel-query ready!

Name	Link
🔨 Latest commit	6fa5d72
🔍 Latest deploy log	https://app.netlify.com/sites/neurobagel-query/deploys/6793e4905202c50008b8795a
😎 Deploy Preview	https://deploy-preview-450--neurobagel-query.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.