go-http-utils, v1.0

The library that provides HTTP utility functions.

Major version.

Features

• wrapper for the http.ResponseWriter interface for catching writing errors;
• analog of the http.Redirect() function with catching writing errors;
• middlewares:
  • middleware for catching writing errors;
  • middleware that fallback of requests to static assets to the index.html file (useful in a SPA);
• function to start a server with support for graceful shutdown by a signal.

Installation

Prepare the directory:

$ mkdir --parents "$(go env GOPATH)/src/github.com/thewizardplusplus/"
$ cd "$(go env GOPATH)/src/github.com/thewizardplusplus/"

Clone this repository:

$ git clone https://github.com/thewizardplusplus/go-http-utils.git
$ cd go-http-utils

Install dependencies with the dep tool:

$ dep ensure -vendor-only

Examples

httputils.CatchingResponseWriter:

package main

import (
    "log"
    "net/http"

    httputils "github.com/thewizardplusplus/go-http-utils"
)

func main() {
    http.HandleFunc("/", func(writer http.ResponseWriter, request *http.Request) {
        catchingWriter := httputils.NewCatchingResponseWriter(writer)

        // use the catchingWriter object as the usual http.ResponseWriter interface
        http.Redirect(
            catchingWriter,
            request,
            "http://example.com/",
            http.StatusMovedPermanently,
        )

        if err := catchingWriter.LastError(); err != nil {
            log.Printf("unable to write the HTTP response: %v", err)
        }
    })
}

httputils.CatchingMiddleware():

package main

import (
    "fmt"
    stdlog "log"
    "net/http"
    "os"

    "github.com/go-log/log/print"
    httputils "github.com/thewizardplusplus/go-http-utils"
)

func main() {
    // use the standard logger for error handling
    logger := stdlog.New(os.Stderr, "", stdlog.LstdFlags)
    catchingMiddleware := httputils.CatchingMiddleware(
        // wrap the standard logger via the github.com/go-log/log package
        print.New(logger),
    )

    var handler http.Handler
    handler = http.HandlerFunc(func(writer http.ResponseWriter, _ *http.Request) {
        // writing error will be handled by the catching middleware
        fmt.Fprintln(writer, "Hello, world!")
    })
    handler = catchingMiddleware(handler)

    http.Handle("/", handler)
    logger.Fatal(http.ListenAndServe(":8080", nil))
}

httputils.SPAFallbackMiddleware():

package main

import (
    "log"
    "net/http"

    httputils "github.com/thewizardplusplus/go-http-utils"
)

func main() {
    staticAssetHandler := http.FileServer(http.Dir("/var/www/example.com"))
    staticAssetHandler = httputils.SPAFallbackMiddleware()(staticAssetHandler)

    http.Handle("/", staticAssetHandler)
    log.Fatal(http.ListenAndServe(":8080", nil))
}

httputils.RunServer():

package main

import (
    "context"
    stdlog "log"
    "net/http"
    "os"

    "github.com/go-log/log/print"
    httputils "github.com/thewizardplusplus/go-http-utils"
)

func main() {
    server := &http.Server{Addr: ":8080"}
    // use the standard logger for error handling
    logger := stdlog.New(os.Stderr, "", stdlog.LstdFlags)
    if ok := httputils.RunServer(
        context.Background(),
        server,
        // wrap the standard logger via the github.com/go-log/log package
        print.New(logger),
        os.Interrupt,
    ); !ok {
        // the error is already logged, so just end the program with the error status
        os.Exit(1)
    }
}

Repository

Link: https://github.com/thewizardplusplus/go-http-utils/tree/v1.0.

Content: code.

License: MIT.

Bibliography

1. Check Errors When Calling http.ResponseWriter.Write()
2. Proxying API Requests in Development
3. https://golang.org/pkg/net/http/#Server.Shutdown