mirror of https://github.com/kataras/iris.git synced 2025-01-23 10:41:03 +01:00

Makis Maropoulos dba92ba64d Add more notes on HISTORY.md about rc.4 changes

2016-07-01 02:13:21 +03:00

20 KiB

Raw Blame History

History

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

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

Move middleware & their configs to the iris-contrib/middleware repository
Move all plugins & their configs to the iris-contrib/plugin repository
Move the graceful package to the iris-contrib/graceful repository
Move the mail package & its configs to the iris-contrib/mail repository

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

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")

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

Implement feature request to add Globals on the pongo2
Implement feature request for static Favicon
Implement a unique easy only-websocket support:

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 registed 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

NoLayout support for particular templates
Raw Markdown Template Engine
Markdown to HTML > context.Markdown(statusCode int, markdown string) , context.MarkdownString(markdown string) (htmlReturn string)
Simplify the plugin registration

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: https://github.com/tdewolff/minify/issues/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.

20 KiB Raw Blame History