Convert to Spring Boot

Author: fileformat

.github/workflows/gcr-deploy.yaml

@@ -1,67 +1,64 @@
-name: build
+name: deploy
 
 on:
   push:
     branches:
     - main
 
+  workflow_dispatch:
+
 # Environment variables available to all jobs and steps in this workflow
+# NOTE: these aren't really secret, but there aren't non-secret settings
 env:
   RUN_PROJECT: ${{ secrets.RUN_PROJECT }}
   RUN_REGION: ${{ secrets.RUN_REGION }}
   RUN_SERVICE: ${{ secrets.RUN_SERVICE }}
 
 jobs:
-  setup-build-deploy:
-    name: Setup, Build, and Deploy
+  deploy:
+    name: Deploy to CloudRun
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v1
+        uses: actions/checkout@v4
 
-      - name: Set up JDK 1.8
-        uses: actions/setup-java@v1
+      - name: gcloud auth
+        id: 'auth'
+        uses: 'google-github-actions/auth@v2'
         with:
-          java-version: 1.8
-
-      - name: Set COMMIT and LASTMOD
-        run: |
-          sudo apt-get install -y xmlstarlet
-          xmlstarlet edit --inplace --update "//_:web-app/_:context-param/_:param-name[text()='COMMIT']/parent::*/_:param-value" -v ${GITHUB_SHA:0:7} www/WEB-INF/web.xml
-          xmlstarlet edit --inplace --update "//_:web-app/_:context-param/_:param-name[text()='LASTMOD']/parent::*/_:param-value" -v "$(date -u +%Y-%m-%dT%H:%M:%SZ)" www/WEB-INF/web.xml
+          credentials_json: '${{ secrets.GCP_SA_KEY }}'
 
       # Setup gcloud CLI
-      - uses: GoogleCloudPlatform/github-actions/setup-gcloud@master
-        with:
-          version: '275.0.0'
-          service_account_email: ${{ secrets.GCP_SA_EMAIL }}
-          service_account_key: ${{ secrets.GCP_SA_KEY }}
+      - name: gcloud setup
+        uses: google-github-actions/setup-gcloud@v2
 
-      # Configure gcloud CLI
-      - name: gcloud Set up
-        run: |
-          gcloud config set project $RUN_PROJECT
+      - name: gcloud docker-auth
+        run: gcloud auth configure-docker
 
       # Build and push image to Google Container Registry
-      - name: Docker Build
+      - name: Build
         run: |
-          docker build -t gcr.io/$RUN_PROJECT/$RUN_SERVICE:$GITHUB_SHA .
+          docker build \
+            --build-arg COMMIT=${GITHUB_SHA:0:7} \
+            --build-arg LASTMOD=$(date -u +%Y-%m-%dT%H:%M:%SZ) \
+            --tag gcr.io/${RUN_PROJECT}/${RUN_SERVICE}:$GITHUB_SHA \
+            .
 
       - name: GCloud auth to docker
         run: |
           gcloud auth configure-docker
 
       - name: Push to registry
         run: |
-          docker push gcr.io/$RUN_PROJECT/$RUN_SERVICE:$GITHUB_SHA
+          docker push gcr.io/${RUN_PROJECT}/${RUN_SERVICE}:$GITHUB_SHA
 
       # Deploy image to Cloud Run
       - name: Deploy
         run: |
-          gcloud run deploy $RUN_SERVICE \
+          gcloud run deploy ${RUN_SERVICE} \
             --allow-unauthenticated \
-            --image gcr.io/$RUN_PROJECT/$RUN_SERVICE:$GITHUB_SHA \
+            --image gcr.io/${RUN_PROJECT}/${RUN_SERVICE}:$GITHUB_SHA \
             --platform managed \
             --project ${RUN_PROJECT} \
-            --region $RUN_REGION
+            --region ${RUN_REGION}

.gitignore

@@ -1,3 +1,7 @@
 *~
 *.class
+.DS_Store
+*.env*
 .idea/
+target
+.vscode

Dockerfile

@@ -1,3 +1,25 @@
-FROM jetty
+FROM maven:3.9.9-eclipse-temurin-21 AS builder
 
-COPY ./www /var/lib/jetty/webapps/ROOT
+WORKDIR /app
+COPY pom.xml /app
+
+RUN mvn dependency:go-offline
+
+COPY . /app
+RUN mvn package
+
+
+FROM gcr.io/distroless/java21-debian12
+ARG COMMIT="(not set)"
+ARG LASTMOD="(not set)"
+ENV COMMIT=$COMMIT
+ENV LASTMOD=$LASTMOD
+
+WORKDIR /app
+
+COPY --from=builder /app/target/ff-pdf2txt-1.0.jar /app/ff-pdf2txt-1.0.jar
+
+USER nonroot
+EXPOSE 4000
+ENV PORT=4000
+CMD ["ff-pdf2txt-1.0.jar"]

build.xml

@@ -1,8 +1,21 @@
-#!/bin/bash
+#!/usr/bin/env bash
+#
+# run locally but in docker
 
 set -o errexit
 set -o pipefail
 set -o nounset
 
-docker build -t ff-pdf2txt:latest .
-docker run -p 4000:8080 ff-pdf2txt:latest
+APP=ff-pdf2txt
+
+docker build \
+	--build-arg COMMIT=$(git rev-parse --short HEAD)-local \
+	--build-arg LASTMOD=$(date -u +%Y-%m-%dT%H:%M:%SZ) \
+	--tag "${APP}" \
+	.
+
+docker run \
+	--publish 4000:4000 \
+	--expose 4000 \
+	--env PORT='4000' \
+	"${APP}"

