Make kernel_id as a conditional optional field (#1300)

Co-authored-by: Steven Silvester <[email protected]>

Author: allstrive

jupyter_server/event_schemas/kernel_actions/v1.yaml

@@ -7,7 +7,6 @@ description: |
 type: object
 required:
   - action
-  - kernel_id
   - msg
 properties:
   action:
@@ -39,7 +38,7 @@ properties:
     description: |
       Kernel id.
 
-      This is a required field.
+      This is a required field for all actions and statuses except action start with status error.
   kernel_name:
     type: string
     description: |
@@ -69,3 +68,13 @@ properties:
     type: string
     description: |
       Description of the event specified in action.
+if:
+    not:
+      properties:
+        status:
+            const: error
+        action:
+            const: start
+then:
+  required:
+    - kernel_id

jupyter_server/services/kernels/kernelmanager.py

@@ -738,28 +738,31 @@ async def wrapped_method(self, *args, **kwargs):
             # If the method succeeds, emit a success event.
             try:
                 out = await method(self, *args, **kwargs)
+                data = {
+                    "kernel_name": self.kernel_name,
+                    "action": action,
+                    "status": "success",
+                    "msg": success_msg.format(
+                        kernel_id=self.kernel_id, kernel_name=self.kernel_name, action=action
+                    ),
+                }
+                if self.kernel_id:
+                    data["kernel_id"] = self.kernel_id
                 self.emit(
                     schema_id="https://events.jupyter.org/jupyter_server/kernel_actions/v1",
-                    data={
-                        "kernel_id": self.kernel_id,
-                        "kernel_name": self.kernel_name,
-                        "action": action,
-                        "status": "success",
-                        "msg": success_msg.format(
-                            kernel_id=self.kernel_id, kernel_name=self.kernel_name, action=action
-                        ),
-                    },
+                    data=data,
                 )
                 return out
             # If the method fails, emit a failed event.
             except Exception as err:
                 data = {
-                    "kernel_id": self.kernel_id,
                     "kernel_name": self.kernel_name,
                     "action": action,
                     "status": "error",
                     "msg": str(err),
                 }
+                if self.kernel_id:
+                    data["kernel_id"] = self.kernel_id
                 # If the exception is an HTTPError (usually via a gateway request)
                 # log the status_code and HTTPError log_message.
                 if isinstance(err, web.HTTPError):

pyproject.toml

@@ -277,6 +277,8 @@ filterwarnings = [
   "ignore:datetime.utcnow:DeprecationWarning",
   # from nbformat
   "ignore:Importing ErrorTree directly from the jsonschema package:DeprecationWarning",
+  # From jupyter_events
+  "module:jsonschema.RefResolver is deprecated as of:DeprecationWarning",
   # ignore pytest warnings.
   "ignore:::_pytest",
 ]