Skip to content

Latest commit

 

History

History
1974 lines (1324 loc) · 89.5 KB

HISTORY.md

File metadata and controls

1974 lines (1324 loc) · 89.5 KB
Raw

History

How to upgrade: remove your $GOPATH/src/github.com/kataras folder, open your command-line and execute this command: go get -u github.com/kataras/iris/iris.

6.1.1 -> 6.1.2

Better internalization and localization support, with ability to change the cookie's key and context's keys.

read the comments:

package main

import (
	"github.com/iris-contrib/middleware/i18n"
	"github.com/kataras/iris"
)

func main() {

	iris.Use(i18n.New(i18n.Config{
		Default:      "en-US",
		URLParameter: "lang",
		Languages: map[string]string{
			"en-US": "./locales/locale_en-US.ini",
			"el-GR": "./locales/locale_el-GR.ini",
			"zh-CN": "./locales/locale_zh-CN.ini"}}))

	iris.Get("/", func(ctx *iris.Context) {

		// it tries to find the language by:
		// ctx.Get("language") , that should be setted on other middleware before the i18n middleware*
		// if that was empty then
		// it tries to find from the URLParameter setted on the configuration
		// if not found then
		// it tries to find the language by the "lang" cookie
		// if didn't found then it it set to the Default setted on the configuration

		// hi is the key, 'kataras' is the %s on the .ini file
		// the second parameter is optional

		// hi := ctx.Translate("hi", "kataras")
		// or:
		hi := i18n.Translate(ctx, "hi", "kataras")

		language := ctx.Get(iris.TranslateLanguageContextKey) // language is the language key, example 'en-US'

		// The first succeed language found saved at the cookie with name ("language"),
		//  you can change that by changing the value of the:  iris.TranslateLanguageContextKey
		ctx.Writef("From the language %s translated output: %s", language, hi)
	})

	// go to http://localhost:8080/?lang=el-GR
	// or http://localhost:8080
	// or http://localhost:8080/?lang=zh-CN
	iris.Listen(":8080")

}

6.1.0 -> 6.1.1

What?

  • Give priority to an API path inside a Static route
package main

import (
	"github.com/kataras/iris"
)

func main() {

	usersAPI := iris.None("/api/users/:userid", func(ctx *iris.Context) {
		ctx.Writef("user with id: %s", ctx.Param("userid"))
	})("api.users.id")

	iris.StaticWeb("/", "./www", usersAPI)

	//
	// START THE SERVER
	//
	iris.Listen("localhost:8080")
}
  • Play with(very advanced usage, used by big companies): enable(online) or disable(offline) routes at runtime with one line of code.
package main

import (
	"github.com/kataras/iris"
)

func main() {

	// You can find the Route by iris.Lookup("theRouteName")
	// you can set a route name as: myRoute := iris.Get("/mypath", handler)("theRouteName")
	// that will set a name to the route and returns its iris.Route instance for further usage.
	api := iris.None("/api/users/:userid", func(ctx *iris.Context) {
		userid := ctx.Param("userid")
		ctx.Writef("user with id: %s", userid)
	})("users.api")

	// change the "users.api" state from offline to online and online to offline
	iris.Get("/change", func(ctx *iris.Context) {
		if api.IsOnline() {
			// set to offline
			iris.SetRouteOffline(api)
		} else {
			// set to online if it was not online(so it was offline)
			iris.SetRouteOnline(api, iris.MethodGet)
		}
	})

	iris.Get("/execute", func(ctx *iris.Context) {
		// change the path in order to be catcable from the ExecuteRoute
		// ctx.Request.URL.Path = "/api/users/42"
		// ctx.ExecRoute(iris.Route)
		// or:
		ctx.ExecRouteAgainst(api, "/api/users/42")
	})

	iris.Get("/", func(ctx *iris.Context) {
		ctx.Writef("Hello from index /")
	})

	//
	// START THE SERVER
	//
	// STEPS:
	// 1. navigate to http://localhost:8080/api/users/42
	// you should get 404 error
	// 2. now, navigate to http://localhost:8080/change
	// you should see a blank page
	// 3. now, navigate to http://localhost:8080/api/users/42
	// you should see the page working, NO 404 error
	// go back to the http://localhost:8080/change
	// you should get 404 error again
	// You just dynamically changed the state of a route with 3 lines of code!
	// you can do the same with group of routes and subdomains :)
	iris.Listen(":8080")
}
  • New built'n Middleware: iris.Prioritize(route) in order to give priority to a route inside other handler (used internally on StaticWeb's builder)
usersAPI := iris.None("/api/users/:userid", func(ctx *iris.Context) {
	ctx.Writef("user with id: %s", ctx.Param("userid"))
})("api.users.id") // we need to call empty ("") in order to get its iris.Route instance
// or ("the name of the route")
// which later on can be found with iris.Lookup("the name of the route")

static := iris.StaticHandler("/", "./www", false, false)
// manually give a priority to the usersAPI, if not found then continue to the static handler
iris.Get("/*file", iris.Prioritize(usersAPI), static)

iris.Get("/*file", static)

iris.Listen(":8080")

6.0.9 -> 6.1.0

6.0.8 -> 6.0.9

  • Add PostInterrupt plugin, useful for customization of the os.Interrupt singal, before that Iris closed the server automatically.
iris.Plugins.PostInterrupt(func(s *Framework){
  // when os.Interrupt signal is fired the body of this function will be fired,
  // you're responsible for closing the server with s.Close()

  // if that event is not registered then the framework
  // will close the server for you.



  /* Do  any custom cleanup and finally call the s.Close()
     remember you have the iris.Plugins.PreClose(func(s *Framework)) event too
     so you can split your logic in two logically places.
  */

})

6.0.7 -> 6.0.8

  • Add iris.UseTemplateFunc(functionName string, function interface{}). You could always set custom template funcs by using each of template engine's configuration but this function will help newcomers to start creating their custom template funcs.

Example:

6.0.6 -> 6.0.7

  • iris.Config.DisablePathEscape -> renamed to iris.Config.EnablePathEscape, which defaults to false. Path escape is turned off by-default now, if you're waiting for unescaped path parameters, then just enable it by putting: iris.Config.EnablePathEscape = true anywhere in your code OR use the context.ParamDecoded instead of the context.Param when you want to escape a single path parameter.

  • Example for iris.UsePreRender https://github.com/iris-contrib/examples/tree/master/template_engines/template_prerender

6.0.5 -> 6.0.6

http.Request access from WebsocketConnection.

Example:

Relative commits to kataras/go-websocket:

6.0.4 -> 6.0.5

  • Add iris.DestroySessionByID(string) and iris.DestroyAllSessions() functions as requested by a community member in the chat
// DestroySessionByID removes the session entry
// from the server-side memory (and database if registered).
// Client's session cookie will still exist but it will be reseted on the next request.
//
// It's safe to use it even if you are not sure if a session with that id exists.
DestroySessionByID(string)
// DestroyAllSessions removes all sessions
// from the server-side memory (and database if registered).
// Client's session cookie will still exist but it will be reseted on the next request.
DestroyAllSessions()

6.0.3 -> 6.0.4

  • Add a simple context.StreamWriter to fill the v5's StreamWriter, it's a io.Writer instead of bufio.Writer and returns false when stop otherwise true. Take a look at the silly book examples here.

6.0.2 -> 6.0.3

  • Give the users an easy to way to set a limit to the body size comes from the client, globally or per-route (useful when you want to disable/enable limit on certain clients).
// ...
const maxBodySize =  1 << 20
// ...

api := iris.New()

api.Use(iris.LimitRequestBodySize(maxBodySize))
// or do it manually under certain situations,
// inside the route's handler:
// ctx.SetMaxRequestBodySize(maxBodySize)

// routes after

6.0.1 -> 6.0.2

  • Fix subdomains (silly fix by checking the Request.Host vs Request.URL.Host) and add a more realistic test, as reported here.

6.0.0 -> 6.0.1

We had(for 2 days) one ResponseWriter which has special and unique features, but it slowed the execution a little bit, so I had to think more about it, I want to keep iris as the fastest http/2 web framework, well-designed and also to be usable and very easy for new programmers, performance vs design is tough decision. I choose performance most of the times but golang gives us the way to have a good design with that too.

I had to convert that ResponseWriter to a 'big but simple golang' interface and split the behavior into two parts, one will be the default and fast response writer, and the other will be the most useful response writer + transactions = iris.ResponseRecorder (no other framework or library have these features as far as I know). At the same time I had to provide an easy one-call way to wrap the basic response writer to a response recorder and set it to the context or to the whole app.

Of course I give the green light to other authors to copy these response writers as I already did with the whole source code and I'm happy to see my code exists into other famous web frameworks even when they don't notice my name anywhere :)

  • response_writer.go: is the response writer as you knew it with iris' bonus like the StatusCode() int which returns the http status code (useful for middleware which needs to know the previous status code), WriteHeader which doesn't let you write the status code more than once and so on.

  • response_recorder.go: is the response writer used by Transactions but you can use it by calling the context.Record/Redorder/IsRecording(). It lets you ResetBody , ResetHeaders and cookies, set the status code at any time (before or after its Write method) and more.

