Merge pull request #2020 from kili-technology/revert-2011-feature/lab-3584-aakd-i-see-onsubmit-and-onreview-handlers-removed-from

Revert "feat(lab-3584): remove legacy plugin handlers"

Author: florianlega

docs/sdk/tutorials/plugins_example.md

@@ -125,33 +125,28 @@ class PluginHandler(PluginCore):
     Custom plugin instance
     """
 
-    def on_event(self, payload: dict) -> None:
+    def on_submit(self, label: Dict, asset_id: str) -> None:
         """
         Dedicated handler for Submit action
         """
-        event = payload.get("event")
+        self.logger.info("On submit called")
 
-        if event == 'labels.created.submit':
-            label = payload["label"]
-            asset_id = label["assetId"]
-            self.logger.info("On submit called")
+        issues_array = check_rules_on_label(label)
 
-            issues_array = check_rules_on_label(label)
+        project_id = self.project_id
 
-            project_id = self.project_id
+        if len(issues_array) > 0:
+            print("Creating an issue...")
 
-            if len(issues_array) > 0:
-                print("Creating an issue...")
+            self.kili.create_issues(
+                project_id=project_id,
+                label_id_array=[label['id']] * len(issues_array),
+                text_array=issues_array,
+            )
 
-                self.kili.create_issues(
-                    project_id=project_id,
-                    label_id_array=[label['id']] * len(issues_array),
-                    text_array=issues_array,
-                )
+            print("Issue created!")
 
-                print("Issue created!")
-
-                self.kili.send_back_to_queue(asset_ids=[asset_id])
+            self.kili.send_back_to_queue(asset_ids=[asset_id])
 
 ```
 
@@ -213,7 +208,7 @@ plugin_name = "Plugin bbox count"
 from kili.exceptions import GraphQLError
 
 try:
-    kili.upload_plugin(plugin_folder, plugin_name, event_matcher=["labels.created.submit"])
+    kili.upload_plugin(plugin_folder, plugin_name)
 except GraphQLError as error:
     print(str(error))
 ```
@@ -236,9 +231,7 @@ path_to_plugin = Path(plugin_folder) / "main.py"
 plugin_name_file = "Plugin bbox count - file"
 
 try:
-    kili.upload_plugin(
-        str(path_to_plugin), plugin_name_file, event_matcher=["labels.created.submit"]
-    )
+    kili.upload_plugin(str(path_to_plugin), plugin_name_file)
 except GraphQLError as error:
     print(str(error))
 ```

docs/sdk/tutorials/plugins_library.md

@@ -27,6 +27,7 @@ Let's imagine a project where we want to process images and detect some objects.
 Let's imagine another project where we process invoices. The project has two jobs and several transcription tasks associated with them. One of the jobs is about payment information and must contain a proper IBAN number as well as currency. The IBAN must start with FR, and the currency should be one of: *EURO* or *DOLLAR*. Kili's interface customization options are powerful and flexible, but won't help us in this specific situation so we have to turn to Kili plugins for help. We'll set up our Kili plugin to check these two rules when labelers click *Submit*. If the annotations don't match our predefined rules, our QA bot will add issues to the asset and send the asset back to the labeling queue. At the end, our script will calculate labeling accuracy and insert the accuracy metric in the json_metadata of the asset. All that with no need to engage a human reviewer.
 
 - Plugin file: [`plugin_document.py`](https://github.com/kili-technology/kili-python-sdk/blob/main/recipes/plugins_library/plugin_document.py){target=_blank}
+- End-to-end notebook showcasing this example: [`plugins_example_document.ipynb`](https://github.com/kili-technology/kili-python-sdk/blob/main/recipes/plugins_example_document.ipynb){target=_blank}
 
 ### 2. Consensus resolution
 

recipes/plugins_example.ipynb

@@ -205,33 +205,28 @@
     "    Custom plugin instance\n",
     "    \"\"\"\n",
     "\n",
-    "    def on_event(self, payload: dict) -> None:\n",
+    "    def on_submit(self, label: Dict, asset_id: str) -> None:\n",
     "        \"\"\"\n",
     "        Dedicated handler for Submit action \n",
     "        \"\"\"\n",
-    "        event = payload.get(\"event\")\n",
+    "        self.logger.info(\"On submit called\")\n",
     "\n",
-    "        if event == 'labels.created.submit':\n",
-    "            label = payload[\"label\"]\n",
-    "            asset_id = label[\"assetId\"]\n",
-    "            self.logger.info(\"On submit called\")\n",
+    "        issues_array = check_rules_on_label(label)\n",
     "\n",
-    "            issues_array = check_rules_on_label(label)\n",
+    "        project_id = self.project_id\n",
     "\n",
-    "            project_id = self.project_id\n",
+    "        if len(issues_array) > 0:\n",
+    "            print(\"Creating an issue...\")\n",
     "\n",
-    "            if len(issues_array) > 0:\n",
-    "                print(\"Creating an issue...\")\n",
+    "            self.kili.create_issues(\n",
+    "                project_id=project_id,\n",
+    "                label_id_array=[label['id']] * len(issues_array),\n",
+    "                text_array=issues_array,\n",
+    "            )\n",
     "\n",
-    "                self.kili.create_issues(\n",
-    "                    project_id=project_id,\n",
-    "                    label_id_array=[label['id']] * len(issues_array),\n",
-    "                    text_array=issues_array,\n",
-    "                )\n",
+    "            print(\"Issue created!\")\n",
     "\n",
-    "                print(\"Issue created!\")\n",
-    "\n",
-    "                self.kili.send_back_to_queue(asset_ids=[asset_id])\n",
+    "            self.kili.send_back_to_queue(asset_ids=[asset_id])\n",
     "\n",
     "```"
    ]
@@ -324,7 +319,7 @@
     "from kili.exceptions import GraphQLError\n",
     "\n",
     "try:\n",
-    "    kili.upload_plugin(plugin_folder, plugin_name, event_matcher=[\"labels.created.submit\"])\n",
+    "    kili.upload_plugin(plugin_folder, plugin_name)\n",
     "except GraphQLError as error:\n",
     "    print(str(error))"
    ]
@@ -364,9 +359,7 @@
     "plugin_name_file = \"Plugin bbox count - file\"\n",
     "\n",
     "try:\n",
-    "    kili.upload_plugin(\n",
-    "        str(path_to_plugin), plugin_name_file, event_matcher=[\"labels.created.submit\"]\n",
-    "    )\n",
+    "    kili.upload_plugin(str(path_to_plugin), plugin_name_file)\n",
     "except GraphQLError as error:\n",
     "    print(str(error))"
    ]