Merge pull request #1728 from StoDevX/sis-disclaimer

Add disclaimers to SIS' Balances view

Author: hawkrives

source/flux/init.js

@@ -11,17 +11,10 @@ import {
   setLoginCredentials,
   validateLoginCredentials,
   loadFeedbackStatus,
+  loadAcknowledgement,
 } from './parts/settings'
 import {updateBalances, updateCourses} from './parts/sis'
 
-function homescreen(store) {
-  store.dispatch(loadHomescreenOrder())
-}
-
-function feedbackOptOutStatus(store) {
-  store.dispatch(loadFeedbackStatus())
-}
-
 function loginCredentials(store) {
   loadLoginCredentials().then(({username, password} = {}) => {
     if (!username || !password) return
@@ -36,14 +29,6 @@ async function validateOlafCredentials(store) {
   store.dispatch(validateLoginCredentials(username, password))
 }
 
-function loadBalances(store) {
-  store.dispatch(updateBalances(false))
-}
-
-function loadCourses(store) {
-  store.dispatch(updateCourses(false))
-}
-
 function netInfoIsConnected(store) {
   function updateConnectionStatus(isConnected) {
     store.dispatch(updateOnlineStatus(isConnected))
@@ -58,15 +43,16 @@ export async function init(store: {dispatch: any}) {
   // and those that do.
 
   // kick off the parts that don't care about network
-  homescreen(store)
-  feedbackOptOutStatus(store)
+  store.dispatch(loadHomescreenOrder())
+  store.dispatch(loadFeedbackStatus())
+  store.dispatch(loadAcknowledgement())
   loginCredentials(store)
 
   // wait for our first connection check to happen
   await netInfoIsConnected(store)
 
   // then go do the network stuff
   validateOlafCredentials(store)
-  loadBalances(store)
-  loadCourses(store)
+  store.dispatch(updateBalances(false))
+  store.dispatch(updateCourses(false))
 }

source/flux/parts/settings.js

@@ -9,7 +9,12 @@ import {
   clearLoginCredentials,
 } from '../../lib/login'
 
-import {setAnalyticsOptOut, getAnalyticsOptOut} from '../../lib/storage'
+import {
+  setAnalyticsOptOut,
+  getAnalyticsOptOut,
+  getAcknowledgementStatus,
+  setAcknowledgementStatus,
+} from '../../lib/storage'
 
 import {updateBalances} from './sis'
 
@@ -25,6 +30,7 @@ export const CREDENTIALS_VALIDATE_FAILURE =
   'settings/CREDENTIALS_VALIDATE_FAILURE'
 export const SET_FEEDBACK = 'settings/SET_FEEDBACK'
 export const CHANGE_THEME = 'settings/CHANGE_THEME'
+export const SIS_ALERT_SEEN = 'settings/SIS_ALERT_SEEN'
 
 export async function setFeedbackStatus(feedbackEnabled: boolean) {
   await setAnalyticsOptOut(feedbackEnabled)
@@ -35,6 +41,15 @@ export function loadFeedbackStatus() {
   return {type: SET_FEEDBACK, payload: getAnalyticsOptOut()}
 }
 
+export function loadAcknowledgement() {
+  return {type: SIS_ALERT_SEEN, payload: getAcknowledgementStatus()}
+}
+
+export async function hasSeenAcknowledgement() {
+  await setAcknowledgementStatus(true)
+  return {type: SIS_ALERT_SEEN, payload: true}
+}
+
 export async function setLoginCredentials(username: string, password: string) {
   await saveLoginCredentials(username, password)
   return {type: SET_LOGIN_CREDENTIALS, payload: {username, password}}
@@ -155,6 +170,7 @@ const initialSettingsState: SettingsState = {
 
   credentials: initialCredentialsState,
   feedbackDisabled: false,
+  unofficiallyAcknowledged: false,
 }
 
 export function settings(
@@ -176,6 +192,9 @@ export function settings(
     case SET_FEEDBACK:
       return {...state, feedbackDisabled: payload}
 
+    case SIS_ALERT_SEEN:
+      return {...state, unofficiallyAcknowledged: payload}
+
     default:
       return state
   }

source/lib/storage.js

@@ -35,6 +35,14 @@ export function getHomescreenOrder(): Promise<string[]> {
   return getItem(homescreenOrderKey)
 }
 
+const acknowledgementStatusKey = 'settings:ackd'
+export function setAcknowledgementStatus(status: boolean) {
+  return setItem(acknowledgementStatusKey, status)
+}
+export function getAcknowledgementStatus(): Promise<?boolean> {
+  return getItem(acknowledgementStatusKey)
+}
+
 /// MARK: Credentials
 
 const tokenValidKey = 'credentials:valid'

source/views/sis/balances.js

@@ -1,16 +1,20 @@
-/**
- * @flow
- * All About Olaf
- * Balances page
- */
+// @flow
 
 import React from 'react'
-import {StyleSheet, ScrollView, View, Text, RefreshControl} from 'react-native'
+import {
+  StyleSheet,
+  ScrollView,
+  View,
+  Text,
+  RefreshControl,
+  Alert,
+} from 'react-native'
 import {TabBarIcon} from '../components/tabbar-icon'
 import {connect} from 'react-redux'
 import {Cell, TableView, Section} from 'react-native-tableview-simple'
 import type {LoginStateType} from '../../flux/parts/settings'
 
+import {hasSeenAcknowledgement} from '../../flux/parts/settings'
 import {updateBalances} from '../../flux/parts/sis'
 
 import delay from 'delay'
@@ -19,24 +23,34 @@ import * as c from '../components/colors'
 
 import type {TopLevelViewPropsType} from '../types'
 
-class BalancesView extends React.Component {
+const DISCLAIMER = 'This data may be outdated or otherwise inaccurate.'
+const LONG_DISCLAIMER =
+  'This data may be inaccurate.\nBon Appétit is always right.\nThis app is unofficial.'
+
+type Props = TopLevelViewPropsType & {
+  flex: ?number,
+  ole: ?number,
+  print: ?number,
+  weeklyMeals: ?number,
+  dailyMeals: ?number,
+  loginState: LoginStateType,
+  message: ?string,
+  alertSeen: boolean,
+
+  hasSeenAcknowledgement: () => any,
+  updateBalances: boolean => any,
+}
+
+type State = {
+  loading: boolean,
+}
+
+class BalancesView extends React.PureComponent<void, Props, State> {
   static navigationOptions = {
     tabBarLabel: 'Balances',
     tabBarIcon: TabBarIcon('card'),
   }
 
-  props: TopLevelViewPropsType & {
-    flex: ?number,
-    ole: ?number,
-    print: ?number,
-    weeklyMeals: ?number,
-    dailyMeals: ?number,
-    loginState: LoginStateType,
-    message: ?string,
-
-    updateBalances: boolean => any,
-  }
-
   state = {
     loading: false,
   }
@@ -47,27 +61,40 @@ class BalancesView extends React.Component {
     this.refresh()
   }
 
+  componentDidMount() {
+    if (!this.props.alertSeen) {
+      Alert.alert('', LONG_DISCLAIMER, [
+        {text: 'I Disagree', onPress: this.goBack, style: 'cancel'},
+        {text: 'Okay', onPress: this.props.hasSeenAcknowledgement},
+      ])
+    }
+  }
+
   refresh = async () => {
     let start = Date.now()
-    this.setState({loading: true})
+    this.setState(() => ({loading: true}))
 
     await this.fetchData()
 
     // wait 0.5 seconds – if we let it go at normal speed, it feels broken.
     let elapsed = Date.now() - start
     await delay(500 - elapsed)
 
-    this.setState({loading: false})
+    this.setState(() => ({loading: false}))
   }
 
   fetchData = async () => {
-    await Promise.all([this.props.updateBalances(true)])
+    await this.props.updateBalances(true)
   }
 
   openSettings = () => {
     this.props.navigation.navigate('SettingsView')
   }
 
+  goBack = () => {
+    this.props.navigation.goBack(null)
+  }
+
   render() {
     let {flex, ole, print, dailyMeals, weeklyMeals} = this.props
     let {loading} = this.state
@@ -83,7 +110,7 @@ class BalancesView extends React.Component {
         }
       >
         <TableView>
-          <Section header="BALANCES">
+          <Section header="BALANCES" footer={DISCLAIMER}>
             <View style={styles.balancesRow}>
               <FormattedValueCell
                 label="Flex"
@@ -109,7 +136,7 @@ class BalancesView extends React.Component {
             </View>
           </Section>
 
-          <Section header="MEAL PLAN">
+          <Section header="MEAL PLAN" footer={DISCLAIMER}>
             <View style={styles.balancesRow}>
               <FormattedValueCell
                 label="Daily Meals Left"
@@ -150,26 +177,28 @@ class BalancesView extends React.Component {
   }
 }
 
-function mapStateToProps(state) {
+function mapState(state) {
   return {
     flex: state.sis.balances.flex,
     ole: state.sis.balances.ole,
     print: state.sis.balances.print,
     weeklyMeals: state.sis.balances.weekly,
     dailyMeals: state.sis.balances.daily,
     message: state.sis.balances.message,
+    alertSeen: state.settings.unofficiallyAcknowledged,
 
     loginState: state.settings.credentials.state,
   }
 }
 
-function mapDispatchToProps(dispatch) {
+function mapDispatch(dispatch) {
   return {
     updateBalances: force => dispatch(updateBalances(force)),
+    hasSeenAcknowledgement: () => dispatch(hasSeenAcknowledgement()),
   }
 }
 
-export default connect(mapStateToProps, mapDispatchToProps)(BalancesView)
+export default connect(mapState, mapDispatch)(BalancesView)
 
 let cellMargin = 10
 let cellSidePadding = 10