Transform the responseWriter to a ResponseRecorder is ridiculous easily, depending on yours preferences select one of these methods:

  • context call (lifetime only inside route's handlers/middleware): context.Record(); which will convert the context.ResponseWriter to a ResponseRecorder. All previous methods works as before but if you want to ResetBody/Reset/ResetHeaders/SetBody/SetBodyString you will have to use the w := context.Recorder() or just cast the context.ResponseWriter to a pointer of iris.ResponseRecorder.

  • middleware (global, per party, per route...): iris.UseGlobal(iris.Recorder)/app := iris.New(); app.UseGlobal(iris.Recorder) or iris.Get("/mypath", iris.Recorder, myPathHandler)

v5/fasthttp -> 6.0.0

As I promised to the community and a lot others, HTTP/2 support on Iris is happening!

I tried to minimize the side affects.

If you don't find something you used to use come here and check that conversional list:

  • iris.ToHandlerFunc -> iris.ToHandler.

  • context.Response.BodyWriter() io.Writer -> context.ResponseWriter is a http.ResponseWriter(and io.Writer) now.

  • context.Request/Response.Body() -> body,err := io.ReadAll(context.Request.Body) or for response's previous body(useful on middleware) ctx.Record() /* middleware here */ body:= ctx.Recorder().Body().

  • context.RequestCtx removed and replaced by context.ResponseWriter (*iris.ResponseWriter -> http.ResponseWriter) and context.Request (*http.Request).

  • context.Write(string, ...string) -> context.Writef(string, ...string) | Write now has this form: Write([]byte) (int,error). All other write methods didn't changed.

  • context.GetFlash/SetFlash -> context.Session().GetFlash/GetFlashString/SetFlash/DeleteFlash/ClearFlashes/Flashes/HasFlash.

  • context.FormValueString(string) -> context.FormValue(string).

  • context.PathString() -> context.Path().

  • context.HostString() -> context.Host().

  • iris.Config.DisablePathEscape -> iris.Config.EnablePathEscape, defaults to false. Now we have two methods to get a decoded parameter.

  • context.Param/ParamDecoded without need of this to be true, if it's true then the path parameters are query-decoded and .ParamDecoded returns the uri-decoded result.

  • context.RequestIP -> context.Request.RemoteAddr but I recommend use the previous context's function: context.RemoteAddr() which will search for the client's IP in detail.

  • All net/http middleware/handlers are COMPATIBLE WITH IRIS NOW, read more there](https://github.com/iris-contrib/middleware/blob/master/README.md#can-i-use-standard-nethttp-handler-with-iris).

Static methods changes

  • iris.StaticServe/StaticContent/StaticEmbedded/Favicon stay as they were before this version..

  • iris.StaticHandler(string, int, bool, bool, []string) HandlerFunc -> iris.StaticHandler(reqPath string, systemPath string, showList bool, enableGzip bool) HandlerFunc.

  • iris.StaticWeb(string, string, int) RouteNameFunc -> iris.StaticWeb(routePath string, systemPath string) RouteNameFunc.

  • iris.Static -> removed and joined to the new iris.StaticHandler

  • iris.StaticFS -> removed and joined into the new iris.StaticWeb.

More on Transictions vol 4:

  • Add support for custom transactions scopes, two scopes already implemented: iris.TransientTransactionScope(default) and iris.RequestTransactionScope

  • ctx.BeginTransaction(pipe func(*iris.TransactionScope)) -> ctx.BeginTransaction(pipe func(*iris.Transaction))

  • from -> to. Further research context_test.go:TestTransactions and https://www.codeproject.com/Articles/690136/All-About-TransactionScope (for .NET C#, I got the idea from there, it's a unique(golang web) feature so please read this before use transactions inside iris)

Examples, middleware & plugins were been refactored for this new (net/http2 compatible) release.

5.1.1 -> 5.1.3

  • More on Transactions vol 3: Recovery from any (unexpected error) panics inside context.BeginTransaction without loud, continue the execution as expected. Next version will have a little cleanup if I see that the transactions code is going very large or hard to understand the flow*

5.1.1 -> 5.1.2

  • More on Transactions vol 2: Added iris.UseTransaction and iris.DoneTransaction to register transactions as you register middleware(handlers). new named type iris.TransactionFunc, shortcut of func(scope *iris.TransactionScope), that gives you a function which you can convert a transaction to a normal handler/middleware using its .ToMiddleware(), for more see the test code inside context_test.go:TestTransactionsMiddleware.

5.1.0 -> 5.1.1

Two hours after the previous update,

  • More on Transactions: By-default transaction's lifetime is 'per-call/transient' meaning that each transaction has its own scope on the context, rollbacks when scope.Complete(notNilAndNotEmptyError) and the rest of transactions in chain are executed as expected, from now and on you have the ability to skip the rest of the next transactions on first failure by simply call scope.RequestScoped(true).

Note: RequestTransactionScope renamed to ,simply, TransactionScope.

5.0.4 -> 5.1.0

  • NEW (UNIQUE?) FEATURE: Request-scoped transactions inside handler's context. Proof-of-concept example here.

5.0.3 -> 5.0.4

The use of iris.BodyDecoder as a custom decoder that you can implement to a type in order to be used as the decoder/binder for the request body and override the json.Unmarshal(context.ReadJSON) or xml.Unmarshal(context.ReadXML) was very useful and gave you some kind of per-type-binder extensibility.

NEW context.UnmarshalBody: Per-service-binder. Side by side with the iris.BodyDecoder. We now have a second way to pass a custom Unmarshaler to override the json.Unmarshal and xml.Unmarshal.

If the object doesn't implements the iris.BodyDecoder but you still want to implement your own algorithm to parse []byte as an 'object' instead of the iris' defaults.

type Unmarshaler interface {
	Unmarshal(data []byte, v interface{}) error
}

context.ReadJSON & context.ReadXML have been also refactored to work with this interface and the new context.DeodeBody function, look:

// ReadJSON reads JSON from request's body
// and binds it to a value of any json-valid type
func (ctx *Context) ReadJSON(jsonObject interface{}) error {
	return ctx.UnmarshalBody(jsonObject, UnmarshalerFunc(json.Unmarshal))
}

// ReadXML reads XML from request's body
// and binds it to a value of any xml-valid type
func (ctx *Context) ReadXML(xmlObject interface{}) error {
	return ctx.UnmarshalBody(xmlObject, UnmarshalerFunc(xml.Unmarshal))
}

Both encoding/json and encoding/xml standard packages have valid Unmarshal function so they can be used as iris.Unmarshaller (with the help of iris.UnmarshallerFunc which just converts the signature to the iris.Unmarshaller interface). You only have to implement one function and it will work with any 'object' passed to the UnmarshalBody even if the object doesn't implements the iris.BodyDecoder.

5.0.2 -> 5.0.3

  • Fix https relative redirect paths, a very old issue, which I just saw, peaceful, again :)

5.0.1 -> 5.0.2

  • geekypanda/httpcache has been re-written, by me, got rid of the mutex locks and use individual statcks instead, gain even more performance boost

  • InvalidateCache has been removed, it wasn't working well for big apps, let cache work with its automation, is better.

  • Add tests for the iris.Cache

v3 -> v4 (fasthttp-based) long term support

  • NEW FEATURE: CacheService simple, cache service for your app's static body content(can work as external service if you are doing horizontal scaling, the Cache is just a Handler :) )

Cache any content, templates, static files, even the error handlers, anything.

Bombardier: 5 million requests and 100k clients per second to this markdown static content(look below) with cache(3 seconds) can be served up to ~x12 times faster. Imagine what happens with bigger content like full page and templates!

OUTLINE

// Cache is just a wrapper for a route's handler which you want to enable body caching
// Usage: iris.Get("/", iris.Cache(func(ctx *iris.Context){
//    ctx.WriteString("Hello, world!") // or a template or anything else
// }, time.Duration(10*time.Second))) // duration of expiration
// if <=time.Second then it tries to find it though request header's "cache-control" maxage value
//
// Note that it depends on a station instance's cache service.
// Do not try to call it from default' station if you use the form of app := iris.New(),
// use the app.Cache instead of iris.Cache
Cache(bodyHandler HandlerFunc, expiration time.Duration) HandlerFunc

// InvalidateCache clears the cache body for a specific context's url path(cache unique key)
//
// Note that it depends on a station instance's cache service.
// Do not try to call it from default' station if you use the form of app := iris.New(),
// use the app.InvalidateCache instead of iris.InvalidateCache
InvalidateCache(ctx *Context)

OVERVIEW

iris.Get("/hi", iris.Cache(func(c *iris.Context) {
	c.WriteString("Hi this is a big content, do not try cache on small content it will not make any significant difference!")
}, time.Duration(10)*time.Second))

EXAMPLE:

package main

import (
	"github.com/kataras/iris"
	"time"
)

