adalal/gotenberg
1
0
Fork 0
mirror of https://github.com/gotenberg/gotenberg.git synced 2026-08-13 02:42:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

minor refactoring of const + better timeout handling in pinter package + api package tests

Browse Source
This commit is contained in:
Julien Neuhart
2019-07-10 11:46:58 +02:00
parent 0c1e4e6888
commit f6b357691c
27 changed files with 604 additions and 213 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
internal/app/api/pkg/context/context.go
View File

@@ -36,7 +36,7 @@ func New(c echo.Context, logger *logger.Logger, config *config.Config) *Context
// MustCastFromEchoContext cast an echo.Context to our custom
// context. If something goes wrong, panic.
func MustCastFromEchoContext(c echo.Context) *Context {
const op = "context.MustCastFromEchoContext"
const op string = "context.MustCastFromEchoContext"
ctx, ok := c.(*Context)
if !ok {
panic(fmt.Sprintf("%s: unable to cast an echo.Context to a custom context", op))
@@ -60,7 +60,7 @@ func (ctx *Context) Resource() *resource.Resource {
// WithResource adds a resource to the context.
func (ctx *Context) WithResource(resourceDirPath string) error {
const op = "context.WithResource"
const op string = "context.WithResource"
r, err := resource.New(ctx, ctx.logger, ctx.config, resourceDirPath)
ctx.resource = r
if err != nil {
@@ -75,7 +75,7 @@ func (ctx *Context) WithResource(resourceDirPath string) error {
// LogRequestResult logs the result of a request.
// This method should only be used by a middleware!
func (ctx *Context) LogRequestResult(err error, isDebug bool) error {
const op = "context.LogRequestResult"
const op string = "context.LogRequestResult"
req := ctx.Request()
resp := ctx.Response()
stopTime := time.Now()

2
internal/app/api/pkg/handler/handler.go
View File

@@ -35,7 +35,7 @@ const (
)
func convert(ctx *context.Context, p printer.Printer) error {
const op = "handler.convert"
const op string = "handler.convert"
r := ctx.Resource()
logger := ctx.StandardLogger()
baseFilename := random.Get()

2
internal/app/api/pkg/handler/html.go
View File

@@ -10,7 +10,7 @@ import (
// HTML is the endpoint for converting
// HTML to PDF.
func HTML(c echo.Context) error {
const op = "handler.HTML"
const op string = "handler.HTML"
ctx := context.MustCastFromEchoContext(c)
ctx.StandardLogger().DebugfOp(op, "html request")
r := ctx.Resource()

2
internal/app/api/pkg/handler/markdown.go
View File

@@ -10,7 +10,7 @@ import (
// Markdown is the endpoint for converting
// Markdown to PDF.
func Markdown(c echo.Context) error {
const op = "handler.Markdown"
const op string = "handler.Markdown"
ctx := context.MustCastFromEchoContext(c)
ctx.StandardLogger().DebugfOp(op, "markdown request")
r := ctx.Resource()

2
internal/app/api/pkg/handler/merge.go
View File

@@ -10,7 +10,7 @@ import (
// Merge is the endpoint for
// merging PDF files.
func Merge(c echo.Context) error {
const op = "handler.Merge"
const op string = "handler.Merge"
ctx := context.MustCastFromEchoContext(c)
ctx.StandardLogger().DebugfOp(op, "merge request")
r := ctx.Resource()

2
internal/app/api/pkg/handler/office.go
View File

@@ -10,7 +10,7 @@ import (
// Office is the endpoint for converting
// Office files to PDF.
func Office(c echo.Context) error {
const op = "handler.Office"
const op string = "handler.Office"
ctx := context.MustCastFromEchoContext(c)
ctx.StandardLogger().DebugfOp(op, "office request")
r := ctx.Resource()

2
internal/app/api/pkg/handler/url.go
View File

@@ -11,7 +11,7 @@ import (
// URL is the endpoint for converting
// a URL to PDF.
func URL(c echo.Context) error {
const op = "handler.URL"
const op string = "handler.URL"
ctx := context.MustCastFromEchoContext(c)
ctx.StandardLogger().DebugfOp(op, "url request")
r := ctx.Resource()

2
internal/app/api/pkg/middleware/cleanup.go
View File

@@ -11,7 +11,7 @@ import (
func Cleanup() echo.MiddlewareFunc {
return func(next echo.HandlerFunc) echo.HandlerFunc {
return func(c echo.Context) error {
const op = "middleware.Cleanup"
const op string = "middleware.Cleanup"
err := next(c)
ctx := context.MustCastFromEchoContext(c)
r := ctx.Resource()

4
internal/app/api/pkg/middleware/context.go
View File

@@ -15,13 +15,13 @@ import (
const (
// TestingTraceEnvVar is an environment
// variable used in some tests.
TestingTraceEnvVar = "TESTING_TRACE"
TestingTraceEnvVar string = "TESTING_TRACE"
// TestsTracePrefix helps
// creating all resources inside a prefix.
// Only used in some tests
// to check if the resources
// have been removed.
TestsTracePrefix = "tmp"
TestsTracePrefix string = "tmp"
)
// Context helps extending the default echo.Context with

28
internal/app/api/pkg/resource/resource.go
View File

@@ -65,7 +65,7 @@ type Resource struct {
// New creates a new resource.
func New(c echo.Context, logger *logger.Logger, config *config.Config, dirPath string) (*Resource, error) {
const op = "resource.New"
const op string = "resource.New"
r := &Resource{
logger: logger,
config: config,
@@ -83,7 +83,7 @@ func New(c echo.Context, logger *logger.Logger, config *config.Config, dirPath s
}
func formValues(c echo.Context, logger *logger.Logger) map[string]string {
const op = "resource.formValues"
const op string = "resource.formValues"
v := make(map[string]string)
fetch := func(formField string) string {
value := c.FormValue(formField)
@@ -110,7 +110,7 @@ func formValues(c echo.Context, logger *logger.Logger) map[string]string {
}
func formFiles(c echo.Context, logger *logger.Logger, dirPath string) error {
const op = "resource.formFiles"
const op string = "resource.formFiles"
form, err := c.MultipartForm()
if err != nil {
return &standarderror.Error{Op: op, Err: err}
@@ -153,7 +153,7 @@ func (r *Resource) DirPath() string {
// Close deletes the working directory of the
// resource if it exists.
func (r *Resource) Close() error {
const op = "resource.Close"
const op string = "resource.Close"
if _, err := os.Stat(r.formFilesDirPath); os.IsNotExist(err) {
r.logger.DebugfOp(op, "directory '%s' does not exist, nothing to remove", r.formFilesDirPath)
return nil
@@ -171,7 +171,7 @@ const defaultHeaderFooterHTML string = "<html><head></head><body></body></html>"
// thanks to the form values and form files from the request
// plus the default values from the configuration.
func (r *Resource) ChromePrinterOptions() (*printer.ChromeOptions, error) {
const op = "resource.ChromePrinterOptions"
const op string = "resource.ChromePrinterOptions"
waitTimeout, err := r.float64(WaitTimeoutFormField, r.config.DefaultWaitTimeout())
if err != nil {
return nil, &standarderror.Error{Op: op, Err: err}
@@ -237,7 +237,7 @@ func (r *Resource) ChromePrinterOptions() (*printer.ChromeOptions, error) {
// thanks to the form values from the request
// plus the default values from the configuration.
func (r *Resource) OfficePrinterOptions() (*printer.OfficeOptions, error) {
const op = "resource.OfficePrinterOptions"
const op string = "resource.OfficePrinterOptions"
waitTimeout, err := r.float64(WaitTimeoutFormField, r.config.DefaultWaitTimeout())
if err != nil {
return nil, &standarderror.Error{Op: op, Err: err}
@@ -258,7 +258,7 @@ func (r *Resource) OfficePrinterOptions() (*printer.OfficeOptions, error) {
// thanks to the form values from the request
// plus the default values from the configuration.
func (r *Resource) MergePrinterOptions() (*printer.MergeOptions, error) {
const op = "resource.MergePrinterOptions"
const op string = "resource.MergePrinterOptions"
waitTimeout, err := r.float64(WaitTimeoutFormField, r.config.DefaultWaitTimeout())
if err != nil {
return nil, &standarderror.Error{Op: op, Err: err}
@@ -289,7 +289,7 @@ func (r *Resource) hasFile(filename string) bool {
// Get returns the form field value.
func (r *Resource) Get(formField string) (string, error) {
const op = "resource.Get"
const op string = "resource.Get"
v, err := r.value(formField)
if err != nil {
return "", &standarderror.Error{Op: op, Err: err}
@@ -298,7 +298,7 @@ func (r *Resource) Get(formField string) (string, error) {
}
func (r *Resource) value(formField string) (string, error) {
const op = "resource.value"
const op string = "resource.value"
v, ok := r.formValues[formField]
if !ok {
return "", &standarderror.Error{
@@ -311,7 +311,7 @@ func (r *Resource) value(formField string) (string, error) {
}
func (r *Resource) float64(formField string, defaultValue float64) (float64, error) {
const op = "resource.float64"
const op string = "resource.float64"
if !r.Has(formField) {
return defaultValue, nil
}
@@ -331,7 +331,7 @@ func (r *Resource) float64(formField string, defaultValue float64) (float64, err
}
func (r *Resource) bool(formField string, defaultValue bool) (bool, error) {
const op = "resource.bool"
const op string = "resource.bool"
if !r.Has(formField) {
return defaultValue, nil
}
@@ -353,7 +353,7 @@ func (r *Resource) bool(formField string, defaultValue bool) (bool, error) {
// Fpath returns the path of the given filename.
// This filename should be the name of a form file.
func (r *Resource) Fpath(filename string) (string, error) {
const op = "resource.Fpath"
const op string = "resource.Fpath"
fpath := fmt.Sprintf("%s/%s", r.formFilesDirPath, filename)
_, err := os.Stat(fpath)
if os.IsNotExist(err) {
@@ -371,7 +371,7 @@ func (r *Resource) Fpath(filename string) (string, error) {
}
func (r *Resource) content(filename string, defaultValue string) (string, error) {
const op = "resource.content"
const op string = "resource.content"
if !r.hasFile(filename) {
return defaultValue, nil
}
@@ -389,7 +389,7 @@ func (r *Resource) content(filename string, defaultValue string) (string, error)
// Fpaths returns the list of files of the resource
// according to given file extensions.
func (r *Resource) Fpaths(exts ...string) ([]string, error) {
const op = "resource.Fpaths"
const op string = "resource.Fpaths"
var fpaths []string
err := filepath.Walk(r.formFilesDirPath, func(path string, info os.FileInfo, _ error) error {
if info.IsDir() {