Merge pull request #740 from FlorentinD/catch-session-already-exists

Allow session name  to be unique per user

Author: FlorentinD

changelog.md

@@ -9,6 +9,7 @@
 * Add Neo4j python driver rust extension as a new optional dependency.
 * Support creating GDS Sessions for self-managed Neo4j DBMS.
   * `GdsSessions.get_or_create` requires a new parameter `cloud_location` to specify where the session will be created.
+* Return the id of a session and allow deletion by id or name.
 * Add `ttl` parameter to `GdsSessions.get_or_create` to control if and when an unused session will be automatically deleted.
 * Add concurrency control for remote write-back procedures using the `concurrency` parameter.
 

doc/modules/ROOT/pages/gds-session.adoc

@@ -133,13 +133,13 @@ sessions.list()
 
 Use the `delete()` method to delete a GDS Session.
 This will terminate the session and stop any running costs from accumulating further.
-Deleting a session will not affect the configured AuraDB data source.
-However, any data not written back to the AuraDB instance will be lost.
+Deleting a session will not affect the configured Neo4j data source.
+However, any data not written back to the Neo4j instance will be lost.
 
 .Deleting a GDS Session:
 [source, python, role=no-test]
 ----
-sessions.delete("my-new-session")
+sessions.delete(session_name="my-new-session")
 ----
 
 

doc/modules/ROOT/pages/tutorials/gds-sessions-self-managed.adoc

@@ -113,7 +113,11 @@ what that looks like
 
 [source, python, role=no-test]
 ----
-sessions.list()
+gds_sessions = sessions.list()
+
+# Display the sessions
+from pandas import DataFrame
+DataFrame(gds_sessions)
 ----
 
 == Adding a dataset
@@ -297,7 +301,7 @@ stop incurring costs.
 ----
 gds.delete()
 
-# or sessions.delete("people-and-fruits")
+# or sessions.delete(session_name="people-and-fruits")
 ----
 
 [source, python, role=no-test]

doc/modules/ROOT/pages/tutorials/gds-sessions.adoc

@@ -30,11 +30,11 @@ GDS sessions feature enabled for your tenant. Contact your account
 manager to get the features enabled.
 
 We also need to have the `+graphdatascience+` Python library installed,
-version `+1.11+` or later.
+version `+1.12a1+` or later.
 
 [source, python, role=no-test]
 ----
-%pip install "graphdatascience>=1.11"
+%pip install "graphdatascience>=1.12a1"
 ----
 
 == Aura API credentials
@@ -111,6 +111,10 @@ what that looks like
 [source, python, role=no-test]
 ----
 sessions.list()
+
+# Display the sessions
+from pandas import DataFrame
+DataFrame(sessions)
 ----
 
 == Adding a dataset

examples/gds-sessions-self-managed.ipynb

@@ -159,7 +159,11 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "sessions.list()"
+    "gds_sessions = sessions.list()\n",
+    "\n",
+    "# Display the sessions\n",
+    "from pandas import DataFrame\n",
+    "DataFrame(gds_sessions)"
    ]
   },
   {
@@ -401,7 +405,7 @@
    "source": [
     "gds.delete()\n",
     "\n",
-    "# or sessions.delete(\"people-and-fruits\")"
+    "# or sessions.delete(session_name=\"people-and-fruits\")"
    ]
   },
   {

examples/gds-sessions.ipynb

@@ -45,7 +45,7 @@
     "This notebook requires having an AuraDB instance available and have the GDS sessions feature enabled for your tenant. \n",
     "Contact your account manager to get the features enabled. \n",
     "\n",
-    "We also need to have the `graphdatascience` Python library installed, version `1.11` or later."
+    "We also need to have the `graphdatascience` Python library installed, version `1.12a1` or later."
    ]
   },
   {
@@ -58,7 +58,7 @@
    },
    "outputs": [],
    "source": [
-    "%pip install \"graphdatascience>=1.11\""
+    "%pip install \"graphdatascience>=1.12a1\""
    ]
   },
   {
@@ -155,7 +155,11 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "sessions.list()"
+    "sessions.list()\n",
+    "\n",
+    "# Display the sessions\n",
+    "from pandas import DataFrame\n",
+    "DataFrame(sessions)"
    ]
   },
   {

graphdatascience/session/dedicated_sessions.py

@@ -81,11 +81,17 @@ def get_or_create(
             session_id=session_id, session_connection=session_connection, db_connection=db_connection
         )
 
-    def delete(self, session_name: str) -> bool:
-        candidate = self._find_existing_session(session_name)
+    def delete(self, *, session_name: Optional[str] = None, session_id: Optional[str] = None) -> bool:
+        if not session_name and not session_id:
+            raise ValueError("Either session_name or session_id must be provided.")
 
-        if candidate:
-            return self._aura_api.delete_session(candidate.id) is not None
+        if session_id:
+            return self._aura_api.delete_session(session_id) is not None
+
+        if session_name:
+            candidate = self._find_existing_session(session_name)
+            if candidate:
+                return self._aura_api.delete_session(candidate.id) is not None
 
         return False
 
@@ -96,12 +102,19 @@ def list(self, dbid: Optional[str] = None) -> List[SessionInfo]:
 
     def _find_existing_session(self, session_name: str) -> Optional[SessionDetails]:
         matched_sessions: List[SessionDetails] = []
-        # TODO pass dbid to list sessions (fail if for different dbid)
         matched_sessions = [s for s in self._aura_api.list_sessions() if s.name == session_name]
 
         if len(matched_sessions) == 0:
             return None
 
+        # this will only occur for admins as we cannot resolve Aura-API client_id -> console_user_id we fail for now
+        if len(matched_sessions) > 1:
+            users = [s.user_id for s in matched_sessions]
+            raise RuntimeError(
+                "Admin users need to chose a unique session name for now."
+                f" Multiple sessions with the name `{session_name}` across multiple users exist. Sessions found for users: {users}"
+            )
+
         return matched_sessions[0]
 
     @staticmethod

graphdatascience/session/gds_sessions.py

@@ -94,16 +94,17 @@ def get_or_create(
         """
         return self._impl.get_or_create(session_name, memory, db_connection, ttl=ttl, cloud_location=cloud_location)
 
-    def delete(self, session_name: str) -> bool:
+    def delete(self, *, session_name: Optional[str] = None, session_id: Optional[str] = None) -> bool:
         """
-        Delete a GDS session.
+        Delete a GDS session either by name or id.
         Args:
             session_name: the name of the session to delete
+            session_id: the id of the session to delete
 
         Returns:
             True iff a session was deleted as a result of this call.
         """
-        return self._impl.delete(session_name)
+        return self._impl.delete(session_name=session_name, session_id=session_id)
 
     def list(self) -> List[SessionInfo]:
         """

graphdatascience/session/session_info.py

@@ -15,6 +15,7 @@ class SessionInfo:
     Represents information about a session.
 
     Attributes:
+        id (str): The ID of the session.
         name (str): The name of the session.
         memory (str): The size of the session.
         instance_id (Optional[str]): The ID of the AuraDB instance the session is attached to.
@@ -26,6 +27,7 @@ class SessionInfo:
         ttl (Optional[timedelta]): The time until the session is deleted if unused. The TTL gets renewed on every activity.
     """
 
+    id: str
     name: str
     memory: SessionMemoryValue
     instance_id: Optional[str]
@@ -39,6 +41,7 @@ class SessionInfo:
     @classmethod
     def from_session_details(cls, details: SessionDetails) -> SessionInfo:
         return SessionInfo(
+            id=details.id,
             name=details.name,
             memory=details.memory,
             instance_id=details.instance_id,