Merge pull request #526 from leancloud/on-auth-data

feat: on_auth_data hook

Author: weakish

leancloud/engine/__init__.py

@@ -34,6 +34,7 @@
 from .leanengine import register_cloud_func
 from .leanengine import register_on_bigquery
 from .leanengine import register_on_login
+from .leanengine import register_on_auth_data
 from .leanengine import register_on_verified
 from .leanengine import user
 
@@ -121,6 +122,9 @@ def on_verified(self, *args, **kwargs):
     def on_login(self, *args, **kwargs):
         return register_on_login(self.app.cloud_codes, *args, **kwargs)
 
+    def on_auth_data(self, *args, **kwargs):
+        return register_on_auth_data(self.app.cloud_codes, *args, **kwargs)
+
     def on_bigquery(self, *args, **kwargs):
         warnings.warn(
             "on_bigquery is deprecated, please use on_insight instead",

leancloud/engine/leanengine.py

@@ -135,6 +135,8 @@ def __init__(self, fetch_user):
                 ),
                 Rule("/__engine/1.1/functions/_User/onLogin", endpoint="on_login"),
                 Rule("/__engine/1/functions/_User/onLogin", endpoint="on_login"),
+                Rule("/__engine/1.1/functions/_User/onAuthData", endpoint="on_auth_data"),
+                Rule("/__engine/1/functions/_User/onAuthData", endpoint="on_auth_data"),
                 Rule(
                     "/__engine/1/functions/<class_name>/<hook_name>",
                     endpoint="cloud_hook",
@@ -163,6 +165,8 @@ def __init__(self, fetch_user):
                 Rule("/1.1/functions/BigQuery/<event>", endpoint="on_bigquery"),
                 Rule("/1.1/functions/_User/onLogin", endpoint="on_login"),
                 Rule("/1/functions/_User/onLogin", endpoint="on_login"),
+                Rule("/1.1/functions/_User/onAuthData", endpoint="on_auth_data"),
+                Rule("/1/functions/_User/onAuthData", endpoint="on_auth_data"),
                 Rule("/1/functions/<class_name>/<hook_name>", endpoint="cloud_hook"),
                 Rule("/1.1/functions/<class_name>/<hook_name>", endpoint="cloud_hook"),
                 Rule("/1/functions/onVerified/<verify_type>", endpoint="on_verified"),
@@ -247,6 +251,10 @@ def dispatch_request(self, environ):
                 result = {
                     "result": dispatch_on_login(self.cloud_codes, app_params, **values)
                 }
+            elif endpoint == "on_auth_data":
+                result = {
+                    "result": dispatch_on_auth_data(self.cloud_codes, app_params, **values)
+                }
             elif endpoint == "ops_meta_data":
                 from .authorization import MASTER_KEY
 
@@ -508,6 +516,26 @@ def dispatch_on_login(_cloud_codes, app_params, params):
 
     return func(user)
 
+def register_on_auth_data(_cloud_codes, func):
+    func_name = "__on_auth_data__User"
+
+    if func_name in _cloud_codes:
+        raise RuntimeError("on authdata is already registered")
+    _cloud_codes[func_name] = func
+
+def dispatch_on_auth_data(_cloud_codes, app_params, params):
+    from .authorization import HOOK_KEY
+    current_hook_key = app_params.get("hook_key")
+    if not current_hook_key or current_hook_key != HOOK_KEY:
+        raise LeanEngineError(code=401, message="Unauthorized.")
+
+    func = _cloud_codes.get("__on_auth_data__User")
+    if not func:
+        return
+
+    auth_data = params["object"]
+    return func(auth_data)
+    
 
 def dispatch_ops_meta_data(_cloud_codes):
     return list(_cloud_codes.keys())

tests/test_engine.py

@@ -500,6 +500,32 @@ def on_login(user):
     assert response.ok
 
 
+def test_on_auth_data():  # type: () -> None
+    @engine.on_auth_data
+    def on_auth_data(auth_data):
+        if auth_data["foo"]["openid"] == "openid":
+            auth_data["foo"]["uid"] = "openid"
+        return auth_data
+
+    response = requests.post(
+        url + "/__engine/1.1/functions/_User/onAuthData",
+        json={"object": {
+            "foo": {
+                "openid": "openid",
+                "access_token": "access_token",
+                "expires_in": 123456789,
+            }
+        }},
+        headers={
+            "x-avoscloud-application-id": TEST_APP_ID,
+            "x-avoscloud-application-key": TEST_APP_KEY,
+            "x-lc-hook-key": TEST_HOOK_KEY,
+        },
+    )
+    assert response.ok
+    assert response.json()["result"]["foo"]["uid"] == "openid"
+
+
 def test_insight():  # type: () -> None
     @engine.on_insight("end")
     def on_insight_end(ok, data):