Ona custom changes

.github/workflows/docker-image-build.yaml

@@ -0,0 +1,47 @@
+name: build and push image to dockerhub
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+'
+      - '[0-9]+.[0-9]+.[0-9]+-rc'
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version tag to build (e.g., 1.2.3 or 1.2.3-rc)'
+        required: true
+        type: string
+        default: 'latest'
+
+jobs:
+  main:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Get the version
+        id: get-version-release
+        run: |
+          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+            echo "version=${{ github.event.inputs.version }}" >> $GITHUB_ENV
+          else
+            echo "version=${GITHUB_REF_NAME}" >> $GITHUB_ENV
+          fi
+      - name: Checkout to version
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ env.version }}
+      - name: Login to DockerHub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+      - name: Build and push
+        id: docker-build
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          file: Dockerfile
+          platforms: linux/amd64
+          push: true
+          tags: |
+            onaio/dirt-tile-server:${{ env.version }}
+      - name: Image digest
+        run: echo ${{ steps.docker-build.outputs.digest }}

Dockerfile

@@ -1,8 +1,10 @@
 # adapted from https://nodejs.org/en/docs/guides/nodejs-docker-webapp/
-FROM node:20-slim
+FROM node:22.21.0-alpine3.21
+RUN apk update && apk upgrade
 WORKDIR /usr/src/app
 COPY package*.json ./
 RUN npm ci --only=production
 COPY . .
+RUN npm install
 EXPOSE 3000
 CMD [ "npm", "run", "start" ]

README.md