var testMarkdownContents = `## Hello Markdown from Iris

This is an example of Markdown with Iris



Features
--------

All features of Sundown are supported, including:

*   **Compatibility**. The Markdown v1.0.3 test suite passes with
    the --tidy option.  Without --tidy, the differences are
    mostly in whitespace and entity escaping, where blackfriday is
    more consistent and cleaner.

*   **Common extensions**, including table support, fenced code
    blocks, autolinks, strikethroughs, non-strict emphasis, etc.

*   **Safety**. Blackfriday is paranoid when parsing, making it safe
    to feed untrusted user input without fear of bad things
    happening. The test suite stress tests this and there are no
    known inputs that make it crash.  If you find one, please let me
    know and send me the input that does it.

    NOTE: "safety" in this context means *runtime safety only*. In order to
    protect yourself against JavaScript injection in untrusted content, see
    [this example](https://github.com/russross/blackfriday#sanitize-untrusted-content).

*   **Fast processing**. It is fast enough to render on-demand in
    most web applications without having to cache the output.

*   **Thread safety**. You can run multiple parsers in different
    goroutines without ill effect. There is no dependence on global
    shared state.

*   **Minimal dependencies**. Blackfriday only depends on standard
    library packages in Go. The source code is pretty
    self-contained, so it is easy to add to any project, including
    Google App Engine projects.

*   **Standards compliant**. Output successfully validates using the
    W3C validation tool for HTML 4.01 and XHTML 1.0 Transitional.

	[this is a link](https://github.com/kataras/iris) `

func main() {
	// if this is not setted then iris set this duration to the lowest expiration entry from the cache + 5 seconds
	// recommentation is to left as it's or
	// iris.Config.CacheGCDuration = time.Duration(5) * time.Minute

	bodyHandler := func(ctx *iris.Context) {
		ctx.Markdown(iris.StatusOK, testMarkdownContents)
	}

	expiration := time.Duration(5 * time.Second)

	iris.Get("/", iris.Cache(bodyHandler, expiration))

	// if expiration is <=time.Second then the cache tries to set the expiration from the "cache-control" maxage header's value(in seconds)
	// // if this header doesn't founds then the default is 5 minutes
	iris.Get("/cache_control", iris.Cache(func(ctx *iris.Context) {
		ctx.HTML(iris.StatusOK, "<h1>Hello!</h1>")
	}, -1))

	iris.Listen(":8080")
}

The get command downloads, installs and runs a project based on a prototype, such as basic, static and mongo .

These projects are located online

iris get basic

Downloads the basic sample protoype project to the $GOPATH/src/github.com/iris-contrib/examples directory(the iris cmd will open this folder to you, automatically) builds, runs and watch for source code changes (hot-reload)

Iris get command preview

  • CHANGE: The Path parameters are now immutable. Now you don't have to copy a path parameter before passing to another function which maybe modifies it, this has a side-affect of context.GetString("key") = context.Param("key") so you have to be careful to not override a path parameter via other custom (per-context) user value.

  • NEW: iris.StaticEmbedded/app := iris.New(); app.StaticEmbedded - Embed static assets into your executable with go-bindata and serve them.

Note: This was already buitl'n feature for templates using iris.UseTemplate(html.New()).Directory("./templates",".html").Binary(Asset,AssetNames), after v4.6.1 you can do that for other static files too, with the StaticEmbedded function

outline

// StaticEmbedded  used when files are distributed inside the app executable, using go-bindata mostly
// First parameter is the request path, the path which the files in the vdir(second parameter) will be served to, for example "/static"
// Second parameter is the (virtual) directory path, for example "./assets"
// Third parameter is the Asset function
// Forth parameter is the AssetNames function
//
// For more take a look at the
// example: https://github.com/iris-contrib/examples/tree/master/static_files_embedded
StaticEmbedded(requestPath string, vdir string, assetFn func(name string) ([]byte, error), namesFn func() []string) RouteNameFunc

example

You can view and run it from here *

package main

// First of all, execute: $ go get https://github.com/jteeuwen/go-bindata
// Secondly, execute the command: cd $GOPATH/src/github.com/iris-contrib/examples/static_files_embedded && go-bindata ./assets/...

import (
	"github.com/kataras/iris"
)

func main() {

	// executing this go-bindata command creates a source file named 'bindata.go' which
	// gives you the Asset and AssetNames funcs which we will pass into .StaticAssets
	// for more viist: https://github.com/jteeuwen/go-bindata
	// Iris gives you a way to integrade these functions to your web app

	// For the reason that you may use go-bindata to embed more than your assets, you should pass the 'virtual directory path', for example here is the : "./assets"
	// and the request path, which these files will be served to, you can set as "/assets" or "/static" which resulting on http://localhost:8080/static/*anyfile.*extension
	iris.StaticEmbedded("/static", "./assets", Asset, AssetNames)


	// that's all
	// this will serve the ./assets (embedded) files to the /static request path for example the favicon.ico will be served as :
	// http://localhost:8080/static/favicon.ico
	// Methods: GET and HEAD



	iris.Get("/", func(ctx *iris.Context) {
		ctx.HTML(iris.StatusOK, "<b> Hi from index</b>")
	})

	iris.Listen(":8080")
}

// Navigate to:
// http://localhost:8080/static/favicon.ico
// http://localhost:8080/static/js/jquery-2.1.1.js
// http://localhost:8080/static/css/bootstrap.min.css

// Now, these files are stored inside into your executable program, no need to keep it in the same location with your assets folder.

  • FIX: httptest flags caused by httpexpect which used to help you with tests inside old func iris.Tester as reported here

  • NEW: iris.ResetDefault() func which resets the default iris instance which is the station for the most part of the public/package API

  • NEW: package httptest with configuration which can be passed per 'tester' instead of iris instance( this is very helpful for testers)

  • CHANGED: All tests are now converted for 'white-box' testing, means that tests now have package named: iris_test instead of iris in the same main directory.

  • CHANGED: iris.Tester moved to httptest.New which lives inside the new /kataras/iris/httptest package, so:

old

import (
	"github.com/kataras/iris"
	"testing"
)

func MyTest(t *testing.T) {
	iris.Get("/mypath", func(ctx *iris.Context){
		ctx.Write("my body")
	})
	// with configs: iris.Config.Tester.ExplicitURL/Debug = true
	e:= iris.Tester(t)
	e.GET("/mypath").Expect().Status(iris.StatusOK).Body().Equal("my body")
}

used that instead/new

import (
	"github.com/kataras/iris/httptest"
	"github.com/kataras/iris"
	"testing"
)

func MyTest(t *testing.T) {
	// make sure that you reset your default station if you don't use the form of app := iris.New()
	iris.ResetDefault()

	iris.Get("/mypath", func(ctx *iris.Context){
		ctx.Write("my body")
	})

	e:= httptest.New(iris.Default, t)
	// with configs: e:= httptest.New(iris.Default, t, httptest.ExplicitURL(true), httptest.Debug(true))
	e.GET("/mypath").Expect().Status(iris.StatusOK).Body().Equal("my body")
}

Finally, some plugins container's additions:

  • NEW: iris.Plugins.Len() func which returns the length of the current activated plugins in the default station

  • NEW: iris.Plugins.Fired("event") int func which returns how much times and from how many plugins a particular event type is fired, event types are: "prelookup", "prebuild", "prelisten", "postlisten", "preclose", "predownload"

  • NEW: iris.Plugins.PreLookupFired() bool func which returns true if PreLookup fired at least one time

  • NEW: iris.Plugins.PreBuildFired() bool func which returns true if PreBuild fired at least one time

  • NEW: iris.Plugins.PreListenFired() bool func which returns true if PreListen/PreListenParallel fired at least one time

  • NEW: iris.Plugins.PostListenFired() bool func which returns true if PostListen fired at least one time

  • NEW: iris.Plugins.PreCloseFired() bool func which returns true if PreClose fired at least one time

  • NEW: iris.Plugins.PreDownloadFired() bool func which returns true if PreDownload fired at least one time

  • Feature request: I never though that it will be easier for users to catch 405 instead of simple 404, I though that will make your life harder, but it's requested by the Community here, so I did my duty. Enable firing Status Method Not Allowed (405) with a simple configuration field: iris.Config.FireMethodNotAllowed=true or iris.Set(iris.OptionFireMethodNotAllowed(true)) or app := iris.New(iris.Configuration{FireMethodNotAllowed:true}). A trivial, test example can be shown here:

func TestMuxFireMethodNotAllowed(t *testing.T) {

	iris.Config.FireMethodNotAllowed = true // enable catching 405 errors

	h := func(ctx *iris.Context) {
		ctx.Write("%s", ctx.MethodString())
	}

	iris.OnError(iris.StatusMethodNotAllowed, func(ctx *iris.Context) {
		ctx.Write("Hello from my custom 405 page")
	})

	iris.Get("/mypath", h)
	iris.Put("/mypath", h)

	e := iris.Tester(t)

	e.GET("/mypath").Expect().Status(iris.StatusOK).Body().Equal("GET")
	e.PUT("/mypath").Expect().Status(iris.StatusOK).Body().Equal("PUT")
	// this should fail with 405 and catch by the custom http error

	e.POST("/mypath").Expect().Status(iris.StatusMethodNotAllowed).Body().Equal("Hello from my custom 405 page")
	iris.Close()
}

  • NEW: PreBuild plugin type, raises before .Build. Used by third-party plugins to register any runtime routes or make any changes to the iris main configuration, example of this usage is the OAuth/OAuth2 Plugin.

  • FIX: The OAuth example.

  • NEW: Websocket configuration fields:

    • Error func(ctx *Context, status int, reason string). Manually catch any handshake errors. Default calls the ctx.EmitError(status) with a stored error message in the WsError key(ctx.Set("WsError", reason)), as before.
    • CheckOrigin func(ctx *Context). Manually allow or dissalow client's websocket access, ex: via header Origin. Default allow all origins(CORS-like) as before.
    • Headers bool. Allow websocket handler to copy request's headers on the handshake. Default is true With these in-mind the WebsocketConfiguration seems like this now :
