feat(go): mongo db sample #100
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,59 @@ | ||||||
| # Mongo + Go example | ||||||
|
|
||||||
| Example to demonstrate the possibility to connect Serverless Functions to MongoDB. | ||||||
|
|
||||||
| For this example, [Scaleway Console](https://console.scaleway.com/) will be used for deployment. | ||||||
|
|
||||||
| > [!WARNING] | ||||||
| > This is a basic sample that does not use certificate for authentication, not recommended for production. | ||||||
|
|
||||||
| ## Requirements | ||||||
|
|
||||||
| - Mongo DB created [documentation](https://www.scaleway.com/en/docs/managed-mongodb-databases/quickstart/#how-to-create-a-database-instance) | ||||||
|
|
||||||
| ## Step 1 - Mongo | ||||||
|
|
||||||
| After Mongo DB creation, in the console find the public endpoint of the database, it should look lile: `<scw_database_id>.mgdb.<scw_region>.scw.cloud` | ||||||
|
|
||||||
|
There was a problem hiding this comment. Also, it lacks the info that the MongoDB must be publicly accessible. Inside a private network, Mongo DB won't be reachable from the container as of today. |
||||||
| Once you get the endpoint, keep it somewhere for later use. | ||||||
|
|
||||||
| ## Step 2 - Function Creation | ||||||
|
|
||||||
| Before creating a the Function, we need to package it into a zip file. | ||||||
|
|
||||||
| > [!TIP] | ||||||
| > It's recommended to do it via command line tools, so the following example shows how to zip this current folder: | ||||||
| > | ||||||
| > ```sh | ||||||
| > cd ~/scaleway/serverless-examples/functions/go-mongo/ | ||||||
| > zip -r go-mongo.zip * | ||||||
| > ``` | ||||||
|
|
||||||
| - Create a Serverless Function namespace. [Documentation](https://www.scaleway.com/en/docs/serverless-functions/how-to/create-manage-delete-functions-namespace/#creating-a-serverless-functions-namespace) | ||||||
| - In the created namespace, create Serverless Function | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| - Select the Go runtime | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| - Upload the previously created `go-mongo.zip` | ||||||
| - Ensure the handler is `Handle` | ||||||
| - Add required Secrets to the Function: | ||||||
|
|
||||||
| | Key | Value | | ||||||
| | --------------------- | -------------------------------------------------------------------------------------------------------------- | | ||||||
| | MONGO_PUBLIC_ENDPOINT | (replace with required values): `<scw_database_id>.mgdb.<scw_region>.scw.cloud` | | ||||||
| | MONGO_USER | user created during Mongo DB setup | | ||||||
| | MONGO_PASSWORD | password created during Mongo DB user setup | | ||||||
|
|
||||||
| ## Step 3 - Test | ||||||
|
|
||||||
| Once your Serverless Function is in `ready` state, you can call it using the generated endpoint. | ||||||
|
|
||||||
| Result should be similar to: | ||||||
|
|
||||||
| ```json | ||||||
| { "ID": 2911126, "Name": "RandomName2911126" } | ||||||
| ``` | ||||||
|
|
||||||
| ## Local testing | ||||||
|
|
||||||
| For testing you can use [Go Offline Testing](https://github.com/scaleway/serverless-functions-go). | ||||||
|
|
||||||
| To run locally, execute: `go run cmd/main.go`. | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| scw "github.com/scaleway/serverless-examples/functions/go-mongo" | ||
| "github.com/scaleway/serverless-functions-go/local" | ||
| ) | ||
|
|
||
| // https://github.com/scaleway/serverless-functions-go | ||
| func main() { | ||
| // Replace "Handle" with your function handler name if necessary | ||
| local.ServeHandler(scw.Handle, local.WithPort(8080)) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,22 @@ | ||||||
| module github.com/scaleway/serverless-examples/functions/go-mongo | ||||||
|
|
||||||
| go 1.24.1 | ||||||
|
There was a problem hiding this comment.
Suggested change
Otherwise, this might break if someone tries to use another patch version, depending on the Go runtime under the hood. |
||||||
|
|
||||||
| require ( | ||||||
| github.com/scaleway/serverless-functions-go v0.1.2 | ||||||
| go.mongodb.org/mongo-driver v1.17.3 | ||||||
| ) | ||||||
|
|
||||||
| require ( | ||||||
| github.com/golang/snappy v0.0.4 // indirect | ||||||
| github.com/google/uuid v1.3.0 // indirect | ||||||
| github.com/klauspost/compress v1.16.7 // indirect | ||||||
| github.com/montanaflynn/stats v0.7.1 // indirect | ||||||
| github.com/xdg-go/pbkdf2 v1.0.0 // indirect | ||||||
| github.com/xdg-go/scram v1.1.2 // indirect | ||||||
| github.com/xdg-go/stringprep v1.0.4 // indirect | ||||||
| github.com/youmark/pkcs8 v0.0.0-20240726163527-a2c0da244d78 // indirect | ||||||
| golang.org/x/crypto v0.26.0 // indirect | ||||||
| golang.org/x/sync v0.8.0 // indirect | ||||||
| golang.org/x/text v0.17.0 // indirect | ||||||
| ) | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= | ||
| github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= | ||
| github.com/golang/snappy v0.0.4 h1:yAGX7huGHXlcLOEtBnF4w7FQwA26wojNCwOYAEhLjQM= | ||
| github.com/golang/snappy v0.0.4/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= | ||
| github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= | ||
| github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= | ||
| github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I= | ||
| github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= | ||
| github.com/klauspost/compress v1.16.7 h1:2mk3MPGNzKyxErAw8YaohYh69+pa4sIQSC0fPGCFR9I= | ||
| github.com/klauspost/compress v1.16.7/go.mod h1:ntbaceVETuRiXiv4DpjP66DpAtAGkEQskQzEyD//IeE= | ||
| github.com/montanaflynn/stats v0.7.1 h1:etflOAAHORrCC44V+aR6Ftzort912ZU+YLiSTuV8eaE= | ||
| github.com/montanaflynn/stats v0.7.1/go.mod h1:etXPPgVO6n31NxCd9KQUMvCM+ve0ruNzt6R8Bnaayow= | ||
| github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= | ||
| github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= | ||
| github.com/scaleway/serverless-functions-go v0.1.2 h1:UUToB+XXpLDG9l6c9c0ALhAs1jvb6rV2Lkyj2kZEYCo= | ||
| github.com/scaleway/serverless-functions-go v0.1.2/go.mod h1:23Hj74DYzTsVY3QgvsM0MGnx0+0OAAabTC06BOMJE58= | ||
| github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8= | ||
| github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= | ||
| github.com/xdg-go/pbkdf2 v1.0.0 h1:Su7DPu48wXMwC3bs7MCNG+z4FhcyEuz5dlvchbq0B0c= | ||
| github.com/xdg-go/pbkdf2 v1.0.0/go.mod h1:jrpuAogTd400dnrH08LKmI/xc1MbPOebTwRqcT5RDeI= | ||
| github.com/xdg-go/scram v1.1.2 h1:FHX5I5B4i4hKRVRBCFRxq1iQRej7WO3hhBuJf+UUySY= | ||
| github.com/xdg-go/scram v1.1.2/go.mod h1:RT/sEzTbU5y00aCK8UOx6R7YryM0iF1N2MOmC3kKLN4= | ||
| github.com/xdg-go/stringprep v1.0.4 h1:XLI/Ng3O1Atzq0oBs3TWm+5ZVgkq2aqdlvP9JtoZ6c8= | ||
| github.com/xdg-go/stringprep v1.0.4/go.mod h1:mPGuuIYwz7CmR2bT9j4GbQqutWS1zV24gijq1dTyGkM= | ||
| github.com/youmark/pkcs8 v0.0.0-20240726163527-a2c0da244d78 h1:ilQV1hzziu+LLM3zUTJ0trRztfwgjqKnBWNtSRkbmwM= | ||
| github.com/youmark/pkcs8 v0.0.0-20240726163527-a2c0da244d78/go.mod h1:aL8wCCfTfSfmXjznFBSZNN13rSJjlIOI1fUNAtF7rmI= | ||
| github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= | ||
| go.mongodb.org/mongo-driver v1.17.3 h1:TQyXhnsWfWtgAhMtOgtYHMTkZIfBTpMTsMnd9ZBeHxQ= | ||
| go.mongodb.org/mongo-driver v1.17.3/go.mod h1:Hy04i7O2kC4RS06ZrhPRqj/u4DTYkFDAAccj+rVKqgQ= | ||
| golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= | ||
| golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= | ||
| golang.org/x/crypto v0.26.0 h1:RrRspgV4mU+YwB4FYnuBoKsUapNIL5cohGAmSH3azsw= | ||
| golang.org/x/crypto v0.26.0/go.mod h1:GY7jblb9wI+FOo5y8/S2oY4zWP07AkOJ4+jxCqdqn54= | ||
| golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= | ||
| golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= | ||
| golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= | ||
| golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= | ||
| golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= | ||
| golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= | ||
| golang.org/x/sync v0.8.0 h1:3NFvSEYkUoMifnESzZl15y791HH1qU2xm6eCJU5ZPXQ= | ||
| golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= | ||
| golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= | ||
| golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= | ||
| golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= | ||
| golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= | ||
| golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= | ||
| golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= | ||
| golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= | ||
| golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= | ||
| golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= | ||
| golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= | ||
| golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ= | ||
| golang.org/x/text v0.17.0 h1:XtiM5bkSOt+ewxlOE/aE/AKEHibwj/6gvWMl9Rsh0Qc= | ||
| golang.org/x/text v0.17.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY= | ||
| golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= | ||
| golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= | ||
| golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= | ||
| golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= | ||
| gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= | ||
| gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,91 @@ | ||||||
| package example | ||||||
|
|
||||||
| import ( | ||||||
| "context" | ||||||
| "encoding/json" | ||||||
| "fmt" | ||||||
| "log/slog" | ||||||
| "math/rand" | ||||||
| "net/http" | ||||||
| "net/url" | ||||||
| "os" | ||||||
|
|
||||||
| "go.mongodb.org/mongo-driver/bson" | ||||||
| "go.mongodb.org/mongo-driver/mongo" | ||||||
| "go.mongodb.org/mongo-driver/mongo/options" | ||||||
| ) | ||||||
|
|
||||||
| var client *mongo.Client | ||||||
|
|
||||||
| type RandomDocument struct { | ||||||
| ID int `bson:"id"` | ||||||
| Name string `bson:"name"` | ||||||
| } | ||||||
|
|
||||||
| func init() { | ||||||
| mongoPublicEndpoint := os.Getenv("MONGO_PUBLIC_ENDPOINT") | ||||||
| if mongoPublicEndpoint == "" { | ||||||
| panic("MONGO_PUBLIC_ENDPOINT is required") | ||||||
| } | ||||||
|
|
||||||
| mongoUser := os.Getenv("MONGO_USER") | ||||||
| if mongoUser == "" { | ||||||
| panic("MONGO_USER is required") | ||||||
| } | ||||||
|
|
||||||
| mongoPassword := url.PathEscape(os.Getenv("MONGO_PASSWORD")) | ||||||
| if mongoPassword == "" { | ||||||
| panic("MONGO_PASSWORD is required") | ||||||
| } | ||||||
|
|
||||||
| // This is a basic sample that does not use certificate for authentication, not recommended for production. | ||||||
| mongo_uri := fmt.Sprintf(`mongodb+srv://%s:%s@%s/?tls=true&tlsInsecure=true`, | ||||||
|
There was a problem hiding this comment. issue: code panics if password contains a I'm not sure if we can escape it, but I feel the connection should be done using credentials := options.Credential{
Username: mongoUser,
Password: mongoPassword,
}
var err error
client, err = mongo.Connect(context.TODO(), options.Client().ApplyURI(mongo_uri).SetAuth(credentials))But I'm facing another issue ( Anyway, like this, it doesn't work with special There was a problem hiding this comment. nit:
Suggested change
|
||||||
| mongoUser, | ||||||
| mongoPassword, | ||||||
| mongoPublicEndpoint) | ||||||
|
|
||||||
| var err error | ||||||
| client, err = mongo.Connect(context.TODO(), options.Client().ApplyURI(mongo_uri)) | ||||||
| if err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
|
|
||||||
| err = client.Ping(context.TODO(), nil) | ||||||
| if err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
|
|
||||||
| slog.Info("Connected to MongoDB") | ||||||
| } | ||||||
|
|
||||||
| func Handle(w http.ResponseWriter, r *http.Request) { | ||||||
| collection := client.Database("testdb").Collection("testcollection") | ||||||
|
|
||||||
| randomID := rand.Intn(100000000) | ||||||
|
|
||||||
| doc := RandomDocument{ | ||||||
| ID: randomID, | ||||||
| Name: fmt.Sprintf("RandomName%d", randomID), | ||||||
| } | ||||||
|
|
||||||
| insertResult, err := collection.InsertOne(context.TODO(), doc) | ||||||
| if err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
|
|
||||||
| slog.Info("Inserted document with ID:", insertResult.InsertedID) | ||||||
|
There was a problem hiding this comment. issue: this displays |
||||||
|
|
||||||
| var result RandomDocument | ||||||
|
|
||||||
| if err := collection.FindOne(context.TODO(), bson.M{"_id": insertResult.InsertedID}).Decode(&result); err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
|
|
||||||
| slog.Info("Found document", result.Name, result.ID) | ||||||
|
|
||||||
| w.Header().Set("Content-Type", "application/json") | ||||||
|
|
||||||
| if err := json.NewEncoder(w).Encode(result); err != nil { | ||||||
| panic(err) | ||||||
| } | ||||||
| } | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.