Merge branch 'main' into harmony-1538-2

services/harmony/app/middleware/extend.ts

@@ -0,0 +1,31 @@
+import { NextFunction } from 'express';
+import HarmonyRequest from '../models/harmony-request';
+
+/**
+ * Set the request operation extendDimensions value to the default if applicable
+ * @param req - The client request
+ */
+export function setExtendDimensionsDefault(req: HarmonyRequest): void {
+  const extend = req.context.serviceConfig?.capabilities?.extend;
+  const defaultExtendDimensions = req.context.serviceConfig?.capabilities?.default_extend_dimensions;
+  // set extendDimension to the default if there is one configured and no provided value
+  if (extend && defaultExtendDimensions && !req.operation?.extendDimensions) {
+    req.operation.extendDimensions = defaultExtendDimensions;
+  }
+}
+
+/**
+ * Express.js middleware that inject default extend parameter into operation if applicable
+ *
+ * @param req - The client request
+ * @param res - The client response
+ * @param next - The next function in the middleware chain
+ */
+export default async function extendDefault(req: HarmonyRequest, res, next: NextFunction): Promise<void> {
+  try {
+    setExtendDimensionsDefault(req);
+    next();
+  } catch (error) {
+    next(error);
+  }
+}

services/harmony/app/models/services/base-service.ts

@@ -29,6 +29,8 @@ export interface ServiceCapabilities {
   };
   output_formats?: string[];
   reprojection?: boolean;
+  extend?: boolean;
+  default_extend_dimensions?: string[];
 }
 
 export interface ServiceStep {

services/harmony/app/routers/router.ts

@@ -38,6 +38,7 @@ import { getStagingBucketPolicy } from '../frontends/staging-bucket-policy';
 import { parseGridMiddleware } from '../util/grids';
 import docsPage from '../frontends/docs/docs';
 import { getCollectionCapabilitiesJson } from '../frontends/capabilities';
+import extendDefault from '../middleware/extend';
 export interface RouterConfig {
   PORT?: string | number; // The port to run the frontend server on
   BACKEND_PORT?: string | number; // The port to run the backend server on
@@ -198,6 +199,7 @@ export default function router({ skipEarthdataLogin = 'false' }: RouterConfig):
   result.use(logged(cmrUmmCollectionReader));
   result.use(logged(cmrGranuleLocator));
   result.use(logged(addRequestContextToOperation));
+  result.use(logged(extendDefault));
   result.use(logged(redirectWithoutTrailingSlash));
 
   result.get('/', asyncHandler(landingPage));

services/harmony/test/middleware/extend.ts

@@ -0,0 +1,90 @@
+import { expect } from 'chai';
+import { describe, it, beforeEach } from 'mocha';
+import HarmonyRequest from '../../app/models/harmony-request';
+import DataOperation from '../../app/models/data-operation';
+import { setExtendDimensionsDefault } from '../../app/middleware/extend';
+
+describe('extend serivce default value', function () {
+  beforeEach(function () {
+    const collectionId = 'C123-TEST';
+    const shortName = 'harmony_example';
+    const versionId = '1';
+    const operation = new DataOperation();
+    operation.addSource(collectionId, shortName, versionId);
+    const harmonyRequest = {
+      operation: operation,
+      context: {
+        serviceConfig: {
+          name: 'extend-service',
+          type: { name: 'turbo' },
+          collections: [{ id: collectionId }],
+          capabilities: {
+            extend: true,
+            default_extend_dimensions: ['mirror_step'],
+          },
+        },
+      },
+    } as HarmonyRequest;
+    this.req = harmonyRequest;
+  });
+
+  describe('and the request does not provide dimension extension', function () {
+    it('extendDimensions is set to the default', function () {
+      setExtendDimensionsDefault(this.req);
+      expect(this.req.operation.extendDimensions).to.eql(['mirror_step']);
+    });
+  });
+
+  describe('and the request provides dimension extension', function () {
+    beforeEach(function () {
+      this.req.operation.extendDimensions = ['lat', 'lon'];
+    });
+
+    it('extendDimensions is set to the provided value, not the default', function () {
+      setExtendDimensionsDefault(this.req);
+      expect(this.req.operation.extendDimensions).to.eql(['lat', 'lon']);
+    });
+  });
+});
+
+describe('extend serivce misconfigured without default value', function () {
+  beforeEach(function () {
+    const collectionId = 'C123-TEST';
+    const shortName = 'harmony_example';
+    const versionId = '1';
+    const operation = new DataOperation();
+    operation.addSource(collectionId, shortName, versionId);
+    const harmonyRequest = {
+      operation: operation,
+      context: {
+        serviceConfig: {
+          name: 'extend-service',
+          type: { name: 'turbo' },
+          collections: [{ id: collectionId }],
+          capabilities: {
+            extend: true,
+          },
+        },
+      },
+    } as HarmonyRequest;
+    this.req = harmonyRequest;
+  });
+
+  describe('and the request does not provide dimension extension', function () {
+    it('extendDimensions is set to the default', function () {
+      setExtendDimensionsDefault(this.req);
+      expect(this.req.operation.extendDimensions).to.not.exist;
+    });
+  });
+
+  describe('and the request provides dimension extension', function () {
+    beforeEach(function () {
+      this.req.operation.extendDimensions = ['lat', 'lon'];
+    });
+
+    it('extendDimensions is set to the provided value, not the default', function () {
+      setExtendDimensionsDefault(this.req);
+      expect(this.req.operation.extendDimensions).to.eql(['lat', 'lon']);
+    });
+  });
+});