README.md

Golang CORS Example

Requirements

This example assumes you are familiar with how serverless functions work. If needed, you can check Scaleway's official documentation

This example uses the Scaleway Serverless Framework Plugin. Please set up your environment with the requirements stated in the Scaleway Serverless Framework Plugin before trying out the example.

Additionnaly it uses the serverless-functions-go library for local testing.

Context

This example shows how to handle preflight CORS requests that will be sent by a browser when invoking a function. The example uses totally permissive, open CORS, you may want to modify this to make it more secure.

Description

The function of the example is to allow most CORS requests. For more documentation on how to control access for CORS requests, see HTTP response headers

This function uses Golang 1.19 runtime.

Setup

Once your environment is set up, you can test your function locally with:

npm install 

go run test/main.go

This will launch a local server, allowing you to test the function. For that, you can run in another terminal:

curl -i -X GET http://localhost:8080

The result should be similar to:

HTTP/2 200
access-control-allow-headers: *
access-control-allow-methods: *
access-control-allow-origin: *
content-length: 44
content-type: text/plain
date: Tue, 12 Apr 2023 12:34:56 GMT
x-envoy-upstream-service-time: 10
server: envoy

This function is allowing most CORS requests

You can also check the result of your function in a browser. It should be "This function is allowing most CORS requests".

Deploy and run

Finally, if the test succeeded, you can deploy your function with:

serverless deploy

Then, from the given URL, you can run:

# Options request
curl -i -X OPTIONS <function URL>

# Get request
curl -i -X GET <function URL>

When invoking this function, the output should be similar to the one obtained when testing locally.