Fix behavior keepalive by maxvalentini77 · Pull Request #4904 · joomla/joomla-cms

maxvalentini77 · 2014-10-23T15:33:32Z

I found three issues:

1: In some cases, call an invalid URL, resulting in a response with code 404. (still refresh the session)
2: Update the article hits counter.
3: Work in different ways with "Search Engine Friendly URLs" enabled or disabled.

How to reproduce number 1

Enable "Search Engine Friendly URLs"
Set "Session Lifetime" to 1 (not required but useful to test faster!)
Create a menu of type "Menu Heading" and call it "heading"
Create a menu that point to an article and add it as child of "heading"
Create a Login module and put it some where in the page (add the "behavior.keepalive")
Use the article menu (you will be redirected to a page with an URL like "www.host.net/index.php/heading/article")
Wait some "Session Lifetime" minutes and an ajax call to the URL "www.host.net/index.php/heading/" will be executed but ends with a 404 error

The session is refreshed but it isn't nice to generate a 404 error that, for example, ends up in the apache logs.

How to reproduce number 2

Set "Session Lifetime" to 1 (not required but useful to test faster!)
Create a menu that point to an article and set it as default
Create a Login module and put it some where in the page (add the "behavior.keepalive")
Go to the homepage of the site, the article will be displayed with a counter hits = C
Wait some "Session Lifetime" minutes and an ajax call to the homepage will be executed (increasing the hits counter)
Refresh the page

The counter was increased by 1+X where X is the number of ajax calls.

How to reproduce number 3

Disable "Search Engine Friendly URLs"
Set "Session Lifetime" to 1 (not required but useful to test faster!)
Create a menu of type "Menu Heading" and call it "heading"
Create a menu that point to an article and add it as child of "heading"
Create a Login module and put it some where in the page (add the "behavior.keepalive")
Use the article menu (you will be redirected to a page with an URL like "www.host.net/index.php?option=com_content&view=article&id=12&Itemid=160")
Wait some "Session Lifetime" minutes and an ajax call to the URL "www.host.net/" will be executed.

This is the same procedure to reproduce number 1 but ends with a different behavior that, if the homepage display an article, generate the same issue of number 2.
(This because the homepage of the site has been called.)

Proposed solution

I modified the URL of the ajax call from "./" to:

JRoute::_("index.php?option=com_ajax&format=json", false)

This call refresh the session without generate any html and/or call model methods that can lead to unexpected/unwanted behaviors (for example in an increased article hits counter).
This call is available on both site and administrator applications.

To test it in the administrator application (for example) go to the edit category page that include the "behavior.keepalive" and wait for the ajax call.

Fedik · 2015-04-10T13:17:44Z

thanks @maxvalentini77
I had similar idea, and found this is already suggested couple months ago 😄

couple note:
you do not need to call JRoute as it useless here, enough:
JUri::base(true) . 'index.php?option=com_ajax&format=json';

and can you please make $refreshTime fixed, example 1 minute , so we could solve also that issue #6730

something like:

JFactory::getDocument()->addScriptDeclaration('
!window.setInterval(function(){
var r; try{ r = window.XMLHttpRequest ? new XMLHttpRequest() : new ActiveXObject("Microsoft.XMLHTTP")}catch(e){};if(r){r.open("GET","'.$url.'",true);r.send(null)}
}, 60000);
');

maxvalentini77 · 2015-04-10T18:55:43Z

Hi @Fedik
I made the changes.

Thank you

Fedik · 2015-04-10T19:06:11Z

I am sorry, I missed slash in my example, for url:
JUri::base(true) . '/index.php?option=com_ajax&format=json';

and thanks for this, I try test tomorrow

maxvalentini77 · 2015-04-10T22:25:55Z

Added the slash and tested, seems to work well.
Time is now fixed to 60 seconds, I don't know if also solves the #6730.

Fedik · 2015-04-11T10:58:08Z

test works for me good, also fix #6730 issue for me
thanks!

Fedik · 2015-04-14T10:45:47Z

test
still works good 😄

Fedik · 2015-05-13T10:16:06Z

it is ready to "RTC" or? 😃

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/4904.}

demis-palma · 2015-05-13T10:32:23Z

@test successful
@Fedik I guess that your test has not been notified because it lacks the (at) symbol.

