Upgrading To v1.13 From v1.12

Enhancements 🚀

Upgrade The Default Version Of Golang To 1.20
Task Scheduling Supports Scale Horizontally
Add Debug Methods
make:controller Command Adds Parameter
Add Status Method For Response
Add Sum and Cursor Methods For Orm
The Route Module Supports Configure Driver
Add InputArray And InputMap Methods For Request
The Model Of Orm Supports Custom Connection
Add Cloudinary Driver For Filesystem
Add New Chain Methods For Log

v1.13.4

The Service Startup Supports Environment Variables

Breaking Changes 🛠

Remove The Global HTTP Middleware Loaded By Default
Optimize The Return of Controller
Change The Parameter Of The Group Method In facades.Route()
Optimize Remember And RememberForever Methods In facades.Cache()(If using)
Change The Package Name Of access.NewAllowResponse and access.NewDenyResponse(If using)
Remove Deprecated Methods(If using)

Upgrade Guide

Please upgrade the framework step by step according to the content in this section.

Estimated Upgrade Time: 10 Minutes

1. Updating Dependencies

Update dependencies in the go.mod file:

go get -u github.com/goravel/framework@v1.13.9 && go get -u github.com/goravel/gin

2. Add New Files

testsopen in new window

database/seeders/database_seeder.goopen in new window

app/providers/database_service_provider.goopen in new window

3. Register New Providers

Note the order:

import (
  "github.com/goravel/framework/testing"
  "github.com/goravel/gin"
)

// config/app.go
"providers": []foundation.ServiceProvider{
  ...
  &validation.ServiceProvider{},
  // New
  &testing.ServiceProvider{}, 
  &providers.AppServiceProvider{},
  ...
  &providers.ValidationServiceProvider{},
  // New
  &providers.DatabaseServiceProvider{}, 
  // New
  &gin.ServiceProvider{}, 
}

4. Add Configuration

Modify config/http.goopen in new window

import (
  "github.com/goravel/framework/contracts/route"
  "github.com/goravel/framework/facades"
  ginfacades "github.com/goravel/gin/facades"
)

config.Add("http", map[string]any{
  // HTTP Driver
  "default": "gin",
  // HTTP Drivers
  "drivers": map[string]any{
    "gin": map[string]any{
      "route": func() (route.Route, error) {
        return ginfacades.Route("gin"), nil
      },
    },
  },
  ...
}

Modify config/cors.goopen in new window

config.Add("cors", map[string]any{
  ...
  // New
  "paths":                []string{"*"}, 
  "allowed_methods":      []string{"*"},
  ...
}

5. Remove The Global HTTP Middleware Loaded By Default

The tls and cors middleware have been integrated into the default HTTP driver, therefore, middleware.Cors() and middleware.Tls() in the app/http/kernel.go file need to be removed.
The facades.Route().GlobalMiddleware(http.Kernel{}.Middleware()...) method in the app/providers/route_service_provider.go file moves to Boot from Register:

package providers

...

type RouteServiceProvider struct {
}

func (receiver *RouteServiceProvider) Register(app foundation.Application) {
}

func (receiver *RouteServiceProvider) Boot(app foundation.Application) {
  //Add HTTP middleware
  facades.Route().GlobalMiddleware(http.Kernel{}.Middleware()...)

  receiver.configureRateLimiting()

  routes.Web()
}

func (receiver *RouteServiceProvider) configureRateLimiting() {

}

6. Optimize The Return of Controller

Controller adds return value http.Response, ctx.Response() can be return directly, there is no need to use return separately to make the logic smoother.

// Before
func (r *UserController) Show(ctx http.Context) {
  ctx.Response().Success().Json(http.Json{
    "Hello": "Goravel",
  })
  return
}

// After
func (r *UserController) Show(ctx http.Context) http.Response {
  return ctx.Response().Success().Json(http.Json{
    "Hello": "Goravel",
  })
}

7. Change The Parameter Of The Group Method In facades.Route()

Change route.Route to route.Router：

// Before
facades.Route().Group(func(route route.Route)

// After
facades.Route().Group(func(route route.Router)

8. Optimize Remember And RememberForever Methods In facades.Cache()(If using)

The type of callback changes to func() (any, error) from func() any:

// Before
Remember(key string, ttl time.Duration, callback func() any) (any, error)
RememberForever(key string, callback func() any) (any, error)

// After
Remember(key string, ttl time.Duration, callback func() (any, error)) (any, error)
RememberForever(key string, callback func() (any, error)) (any, error)

9. Change The Package Name Of access.NewAllowResponse and access.NewDenyResponse(If using)

Change /contracts/auth/access to /auth/access:

// Before
import "github.com/goravel/framework/contracts/auth/access"

access.NewAllowResponse()
access.NewDenyResponse()

// After
import "github.com/goravel/framework/auth/access"

access.NewAllowResponse()
access.NewDenyResponse()

10. Remove Deprecated Methods(If using)

Remove ctx.Request().Form() and ctx.Request().Json() methods, use the ctx.Request().Input() method instead;
Remove GetLevel, GetTime, GetMessage methods of Log custom driver, use Level, Time, Message methods instead;
Remove the gorm.New method, the method is used to obtain the gorm instance directly, it is no longer recommended. if necessary, use the gorm.NewGormImpl method instead;

Function Introduction

Upgrade The Default Version Of Golang To 1.20

Version: v1.13.1

Golang 1.18 and 1.19 have been discontinued and the framework has been upgraded to 1.20 accordingly, for detailopen in new window. If you want to continue using 1.18 or 1.19, just modify the version number in go.mod, they are fully compatible at present.

Task Scheduling Supports Scale Horizontally

Version: v1.13.1

For Detail

Add debug Methods

Version: v1.13.1

For Detail

make:controller Command Adds Parameter

Version: v1.13.1

The make:controller command adds --resource parameter, the CURD struct can be created easily:

go run . artisan make:controller --resource UserController

Add Status method for Response

Version: v1.13.1

For Detail

Add Sum and Cursor methods for Orm

Version: v1.13.1

For Detail

The Route Module Supports Configure Driver

Version: v1.13.1

Separate the original default driver Gin of the Route module into a package, it can be injected into Goravel by configuration. after this optimization, providers a convenient channel for injecting other HTTP packages into Goravel, currently two HTTP packages are officially supported:

Driver	Link
Gin	https://github.com/goravel/ginopen in new window
Fiber	https://github.com/goravel/fiberopen in new window

Fix the problem that no error throws if the user didn't exist when using the facades.Auth().User(ctx, &user) method.
Fix the problem that user can be found when the primary key isn't int;

Issue #294open in new window

Issue #389open in new window