@ff/server v0.0.1

[adoublef]

Description

This is for the service scaffolding. Using this as a template for building a service struct which is easily extendable. Currently there are no dependencies (no databases) but can easily be added at a time we see fit

Fixes #1 (issue)

Current status

• Waiting for review
• Waiting for comment resolution
• Waiting for merge
• Draft
• Trivial PR (nominal cosmetic/typo/whitespace changes)

Semantic Versioning

• This is a feat change

Type of change

• New feature (non-breaking change which adds functionality)

How Has This Been Tested?

I have used this as a basis for testing http services in Go. all checks pass (status 501) with 84% coverage

Manual

Checklist:

• My commit message mentions fix, feat, BREAKING CHANGE accordingly to increase the semantic versioning
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have checked my code/docs and corrected any misspellings

[adoublef]

golangcli-lint fails due to two unused helper functions related to decoding json messages and the cmd/server/main.go not handling error

[pmoieni]

add graceful shutdown and define a stdlib server struct like this to handle timeout and idle situations:

server := http.Server{
   	Addr:         s.Port,
   	Handler:      handler,
   	ErrorLog:     log.Default(),     // set the logger for the server
   	ReadTimeout:  10 * time.Second,  // max time to read request from the client
   	WriteTimeout: 10 * time.Second,  // max time to write response to the client
   	IdleTimeout:  120 * time.Second, // max time for connections using TCP Keep-Alive
   	BaseContext: func(_ net.Listener) context.Context {
   		return serverCtx
   	},
}

[adoublef]

graceful shutdown can be added here, may use a builder pattern as timeouts may be configurable from command line.

[pmoieni]

Service is a general name. use a more specific name like JamService. because not all of the services are gonna have the same struct types and parameters.

It contains more than we want in v0.0.1