# Changelog

# v3.2.0

  • Added a way to customize the request's body field used by JWTController for the authentication process. (By default, "username" and "password" are used)
  • Added a new validation rule: unique.
  • Added helper.Only().
  • filesystem.File.Save() now creates directories if needed.

# v3.1.0

  • Added support for validating objects (map[string]interface{}).
  • Added request.Object() accessor.

# v3.0.x

# v3.0.1

  • Fixed a bug that prevented root-level routes with an empty path (/) to be matched.

# v3.0.0

  • Changed conventions:
    • validation.go and placeholders.go moved to a new http/validation package.
    • Validation rule sets are now located in a request.go file in the same package as the controller.

Motivation: Separating the requests in another package added unnecessary complexity to the directory structure and was not convenient to use. Package naming was far from ideal with the "request" suffix. Moving requests to the same package as the controller is more intuitive and requires less imports and makes route definition cleaner and easier.

  • Validation system overhaul, allowing rule sets to be parsed only once instead of every time a request is received, giving better overall performance. This new system also allows a more verbose syntax for validation, solving the comma rule parameter value and a much easier use in your handlers.
    • Rule functions don't check required parameters anymore. This is now done when the rules are parsed at startup time. The amount of required parameters is given when registering a new rule.
    • Optimized regex-based validation rules by compiling expressions once.
    • A significant amount of untested cases are now tested.
    • The following rules now pass if the validated data type is not supported: greater_than, greater_than_equal, lower_than, lower_than_equal, size.
    • Type-dependent rules now try to determine what is the expected type by looking up in the rule set for a type rule. If no type rule is present, falls back to the inputted type. This change makes it so the validation message is correct even if the client didn't input the expected type.
    • Fixed a bug triggering a panic if the client inputted a non-array value in an array-validated field.

Motivation: The validation system had a lot of room for improvement when it comes to performance, as RuleSet were parsed every time a request was received. Moving this process out of the request life-cycle to execute it only once saves a good amount of execution time. Moreover, any handler who would want to read the rules applied to the current request needed to parse them too, which was inconvenient and not effective. With a structure containing everything you need, making middleware interacting with the request's rules is much easier.

  • Routing has been improved by changing how validation and route-specific middleware are registered. The signature of the router functions have been simplified by removing the validation and middleware parameters from Route(), Get(), Post(), etc. This is now done through two new chainable methods on the Route: route.Validate() and route.Middleware().

Motivation: In the original design, the validation parameter was included in the main route definition function because most routes were expected to be validated, which turned out not to be the case. In a typical CRUD, only the create and update actions are validated, which made the route definition dirty and filled with nil parameters. Separating the rules and middleware definition is more in line with their optional nature and makes routes definition cleaner and more readable, although sometimes slightly longer.

  • Log Formatter now receive the length of the response (in bytes) instead of the full body.

Motivation: Keeping in memory the full response has an important impact on memory when sending files or large responses. Using the response content in a log formatter is also a marginal use-case which doesn't justify the performance loss described previously. It is still possible to retrieve the content of the response by writing your own chained writer.

  • Configuration system has been revamped.
    • Added support for tree-like configurations, allowing for better categorization. Nested values can be accessed using dot-separated path.
    • Improved validation: nested entries can now be validated too and all entries can have authorized values. Optional entries can now be validated too.
    • Improved support for slices. The validation system is also able to check slices.
    • Entries that are validated with the int type are now automatically converted from float64 if they don't have decimal places. It is no longer necessary to manually cast float64 that are supposed to be integers.
    • More openness: entries can be registered with a default value, their type and authorized values from any package. This allows config entries required by a specific package to be loaded only if the latter is imported.
    • Core configuration has been sorted in categories. This is a breaking change that will require you to update your configuration files.
    • Entries having a nil value are now considered unset.
    • Added accessors GetInt() and GetFloat().
    • Added slice accessors: GetStringSlice(), GetBoolSlice(), GetIntSlice(), GetFloatSlice()
    • Added LoadFrom(), letting you load a configuration file from a custom path.
    • Added the ability to use environment variables in configuration files.
    • Bug fix: config.IsLoaded() returned true even if config failed to load.
    • maxUploadSize config entry now supports decimal places.

