Merge lp:~huxuan/gtg/bug-907676 into lp:~gtg/gtg/old-trunk

[Xuan (Sean) Hu]

It's a trial to solve bug #907676.
Welcome to any suggestions or criticism.
Feel free to comment your opinion down

[lp:~huxuan/gtg/bug-907676]

1177. By Xuan (Sean) Hu on 2012-04-25

backend_localfile.py

1) remove test code. (forgive silly me)

1178. By Xuan (Sean) Hu on 2012-04-26

backend_localfile.py

1) a little code revise to be more pylint.
Though there exist more.

[Izidor Matušov (izidor)]

Your solution looks good and should work in the most of the situation. You might not get right this kind of situation:
" You get many requests in 20 seconds. You filter them because it is in burst. But then you have no save requests for long time like 30 minutes. Afterwards GTG crashes or user turn off the computer without closing GTG - the changes in the first 20 seconds are lost. "

Do you see that usecase? I propose to solve this bug by creating a timer which save XML and then timer is deleted. If the timer exists, save action is thrown away (it is already going to be saved). You might need to add locks to prevent modification of XML while saving XML.

review: Needs Fixing (code)

[Bertrand Rousseau (bertrand-rousseau)]

I don't think we'd like to keep that particular line ;-)

+ print 'fuck'

2012/4/26 Izidor Matušov <email address hidden>:
> Review: Needs Fixing code
>
> Your solution looks good and should work in the most of the situation. You might not get right this kind of situation:
> " You get many requests in 20 seconds. You filter them because it is in burst. But then you have no save requests for long time like 30 minutes. Afterwards GTG crashes or user turn off the computer without closing GTG - the changes in the first 20 seconds are lost. "
>
> Do you see that usecase? I propose to solve this bug by creating a timer which save XML and then timer is deleted. If the timer exists, save action is thrown away (it is already going to be saved). You might need to add locks to prevent modification of XML while saving XML.
> --
> https://code.launchpad.net/~huxuan/gtg/bug-907676/+merge/103529
> You are subscribed to branch lp:gtg.

--
Bertrand Rousseau

[Xuan (Sean) Hu (huxuan)]

izidor:
Got that, I will try to implement it.

Bertrand Rousseau:
Really sorry for the testing code. I did have delete it.

[lp:~huxuan/gtg/bug-907676]

1179. By Xuan (Sean) Hu on 2012-04-26

backend_localfile.py

1) Make timer for saving

[Xuan (Sean) Hu (huxuan)]

hi, I have resubmit and wish your more suggestion.

[Xuan (Sean) Hu (huxuan)]

review: Needs Resubmitting

[lp:~huxuan/gtg/bug-907676]

1180. By Xuan (Sean) Hu on 2012-04-26

backend_localfile.py

1) revised for silly logical error

1181. By Xuan (Sean) Hu on 2012-04-26

backend_localfile.py

1) silly repo error (thanks to pylint)
2) docstring revise

1182. By Xuan (Sean) Hu on 2012-04-26

backend_localfile.py

1) silly logical error.

1183. By Xuan (Sean) Hu on 2012-04-26

backend_localfile.py

1) bug fix for error indent

1184. By Xuan (Sean) Hu on 2012-04-26

backend_localfile.py

1) remove self.timer_exist for simplier code

1185. By Xuan (Sean) Hu on 2012-05-10

Merge from lp:gtg

[Izidor Matušov (izidor)]

Could you explain me why do you need self.timer_backup?

The only way how to call savexml from set_task & remove_task should be through a timer. In other words, there can't savexml in set_task & remove_task methods.

Please, decrease Timer time to shorter interval like 1 or 2 seconds. (This should prevent bursts of savexml calls but still saving enough and not lose data)

If something is not clear, feel free to contact me directly :)

review: Needs Fixing (code)

[lp:~huxuan/gtg/bug-907676]

1186. By Xuan (Sean) Hu on 2012-05-18

merge from lp:gtg

1187. By Xuan (Sean) Hu on 2012-05-28

revise according to izidor's comment:

1) backend_localfile.py: remove redundant savexml, reduce timer interval
2) test_backends.py: add time.sleep to wait timer so as to pass the test

1188. By Xuan (Sean) Hu on 2012-05-28

merge from lp:gtg

[Xuan (Sean) Hu (huxuan)]

izidor, hi

Sorry for reply so late. I'm just back from thesis season with everything almost done.

I just use self.time_backup as a sign of whether to create backup localfile. If remove that then how should we judge whether savexml should just save with rewrite or as a backup?
I have remove the redundant savexml in set_task and remove_task, but find if fail in the test caused by the timer. I add a time.sleep so as to make it pass. just note it here for attention.
The code still need some test and revise. I will try to get you in the irc channel.

[lp:~huxuan/gtg/bug-907676]

1189. By Xuan (Sean) Hu on 2012-05-30

