Moving all scripts to git

.github/workflows/text-followup-handler.yml

@@ -0,0 +1,82 @@
+name: Text Followup Handler
+on:
+  push:
+    branches: [ main ]
+    tags: [ "handler-text-followup-[0-9]+.[0-9]+.[0-9]+" ]
+    paths: [ "handlers/text-followup-handler/**" ]
+  pull_request:
+    branches: [ main ]
+    paths: [ "handlers/text-followup-handler/**" ]
+  workflow_run:
+    workflows: [ "Schemas (Trigger)" ]
+    types:
+      - completed
+  workflow_dispatch:
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: shared-reality-lab/image-handler-text-followup
+jobs:
+  lint:
+    name: PEP 8 style check.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      - name: Install flake8
+        run: pip install flake8
+      - name: Check with flake8
+        run: python -m flake8 ./handlers/text-followup-handler --show-source
+  build-and-push-image:
+    name: Build and Push to Registry
+    needs: lint
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+      - name: Log into GHCR
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Get Correct Tags
+        run: |
+          if [[ ${{ github.ref }} =~ ^refs/tags/handler-text-followup-[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo "TAGGED=true" >> $GITHUB_ENV
+          else
+            echo "TAGGED=false" >> $GITHUB_ENV
+          fi
+      - name: Get timestamp
+        run: echo "timestamp=$(date -u +'%Y-%m-%dT%H.%M')" >> $GITHUB_ENV
+      - name: Extract metadata
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          flavor: |
+            latest=${{ env.TAGGED }}
+          tags: |
+            type=match,enable=${{ env.TAGGED }},priority=300,pattern=handler-text-followup-(\d+.\d+.\d+),group=1
+            type=raw,priority=200,value=unstable
+            type=raw,priority=100,value=${{ env.timestamp }}
+          labels: |
+            org.opencontainers.image.title=IMAGE Handler Text Followup
+            org.opencontainers.image.description=Handler to create responses for followup queries.
+            org.opencontainers.image.authors=IMAGE Project <[email protected]>
+            org.opencontainers.image.licenses=AGPL-3.0-or-later
+            maintainer=IMAGE Project <[email protected]>
+      - name: Build and push
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          file: ./handlers/text-followup-handler/Dockerfile
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/text-followup.yml

@@ -0,0 +1,83 @@
+name: Graphic Caption
+on:
+  push:
+    branches: [ main, text-followup ]
+    tags: [ "preprocessor-text-followup-[0-9]+.[0-9]+.[0-9]+" ]
+    paths: [ "preprocessors/text-followup/**" ]
+  pull_request:
+    branches: [ main ]
+    paths: [ "preprocessors/text-followup/**" ]
+  workflow_run:
+    workflows: [ "Schemas (Trigger)" ]
+    types:
+      - completed
+  workflow_dispatch:
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: shared-reality-lab/image-preprocessor-text-followup
+jobs:
+  lint:
+    name: PEP 8 style check.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      - name: Install flake8
+        run: pip install flake8
+      - name: Check with flake8
+        run: python -m flake8 ./preprocessors/text-followup --show-source
+  build-and-push-image:
+    name: Build and Push to Registry
+    needs: lint
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+      - name: Log into GHCR
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Get Correct Tags
+        run: |
+          if [[ ${{ github.ref }} =~ ^refs/tags/preprocessor-text-followup-[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo "TAGGED=true" >> $GITHUB_ENV
+          else
+            echo "TAGGED=false" >> $GITHUB_ENV
+          fi
+      - name: Get timestamp
+        run: echo "timestamp=$(date -u +'%Y-%m-%dT%H.%M')" >> $GITHUB_ENV
+      - name: Extract metadata
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          flavor: |
+            latest=${{ env.TAGGED }}
+          tags: |
+            type=match,enable=${{ env.TAGGED }},priority=300,pattern=preprocessor-text-followup-(\d+.\d+.\d+),group=1
+            type=raw,priority=200,value=unstable
+            type=raw,priority=100,value=${{ env.timestamp }}
+          labels: |
+            org.opencontainers.image.title=IMAGE Preprocessor Text Followup
+            org.opencontainers.image.description=Responds to followup queries from user.
+            org.opencontainers.image.authors=IMAGE Project <[email protected]>
+            org.opencontainers.image.documentation=https://github.com/Shared-Reality-Lab/IMAGE-server/tree/main/preprocessors/text-followup/README.md
+            org.opencontainers.image.licenses=AGPL-3.0-or-later
+            maintainer=IMAGE Project <[email protected]>
+      - name: Build and push
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          file: ./preprocessors/text-followup/Dockerfile
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -7,5 +7,13 @@ config/chart.env
 config/apis-and-selection.env
 config/vision_api_key.json
 config/ollama.env
+config/healthcheck.env
+config/image-summary.env
+config/imagelogs.env
+config/make_request.env
+config/pp_daily_test.env
+config/restoreunstable.env
+config/sendimagereq.env
+config/image_daily_cron.env
 *.sh
 docker-compose.override.yml

build.yml

@@ -96,6 +96,11 @@ services:
             context: .
             dockerfile: ./preprocessors/graphic-caption/Dockerfile
         image: "graphic-caption:latest"
+    text-followup:
+        build:
+            context: .
+            dockerfile: ./preprocessors/text-followup/Dockerfile
+        image: "text-followup:latest"
     emotion-recognition:
         build:
             context: .
@@ -263,6 +268,11 @@ services:
             context: .
             dockerfile: ./handlers/svg-action-recognition/Dockerfile
         image: "svg-action-recognition:latest"
+    text-followup-handler:
+        build:
+            context: .
+            dockerfile: ./handlers/text-followup-handler/Dockerfile
+        image: "text-followup-handler:latest"
     # Supercollider on Fedora 34
     supercollider-base:
         build:

docker-compose.yml

@@ -21,8 +21,8 @@ services:
     profiles: [production, test, default]
     image: 'memcached:1.6'
     restart: unless-stopped
-    # cache memory size - 4GB
-    command: -m 4096
+    # cache memory size - 4GB, maximum item size - 5MB
+    command: -m 4096 -I 5m
 
   espnet-tts:
     profiles: [production, test, default]
@@ -104,6 +104,17 @@ services:
       env_file:
         ./config/ollama.env
 
+  text-followup:
+    profiles: [test, default]
+    image: ghcr.io/shared-reality-lab/image-preprocessor-text-followup:${REGISTRY_TAG}
+    restart: unless-stopped
+    labels:
+      ca.mcgill.a11y.image.preprocessor: 1
+      ca.mcgill.a11y.image.port: 5000
+      ca.mcgill.a11y.image.cacheTimeout: 0
+      ca.mcgill.a11y.image.route: "followup"
+    env_file:
+      ./config/ollama.env
 
   graphic-tagger:
     profiles: [production, test, default]
@@ -291,6 +302,14 @@ services:
     labels:
         ca.mcgill.a11y.image.handler: enable
 
+  text-followup-handler:
+    profiles: [test, default]
+    image: ghcr.io/shared-reality-lab/image-handler-text-followup:${REGISTRY_TAG}
+    restart: unless-stopped
+    labels:
+        ca.mcgill.a11y.image.handler: enable
+        ca.mcgill.a11y.image.route: "followup"
+
 # end - common services
 
 # start - unicorn exclusive services

handlers/autour-handler/Dockerfile

@@ -13,6 +13,8 @@ RUN npm run build && npm prune --production
 
 FROM node:alpine as final
 
+RUN apk add --no-cache curl
+
 WORKDIR /usr/src/app
 COPY --from=builder --chown=node:node /usr/src/app/package*.json ./
 COPY --from=builder --chown=node:node /usr/src/app/dist ./dist
@@ -22,4 +24,7 @@ ENV NODE_ENV=production
 EXPOSE 80
 
 USER node
+
+HEALTHCHECK --interval=60s --timeout=10s --start-period=120s --retries=5 CMD curl -f http://localhost:80/health || exit 1
+
 CMD [ "node", "." ]

handlers/autour-handler/src/server.ts

@@ -55,7 +55,10 @@ app.post("/handler", async (req, res) => {
     }
 
     const autourData = preprocessors["ca.mcgill.a11y.image.preprocessor.autour"];
-    if (autourData["places"].length === 0) {
+
+    // Filter places we will not use before checking for non-zero length.
+    const places = autourData["places"].filter((p: { "cat": number }) => !filterCategories.includes(p["cat"]));
+    if (places.length === 0) {
         console.warn("No places detected despite running.");
         const response = {
             "request_uuid": req.body["request_uuid"],
@@ -89,9 +92,8 @@ app.post("/handler", async (req, res) => {
         return;
     }
 
-    // Sort and filter POIs
-    // Do this before since TTS is time consuming
-    const places = autourData["places"].filter((p: { "cat": number }) => !filterCategories.includes(p["cat"]));
+    // Sort and filter POIs by distance.
+    // Do this before TTS since it is time consuming
     const source = new LatLon(autourData["lat"], autourData["lon"]);
     for (const place of places) {
         const dest = new LatLon(place["ll"][0], place["ll"][1]);
@@ -136,7 +138,7 @@ app.post("/handler", async (req, res) => {
             const translateSegments = []; // Combine map description with data to translate
             translateSegments.push(description);
             translateSegments.push(...segments);
-            
+
             const translated:string[] = await fetch( "http://multilang-support/service/translate", {
                 "method": "POST",
                 "headers": {
@@ -159,7 +161,6 @@ app.post("/handler", async (req, res) => {
             for(let i = 1; i < translated.length; i++) {
                 segments[i - 1] = translated[i];
             }
-
         } catch (e) {
             console.error(e);
             console.debug(`Cannot translate to ${targetLanguage}`);
@@ -170,7 +171,7 @@ app.post("/handler", async (req, res) => {
             return;
         }
     }
-    
+
     // Forming Response
     let ttsResponse;
     try {
@@ -331,6 +332,10 @@ app.post("/handler", async (req, res) => {
     }
 });
 
+app.get("/health", (req, res) => {
+    res.status(200).json({ status: "healthy", timestamp: new Date().toISOString() });
+});
+
 app.listen(port, () => {
     console.log(`Started server on port ${port}`);
 });

handlers/hello-handler/Dockerfile

@@ -1,5 +1,7 @@
 FROM node:alpine
 
+RUN apk add --no-cache curl
+
 WORKDIR /usr/src/app
 
 # Apparently splittig this up is good for layers
@@ -17,4 +19,7 @@ ENV NODE_ENV=production
 EXPOSE 80
 
 USER node
+
+HEALTHCHECK --interval=60s --timeout=10s --start-period=120s --retries=5 CMD curl -f http://localhost:80/health || exit 1
+
 CMD [ "node", "dist/server.js" ]

handlers/hello-handler/src/server.ts

@@ -94,6 +94,10 @@ app.post("/handler", async (req, res) => {
     }
 });
 
+app.get("/health", (req, res) => {
+    res.status(200).json({ status: "healthy", timestamp: new Date().toISOString() });
+});
+
 app.listen(port, () => {
     console.log(`Started server on port ${port}`);
 });

handlers/hello-svg-handler/Dockerfile

@@ -1,6 +1,6 @@
 FROM python:3.10
 
-RUN apt-get install libcairo2
+RUN apt-get install libcairo2 curl
 
 RUN adduser --disabled-password python
 WORKDIR /usr/src/app
@@ -15,4 +15,7 @@ COPY /handlers/hello-svg-handler/ /usr/src/app
 
 EXPOSE 80
 USER python
+
+HEALTHCHECK --interval=60s --timeout=10s --start-period=120s --retries=5 CMD curl -f http://localhost:80/health || exit 1
+
 CMD ["gunicorn", "hello_svg:app", "-b", "0.0.0.0:80", "--capture-output", "--log-level=debug" ]

handlers/hello-svg-handler/hello_svg.py

@@ -21,6 +21,8 @@
 import logging
 import time
 import drawSvg as draw
+from datetime import datetime
+
 
 app = Flask(__name__)
 
@@ -114,5 +116,16 @@ def handle():
     return response
 
 
+@app.route("/health", methods=["GET"])
+def health():
+    """
+    Health check endpoint to verify if the service is running
+    """
+    return jsonify({
+        "status": "healthy",
+        "timestamp": datetime.now().isoformat()
+    }), 200
+
+
 if __name__ == "__main__":
     app.run(host="0.0.0.0", port=80, debug=False)