From 14a5754a07034f73312eefd028a9a69e68c19255 Mon Sep 17 00:00:00 2001
From: Jeremy Tuloup <jeremy.tuloup@gmail.com>
Date: Mon, 24 Jul 2023 14:17:31 +0000
Subject: [PATCH] Update browser tab favicon on kernel busy

---
 packages/notebook-extension/src/index.ts | 48 +++++++++++++++++++++++-
 1 file changed, 47 insertions(+), 1 deletion(-)

diff --git a/packages/notebook-extension/src/index.ts b/packages/notebook-extension/src/index.ts
index 52eac92d5c..e4d217c577 100644
--- a/packages/notebook-extension/src/index.ts
+++ b/packages/notebook-extension/src/index.ts
@@ -402,6 +402,51 @@ const notebookToolsWidget: JupyterFrontEndPlugin<void> = {
   },
 };
 
+/**
+ * A plugin to update the tab icon based on the kernel status.
+ */
+const tabIcon: JupyterFrontEndPlugin<void> = {
+  id: '@jupyter-notebook/notebook-extension:tab-icon',
+  autoStart: true,
+  requires: [INotebookTracker],
+  activate: (app: JupyterFrontEnd, tracker: INotebookTracker) => {
+    // the favicons are provided by Jupyter Server
+    const notebookIcon = ' /static/favicons/favicon-notebook.ico';
+    const busyIcon = ' /static/favicons/favicon-busy-1.ico';
+
+    const updateBrowserFavicon = (
+      status: ISessionContext.KernelDisplayStatus
+    ) => {
+      const link = document.querySelector(
+        "link[rel*='icon']"
+      ) as HTMLLinkElement;
+      switch (status) {
+        case 'busy':
+          link.href = busyIcon;
+          break;
+        case 'idle':
+          link.href = notebookIcon;
+          break;
+      }
+    };
+
+    const onChange = async () => {
+      const current = tracker.currentWidget;
+      const sessionContext = current?.sessionContext;
+      if (!sessionContext) {
+        return;
+      }
+
+      sessionContext.statusChanged.connect(() => {
+        const status = sessionContext.kernelDisplayStatus;
+        updateBrowserFavicon(status);
+      });
+    };
+
+    tracker.currentChanged.connect(onChange);
+  },
+};
+
 /**
  * A plugin that adds a Trusted indicator to the menu area
  */
@@ -441,8 +486,9 @@ const plugins: JupyterFrontEndPlugin<any>[] = [
   closeTab,
   kernelLogo,
   kernelStatus,
-  scrollOutput,
   notebookToolsWidget,
+  scrollOutput,
+  tabIcon,
   trusted,
 ];