/hub-search-proxy

Primary LanguageJavaScript

HubSearchProxy

  • AWS Serverless (Lambda) function that interacts with ResearchHub's ElasticSearch instance
  • Build using the Serverless Framework
  • Supports unit testing and debugging with Visual Studio Code

Setup

  1. Install Serverless Framework globally
npm install -g serverless
  1. Install NPM modules
npm install
  1. Obtain Temporary AWS credentials for UoA (Note: only valid for 1 hour)

Run locally

To run the tests locally simply execute:

npm test

Debug Locally

Inside Visual Studio Code hit F5 and select Debug as config file. Attach breakpoints as desired.

Test

To run all unit tests once simply execute:

npm test

Test and watch for changes

To run all unit tests and have them watch your files for changes:

npm run testw

Deploy to AWS

To deploy to AWS execute (Note: will only deploy after all unit tests have passed):

npm deploy

Deploy to a different stage

  • By default the above command deploys to the sandbox stage
  • You can optionally pass a -- --stage STAGE_NAME flag (Note: the extra --)
npm run deploy -- --stage=test

Get info about existing deployment

To get information about the currently deployed endpoints, region, stage, layers and other things, execute:

sls info

Invoke a deployed Lambda function running on AWS

sls invoke -f hub-search-proxy

Resources

Local Development

  • npm deploy and npm test will not run successfully without AWS credentials. These can be accessed on the Auckland Uni wiki here
  • Make sure that the credentials are located in ~/.aws/credentials and take note of the profile for the credentials. Currently saml is the default profile at the time of writing this.
  • If you wish to test with non-sandbox configurations you will also need to specify the --stage option as either sandbox, nonprod or prod.
  • Passing in the aws credentials to the deploy and test commands can be done by adding arguments after a double dash to the run/test commands. This applies to any npm command.
  • Deploying with the default sandbox stage and saml profile: npm run deploy -- --aws-profile saml
  • Running tests with non-prod stage environment variables. npm run test -- --aws-profile saml --stage nonprod
  • Environmental variables can be set in env/ which is used by serverless when deploying/testing lambda function.