🔨 refactor disable hook, and leancloud.Object.destroy_all

Author: aisk

leancloud/client.py

@@ -24,6 +24,7 @@
 APP_ID = None
 APP_KEY = None
 MASTER_KEY = None
+HOOK_KEY = None
 USE_PRODUCTION = '1'
 USE_HTTPS = True
 # 兼容老版本，如果 USE_MASTER_KEY 为 None ，并且 MASTER_KEY 不为 None，则使用 MASTER_KEY
@@ -40,7 +41,7 @@
 TIMEOUT_SECONDS = 15
 
 
-def init(app_id, app_key=None, master_key=None):
+def init(app_id, app_key=None, master_key=None, hook_key=None):
     """初始化 LeanCloud 的 AppId / AppKey / MasterKey
 
     :type app_id: string_types
@@ -49,13 +50,19 @@ def init(app_id, app_key=None, master_key=None):
     :param app_key: 应用的 Application Key
     :type master_key: None or string_types
     :param master_key: 应用的 Master Key
+    :param hook_key: application's hook key
+    :type hook_key: None or string_type
     """
     if (not app_key) and (not master_key):
         raise RuntimeError('app_key or master_key must be specified')
-    global APP_ID, APP_KEY, MASTER_KEY
+    global APP_ID, APP_KEY, MASTER_KEY, HOOK_KEY
     APP_ID = app_id
     APP_KEY = app_key
     MASTER_KEY = master_key
+    if hook_key:
+        HOOK_KEY = hook_key
+    else:
+        HOOK_KEY = os.environ.get('LEANCLOUD_APP_HOOK_KEY')
 
 
 def need_init(func):
@@ -176,6 +183,7 @@ def get_app_info():
         'app_id': APP_ID,
         'app_key': APP_KEY,
         'master_key': MASTER_KEY,
+        'hook_key': HOOK_KEY,
     }
 
 

leancloud/object_.py

@@ -4,12 +4,10 @@
 from __future__ import division
 from __future__ import print_function
 
-import time
 import copy
 import json
 
-import iso8601
-from werkzeug import LocalProxy
+from werkzeug.local import LocalProxy
 
 import leancloud
 from leancloud import utils
@@ -80,6 +78,7 @@ def __init__(self, **attrs):
         self._class_name = self._class_name  # for IDE
         self._changes = {}
         self._attributes = {}
+        self._flags = {}
         self.created_at = None
         self.updated_at = None
 
@@ -152,13 +151,32 @@ def destroy_all(cls, objs):
         """
         if not objs:
             return
-        if not all(x._class_name == objs[0]._class_name for x in objs):
-            raise ValueError("destroy_all requires the argument object list's _class_names must be the same")
         if any(x.is_new() for x in objs):
             raise ValueError("Could not destroy unsaved object")
-        ids = {x.id for x in objs}
-        ids = ','.join(ids)
-        client.delete('/classes/{0}/{1}'.format(objs[0]._class_name, ids))
+
+        dumped_objs = []
+        for obj in objs:
+            dumped_obj = {
+                'method': 'DELETE',
+                'path': '/{0}/classes/{1}/{2}'.format(client.SERVER_VERSION, obj._class_name, obj.id),
+                'body': obj._flags,
+            }
+            dumped_objs.append(dumped_obj)
+
+        response = client.post('/batch', params={'requests': dumped_objs}).json()
+
+        errors = []
+        for idx, obj in enumerate(objs):
+            content = response[idx]
+            error = content.get('error')
+            if error:
+                errors.append(leancloud.LeanCloudError(error.get('code'), error.get('error')))
+
+        if errors:
+            # TODO: how to raise list of errors?
+            # raise MultipleValidationErrors(errors)
+            # add test
+            raise errors[0]
 
     def dump(self):
         obj = self._dump()
@@ -186,7 +204,7 @@ def destroy(self):
         """
         if not self.id:
             return
-        client.delete('/classes/{0}/{1}'.format(self._class_name, self.id))
+        client.delete('/classes/{0}/{1}'.format(self._class_name, self.id), self._flags)
 
     def save(self, where=None, fetch_when_save=None):
         """
@@ -464,7 +482,9 @@ def clear(self):
         self.set(self._attributes, unset=True)
 
     def _dump_save(self):
-        return {k:v.dump() for k,v in iteritems(self._changes)}
+        data = {k: v.dump() for k, v in iteritems(self._changes)}
+        data.update(self._flags)
+        return data
 
     def fetch(self, select=None, include=None):
         """
