Facet expiration flag

Problem:

For performance reason a facet may cache the data in browser's memory. There should be a flag to indicate whether a facet has expired and should be refreshed. The expired flag could be set by these events:

 1) any update operation
 2) changing search filter in search facet
 3) switching page in a multi-paged search/association facet
 4) switching direct/indirect view in association facet
 5) facet expiration time
A facet should be able to use these methods to refresh itself:
 6) on demand: an expired facet should be refreshed when a user opens it.
 7) automatic: an open facet should automatically refresh itself when it expires.

Solution:

This patch solves cases: #2, #3, #5, #6. Case #4 works without any change. Case #1 will be solved later. Case #7 is deffered.

Default expiration timeout was set to 10 minutes.

In this patch are also updated facet.needs_update methods to reflect changes in containing facets.

https://fedorahosted.org/freeipa/ticket/2075
This commit is contained in:
Petr Vobornik
2012-03-22 17:03:57 +01:00
parent 5cfee2338d
commit bbe672a2ae
5 changed files with 92 additions and 17 deletions

View File

@@ -4,6 +4,7 @@
* Pavel Zuna <pzuna@redhat.com>
* Adam Young <ayoung@redhat.com>
* Endi S. Dewata <edewata@redhat.com>
* Petr Vobornik <pvoborni@redhat.com>
*
* Copyright (C) 2010 Red Hat
* see file 'COPYING' for use and warranty information
@@ -128,12 +129,25 @@ IPA.search_facet = function(spec) {
var filter = IPA.nav.get_state(that.entity.name+'-filter');
that.old_filter = filter || '';
that.old_pkeys = that.managed_entity.get_primary_key_prefix();
if (that.filter) {
that.filter.val(filter);
}
};
that.needs_update = function() {
if (that._needs_update !== undefined) return that._needs_update;
var needs_update = that.facet_needs_update();
//check if state changed
var pkeys = that.managed_entity.get_primary_key_prefix();
needs_update = needs_update || IPA.array_diff(pkeys, that.old_pkeys);
return needs_update;
};
that.show_add_dialog = function() {
var dialog = that.managed_entity.get_dialog('add');
dialog.open(that.container);
@@ -171,8 +185,12 @@ IPA.search_facet = function(spec) {
that.find = function() {
var filter = that.filter.val();
var old_filter = IPA.nav.get_state(that.managed_entity.name+'-filter');
var state = {};
state[that.managed_entity.name + '-filter'] = filter;
if (filter !== old_filter) that.set_expired_flag();
IPA.nav.push_state(state);
};
@@ -186,16 +204,8 @@ IPA.search_facet = function(spec) {
that.create_refresh_command = function() {
var filter = [];
var entity = that.managed_entity;
filter.unshift(IPA.nav.get_state(entity.name+'-filter'));
entity = entity.get_containing_entity();
while (entity !== null) {
filter.unshift(IPA.nav.get_state(entity.name+'-pkey'));
entity = entity.get_containing_entity();
}
var filter = that.managed_entity.get_primary_key_prefix();
filter.push(IPA.nav.get_state(that.managed_entity.name+'-filter'));
var command = IPA.command({
name: that.get_search_command_name(),
@@ -239,8 +249,14 @@ IPA.search_facet = function(spec) {
};
that.needs_clear = function() {
var clear = false;
var filter = IPA.nav.get_state(that.entity.name+'-filter') || '';
return that.old_filter !== '' || that.old_filter !== filter;
clear = that.old_filter !== '' || that.old_filter !== filter;
var pkeys = that.managed_entity.get_primary_key_prefix();
clear = clear || IPA.array_diff(pkeys, that.old_pkeys);
return clear;
};
init();
@@ -337,8 +353,11 @@ IPA.nested_search_facet = function(spec) {
that.header.set_pkey(
IPA.nav.get_state(IPA.current_entity.name+'-pkey'));
var filter = IPA.nav.get_state(that.managed_entity.name+'-filter');
that.old_filter = filter || '';
that.old_pkeys = that.managed_entity.get_primary_key_prefix();
if (that.filter) {
var filter = IPA.nav.get_state(that.managed_entity.name+'-filter');
that.filter.val(filter);
}
};