GQL-118: Add support for retrieving a collection revision

src/cmr/concepts/concept.js

@@ -643,14 +643,17 @@ export default class Concept {
   fetchUmm(searchParams, requestedKeys, providedHeaders) {
     this.logKeyRequest(requestedKeys, 'umm')
 
+    const { revisionId } = searchParams
+
     // Construct the promise that will request data from the umm endpoint
     return cmrQuery({
       conceptType: this.getConceptType(),
       params: pick(snakeCaseKeys(searchParams), this.getPermittedUmmSearchParams()),
       nonIndexedKeys: this.getNonIndexedKeys(),
       headers: providedHeaders,
       options: {
-        format: 'umm_json'
+        format: 'umm_json',
+        allRevisions: revisionId ? true : undefined
       }
     })
   }
@@ -943,6 +946,7 @@ export default class Concept {
    * @param {Array} ummKeys Array of the keys requested in the query
    */
   async parseUmm(ummResponse, ummKeys) {
+    const { revisionId } = this.params.params || {}
     // Pull out the key mappings so we can retrieve the values below
     const { ummKeyMappings } = this.requestInfo
 
@@ -961,14 +965,26 @@ export default class Concept {
     items.forEach((item, itemIndex) => {
       const normalizedItem = this.normalizeUmmItem(item)
 
+      // Filter out items that don't match the requested revisionId
+      // This is necessary because the umm endpoint returns multiple revisions
+      if (revisionId && normalizedItem.meta['revision-id'].toString() !== revisionId.toString()) {
+        return
+      }
+
       // Creates unique item keys regardless of whether or not
       // a user calls for data with similar conceptIds (as is the case with revisions)
       const itemKey = this.generateUmmItemKey(itemIndex, normalizedItem)
 
       this.setEssentialUmmValues(itemKey, normalizedItem)
 
-      this.setUmmItems(item, itemKey, ummKeys, ummKeyMappings,)
+      this.setUmmItems(item, itemKey, ummKeys, ummKeyMappings)
     })
+
+    // Update the item count if we filtered out items
+    if (revisionId) {
+      const filteredItemCount = Object.keys(this.items).length
+      this.setUmmItemCount(filteredItemCount)
+    }
   }
 
   /**

src/resolvers/__tests__/collection.test.js

@@ -1083,6 +1083,101 @@ describe('Collection', () => {
           })
         })
       })
+
+      describe('when retrieving by revisionId', () => {
+        test('returns the specific revision when revisionId is provided', async () => {
+          nock(/example-cmr/)
+            .defaultReplyHeaders({
+              'CMR-Took': 7,
+              'CMR-Request-Id': 'abcd-1234-efgh-5678'
+            })
+            .get('/search/collections.umm_json?all_revisions=true&concept_id=C100000-EDSC')
+            .reply(200, {
+              items: [{
+                meta: {
+                  'concept-id': 'C100000-EDSC',
+                  'revision-id': 2
+                },
+                umm: {}
+              }]
+            })
+
+          const response = await server.executeOperation({
+            variables: {
+              params: {
+                conceptId: 'C100000-EDSC',
+                revisionId: '2'
+              }
+            },
+            query: `
+            query GetCollection($params: CollectionInput!) {
+              collection(params: $params) {
+                conceptId
+                revisionId
+              }
+            }
+          `
+          }, {
+            contextValue
+          })
+
+          const { data, errors } = response.body.singleResult
+
+          if (errors) {
+            console.error('GraphQL errors:', errors)
+            throw new Error('GraphQL query resulted in errors')
+          }
+
+          expect(data).toEqual({
+            collection: {
+              conceptId: 'C100000-EDSC',
+              revisionId: '2'
+            }
+          })
+        })
+
+        test('returns null when the specified revision does not exist', async () => {
+          nock(/example-cmr/)
+            .defaultReplyHeaders({
+              'CMR-Took': 7,
+              'CMR-Request-Id': 'abcd-1234-efgh-5678'
+            })
+            .get('/search/collections.umm_json?all_revisions=true&concept_id=C100000-EDSC')
+            .reply(200, {
+              items: [{
+                meta: {
+                  'concept-id': 'C100000-EDSC',
+                  'revision-id': 4
+                },
+                umm: {}
+              }]
+            })
+
+          const response = await server.executeOperation({
+            query: `query GetCollection($params: CollectionInput!) {
+              collection(params: $params) {
+                conceptId
+                revisionId
+              }
+            }`,
+            variables: {
+              params: {
+                conceptId: 'C100000-EDSC',
+                revisionId: '2'
+              }
+            }
+          }, {
+            contextValue
+          })
+
+          const { data, errors } = response.body.singleResult
+
+          expect(errors).toBeUndefined()
+          expect(data).toEqual({
+            collection: null
+          })
+        })
+      })
     })
   })
 

src/types/collection.graphql

@@ -887,6 +887,9 @@ input CollectionInput {
 
   "If this parameter is set (e.g. include_tags=gov.nasa.earthdata.search.*,gov.nasa.echo.*), the collection results will contain an additional field 'tags' within each collection. The value of the tags field is a list of tag_keys that are associated with the collection. Only the tags with tag_key matching the values of include_tags parameter (with wildcard support) are included in the results."
   includeTags: String
+
+  "The revision id of the collection."
+  revisionId: String
 }
 
 type Query {

src/utils/__tests__/parseRequestedFields.test.js

@@ -696,4 +696,50 @@ describe('parseRequestedFields', () => {
       })
     })
   })
+
+  describe('when revisionId is provided', () => {
+    test('moves all keys to ummKeys when revisionId is present', () => {
+      const requestInfo = {
+        name: 'collection',
+        alias: 'collection',
+        args: {
+          params: {
+            revisionId: '1'
+          }
+        },
+        fieldsByTypeName: {
+          Collection: {
+            conceptId: {
+              name: 'conceptId',
+              alias: 'conceptId',
+              args: {},
+              fieldsByTypeName: {}
+            },
+            title: {
+              name: 'title',
+              alias: 'title',
+              args: {},
+              fieldsByTypeName: {}
+            },
+            keyTwo: {
+              name: 'keyTwo',
+              alias: 'keyTwo',
+              args: {},
+              fieldsByTypeName: {}
+            }
+          }
+        }
+      }
+
+      const requestedFields = parseRequestedFields(requestInfo, keyMap, 'collection')
+
+      expect(requestedFields).toEqual({
+        jsonKeys: [],
+        metaKeys: [],
+        ummKeys: ['conceptId', 'keyTwo', 'title'],
+        ummKeyMappings,
+        isList: false
+      })
+    })
+  })
 })

src/utils/cmrQuery.js

@@ -55,8 +55,16 @@ export const cmrQuery = ({
     url: `${process.env.cmrRootUrl}/${path}`
   }
 
+  // Create a new object with the original params and add all_revisions if needed
+  const updatedParams = options.allRevisions
+    ? {
+      ...params,
+      all_revisions: true
+    }
+    : params
+
   // Append any query arguments based on provided params
-  const cmrParameters = prepKeysForCmr(snakecaseKeys(params), nonIndexedKeys)
+  const cmrParameters = prepKeysForCmr(snakecaseKeys(updatedParams), nonIndexedKeys)
 
   const { env } = process
   const { maximumQueryPathLength } = env

src/utils/parseRequestedFields.js

@@ -10,6 +10,7 @@ import { CONCEPT_TYPES, PSEUDO_FIELDS } from '../constants'
  * @param {Array} requestedFields Fields requested
  * @param {Object} keyMap Mappings of UMM fields to requestable fields
  * @param {String} conceptName Name of the concept () to lookup requested fields in the query
+ * @param {Object} params Query parameters that may affect key routing
  */
 export const parseRequestedFields = (parsedInfo, keyMap, conceptName) => {
   let { fieldsByTypeName } = parsedInfo
@@ -236,7 +237,10 @@ export const parseRequestedFields = (parsedInfo, keyMap, conceptName) => {
   ))
 
   // If all requested keys are available in json, use json because its all indexed in CMR
-  if (difference(ummKeys, sharedKeys).length === 0) {
+  // UNLESS revisionId, in which case JSON endpoint doesn't support it
+  const { revisionId } = parsedInfo.args.params || {}
+
+  if (difference(ummKeys, sharedKeys).length === 0 && !revisionId) {
     return {
       jsonKeys: requestedFields,
       metaKeys,
@@ -247,12 +251,18 @@ export const parseRequestedFields = (parsedInfo, keyMap, conceptName) => {
   }
 
   // Requested keys that are not UMM and not CONCEPT_TYPES keys must be json
-  const jsonKeys = requestedFields.filter((field) => (
+  let jsonKeys = requestedFields.filter((field) => (
     !ummKeys.includes(field)
     && !CONCEPT_TYPES.includes(field)
     && !PSEUDO_FIELDS.includes(field)
   ))
 
+  // When revisionId, all data must come from UMM endpoint (JSON endpoint doesn't support it)
+  if (revisionId && jsonKeys.length > 0) {
+    ummKeys = [...ummKeys, ...jsonKeys]
+    jsonKeys = []
+  }
+
   // If we already have to go to the json endpoint get as much info from there as possible
   if (jsonKeys.length > 0) {
     // Move any requested key that is shared over to the jsonKeys
@@ -268,7 +278,7 @@ export const parseRequestedFields = (parsedInfo, keyMap, conceptName) => {
 
   // If facets were requested, we need to ensure we have at least 1 json key
   // some do because facets are not available from the umm endpoint
-  if (metaKeys.includes('collectionFacets') && jsonKeys.length === 0) {
+  if (metaKeys.includes('collectionFacets') && jsonKeys.length === 0 && !revisionId) {
     jsonKeys.push('conceptId')
 
     // Remove the concept id from the ummKeys (if it exists) because we just moved it to the jsonKeys

src/utils/umm/collectionKeyMap.json

@@ -8,6 +8,7 @@
     "hasTransforms",
     "hasVariables",
     "processingLevelId",
+    "provider",
     "shortName",
     "title",
     "versionId"
@@ -52,6 +53,7 @@
     "processingLevel": "umm.ProcessingLevel",
     "processingLevelId": "umm.ProcessingLevel.Id",
     "projects": "umm.Projects",
+    "provider": "meta.provider-id",
     "providerId": "meta.provider-id",
     "publicationReferences": "umm.PublicationReferences",
     "purpose": "umm.Purpose",