feat: dem info endpoint (MAPCO-9814)

.gitignore

@@ -1,3 +1,6 @@
+# Temp folder
+tmp
+
 # Logs
 logs
 *.log
@@ -111,3 +114,5 @@ dist
 # Jest
 jest_html_reporters.html
 reports
+
+config/local*.json

README.md

@@ -1,64 +1,47 @@
-# Map Colonies typescript service template
-
-----------------------------------
-
-This is a basic repo template for building new MapColonies web services in Typescript.
-
-> [!IMPORTANT]
-> To regenerate the types on openapi change run the command `npm run generate:openapi-types`.
-
-> [!WARNING]
-> After creating a new repo based on this template, you should delete the CODEOWNERS file.
+# dem-gateway
 
+Gateway for DEM resources manipulation
 
 ## Development
-When in development you should use the command `npm run start:dev`. The main benefits are that it enables offline mode for the config package, and source map support for NodeJS errors.
-
-### Template Features:
-
-- eslint configuration by [@map-colonies/eslint-config](https://github.com/MapColonies/eslint-config)
-
-- prettier configuration by [@map-colonies/prettier-config](https://github.com/MapColonies/prettier-config)
-
-- jest
-
-- .nvmrc
-
-- Multi stage production-ready Dockerfile
-
-- commitlint
-
-- git hooks
-
-- logging by [@map-colonies/js-logger](https://github.com/MapColonies/js-logger)
-
-- OpenAPI request validation
-
-- config load with [node-config](https://www.npmjs.com/package/node-config)
-
-- Tracing and metrics by [@map-colonies/telemetry](https://github.com/MapColonies/telemetry)
 
-- github templates
-
-- bug report
+When in development you should use the command `npm run start:dev`. The main benefits are that it enables offline mode for the config package, and source map support for NodeJS errors.
 
-- feature request
+### Adding a New Handler
 
-- pull request
+Before all, check if existing handlers can fulfill your need. For example, [`gdal handler`](src/info//fileHandlers/gdal.ts) can handle most of raster file formats.
 
-- github actions
+Add a new file handler under `src/info/fileHandlers`. The file should contain a class implementing the `FileHandler` interface.
+Verify that OpenAPI spec supports the file format associated with the new handler. OpenAPI validates input file formats through a RegEx pattern.
 
-- on pull_request
+Add a new or record into the [default.json](config/default.json) under `application.supportedFormatsMap` in the form of:
 
-- LGTM
+```json
+{
+  ...
+  "application": {
+    ...
+    "supportedFormatsMap": {
+      ...
+      "formatName": "drivername"
+    },
+    ...
+  }
+}
 
-- test
+```
+This configuration is used to map common format names into a given file handler internal name. For example, the gdal handler maps formats into gdal's internal driver name.
 
-- lint
+Finally, since DI is utilized a new record for the new handler should be added in [containerConfig.ts](src/containerConfig.ts):
 
-- snyk
+```javascript
+const dependencies: InjectionObject<unknown>[] = [
+    ...
+    { token: 'FileHandler', provider: { useClass: NewHandler } }
+];
+```
 
 ## API
+
 Checkout the OpenAPI spec [here](/openapi3.yaml)
 
 ## Installation
@@ -74,51 +57,43 @@ npm install
 Clone the project
 
 ```bash
-
 git clone https://link-to-project
-
 ```
 
 Go to the project directory
 
 ```bash
-
 cd my-project
-
 ```
 
 Install dependencies
 
 ```bash
-
 npm install
-
 ```
 
 Start the server
 
 ```bash
-
 npm run start
-
 ```
 
 ## Running Tests
 
 To run tests, run the following command
 
 ```bash
-
 npm run test
-
 ```
 
 To only run unit tests:
+
 ```bash
 npm run test:unit
 ```
 
 To only run integration tests:
+
 ```bash
 npm run test:integration
 ```

catalog-info.yaml

@@ -1,17 +1,17 @@
 apiVersion: backstage.io/v1alpha1
 kind: Component
 metadata:
-  name: ts-server-boilerplate
-  description: A boilerplate github repo for a REST API service in NodeJS for MapColonies
+  name: dem-gateway
+  description: Gateway for DEM resources manipulation
   annotations:
-    github.com/project-slug: MapColonies/ts-server-boilerplate
+    github.com/project-slug: MapColonies/dem-gateway
   tags:
     - nodejs
     - typescript
     - expressjs
-    - boilerplate
+    - dem
 spec:
   type: service
   lifecycle: production
-  owner: DevInfra
-  system: boilerplate
+  owner: DEM
+  system: dem-ingestion

config/default.json

@@ -12,8 +12,10 @@
     },
     "shared": {},
     "logger": {
-      "level": "info",
-      "prettyPrint": false
+      "prettyPrint": false,
+      "opentelemetryOptions": {
+        "enabled": false
+      }
     }
   },
   "server": {
@@ -29,5 +31,33 @@
         "options": null
       }
     }
+  },
+  "storageExplorer": {
+    "sourceDir": "",
+    "displayNameDir": "layerSources",
+    "validFileExtensions": ["tif"]
+  },
+  "jobnik": {
+    "baseUrl": "http://localhost:3000"
+  },
+  "application": {
+    "validation": {
+      "blockSize": 256,
+      "compression": "LZW",
+      "resolutionDegree": { "min": 0.00000009060870470168063430786, "max": 0.08982 },
+      "resolutionMeter": { "min": 0.01, "max": 10000 },
+      "supportedSrsIds": [
+        4326, 32601, 32602, 32603, 32604, 32605, 32606, 32607, 32608, 32609, 32610, 32611, 32612, 32613, 32614, 32615, 32616, 32617, 32618, 32619,
+        32620, 32621, 32622, 32623, 32624, 32625, 32626, 32627, 32628, 32629, 32630, 32631, 32632, 32633, 32634, 32635, 32636, 32637, 32638, 32639,
+        32640, 32641, 32642, 32643, 32644, 32645, 32646, 32647, 32648, 32649, 32650, 32651, 32652, 32653, 32654, 32655, 32656, 32657, 32658, 32659,
+        32660, 32701, 32702, 32703, 32704, 32705, 32706, 32707, 32708, 32709, 32710, 32711, 32712, 32713, 32714, 32715, 32716, 32717, 32718, 32719,
+        32720, 32721, 32722, 32723, 32724, 32725, 32726, 32727, 32728, 32729, 32730, 32731, 32732, 32733, 32734, 32735, 32736, 32737, 32738, 32739,
+        32740, 32741, 32742, 32743, 32744, 32745, 32746, 32747, 32748, 32749, 32750, 32751, 32752, 32753, 32754, 32755, 32756, 32757, 32758, 32759,
+        32760
+      ]
+    },
+    "supportedFormatsMap": {
+      "geotiff": "gtiff"
+    }
   }
 }

config/test.json

@@ -1 +1,5 @@
-{}
+{
+  "storageExplorer": {
+    "sourceDir": "/"
+  }
+}

helm/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
-name: ts-server-boilerplate
-description: A Helm chart for ts-server-boilerplate service
+name: dem-gateway
+description: A Helm chart for dem-gateway service
 type: application
 version: 1.0.0
 appVersion: 1.0.0

helm/templates/_helpers.tpl

@@ -1,7 +1,7 @@
 {{/*
 Expand the name of the chart.
 */}}
-{{- define "ts-server-boilerplate.name" -}}
+{{- define "dem-gateway.name" -}}
 {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
 
@@ -10,7 +10,7 @@ Create a default fully qualified app name.
 We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
 If release name contains chart name it will be used as a full name.
 */}}
