Merge records instead of overwrite and updates to metric portfolio

examples/minimal.py

@@ -35,8 +35,15 @@
 
 st.markdown("---")
 
-with streamlit_analytics.track():
-    st.text_input("Write your name")
-    st.selectbox("Select your favorite", ["cat", "dog", "flower"])
-    st.button("Click me")
+session_id = st.text_input("Session ID", help="This is the session ID that will be used to track individual session data. If not provided, tracking only occurs at an aggregate level.")
+
+if session_id is not None and session_id == "":
+    session_id = None
+
+with streamlit_analytics.track(session_id=session_id):
+    st.text_input("Write your name", key="name")
+    st.selectbox("Select your favorite", ["cat", "dog", "flower"], key="favorite")
+    st.button("Click me", key="click_me")
     streamlit_analytics.data
+    streamlit_analytics.session_data
+

examples/pages/firebase_test.py

@@ -2,6 +2,17 @@
 
 import streamlit_analytics2 as streamlit_analytics
 
+COLLECTION_NAME = "streamlit-analytics-secrets-approach"
+DOCUMENT_NAME = "counts"
+PROJECT_NAME = "ev-monitoring-poc"
+
+session_id = st.text_input("Session ID", help="This is the session ID that will be used to track individual session data. If not provided, tracking only occurs at an aggregate level.")
+
+if session_id is not None and session_id == "":
+    session_id = None
+st.write(f"Session ID: {session_id}")
+st.write(f"{streamlit_analytics.session_data["loaded_from_firestore"]=}")
+
 tab1, tab2 = st.tabs(["Classic", "Advanced"])
 
 
@@ -13,26 +24,54 @@
 
         with streamlit_analytics.track(
             firestore_key_file="pages/firebase-key.json",
-            firestore_collection_name="streamlit_analytics2",
-            firestore_document_name="data",
-            firestore_project_name="streamlit-analtyics2",
+            firestore_collection_name=COLLECTION_NAME,
+            firestore_document_name=DOCUMENT_NAME,
+            firestore_project_name=PROJECT_NAME,
             verbose=True,
+            session_id=session_id,
         ):
 
             st.text_input("Write something")
             st.button("Click me")
+
+            st.write("# Aggregate Stats")
+            st.write(streamlit_analytics.data)
+            st.write("# Session Stats")
+            st.write(streamlit_analytics.session_data)
+
+    if st.button("Delete session data", key="delete_classic"):
+        streamlit_analytics.delete_session_data(
+            session_id,
+            COLLECTION_NAME,
+            firestore_project_name=PROJECT_NAME,
+            firestore_key_file="pages/firebase-key.json"
+        )
 
 
 # Advanced storing of key in secrets.toml
 with tab2:
     st.header("Advanced")
-    # if st.button("Test Advanced"):
 
-    #     with streamlit_analytics.track(
-    #         firestore_collection_name="counts",
-    #         streamlit_secrets_firestore_key="firebase",
-    #         firestore_project_name="firestore_project_name",
-    #         verbose=True):
+    with streamlit_analytics.track(
+        firestore_collection_name=COLLECTION_NAME,
+        streamlit_secrets_firestore_key="firebase",
+        firestore_project_name=PROJECT_NAME,
+        session_id=session_id,
+        verbose=False):
+
+        st.text_input("Write something", key="text_input2")
+        st.button("Click me", key="button2")
+
+        st.write("# Aggregate Stats")
+        st.write(streamlit_analytics.data)
+        st.write("# Session Stats")
+        st.write(streamlit_analytics.session_data)
 
-    #         st.text_input("Write something")
-    #         st.button("Click me")
+    if st.button("Delete session data", key="delete_advanced"):
+        print("Session deletion button clicked")
+        streamlit_analytics.delete_session_data(
+            session_id,
+            COLLECTION_NAME,
+            firestore_project_name=PROJECT_NAME,
+            streamlit_secrets_firestore_key="firebase",
+        )

src/streamlit_analytics2/__init__.py

