Merge branch 'master' of bitbucket.org:nginx-goodies/nginx-sticky-module-ng

Author: femaref

Changelog.txt

@@ -1,6 +1,11 @@
 
+1.2.5 - 2014-07-07 
+  - setting path-defaults to / 
+    fixing issue 
+    https://bitbucket.org/nginx-goodies/nginx-sticky-module-ng/issue/7/leaving-cookie-path-empty-in-module
+
 1.2.4 - 2014-04-18
-  - fixed an compiling-issue on some systems (SLES)
+  - fixed an compiling-issue on some systems (SLES, CentOS)
     https://bitbucket.org/nginx-goodies/nginx-sticky-module-ng/issue/5/nginx-compile-warning
 
 1.2.3 - 2014-03-10

README.md

@@ -58,7 +58,7 @@ Modify your compile of Nginx by adding the following directive
   default: nothing. Let the browser handle this.
 
 - path:    the path in which the cookie will be valid
-  default: nothing. Let the browser handle this.
+  default: /
 
 - expires: the validity duration of the cookie
   default: nothing. It's a session cookie.
@@ -88,19 +88,25 @@ Modify your compile of Nginx by adding the following directive
               Proxy Error) if a request comes with a cookie and the
               corresponding backend is unavailable.
 
-- secure    enable secure cookies; transfered only via https
-- httponly  enable cookies not to be leaked to via js
+- secure    enable secure cookies; transferred only via https
+- httponly  enable cookies not to be leaked via js
 
 
 # Detail Mechanism
 
 - see docs/sticky.{vsd,pdf}	
 
-# Warnings:
+# Issues and Warnings:
+
+- when using different upstream-configs with stickyness that use the same domain but 
+  refer to different location - configs it might be wise to set a different path / route -  
+  option on each of this upstream-configs like described here:
+  https://bitbucket.org/nginx-goodies/nginx-sticky-module-ng/issue/7/leaving-cookie-path-empty-in-module
 
 - sticky module does not work with the "backup" option of the "server" configuration item.
 - sticky module might work with the nginx_http_upstream_check_module (up from version 1.2.3)
 - sticky module may require to configure nginx with SSL support (when using "secure" option)
+  
 
 
 # Contributing
@@ -120,9 +126,10 @@ see Todo.md
 
 # Authors & Credits
 
-- Jerome Loyet, inital module
+- Jerome Loyet, initial module
 - Markus Linnala, httponly/secure-cookies-patch
 - Peter Bowey, Nginx 1.5.8 API-Change 
+- Michael Chernyak for Max-Age-Patch 
 - anybody who suggested a patch, created an issue on bitbucket or helped improving this module 
 
 
@@ -132,7 +139,6 @@ see Todo.md
     This module is licenced under the BSD license.
 
     Copyright (C) 2010 Jerome Loyet (jerome at loyet dot net)
-    Copyright (C) 2012 Markus Linnala (markus.linnala@gmail.com)
     Copyright (C) 2014 Markus Manzke (goodman at nginx-goodies dot com)
 
 

patches/upstream_check.patch

@@ -1,58 +1,46 @@
-Index: ngx_http_sticky_module.c
-===================================================================
---- ngx_http_sticky_module.c  (revision 45)
-+++ ngx_http_sticky_module.c  (working copy)
-@@ -10,6 +10,11 @@
- 
- #include "ngx_http_sticky_misc.h"
- 
-+#if (NGX_UPSTREAM_CHECK_MODULE)
-+#include "ngx_http_upstream_check_handler.h"
-+#endif
-+
-+
- /* define a peer */
- typedef struct {
-  ngx_http_upstream_rr_peer_t *rr_peer;
-@@ -287,6 +292,16 @@
-          return NGX_BUSY;
-        }
+diff --git a/ngx_http_sticky_module.c b/ngx_http_sticky_module.c
+index 9967428..f13d4b5 100644
+--- a/ngx_http_sticky_module.c
++++ b/ngx_http_sticky_module.c
+@@ -299,6 +299,16 @@ static ngx_int_t ngx_http_get_sticky_peer(ngx_peer_connection_t *pc, void *data)
+ 					return NGX_BUSY;
+ 				}
 
 +#if (NGX_UPSTREAM_CHECK_MODULE)
-+                ngx_log_debug1(NGX_LOG_DEBUG_HTTP, pc->log, 0,
-+                               "get sticky peer, check_index: %ui",
-+                               peer->check_index);
++		ngx_log_debug1(NGX_LOG_DEBUG_HTTP, pc->log, 0,
++				"get sticky peer, check_index: %ui",
++				peer->check_index);
 +
-+                if (ngx_http_check_peer_down(peer->check_index)) {
-+         return NGX_BUSY;
-+                }
++		if (ngx_http_check_peer_down(peer->check_index)) {
++			return NGX_BUSY;
++		}
 +#endif
 +
-        /* if it's been ignored for long enought (fail_timeout), reset timeout */
-        /* do this check before testing peer->fails ! :) */
-        if (now - peer->accessed > peer->fail_timeout) {
-@@ -303,6 +318,14 @@
-      /* ensure the peer is not marked as down */
-      if (!peer->down) {
+ 				/* if it's been ignored for long enought (fail_timeout), reset timeout */
+ 				/* do this check before testing peer->fails ! :) */
+ 				if (now - peer->accessed > peer->fail_timeout) {
+@@ -315,6 +325,14 @@ static ngx_int_t ngx_http_get_sticky_peer(ngx_peer_connection_t *pc, void *data)
+ 			/* ensure the peer is not marked as down */
+ 			if (!peer->down) {
 
 +#if (NGX_UPSTREAM_CHECK_MODULE)
-+                ngx_log_debug1(NGX_LOG_DEBUG_HTTP, pc->log, 0,
-+                               "get sticky peer, check_index: %ui",
-+                               peer->check_index);
++		ngx_log_debug1(NGX_LOG_DEBUG_HTTP, pc->log, 0,
++				"get sticky peer, check_index: %ui",
++				peer->check_index);
 +
-+                if (!ngx_http_check_peer_down(peer->check_index)) {
++		if (!ngx_http_check_peer_down(peer->check_index)) {
 +#endif
 +
-        /* if it's not failedi, use it */
-        if (peer->max_fails == 0 || peer->fails < peer->max_fails) {
-          selected_peer = (ngx_int_t)n;
-@@ -317,6 +340,9 @@
-          /* mark the peer as tried */
-          iphp->rrp.tried[n] |= m;
-        }
+ 				/* if it's not failedi, use it */
+ 				if (peer->max_fails == 0 || peer->fails < peer->max_fails) {
+ 					selected_peer = (ngx_int_t)n;
+@@ -329,6 +347,9 @@ static ngx_int_t ngx_http_get_sticky_peer(ngx_peer_connection_t *pc, void *data)
+ 					/* mark the peer as tried */
+ 					iphp->rrp.tried[n] |= m;
+ 				}
 +#if (NGX_UPSTREAM_CHECK_MODULE)
-+                }
++		}
 +#endif
-      }
-    }
-  }
+ 			}
+ 		}
+ 	}