challenge.md

This section explain all the functionnalities in the challenge part

Quiz

A quiz includes 4 basic questions and one custom question.

Basic Question

All basics Questions are created in the quizEntity.json. We have to add :

• questionLabel => Label of the question
• Answers => An array of three answers (answerLabel, isTrue)
• description => Explain the question
• source => Source of the explanaition

This questions and answers are in random order.

In the question page the user have to select an answer and click validate. Then, he sees the right answer and a modal with the explanation and the source. After this modal, he goes to the next question. Depends on the answer, the question result state is set either correct or incorrect. If it is a right answer, the quiz result is incremented by one.

Custom Question

At the end of every quiz, we're creating a custom question. During the creation of the quiz, we have to add :

• type => data or calculation
• period => the period selected for the calcul
• timestep => the interval of the calcul (Day, Month, Year)
  We get all this information to determine the custom question (All information are in the quizEntity.json). Depending of the question type, the system calcul a maximum or an average data. Then, he generate two randoms answers following the right answer.

A user can stop during a quiz and picks up where he left off. To define where the user left off, we have to check if at least one of the question result status is unlocked.

Once the custom question is answered, the quiz state is set to done. Then, the user sees his result and his earned stars. He can also retry or go back to the challenge page.

Exploration

Exploration is a feature which in the user got to do an action in order to help him to discover all features of this app. They are 4 types of action :

• DECLARATIVE : The user has to do something outside of the app => No way for the app to know if the user did it so we trust him.
• ACTION : Action whitin the app. When the user finish he got a notification.
• CONSUMPTION : He got to do something in his consumption view.
• ECOGESTURE : He need to have a look to a specific Ecogesture.

In order to check if an exploration (which is not declarative) is done, a hook called useExploration is used.It is called on component that has to check if an exploration is done.

This hook called exploration service to check exploration by passing two parameter(the current challenge and the user exploration id associated with the exploration id of the current challenge). This check is done only if:

• There is a current challenge
• exploration.id of the current challenge is equal to the user exploration id
• exploration.state is ONGOING

Depends on the type of an exploration, either the exploration remains in progress until it is fully done or it ends.

When the user finish the exploration, he got a success message and five more stars on his challenge progression.

Action

Action is a feature which in the user has to apply an ecogesture for a given duration in order to reduce his consumption. An action refers to the model UserAction in the app, and is an extention of an ecogesture to which we add an startDate and a userActionState, allowing user to manage the action state depending on user's progress.

UserAction {
  ecogesture: Ecogesture | null
  state: UserActionState
  startDate: DateTime | null
}

Unlike the exploration, duel and quiz, there is no relationship for an action in the ChallengeEntity model, given that the action is picked by the user. So once it is picked, it is directly stored in the current UserChallenge.

When a user launches an action, there is several possible cases :

The user has not completed his consumption profile

If the user's profile has never been completed, the application will purpose him the default action list which is defined in the action service. The first one of this list will be shown at first, and if the user wants to pick another one, he'll have the choice between the three ecogestures of the default list.

The user has completed his consumption profile

If the user has completed his profile, the application will purpose him a list of three custom ecogestures. The list is built the following way :

1. First we look for the action that haven't been done yet
2. We pick only the actions that are available for the user's connected fluids
3. We pick the action that are appliable during the current season. At this moment, if the list is smaller than 3, we complete it with actions whose value for property Season is NONE
4. If the list is still smaller than 3 after this, we complete with default actions (This case is rare)
5. Finally, we sort the list of action by efficency and then difficulty. We put the most efficient actions and with the lowest difficulty in first.

At any moment of an action, a user can consult his progress through a clock icon and the ending date of his action. The accomplishment of an action is only conditionned by the duration. Once the user completes an action, he'll see a notification on the app and then win his five stars when he comes back to the action screen.

Duel

On launch

In order to find a valid reference period we search for a period which is defined by the duel duration.
We check the most recent period first if it's complete and then we go farther and farther in the time if the ones before got missing values.
We also define a threshold for a maximum old period (6 months for the moment determined in the code ==> hardcoding). If the thresold is reached and no valid period was found, we alert the user that he can't launch the duel and have to wait before he can retry this process.

On going

Every time the user go into the duel mode, we are checking if the duel is finished. if (actualDate - startDate) > duelDuration, the duel is done.

On finish

Once the state of the duel is set to DONE, we save the user result and determine if he wins (userComsumption < threshold of the reference period) or if he loses. Then the user sees his earned badge.

Challenges

We can find the file challengeEntity.json in the /db folder. This file contains an array of challenges, and each of them includes relationships to duels, quiz, missions and actions.

UserData creation

Once a user launch a challenge in the Ecolyo app, we create a userChallenge and store it in the couchDB under the doctype 'com.grandlyon.ecolyo.userchallenge'. During this process, the objects related to the challenge (quiz, duel, mission, action) will be be converted to an user version which contains informations about the user progress, the fluids connected and so on. So we have now a userChallenge that contains a userQuiz, a userDuel, etc. instead of relations.

To illustrate this, let's show the conversion of quizEntity to userQuiz :

DuelEntity {
  id: string
  title: string
  description: string
  duration: Duration
}

Becomes :

UserQuiz {
  id: string
  title: string
  description: string
	duration: Duration
  threshold: number
  state: UserDuelState
  startDate: string | null
  fluidTypes: FluidType[]
  userConsumption: number
}

Data managment schema