Merge pull request #68 from NYULibraries/implement-proposed-statuspageembed-changes

Implement proposed StatusPageEmbed changes

Author: da70

.circleci/config.yml

@@ -7,23 +7,23 @@ docker_build: &docker_build
   run:
     name: Docker build
     command: |
-      docker compose build test compile
+      docker compose build unit-tests compile
 
 test: &test
   run:
     name: Test
     command: |
-      docker compose run test
+      docker compose run unit-tests
 
-webpack_copy: &webpack_copy
+copy_build: &copy_build
   run:
-    name: Copy Webpack build
+    name: Copy vite build
     command: |
       docker cp $(docker ps -a -q --filter name=compile):/app/dist ./
 
-webpack_test: &webpack_test
+test_build: &test_build
   run:
-    name: Test that webpack built correct files
+    name: Test that vite built correct files
     command: |
       test -e dist/index.min.css
       test -e dist/index.min.js
@@ -56,11 +56,11 @@ jobs:
       - *docker_build
       - *test
       - run:
-          name: Webpack compile stage
+          name: Vite build
           command: |
-            docker compose run compile build:stage
-      - *webpack_copy
-      - *webpack_test
+            docker compose run compile
+      - *copy_build
+      - *test_build
       - *aws_env
       - *aws-sync-s3
 
@@ -71,11 +71,11 @@ jobs:
       - *docker_build
       - *test
       - run:
-          name: Webpack compile prod 
+          name: Vite build
           command: |
-            docker compose run compile build:prod
-      - *webpack_copy
-      - *webpack_test
+            docker compose run compile
+      - *copy_build
+      - *test_build
       - *aws_env
       - *aws-sync-s3
 

.dockerignore

@@ -1,4 +1,3 @@
 node_modules/
 npm-debug.log
-yarn-error.log
 

.env

@@ -1,6 +1,9 @@
+dist/
 node_modules/
+
+.env
+.node-version
+
 npm-debug.log
 yarn-error.log
-.node-version
-dist/
-package-lock.json
+

.eslintrc.yml

@@ -1,16 +1,18 @@
-FROM node:20-alpine
+FROM node:24.15.0-trixie
 
 ENV INSTALL_PATH /app
 ENV PATH $INSTALL_PATH/node_modules/.bin:$PATH
 
-COPY package.json yarn.lock /tmp/
+COPY package.json package-lock.json /tmp/
+# Keep this here for the convenience of developers who are using Hadolint
+# in their local development environments.
+# DL3003 is "Use absolute paths, or use WORKDIR to switch to a directory."
 # hadolint ignore=DL3003
-RUN cd /tmp && yarn install --frozen-lockfile \
-    && yarn cache clean \
+RUN cd /tmp && npm install \
     && mkdir -p $INSTALL_PATH && cp -a /tmp/node_modules $INSTALL_PATH
 
 COPY . $INSTALL_PATH
 
 WORKDIR $INSTALL_PATH
 
-CMD ["NODE_ENV=production", "yarn", "build:prod"]
+CMD ["npm", "run", "build"]

.gitignore

@@ -0,0 +1,16 @@
+FROM node:24.15.0-trixie
+
+WORKDIR /app
+
+COPY public/ ./public
+COPY src/ ./src
+COPY index.html .
+COPY package.json .
+COPY package-lock.json .
+COPY vite.config.js .
+
+RUN npm install
+
+EXPOSE 5173
+
+CMD ["npm", "run", "dev"]

Dockerfile

@@ -0,0 +1,48 @@
+FROM mcr.microsoft.com/playwright:v1.58.2-jammy AS builder
+
+WORKDIR /e2e
+
+COPY test/e2e/package.json test/e2e/package-lock.json ./
+
+# Install dependencies
+RUN npm install \
+    # Install only the Chromium browser, as it is the only browser needed for the project. \
+    && npx playwright install chromium
+
+# Copy over remaining e2e files
+COPY test/e2e/ .
+
+FROM node:26-bookworm
+
+ENV INSTALL_PATH /app
+
+COPY src/js/config.mjs $INSTALL_PATH/src/js/
+
+RUN apt-get update -y && apt-get install -y curl
+
+WORKDIR $INSTALL_PATH/test/e2e
+
+# Install Chromium dependencies using the Playwright CLI
+# Separation of concerns: The build stage is primarily focused on building and preparing the application,
+# including installing dependencies required for the application to run.
+# Installing Chromium dependencies in the production stage ensures that only the necessary dependencies
+# for running the application are included in the final image, reducing the overall image size
+RUN npx playwright install-deps chromium
+
+# Copy dependencies and the app
+COPY --from=builder /e2e .
+
+# Copy the browser binaries
+# https://github.com/microsoft/playwright/blob/1f209204cd18bce7d1bfae50f5af105dec752df8/utils/docker/Dockerfile.focal#L33
+COPY --from=builder /ms-playwright /ms-playwright
+
+ENV CONTAINER_MODE true
+# Set the PLAYWRIGHT_BROWSERS_PATH environment variable to tell Playwright where to look for the browser binaries
+# https://github.com/microsoft/playwright/blob/1f209204cd18bce7d1bfae50f5af105dec752df8/utils/docker/Dockerfile.focal#L24
+ENV PLAYWRIGHT_BROWSERS_PATH=/ms-playwright
+
+# Entrypoint ensures $PLAYWRIGHT_BASE_URL has started
+ENTRYPOINT [ "./scripts/docker-entrypoint.sh" ]
+
+# Run playwright tests
+CMD ["npm", "run", "test"]

Dockerfile.development

@@ -0,0 +1,10 @@
+FROM node:24.15.0-trixie
+
+WORKDIR /app
+
+COPY package.json .
+COPY src ./src
+COPY tools ./tools
+
+CMD ["npm", "run", "statuspage-proxy"]
+

Dockerfile.e2e-tests

@@ -0,0 +1,22 @@
+FROM node:24.15.0-trixie
+
+ENV APP_INSTALL_PATH /app
+ENV UNIT_TESTS_INSTALL_PATH ${APP_INSTALL_PATH}/test/unit
+
+COPY src $APP_INSTALL_PATH/src
+
+COPY test/unit/package.json test/unit/package-lock.json /tmp/
+
+RUN cd /tmp && npm install \
+  && mkdir -p ${UNIT_TESTS_INSTALL_PATH} \
+  && cd ${UNIT_TESTS_INSTALL_PATH} \
+  && cp -R /tmp/node_modules ${UNIT_TESTS_INSTALL_PATH} \
+  && rm -r /tmp/*
+
+COPY test/unit ${UNIT_TESTS_INSTALL_PATH}
+
+WORKDIR ${UNIT_TESTS_INSTALL_PATH}
+
+# Run playwright tests
+CMD [ "npm", "run", "test" ]
+