type WebsocketConfiguration struct {
	// WriteTimeout time allowed to write a message to the connection.
	// Default value is 15 * time.Second
	WriteTimeout time.Duration
	// PongTimeout allowed to read the next pong message from the connection
	// Default value is 60 * time.Second
	PongTimeout time.Duration
	// PingPeriod send ping messages to the connection with this period. Must be less than PongTimeout
	// Default value is (PongTimeout * 9) / 10
	PingPeriod time.Duration
	// MaxMessageSize max message size allowed from connection
	// Default value is 1024
	MaxMessageSize int64
	// BinaryMessages set it to true in order to denotes binary data messages instead of utf-8 text
	// see https://github.com/kataras/iris/issues/387#issuecomment-243006022 for more
	// defaults to false
	BinaryMessages bool
	// Endpoint is the path which the websocket server will listen for clients/connections
	// Default value is empty string, if you don't set it the Websocket server is disabled.
	Endpoint string
	// ReadBufferSize is the buffer size for the underline reader
	ReadBufferSize int
	// WriteBufferSize is the buffer size for the underline writer
	WriteBufferSize int
	// Headers  if true then the client's headers are copy to the websocket connection
	//
	// Default is true
	Headers bool
	// Error specifies the function for generating HTTP error responses.
	//
	// The default behavior is to store the reason in the context (ctx.Set(reason)) and fire any custom error (ctx.EmitError(status))
	Error func(ctx *Context, status int, reason string)
	// CheckOrigin returns true if the request Origin header is acceptable. If
	// CheckOrigin is nil, the host in the Origin header must not be set or
	// must match the host of the request.
	//
	// The default behavior is to allow all origins
	// you can change this behavior by setting the iris.Config.Websocket.CheckOrigin = iris.WebsocketCheckSameOrigin
	CheckOrigin func(ctx *Context) bool
}
  • REMOVE: github.com/kataras/iris/context/context.go , this is no needed anymore. Its only usage was inside sessions and websockets, a month ago I did improvements to the sessions as a standalone package, the IContext interface is not being used there. With the today's changes, the iris-contrib/websocket doesn't needs the IContext interface too, so the whole folder ./context is useless and removed now. Users developers don't have any side-affects from this change.

Examples, Book are up-to-date, just new configuration fields.

  • FIX: Previous CORS fix wasn't enough and produces error before server's startup* if many paths were trying to auto-register an .OPTIONS route, now this is fixed in combined with some improvements on the cors middleware too.

  • NEW: BodyDecoder gives the ability to set a custom decoder per passed object when context.ReadJSON and context.ReadXML

// BodyDecoder is an interface which any struct can implement in order to customize the decode action
// from ReadJSON and ReadXML
//
// Trivial example of this could be:
// type User struct { Username string }
//
// func (u *User) Decode(data []byte) error {
//	  return json.Unmarshal(data, u)
// }
//
// the 'context.ReadJSON/ReadXML(&User{})' will call the User's
// Decode option to decode the request body
//
// Note: This is totally optionally, the default decoders
// for ReadJSON is the encoding/json and for ReadXML is the encoding/xml
type BodyDecoder interface {
	Decode(data []byte) error
}

for a usage example go to https://github.com/kataras/iris/blob/master/context_test.go#L262

  • small fix: websocket server is nil when more than the default websocket station tries to be registered before OnConnection called*

  • FIX: CORS not worked for all http methods

  • FIX: Unexpected Party root's route slash when DisablePathCorrection is false(default), as reported here

  • small fix: DisablePathEscape not affects the uri string

  • small fix: when Path Correction on POST redirect to the GET instead of POST

  • NEW: Template PreRenders, as requested here.

// ...
iris.UsePreRender(func(ctx *iris.Context, filename string, binding interface{}, options ...map[string]interface{}) bool {
	// put the 'Error' binding here, for the shake of the test
	if b, isMap := binding.(map[string]interface{}); isMap {
		b["Error"] = "error!"
	}
	// true= continue to the next PreRender
  // false= do not continue to the next PreRender
  // * but the actual Render will be called at any case *
  return true
})

iris.Get("/", func(ctx *Context) {
  	ctx.Render("hi.html", map[string]interface{}{"Username": "anybody"})
    // hi.html: <h1>HI {{.Username}}. Error: {{.Error}}</h1>
})

// ...

NOTE: For normal users this update offers nothing, read that only if you run Iris behind a proxy or balancer like nginx or you need to serve using a custom net.Listener.

This update implements the support of using native servers and net.Listener instead of Iris' defined.

Breaking changes

  • iris.Config.Profile field removed and the whole pprof transfered to the iris-contrib/middleware/pprof.
  • iris.ListenTLSAuto renamed to iris.ListenLETSENCRYPT
  • iris.Default.Handler is iris.Router which is the Handler you can use to setup a custom router or bind Iris' router, after iris.Build call, to an external custom server.
  • iris.ServerConfiguration, iris.ListenVirtual, iris.AddServer, iris.Go & iris.TesterConfiguration.ListeningAddr removed, read below the reason and their alternatives

New features

  • Boost Performance on server's startup
  • NEW: iris.Reserve() re-starts the server if iris.Close() called previously.
  • NEW: iris.Config.VHost and iris.Config.VScheme replaces the previous ListenVirtual, iris.TesterConfiguration.ListeningAddr, iris.ServerConfiguration.VListeningAddr, iris.ServerConfiguration.VScheme.
  • NEW: iris.Build it's called automatically on Listen functions or Serve function. CALL IT, MANUALLY, ONLY WHEN YOU WANT TO BE ABLE TO GET THE IRIS ROUTER(iris.Router) AND PASS THAT, HANDLER, TO ANOTHER EXTERNAL FASTHTTP SERVER.
  • NEW: iris.Serve(net.Listener). Starts the server using a custom net.Listener, look below for example link
  • NEW: now that iris supports custom net.Listener bind, I had to provide to you some net.Listeners too, such as iris.TCP4, iris.UNIX, iris.TLS , iris.LETSENCRPYPT & iris.CERT , all of these are optionals because you can just use the iris.Listen, iris.ListenUNIX, iris.ListenTLS & iris.ListenLETSENCRYPT, but if you want, for example, to pass your own tls.Config then you will have to create a custom net.Listener and pass that to the iris.Serve(net.Listener).

