Cloud Backend test solution

.eslintignore

@@ -0,0 +1 @@
+node_modules/*

.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'prettier'],
+  extends: [
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier',
+  ],
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  rules: {
+    'require-await': 2,
+    '@typescript-eslint/camelcase': 0,
+    'prettier/prettier': [
+      'error',
+      {
+        singleQuote: true,
+        trailingComma: 'es5',
+        arrowParens: 'always',
+      },
+    ],
+  },
+};

.gitignore

@@ -0,0 +1,21 @@
+node_modules
+.env
+dist/
+
+coverage/*
+.nyc_output/*
+
+# CDK asset staging directory
+.cdk.staging
+cdk.out
+cdk.context.json
+
+
+# Parcel build directories
+.cache
+.build
+nodejs
+nodejs.zip
+.DS_Store
+conf/.env
+hive.json

.husky/.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run commit-msg

.husky/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run pre-commit

.husky/.husky/pre-push

@@ -0,0 +1,4 @@
+#!/bin/sh
+ . "$(dirname "$0")/_/husky.sh"
+
+npm run pre-push

.mocharc.json

@@ -0,0 +1,13 @@
+{
+    "diff": true,
+    "extension": ["ts"],
+    "opts": false,
+    "sort": true,
+    "color": true,
+    "slow": 75,
+    "timeout": 99999,
+    "ui": "bdd",
+    "spec": "src/test/**/*.test.ts",
+    "require": "ts-node/register",
+    "reporter": "spec"
+}

.prettierrc.json

@@ -0,0 +1,3 @@
+{
+    "singleQuote": true
+}

.sample.env

@@ -0,0 +1,6 @@
+SERVICE_PORT=
+API_KEY=<YOUR_API_KEY>
+JWT_TOKENS_AUTHORITY=
+DEPLOY_REGION=
+ENV_SHORT=
+STACK_NAME=

bin/graphql-cdk.ts

@@ -0,0 +1,39 @@
+#!/usr/bin/env node
+
+import * as cdk from '@aws-cdk/core';
+
+import { GraphqlLambdaStack } from '../deploy/graphql-stack';
+import conf from '../src/conf';
+import { Environment } from '../src/conf/config';
+
+const account = conf.deployAccount;
+const region = conf.deployRegion;
+const hostedZone = process.env.DEPLOY_ZONE ?? 'us-east-1';
+
+const authority = conf.jwtTokens.authority;
+const environment = conf.env as Environment;
+const serviceName = 'graphql';
+const apiKey = conf.apiKey as string;
+const hiveToken = conf.hiveToken as string;
+
+class GraphQLCDKApp extends cdk.App {
+  constructor() {
+    super();
+
+    new GraphqlLambdaStack(this, `${conf.stackName}`, {
+      environment,
+      env: {
+        account,
+        region,
+      },
+      hostedZone: hostedZone,
+      authority,
+      serviceName,
+      apiKey,
+      hiveToken,
+    });
+  }
+}
+
+const app = new GraphQLCDKApp();
+app.synth();

cdk.json

@@ -0,0 +1,9 @@
+{
+    "app": "npx ts-node bin/graphql-cdk.ts",
+    "requireApproval": "never",
+    "context": {
+      "@aws-cdk/core:enableStackNameDuplicates": "true",
+      "aws-cdk:enableDiffNoFail": "true"
+    }
+}
+

deploy/deploy.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+set -e
+
+# Installing only prod dependencies because of 250MB limitation
+# https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html
+echo "## Installing prd dependencies..."
+npm install --only=prod --loglevel=warn
+npm run build -- --project tsconfig.prod.json
+
+AWS_CREDS_FILE=~/.aws/credentials
+if [[ ! -e ~/.aws/credentials ]]; then
+    mkdir ~/.aws
+    touch $AWS_CREDS_FILE
+    chmod 600 $AWS_CREDS_FILE
+fi
+
+grep -qF -- "[graphql-deploy]" ~/.aws/credentials || cat << EndOfFile >> $AWS_CREDS_FILE
+[graphql-deploy]
+aws_access_key_id=${AWS_ACCESS_KEY_ID}
+aws_secret_access_key=${AWS_SECRET_ACCESS_KEY}
+EndOfFile
+
+echo "## Check for existing nodejs directory..."
+if [[ ! -e nodejs ]]; then
+    echo "## Deleting nodejs zip"
+    rm -rf nodejs.zip
+        echo "## Creating nodejs directory..."
+    mkdir nodejs
+fi
+cd nodejs
+cp -r ../node_modules node_modules
+cp ../package.json .
+cp ../schema.graphql ../dist
+cd .. || exit
+npm run zip:nodejs
+
+npm run cdk -- deploy --profile graphql-deploy -o cdk.out
+
+rm -r nodejs
+rm -r nodejs.zip

