EDSC-3797: Added an option for concatenation for custom downloads via Harmony

serverless/src/submitHarmonyOrder/__tests__/constructOrderPayload.test.js

@@ -693,4 +693,115 @@ describe('constructOrderPayload', () => {
       })
     })
   })
+
+  describe('when only concatenation is supported', () => {
+    test('constructs a payload containing supportsConcatenation = true and enableConcatenateDownload = true', async () => {
+      nock(/cmr/)
+        .matchHeader('Authorization', 'Bearer access-token')
+        .get('/search/granules.json?point%5B%5D=-77%2C%2034')
+        .reply(200, {
+          feed: {
+            entry: [{
+              id: 'G10000001-EDSC'
+            }, {
+              id: 'G10000005-EDSC'
+            }]
+          }
+        })
+
+      const granuleParams = {
+        point: ['-77, 34']
+      }
+
+      const accessMethod = {
+        supportsConcatenation: true,
+        enableConcatenateDownload: true
+      }
+
+      const accessToken = 'access-token'
+
+      const response = await constructOrderPayload({
+        accessMethod,
+        granuleParams,
+        accessToken
+      })
+
+      expect(response.getAll('concatenate')).toEqual([
+        'true'
+      ])
+    })
+
+    test('constructs a payload containing supportsConcatenation = true and enableConcatenateDownload = false', async () => {
+      nock(/cmr/)
+        .matchHeader('Authorization', 'Bearer access-token')
+        .get('/search/granules.json?point%5B%5D=-77%2C%2034')
+        .reply(200, {
+          feed: {
+            entry: [{
+              id: 'G10000001-EDSC'
+            }, {
+              id: 'G10000005-EDSC'
+            }]
+          }
+        })
+
+      const granuleParams = {
+        point: ['-77, 34']
+      }
+
+      const accessMethod = {
+        supportsConcatenation: true,
+        enableConcatenateDownload: false
+      }
+
+      const accessToken = 'access-token'
+
+      const response = await constructOrderPayload({
+        accessMethod,
+        granuleParams,
+        accessToken
+      })
+
+      expect(response.getAll('concatenate')).not.toEqual([
+        'true'
+      ])
+    })
+  })
+
+  describe('when concatenation is not supported', () => {
+    test('constructs a payload containing supportsConcatenation = false', async () => {
+      nock(/cmr/)
+        .matchHeader('Authorization', 'Bearer access-token')
+        .get('/search/granules.json?point%5B%5D=-77%2C%2034')
+        .reply(200, {
+          feed: {
+            entry: [{
+              id: 'G10000001-EDSC'
+            }, {
+              id: 'G10000005-EDSC'
+            }]
+          }
+        })
+
+      const granuleParams = {
+        point: ['-77, 34']
+      }
+
+      const accessMethod = {
+        supportsConcatenation: false
+      }
+
+      const accessToken = 'access-token'
+
+      const response = await constructOrderPayload({
+        accessMethod,
+        granuleParams,
+        accessToken
+      })
+
+      expect(response.getAll('concatenate')).not.toEqual([
+        'true'
+      ])
+    })
+  })
 })

serverless/src/submitHarmonyOrder/constructOrderPayload.js