With these in mind, developers are now able to fill their advanced needs without use the iris.AddServer, ServerConfiguration and V fields, so it's easier to:

  • use any external (fasthttp compatible) server or router. Examples: server and [router]((https://github.com/iris-contrib/tree/master/custom_fasthtthttp_router)
  • bind any net.Listener which will be used to run the Iris' HTTP server, as requested here. Example here
  • setup virtual host and scheme, useful when you run Iris behind nginx (etc) and want template function {{url }} and subdomains to work as you expected. Usage:
iris.Config.VHost = "mydomain.com"
iris.Config.VScheme = "https://"

iris.Listen(":8080")

// this will run on localhost:8080 but templates, subdomains and all that will act like https://mydomain.com,
// before this update you used the iris.AddServer and iris.Go and pass some strange fields into

Last, for testers:

Who used the iris.ListenVirtual(...).Handler: If closed server, then iris.Build() and iris.Router, otherwise just iris.Router.

To test subdomains or a custom domain just set the iris.Config.VHost and iris.Config.VScheme fields, instead of the old subdomain_test_handler := iris.AddServer(iris.ServerConfiguration{VListeningAddr:"...", Virtual: true, VScheme:false}).Handler. Usage here.

Finally, I have to notify you that examples, plugins, middleware and book have been updated.

  • Align with the latest version of go-websocket, remove vendoring for compression on go-fs which produced errors on sqllite and gorm(mysql and mongo worked fine before too) as reported here.

  • External FIX: template syntax error causes a "template doesn't exist"

  • ADDED: You are now able to use a raw fasthttp handler as the router instead of the default Iris' one. Example here. But remember that I'm always recommending to use the Iris' default which supports subdomains, group of routes(parties), auto path correction and many other built'n features. This exists for specific users who told me that they need a feature like that inside Iris, we have no performance cost at all so that's ok to exists.

  • CHANGE: Updater (See 4.2.4 and 4.2.3) runs in its own goroutine now, unless the iris.Config.CheckForUpdatesSync is true.

  • ADDED: To align with fasthttp server's configuration, iris has these new Server Configuration's fields, which allows you to set a type of rate limit:

// Maximum number of concurrent client connections allowed per IP.
//
// By default unlimited number of concurrent connections
// may be established to the server from a single IP address.
MaxConnsPerIP int

// Maximum number of requests served per connection.
//
// The server closes connection after the last request.
// 'Connection: close' header is added to the last response.
//
// By default unlimited number of requests may be served per connection.
MaxRequestsPerConn int

// Usage: iris.ListenTo{iris.OptionServerListeningAddr(":8080"), iris.OptionServerMaxConnsPerIP(300)}
//    or: iris.ListenTo(iris.ServerConfiguration{ListeningAddr: ":8080", MaxConnsPerIP: 300, MaxRequestsPerConn:100})
// for an optional second server with a different port you can always use:
//        iris.AddServer(iris.ServerConfiguration{ListeningAddr: ":9090", MaxConnsPerIP: 300, MaxRequestsPerConn:100})

  • ADDED: iris.CheckForUpdates(force bool) which can run the updater(look 4.2.4) at runtime too, updater is tested and worked at dev machine.

  • NEW Experimental feature: Updater with a CheckForUpdates configuration field, as requested here

// CheckForUpdates will try to search for newer version of Iris based on the https://github.com/kataras/iris/releases
// If a newer version found then the app will ask the he dev/user if want to update the 'x' version
// if 'y' is pressed then the updater will try to install the latest version
// the updater, will notify the dev/user that the update is finished and should restart the App manually.
// Notes:
// 1. Experimental feature
// 2. If setted to true, the app will have a little startup delay
// 3. If you as developer edited the $GOPATH/src/github/kataras or any other Iris' Go dependencies at the past
//    then the update process will fail.
//
// Usage: iris.Set(iris.OptionCheckForUpdates(true)) or
//        iris.Config.CheckForUpdates = true or
//        app := iris.New(iris.OptionCheckForUpdates(true))
// Default is false
CheckForUpdates bool

  • Add IsAjax() convenience method

  • Fix sessiondb issue 416

  • CHANGE: No front-end changes if you used the default response engines before. Response Engines to Serializers, iris.ResponseEngine serializer.Serializer, comes from kataras/go-serializer which is installed automatically when you upgrade iris with -u flag.

    • the repo "github.com/iris-contrib/response" is a clone of "github.com/kataras/go-serializer", to keep compatibility state. examples and gitbook updated to work with the last.

    • iris.UseResponse(iris.ResponseEngine, ...string)func (string) was used to register custom response engines, now you use: iris.UseSerializer(key string, s serializer.Serializer).

    • iris.ResponseString same defintion but differnet name now: iris.SerializeToString

Serializer examples and Book section updated.

  • ADDED: iris.TemplateSourceString(src string, binding interface{}) string this will parse the src raw contents to the template engine and return the string result & context.RenderTemplateSource(status int, src string, binding interface{}, options ...map[string]interface{}) error this will parse the src raw contents to the template engine and render the result to the client, as requseted here.

This version has 'breaking' changes if you were, directly, passing custom configuration to a custom iris instance before. As the TODO2 I had to think and implement a way to make configuration even easier and more simple to use.

With last changes in place, Iris is using new, cross-framework, and more stable packages made by me(so don't worry things are working and will as you expect) to render templates, manage sessions and websockets. So the /kataras/iris/config is no longer need to be there, we don't have core packages inside iris which need these configuration to other package-folder than the main anymore(in order to avoid the import-cycle), new file /kataras/iris/configuration.go is created for the configuration, which lives inside the main package, means that now:

  • if you want to pass directly configuration to a new custom iris instance, you don't have to import the github.com/kataras/iris/config package

Naming changes:

  • config.Iris -> iris.Configuration, which is the parent/main configuration. Added: TimeFormat and Other (pass any dynamic custom, other options there)
  • config.Sessions -> iris.SessionsConfiguration
  • config.Websocket -> iris.WebscoketConfiguration
  • config.Server -> iris.ServerConfiguration
  • config.Tester -> iris.TesterConfiguration

All these changes wasn't made only to remove the ./config folder but to make easier for you to pass the exact configuration field/option you need to edit at the top of the default configuration, without need to pass the whole Configuration object. Attention: old way, pass iris.Configuration directly, is still valid object to pass to the iris.New, so don't be afraid for breaking change, the only thing you will need to edit is the names of the configuration you saw on the previous paragraph.

Configuration Declaration:

instead of old, but still valid to pass to the iris.New:

  • iris.New(iris.Configuration{Charset: "UTF-8", Sessions: iris.SessionsConfiguration{Cookie: "cookienameid"}}) now you can just write this:
  • iris.New(iris.OptionCharset("UTF-8"), iris.OptionSessionsCookie("cookienameid"))

.New by configuration

import "github.com/kataras/iris"
//...
myConfig := iris.Configuration{Charset: "UTF-8", IsDevelopment:true, Sessions: iris.SessionsConfiguration{Cookie:"mycookie"}, Websocket: iris.WebsocketConfiguration{Endpoint: "/my_endpoint"}}
iris.New(myConfig)

.New by options

import "github.com/kataras/iris"
//...
iris.New(iris.OptionCharset("UTF-8"), iris.OptionIsDevelopment(true), iris.OptionSessionsCookie("mycookie"), iris.OptionWebsocketEndpoint("/my_endpoint"))

// if you want to set configuration after the .New use the .Set:
iris.Set(iris.OptionDisableBanner(true))

List of all available options:

// OptionDisablePathCorrection corrects and redirects the requested path to the registered path
// for example, if /home/ path is requested but no handler for this Route found,
// then the Router checks if /home handler exists, if yes,
// (permant)redirects the client to the correct path /home
//
// Default is false
OptionDisablePathCorrection(val bool)

// OptionDisablePathEscape when is false then its escapes the path, the named parameters (if any).
OptionDisablePathEscape(val bool)

// OptionDisableBanner outputs the iris banner at startup
//
// Default is false
OptionDisableBanner(val bool)

// OptionLoggerOut is the destination for output
//
// Default is os.Stdout
OptionLoggerOut(val io.Writer)

// OptionLoggerPreffix is the logger's prefix to write at beginning of each line
//
// Default is [IRIS]
OptionLoggerPreffix(val string)

// OptionProfilePath a the route path, set it to enable http pprof tool
// Default is empty, if you set it to a $path, these routes will handled:
OptionProfilePath(val string)

// OptionDisableTemplateEngines set to true to disable loading the default template engine (html/template) and disallow the use of iris.UseEngine
// Default is false
OptionDisableTemplateEngines(val bool)

// OptionIsDevelopment iris will act like a developer, for example
// If true then re-builds the templates on each request
// Default is false
OptionIsDevelopment(val bool)

// OptionTimeFormat time format for any kind of datetime parsing
OptionTimeFormat(val string)

// OptionCharset character encoding for various rendering
// used for templates and the rest of the responses
// Default is "UTF-8"
OptionCharset(val string)

// OptionGzip enables gzip compression on your Render actions, this includes any type of render, templates and pure/raw content
// If you don't want to enable it globally, you could just use the third parameter on context.Render("myfileOrResponse", structBinding{}, iris.RenderOptions{"gzip": true})
// Default is false
OptionGzip(val bool)

// OptionOther are the custom, dynamic options, can be empty
// this fill used only by you to set any app's options you want
// for each of an Iris instance
OptionOther(val ...options.Options) //map[string]interface{}, options is github.com/kataras/go-options

// OptionSessionsCookie string, the session's client cookie name, for example: "qsessionid"
OptionSessionsCookie(val string)

// OptionSessionsDecodeCookie set it to true to decode the cookie key with base64 URLEncoding
// Defaults to false
OptionSessionsDecodeCookie(val bool)

// OptionSessionsExpires the duration of which the cookie must expires (created_time.Add(Expires)).
// If you want to delete the cookie when the browser closes, set it to -1 but in this case, the server side's session duration is up to GcDuration
//
// Default infinitive/unlimited life duration(0)
OptionSessionsExpires(val time.Duration)

// OptionSessionsCookieLength the length of the sessionid's cookie's value, let it to 0 if you don't want to change it
// Defaults to 32
OptionSessionsCookieLength(val int)

// OptionSessionsGcDuration every how much duration(GcDuration) the memory should be clear for unused cookies (GcDuration)
// for example: time.Duration(2)*time.Hour. it will check every 2 hours if cookie hasn't be used for 2 hours,
// deletes it from backend memory until the user comes back, then the session continue to work as it was
//
// Default 2 hours
OptionSessionsGcDuration(val time.Duration)

// OptionSessionsDisableSubdomainPersistence set it to true in order dissallow your q subdomains to have access to the session cookie
// defaults to false
OptionSessionsDisableSubdomainPersistence(val bool)

// OptionWebsocketWriteTimeout time allowed to write a message to the connection.
// Default value is 15 * time.Second
OptionWebsocketWriteTimeout(val time.Duration)

// OptionWebsocketPongTimeout allowed to read the next pong message from the connection
// Default value is 60 * time.Second
OptionWebsocketPongTimeout(val time.Duration)

// OptionWebsocketPingPeriod send ping messages to the connection with this period. Must be less than PongTimeout
// Default value is (PongTimeout * 9) / 10
OptionWebsocketPingPeriod(val time.Duration)

// OptionWebsocketMaxMessageSize max message size allowed from connection
// Default value is 1024
OptionWebsocketMaxMessageSize(val int64)

// OptionWebsocketBinaryMessages set it to true in order to denotes binary data messages instead of utf-8 text
// see https://github.com/kataras/iris/issues/387#issuecomment-243006022 for more
// defaults to false
OptionWebsocketBinaryMessages(val bool)

// OptionWebsocketEndpoint is the path which the websocket server will listen for clients/connections
// Default value is empty string, if you don't set it the Websocket server is disabled.
OptionWebsocketEndpoint(val string)

// OptionWebsocketReadBufferSize is the buffer size for the underline reader
OptionWebsocketReadBufferSize(val int)

// OptionWebsocketWriteBufferSize is the buffer size for the underline writer
OptionWebsocketWriteBufferSize(val int)

// OptionTesterListeningAddr is the virtual server's listening addr (host)
// Default is "iris-go.com:1993"
OptionTesterListeningAddr(val string)

// OptionTesterExplicitURL If true then the url (should) be prepended manually, useful when want to test subdomains
// Default is false
OptionTesterExplicitURL(val bool)

// OptionTesterDebug if true then debug messages from the httpexpect will be shown when a test runs
// Default is false
OptionTesterDebug(val bool)

Now, some of you maybe use more than one server inside their iris instance/app, so you used the iris.AddServer(config.Server{}), which now becomes iris.AddServer(iris.ServerConfiguration{}), ServerConfiguration has also (optional) options to pass there and to iris.ListenTo(OptionServerListeningAddr("mydomain.com")):

// examples:
iris.AddServer(iris.OptionServerCertFile("file.cert"),iris.OptionServerKeyFile("file.key"))
iris.ListenTo(iris.OptionServerReadBufferSize(42000))

// or, old way but still valid:
iris.AddServer(iris.ServerConfiguration{ListeningAddr: "mydomain.com", CertFile: "file.cert", KeyFile: "file.key"})
iris.ListenTo(iris.ServerConfiguration{ReadBufferSize:42000, ListeningAddr: "mydomain.com"})

List of all Server's options:

OptionServerListeningAddr(val string)

OptionServerCertFile(val string)

OptionServerKeyFile(val string)

// AutoTLS enable to get certifications from the Letsencrypt
// when this configuration field is true, the CertFile & KeyFile are empty, no need to provide a key.
//
// example: https://github.com/iris-contrib/examples/blob/master/letsencyrpt/main.go
OptionServerAutoTLS(val bool)

// Mode this is for unix only
OptionServerMode(val os.FileMode)
// OptionServerMaxRequestBodySize Maximum request body size.
//
// The server rejects requests with bodies exceeding this limit.
//
// By default request body size is 8MB.
OptionServerMaxRequestBodySize(val int)

// Per-connection buffer size for requests' reading.
// This also limits the maximum header size.
//
// Increase this buffer if your clients send multi-KB RequestURIs
// and/or multi-KB headers (for example, BIG cookies).
//
// Default buffer size is used if not set.
OptionServerReadBufferSize(val int)

// Per-connection buffer size for responses' writing.
//
// Default buffer size is used if not set.
OptionServerWriteBufferSize(val int)

// Maximum duration for reading the full request (including body).
//
// This also limits the maximum duration for idle keep-alive
// connections.
//
// By default request read timeout is unlimited.
OptionServerReadTimeout(val time.Duration)

// Maximum duration for writing the full response (including body).
//
// By default response write timeout is unlimited.
OptionServerWriteTimeout(val time.Duration)

// RedirectTo, defaults to empty, set it in order to override the station's handler and redirect all requests to this address which is of form(HOST:PORT or :PORT)
//
// NOTE: the http status is 'StatusMovedPermanently', means one-time-redirect(the browser remembers the new addr and goes to the new address without need to request something from this server
// which means that if you want to change this address you have to clear your browser's cache in order this to be able to change to the new addr.
//
// example: https://github.com/iris-contrib/examples/tree/master/multiserver_listening2
OptionServerRedirectTo(val string)

// OptionServerVirtual If this server is not really listens to a real host, it mostly used in order to achieve testing without system modifications
OptionServerVirtual(val bool)

// OptionServerVListeningAddr, can be used for both virtual = true or false,
// if it's setted to not empty, then the server's Host() will return this addr instead of the ListeningAddr.
// server's Host() is used inside global template helper funcs
// set it when you are sure you know what it does.
//
// Default is empty ""
OptionServerVListeningAddr(val string)

// OptionServerVScheme if setted to not empty value then all template's helper funcs prepends that as the url scheme instead of the real scheme
// server's .Scheme returns VScheme if  not empty && differs from real scheme
//
// Default is empty ""
OptionServerVScheme(val string)

// OptionServerName the server's name, defaults to "iris".
// You're free to change it, but I will trust you to don't, this is the only setting whose somebody, like me, can see if iris web framework is used
OptionServerName(val string)

View all configuration fields and options by navigating to the kataras/iris/configuration.go source file

Book & Examples are updated (website docs will be updated soon).

  • CHANGED: Use of the standard log.Logger instead of the iris-contrib/logger(colorful logger), these changes are reflects some middleware, examples and plugins, I updated all of them, so don't worry.

So, iris-contrib/middleware/logger will now NO need to pass other Logger instead, instead of: iris.Use(logger.New(iris.Logger)) use -> iris.Use(logger.New()) which will use the iris/instance's Logger.

  • ADDED: context.Framework() which returns your Iris instance (typeof *iris.Framework), useful for the future(Iris will give you, soon, the ability to pass custom options inside an iris instance).

  • Align with go-sessions, no front-end changes, however I think that the best time to make an upgrade to your local Iris is right now.

  • Remove unused Plugin's custom callbacks, if you still need them in your project use this instead: https://github.com/kataras/go-events

Zero front-end changes. No real improvements, developers can ignore this update.

  • Replace the iris sessions with a new cross-framework package, go-sessions. Same front-end API, sessions examples are compatible, configuration of kataras/iris/config/sessions.go is compatible. kataras/context.SessionStore is now kataras/go-sessions.Session (normally you, as user, never used it before, because of automatically session getting by context.Session())

  • GzipWriter is taken, now, from the kataras/go-fs package which has improvements versus the previous implementation.

Zero front-end changes. No real improvements, developers can ignore this update.

  • Replace the template engines with a new cross-framework package, go-template. Same front-end API, examples and iris-contrib/template are compatible.

Zero front-end changes. No real improvements, developers can ignore this update.

  • Replace the main and underline websocket implementation with go-websocket. Note that we still need the ris-contrib/websocket package.

  • Replace the use of iris-contrib/errors with go-errors, which has more features

  • NEW FEATURE: Optionally OnError foreach Party (by prefix, use it with your own risk), example here

  • NEW: iris.Config.Sessions.CookieLength, You're able to customize the length of each sessionid's cookie's value. Default (and previous' implementation) is 32.

  • FIX: Websocket panic on non-websocket connection*

  • FIX: Multi websocket servers client-side source route panic*

  • Better gzip response managment

  • Feature request has been implemented: Add layout support for Pug/Jade, example here.

  • Feature request has been implemented: Forcefully closing a Websocket connection, WebsocketConnection.Disconnect() error.

  • FIX: WebsocketConnection.Leave() will hang websocket server if .Leave was called manually when the websocket connection has been closed.

  • FIX: StaticWeb not serving index.html correctly, align the func with the rest of Static funcs also, example added.

Notes: if you compare it with previous releases (13+ versions before v3 stable), the v4 stable release was fast, now we had only 6 versions before stable, that was happened because many of bugs have been already fixed and we hadn't new bug reports and secondly, and most important for me, some third-party features are implemented mostly by third-party packages via other developers!

The important , is that the book is finally updated!

If you're willing to donate click here!

  • iris.Config.Gzip, enables gzip compression on your Render actions, this includes any type of render, templates and pure/raw content. If you don't want to enable it globally, you could just use the third parameter on context.Render("myfileOrResponse", structBinding{}, iris.RenderOptions{"gzip": true}). It defaults to false

  • Added config.Server.Name as requested

Fix

**Sessions changes **

  • iris.Config.Sessions.Expires it was time.Time, changed to time.Duration, which defaults to 0, means unlimited session life duration, if you change it then the correct date is setted on client's cookie but also server destroys the session automatically when the duration passed, this is better approach, see here

New

A Response Engine gives you the freedom to create/change the render/response writer for

  • context.JSON
  • context.JSONP
  • context.XML
  • context.Text
  • context.Markdown
  • context.Data
  • context.Render("my_custom_type",mystructOrData{}, iris.RenderOptions{"gzip":false,"charset":"UTF-8"})
  • context.MarkdownString
  • iris.ResponseString(...)

Fix

Small changes

  • iris.Config.Charset, before alpha.3 was iris.Config.Rest.Charset & iris.Config.Render.Template.Charset, but you can override it at runtime by passinth a map iris.RenderOptions on the context.Render call .
  • iris.Config.IsDevelopment, before alpha.1 was iris.Config.Render.Template.IsDevelopment

Websockets changes

No need to import the github.com/kataras/iris/websocket to use the Connection iteral, the websocket moved inside kataras/iris , now all exported variables' names have the prefix of Websocket, so the old websocket.Connection is now iris.WebsocketConnection.

Generally, no other changes on the 'frontend API', for response engines examples and how you can register your own to add more features on existing response engines or replace them, look here.

BAD SIDE: E-Book is still pointing on the v3 release, but will be updated soon.

**Sessions were re-written **

  • Developers can use more than one 'session database', at the same time, to store the sessions
  • Easy to develop a custom session database (only two functions are required (Load & Update)), learn more
  • Session databases are located here, contributions are welcome
  • The only frontend deleted 'thing' is the: config.Sessions.Provider
  • No need to register a database, the sessions works out-of-the-box
  • No frontend/API changes except the context.Session().Set/Delete/Clear, they doesn't return errors anymore, btw they (errors) were always nil :)
  • Examples (master branch) were updated.
$ go get github.com/kataras/go-sessions/sessiondb/$DATABASE
db := $DATABASE.New(configurationHere{})
iris.UseSessionDB(db)

3.0.0 -> 4.0.0-alpha.1

logger, rest and all template engines moved to the iris-contrib.

  • config.Logger -> iris.Logger.Config

  • config.Render/config.Render.Rest/config.Render.Template -> Removed

  • config.Render.Rest -> rest.Config

  • config.Render.Template -> $TEMPLATE_ENGINE.Config except Directory,Extensions, Assets, AssetNames,

  • config.Render.Template.Directory -> iris.UseTemplate($TEMPLAET_ENGINE.New()).Directory("./templates", ".html")

  • config.Render.Template.Assets -> iris.UseTemplate($TEMPLAET_ENGINE.New()).Directory("./templates",".html").Binary(assetFn func(name string) ([]byte, error), namesFn func() []string)

  • context.ExecuteTemplate -> Removed, you can use the context.Response.BodyWriter() to get its writer and execute html/template engine manually, but this is useless because we support the best support for template engines among all other (golang) web frameworks

  • Added config.Server.ReadBufferSize & config.Server.WriteBufferSize which can be passed as configuration fields inside iris.ListenTo(config.Server{...}), which does the same job as iris.Listen

  • Added iris.UseTemplate($TEMPLAET_ENGINE.New()).Directory("./templates", ".html") to register a template engine, now iris supports multi template engines, each template engine has its own file extension, no big changes on context.Render except the last parameter:

  • context.Render(filename string, binding interface{}, layout string{}) -> context.Render(filename string, binding interface{}, options ...map[string]interface{}) | context.Render("myfile.html", myPage{}, iris.Map{"gzip":true,"layout":"layouts/MyLayout.html"}) |

E-book and examples are not yet updated, no big changes.

3.0.0-rc.4 -> 3.0.0-pre.release

  • context.PostFormValue -> context.FormValueString, old func stays until the next revision

  • context.PostFormMulti -> context.FormValues , old func stays until the next revision

  • Added context.VisitAllCookies(func(key,value string)) to visit all your cookies (because context.Request.Header.VisitAllCookie has a bug(I can't fix/pr it because the author is away atm))

  • Added context.GetFlashes to get all available flash messages for a particular request

  • Fix flash message removed after the first GetFlash call in the same request

NEW FEATURE: Built'n support for multi listening servers per iris station, secondary and virtual servers with one-line using the iris.AddServer & iris.Go to start all servers.

  • iris.SecondaryListen -> iris.AddServer, old func stays until the next revision
  • Added iris.Servers with this field you can manage your servers very easy
  • Added iris.AddServer/iris.ListenTo/iris.Go, but funcs like Listen/ListenTLS/ListenUNIX will stay forever
  • Added config.Server.Virtual(bool), config.Server.RedirectTo(string) and config.Server.MaxRequestBodySize(int64)
  • Added iris.Available (channel bool)
  • iris.HTTPServer -> iris.Servers.Main() to get the main server, which is always the last registered server (if more than one used), old field removed
  • iris.Config.MaxRequestBodySize -> config.Server.MaxRequestBodySize, old field removed

NEW FEATURE: Build'n support for your API's end-to-end tests

3.0.0-rc.3 -> 3.0.0-rc.4

NEW FEATURE: Handlebars template engine support with all Iris' view engine's functions/helpers support, as requested here:

  • iris.Config.Render.Template.Layout = "layouts/layout.html"
  • config.NoLayout
  • dynamic optional layout on context.Render
  • Party specific layout
  • iris.Config.Render.Template.Handlebars.Helpers["myhelper"] = func()...
  • {{ yield }}
  • {{ render }}
  • {{ url "myroute" myparams}}
  • {{ urlpath "myroute" myparams}}

For a complete example please, click here.

NEW: Iris can listen to more than one server per station now, as requested here. For example you can have https with SSL/TLS and one more server http which navigates to the secure location. Take a look here for an example of this.

FIXES

  • Fix sessions destroy
  • Fix sessions persistence on subdomains (as RFC2109 commands but you can disable it with iris.Config.Sessions.DisableSubdomainPersistence = true)

IMPROVEMENTS

  • Improvements on iris run && iris create, note that the underline code for hot-reloading moved to rizla.

3.0.0-rc.2 -> 3.0.0-rc.3

Breaking changes

Note 1: iris.Config.Mail doesn't not logger exists, use mail.Config from the iris-contrib/mail, and service:= mail.New(configs); service.Send(....).

Note 2: basicauth middleware's context key changed from context.GetString("auth") to context.GetString("user").

Underline changes, libraries used by iris' base code:

  • Move the errors package to the iris-contrib/errors repository
  • Move the tests package to the iris-contrib/tests repository (Yes, you should make PRs now with no fear about breaking the Iris).

NEW:

  • OAuth, OAuth2 support via plugin (facebook,gplus,twitter and 25 more), gitbook section here, plugin example, low-level package example here (no performance differences, it's just a working version of goth which is converted to work with Iris)

  • JSON Web Tokens support via this middleware, book section here, as requested here.

Fixes:

Improvements to the iris run command, as requested here.

Book and examples are updated also.

3.0.0-rc.1 -> 3.0.0-rc.2

New:

  • iris.MustUse/MustUseFunc - registers middleware for all route parties, all subdomains and all routes.
  • iris control plugin re-written, added real time browser request logger
  • websocket.OnError - Add OnError to be able to catch internal errors from the connection
  • command line tool - iris run main.go runs, watch and reload on source code changes. As requested here

Fixes: https://github.com/kataras/iris/issues/184 , https://github.com/kataras/iris/issues/175 .

3.0.0-beta.3, 3.0.0-beta.4 -> 3.0.0-rc.1

This version took me many days because the whole framework's underline code is rewritten after many many many 'yoga'. Iris is not so small anymore, so I (tried) to organized it a little better. Note that, today, you can just go to iris.go and context.go and look what functions you can use. You had some 'bugs' to subdomains, mail service, basic authentication and logger, these are fixed also, see below...

All examples are updated, and I tested them one by one.

Many underline changes but the public API didn't changed much, of course this is relative to the way you use this framework, because that:

  • Configuration changes: 0

  • iris.Iris pointer -> iris.Framework pointer

  • iris.DefaultIris -> iris.Default

  • iris.Config() -> iris.Config is field now

  • iris.Websocket() -> iris.Websocket is field now

  • iris.Logger() -> iris.Logger is field now

  • iris.Plugins() -> iris.Plugins is field now

  • iris.Server() -> iris.HTTPServer is field now

  • iris.Rest() -> REMOVED

  • iris.Mail() -> REMOVED

  • iris.Mail().Send() -> iris.SendMail()

  • iris.Templates() -> REMOVED

  • iris.Templates().RenderString() -> iris.TemplateString()

  • iris.StaticHandlerFunc -> iris.StaticHandler

  • iris.URIOf() -> iris.URL()

  • iris.PathOf() -> iris.Path()

  • context.RenderString() returned string,error -> context.TemplateString() returns only string, which is empty on any parse error

  • context.WriteHTML() -> context.HTML()

  • context.HTML() -> context.RenderWithStatus()

Entirely new

  • -> iris.ListenUNIX(addr string, socket os.Mode)

  • -> context.MustRender, same as Render but send response 500 and logs the error on parse error

  • -> context.Log(format string, a...interface{})

  • -> context.PostFormMulti(name string) []string

  • -> iris.Lookups() []Route

  • -> iris.Lookup(routeName string) Route

  • -> iris.Plugins.On(eventName string, ...func()) and fire all by iris.Plugins.Call(eventName)

  • iris.Wildcard() REMOVED, subdomains and dynamic(wildcard) subdomains can only be registered with iris.Party("mysubdomain.") && iris.Party("*.")

Semantic change for static subdomains

1

BEFORE :

apiSubdomain := iris.Party("api.mydomain.com")
{
//....
}
iris.Listen("mydomain.com:80")

NOW just subdomain part, no need to duplicate ourselves:

apiSubdomain := iris.Party("api.")
{
//....
}
iris.Listen("mydomain.com:80")

2

Before you couldn't set dynamic subdomains and normal subdomains at the same iris station, now you can. NOW, this is possible

/* admin.mydomain.com,  and for other subdomains the Party(*.) */

admin := iris.Party("admin.")
{
	// admin.mydomain.com
	admin.Get("/", func(c *iris.Context) {
		c.Write("INDEX FROM admin.mydomain.com")
	})
	// admin.mydomain.com/hey
	admin.Get("/hey", func(c *iris.Context) {
		c.Write("HEY FROM admin.mydomain.com/hey")
	})
	// admin.mydomain.com/hey2
	admin.Get("/hey2", func(c *iris.Context) {
		c.Write("HEY SECOND FROM admin.mydomain.com/hey")
	})
}

// other.mydomain.com, otadsadsadsa.mydomain.com  and so on....
dynamicSubdomains := iris.Party("*.")
{
	dynamicSubdomains.Get("/", dynamicSubdomainHandler)

	dynamicSubdomains.Get("/something", dynamicSubdomainHandler)

	dynamicSubdomains.Get("/something/:param1", dynamicSubdomainHandlerWithParam)
}

Minor change for listen

BEFORE you could just listen to a port

iris.Listen("8080")

NOW you have set a HOSTNAME:PORT

iris.Listen(":8080")

Relative issues/features: https://github.com/kataras/iris/issues/166 , https://github.com/kataras/iris/issues/176, https://github.com/kataras/iris/issues/183, https://github.com/kataras/iris/issues/184

Plugins

PreHandle and PostHandle are removed, no need to use them anymore you can take routes by iris.Lookups(), but add support for custom event listeners by iris.Plugins.On("event",func(){}) and fire all callbacks by iris.Plugins.Call("event") .

FOR TESTERS

BEFORE :

api := iris.New()
//...

api.PreListen(config.Server{ListeningAddr: ""})

e := httpexpect.WithConfig(httpexpect.Config{
	Reporter: httpexpect.NewAssertReporter(t),
	Client:   fasthttpexpect.NewBinder(api.ServeRequest),
})

NOW:

api := iris.New()
//...

e := httpexpect.WithConfig(httpexpect.Config{
	Reporter: httpexpect.NewAssertReporter(t),
	Client:   fasthttpexpect.NewBinder(api.NoListen().Handler),
})

3.0.0-beta.2 -> 3.0.0-beta.3

  • Complete the Jade Template Engine support, {{ render }} and {{ url }} done also.

  • Fix Mail().Send

  • Iriscontrol plugin: Replace login using session to basic authentication

And other not-too-important fixes

3.0.0-beta -> 3.0.0-beta.2

  • NEW: Wildcard(dynamic) subdomains, read here

  • NEW: Implement feature request #165. Routes can now be selected by a custom name, and this allows us to use the {{ url "custom-name" "any" "named" "parameters"}}``: For HTML & Amber engines, example here. For PongoEngine, example here

  • Remove the x/net/context, it has been useless after v2.

3.0.0-alpha.beta -> 3.0.0-beta

  • New iris.API for easy API declaration, read more here, example there.

  • Add example and fix the Basic Authentication middleware

3.0.0-alpha.6 -> 3.0.0-alpha.beta

OnConnection(func(c websocket.Connection){})

websocket.Connection

// Receive from the client
On("anyCustomEvent", func(message string) {})
On("anyCustomEvent", func(message int){})
On("anyCustomEvent", func(message bool){})
On("anyCustomEvent", func(message anyCustomType){})
On("anyCustomEvent", func(){})

// Receive a native websocket message from the client
// compatible without need of import the iris-ws.js to the .html
OnMessage(func(message []byte){})

// Send to the client
Emit("anyCustomEvent", string)
Emit("anyCustomEvent", int)
Emit("anyCustomEvent", bool)
Emit("anyCustomEvent", anyCustomType)

// Send via native websocket way, compatible without need of import the iris-ws.js to the .html
EmitMessage([]byte("anyMessage"))

// Send to specific client(s)
To("otherConnectionId").Emit/EmitMessage...
To("anyCustomRoom").Emit/EmitMessage...

// Send to all opened connections/clients
To(websocket.All).Emit/EmitMessage...

// Send to all opened connections/clients EXCEPT this client(c)
To(websocket.NotMe).Emit/EmitMessage...

// Rooms, group of connections/clients
Join("anyCustomRoom")
Leave("anyCustomRoom")


// Fired when the connection is closed
OnDisconnect(func(){})

We have some base-config's changed, these configs which are defaulted to true renamed to 'Disable+$oldName'

		// DisablePathCorrection corrects and redirects the requested path to the registered path
		// for example, if /home/ path is requested but no handler for this Route found,
		// then the Router checks if /home handler exists, if yes,
		// (permant)redirects the client to the correct path /home
		//
		// Default is false
		DisablePathCorrection bool

		// DisablePathEscape when is false then its escapes the path, the named parameters (if any).
		// Change to true it if you want something like this https://github.com/kataras/iris/issues/135 to work
		//
		// When do you need to Disable(true) it:
		// accepts parameters with slash '/'
		// Request: http://localhost:8080/details/Project%2FDelta
		// ctx.Param("project") returns the raw named parameter: Project%2FDelta
		// which you can escape it manually with net/url:
		// projectName, _ := url.QueryUnescape(c.Param("project").
		// Look here: https://github.com/kataras/iris/issues/135 for more
		//
		// Default is false
		DisablePathEscape bool

		// DisableLog turn it to true if you want to disable logger,
		// Iris prints/logs ONLY errors, so be careful when you enable it
		DisableLog bool

		// DisableBanner outputs the iris banner at startup
		//
		// Default is false
		DisableBanner bool

3.0.0-alpha.5 -> 3.0.0-alpha.6

Changes: - config/iris.Config().Render.Template.HTMLTemplate.Funcs typeof []template.FuncMap -> template.FuncMap

Added: - iris.AmberEngine Amber. View an example - iris.JadeEngine Jade. View an example

Book section Render/Templates updated

3.0.0-alpha.4 -> 3.0.0-alpha.5

3.0.0-alpha.3 -> 3.0.0-alpha.4

Community suggestions implemented:

  • Request: Rendering html template to string

    New RenderString(name string, binding interface{}, layout ...string) added to the Context & the Iris' station (iris.Templates().RenderString)

  • Minify Templates

    New config field for minify, defaulted to true: iris.Config().Render.Template.Minify = true 3.0.0-alpha5+ this has been removed because the minify package has bugs, one of them is this: tdewolff/minify#35.

Bugfixes and enhancements:

3.0.0-alpha.2 -> 3.0.0-alpha.3

The only change here is a panic-fix on form bindings. Now no need to make([]string,0) before form binding, new example:

 //./main.go

package main

import (
	"fmt"

	"github.com/kataras/iris"
)

type Visitor struct {
	Username string
	Mail     string
	Data     []string `form:"mydata"`
}

func main() {

	iris.Get("/", func(ctx *iris.Context) {
		ctx.Render("form.html", nil)
	})

	iris.Post("/form_action", func(ctx *iris.Context) {
		visitor := Visitor{}
		err := ctx.ReadForm(&visitor)
		if err != nil {
			fmt.Println("Error when reading form: " + err.Error())
		}
		fmt.Printf("\n Visitor: %v", visitor)
	})

	fmt.Println("Server is running at :8080")
	iris.Listen(":8080")
}
<!-- ./templates/form.html -->
<!DOCTYPE html>
<head>
<meta charset="utf-8">
</head>
<body>
<form action="/form_action" method="post">
<input type="text" name="Username" />
<br/>
<input type="text" name="Mail" /><br/>
<select multiple="multiple" name="mydata">
<option value='one'>One</option>
<option value='two'>Two</option>
<option value='three'>Three</option>
<option value='four'>Four</option>
</select>
<hr/>
<input type="submit" value="Send data" />

</form>
</body>
</html>

3.0.0-alpha.1 -> 3.0.0-alpha.2

The e-book was updated, take a closer look here

Breaking changes

First. Configuration owns a package now github.com/kataras/iris/config . I took this decision after a lot of thought and I ensure you that this is the best architecture to easy:

  • change the configs without need to re-write all of their fields.

     irisConfig := config.Iris { Profile: true, PathCorrection: false }
 api := iris.New(irisConfig)

  • easy to remember: iris type takes config.Iris, sessions takes config.Sessions, iris.Config().Renderisconfig.Render, iris.Config().Render.Templateisconfig.Template, Loggertakesconfig.Logger` and so on...

  • easy to find what features are exists and what you can change: just navigate to the config folder and open the type you want to learn about, for example /iris.go Iris' type configuration is on /config/iris.go

  • default setted fields which you can use. They are already setted by iris, so don't worry too much, but if you ever need them you can find their default configs by this pattern: for example config.Template has config.DefaultTemplate(), config.Rest has config.DefaultRest(), config.Typescript() has config.DefaultTypescript(), note that only config.Iris has config.Default(). I wrote that all structs even the plugins have their default configs now, to make it easier for you, so you can do this without set a config by yourself: iris.Config().Render.Template.Engine = config.PongoEngine or iris.Config().Render.Template.Pongo.Extensions = []string{".xhtml", ".html"}.

Second. Template & rest package moved to the render, so

	*  a new config field named `render` of type `config.Render` which nests the `config.Template` & `config.Rest`
	-  `iris.Config().Templates` -> `iris.Config().Render.Template` of type `config.Template`
	- `iris.Config().Rest` -> `iris.Config().Render.Rest` of type `config.Rest`

Third, sessions.

Configuration instead of parameters. Before sessions.New("memory","sessionid",time.Duration(42) * time.Minute) -> Now: sessions.New(config.DefaultSessions()) of type config.Sessions

  • Before this change the cookie's life was the same as the manager's Gc duration. Now added an Expires option for the cookie's life time which defaults to infinitive, as you (correctly) suggests me in the chat community.-

  • Default Cookie's expiration date: from 42 minutes -> to infinitive/forever

  • Manager's Gc duration: from 42 minutes -> to '2 hours'

  • Redis store's MaxAgeSeconds: from 42 minutes -> to '1 year`

Four. Typescript, Editor & IrisControl plugins now accept a config.Typescript/ config.Editor/ config.IrisControl as parameter

Bugfixes

2.3.2 -> 3.0.0-alpha.1

Changed

  • &render.Config -> &iris.RestConfig . All related to the html/template are removed from there.

  • ctx.Render("index",...) -> ctx.Render("index.html",...) or any extension you have defined in iris.Config().Templates.Extensions

  • iris.Config().Render.Layout = "layouts/layout" -> iris.Config().Templates.Layout = "layouts/layout.html"

  • License BSD-3 Clause Open source -> MIT License Added

  • Switch template engines via IrisConfig. Currently, HTMLTemplate is 'html/template'. Pongo is 'flosch/pongo2`. Refer to the Book, which is updated too, read here.