make sleep with 2 sec to avoid potential make check error

[Izidor Matušov (izidor)]

As I described in the bug and on IRC, the bug should be solved by changing internal interface. Closing as "rejected". Nothing personal :)

review: Disapprove

Unmerged revisions

1189. By Xuan (Sean) Hu on 2012-05-30

make sleep with 2 sec to avoid potential make check error

1188. By Xuan (Sean) Hu on 2012-05-28

merge from lp:gtg

1187. By Xuan (Sean) Hu on 2012-05-28

revise according to izidor's comment:

1) backend_localfile.py: remove redundant savexml, reduce timer interval
2) test_backends.py: add time.sleep to wait timer so as to pass the test

1186. By Xuan (Sean) Hu on 2012-05-18

merge from lp:gtg

1185. By Xuan (Sean) Hu on 2012-05-10

Merge from lp:gtg

1184. By Xuan (Sean) Hu on 2012-04-26

backend_localfile.py

1) remove self.timer_exist for simplier code

1183. By Xuan (Sean) Hu on 2012-04-26

backend_localfile.py

1) bug fix for error indent

1182. By Xuan (Sean) Hu on 2012-04-26

backend_localfile.py

1) silly logical error.

1181. By Xuan (Sean) Hu on 2012-04-26

backend_localfile.py

1) silly repo error (thanks to pylint)
2) docstring revise

1180. By Xuan (Sean) Hu on 2012-04-26

backend_localfile.py

1) revised for silly logical error

=== modified file 'GTG/backends/backend_localfile.py'
--- GTG/backends/backend_localfile.py	2012-03-05 15:23:05 +0000
+++ GTG/backends/backend_localfile.py	2012-05-30 08:35:23 +0000
@@ -27,6 +27,7 @@
 
 import os
 import uuid
+import threading
 
 from GTG                         import _
 from GTG.backends.genericbackend import GenericBackend
@@ -50,8 +51,8 @@
     # default path for filenames
     DEFAULT_PATH = CoreConfig().get_data_dir() 
 
-    # General description of the backend: these are used to show a description of
-    # the backend to the user when s/he is considering adding it.
+    # General description of the backend: these are used to show a description
+    # of the backend to the user when s/he is considering adding it.
     # BACKEND_NAME is the name of the backend used internally (it must be
     # unique).
     # Please note that BACKEND_NAME and BACKEND_ICON_NAME should *not* be
@@ -111,6 +112,22 @@
         # Make safety daily backup after loading
         cleanxml.savexml(self._parameters["path"], self.doc, backup=True)
 
+        # Set timer as None and mark it not backup
+        self.timer = None
+        self.timer_backup = False
+
+    def timer_end(self):
+        """ Save and set timer as None and mark it not backup """
+        cleanxml.savexml(self._parameters["path"], self.doc, \
+                backup=self.timer_backup)
+        self.timer = None
+        self.timer_backup = False
+
+    def timer_start(self):
+        """ Start timer for saving """
+        self.timer = threading.Timer(1, self.timer_end)
+        self.timer.start()
+
     def initialize(self):
         """ This is called when a backend is enabled """
         super(Backend, self).initialize()
@@ -131,8 +148,8 @@
                         self._parameters["path"], "project")
 
     def start_get_tasks(self):
-        """ This function starts submitting the tasks from the XML file into GTG core.
-        It's run as a separate thread.
+        """ This function starts submitting the tasks from the XML file into 
+        GTG core. It's run as a separate thread.
                 
         @return: start_get_tasks() might not return or finish
         """
@@ -178,8 +195,9 @@
             modified = True
 
         #if the XML object has changed, we save it to file
-        if modified and self._parameters["path"] and self.doc :
-            cleanxml.savexml(self._parameters["path"], self.doc)
+        if modified and self._parameters["path"] and self.doc \
+                and not self.timer:
+            self.timer_start()
 
     def remove_task(self, tid):
         """ This function is called from GTG core whenever a task must be
@@ -195,4 +213,7 @@
 
         #We save the XML file only if it's necessary
         if modified:
-            cleanxml.savexml(self._parameters["path"], self.doc, backup=True)
+            if self.timer:
+                self.timer_backup = True
+            else:
+                self.timer_start()
 
=== modified file 'GTG/tests/test_backends.py'
--- GTG/tests/test_backends.py	2012-03-05 15:23:05 +0000
+++ GTG/tests/test_backends.py	2012-05-30 08:35:23 +0000
@@ -27,6 +27,7 @@
 import unittest
 import os
 import xdg
+import time
 
 # GTG imports
 from GTG.backends import backend_localfile as localfile
@@ -100,6 +101,7 @@
         expectedres = True
         beobj.remove_task("0@1")
         beobj.quit()
+        time.sleep(2)
         dataline = open(self.taskpath, 'r').read()
         if "0@1" in dataline:
             res = False