Fedik · 2015-05-13T10:36:35Z

the (at) symbol useless here 😉
people use it as quick way to make "test" word bold 😄

zero-24 · 2015-05-13T10:45:45Z

Thanks for the bump and the tests @Fedik and @demis-palma

RTC'ing now!

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/4904.}

dgrammatiko · 2015-05-13T11:15:22Z

libraries/cms/html/behavior.php

Shouldn’t we repeat the call every X seconds? Where X is the option set in global config. So all I am saying is: restore this line here $script .= '},' . $refreshTime . ');'; and a few lines above $lifetime = ($config->get('lifetime') * 60000);

Right now this is fixed to a call per minute, which for some busy sites will create more load...

In the begging i don't change the time, but @Fedik open the issue #6730 and ask to me to reduce the time to 1 minute to fix also the #6730.
With this change the request is very "light" do not generate any html reducing time and size of the request (without this change can request the homepage!).

@maxvalentini77 I wasn’t aware of #6730…

With 60000 not always refresh the session if the session lifetime is set to 1 minute. Now work always well even with this very small value.

maxvalentini77 · 2015-05-15T15:27:41Z

I notice that the session not always be refreshed if the session lifetime is set to 1 minute.
@Fedik and @demis-palma can check again that continue to works well to you too?
(sorry for the inconveniente)

I also noticed that the session lifetime can be set a zero or negative value in the configuration page.
Zero behavior is equals to default of 15 minutes.
Negative value cause the impossibility to use the application!
(created the issue #6954 for this)

Fedik · 2015-05-15T17:06:05Z

@maxvalentini77 I already use this on my sites, where default session handler is File or APC,
and refresh session each minute works good, if compare with original

session lifetime 1 minute I think have not much sense, not sure that we need to worry about it 😉
but maybe someone has better arguments 😄

Kubik-Rubik · 2015-07-06T15:03:10Z

Thank you @maxvalentini77! Merged.

Modified the url for keepalive behavior.

23da17d

jissues-bot added the PR-staging label Oct 23, 2014

maxvalentini77 added 2 commits October 23, 2014 18:33

Added stub for getRouter

6a7f661

Stub for JApplication is now create at runtime.

b81ec33

Update behavior.php

67bd333

Update behavior.php

d332eed

zero-24 mentioned this pull request Apr 11, 2015

keepalive does not "keep alive" when session handler not a database and session time bigger than few minutes #6730

Closed

Removed stub for method getRouter

5c4893b

zero-24 added the RTC This Pull Request is Ready To Commit label May 13, 2015

dgrammatiko reviewed May 13, 2015
View reviewed changes

Update behavior.php

2418930

With 60000 not always refresh the session if the session lifetime is set to 1 minute. Now work always well even with this very small value.

zero-24 modified the milestone: Joomla! 3.4.4 Jul 2, 2015

Kubik-Rubik closed this in 72ac015 Jul 6, 2015

zero-24 removed the RTC This Pull Request is Ready To Commit label Oct 14, 2015

Uh oh!

Conversation

maxvalentini77 commented Oct 23, 2014

I found three issues:

How to reproduce number 1

How to reproduce number 2

How to reproduce number 3

Proposed solution

Uh oh!

Fedik commented Apr 10, 2015

Uh oh!

maxvalentini77 commented Apr 10, 2015

Uh oh!

Fedik commented Apr 10, 2015

Uh oh!

maxvalentini77 commented Apr 10, 2015

Uh oh!

Fedik commented Apr 11, 2015

Uh oh!

Fedik commented Apr 14, 2015

Uh oh!

Fedik commented May 13, 2015

Uh oh!

demis-palma commented May 13, 2015

Uh oh!

Fedik commented May 13, 2015

Uh oh!

zero-24 commented May 13, 2015

Uh oh!

dgrammatiko May 13, 2015

Choose a reason for hiding this comment

Uh oh!

maxvalentini77 May 13, 2015

Choose a reason for hiding this comment

Uh oh!

dgrammatiko May 13, 2015

Choose a reason for hiding this comment

Uh oh!

maxvalentini77 commented May 15, 2015

Uh oh!

Fedik commented May 15, 2015

Uh oh!

Kubik-Rubik commented Jul 6, 2015

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants