Skip to content

Commit

Permalink
Introduce context fields for new events
Browse files Browse the repository at this point in the history
  • Loading branch information
theMr17 committed Feb 8, 2024
1 parent 604b609 commit 7fb6123
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 37 deletions.
18 changes: 18 additions & 0 deletions model/src/main/proto/oppia_logger.proto
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,24 @@ message EventLog {

// The event being logged is related to the response to the optional survey question.
OptionalSurveyResponseContext optional_response = 42;

// The event being logged is related to lesson progress(checkpoint) saving success.
ExplorationContext progress_saving_success_context = 43;

// The event being logged is related to lesson progress(checkpoint) saving failure.
ExplorationContext progress_saving_failure_context = 44;

// The event being logged is related to lesson progress(checkpoint) saving attempt
// advertently(intentionally).
ExplorationContext lesson_saved_advertently_context = 45;

// The event being logged is related to correct answer submission after returning back to the
// lesson.
ExplorationContext resume_lesson_submit_correct_answer_context = 46;

// The event being logged is related to incorrect answer submission after returning back to
// the lesson.
ExplorationContext resume_lesson_submit_incorrect_answer_context = 47;
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,43 +7,6 @@ import android.os.Bundle
import org.oppia.android.app.model.AppLanguageSelection
import org.oppia.android.app.model.AudioTranslationLanguageSelection
import org.oppia.android.app.model.EventLog
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.ABANDON_SURVEY
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.ACCESS_HINT_CONTEXT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.ACCESS_SOLUTION_CONTEXT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.ACTIVITYCONTEXT_NOT_SET
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.APP_IN_BACKGROUND_CONTEXT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.APP_IN_FOREGROUND_CONTEXT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.BEGIN_SURVEY
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.CLOSE_REVISION_CARD
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.DELETE_PROFILE_CONTEXT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.END_CARD_CONTEXT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.EXIT_EXPLORATION_CONTEXT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.FINISH_EXPLORATION_CONTEXT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.HINT_UNLOCKED_CONTEXT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.INSTALL_ID_FOR_FAILED_ANALYTICS_LOG
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.MANDATORY_RESPONSE
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.OPEN_CONCEPT_CARD
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.OPEN_EXPLORATION_ACTIVITY
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.OPEN_HOME
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.OPEN_INFO_TAB
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.OPEN_LESSONS_TAB
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.OPEN_PRACTICE_TAB
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.OPEN_PROFILE_CHOOSER
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.OPEN_QUESTION_PLAYER
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.OPEN_REVISION_CARD
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.OPEN_REVISION_TAB
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.OPEN_STORY_ACTIVITY
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.OPTIONAL_RESPONSE
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.PAUSE_VOICE_OVER_CONTEXT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.PLAY_VOICE_OVER_CONTEXT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.REACH_INVESTED_ENGAGEMENT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.RESUME_EXPLORATION_CONTEXT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.SHOW_SURVEY_POPUP
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.SOLUTION_UNLOCKED_CONTEXT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.START_CARD_CONTEXT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.START_OVER_EXPLORATION_CONTEXT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.SUBMIT_ANSWER_CONTEXT
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.SWITCH_IN_LESSON_LANGUAGE
import org.oppia.android.app.model.EventLog.SwitchInLessonLanguageEventContext
import org.oppia.android.app.model.OppiaLanguage
import org.oppia.android.app.model.OppiaMetricLog
Expand Down Expand Up @@ -91,6 +54,7 @@ import javax.inject.Singleton
import org.oppia.android.app.model.EventLog.AbandonSurveyContext as AbandonSurveyEventContext
import org.oppia.android.app.model.EventLog.CardContext as CardEventContext
import org.oppia.android.app.model.EventLog.ConceptCardContext as ConceptCardEventContext
import org.oppia.android.app.model.EventLog.Context.ActivityContextCase.*
import org.oppia.android.app.model.EventLog.ExplorationContext as ExplorationEventContext
import org.oppia.android.app.model.EventLog.HintContext as HintEventContext
import org.oppia.android.app.model.EventLog.LearnerDetailsContext as LearnerDetailsEventContext
Expand Down Expand Up @@ -216,6 +180,13 @@ class EventBundleCreator @Inject constructor(
APP_IN_FOREGROUND_CONTEXT -> LearnerDetailsContext(activityName, appInForegroundContext)
EXIT_EXPLORATION_CONTEXT -> ExplorationContext(activityName, exitExplorationContext)
FINISH_EXPLORATION_CONTEXT -> ExplorationContext(activityName, finishExplorationContext)
PROGRESS_SAVING_SUCCESS_CONTEXT -> ExplorationContext(activityName, progressSavingSuccessContext)
PROGRESS_SAVING_FAILURE_CONTEXT -> ExplorationContext(activityName, progressSavingFailureContext)
LESSON_SAVED_ADVERTENTLY_CONTEXT -> ExplorationContext(activityName, lessonSavedAdvertentlyContext)
RESUME_LESSON_SUBMIT_CORRECT_ANSWER_CONTEXT ->
ExplorationContext(activityName, resumeLessonSubmitCorrectAnswerContext)
RESUME_LESSON_SUBMIT_INCORRECT_ANSWER_CONTEXT ->
ExplorationContext(activityName, resumeLessonSubmitIncorrectAnswerContext)
RESUME_EXPLORATION_CONTEXT -> LearnerDetailsContext(activityName, resumeExplorationContext)
START_OVER_EXPLORATION_CONTEXT ->
LearnerDetailsContext(activityName, startOverExplorationContext)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ class KenyaAlphaEventTypeToHumanReadableNameConverterImpl @Inject constructor()
ActivityContextCase.APP_IN_FOREGROUND_CONTEXT -> "app_in_foreground_context"
ActivityContextCase.EXIT_EXPLORATION_CONTEXT -> "exit_exploration_context"
ActivityContextCase.FINISH_EXPLORATION_CONTEXT -> "finish_exploration_context"
ActivityContextCase.PROGRESS_SAVING_SUCCESS_CONTEXT -> "progress_saving_success_context"
ActivityContextCase.PROGRESS_SAVING_FAILURE_CONTEXT -> "progress_saving_failure_context"
ActivityContextCase.LESSON_SAVED_ADVERTENTLY_CONTEXT -> "lesson_saved_advertently_context"
ActivityContextCase.RESUME_LESSON_SUBMIT_CORRECT_ANSWER_CONTEXT -> "resume_lesson_submit_correct_answer_context"
ActivityContextCase.RESUME_LESSON_SUBMIT_INCORRECT_ANSWER_CONTEXT -> "resume_lesson_submit_incorrect_answer_context"
ActivityContextCase.RESUME_EXPLORATION_CONTEXT -> "resume_exploration_context"
ActivityContextCase.START_OVER_EXPLORATION_CONTEXT -> "start_over_exploration_context"
ActivityContextCase.DELETE_PROFILE_CONTEXT -> "delete_profile_context"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,11 @@ class StandardEventTypeToHumanReadableNameConverterImpl @Inject constructor() :
ActivityContextCase.APP_IN_FOREGROUND_CONTEXT -> "bring_app_to_foreground"
ActivityContextCase.EXIT_EXPLORATION_CONTEXT -> "leave_exploration"
ActivityContextCase.FINISH_EXPLORATION_CONTEXT -> "complete_exploration"
ActivityContextCase.PROGRESS_SAVING_SUCCESS_CONTEXT -> "progress_saving_success"
ActivityContextCase.PROGRESS_SAVING_FAILURE_CONTEXT -> "progress_saving_failure"
ActivityContextCase.LESSON_SAVED_ADVERTENTLY_CONTEXT -> "lesson_saved_advertently"
ActivityContextCase.RESUME_LESSON_SUBMIT_CORRECT_ANSWER_CONTEXT -> "submit_correct_ans_in_resumed_lesson"
ActivityContextCase.RESUME_LESSON_SUBMIT_INCORRECT_ANSWER_CONTEXT -> "submit_incorrect_ans_in_resumed_lesson"
ActivityContextCase.RESUME_EXPLORATION_CONTEXT -> "resume_in_progress_exploration"
ActivityContextCase.START_OVER_EXPLORATION_CONTEXT -> "restart_in_progress_exploration"
ActivityContextCase.DELETE_PROFILE_CONTEXT -> "delete_profile"
Expand Down

0 comments on commit 7fb6123

Please sign in to comment.