Run your hapi server in a Google Cloud function.
Follow @marcuspoehls and @superchargejs for updates!
Serverless is becoming popular and widely accepted in the developer community. Going serverless requires a mindset shift. Going serverless requires you to think stateless.
This @supercharge/hapi-google-cloud-functions package let’s you use your hapi.js HTTP server in a Google Cloud function.
This package wraps your hapi server and transforms an incoming request to the cloud function into a hapi-compatible request. This request will be injected into your hapi server and the resulting response transformed back into a cloud-function-compatible format.
It’s basically a “done for you” package to run your hapi server in a serverless function on Google Cloud.
hapi v19 (or later) and Node.js v12 (or newer)
This plugin requires hapi v19 (or later) and Node.js v12 or newer.
| Major Release | hapi.js version | Node.js version |
|---|---|---|
v2 |
>=19 @hapi/hapi |
>=12 |
v1 |
>=18 hapi |
>=8 |
npm i @supercharge/hapi-google-cloud-functions
Using @supercharge/hapi-google-cloud-functions is pretty straightforward:
'use strict'
const Hapi = require('@hapi/hapi')
const CloudFunctionHandler = require('@supercharge/hapi-google-cloud-functions')
// this `handler` will be used as a cached instance
// a warm function will reuse the handler for incoming requests
let handler
module.exports.http = async (request, response) => {
if (!handler) {
// First, compose your hapi server with all the plugins and dependencies
server = new Hapi.Server()
await server.register({
plugin: require('@hapi/vision')
})
// Second, create a handler instance for your server which will
// transform the Cloud function request into a hapi-compatible
// request. Then, send the request through your hapi server
// and transform the response from hapi into a
// function-compatible response
handler = CloudFunctionHandler.for(server)
}
return handler.proxy(request, response)
}There’s a deployment example in the supercharge/playground-google-cloud-functions repository.
We used the Serverless framework to deploy a Supercharge app in the playground-google-cloud-functions repository. The Serverless CLI is sweet because it allows you to deploy your app from a single configuration file.
When deploying with the Serverless CLI, you need to add the serverless-google-cloudfunctions package as a dependency to your project. Install it from NPM:
npm i serverless-google-cloudfunctionsThen, you must add it as a plugin to your serverless.yml file. The next step describes this file in more detail.
Deploying to Google Cloud from the Serverless CLI needs a keyfile. Follow these steps in the Serverless docs to set up your Google Cloud credentials and generate a keyfile.
Here’s the sample serverless.yml used to deploy the app:
service: supercharge-gcp-function # do not use the "google" in the name
provider:
name: google
runtime: nodejs8
region: europe-west1
project: your-gcp-project-name
credentials: ./path/to/your/gcp-keyfile.json
functions:
app:
handler: http
memorySize: 256 # default is 1024 MB
events:
- http: path
plugins:
- serverless-google-cloudfunctionsDeploy your project to Google Cloud using the Serverless CLI. Run the following command from your project directory:
sls deployThe deployment process may take some minutes. When finished, you’ll see a URL to access the deployed function. Enjoy!
Do you miss a string function? We very much appreciate your contribution! Please send in a pull request 😊
- Create a fork
- Create your feature branch:
git checkout -b my-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request 🚀
MIT © Supercharge
superchargejs.com · GitHub @supercharge · Twitter @superchargejs