From c43bcff033de25b416443832c8be6ea40babae05 Mon Sep 17 00:00:00 2001
From: Yousif Ahmed <yousif@bugsnag.com>
Date: Fri, 13 Sep 2024 14:07:31 +0100
Subject: [PATCH] launch navigation scenarios via commands

---
 .../app/react_navigation_js/app/App.js        | 199 ++----------------
 .../app/lib/CommandRunner.js                  |  38 ++++
 .../app/lib/ConfigFileReader.js               |  32 +++
 .../app/lib/ScenarioLauncher.js               | 101 +++++++++
 ...ctNavigationBreadcrumbsDisabledScenario.js |  28 ++-
 ...actNavigationBreadcrumbsEnabledScenario.js |  28 ++-
 test/react-native/features/navigation.feature |   8 +-
 7 files changed, 226 insertions(+), 208 deletions(-)
 create mode 100644 test/react-native/features/fixtures/app/react_navigation_js/app/lib/CommandRunner.js
 create mode 100644 test/react-native/features/fixtures/app/react_navigation_js/app/lib/ConfigFileReader.js
 create mode 100644 test/react-native/features/fixtures/app/react_navigation_js/app/lib/ScenarioLauncher.js

diff --git a/test/react-native/features/fixtures/app/react_navigation_js/app/App.js b/test/react-native/features/fixtures/app/react_navigation_js/app/App.js
index b72e94ef63..7fd9986db5 100644
--- a/test/react-native/features/fixtures/app/react_navigation_js/app/App.js
+++ b/test/react-native/features/fixtures/app/react_navigation_js/app/App.js
@@ -1,200 +1,35 @@
-import React, { Component } from 'react'
-import Bugsnag from '@bugsnag/react-native'
-import BugsnagPluginReactNavigation from '@bugsnag/plugin-react-navigation'
-import { NavigationContainer } from '@react-navigation/native'
-import * as Scenarios from './Scenarios'
+import React, { useState, useEffect } from 'react'
 import {
   View,
   Text,
-  TextInput,
-  Button,
   StyleSheet,
-  NativeModules
+  SafeAreaView
 } from 'react-native'
 
