An API to encapsulate Happy functionality

To run the server, simply run:

make dev

To run all tests, simply run:

make test

To run a single test, run:

make test name=TestVersionCheckFail

(replace TestVersionCheckFail with the name of the test you want to run)

golangci-lint is used to lint the code in this repo. To run lint locally, run make lint.

Fiber has swagger support which we use to generate documentation (https://github.com/gofiber/swagger).

More information about the declarative comment format can be found here.

Make sure you have swag installed. If not, you can install it with:

go install github.com/swaggo/swag/cmd/swag@latest

After updating annotations update the docs by running:

make update-docs

App configs are stored in YAML files. A file named app-config.yaml will be loaded first (if it exists), then a file named app-config.<env>.yaml will be loaded (if such a file exists) and the values there will override the values loaded from the first file. The value of <env> is specified by the APP_ENV environment variable.

The directory of these files is configurable by setting the CONFIG_YAML_DIRECTORY environment variable (default is the api module root).

App config YAML files should only store non-sensitive values. Sensitive values should use the template syntax and be set as environment variables. For example, oidc_client_id: "{{.OIDC_CLIENT_ID}}" tells the app to inject the value of the OIDC_CLIENT_ID environment variable into the oidc_client_id config value.

Use these resources as a general guide:

• https://github.com/uber-go/guide/blob/master/style.md
• https://go.dev/doc/effective_go
• https://github.com/golang/go/wiki/CommonMistakes
• https://github.com/golang/go/wiki/CodeReviewComments

For receivers, default to pointer receivers unless you are doing performance optimizations:

type A struct {

}
func (a *A) myFunc() {

}

• Until our structs get bigger and more complicated, pass values, not pointers. If you need to modify a struct, consider using a pointer receiver:

type myStruct struct {
    value string
}
func myFunc(s myStruct) {

}

func (m  *myStruct) editMyStruct {
    m.value = "blah"
}

• https://stackoverflow.com/questions/23542989/pointers-vs-values-in-parameters-and-return-values: "Slices, maps, channels, strings, function values, and interface values are implemented with pointers internally, and a pointer to them is often redundant."
• Don't use a pointer to avoid memory allocations or for performance reasons. When we measure out program and find performance issues, we will optimize them based on the usecase.