deploy/graphql-stack.ts

@@ -0,0 +1,78 @@
+import * as cdk from '@aws-cdk/core';
+import * as lambda from '@aws-cdk/aws-lambda';
+import * as apiGateway from '@aws-cdk/aws-apigateway';
+import { Construct } from '@aws-cdk/core';
+import { Duration } from '@aws-cdk/core';
+import * as gql from './graphql';
+// import _ from 'lodash';
+// import * as ec2 from '@aws-cdk/aws-ec2';
+
+const createTagger =
+  (tags: { [key: string]: string }) => (taggable: Construct) =>
+    Object.keys(tags).map((tag) => cdk.Tags.of(taggable).add(tag, tags[tag]));
+
+export class GraphqlLambdaStack extends cdk.Stack {
+  constructor(scope: cdk.Construct, id: string, props: gql.StackProps) {
+    super(scope, id, props);
+    const tagIt = createTagger({
+      env: props.environment,
+      'provisioned-by': 'cdk',
+      service: 'graphql',
+      Name: `${props.environment}-${props.env?.region}-${props.serviceName}`,
+    });
+    // The code that defines your stack goes here
+    const layer = new lambda.LayerVersion(this, 'NpmModulesLayer', {
+      code: new lambda.AssetCode('nodejs.zip'),
+      compatibleRuntimes: [lambda.Runtime.NODEJS_12_X],
+      description: 'A layer to package modules',
+    });
+
+    // If you want, you can configure own VPC, subnets, SGs when creating
+    // Lambda function.
+
+    // const vpc = ec2.Vpc.fromLookup(this, 'Vpc', {
+    //   vpcId: props.vpcId,
+    // });
+    // const securityGroup = ec2.SecurityGroup.fromSecurityGroupId(
+    //   this,
+    //   'GraphQLSG',
+    //   'sg-0e8485c6cad5d3be7',
+    //   {
+    //     mutable: false,
+    //   }
+    // );
+    const graphqlLambda = new lambda.Function(this, 'MessageHandler', {
+      functionName: 'GraphQLLambda',
+      description: 'Process GraphQL requests',
+      // Where our lambda function is located
+      code: new lambda.AssetCode('dist'),
+      // What should be executed once the lambda is invoked
+      // - in that case, the `handler` function exported by `handler.ts`
+      handler: 'handler.handler',
+      runtime: lambda.Runtime.NODEJS_12_X,
+      timeout: Duration.seconds(300),
+      environment: {
+        AUTHORITY: props.authority,
+        API_KEY: props.apiKey,
+        HIVE_TOKEN: props.hiveToken,
+      },
+      layers: [layer],
+      // vpc: vpc,
+      // vpcSubnets: {
+      //   subnets: _.filter(vpc.privateSubnets, (subnet) => {
+      //     return props.subnetIds.includes(subnet.subnetId);
+      //   }),
+      // },
+      // securityGroups: [securityGroup]
+    });
+    tagIt(graphqlLambda);
+    const apiGatewayLambdaRestApi = new apiGateway.LambdaRestApi(
+      this,
+      'graphqlEndpoint',
+      {
+        handler: graphqlLambda,
+      }
+    );
+    tagIt(apiGatewayLambdaRestApi);
+  }
+}

deploy/graphql.ts

@@ -0,0 +1,18 @@
+import * as cdk from '@aws-cdk/core';
+
+export enum Environment {
+  Production = 'prd',
+  Staging = 'stg',
+  QA = 'qa',
+  Development = 'dev',
+}
+
+export interface StackProps extends cdk.StackProps {
+  apiKey: string;
+  hiveToken: string;
+  environment: Environment;
+  imageTag?: string;
+  hostedZone: string;
+  authority: string;
+  serviceName: string;
+}

