Send the user's Python version to Segment (streamlit#1212)

* Move widget-related messages out of BackMsg.proto

* Clear up protobuf/__init__.py . No need for all the crap we had there.

* Send python_version to client

* Large refactor so generated proto files have right Python path

* Add __init__py to proto/

* Add useless comment to /proto/__init__py

* Rename __init__py to __init__.py

* Remove FixMe from Makefile.

Author: tvst

Makefile

@@ -106,7 +106,6 @@ wheel:
 	# cd lib ; python setup.py bdist_wheel sdist
 
 clean:
-	@echo FIXME: This needs to be fixed!
 	cd lib; rm -rf build dist  .eggs *.egg-info
 	find . -name '*.pyc' -type f -delete || true
 	find . -name __pycache__ -type d -delete || true

frontend/src/App.jsx

@@ -184,19 +184,22 @@ class App extends PureComponent {
    */
   handleInitialize(initializeMsg) {
     SessionInfo.current = new SessionInfo({
-      streamlitVersion: initializeMsg.streamlitVersion,
+      streamlitVersion: initializeMsg.environmentInfo.streamlitVersion,
+      pythonVersion: initializeMsg.environmentInfo.pythonVersion,
       installationId: initializeMsg.userInfo.installationId,
       authorEmail: initializeMsg.userInfo.email,
     })
 
     MetricsManager.current.initialize({
-      gatherUsageStats: initializeMsg.gatherUsageStats,
+      gatherUsageStats: initializeMsg.config.gatherUsageStats,
     })
 
-    MetricsManager.current.enqueue('createReport')
+    MetricsManager.current.enqueue('createReport', {
+      pythonVersion: SessionInfo.current.pythonVersion,
+    })
 
     this.setState({
-      sharingEnabled: initializeMsg.sharingEnabled,
+      sharingEnabled: initializeMsg.config.sharingEnabled,
     })
 
     const initialState = initializeMsg.sessionState

frontend/src/lib/SessionInfo.ts

@@ -6,13 +6,15 @@
 
 interface Args {
   streamlitVersion: string;
+  pythonVersion: string;
   installationId: string;
   authorEmail: string;
 }
 
 
 export class SessionInfo {
   public readonly streamlitVersion: string;
+  public readonly pythonVersion: string;
   public readonly installationId: string;
   public readonly authorEmail: string;
 
@@ -36,8 +38,11 @@ export class SessionInfo {
     SessionInfo.singleton = sm
   }
 
-  public constructor({streamlitVersion, installationId, authorEmail}: Args) {
+  public constructor({
+    streamlitVersion, pythonVersion, installationId, authorEmail,
+  }: Args) {
     this.streamlitVersion = streamlitVersion
+    this.pythonVersion = pythonVersion
     this.installationId = installationId
     this.authorEmail = authorEmail
   }

lib/streamlit/ReportSession.py

@@ -1,6 +1,7 @@
 # Copyright 2019 Streamlit Inc. All rights reserved.
 # -*- coding: utf-8 -*-
 from enum import Enum
+import sys
 
 import tornado.gen
 import tornado.ioloop
@@ -314,22 +315,25 @@ def _maybe_enqueue_initialize_message(self):
         msg = ForwardMsg()
         imsg = msg.initialize
 
-        imsg.sharing_enabled = (
+        imsg.config.sharing_enabled = (
             config.get_option('global.sharingMode') != 'off')
         LOGGER.debug(
             'New browser connection: sharing_enabled=%s',
-            msg.initialize.sharing_enabled)
+            imsg.config.sharing_enabled)
 
-        imsg.gather_usage_stats = (
+        imsg.config.gather_usage_stats = (
             config.get_option('browser.gatherUsageStats'))
         LOGGER.debug(
             'New browser connection: gather_usage_stats=%s',
-            msg.initialize.gather_usage_stats)
+            imsg.config.gather_usage_stats)
+
+        imsg.environment_info.streamlit_version = __version__
+        imsg.environment_info.python_version = (
+            '.'.join(map(str, sys.version_info)))
 
-        imsg.streamlit_version = __version__
         imsg.session_state.run_on_save = self._run_on_save
-        imsg.session_state.report_is_running = \
-            self._state == ReportSessionState.REPORT_IS_RUNNING
+        imsg.session_state.report_is_running = (
+            self._state == ReportSessionState.REPORT_IS_RUNNING)
 
         imsg.user_info.installation_id = __installation_id__
         imsg.user_info.email = Credentials.get_current().activation.email

lib/tests/streamlit/ReportQueue_test.py

@@ -13,7 +13,7 @@
 # their general type.
 
 INIT_MSG = ForwardMsg()
-INIT_MSG.initialize.sharing_enabled = True
+INIT_MSG.initialize.config.sharing_enabled = True
 
 TEXT_DELTA_MSG1 = ForwardMsg()
 TEXT_DELTA_MSG1.delta.new_element.text.body = 'text1'
@@ -44,7 +44,7 @@ def test_simple_enqueue(self):
         queue = rq.flush()
         self.assertTrue(rq.is_empty())
         self.assertEqual(len(queue), 1)
-        self.assertTrue(queue[0].initialize.sharing_enabled)
+        self.assertTrue(queue[0].initialize.config.sharing_enabled)
 
     def test_enqueue_two(self):
         rq = ReportQueue()
@@ -57,7 +57,7 @@ def test_enqueue_two(self):
 
         queue = rq.flush()
         self.assertEqual(len(queue), 2)
-        self.assertTrue(queue[0].initialize.sharing_enabled)
+        self.assertTrue(queue[0].initialize.config.sharing_enabled)
         self.assertEqual(queue[1].delta.id, 0)
         self.assertEqual(queue[1].delta.new_element.text.body, 'text1')
 
@@ -75,7 +75,7 @@ def test_enqueue_three(self):
 
         queue = rq.flush()
         self.assertEqual(len(queue), 3)
-        self.assertTrue(queue[0].initialize.sharing_enabled)
+        self.assertTrue(queue[0].initialize.config.sharing_enabled)
         self.assertEqual(queue[1].delta.id, 0)
         self.assertEqual(queue[1].delta.new_element.text.body, 'text1')
         self.assertEqual(queue[2].delta.id, 1)
@@ -95,7 +95,7 @@ def test_replace_element(self):
 
         queue = rq.flush()
         self.assertEqual(len(queue), 2)
-        self.assertTrue(queue[0].initialize.sharing_enabled)
+        self.assertTrue(queue[0].initialize.config.sharing_enabled)
         self.assertEqual(queue[1].delta.id, 0)
         self.assertEqual(queue[1].delta.new_element.text.body, 'text2')
 
@@ -116,7 +116,7 @@ def test_simple_add_rows(self):
 
         queue = rq.flush()
         self.assertEqual(len(queue), 3)
-        self.assertTrue(queue[0].initialize.sharing_enabled)
+        self.assertTrue(queue[0].initialize.config.sharing_enabled)
         self.assertEqual(queue[1].delta.id, 0)
         self.assertEqual(queue[1].delta.new_element.text.body, 'text1')
         self.assertEqual(queue[2].delta.id, 1)
@@ -144,7 +144,7 @@ def test_add_rows_rerun(self):
 
         queue = rq.flush()
         self.assertEqual(len(queue), 3)
-        self.assertTrue(queue[0].initialize.sharing_enabled)
+        self.assertTrue(queue[0].initialize.config.sharing_enabled)
         self.assertEqual(queue[1].delta.id, 0)
         self.assertEqual(queue[1].delta.new_element.text.body, 'text1')
         self.assertEqual(queue[2].delta.id, 1)

proto/streamlit/proto/Initialize.proto

@@ -6,24 +6,29 @@ import "streamlit/proto/SessionState.proto";
 // It contains streamlit configuration data, and the session state
 // that existed at the time of connection.
 message Initialize {
+  UserInfo user_info = 1;
+  Config config = 2;
+  EnvironmentInfo environment_info = 3;
+
+  // The session state at the time the connection was established
+  SessionState session_state = 4;
+}
+
+message Config {
   // True if saving is properly configured.
   bool sharing_enabled = 1;
 
-  // If true, tells Streamlit to log datpoints for our own stats when the user
-  // performs certain actions.
+  // See config option "browser.gatherUsageStats".
   bool gather_usage_stats = 2;
 
-  // Python streamlit version.
-  string streamlit_version = 3;
-
-  // The session state at the time the connection
-  // was established
-  SessionState session_state = 5;
-
-  UserInfo user_info = 6;
 }
 
 message UserInfo {
   string installation_id = 1;
   string email = 2;
 }
+
+message EnvironmentInfo {
+  string streamlit_version = 1;
+  string python_version = 2;
+}