File size: 9,944 Bytes
e3f0784
 
 
9a6b7dc
e4a1a2b
a962ffe
 
9a6b7dc
897c1d2
 
9a6b7dc
897c1d2
e3f0784
00eef23
9a6b7dc
897c1d2
 
9a6b7dc
897c1d2
e4a1a2b
a2dd0df
897c1d2
e4a1a2b
897c1d2
e4a1a2b
 
 
 
 
897c1d2
e4a1a2b
897c1d2
 
e4a1a2b
897c1d2
e4a1a2b
 
 
 
897c1d2
e4a1a2b
897c1d2
 
e4a1a2b
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
897c1d2
9a6b7dc
 
 
 
e4a1a2b
 
9a6b7dc
 
 
 
897c1d2
 
9a6b7dc
 
e4a1a2b
 
e3f0784
 
 
 
 
 
 
e4a1a2b
9a6b7dc
 
e3f0784
e4a1a2b
 
9a6b7dc
e4a1a2b
 
e3f0784
e4a1a2b
 
897c1d2
 
e4a1a2b
897c1d2
 
 
 
 
e3f0784
3eb1a38
9a6b7dc
e4a1a2b
e3f0784
 
 
a2dd0df
 
9a6b7dc
 
 
897c1d2
9a6b7dc
897c1d2
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
e3f0784
897c1d2
 
 
 
 
 
9a6b7dc
 
 
 
897c1d2
9a6b7dc
 
897c1d2
9a6b7dc
 
 
00eef23
 
9a6b7dc
00eef23
 
c0c66b4
00eef23
9a6b7dc
00eef23
e3f0784
9a6b7dc
00eef23
9a6b7dc
 
c0c66b4
9a6b7dc
 
 
e4a1a2b
897c1d2
9a6b7dc
 
 
 
 
c0c66b4
9a6b7dc
 
 
 
897c1d2
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
e4a1a2b
897c1d2
 
 
 
 
 
 
 
 
 
 
9a6b7dc
 
e4a1a2b
9a6b7dc
 
 
 
 
 
 
897c1d2
9a6b7dc
 
 
897c1d2
 
 
 
 
 
9a6b7dc
 
e4a1a2b
 
9a6b7dc
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
import json
from typing import Dict

from db.schema import Feedback, Response
from db.crud import ingest, read
import pandas as pd
import streamlit as st
from datetime import datetime
import os
from dotenv import load_dotenv

load_dotenv()
VALIDATION_CODE = os.getenv("VALIDATION_CODE")


class SurveyState:
    """Class to handle survey state management"""

    def __init__(self):
        pass

    def save_state(self, prolific_id: str, current_state: Dict) -> None:
        """Save current state to Firebase"""
        try:
            # Saving to Firebase via the ingest function
            feedback = Feedback(user_id=prolific_id, time_stamp=datetime.now().isoformat(),
                                responses=current_state["responses"])
            ingest(feedback)  # Ingest feedback to Firebase
            st.success("Your progress has been saved! You can continue later.")
        except Exception as e:
            st.error(f"Error saving state to Firebase: {e}")

    def load_state(self, prolific_id: str) -> Dict:
        """Load state for a specific user from Firebase"""
        try:
            # Retrieve the state from Firebase for the given Prolific ID
            state = self.get_state_from_firebase(prolific_id)
            if state:
                return state
        except Exception as e:
            st.error(f"Error loading state from Firebase: {e}")
        return {}

    class SurveyState:
        """Class to handle survey state management"""

        def __init__(self):
            pass

        @staticmethod
        def save_state(self, username: str, current_state: Dict) -> None:
            """Save current state to Firebase"""
            try:
                # Saving to Firebase via the ingest function
                feedback = Feedback(user_id=username, time_stamp=datetime.now().isoformat(),
                                    responses=current_state["responses"])
                ingest(feedback)  # Ingest feedback to Firebase
                st.success("Your progress has been saved! You can continue later.")
            except Exception as e:
                st.error(f"Error saving state to Firebase: {e}")

        def load_state(self, username: str) -> Dict:
            """Load state for a specific user from Firebase"""
            try:
                # Retrieve the state from Firebase for the given Prolific ID
                state = self.get_state_from_firebase(username)
                if state:
                    return state
            except Exception as e:
                st.error(f"Error loading state from Firebase: {e}")
            return {}

        def get_state_from_firebase(self, username: str) -> Dict:
            # Placeholder method to simulate getting state from Firebase
            # In practice, you will query Firebase to get the current state
            data = read(username)
            return {}


def initialization():
    """Initialize session state variables."""
    if "current_index" not in st.session_state:
        st.session_state.current_index = 0
    if "username" not in st.session_state:
        st.session_state.username = None
    if "responses" not in st.session_state:
        st.session_state.responses = []
    if "completed" not in st.session_state:
        st.session_state.completed = False
    if "survey_state" not in st.session_state:
        st.session_state.survey_state = SurveyState()


def validate_username(username: str) -> bool:
    return bool(username.strip())


def validate_code(input_code: str) -> bool:
    """Validate the entered code against the hardcoded validation code"""
    return input_code.strip() == VALIDATION_CODE


