Lastdocfix

learning_observer/learning_observer/incoming_student_event.py

@@ -351,8 +351,6 @@ async def incoming_websocket_handler(request):
         source=json_msg['source']
     )
 
-    print(event_metadata['auth'])
-
     # We're now ready to make the pipeline.
     hostname = socket.gethostname();
     decoder_and_logger = event_decoder_and_logger(

modules/writing_observer/writing_observer/event_wrapper.py

@@ -0,0 +1,123 @@
+"""
+event_wrapper.py
+Collin F. Lynch
+2022
+
+A big part of this project is wrapping up google doc events.
+In doing that we are reverse-engineering some of the elements 
+particularly the event types.  This code provides some basic
+wrappers for event types to simplify extraction of key elements
+and to simplify event recognition.  
+
+Over time this will likely expand and will need to adapt to keep 
+up with any changes in the event structure.  For now it is just 
+a thin abstraction layer on a few of the pieces.
+
+Clearly of course there are events at multiple levels of the system
+this code is located within the writing_observer module at the 
+moment because it is exclusively concerned with visibiity events, 
+keystroke events, and other doc-specific tasks.  A larger heirarchy
+of event wrappers for different levels of the system may make sense
+as time goes on.
+"""
+
+
+# Imports
+# --------------------------------
+import json
+
+
+
+# Basic class tests
+# -------------------------------
+def is_visibility_eventp(event):
+    """
+    Given an event return true if it is a visibility 
+    event which indicates changing the doc shown or 
+    active.
+
+    Here we look for an event with 'client' 
+    containing the field 'event_type' of 
+    'visibility'
+    """
+    Event_Type = event.get('client', {}).get('event', None)
+    return(Event_Type == 'visibility')
+
+
+def is_keystroke_eventp(event):
+    """
+    Given an event return true if it is a keystroke 
+    event which indicates changing the doc shown or 
+    active.
+
+    Here we look for an event with 'client' 
+    containing the field 'event_type' of 
+    'keystroke'
+    """
+    Event_Type = event.get('client', {}).get('event', None)
+    return(Event_Type == 'keystroke')
+
+
+
+# ---------------------------------------
+# Extraction Methods
+
+def get_doc_id(event):
+    """
+    Some of the event types (e.g. 'google_docs_save') have 
+    a 'doc_id' which provides a link to the google document.
+    Others, notably the 'visibility' and 'keystroke' events
+    do not have doc_id but do have a link to an 'object'
+    field which in turn contains an 'id' field linking to 
+    the google doc along with other features such as the 
+    title.  
+
+    This method provides a simple abstraction that returns 
+    the 'doc_id' value if it exists or returns the 'id' from
+    the 'object' field if this is a 'visibility' or 'keystroke'
+    event.
+
+    NOTE: This change is based upon the (possibly faulty)
+     assumption that the object in keystroke and visibility
+     events is always a doc. The type field in the object 
+     entry is uninformative in these cases.
+    """
+
+    # Handle standard Doc_ID cases first.
+    Doc_ID = event.get('client', {}).get('doc_id', None)
+    if (Doc_ID != None): return(Doc_ID)
+
+    # Handle cases where the object is encoded.  For
+    # safety we only do this for cases where it is a
+    # keystroke or visibility item.
+    if (is_keystroke_eventp(event)
+        or is_visibility_eventp(event)):
+
+        Doc_ID = event.get('client', {}).get('object', {}).get('id', None)
+        return(Doc_ID)
+
+    # As a bottom out case we just return None.
+
+
+
+def get_doc_title(event):
+    """
+    The keystroke and visibility events provide a link to the 
+    the document title under the 'object' field which will 
+    be useful for pulling title information in later cases.
+
+    NOTE: This change is based upon the (possibly faulty)
+     assumption that the object in keystroke and visibility
+     events is always a doc. The type field in the object 
+     entry is uninformative in these cases.
+    """
+    # For safety we only do this for cases where it is a
+    # keystroke or visibility item.
+    if (is_keystroke_eventp(event)
+        or is_visibility_eventp(event)):
+
+        Doc_Title = event.get('client', {}).get('object', {}).get('title', None)
+        return(Doc_Title)
+
+    # As a bottom out case we just return None.
+

modules/writing_observer/writing_observer/writing_analysis.py

@@ -6,6 +6,7 @@
 2) Reconstruct text (+Deane graphs, etc.)
 '''
 import writing_observer.reconstruct_doc
+import writing_observer.event_wrapper
 
 from learning_observer.stream_analytics.helpers import student_event_reducer, kvs_pipeline, KeyField, EventField, Scope
 import learning_observer.settings
@@ -163,8 +164,13 @@ async def last_document(event, internal_state):
     `document_list`, but we don't need that level of complexity for the 1.0
     dashboard.
     '''
-    document_id = event.get('client', {}).get('doc_id', None)
 
+    # Initially this code looked only for cases where the document
+    # id was specified by a doc_id field.  This fix uses the event
+    # wrapper methods to support access of IDs located in the
+    # doc_id field or in the 'object' field.
+    document_id = writing_observer.event_wrapper.get_doc_id(event)
+
     if document_id is not None:
         state = {"document_id": document_id}
         return state, state