Motivation: Configuration was without a doubt one of the weakest and inflexible feature of the framework. It was possible to use objects in custom entries, but not for core config, but it was inconvenient because it required a lot of type assertions. Moreover, core config entries were not handled the same as custom ones, which was a lack of openness. Hopefully, this revamped system will cover more potential use-cases, ease plugin development and allow you to produce cleaner code and configuration files.

  • Database improvements
    • Goyave has moved to GORM v2 (opens new window). Read the release note (opens new window) to learn more about what changed.
    • Protect the database instance with mutex.
    • database.Close() can now return errors.
    • Added database connection initializers.
    • Added the ability to regsiter new SQL dialects to use with GORM.
    • Use utf8mb4 by default in database options.
    • Added a short alias for database.GetConnection(): database.Conn().
    • Factories now use batch insert.
    • Factories now return interface{} instead of []interface{}. The actual type of the returned value is a slice of the the type of what is returned by your generator, so you can type-assert safely.
  • Status handlers improvements
    • Export panic and error status handlers so they can be expanded easily.
    • Added goyave.ValidationStatusHandler(), a status handler for validation errors. Therefore, the format in which validation errors are sent to the client can be customized by using your own status handler for the HTTP status 400 and 422.
  • goyave.Response improvements
    • response.Render and response.RenderHTML now execute and write the template to a bytes.Buffer instead of directly to the goyave.Response. This allows to catch and handle errors before the response header has been written, in order to return an error 500 if the template doesn't execute properly for example.
    • Added response.GetStacktrace(), response.IsEmpty() and response.IsHeaderWritten().
    • Re-organised the goyave.Response structure fields to save some memory.
    • Removed deprecated method goyave.CreateTestResponse(). Use goyave.TestSuite.CreateTestResponse() instead.
  • Recovery middleware now correctly handles panics with a nil value.
  • Test can now be run without the -p 1 flag thanks to a lock added to the goyave.RunTest method. Therefore, goyave.TestSuite still don't run in parallel but are safe to use with the typical test command.
  • Cache the regex used by helper.ParseMultiValuesHeader() to improve performance. This also improves the performance of the language middleware.
  • Bug fix: data under validation wasn't considered from JSON payload if the content type included the charset.
  • The Gzip middleware will now skip requests that have the Upgrade HTTP header set to any value.
  • response.String() and response.JSON() don't write header before calling Write anymore. This behavior prevented middleware and chained writers to alter the response headers.
  • Added goyave.PreWriter interface for chained writers needing to alter headers or status before they are written.
    • Even if this change is not breaking, it is recommended to update all your chained writers to call PreWrite() on their child writer if they implement the interface.
    • Thanks to this change, a bug with the gzip middleware has been fixed: header Content-Length wasn't removed, resulting in false information sent to the clients, which in turn failed to decompress the response.

# v2.10.x

# v2.10.2

  • Fixed a bug in body parsing middleware preventing json body to be parsed if a charset was provided.

# v2.10.1

  • Changed the behavior of response.File() and response.Download() to respond with a status 404 if the given file doesn't exist instead of panicking.
  • Improved error handling:
    • log.Panicf is not used anymore to print panics, removing possible duplicate logs.
    • Added error checks during automatic migrations.
    • goyave.Start() now exits the program with the following error codes:
      • 2: Panic (server already running, error when loading language files, etc)
      • 3: Configuration is invalid
      • 4: An error occurred when opening network listener
      • 5: An error occurred in the HTTP server

This change will require a slightly longer main function but offers better flexibility for error handling and multi-services.

if err := goyave.Start(route.Register); err != nil {
	os.Exit(err.(*goyave.Error).ExitCode)
}
  • Fixed a bug in TestSuite: HTTP client was re-created everytime getHTTPClient() was called.
  • Fixed testing documentation examples that didn't close http response body.
  • Documentation meta improvements.
  • Protect JSON requests with maxUploadSize.
  • The server will now automatically return 413 Payload Too Large if the request's size exceeds the maxUploadSize defined in configuration.
  • The request parsing middleware doesn't drain the body anymore, improving native handler compatibility.
  • Set a default status handler for all 400 errors.
  • Fixed a bug preventing query parameters to be parsed when the request had the Content-Type: application/json header.
  • Added a dark theme for the documentation. It can be toggled by clicking the moon icon next to the search bar.

# v2.10.0

  • Added router Get, Post, Put, Patch, Delete and Options methods to register routes directly without having to specify a method string.
  • Added placeholder support in regular language lines.

# v2.9.0

  • Added hidden fields.
  • Entirely removed Gorilla mux. This change is not breaking: native middleware still work the same.

# v2.8.0

  • Added a built-in logging system.
    • Added a middleware for access logs using the Common Log Format or Combined Log Format. This allows custom formatters too.
    • Added three standard loggers: goyave.Logger, goyave.AccessLogger and goyave.ErrLogger
  • Fixed bug: the gzip middleware now closes underlying writer on close.