documentation/2_HowToDeploy.md

@@ -0,0 +1,66 @@
+## Deployment guide
+
+### Welcome to CDK TypeScript project
+
+  You should explore the contents of this project. It demonstrates a CDK app with an instance of a stack (`DevGraphQLStack`)
+  which contains a Lambda Function and API Gateway.
+
+  The `cdk.json` file tells the CDK Toolkit how to execute your app.<p>&nbsp;</p>
+
+### What prerequisites do I need to deploy the service?
+
+  1. Install node and awscli, follow this [link](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html) to confugure aws.
+
+  2. Install cdk, `npm install aws-cdk`
+    This same depedency is mentioned in `package.json` as well, but installing ahead for cdk bootstrap purposes
+
+  3. Run `cdk bootstrap aws://<YOUR_AWS_ACCOUNT>/<YOUR_AWS_REGION>` which will set up a deployment environment on AWS you can use with your default AWS credentials. For example, `cdk bootstrap aws://1234567/us-east-1`
+
+  Note: Keep in mind not to install extra packages other than prd dependencies in `package.json`, because of lambda 250MB limitation, for more [details](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html)
+
+
+### <u>How to deploy CDK stack</u>
+
+  deploy.sh script to deploy cdk stacks to Dev, QA, STG, PRD environments.
+
+  `deploy.sh` script is to deploy CDK stacks to AWS
+    - pass these as command line arguments for `deploy.sh`
+    AWS_ACCESS_KEY_ID - <YOUR_AWS_ACCESS_KEY_ID>
+    AWS_SECRET_ACCESS_KEY - <YOUR_AWS_SECRET_ACCESS_KEY>
+
+  eg:, from the root dir:
+  ```bash
+  AWS_ACCESS_KEY_ID=<YOUR_AWS_ACCESS_KEY_ID> AWS_SECRET_ACCESS_KEY=<YOUR_AWS_SECRET_ACCESS_KEY> bash deploy/deploy.sh
+  ```
+  Grab GraphQL endpoint from cdk output.
+
+  Example output
+  ```bash
+  Outputs:
+  DevGraphQLStack.graphqlEndpoint711CBBBD = https://6holtoh5t4.execute-api.us-east-1.amazonaws.com/prod/
+  ```
+  <p>&nbsp;</p>
+
+### Troubleshooting
+
+  1.verify cloudformation stack with right resources like lambda, api gaeway deployed in AWS
+  2. Clod watch logs are helpful to debug any issues
+
+### Useful commands
+
+  - `npm run build` compile typescript to js
+  - `npm run watch` watch for changes and compile
+  - `npm run test` perform the mocha unit tests
+  - `cdk deploy` deploy this stack to your default AWS account/region
+  - `cdk diff` compare deployed stack with current state
+  - `cdk synth` emits the synthesized CloudFormation template
+
+  NOTE: To deploy, you will need to run `cdk bootstrap` which will set up a deployment environment on AWS you can use with your default AWS credentials.
+
+  - cdk deploy deploy this stack to your default AWS account/region, in graphql case, stack is going to be Lambda Function, Lambda Layer, IAM Role, Policy, API Gateway etc..
+  - cdk diff compare deployed stack with current state
+  - cdk synth emits the synthesized CloudFormation template to ./cdk.out
+
+  [Layers](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-lambda-readme.html#layers): using lambda layers to provision code to Lambda function which are node modules.
+  Check [here](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-lambda-readme.html#bundling-asset-code) for more details.<p>&nbsp;</p>
+

documentation/3_HowToRun.md

@@ -0,0 +1,10 @@
+### How to run
+  Once Stack is deployed, access API Gateway in Postman. First update Lambda configuration environment variables with the right API key. By providing right jwt token, you can access GraphQL API by appending `/graphql` at the end.
+
+  #### How to generate API_KEY in Google Cloud Console?
+
+  > Follow this [link](https://developers.google.com/maps/documentation/geocoding/get-api-key) to create API key and restrict to use it for Geocoding API
+
+### GraphQL Endpoint
+
+  For example, you can hit `https://dqe0uhf4s5.execute-api.us-east-1.amazonaws.com/prod/graphql` and make queries with the right JWT token. Please check `documentation/8_HowToGenerateJWT.md` for more details about how to generate jwt token.