-const defaultJsConfig = () => ({
-  plugins: [new BugsnagPluginReactNavigation()]
-})
-
-export default class App extends Component {
-  constructor (props) {
-    super(props)
-    this.state = {
-      currentScenario: '',
-      apiKey: '12312312312312312312312312312312',
-      notifyEndpoint: '',
-      sessionsEndpoint: '',
-      scenario: null,
-      bugsnagStarted: false
-    }
-  }
-
-  getConfiguration = () => {
-    var config = {
-      apiKey: this.state.apiKey,
-      autoTrackSessions: false
-    }
-
-    if (this.state.notifyEndpoint && this.state.sessionsEndpoint) {
-      config.endpoints = {
-        notify: this.state.notifyEndpoint,
-        sessions: this.state.sessionsEndpoint
-      }
-    }
-    return config
-  }
-
-  setScenario = newScenario => {
-    this.setState(() => ({ currentScenario: newScenario }))
-  }
-
-  setApiKey = newApiKey => {
-    this.setState(() => ({ apiKey: newApiKey }))
-  }
-
-  setNotifyEndpoint = newNotifyEndpoint => {
-    this.setState(() => ({ notifyEndpoint: newNotifyEndpoint }))
-  }
-
-  setSessionsEndpoint = newSessionsEndpoint => {
-    this.setState(() => ({ sessionsEndpoint: newSessionsEndpoint }))
-  }
-
-  useRealEndpoints = () => {
-    this.setState({ notifyEndpoint: 'https://notify.bugsnag.com' })
-    this.setState({ sessionsEndpoint: 'https://sessions.bugsnag.com' })
-  }
-
-  clearPersistentData = () => {
-    NativeModules.BugsnagTestInterface.clearPersistentData()
-  }
-
-  pollBugsnagStarted = () => {
-    setTimeout(() => {
-      if (Bugsnag.isStarted()) {
-        this.setState(() => ({ bugsnagStarted: true }))
-      } else {
-        this.pollBugsnagStarted()
-      }
-    }, 50)
-  }
+import { launchScenario } from './lib/ScenarioLauncher'
 
-  startScenario = () => {
-    console.log(`Running scenario: ${this.state.currentScenario}`)
-    const scenarioName = this.state.currentScenario
-    const configuration = this.getConfiguration()
-    const jsConfig = defaultJsConfig()
-    const scenario = new Scenarios[scenarioName](configuration, jsConfig)
-    console.log(`  with config: ${JSON.stringify(configuration)} (native) and ${JSON.stringify(jsConfig)} (js)`)
-    this.setState({ scenario: scenario })
-    this.pollBugsnagStarted()
-    scenario.run()
-  }
+const App = () => {
+  const [scenario, setScenario] = useState(null)
 
-  startBugsnag = () => {
-    console.log(`Starting Bugsnag for scenario: ${this.state.currentScenario}`)
-    const scenarioName = this.state.currentScenario
-    const configuration = this.getConfiguration()
-    const jsConfig = defaultJsConfig()
-    // eslint-disable-next-line no-new
-    new Scenarios[scenarioName](configuration, jsConfig)
-    console.log(`  with config: ${JSON.stringify(configuration)} (native) and ${JSON.stringify(jsConfig)} (js)`)
-    NativeModules.BugsnagTestInterface.startBugsnag(configuration)
-      .then(() => {
-        Bugsnag.start(jsConfig)
-      })
-  }
+  useEffect(() => {
+    launchScenario(setScenario)
+  }, [])
 
-  waiting () {
-    return (
-      <View style={styles.container}>
-        <View style={styles.child}>
+  return (
+    scenario ? scenario() : (
+      <SafeAreaView style={styles.container}>
+        <View>
           <Text>React Navigation Test App</Text>
-          <TextInput style={styles.textInput}
-            placeholder='Scenario Name'
-            accessibilityLabel='scenario_name'
-            onChangeText={this.setScenario}/>
-
-          <Button style={styles.clickyButton}
-            accessibilityLabel='clear_data'
-            title='Clear Persistent Data'
-            onPress={this.clearPersistentData}/>
-          <Button style={styles.clickyButton}
-            accessibilityLabel='start_bugsnag'
-            title='Start Bugsnag only'
-            onPress={this.startBugsnag}/>
-          <Button style={styles.clickyButton}
-            accessibilityLabel='run_scenario'
-            title='Run scenario'
-            onPress={this.startScenario}/>
-
-          <Text>Configuration</Text>
-          <TextInput placeholder='Notify endpoint'
-            style={styles.textInput}
-            accessibilityLabel='notify_endpoint'
-            value={this.state.notifyEndpoint}
-            onChangeText={this.setNotifyEndpoint}/>
-          <TextInput placeholder='Sessions endpoint'
-            style={styles.textInput}
-            accessibilityLabel='sessions_endpoint'
-            value={this.state.sessionsEndpoint}
-            onChangeText={this.setSessionsEndpoint}/>
-          <TextInput placeholder='API key'
-            style={styles.textInput}
-            accessibilityLabel='api_key'
-            value={this.state.apiKey}
-            onChangeText={this.setApiKey}/>
-          <Button style={styles.clickyButton}
-            accessibilityLabel='use_dashboard_endpoints'
-            title='Use dashboard endpoints'
-            onPress={this.useRealEndpoints}/>
         </View>
-      </View>
+      </SafeAreaView>
     )
-  }
-
-  ready () {
-    const BugsnagNavigationContainer = Bugsnag.getPlugin('reactNavigation').createNavigationContainer(NavigationContainer)
-    return this.state.bugsnagStarted ? (
-      <BugsnagNavigationContainer>
-        {this.state.scenario.view()}
-      </BugsnagNavigationContainer>
-    ) : null
-  }
-
-  render () {
-    return this.state.scenario
-      ? this.ready()
-      : this.waiting()
-  }
-};
+  )
+}
 
 const styles = StyleSheet.create({
   container: {
-    flexDirection: 'column',
-    flex: 1,
-    backgroundColor: '#eaefea',
-    alignItems: 'center',
-    justifyContent: 'center',
-    paddingTop: '15%'
-  },
-  child: {
     flex: 1
-  },
-  textInput: {
-    backgroundColor: '#fff',
-    borderWidth: 0.5,
-    borderColor: '#000',
-    borderRadius: 4,
-    margin: 5,
-    padding: 5
-  },
-  clickyButton: {
-    backgroundColor: '#acbcef',
-    borderWidth: 0.5,
-    borderColor: '#000',
-    borderRadius: 4,
-    margin: 5,
-    padding: 5
   }
 })
+
+export default App
diff --git a/test/react-native/features/fixtures/app/react_navigation_js/app/lib/CommandRunner.js b/test/react-native/features/fixtures/app/react_navigation_js/app/lib/CommandRunner.js
new file mode 100644
index 0000000000..c1a217cfd9
--- /dev/null
+++ b/test/react-native/features/fixtures/app/react_navigation_js/app/lib/CommandRunner.js
@@ -0,0 +1,38 @@
+import { getMazeRunnerAddress } from './ConfigFileReader'
+
+const INTERVAL = 500
+
+let mazeAddress
+
+const delay = ms => new Promise(resolve => setTimeout(resolve, ms))
+
+export async function getCurrentCommand () {
+  if (!mazeAddress) {
+    mazeAddress = await getMazeRunnerAddress()
+  }
+
+  const url = `http://${mazeAddress}/command`
+  console.error(`[Bugsnag CommandRunner] Fetching command from ${url}`)
+
+  while (true) {
+    try {
+      // eslint-disable-next-line no-undef
+      const response = await fetch(url)
+      const text = await response.text()
+      console.error(`[Bugsnag CommandRunner] Response from maze runner: ${text}`)
+
+      const command = JSON.parse(text)
+
+      // keep polling until a scenario command is received
+      if (command.action !== 'noop') {
+        console.error(`[Bugsnag CommandRunner] Received command from maze runner: ${JSON.stringify(command)}`)
+
+        return command
+      }
+    } catch (err) {
+      console.error(`[Bugsnag CommandRunner] Error fetching command from maze runner: ${err.message}`, err)
+    }
+
+    await delay(INTERVAL)
+  }
+}
diff --git a/test/react-native/features/fixtures/app/react_navigation_js/app/lib/ConfigFileReader.js b/test/react-native/features/fixtures/app/react_navigation_js/app/lib/ConfigFileReader.js
new file mode 100644
index 0000000000..b41f83a2a0
--- /dev/null
+++ b/test/react-native/features/fixtures/app/react_navigation_js/app/lib/ConfigFileReader.js
@@ -0,0 +1,32 @@
+import { Platform } from 'react-native'
+import { Dirs, FileSystem } from 'react-native-file-access'
+
+const TIMEOUT = 60000
+
+const delay = ms => new Promise(resolve => setTimeout(resolve, ms))
+
+const getMazeRunnerAddress = async () => {
+  let configFilePath
+  const startTime = Date.now()
+
+  // poll for the config file to exist
+  while (Date.now() - startTime < TIMEOUT) {
+    const configFileDir = Platform.OS === 'android' ? '/data/local/tmp' : Dirs.DocumentDir
+    configFilePath = `${configFileDir}/fixture_config.json`
+    const configFileExists = await FileSystem.exists(configFilePath)
+
+    if (configFileExists) {
+      const configFile = await FileSystem.readFile(configFilePath)
+      console.error(`[Bugsnag ConfigFileReader] found config file at '${configFilePath}'. contents: ${configFile}`)
+      const config = JSON.parse(configFile)
+      return `${config.maze_address}`
+    }
+
+    await delay(500)
+  }
+
+  console.error(`[Bugsnag ConfigFileReader] no config file found at ${configFilePath}, falling back to 'localhost:9339'`)
+  return 'localhost:9339'
+}
+
+module.exports.getMazeRunnerAddress = getMazeRunnerAddress
diff --git a/test/react-native/features/fixtures/app/react_navigation_js/app/lib/ScenarioLauncher.js b/test/react-native/features/fixtures/app/react_navigation_js/app/lib/ScenarioLauncher.js
new file mode 100644
index 0000000000..4d232b6b95
--- /dev/null
+++ b/test/react-native/features/fixtures/app/react_navigation_js/app/lib/ScenarioLauncher.js
@@ -0,0 +1,101 @@
+import * as Scenarios from '../Scenarios'
+import { getCurrentCommand } from './CommandRunner'
+import { NativeModules } from 'react-native'
+import Bugsnag from '@bugsnag/react-native'
+
+async function runScenario (scenarioName, apiKey, notifyEndpoint, sessionEndpoint, scenarioData, setScenario) {
+  console.error(`[Bugsnag ScenarioLauncher] running scenario: ${scenarioName}`)
+
+  const nativeConfig = {
+    apiKey,
+    autoTrackSessions: false,
+    endpoints: {
+      notify: notifyEndpoint,
+      sessions: sessionEndpoint
+    }
+  }
+
+  const jsConfig = {}
+
+  // create the scenario and allow it to modify the configuration
+  const scenario = new Scenarios[scenarioName](nativeConfig, jsConfig, scenarioData)
+
+  console.error(`[Bugsnag ScenarioLauncher] with config: ${JSON.stringify(nativeConfig)} (native) and ${JSON.stringify(jsConfig)} (js)`)
+
+  // clear persistent data
+  console.error('[Bugsnag ScenarioLauncher] clearing persistent data')
+  NativeModules.BugsnagTestInterface.clearPersistentData()
+
+  // start the native client
+  console.error('[Bugsnag ScenarioLauncher] starting native Bugsnag')
+  await NativeModules.BugsnagTestInterface.startBugsnag(nativeConfig)
+
+  // start the js client
+  console.error('[Bugsnag ScenarioLauncher] starting js Bugsnag')
+  Bugsnag.start(jsConfig)
+
+  // run the scenario
+  console.error('launching scenario')
+  setTimeout(() => {
+    scenario.run()
+    if (typeof setScenario === 'function' && scenario.view) setScenario(scenario.view)
+  }, 1)
+}
+
+async function startBugsnag (scenarioName, apiKey, notifyEndpoint, sessionEndpoint, scenarioData) {
+  console.error(`[Bugsnag ScenarioLauncher] starting Bugsnag for scenario: ${scenarioName}`)
+  const nativeConfig = {
+    apiKey,
+    autoTrackSessions: false,
+    endpoints: {
+      notify: notifyEndpoint,
+      sessions: sessionEndpoint
+    }
+  }
+
+  const jsConfig = {}
+
+  // create the scenario and allow it to modify the configuration
+  // eslint-disable-next-line no-unused-vars
+  const scenario = new Scenarios[scenarioName](nativeConfig, jsConfig, scenarioData)
+
+  console.error(`[Bugsnag ScenarioLauncher] with config: ${JSON.stringify(nativeConfig)} (native) and ${JSON.stringify(jsConfig)} (js)`)
+
+  // start the native client
+  console.error('[Bugsnag ScenarioLauncher] starting native Bugsnag')
+  await NativeModules.BugsnagTestInterface.startBugsnag(nativeConfig)
+
+  // start the js client
+  console.error('[Bugsnag ScenarioLauncher] starting js Bugsnag')
+  Bugsnag.start(jsConfig)
+}
+
+export async function launchScenario (setScenario) {
+  const command = await getCurrentCommand()
+
+  switch (command.action) {
+    case 'run-scenario':
+      // eslint-disable-next-line no-return-await
+      return await runScenario(
+        command.scenario_name,
+        command.api_key,
+        command.notify,
+        command.sessions,
+        command.scenario_data,
+        setScenario
+      )
+
+    case 'start-bugsnag':
+      // eslint-disable-next-line no-return-await
+      return await startBugsnag(
+        command.scenario_name,
+        command.api_key,
+        command.notify,
+        command.sessions,
+        command.scenario_data
+      )
+
+    default:
+      throw new Error(`Unknown action '${command.action}'`)
+  }
+}
diff --git a/test/react-native/features/fixtures/app/react_navigation_js/app/scenarios/ReactNavigationBreadcrumbsDisabledScenario.js b/test/react-native/features/fixtures/app/react_navigation_js/app/scenarios/ReactNavigationBreadcrumbsDisabledScenario.js
index d721f34ecb..f069dee90c 100644
--- a/test/react-native/features/fixtures/app/react_navigation_js/app/scenarios/ReactNavigationBreadcrumbsDisabledScenario.js
+++ b/test/react-native/features/fixtures/app/react_navigation_js/app/scenarios/ReactNavigationBreadcrumbsDisabledScenario.js
@@ -1,28 +1,34 @@
 import Scenario from './Scenario'
 import Bugsnag from '@bugsnag/react-native'
+import BugsnagPluginReactNavigation from '@bugsnag/plugin-react-navigation'
 import * as React from 'react'
 import { View, Text, Button } from 'react-native'
 import { createStackNavigator } from '@react-navigation/stack'
+import { NavigationContainer } from '@react-navigation/native'
 
 export class ReactNavigationBreadcrumbsDisabledScenario extends Scenario {
-  constructor (configuration, _jsConfig) {
+  constructor (configuration, jsConfig) {
     super()
     configuration.enabledBreadcrumbTypes = ['process', 'request', 'log']
+    jsConfig.plugins = [new BugsnagPluginReactNavigation()]
   }
 
   view () {
+    const BugsnagNavigationContainer = Bugsnag.getPlugin('reactNavigation').createNavigationContainer(NavigationContainer)
     const Stack = createStackNavigator()
     return (
-      <Stack.Navigator>
-        <Stack.Screen
-          name="Home"
-          component={ HomeScreen }
-        />
-        <Stack.Screen
-          name="Details"
-          component={ DetailsScreen }
-        />
-      </Stack.Navigator>
+      <BugsnagNavigationContainer>
+        <Stack.Navigator>
+          <Stack.Screen
+            name="Home"
+            component={ HomeScreen }
+          />
+          <Stack.Screen
+            name="Details"
+            component={ DetailsScreen }
+          />
+        </Stack.Navigator>
+      </BugsnagNavigationContainer>
     )
   }
 
diff --git a/test/react-native/features/fixtures/app/react_navigation_js/app/scenarios/ReactNavigationBreadcrumbsEnabledScenario.js b/test/react-native/features/fixtures/app/react_navigation_js/app/scenarios/ReactNavigationBreadcrumbsEnabledScenario.js
index 5554af37e8..3233c96486 100644
--- a/test/react-native/features/fixtures/app/react_navigation_js/app/scenarios/ReactNavigationBreadcrumbsEnabledScenario.js
+++ b/test/react-native/features/fixtures/app/react_navigation_js/app/scenarios/ReactNavigationBreadcrumbsEnabledScenario.js
@@ -1,27 +1,33 @@
 import Scenario from './Scenario'
 import Bugsnag from '@bugsnag/react-native'
+import BugsnagPluginReactNavigation from '@bugsnag/plugin-react-navigation'
 import * as React from 'react'
 import { View, Text, Button } from 'react-native'
 import { createStackNavigator } from '@react-navigation/stack'
+import { NavigationContainer } from '@react-navigation/native'
 
 export class ReactNavigationBreadcrumbsEnabledScenario extends Scenario {
-  constructor (_configuration, _jsConfig) {
+  constructor (_configuration, jsConfig) {
     super()
+    jsConfig.plugins = [new BugsnagPluginReactNavigation()]
   }
 
   view () {
+    const BugsnagNavigationContainer = Bugsnag.getPlugin('reactNavigation').createNavigationContainer(NavigationContainer)
     const Stack = createStackNavigator()
     return (
-      <Stack.Navigator>
-        <Stack.Screen
-          name="Home"
-          component={ HomeScreen }
-        />
-        <Stack.Screen
-          name="Details"
-          component={ DetailsScreen }
-        />
-      </Stack.Navigator>
+      <BugsnagNavigationContainer>
+        <Stack.Navigator>
+          <Stack.Screen
+            name="Home"
+            component={ HomeScreen }
+          />
+          <Stack.Screen
+            name="Details"
+            component={ DetailsScreen }
+          />
+        </Stack.Navigator>
+      </BugsnagNavigationContainer>
     )
   }
 
diff --git a/test/react-native/features/navigation.feature b/test/react-native/features/navigation.feature
index b142b809f0..61d3a7c118 100644
--- a/test/react-native/features/navigation.feature
+++ b/test/react-native/features/navigation.feature
@@ -2,7 +2,7 @@
 Feature: Navigation plugin features
 
 Scenario: Navigating screens causes breadcrumbs and context to be updated
-  When I run the navigation scenario "ReactNavigationBreadcrumbsEnabledScenario"
+  When I run "ReactNavigationBreadcrumbsEnabledScenario"
   And I trigger a handled error
   And I wait to receive an error
   Then the exception "message" equals "HomeNavigationError"
@@ -22,7 +22,7 @@ Scenario: Navigating screens causes breadcrumbs and context to be updated
   When I trigger an unhandled error
   And I wait for 5 seconds
   And I relaunch the app after a crash
-  And I configure Bugsnag for the navigation scenario "ReactNavigationBreadcrumbsEnabledScenario"
+  And I configure Bugsnag for "ReactNavigationBreadcrumbsEnabledScenario"
   And I wait to receive an error
   Then the exception "message" equals "DetailsNavigationUnhandledError"
   And the event "unhandled" is true
@@ -31,7 +31,7 @@ Scenario: Navigating screens causes breadcrumbs and context to be updated
   And the event contains a breadcrumb matching the JSON fixture in "features/fixtures/expected_breadcrumbs/HomeToDetailsNavigation.json"
 
 Scenario: Navigating when navigation breadcrumbs are disabled only updates context
-  When I run the navigation scenario "ReactNavigationBreadcrumbsDisabledScenario"
+  When I run "ReactNavigationBreadcrumbsDisabledScenario"
   And I trigger a handled error
   And I wait to receive an error
   Then the exception "message" equals "HomeNavigationError"
@@ -49,7 +49,7 @@ Scenario: Navigating when navigation breadcrumbs are disabled only updates conte
 
   When I trigger an unhandled error
   And I relaunch the app after a crash
-  And I configure Bugsnag for the navigation scenario "ReactNavigationBreadcrumbsDisabledScenario"
+  And I configure Bugsnag for "ReactNavigationBreadcrumbsDisabledScenario"
   And I wait to receive an error
   Then the exception "message" equals "DetailsNavigationUnhandledError"
   And the event "unhandled" is true