GQL-109: Make cmr-grahphql calls to graphdb easier to use and make cmr-graphql more resistant to a graphdb outage

eudoroolivares2016 · web-flow · commit 1ed8c2609399 · 2025-06-30T12:00:26.000-04:00
* GQL-109: Add env var to not require running graphdb instance, fix searching by provider

* GQL-109: Rename graphdb data source to graphDbRelatedCollections

* GQL-109: Move logic to resolver update README.md
diff --git a/README.md b/README.md
@@ -78,6 +78,7 @@ This application will be available at [http://127.0.0.1:3013/api](http://127.0.0
 #### Local graph database
 
 We use a graph database to query against related collections and duplicate collections. To send queries to a locally running graph database, we can use a docker gremlin-server that exposes an HTTP endpoint. This is launched by running
+You can optionally not require a graphdb server to be running locally by setting the `GRAPHDB_ENABLED` to false in the `.env` for the env you are running against. If it is set to false this will return empty responses from graphdb.
 
 `docker run -it -p 8182:8182 tinkerpop/gremlin-server conf gremlin-server-rest-modern.yaml`
 
diff --git a/bin/deploy-bamboo.sh b/bin/deploy-bamboo.sh
@@ -43,6 +43,7 @@ dockerRun() {
     -e "GRAPHDB_HOST=$bamboo_GRAPHDB_HOST" \
     -e "GRAPHDB_PATH=$bamboo_GRAPHDB_PATH" \
     -e "GRAPHDB_PORT=$bamboo_GRAPHDB_PORT" \
+    -e "GRAPHDB_ENABLED=$bamboo_GRAPHDB_ENABLED" \
     -e "GTM_ID=$bamboo_GTM_ID" \
     -e "LAMBDA_TIMEOUT=$bamboo_LAMBDA_TIMEOUT" \
     -e "LOG_DESTINATION_ARN=$bamboo_LOG_DESTINATION_ARN" \
diff --git a/cdk/graphql/lib/graphql-stack.ts b/cdk/graphql/lib/graphql-stack.ts
@@ -32,6 +32,7 @@ const environment = {
   edlJwk: process.env.EDL_JWK!,
   edlKeyId: process.env.EDL_KEY_ID!,
   graphdbHost: process.env.GRAPHDB_HOST || 'http://localhost',
+  graphdbEnabled: process.env.GRAPHDB_ENABLED || 'true',
   graphdbPath: process.env.GRAPHDB_PATH!,
   graphdbPort: process.env.GRAPHDB_PORT || '8182',
   maxRetries: process.env.MAX_RETRIES || '1',
diff --git a/src/datasources/__tests__/graphDbRelatedCollections.test.js b/src/datasources/__tests__/graphDbRelatedCollections.test.js
@@ -1,6 +1,6 @@
 import nock from 'nock'
 
-import graphDbDatasource from '../graphDb'
+import graphDbRelatedCollectionsDatasource from '../graphDbRelatedCollections'
 
 import relatedCollectionsGraphDbPlatformInstrumentGraphdbResponseMocks from './__mocks__/relatedCollections.graphDbPlatformInstrument.graphdbResponse.mocks'
 import relatedCollectionsGraphDbPlatformInstrumentResponseMocks from './__mocks__/relatedCollections.graphDbPlatformInstrument.response.mocks'
@@ -168,7 +168,7 @@ describe('graphDb', () => {
           })
           .reply(200, relatedCollectionsRelatedUrlTypeGraphdbResponseMocks)
 
-        const response = await graphDbDatasource(
+        const response = await graphDbRelatedCollectionsDatasource(
           { conceptId: 'C100000-EDSC' },
           {
             limit: 1,
@@ -207,7 +207,7 @@ describe('graphDb', () => {
           })
           .reply(200, relatedCollectionsRelatedUrlSubtypeGraphdbResponseMocks)
 
-        const response = await graphDbDatasource(
+        const response = await graphDbRelatedCollectionsDatasource(
           { conceptId: 'C100000-EDSC' },
           {
             limit: 1,
@@ -251,7 +251,7 @@ describe('graphDb', () => {
           })
           .reply(200, relatedCollectionsRelatedUrlTypeAndSubtypeGraphdbResponseMocks)
 
-        const response = await graphDbDatasource(
+        const response = await graphDbRelatedCollectionsDatasource(
           { conceptId: 'C100000-EDSC' },
           {
             limit: 1,
@@ -354,7 +354,7 @@ describe('graphDb', () => {
           })
           .reply(200, relatedCollectionsGraphDbProjectGraphdbResponseMocks)
 
-        const response = await graphDbDatasource(
+        const response = await graphDbRelatedCollectionsDatasource(
           { conceptId: 'C100000-EDSC' },
           {
             limit: 1
@@ -459,7 +459,7 @@ describe('graphDb', () => {
           })
           .reply(200, relatedCollectionsGraphDbPlatformInstrumentGraphdbResponseMocks)
 
-        const response = await graphDbDatasource(
+        const response = await graphDbRelatedCollectionsDatasource(
           { conceptId: 'C100000-EDSC' },
           {
             limit: 1
@@ -576,7 +576,7 @@ describe('graphDb', () => {
           })
           .reply(200, relatedCollectionsGraphDbRelatedUrlGraphdbResponseMocks)
 
-        const response = await graphDbDatasource(
+        const response = await graphDbRelatedCollectionsDatasource(
           { conceptId: 'C100000-EDSC' },
           {
             limit: 1
@@ -696,7 +696,7 @@ describe('graphDb', () => {
           })
           .reply(200, relatedCollectionsGraphDbRelatedUrlGraphdbResponseMocks)
 
-        const response = await graphDbDatasource(
+        const response = await graphDbRelatedCollectionsDatasource(
           { conceptId: 'C100000-EDSC' },
           {
             limit: 1,
@@ -827,7 +827,7 @@ describe('graphDb', () => {
           })
           .reply(200, relatedCollectionsGraphDbRelatedUrlProjectGraphdbResponseMocks)
 
-        const response = await graphDbDatasource(
+        const response = await graphDbRelatedCollectionsDatasource(
           { conceptId: 'C100000-EDSC' },
           {
             limit: 1,
@@ -957,7 +957,7 @@ describe('graphDb', () => {
           })
           .reply(200, relatedCollectionsGraphDbRelatedUrlRelationshipTypeGraphdbResponseMocks)
 
-        const response = await graphDbDatasource(
+        const response = await graphDbRelatedCollectionsDatasource(
           { conceptId: 'C100000-EDSC' },
           {
             limit: 1,
@@ -1063,7 +1063,7 @@ describe('graphDb', () => {
           })
           .reply(200, relatedCollectionsGraphDbCitationGraphdbResponseMocks)
 
-        const response = await graphDbDatasource(
+        const response = await graphDbRelatedCollectionsDatasource(
           { conceptId: 'C100000-EDSC' },
           {
             limit: 1
@@ -1174,7 +1174,7 @@ describe('graphDb', () => {
           })
           .reply(200, relatedCollectionsGraphDbScienceKeywordGraphdbResponseMocks)
 
-        const response = await graphDbDatasource(
+        const response = await graphDbRelatedCollectionsDatasource(
           { conceptId: 'C100000-EDSC' },
           {
             limit: 1
@@ -1305,7 +1305,7 @@ describe('graphDb', () => {
           })
           .reply(200, relatedCollectionsGraphDbRelatedUrlCitationGraphdbResponseMocks)
 
-        const response = await graphDbDatasource(
+        const response = await graphDbRelatedCollectionsDatasource(
           { conceptId: 'C100000-EDSC' },
           {
             limit: 1
@@ -1403,7 +1403,7 @@ describe('graphDb', () => {
           })
           .reply(200, relatedCollectionsRelationshipTypeGraphdbResponseMocks)
 
-        const response = await graphDbDatasource(
+        const response = await graphDbRelatedCollectionsDatasource(
           { conceptId: 'C100000-EDSC' },
           {
             limit: 1
@@ -1480,7 +1480,7 @@ describe('graphDb', () => {
           })
           .reply(200, relatedCollectionsNoRelationshipsGraphDbResponseMock)
 
-        const response = await graphDbDatasource(
+        const response = await graphDbRelatedCollectionsDatasource(
           { conceptId: 'C100000-EDSC' },
           {
             limit: 1
@@ -1500,8 +1500,8 @@ describe('graphDb', () => {
     })
   })
 
-  describe('Testing permitted groups on related collections', () => {
-    test('Testing that permitted groups is in the post request', async () => {
+  describe('When the related collections are behind permitted groups', () => {
+    test('Testing that permitted groups are in the gremlin request', async () => {
       nock(/example-graphdb/)
         .post('/', (body) => {
           const parsedBody = typeof body === 'string' ? JSON.parse(body) : body
@@ -1539,7 +1539,7 @@ describe('graphDb', () => {
           ]
         })
 
-      const response = await graphDbDatasource(
+      const response = await graphDbRelatedCollectionsDatasource(
         { conceptId: 'C100000-EDSC' },
         {
           limit: 1
@@ -1556,40 +1556,42 @@ describe('graphDb', () => {
       expect(response).toEqual(relatedCollectionsRelationshipTypeResponseMocks)
     })
 
-    test('Mocking the response for a client not being in any groups, and retrieving no related collections', async () => {
-      nock(/example-graphdb/)
-        .post('/', (body) => {
-          const parsedBody = typeof body === 'string' ? JSON.parse(body) : body
-          const gremlinQuery = parsedBody?.gremlin || ''
+    describe('when the user is in no groups', () => {
+      test('the response contains no related collections', async () => {
+        nock(/example-graphdb/)
+          .post('/', (body) => {
+            const parsedBody = typeof body === 'string' ? JSON.parse(body) : body
+            const gremlinQuery = parsedBody?.gremlin || ''
 
-          const hasCorrectPermittedGroups = gremlinQuery.includes('within(\'registered\',\'guest\')')
-          const hasOtherV = gremlinQuery.includes('.otherV()')
+            const hasCorrectPermittedGroups = gremlinQuery.includes('within(\'registered\',\'guest\')')
+            const hasOtherV = gremlinQuery.includes('.otherV()')
 
-          return hasCorrectPermittedGroups && hasOtherV
-        })
-        .reply(200, relatedCollectionsResponseEmptyMocks)
+            return hasCorrectPermittedGroups && hasOtherV
+          })
+          .reply(200, relatedCollectionsResponseEmptyMocks)
 
-      nock(/example-urs/)
-        .get(/groups_for_user/)
-        .reply(200, {})
+        nock(/example-urs/)
+          .get(/groups_for_user/)
+          .reply(200, {})
 
-      const response = await graphDbDatasource(
-        { conceptId: 'C100000-EDSC' },
-        {
-          limit: 1
-        },
-        {
-          headers: {
-            'Client-Id': 'eed-test-graphql',
-            'CMR-Request-Id': 'abcd-1234-efgh-5678'
+        const response = await graphDbRelatedCollectionsDatasource(
+          { conceptId: 'C100000-EDSC' },
+          {
+            limit: 1
           },
-          edlUsername: 'someEdlUsername'
-        },
-        parsedInfo
-      )
-      expect(response).toEqual({
-        count: 0,
-        items: []
+          {
+            headers: {
+              'Client-Id': 'eed-test-graphql',
+              'CMR-Request-Id': 'abcd-1234-efgh-5678'
+            },
+            edlUsername: 'someEdlUsername'
+          },
+          parsedInfo
+        )
+        expect(response).toEqual({
+          count: 0,
+          items: []
+        })
       })
     })
   })
diff --git a/src/datasources/graphDbDuplicateCollections.js b/src/datasources/graphDbDuplicateCollections.js
@@ -22,7 +22,7 @@ export default async (
 
   const { doi: doiDescription } = doi || {}
 
-  // If doi or shorName don't exist, return 0 duplicateCollections
+  // If doi or shortName don't exist, return 0 duplicateCollections
   if (!doiDescription || !shortName) {
     return {
       count: 0,
diff --git a/src/datasources/graphDbRelatedCollections.js b/src/datasources/graphDbRelatedCollections.js
@@ -175,18 +175,17 @@ export default async (
     headers,
     query
   })
-
   const { result } = data
 
   // Useful for debugging!
   // console.log('GraphDB query', JSON.parse(query))
   // console.log('GraphDB Response result: ', JSON.stringify(result, null, 2))
 
   const { data: resultData } = result
-  const { '@value': dataValues } = resultData
+  const { '@value': dataValues = [] } = resultData
 
   const collectionsList = []
-  let totalRelatedCollectionsCount
+  let totalRelatedCollectionsCount = 0
 
   dataValues.forEach((dataValue) => {
     const { '@value': dataValueMap } = dataValue
@@ -288,7 +287,6 @@ export default async (
     count: totalRelatedCollectionsCount,
     items: collectionsList
   }
-
   // Useful for debugging!
   // console.log('graphDb.js response', JSON.stringify(returnObject, null, 2))
 
diff --git a/src/graphql/handler.js b/src/graphql/handler.js
@@ -37,7 +37,7 @@ import dataQualitySummarySource from '../datasources/dataQualitySummary'
 import granuleSource from '../datasources/granule'
 import graphDbAssociatedCitations from '../datasources/graphDbAssociatedCitations'
 import graphDbDuplicateCollectionsSource from '../datasources/graphDbDuplicateCollections'
-import graphDbSource from '../datasources/graphDb'
+import graphDbRelatedCollectionsSource from '../datasources/graphDbRelatedCollections'
 import gridSource from '../datasources/grid'
 import maxItemsPerOrderSource from '../datasources/maxItemsPerOrder'
 import permissionSource from '../datasources/permission'
@@ -249,7 +249,7 @@ export default startServerAndCreateLambdaHandler(
           granuleSource,
           graphDbAssociatedCitations,
           graphDbDuplicateCollectionsSource,
-          graphDbSource,
+          graphDbRelatedCollectionsSource,
           gridSource,
           groupSourceCreate,
           groupSourceDelete,
diff --git a/src/resolvers/__tests__/__mocks__/mockServer.js b/src/resolvers/__tests__/__mocks__/mockServer.js
@@ -20,7 +20,7 @@ import dataQualitySummarySource from '../../../datasources/dataQualitySummary'
 import granuleSource from '../../../datasources/granule'
 import graphDbAssociatedCitations from '../../../datasources/graphDbAssociatedCitations'
 import graphDbDuplicateCollectionsSource from '../../../datasources/graphDbDuplicateCollections'
-import graphDbSource from '../../../datasources/graphDb'
+import graphDbRelatedCollectionsSource from '../../../datasources/graphDbRelatedCollections'
 import gridSource from '../../../datasources/grid'
 import maxItemsPerOrderSource from '../../../datasources/maxItemsPerOrder'
 import permissionSource from '../../../datasources/permission'
@@ -122,7 +122,7 @@ export const buildContextValue = (extraContext) => ({
     granuleSource,
     graphDbAssociatedCitations,
     graphDbDuplicateCollectionsSource,
-    graphDbSource,
+    graphDbRelatedCollectionsSource,
     gridSource,
     groupSourceCreate,
     groupSourceDelete,
diff --git a/src/resolvers/__tests__/collection.test.js b/src/resolvers/__tests__/collection.test.js
diff --git a/src/resolvers/collection.js b/src/resolvers/collection.js