def username_screen():
    """Display the Prolific ID entry screen."""
    st.title("Welcome to the Feedback Survey")

    username_input = st.text_input("Enter your First name and press TAB:")
    validation_code_input = st.text_input("Enter the validation code to proceed and press ENTER:")

    next_button = st.button("Next")
    if (username_input and validation_code_input) or next_button:
        # Validate Prolific ID and code
        if validate_username(username_input) and validate_code(validation_code_input):
            st.session_state.username = username_input

            # Load previous state if exists
            saved_state = st.session_state.survey_state.load_state(username_input)
            if saved_state:
                st.session_state.current_index = saved_state.get('current_index', 0)
                st.session_state.responses = saved_state.get('responses', [])
                st.success("Previous progress loaded! Continuing from where you left off.")
            else:
                st.success("Prolific ID and code validated! Starting new survey.")
            st.rerun()
        else:
            if not validate_username(username_input):
                st.warning("Invalid Prolific ID. Please check and try again.")
            if not validate_code(validation_code_input):
                st.warning("Invalid validation code. Please check and try again.")


def questions_screen(data):
    """Display the questions screen."""
    current_index = st.session_state.current_index
    config = data.iloc[current_index]

    # Progress bar
    progress = (current_index + 1) / len(data)
    st.progress(progress)
    st.write(f"Question {current_index + 1} of {len(data)}")

    st.subheader(f"Config ID: {config['config_id']}")

    # Create tabs for better organization
    context_tab, questions_tab = st.tabs(["Context", "Questions"])

    with context_tab:
        st.write(f"**Persona:** {config['persona']}")
        st.write(f"**Filters:** {config['filters']}")
        st.write(f"**Cities:** {config['city']}")

        # Expandable context
        with st.expander("Show Context", expanded=False):
            st.write(config['context'])

    options = [0, 1, 2, 3, 4, 5]

    with questions_tab:
        st.write(f"**Query_v:** {config['query_v']}")
        rating_v = st.radio("Rate this config:", options, key=f"rating_v_{current_index}")

        st.write(f"**Query_p0:** {config['query_p0']}")
        rating_p0 = st.radio("Rate this config:", options, key=f"rating_p0_{current_index}")

        st.write(f"**Query_p1:** {config['query_p1']}")
        rating_p1 = st.radio("Rate this config:", options, key=f"rating_p1_{current_index}")

        comment = st.text_area("Comments (Optional):")
    response = Response(config_id=config["config_id"],
                        rating_v=rating_v, rating_p0=rating_p0, rating_p1=rating_p1,
                        comment=comment, timestamp=datetime.now().isoformat())
    print(response)
    if len(st.session_state.responses) > current_index:
        st.session_state.responses[current_index] = response
    else:
        st.session_state.responses.append(response)
    navigation_buttons(data, rating_v, rating_p0, rating_p1)


def navigation_buttons(data, rating_v, rating_p0, rating_p1):
    """Display navigation buttons."""
    current_index = st.session_state.current_index

    col1, col2, col3 = st.columns([1, 1, 2])

    with col1:  # Back button
        if st.button("Back") and current_index > 0:
            st.session_state.current_index -= 1
            st.rerun()

    with col2:  # Next button
        if st.button("Next"):
            if rating_v == 0 or rating_p0 == 0 or rating_p1 == 0:
                st.warning("Please provide a rating before proceeding.")
            else:
                if current_index < len(data) - 1:
                    st.session_state.current_index += 1
                    st.rerun()
                else:
                    feedback = Feedback(
                        id=current_index + 1,
                        user_id=st.session_state.username,
                        time_stamp=datetime.now().isoformat(),
                        responses=st.session_state.responses,
                    )
                    try:
                        ingest(feedback)
                        st.session_state.completed = True
                        st.rerun()
                    except Exception as e:
                        st.error(f"An error occurred while submitting feedback: {e}")


def exit_screen():
    """Display exit screen"""
    st.markdown("""
        <div class='exit-container'>
            <h1>Thank you for participating!</h1>
            <p>Your responses have been saved successfully.</p>
            <p>You can safely close this window or start a new survey.</p>
        </div>
    """, unsafe_allow_html=True)

    if st.button("Start New Survey"):
        reset_survey()
        st.rerun()


def submit_survey():
    """Submit the complete survey"""
    try:
        feedback = Feedback(
            id=st.session_state.current_index,
            user_id=st.session_state.username,
            time_stamp=datetime.now().isoformat(),
            responses=st.session_state.responses,
        )
        print(feedback)
        ingest(feedback)
        st.session_state.completed = True
        st.rerun()
    except Exception as e:
        st.error(f"An error occurred while submitting feedback: {e}")


def reset_survey():
    """Reset the survey state to start over."""
    st.session_state.username = None
    st.session_state.current_index = 0
    st.session_state.responses = []
    st.session_state.completed = False


def ui():
    """Main function to control the survey flow."""
    data = pd.read_csv("data/gemini_results_subset.csv")[:3]
    initialization()

    if st.session_state.completed:
        # st.title("Survey Completed")
        # st.success("Thank you! Your survey has been submitted successfully.")
        # if st.button("Start New Survey"):
        #     reset_survey()
        #     st.rerun()
        exit_screen()
        return

    if st.session_state.username is None:
        username_screen()
    else:
        questions_screen(data)


if __name__ == "__main__":
    ui()