@@ -47,11 +47,13 @@ export const constructOrderPayload = async ({
   const {
     enableTemporalSubsetting,
     enableSpatialSubsetting,
+    enableConcatenateDownload,
     mbr,
     selectedOutputFormat,
     selectedOutputProjection,
     supportsBoundingBoxSubsetting,
-    supportsShapefileSubsetting
+    supportsShapefileSubsetting,
+    supportsConcatenation
   } = accessMethod
 
   // OGC uses duplicate parameter names for subsetting and the
@@ -215,6 +217,11 @@ export const constructOrderPayload = async ({
     orderPayload.append('outputCrs', selectedOutputProjection)
   }
 
+  // Adds supportsConcatenation to the payload and it's value
+  if (supportsConcatenation && enableConcatenateDownload) {
+    orderPayload.append('concatenate', true)
+  }
+
   // EDSC-3440: Add skipPreview=true to all Harmony orders
   orderPayload.append('skipPreview', true)
 

static/src/js/components/AccessMethod/AccessMethod.js

@@ -61,6 +61,10 @@ export class AccessMethod extends Component {
       enableTemporalSubsetting = !isRecurring
     } = selectedMethod || {}
 
+    const {
+      enableConcatenateDownload
+    } = selectedMethod || false
+
     const {
       enableSpatialSubsetting = !(
         boundingBox === undefined
@@ -73,14 +77,16 @@ export class AccessMethod extends Component {
 
     this.state = {
       enableTemporalSubsetting,
-      enableSpatialSubsetting
+      enableSpatialSubsetting,
+      enableConcatenateDownload
     }
 
     this.handleAccessMethodSelection = this.handleAccessMethodSelection.bind(this)
     this.handleOutputFormatSelection = this.handleOutputFormatSelection.bind(this)
     this.handleOutputProjectionSelection = this.handleOutputProjectionSelection.bind(this)
     this.handleToggleTemporalSubsetting = this.handleToggleTemporalSubsetting.bind(this)
     this.handleToggleSpatialSubsetting = this.handleToggleSpatialSubsetting.bind(this)
+    this.handleConcatenationSelection = this.handleConcatenationSelection.bind(this)
   }
 
   UNSAFE_componentWillReceiveProps() {
@@ -141,6 +147,25 @@ export class AccessMethod extends Component {
     })
   }
 
+  handleConcatenationSelection(event) {
+    const { metadata, onUpdateAccessMethod, selectedAccessMethod } = this.props
+    const { conceptId: collectionId } = metadata
+
+    const { target } = event
+    const { checked } = target
+
+    this.setState({ enableConcatenateDownload: checked })
+
+    onUpdateAccessMethod({
+      collectionId,
+      method: {
+        [selectedAccessMethod]: {
+          enableConcatenateDownload: checked
+        }
+      }
+    })
+  }
+
   handleToggleTemporalSubsetting(event) {
     const { metadata, onUpdateAccessMethod, selectedAccessMethod } = this.props
     const { conceptId: collectionId } = metadata
@@ -207,11 +232,6 @@ export class AccessMethod extends Component {
   }
 
   render() {
-    const {
-      enableTemporalSubsetting,
-      enableSpatialSubsetting
-    } = this.state
-
     const {
       accessMethods,
       index,
@@ -337,9 +357,17 @@ export class AccessMethod extends Component {
       supportsTemporalSubsetting = false,
       supportsShapefileSubsetting = false,
       supportsBoundingBoxSubsetting = false,
-      supportsVariableSubsetting = false
+      supportsVariableSubsetting = false,
+      supportsConcatenation = false,
+      defaultConcatenation = false
     } = selectedMethod || {}
 
+    const {
+      enableTemporalSubsetting,
+      enableSpatialSubsetting,
+      enableConcatenateDownload = defaultConcatenation
+    } = this.state
+
     const isOpendap = (selectedAccessMethod && selectedAccessMethod === 'opendap')
 
     // Harmony access methods are postfixed with an index given that there can be more than one
@@ -392,6 +420,7 @@ export class AccessMethod extends Component {
       || supportsBoundingBoxSubsetting
       || supportedOutputFormatOptions.length > 0
       || supportedOutputProjectionOptions.length > 0
+      || supportsConcatenation
       || (form && isActive)
 
     const {
@@ -496,6 +525,38 @@ export class AccessMethod extends Component {
                     </ProjectPanelSection>
                   )
                 }
+                {
+                  supportsConcatenation && (
+                    <ProjectPanelSection
+                      customHeadingTag="h4"
+                      heading="Combine Data"
+                      intro="Select from available operations to combine the data."
+                      nested
+                    >
+                      <Form.Group controlId="input__concatinate-subsetting" className="mb-0">
+                        <Form.Check
+                          id="input__concatinate-subsetting"
+                          type="checkbox"
+                          label={
+                            (
+                              <div>
+                                <span className="mb-1 d-block">
+                                  Enable Concatenation
+                                </span>
+                                <span className="mb-1 d-block text-muted">
+                                  Data will be concatenated along a newly created dimension
+                                </span>
+                              </div>
+                            )
+                          }
+                          checked={enableConcatenateDownload}
+                          disabled={isRecurring}
+                          onChange={this.handleConcatenationSelection}
+                        />
+                      </Form.Group>
+                    </ProjectPanelSection>
+                  )
+                }
                 {
                   supportsTemporalSubsetting && (
                     <ProjectPanelSection

static/src/js/components/AccessMethod/__tests__/AccessMethod.test.js

@@ -1065,7 +1065,7 @@ describe('AccessMethod component', () => {
 
             const checkbox = screen.getByRole('checkbox')
             await user.click(checkbox)
-            expect(screen.getByRole('checkbox').checked).toEqual(true)
+            expect(checkbox.checked).toEqual(true)
           })
 
           test('calls onUpdateAccessMethod', async () => {
@@ -1140,6 +1140,89 @@ describe('AccessMethod component', () => {
           expect(screen.getByText(/using the harmony-service-name/)).toBeInTheDocument()
         })
       })
+
+      describe('when the service type is `Harmony` and concatenation is available', () => {
+        test('the `Combine Data` option is avaialable when concatenation service is true', () => {
+          const collectionId = 'collectionId'
+          const serviceName = 'harmony-service-name'
+          setup({
+            accessMethods: {
+              harmony0: {
+                isValid: true,
+                type: 'Harmony',
+                name: serviceName,
+                supportsConcatenation: true,
+                defaultConcatenation: true
+              }
+            },
+            metadata: {
+              conceptId: collectionId
+            },
+            selectedAccessMethod: 'harmony0'
+          })
+
+          expect(screen.getByText(/The requested data will be processed/)).toBeInTheDocument()
+          expect(screen.getByText(/Combine Data/)).toBeInTheDocument()
+          expect(screen.getByRole('checkbox').checked).toEqual(true)
+        })
+
+        test('when the `Combine Data` option is clicked, the enableConcatenateDownload changes', async () => {
+          const user = userEvent.setup()
+          const collectionId = 'collectionId'
+          const serviceName = 'harmony-service-name'
+          const { onUpdateAccessMethod } = setup({
+            accessMethods: {
+              harmony0: {
+                isValid: true,
+                type: 'Harmony',
+                name: serviceName,
+                supportsConcatenation: true,
+                defaultConcatenation: false
+              }
+            },
+            metadata: {
+              conceptId: collectionId
+            },
+            selectedAccessMethod: 'harmony0'
+          })
+
+          expect(screen.getByText(/The requested data will be processed/)).toBeInTheDocument()
+          expect(screen.getByText(/Combine Data/)).toBeInTheDocument()
+          await user.click(screen.getByRole('checkbox'))
+
+          expect(onUpdateAccessMethod).toHaveBeenCalledTimes(1)
+          expect(onUpdateAccessMethod).toHaveBeenCalledWith({
+            collectionId: 'collectionId',
+            method: { harmony0: { enableConcatenateDownload: true } }
+          })
+
+          expect(screen.getByRole('checkbox').checked).toEqual(true)
+        })
+      })
+
+      describe('when the service type is `Harmony` and concatenation is unavailable', () => {
+        test('when the `Combine Data` option is clicked, the enableConcatenateDownload changes', async () => {
+          const collectionId = 'collectionId'
+          const serviceName = 'harmony-service-name'
+          setup({
+            accessMethods: {
+              harmony0: {
+                isValid: true,
+                type: 'Harmony',
+                name: serviceName,
+                supportsConcatenation: false,
+                enableConcatenateDownload: false
+              }
+            },
+            metadata: {
+              conceptId: collectionId
+            },
+            selectedAccessMethod: 'harmony0'
+          })
+
+          expect(screen.queryAllByText(/Combine Data/)).toHaveLength(0)
+        })
+      })
     })
   })
 })