@@ -150,6 +150,25 @@ map.on('load', function() {
 })
 ```
 
+#### MVT Query Parameters
+
+The `mvt` route supports different query parameters for accessing different types of forms:
+
+- **Regular form**: Use `form_id` parameter
+  ```
+  /v1/mvt/{z}/{x}/{y}?form_id=842230
+  ```
+
+- **Merged dataset**: Use `merged_dataset_id` parameter to fetch data from all constituent forms
+  ```
+  /v1/mvt/{z}/{x}/{y}?merged_dataset_id=852601
+  ```
+
+- **Dataview**: Use `dataview_id` parameter to fetch data with applied filters
+  ```
+  /v1/mvt/{z}/{x}/{y}?dataview_id=12345
+  ```
+
 ### Changes require a Restart
 
 If you modify code or add a route, dirt will not see it until dirt is restarted.

index.js

@@ -1,108 +1,183 @@
-const fs = require('fs')
-const path = require('path')
-require("dotenv").config()
-
-// LOGGER OPTIONS
-let logger = false
-if ("SERVER_LOGGER" in process.env) {
-  logger = process.env.SERVER_LOGGER === "true" ? { level: 'info' } : { level: process.env.SERVER_LOGGER }
-  if ("SERVER_LOGGER_PATH" in process.env) {
-    logger.file = process.env.SERVER_LOGGER_PATH
-  }
-}
-
-const fastify = require("fastify")({ logger: logger })
-
-// EXIT IF POSTGRES_CONNECTION ENV VARIABLE NOT SET
-if (!("POSTGRES_CONNECTION" in process.env)) {
-  throw new Error("Required ENV variable POSTGRES_CONNECTION is not set. Please see README.md for more information.");
-}
-
-// POSTGRES CONNECTION
-const postgresConfig = { connectionString: process.env.POSTGRES_CONNECTION }
-
-if (process.env.SSL_ROOT_CERT) {
-  postgresConfig.ssl = {
-    ca: process.env.SSL_ROOT_CERT
-  }
-} else if (process.env.SSL_ROOT_CERT_PATH) {
-  postgresConfig.ssl = {
-    ca: fs.readFileSync(process.env.SSL_ROOT_CERT_PATH).toString()
-  }
-}
-
-fastify.register(require('@fastify/postgres'), postgresConfig)
-
-// COMPRESSION
-// add x-protobuf
-fastify.register(
-  require('@fastify/compress'),
-  { customTypes: /x-protobuf$/ }
-)
-
-// CACHE SETTINGS
-fastify.register(
-  require('@fastify/caching'), {
-    privacy: process.env.CACHE_PRIVACY || 'private',
-    expiresIn: process.env.CACHE_EXPIRESIN || 3600,
-    serverExpiresIn: process.env.CACHE_SERVERCACHE
-  }
-)
-
-// CORS
-fastify.register(require('@fastify/cors'))
-
-// OPTIONAL RATE LIMITER
-if ("RATE_MAX" in process.env) {
-  fastify.register(import('@fastify/rate-limit'), {
-    max: process.env.RATE_MAX,
-    timeWindow: '1 minute'
-  })
-}
-
-// INITIALIZE SWAGGER
-fastify.register(require('@fastify/swagger'), {
-  exposeRoute: true,
-  hideUntagged: true,
-  swagger: {
-    "basePath": process.env.BASE_PATH || "/",
-    "info": {
-      "title": "Dirt-Simple PostGIS HTTP API",
-      "description": "The Dirt-Simple PostGIS HTTP API is an easy way to expose geospatial functionality to your applications. It takes simple requests over HTTP and returns JSON, JSONP, or protobuf (Mapbox Vector Tile) to the requester. Although the focus of the project has generally been on exposing PostGIS functionality to web apps, you can use the framework to make an API to any database.",
-      "version": process.env.npm_package_version || ""
-    },
-    "externalDocs": {
-      "url": "https://github.com/tobinbradley/dirt-simple-postgis-http-api",
-      "description": "Source code on Github"
-    },
-    "tags": [{
-      "name": "api",
-      "description": "code related end-points"
-    }, {
-      "name": "feature",
-      "description": "features in common formats for direct mapping."
-    }, {
-      "name": "meta",
-      "description": "meta information for tables and views."
-    }]
-  }
-})
-
-// SWAGGER UI
-fastify.register(require("@fastify/swagger-ui"), {
-  routePrefix: "/"
-})
-
-// ADD ROUTES
-fastify.register(require('@fastify/autoload'), {
-  dir: path.join(__dirname, 'routes')
-})
-
-// LAUNCH SERVER
-fastify.listen({port: process.env.SERVER_PORT || 3000, host: process.env.SERVER_HOST || '0.0.0.0'}, (err, address) => {
-  if (err) {
-    console.log(err)
-    process.exit(1)
-  }
-  console.info(`Server listening on ${address}`)
-})
+const fs = require("fs");
+const path = require("path");
+require("dotenv").config();
+
+// LOGGER OPTIONS
+let logger = false;
+if ("SERVER_LOGGER" in process.env) {
+    logger =
+        process.env.SERVER_LOGGER === "true"
+            ? { level: "info" }
+            : { level: process.env.SERVER_LOGGER };
+    if ("SERVER_LOGGER_PATH" in process.env) {
+        logger.file = process.env.SERVER_LOGGER_PATH;
+    }
+}
+
+const axios = require("axios");
+
+async function build() {
+    const fastify = require("fastify")({ logger: logger });
+    const queryString = require("query-string");
+    fastify.addHook("onRequest", async (req, reply) => {
+        // Check for health-check endpoint first
+        if ("/health-check" == req.url) {
+            return;
+        }
+
+        reqParams = req.url.split("?")[1];
+        const parsedReqParams = queryString.parse(reqParams);
+        const formId = parsedReqParams.form_id;
+        const dataviewId = parsedReqParams.dataview_id;
+        const mergedDatasetId = parsedReqParams.merged_dataset_id;
+        const tempToken = parsedReqParams.temp_token;
+        let permissionsCheckEndpoint = `${process.env.ONADATA_URL}${process.env.FORMS_ENDPOINT}${formId}.json`;
+        if (dataviewId !== undefined && dataviewId !== null) {
+            permissionsCheckEndpoint = `${process.env.ONADATA_URL}${process.env.DATAVIEWS_ENDPOINT}${dataviewId}.json`;
+        } else if (mergedDatasetId !== undefined && mergedDatasetId !== null) {
+            permissionsCheckEndpoint = `${process.env.ONADATA_URL}${process.env.MERGED_DATASETS_ENDPOINT}${mergedDatasetId}.json`;
+        }
+        if (permissionsCheckEndpoint) {
+            try {
+                const res = await axios.get(permissionsCheckEndpoint, {
+                    headers:
+                        tempToken && tempToken.length > 0
+                            ? {
+                                  Authorization: `TempToken ${tempToken}`,
+                              }
+                            : {},
+                });
+                if (res && res.status === 200) {
+                    return;
+                } else {
+                    reply.code(403).send("Forbidden");
+                }
+            } catch (error) {
+                req.log.error(error);
+                reply.code(error?.status || 500).send(error.message);
+            }
+        } else {
+            reply.code(401).send("Authentication Failure");
+        }
+    });
+
+    // EXIT IF POSTGRES_CONNECTION ENV VARIABLE NOT SET
+    if (!("POSTGRES_CONNECTION" in process.env)) {
+        throw new Error(
+            "Required ENV variable POSTGRES_CONNECTION is not set. Please see README.md for more information.",
+        );
+    }
+
+    // POSTGRES CONNECTION
+    const postgresConfig = {
+        connectionString: process.env.POSTGRES_CONNECTION,
+    };
+
+    if (process.env.SSL_ROOT_CERT) {
+        postgresConfig.ssl = {
+            ca: process.env.SSL_ROOT_CERT,
+        };
+    } else if (process.env.SSL_ROOT_CERT_PATH) {
+        postgresConfig.ssl = {
+            ca: fs.readFileSync(process.env.SSL_ROOT_CERT_PATH).toString(),
+        };
+    }
+
+    fastify.register(require("@fastify/postgres"), postgresConfig);
+
+    // COMPRESSION
+    // add x-protobuf
+    fastify.register(require("@fastify/compress"), {
+        customTypes: /x-protobuf$/,
+    });
+
+    // CACHE SETTINGS
+    fastify.register(require("@fastify/caching"), {
+        privacy: process.env.CACHE_PRIVACY || "private",
+        expiresIn: process.env.CACHE_EXPIRESIN || 3600,
+        serverExpiresIn: process.env.CACHE_SERVERCACHE,
+    });
+
+    // CORS
+    fastify.register(require("@fastify/cors"), {
+        origin:
+            typeof process.env.CORS_ORIGINS === "string"
+                ? process.env.CORS_ORIGINS.split(",")
+                : process.env.CORS_ORIGINS,
+    });
+
+    // OPTIONAL RATE LIMITER
+    if ("RATE_MAX" in process.env) {
+        fastify.register(import("@fastify/rate-limit"), {
+            max: process.env.RATE_MAX,
+            timeWindow: "1 minute",
+        });
+    }
+
+    // INITIALIZE SWAGGER
+    fastify.register(require("@fastify/swagger"), {
+        exposeRoute: true,
+        hideUntagged: true,
+        swagger: {
+            basePath: process.env.BASE_PATH || "/",
+            info: {
+                title: "Dirt-Simple PostGIS HTTP API",
+                description:
+                    "The Dirt-Simple PostGIS HTTP API is an easy way to expose geospatial functionality to your applications. It takes simple requests over HTTP and returns JSON, JSONP, or protobuf (Mapbox Vector Tile) to the requester. Although the focus of the project has generally been on exposing PostGIS functionality to web apps, you can use the framework to make an API to any database.",
+                version: process.env.npm_package_version || "",
+            },
+            externalDocs: {
+                url: "https://github.com/tobinbradley/dirt-simple-postgis-http-api",
+                description: "Source code on Github",
+            },
+            tags: [
+                {
+                    name: "api",
+                    description: "code related end-points",
+                },
+                {
+                    name: "feature",
+                    description:
+                        "features in common formats for direct mapping.",
+                },
+                {
+                    name: "meta",
+                    description: "meta information for tables and views.",
+                },
+            ],
+        },
+    });
+
+    // ADD ROUTES
+    fastify.register(require("@fastify/autoload"), {
+        dir: path.join(__dirname, "routes"),
+    });
+
+    fastify.get("/health-check", { logLevel: "warn" }, (request, reply) => {
+        reply.send("healthy");
+    });
+
+    return fastify;
+}
+
+// LAUNCH SERVER
+build()
+    .then(
+        (
+            fastify, // LAUNCH SERVER
+        ) =>
+            fastify.listen(
+                {
+                    port: process.env.SERVER_PORT || 3000,
+                    host: process.env.SERVER_HOST || "0.0.0.0",
+                },
+                (err, address) => {
+                    if (err) {
+                        fastify.log.error(err);
+                        process.exit(1);
+                    }
+                    fastify.log.info(`Server listening on ${address}`);
+                },
+            ),
+    )
+    .catch(console.log);