prpl.go

package prpl

import (
	"net/http"

	"github.com/ua-parser/uap-go/uaparser"
)

type (
	// prpl is an instance of the prpl-server service
	prpl struct {
		http.Handler
		parser         *uaparser.Parser
		config         *ProjectConfig
		builds         builds
		root           http.Dir
		routes         Routes
		staticHandlers map[string]http.Handler
		createTemplate createTemplateFn
		usePush        bool
	}

	// optionFn provides functional option configuration
	optionFn func(*prpl) error
)

// New creates a new prpl instance
func New(options ...optionFn) (*prpl, error) {
	p := prpl{
		parser:         uaparser.NewFromSaved(),
		root:           http.Dir("."),
		staticHandlers: make(map[string]http.Handler),
		createTemplate: createDefaultTemplate,
		usePush:        true,
	}

	for _, option := range options {
		if err := option(&p); err != nil {
			return nil, err
		}
	}

	// use polymer.json for build file by default
	if p.config == nil {
		if err := WithConfigFile("polymer.json")(&p); err != nil {
			return nil, err
		}
	}

	// TODO: pass p in rather than all the properties
	p.builds = loadBuilds(p.config, p.root, p.routes, p.createTemplate)

	p.Handler = p.createHandler()

	return &p, nil
}

// WithRoutes sets the route -> fragment mapping
func WithRoutes(routes Routes) optionFn {
	return func(p *prpl) error {
		p.routes = routes
		return nil
	}
}

// WithRoot sets the root directory
func WithRoot(root http.Dir) optionFn {
	return func(p *prpl) error {
		p.root = root
		return nil
	}
}

// WithConfig sets the project configuration
func WithConfig(config *ProjectConfig) optionFn {
	return func(p *prpl) error {
		p.config = config
		return nil
	}
}

// WithConfigFile loads the project configuration
func WithConfigFile(filename string) optionFn {
	return func(p *prpl) error {
		config, err := ConfigFromFile(filename)
		if err != nil {
			return err
		}
		p.config = config
		return nil
	}
}

// WithUAParserFile allows the uaparser configuration
// to be overriden from the inbuilt settings
func WithUAParserFile(regexFile string) optionFn {
	return func(p *prpl) error {
		parser, err := uaparser.New(regexFile)
		if err != nil {
			return err
		}
		p.parser = parser
		return nil
	}
}

// WithUAParserBytes allows the uaparser configuration
// to be overriden from the inbuilt settings
func WithUAParserBytes(data []byte) optionFn {
	return func(p *prpl) error {
		parser, err := uaparser.NewFromBytes(data)
		if err != nil {
			return err
		}
		p.parser = parser
		return nil
	}
}

// WithStaticHandler allows the handler for certain static
// files to be overridden. This could be used to customize
// the manifest.json file per tenant or to serve specific
// images based on host headers etc ...
func WithStaticHandler(path string, handler http.Handler) optionFn {
	return func(p *prpl) error {
		p.staticHandlers[path] = handler
		return nil
	}
}

// WithRouteTemplate allows the entrypoint to be converted
// into a template so that the output can be transformed if
// required
func WithRouteTemplate(factory createTemplateFn) optionFn {
	return func(p *prpl) error {
		p.createTemplate = factory
		return nil
	}
}

// WithPush allows control over the sending of http server
// push / link headers
func WithPush(usePush bool) optionFn {
	return func(p *prpl) error {
		p.usePush = usePush
		return nil
	}
}