docker-run.sh

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+
+	<groupId>info.fileformat.pdf2txt</groupId>
+	<artifactId>ff-pdf2txt</artifactId>
+	<version>1.0</version>
+
+	<parent>
+		<groupId>org.springframework.boot</groupId>
+		<artifactId>spring-boot-starter-parent</artifactId>
+		<version>3.4.4</version>
+	</parent>
+
+	<dependencies>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-web</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-devtools</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<!-- https://mvnrepository.com/artifact/org.apache.pdfbox/pdfbox -->
+		<dependency>
+			<groupId>org.apache.pdfbox</groupId>
+			<artifactId>pdfbox</artifactId>
+			<version>3.0.4</version>
+		</dependency>
+	</dependencies>
+
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.springframework.boot</groupId>
+				<artifactId>spring-boot-maven-plugin</artifactId>
+			</plugin>
+		</plugins>
+	</build>
+
+</project>

pom.xml

@@ -1,17 +1,16 @@
-#!/bin/bash
+#!/usr/bin/env bash
 #
-# run the app in a local docker container
+# script to run on localhost
 #
 
 set -o errexit
 set -o pipefail
 set -o nounset
 
-echo "INFO: starting"
+ENV_FILE="${1:-./.env}"
+if [ -f "${ENV_FILE}" ]; then
+    echo "INFO: loading '${ENV_FILE}'!"
+    export $(cat "${ENV_FILE}")
+fi
 
-docker run \
-	--publish 4000:8080 \
-	--volume /tmp/jetty \
-	--volume /run/jetty \
-	--volume "${PWD}/www:/var/lib/jetty/webapps/ROOT" \
-	jetty:9.4.30-jdk14
+mvn spring-boot:run

run.sh

@@ -0,0 +1,64 @@
+package info.fileformat.pdf2txt;
+
+import org.springframework.boot.web.servlet.error.ErrorController;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.util.UrlPathHelper;
+
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.regex.Pattern;
+
+@Controller
+public class CustomErrorController implements ErrorController {
+
+	static final Pattern callbackPattern = Pattern.compile("([&]|^)callback=([^&]+)");
+
+	@RequestMapping("/error")
+	public void handleError(jakarta.servlet.http.HttpServletRequest req,
+			jakarta.servlet.http.HttpServletResponse resp) throws java.io.IOException {
+		Object status = req.getAttribute("jakarta.servlet.error.status_code");
+
+
+		String callback = null;
+		String qs = UrlPathHelper.defaultInstance.getOriginatingQueryString(req);
+		if (qs != null) {
+			java.util.regex.Matcher matcher = callbackPattern.matcher(qs);
+			if (matcher.find()) {
+				callback = matcher.group(2);
+			}
+		}
+
+		Integer statusCode = 500;
+		if (status != null) {
+			statusCode = Integer.valueOf(status.toString());
+		} else {
+			// LATER: warning message
+			//System.out.println("No status code found in request");
+		}
+
+		String message = (String) req.getAttribute("jakarta.servlet.error.message");
+		if (message == null || message.length() == 0) {
+			//System.out.println("No error message found in request");
+
+			Object ex = req.getAttribute("jakarta.servlet.error.exception");
+			if (ex != null && ex instanceof Throwable) {
+				Throwable throwable = (Throwable) ex;
+				message = throwable.getMessage();
+			} else {
+				message = "Server Error";
+			}
+		}
+		resp.setStatus(statusCode);
+		Map<String, Object> retVal = new LinkedHashMap<>();
+		retVal.put("success", Boolean.FALSE);
+		retVal.put("code", statusCode);
+		retVal.put("message", message);
+
+		HandleJsonp.handleJsonp(resp, callback, retVal);
+	}
+
+	public String getErrorPath() {
+		return "/error";
+	}
+}

src/main/java/info/fileformat/pdf2txt/CustomErrorController.java

@@ -0,0 +1,36 @@
+package info.fileformat.pdf2txt;
+
+import java.io.PrintWriter;
+import java.util.Map;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+public class HandleJsonp {
+
+	public static void handleJsonp(
+			jakarta.servlet.http.HttpServletResponse resp,
+			String callback,
+			Map<String, Object> retVal
+		) throws java.io.IOException {
+
+		ObjectMapper objectMapper = new ObjectMapper();
+		String jsonResponse = objectMapper.writeValueAsString(retVal);
+
+		if (callback != null && callback.matches("^[a-zA-Z_][a-zA-Z0-9_]*$")) {
+			resp.setContentType("application/javascript");
+			resp.setCharacterEncoding("UTF-8");
+			PrintWriter writer = resp.getWriter();
+			writer.write(callback);
+			writer.write("(");
+			writer.write(jsonResponse);
+			writer.write(");");
+		} else {
+			resp.setHeader("Access-Control-Allow-Origin", "*");
+			resp.setHeader("Access-Control-Allow-Methods", "GET, POST");
+			resp.setHeader("Access-Control-Max-Age", "604800");
+			resp.setContentType("application/json");
+			resp.setCharacterEncoding("UTF-8");
+			resp.getWriter().write(jsonResponse);
+		}
+	}
+}