@@ -3,10 +3,15 @@
 Track & visualize user interactions with your streamlit app.
 """
 
-from .main import start_tracking, stop_tracking, track  # noqa: F401
-from .state import data  # noqa: F401
+from .main import (  # noqa: F401
+    delete_session_data,
+    start_tracking,
+    stop_tracking,
+    track,
+)
+from .state import data, session_data  # noqa: F401
 
 from .state import data as counts  # noqa: F401  # isort:skip
 
-__version__ = "0.10.4"
+__version__ = "0.11.0"
 __name__ = "streamlit_analytics2"

src/streamlit_analytics2/display.py

@@ -7,7 +7,7 @@
 import streamlit as st
 
 from . import utils
-from .state import data  # noqa: F401
+from .state import data, session_data  # noqa: F401
 
 
 def show_results(data, reset_callback, unsafe_password=None):  # noqa: F811

src/streamlit_analytics2/firestore.py

@@ -1,11 +1,12 @@
 import json
+from pathlib import Path
+from typing import Optional, Union
 
 import streamlit as st
 from google.cloud import firestore
 from google.oauth2 import service_account
-from streamlit import session_state as ss
 
-from .state import data  # noqa: F401
+from .state import data, session_data  # noqa: F401
 
 
 def sanitize_data(data):  # noqa: F811
@@ -23,12 +24,12 @@ def sanitize_data(data):  # noqa: F811
 
 def load(
     data,  # noqa: F811
-    service_account_json,
-    collection_name,
-    document_name,
-    streamlit_secrets_firestore_key,
-    firestore_project_name,
-    session_id=None,
+    service_account_json: Optional[Union[str, Path]] = None,
+    collection_name: Optional[str] = None,
+    document_name: Optional[str] = "counts",
+    streamlit_secrets_firestore_key: Optional[str] = None,
+    firestore_project_name: Optional[str] = None,
+    session_id: Optional[str] = None,
 ):
     """Load count data from firestore into `data`."""
     firestore_data = None
@@ -59,21 +60,21 @@ def load(
 
     if firestore_session_data is not None:
         for key in firestore_session_data:
-            if key in ss.session_data:
-                ss.session_data[key] = firestore_session_data[key]
+            if key in session_data:
+                session_data[key] = firestore_session_data[key]
 
     # Log loaded data for debugging
     # logging.debug("Data loaded from Firestore: %s", firestore_data)
 
 
 def save(
     data,  # noqa: F811
-    service_account_json,
-    collection_name,
-    document_name,
-    streamlit_secrets_firestore_key,
-    firestore_project_name,
-    session_id=None,
+    service_account_json: Optional[Union[str, Path]] = None,
+    collection_name: Optional[str] = None,
+    document_name: Optional[str] = "counts",
+    streamlit_secrets_firestore_key: Optional[str] = None,
+    firestore_project_name: Optional[str] = None,
+    session_id: Optional[str] = None,
 ):
     """Save count data from `data` to firestore."""
 
@@ -94,7 +95,32 @@ def save(
 
     # Attempt to save to Firestore
     # creates if doesn't exist
-    col.document(document_name).set(sanitized_data)
+    col.document(document_name).set(sanitized_data, merge=True)
     if session_id is not None:
-        sanitized_session_data = sanitize_data(ss.session_data)
-        col.document(session_id).set(sanitized_session_data)
+        sanitized_session_data = sanitize_data(session_data)
+        col.document(session_id).set(sanitized_session_data, merge=True)
+
+
+def delete(
+    document_name: str,  # noqa: F811
+    collection_name: str,
+    service_account_json: Optional[Union[str, Path]] = None,
+    streamlit_secrets_firestore_key: Optional[str] = None,
+    firestore_project_name: Optional[str] = None,
+):
+    """Delete a document from firestore. Commonly used to delete session data when requested by a user by passing session_id as document_name."""
+    if streamlit_secrets_firestore_key is not None:
+        print("Using secrets to connect to firestore for deletion")
+        # Following along here https://blog.streamlit.io/streamlit-firestore-continued/#part-4-securely-deploying-on-streamlit-sharing  # noqa: E501
+        # for deploying to Streamlit Cloud with Firestore
+        key_dict = json.loads(st.secrets[streamlit_secrets_firestore_key])
+        creds = service_account.Credentials.from_service_account_info(key_dict)
+        db = firestore.Client(credentials=creds, project=firestore_project_name)
+    else:
+        db = firestore.Client.from_service_account_json(service_account_json)
+    col = db.collection(collection_name)
+    # TODO pass user set argument via config screen for the name of document
+    # currently hard coded to be "counts"
+
+    # Delete from firestore
+    col.document(document_name).delete()