Integrate usage of neptune graph SDK for schema queries and lambda logic (#5)

Introduce usage of the neptune graph (analytics) SDK in a couple scenarios: 1. during pipeline creation, if an axios request fails when querying the Neptune Analytics graph and falls back to SDK and 2. if the user has opted to use SDK for the generated lambda (as opposed to http).

Summary of changes:

-added new dependency on client-neptune-graph version 3.662.0
-created new lambda template which is used if the user specifies --output-resolver-query-sdk option
-set additional lambda environment variable for neptune db name which is required to execute queries using the neptune graph SDK
-added logic to fall back to neptune graph SDK if Axios request fails during pipeline creation (previous logic threw Error as the analytics SDK was not yet available)
-fixed function which retrieves graph summary to use neptune graph SDK if the neptune-type is neptune-graph (the summary endpoint path for neptune-db is not the same for neptune-graph)
-fixed CDK pipeline to only fetch cluster info if the type is neptune-db as it is not required for Neptune-graph (analytics)
-set isNeptuneIAMAuth to true if the neptune type is detected as neptune-graph
-introduced util.js for parsing functions that are used across multiple modules
-refactored function which had many params to use an object param instead for better readability
-fixed some typos which specified 'neptume' instead of 'neptune'
-changed queryNeptune function to have default value of empty object for params
-change jest config from json to js to allow for globals to be set from environment variables
-changed test cases to reference <AIR_ROUTES_DB_HOST> and <AIR_ROUTES_DB_PORT values which are swapped at test runtime for the environment variable values for easier test configurability and to prevent future accidental commit of real URLs
-removed duplicated airports.source.schema.graphql file in test cases and changed to reference single file in parent directory
-fixed Case05/case02.json which I believe was accidentally changed from remove to create pipeline
-introduced new test case 7 which sets --output-resolver-query-sdk option

Author: andreachild

.gitignore

@@ -4,6 +4,7 @@ package-lock.json
 node_modules/**
 templates/Lambda4AppSyncHTTP/node_modules/**
 templates/Lambda4AppSyncSDK/node_modules/**
+templates/Lambda4AppSyncGraphSDK/node_modules/**
 coverage/**
 test/node_modules/**
 test/TestCases/Case01/output/**
@@ -13,4 +14,5 @@ test/TestCases/Case03/output/**
 test/TestCases/Case04/output/**
 test/TestCases/Case05/output/**
 test/TestCases/Case06/output/**
-*.iml
+test/TestCases/Case07/output/**
+*.iml

.jest.js

@@ -0,0 +1,12 @@
+export default {
+    'transform': {},
+    'verbose': true,
+    'testSequencer': './test/jestTestSequencer.js',
+    'globals': {
+        // neptune db that has pre-loaded air routes sample data host and port
+        // ex. db-neptune-foo-bar.cluster-abc.us-west-2.neptune.amazonaws.com
+        'AIR_ROUTES_DB_HOST': process.env.AIR_ROUTES_DB_HOST,
+        // ex. 8182
+        'AIR_ROUTES_DB_PORT': process.env.AIR_ROUTES_DB_PORT
+    }
+};

.jest.json

@@ -11,7 +11,7 @@ Example starting from an Amazon Neptune database endpoint. In this case the util
 
 Example starting from a GraphQL schema.
 
-`neptune-for-graphql --input-schema-file `<*your-graphql-schema-file*>` --output-aws-pipeline-cdk --output-aws-pipeline-cdk-name` <*your-new-GraphQL-API-name*>` --output-aws-pipeline-cdk-neptume-endpoint` <*your-neptune-database-endpoint:port*>` --output-resolver-query-https` 
+`neptune-for-graphql --input-schema-file `<*your-graphql-schema-file*>` --output-aws-pipeline-cdk --output-aws-pipeline-cdk-name` <*your-new-GraphQL-API-name*>` --output-aws-pipeline-cdk-neptune-endpoint` <*your-neptune-database-endpoint:port*>` --output-resolver-query-https` 
 
 
 

doc/cdk.md

@@ -135,7 +135,7 @@ It removes the pipeline created with `--create-update-aws-pipeline`. The resourc
 <br>
 This trigger the creation of a CDK file to be use to create the AWS resources for the GraphQL API, including the AppSync GraphQL API and the Lambda that run the resolver.
 
-`--output-aws-pipeline-cdk-neptume-endpoint <value>, -ce <value>`
+`--output-aws-pipeline-cdk-neptune-endpoint <value>, -ce <value>`
 <br>
 This set the Neptune database endpoint used by the Lambda function to query the Neptune database. If not set it used the endpoint set with `--input-graphdb-schema-neptune-endpoint`.
 

doc/cliReference.md

@@ -21,8 +21,9 @@
   "scripts": {
     "postinstall": "cd templates/Lambda4AppSyncHTTP && npm install && cd ../Lambda4AppSyncSDK && npm install",
     "lint": "eslint neptune-for-graphql.mjs ./src",
-    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage --runInBand --detectOpenHandles --config .jest.json",
-    "test:resolver": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage --runInBand --detectOpenHandles --config .jest.json --testPathPattern=test/TestCases/Case01"
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage --runInBand --detectOpenHandles --config .jest.js",
+    "test:sdk": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage --runInBand --detectOpenHandles --config .jest.js --testPathPattern=test/TestCases/Case07",
+    "test:resolver": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage --runInBand --detectOpenHandles --config .jest.js --testPathPattern=test/TestCases/Case01"
   },
   "jest": {
     "collectCoverage": true,
@@ -53,6 +54,7 @@
     "@aws-sdk/client-lambda": "3.387.0",
     "@aws-sdk/client-neptune": "3.387.0",
     "@aws-sdk/client-neptunedata": "3.403.0",
+    "@aws-sdk/client-neptune-graph": "3.662.0",
     "@aws-sdk/credential-providers": "3.414.0",
     "archiver": "5.3.1",
     "aws4-axios": "3.3.0",

package.json

@@ -10,7 +10,7 @@ express or implied. See the License for the specific language governing
 permissions and limitations under the License.
 */
 
-import { getNeptuneClusterinfoBy } from './pipelineResources.js'
+import { getNeptuneClusterDbInfoBy } from './pipelineResources.js'
 import { readFile, writeFile } from 'fs/promises';
 //import semver from 'semver';
 import fs from 'fs';
@@ -74,7 +74,22 @@ async function createDeploymentFile(folderPath, zipFilePath) {
 }
 
 
-async function createAWSpipelineCDK (pipelineName, neptuneDBName, neptuneDBregion, appSyncSchema, schemaModel, lambdaFilesPath, outputFile, __dirname, quiet, isNeptuneIAMAuth, neptuneHost, neptunePort, outputFolderPath ) {    
+async function createAWSpipelineCDK({
+                                        pipelineName,
+                                        neptuneDBName,
+                                        neptuneDBregion,
+                                        appSyncSchema,
+                                        schemaModel,
+                                        lambdaFilesPath,
+                                        outputFile,
+                                        __dirname,
+                                        quiet,
+                                        isNeptuneIAMAuth,
+                                        neptuneHost,
+                                        neptunePort,
+                                        outputFolderPath,
+                                        neptuneType
+                                    }) {
 
     NAME = pipelineName;    
     REGION = neptuneDBregion;
@@ -89,52 +104,54 @@ async function createAWSpipelineCDK (pipelineName, neptuneDBName, neptuneDBregio
     let spinner = null;
     let neptuneClusterInfo = null;
 
-    try {
-        loggerInfo('Get Neptune Cluster Info');
-        if (!quiet) spinner = ora('Getting ...').start();
-        neptuneClusterInfo = await getNeptuneClusterinfoBy(NEPTUNE_DB_NAME, REGION);
-        if (!quiet) spinner.succeed('Got Neptune Cluster Info');
-        if (isNeptuneIAMAuth) {
-            if (!neptuneClusterInfo.isIAMauth) {
-                loggerError("The Neptune database authentication is set to VPC.");
-                loggerError("Remove the --output-aws-pipeline-cdk-neptune-IAM option.");
-                process.exit(1);
-            }                
-        } else {
-            if (neptuneClusterInfo.isIAMauth) {
-                loggerError("The Neptune database authentication is set to IAM.");
-                loggerError("Add the --output-aws-pipeline-cdk-neptune-IAM option.");
-                process.exit(1);
+    if (neptuneType === 'neptune-db') {
+        try {
+            loggerInfo('Get Neptune Cluster Info');
+            if (!quiet) spinner = ora('Getting ...').start();
+            neptuneClusterInfo = await getNeptuneClusterDbInfoBy(NEPTUNE_DB_NAME, REGION);
+            if (!quiet) spinner.succeed('Got Neptune Cluster Info');
+            if (isNeptuneIAMAuth) {
+                if (!neptuneClusterInfo.isIAMauth) {
+                    loggerError("The Neptune database authentication is set to VPC.");
+                    loggerError("Remove the --output-aws-pipeline-cdk-neptune-IAM option.");
+                    process.exit(1);
+                }
             } else {
-                loggerInfo(`Subnet Group: ` + neptuneClusterInfo.dbSubnetGroup);
+                if (neptuneClusterInfo.isIAMauth) {
+                    loggerError("The Neptune database authentication is set to IAM.");
+                    loggerError("Add the --output-aws-pipeline-cdk-neptune-IAM option.");
+                    process.exit(1);
+                } else {
+                    loggerInfo(`Subnet Group: ` + neptuneClusterInfo.dbSubnetGroup);
+                }
             }
-        }
 
-        if (neptuneClusterInfo.version != '') {
-            const v = neptuneClusterInfo.version;            
-            if (lambdaFilesPath.includes('SDK') == true && //semver.satisfies(v, '>=1.2.1.0') ) {
-                (v == '1.2.1.0' || v == '1.2.0.2' || v == '1.2.0.1' ||  v == '1.2.0.0' || v == '1.1.1.0' || v == '1.1.0.0')) {
-                loggerError("Neptune SDK query is supported starting with Neptune versions 1.2.1.0.R5");
-                loggerError("Switch to Neptune HTTPS query with option --output-resolver-query-https");
-                process.exit(1);
+            if (neptuneClusterInfo.version != '') {
+                const v = neptuneClusterInfo.version;
+                if (lambdaFilesPath.includes('SDK') == true && //semver.satisfies(v, '>=1.2.1.0') ) {
+                    (v == '1.2.1.0' || v == '1.2.0.2' || v == '1.2.0.1' || v == '1.2.0.0' || v == '1.1.1.0' || v == '1.1.0.0')) {
+                    loggerError("Neptune SDK query is supported starting with Neptune versions 1.2.1.0.R5");
+                    loggerError("Switch to Neptune HTTPS query with option --output-resolver-query-https");
+                    process.exit(1);
+                }
             }
-        }
 
-        NEPTUNE_HOST = neptuneClusterInfo.host;
-        NEPTUNE_PORT = neptuneClusterInfo.port;
-        NEPTUNE_DBSubnetGroup = neptuneClusterInfo.dbSubnetGroup.replace('default-', '');                
-        NEPTUNE_IAM_POLICY_RESOURCE = neptuneClusterInfo.iamPolicyResource;      
-    
-    } catch (error) {
-        msg = 'Error getting Neptune Cluster Info: ' + JSON.stringify(error);
-        loggerError(msg);
-        if (!quiet) spinner.fail("Error getting Neptune Cluster Info.");
-        if (!isNeptuneIAMAuth) {
-            spinner.clear();
-            loggerError("VPC data is not available to proceed.");
-            process.exit(1);
-        } else {
-            loggerInfo("Proceeding without getting Neptune Cluster info.");
+            NEPTUNE_HOST = neptuneClusterInfo.host;
+            NEPTUNE_PORT = neptuneClusterInfo.port;
+            NEPTUNE_DBSubnetGroup = neptuneClusterInfo.dbSubnetGroup.replace('default-', '');
+            NEPTUNE_IAM_POLICY_RESOURCE = neptuneClusterInfo.iamPolicyResource;
+
+        } catch (error) {
+            msg = 'Error getting Neptune Cluster Info: ' + JSON.stringify(error);
+            loggerError(msg);
+            if (!quiet) spinner.fail("Error getting Neptune Cluster Info.");
+            if (!isNeptuneIAMAuth) {
+                spinner.clear();
+                loggerError("VPC data is not available to proceed.");
+                process.exit(1);
+            } else {
+                loggerInfo("Proceeding without getting Neptune Cluster info.");
+            }
         }
     }
 
@@ -150,7 +167,8 @@ async function createAWSpipelineCDK (pipelineName, neptuneDBName, neptuneDBregio
     CDKFile = CDKFile.replace( "const NAME = '';",                           `const NAME = '${NAME}';` );
     CDKFile = CDKFile.replace( "const REGION = '';",                         `const REGION = '${REGION}';` );
     CDKFile = CDKFile.replace( "const NEPTUNE_HOST = '';",                   `const NEPTUNE_HOST = '${NEPTUNE_HOST}';` );
-    CDKFile = CDKFile.replace( "const NEPTUNE_PORT = '';",                   `const NEPTUNE_PORT = '${NEPTUNE_PORT}';` );    
+    CDKFile = CDKFile.replace( "const NEPTUNE_PORT = '';",                   `const NEPTUNE_PORT = '${NEPTUNE_PORT}';` );
+    CDKFile = CDKFile.replace( "const NEPTUNE_DB_NAME = '';",                `const NEPTUNE_DB_NAME = '${NEPTUNE_DB_NAME}';` );
     CDKFile = CDKFile.replace( "const NEPTUNE_DBSubnetGroup = null;",        `const NEPTUNE_DBSubnetGroup = '${NEPTUNE_DBSubnetGroup}';` );
     CDKFile = CDKFile.replace( "const NEPTUNE_IAM_AUTH = false;",            `const NEPTUNE_IAM_AUTH = ${isNeptuneIAMAuth};` );    
     CDKFile = CDKFile.replace( "const NEPTUNE_IAM_POLICY_RESOURCE = '*';",   `const NEPTUNE_IAM_POLICY_RESOURCE = '${NEPTUNE_IAM_POLICY_RESOURCE}';` );