@@ -515,18 +535,29 @@ def set_acl(self, acl):
         return self.set('ACL', acl)
 
     def disable_before_hook(self):
-        master_key = client.get_app_info().get('master_key')
-        if not master_key:
-            raise ValueError('disable_before_hook need LeanCloud master key')
-        timestamp = int(time.time() * 1000)
-        return self.set('__before', utils.sign_hook('__before_for_' + self._class_name, master_key, timestamp))
+        hook_key = client.get_app_info().get('hook_key')
+        if not hook_key:
+            raise ValueError('disable_before_hook need LeanCloud hook key')
+        self.ignore_hook('beforeSave')
+        self.ignore_hook('beforeUpdate')
+        self.ignore_hook('beforeDelete')
+        return self
 
     def disable_after_hook(self):
-        master_key = client.get_app_info().get('master_key')
-        if not master_key:
-            raise ValueError('disable_before_hook need LeanCloud master key')
-        timestamp = int(time.time() * 1000)
-        return self.set('__after', utils.sign_hook('__after_for_' + self._class_name, master_key, timestamp))
+        hook_key = client.get_app_info().get('hook_key')
+        if not hook_key:
+            raise ValueError('`disable_before_hook` need LeanCloud hook key')
+        self.ignore_hook('afterSave')
+        self.ignore_hook('afterUpdate')
+        self.ignore_hook('afterDelete')
+        return self
+
+    def ignore_hook(self, hook_name):
+        if hook_name not in {'beforeSave', 'afterSave', 'beforeUpdate', 'afterUpdate', 'beforeDelete', 'afterDelete'}:
+            raise ValueError('invalid hook name: ' + hook_name)
+        if '__ignore_hooks' not in self._flags:
+            self._flags['__ignore_hooks'] = []
+        self._flags['__ignore_hooks'].append(hook_name)
 
     def _update_data(self, server_data):
         self._merge_metadata(server_data)

tests/test_engine.py

@@ -57,7 +57,7 @@ def setup():
     leancloud.client.APP_ID = None
     leancloud.client.APP_KEY = None
     leancloud.client.MASTER_KEY = None
-    leancloud.init(TEST_APP_ID, TEST_APP_KEY, TEST_MASTER_KEY)
+    leancloud.init(TEST_APP_ID, TEST_APP_KEY, TEST_MASTER_KEY, TEST_HOOK_KEY)
     authorization._ENABLE_TEST = True
     authorization.APP_ID = TEST_APP_ID
     authorization.APP_KEY = TEST_APP_KEY
@@ -357,7 +357,6 @@ def rpc_list(**params):
 def test_before_save_hook(): # type: () -> None
     @engine.before_save('HookObject')
     def before_hook_object_save(obj):
-        assert obj.has('__before')
         obj.set('beforeSaveHookInserted', True)
 
     response = requests.post(url + '/__engine/1/functions/HookObject/beforeSave', json={
@@ -370,13 +369,12 @@ def before_hook_object_save(obj):
     assert response.ok
     assert response.json()['beforeSaveHookInserted'] == True
     assert response.json()['clientValue'] == 'blah'
-    assert '__before' in response.json()
 
 
 def test_after_save_hook(): # type: () -> None
     @engine.after_save('HookObject')
     def after_hook_object_save(obj):
-        assert obj.has('__after')
+        pass
 
     response = requests.post(url + '/__engine/1/functions/HookObject/afterSave', json={
         'object': {'clientValue': 'blah'}
@@ -458,14 +456,12 @@ def on_insight_end(ok, data):
 
 
 def test_client(): # type: () -> None
-    leancloud.init(os.environ['APP_ID'], os.environ['APP_KEY'])
     assert cloudfunc.run('add', a=1, b=2) == 3
 
 
 def test_request_sms_code(): # type: () -> None
     if leancloud.client.REGION == 'US':
         return
-    leancloud.init(os.environ['APP_ID'], master_key=os.environ['MASTER_KEY'])
     try:
         cloudfunc.request_sms_code('13111111111')
     except LeanCloudError as e:
@@ -497,7 +493,6 @@ def test_captcha():  # type: () -> None
 
 
 def test_current_user(): # type: () -> None
-    leancloud.init(os.environ['APP_ID'], master_key=os.environ['MASTER_KEY'])
     saved_user = leancloud.User()
     saved_user.set('username', 'user{0}'.format(int(time.time())))
     saved_user.set('password', 'password')