# v2.7.x

# v2.7.1

  • Changed MIME type of js and mjs files to text/javascript. This is in accordance with an IETF draft (opens new window) that treats application/javascript as obsolete.
  • Improved error handling: stacktrace wasn't relevant on unexpected panic since it was retrieved from the route's request handler therefore not including the real source of the panic. Stacktrace retrieval has been moved to the recovery middleware to fix this.

# v2.7.0

  • Added Request.Request() accessor to get the raw *http.Request.
  • Fixed a bug allowing non-core middleware applied to the root router to be executed when the "Not Found" or "Method Not Allowed" routes were matched.
  • Fixed a bug making route groups (sub-routers with empty prefix) conflict with their parent router when two routes having the same path but different methods are registered in both routers.
  • Added chained writers.
  • Added gzip compression middleware.
  • Added the ability to register route-specific middleware in Router.Static().

# v2.6.0

  • Custom router implementation. Goyave is not using gorilla/mux anymore. The new router is twice as fast and uses about 3 times less memory.
  • Now redirects to configured protocol if request scheme doesn't match.
  • Added named routes.
  • Added Route.GetFullURI() and Route.BuildURL() for dynamic URL generation.
  • Added helper.IndexOfStr() and helper.ContainsStr() for better performance when using string slices.
  • Moved from GoDoc to pkg.go.dev (opens new window).
  • Print errors to stderr.

# v2.5.0

  • Added an authentication system.
  • Various optimizations.
  • Various documentation improvements.
  • Added dbMaxLifetime configuration entry.
  • Moved from Travis CI to Github Actions.
  • Fixed a bug making duplicate log entries on error.
  • Fixed a bug preventing language lines containing a dot to be retrieved.
  • Fixed TestSuite.GetJSONBody() not working with structs and slices.
  • Added TestSuite.ClearDatabaseTables().
  • Added Config.Has() and Config.Register() to check for the existence of a config entry and to allow custom config entries valdiation.
  • Added Request.BearerToken().
  • Added Response.HandleDatabaseError() for easier database error handling and shorter controller handlers.

# v2.4.x

# v2.4.3

  • Improved string validation by taking grapheme clusters into consideration when calculating length.
  • lang.LoadDefault now correctly creates a fresh language map and clones the default en-US language. This avoids the default language entries to be overridden permanently.

# v2.4.2

  • Don't override Content-Type header when sending a file if already set.
  • Fixed a bug with validation message placeholder :values, which was mistakenly using the :value placeholder.

# v2.4.1

  • Bundle default config and language in executable to avoid needing to deploy $GOROOT/pkg/mod/github.com/!system-!glitch/goyave/ with the application.

# v2.4.0

  • Added template rendring.
  • Fixed PostgreSQL options not working.
  • TestSuite.Middleware() now has a more realistic behavior: the finalization step of the request life-cycle is now also executed. This may require your tests to be updated if those check the status code in the response.
  • Added status handlers.

# v2.3.0

# v2.2.x

# v2.2.1

  • Added domain config entry. This entry is used for url generation, especially for the TLS redirect.
  • Don't show port in TLS redirect response if ports are standard (80 for HTTP, 443 for HTTPS).

# v2.2.0

# v2.1.0

  • filesystem.GetMIMEType now detects css, js, json and jsonld files based on their extension.
  • Added maintenance mode.
    • Can be toggled at runtime.
    • The server can be started in maintenance mode using the maintenance config option. (Defaults to false)
  • Added advanced array validation, with support for n-dimensional arrays.
  • Malformed request messages can now be localized. (malformed-request and malformed-json entries in locale.json)
  • Modified the validator to allow manual validation.

# v2.0.0

  • Documentation and README improvements.
  • In the configuration:
    • The default value of dbConnection has been changed to none.
    • The default value of dbAutoMigrate has been changed to false.
  • Added request data accessors.
  • Some refactoring and package renaming have been done to better respect the Go conventions.
    • The helpers package have been renamed to helper
  • The server now shuts down when it encounters an error during startup.
  • New validation.GetFieldType function.
  • Config and Lang are now protected with a sync.RWMutex to avoid data races in multi-threaded environments.
  • Greatly improve concurrency.
  • Config can now be reloaded manually.
  • Added the Trim middleware.
  • goyave.Response now implements http.ResponseWriter.
    • All writing functions can now return an error.
  • Added the NativeHandler compatibility layer.
  • Fixed a bug preventing the static resources handler to find index.html if a directory with a depth of one was requested without a trailing slash.
  • Now panics when calling Start() while the server is already running.