Send initialization data in the NewReport message

frontend/src/App.test.tsx

@@ -17,7 +17,7 @@
 
 import React from "react"
 import { shallow, mount, ReactWrapper } from "enzyme"
-import { ForwardMsg } from "autogen/proto"
+import { ForwardMsg, NewReport } from "autogen/proto"
 import { IMenuItem } from "hocs/withS4ACommunication/types"
 import { MetricsManager } from "./lib/MetricsManager"
 import { getMetricsManagerForTest } from "./lib/MetricsManagerTestUtils"
@@ -28,17 +28,10 @@ import MainMenu from "./components/core/MainMenu"
 
 const getProps = (extend?: Partial<Props>): Props => ({
   screenCast: {
+    currentState: "OFF",
     toggleRecordAudio: jest.fn(),
     startRecording: jest.fn(),
     stopRecording: jest.fn(),
-    fileName: "",
-    recording: false,
-    recordAudio: false,
-    countdown: -1,
-    startAnimation: false,
-    showRecordedDialog: false,
-    showScreencastDialog: false,
-    showUnsupportedDialog: false,
   },
   s4aCommunication: {
     connect: jest.fn(),
@@ -84,7 +77,8 @@ describe("App", () => {
   })
 
   afterEach(() => {
-    SessionInfo.singleton = undefined
+    const UnsafeSessionInfo = SessionInfo as any
+    UnsafeSessionInfo.singleton = undefined
   })
 
   it("renders without crashing", () => {
@@ -93,22 +87,24 @@ describe("App", () => {
     expect(wrapper.html()).not.toBeNull()
   })
 
-  it("should reload when streamlit server version changes", () => {
+  it("reloads when streamlit server version changes", () => {
     const props = getProps()
     const wrapper = shallow(<App {...props} />)
 
     window.location.reload = jest.fn()
 
     const fwMessage = new ForwardMsg()
 
-    fwMessage.initialize = {
-      environmentInfo: {
-        streamlitVersion: "svv",
+    fwMessage.newReport = {
+      initialize: {
+        environmentInfo: {
+          streamlitVersion: "svv",
+        },
+        sessionId: "sessionId",
+        userInfo: {},
+        config: {},
+        sessionState: {},
       },
-      sessionId: "sessionId",
-      userInfo: {},
-      config: {},
-      sessionState: {},
     }
 
     // @ts-ignore
@@ -117,7 +113,7 @@ describe("App", () => {
     expect(window.location.reload).toHaveBeenCalled()
   })
 
-  it("should start screencast recording when the MainMenu is clicked", () => {
+  it("starts screencast recording when the MainMenu is clicked", () => {
     const props = getProps()
     const wrapper = shallow(<App {...props} />)
 
@@ -135,7 +131,7 @@ describe("App", () => {
     )
   })
 
-  it("should stop screencast when esc is pressed", () => {
+  it("stops screencast when esc is pressed", () => {
     const props = getProps()
     const wrapper = shallow(<App {...props} />)
 
@@ -145,7 +141,7 @@ describe("App", () => {
     expect(props.screenCast.stopRecording).toBeCalled()
   })
 
-  it("should show s4aMenuItems", () => {
+  it("shows s4aMenuItems", () => {
     const props = getProps({
       s4aCommunication: {
         connect: jest.fn(),
@@ -167,3 +163,102 @@ describe("App", () => {
     ])
   })
 })
+
+describe("App.handleNewReport", () => {
+  const NEW_REPORT = new NewReport({
+    initialize: {
+      userInfo: {
+        installationId: "installationId",
+        installationIdV1: "installationIdV1",
+        installationIdV2: "installationIdV2",
+        email: "email",
+      },
+      config: {
+        sharingEnabled: false,
+        gatherUsageStats: false,
+        maxCachedMessageAge: 0,
+        mapboxToken: "mapboxToken",
+        allowRunOnSave: false,
+      },
+      environmentInfo: {
+        streamlitVersion: "streamlitVersion",
+        pythonVersion: "pythonVersion",
+      },
+      sessionState: {
+        runOnSave: false,
+        reportIsRunning: false,
+      },
+      sessionId: "sessionId",
+      commandLine: "commandLine",
+    },
+  })
+
+  afterEach(() => {
+    const UnsafeSessionInfo = SessionInfo as any
+    UnsafeSessionInfo.singleton = undefined
+  })
+
+  it("performs one-time initialization", () => {
+    const wrapper = shallow(<App {...getProps()} />)
+    const app = wrapper.instance()
+
+    const oneTimeInitialization = jest.spyOn(
+      app,
+      // @ts-ignore
+      "handleOneTimeInitialization"
+    )
+
+    expect(SessionInfo.isSet()).toBe(false)
+
+    // @ts-ignore
+    app.handleNewReport(NEW_REPORT)
+
+    expect(oneTimeInitialization).toHaveBeenCalledTimes(1)
+    expect(SessionInfo.isSet()).toBe(true)
+  })
+
+  it("performs one-time initialization only once", () => {
+    const wrapper = shallow(<App {...getProps()} />)
+    const app = wrapper.instance()
+
+    const oneTimeInitialization = jest.spyOn(
+      app,
+      // @ts-ignore
+      "handleOneTimeInitialization"
+    )
+
+    expect(SessionInfo.isSet()).toBe(false)
+
+    // @ts-ignore
+    app.handleNewReport(NEW_REPORT)
+    // @ts-ignore
+    app.handleNewReport(NEW_REPORT)
+    // @ts-ignore
+    app.handleNewReport(NEW_REPORT)
+
+    // Multiple NEW_REPORT messages should not result in one-time
+    // initialization being performed more than once.
+    expect(oneTimeInitialization).toHaveBeenCalledTimes(1)
+    expect(SessionInfo.isSet()).toBe(true)
+  })
+
+  it("throws an error if SessionInfo changes", () => {
+    const wrapper = shallow(<App {...getProps()} />)
+    const app = wrapper.instance()
+
+    expect(SessionInfo.isSet()).toBe(false)
+
+    // @ts-ignore
+    app.handleNewReport(NEW_REPORT)
+
+    const modified = NewReport.toObject(NEW_REPORT)
+    modified.initialize.userInfo.installationId = "modified"
+
+    const modifiedMessage = NewReport.fromObject(modified)
+
+    // @ts-ignore
+    expect(() => app.handleNewReport(modifiedMessage)).toThrow(
+      "Received mismatched SessionInfo"
+    )
+  })
+})