-{{- define "ts-server-boilerplate.fullname" -}}
+{{- define "dem-gateway.fullname" -}}
 {{- if .Values.fullnameOverride -}}
 {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
 {{- else -}}
@@ -26,16 +26,16 @@ If release name contains chart name it will be used as a full name.
 {{/*
 Create chart name and version as used by the chart label.
 */}}
-{{- define "ts-server-boilerplate.chart" -}}
+{{- define "dem-gateway.chart" -}}
 {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
 {{- end }}
 
 {{/*
 Common labels
 */}}
-{{- define "ts-server-boilerplate.labels" -}}
-helm.sh/chart: {{ include "ts-server-boilerplate.chart" . }}
-{{ include "ts-server-boilerplate.selectorLabels" . }}
+{{- define "dem-gateway.labels" -}}
+helm.sh/chart: {{ include "dem-gateway.chart" . }}
+{{ include "dem-gateway.selectorLabels" . }}
 {{- if .Chart.AppVersion }}
 app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
 {{- end }}
@@ -46,23 +46,23 @@ app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{/*
 Returns the tag of the chart.
 */}}
-{{- define "ts-server-boilerplate.tag" -}}
+{{- define "dem-gateway.tag" -}}
 {{- default (printf "v%s" .Chart.AppVersion) .Values.image.tag }}
 {{- end }}
 
 {{/*
 Selector labels
 */}}
-{{- define "ts-server-boilerplate.selectorLabels" -}}
-app.kubernetes.io/name: {{ include "ts-server-boilerplate.name" . }}
+{{- define "dem-gateway.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "dem-gateway.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{ include "mclabels.selectorLabels" . }}
 {{- end }}
 
 {{/*
 Returns the cloud provider name from global if exists or from the chart's values, defaults to minikube
 */}}
-{{- define "ts-server-boilerplate.cloudProviderFlavor" -}}
+{{- define "dem-gateway.cloudProviderFlavor" -}}
 {{- if .Values.global.cloudProvider.flavor }}
     {{- .Values.global.cloudProvider.flavor -}}
 {{- else if .Values.cloudProvider -}}
@@ -75,7 +75,7 @@ Returns the cloud provider name from global if exists or from the chart's values
 {{/*
 Returns the cloud provider docker registry url from global if exists or from the chart's values
 */}}
-{{- define "ts-server-boilerplate.cloudProviderDockerRegistryUrl" -}}
+{{- define "dem-gateway.cloudProviderDockerRegistryUrl" -}}
 {{- if .Values.global.cloudProvider.dockerRegistryUrl }}
     {{- printf "%s/" .Values.global.cloudProvider.dockerRegistryUrl -}}
 {{- else if .Values.cloudProvider.dockerRegistryUrl -}}
@@ -87,7 +87,7 @@ Returns the cloud provider docker registry url from global if exists or from the
 {{/*
 Returns the cloud provider image pull secret name from global if exists or from the chart's values
 */}}
-{{- define "ts-server-boilerplate.cloudProviderImagePullSecretName" -}}
+{{- define "dem-gateway.cloudProviderImagePullSecretName" -}}
 {{- if .Values.global.cloudProvider.imagePullSecretName }}
     {{- .Values.global.cloudProvider.imagePullSecretName -}}
 {{- else if .Values.cloudProvider.imagePullSecretName -}}
@@ -98,7 +98,7 @@ Returns the cloud provider image pull secret name from global if exists or from
 {{/*
 Returns the tracing url from global if exists or from the chart's values
 */}}
-{{- define "ts-server-boilerplate.tracingUrl" -}}
+{{- define "dem-gateway.tracingUrl" -}}
 {{- if .Values.global.tracing.url }}
     {{- .Values.global.tracing.url -}}
 {{- else if .Values.cloudProvider -}}
@@ -109,7 +109,7 @@ Returns the tracing url from global if exists or from the chart's values
 {{/*
 Returns the tracing url from global if exists or from the chart's values
 */}}
-{{- define "ts-server-boilerplate.metricsUrl" -}}
+{{- define "dem-gateway.metricsUrl" -}}
 {{- if .Values.global.metrics.url }}
     {{- .Values.global.metrics.url -}}
 {{- else -}}

helm/templates/configmap.yaml

@@ -1,10 +1,10 @@
-{{- $tracingUrl := include "ts-server-boilerplate.tracingUrl" . -}}
-{{- $metricsUrl := include "ts-server-boilerplate.metricsUrl" . -}}
+{{- $tracingUrl := include "dem-gateway.tracingUrl" . -}}
+{{- $metricsUrl := include "dem-gateway.metricsUrl" . -}}
 {{- if .Values.enabled -}}
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: {{ printf "%s-configmap" (include "ts-server-boilerplate.fullname" .) }}
+  name: {{ printf "%s-configmap" (include "dem-gateway.fullname" .) }}
 data:
   REQUEST_PAYLOAD_LIMIT: {{ .Values.env.requestPayloadLimit | quote }}
   RESPONSE_COMPRESSION_ENABLED: {{ .Values.env.responseCompressionEnabled | quote }}