✨(projet) get user completionrecover the student's progress #9

Arame22 · 2024-09-20T07:59:24Z

use moodle's completion tracker to track student progress

Purpose

Proposal

SergioSim · 2024-09-20T08:30:37Z

block_iagora.php

@@ -55,9 +55,49 @@ public function get_content() {
        } else {
            $this->content->text = $this->generate_chat_content($copilotendpointurl);
        }
+
+          // Marquer l'activité comme vue pour la complétion si le suivi est activé


Suggested change

// Marquer l'activité comme vue pour la complétion si le suivi est activé

// Mark activity as viewed if tracking is enabled.

As most of our comments are in English, could we keep it that way?

quite right

SergioSim · 2024-09-20T08:32:42Z

block_iagora.php

        // Generate a unique identifier for the chat container.
        $chatid = uniqid('iagora_chat_');
+
+    // Si la complétion est activée et que l'utilisateur visualise l'activité 
+    if ($completion->is_enabled($cm) && $completion->is_tracked_user($USER->id)) {


Where is $completion defined? (I got an exception here saying that it's null)

SergioSim · 2024-09-20T13:42:02Z

block_iagora.php

+        $completion = new completion_info($COURSE);
+        if ($completion->is_enabled($this->context) && $completion->is_tracked_user($USER->id)) {
+        // Marquer l'activité comme vue dans le système de complétion
+        $completion->set_module_viewed($this->context);


Why should we set the module as viewed? Isn't this managed by the completion plugin?
Maybe we could retrieve all completed activities and pass this information the the copilot? For example:

global $COURSE, $USER; $completed_activities = array(); $completion = new completion_info($COURSE); $modinfo = get_fast_modinfo($COURSE, $USER->id); $cms = $modinfo->get_cms(); foreach ($cms as $cm) { if ($cm->completion == COMPLETION_TRACKING_NONE) { continue; } if (!$cm->uservisible) { continue; } $completiondata = $completion->get_data($cm, true, $USER->id); if ($completiondata->completionstate == COMPLETION_COMPLETE || $completiondata->completionstate == COMPLETION_COMPLETE_PASS) { $completed_activities[] = $cm->name; } }

Maybe passing a list of incomplete activities might be useful, too? What do you think?

SergioSim · 2024-09-20T13:52:29Z

block_iagora.php

+        // Appeler l'API Moodle 
+        $completionstatus = call_external_api('core_completion_get_activities_completion_status', [
+            'courseid' => $courseid,
+            'userid' => $userid
+        ]);


This plugin runs inside Moodle; thus, I guess we should avoid calling the external API.
We could check out the source code of the get_activities_completion_status function, which gives an excellent example of how to use the completion_info class to retrieve information about course completion.
The Moodle block_selfcompletion plugin might serve as a great example too)

SergioSim · 2024-09-20T13:55:52Z

block_iagora.php

        $context = [
            'chatId' => $chatid,
            'tokenEndpointURL' => $copilotendpointurl,
+            'progress' => $progressPercentage


Suggested change

'progress' => $progressPercentage

'progressPercentage' => $progressPercentage

The key should match the one used in the Mustache template.

use moodle's completion tracker to track student progress

SergioSim

Looks better 👍

Maybe we could also add a second variable to provide a list of incomplete activities? What do you think?

SergioSim · 2024-10-08T11:01:04Z

block_iagora.php

        // Generate a unique identifier for the chat container.
        $chatid = uniqid('iagora_chat_');
        $context = [
            'chatId' => $chatid,
            'tokenEndpointURL' => $copilotendpointurl,
+            'completedactivities' => json_encode($this->get_student_progress()),


Suggested change

'completedactivities' => json_encode($this->get_student_progress()),

'completedActivities' => json_encode($this->get_student_progress()),

Aren't JavaScript variables using camelCase?

yes, but moodle has not accepted this naming.Here's the error he made Variable "completedActivities" must be all lower-case

SergioSim · 2024-10-08T11:03:53Z

block_iagora.php

@@ -66,12 +100,13 @@ public function get_content() {
     * @return string The generated HTML content for the chat.
     */
    private function generate_chat_content($copilotendpointurl) {
-        global $OUTPUT;
+        global $OUTPUT, $USER, $COURSE;


Suggested change

global $OUTPUT, $USER, $COURSE;

global $OUTPUT;

Where are $USER and $COURSE used?

In get_student_progress() I used $COURSE and $USER to retrieve the user's activity progress information get_fast_modinfo($COURSE, $USER->id) and also in $completion->get_data($cm, true, $USER->id) to retrieve whether or not the user has completed the activity.

SergioSim · 2024-10-08T11:09:39Z

templates/chat.mustache

@@ -45,8 +45,21 @@
 /* eslint-disable promise/no-native */
 (async function() {
  const styleOptions = {
-    hideUploadButton: true
+    hideUploadButton: true,
+    botAvatarImage: "/image/iagora.jpg",


I got a 404 - image not found. Where is this image defined?
Setting a fixed image for the bot should be fine in the first iteration; however, we should probably make this configurable in the future.

Yes, indeed, the method I had originally used required providing a link to the image, which had to be available online. I now wanted to try and create a sub-folder in the IAgora folder to store the image in, and then provide the local path to that image.

SergioSim · 2024-10-08T12:29:08Z

templates/chat.mustache

+    botAvatarInitials: 'BF',
+    userAvatarImage: 'https://github.com/compulim.png?size=64',
+    userAvatarInitials: 'WC'
  };
+  const styleSet = window.WebChat.createStyleSet({
+          bubbleBackground: 'rgba(0, 0, 255, .1)',
+          bubbleFromUserBackground: 'rgba(0, 255, 0, .1)'
+        });
+
+        styleSet.textContent = Object.assign({}, styleSet.textContent, {
+          fontFamily: "'Comic Sans MS', 'Arial', sans-serif",
+          fontWeight: 'bold'
+        });


Same thoughts here; these values should be configurable.
For the userAvatarImage, we could use the Moodle user profile image, and for the userAvatarInitials - the first letter of the Moodle user's first name and last name.

I agree, it's a good idea, I'm going to follow this approach.

SergioSim · 2024-10-08T12:32:08Z

templates/chat.mustache

-            type: 'event'
+            type: 'event',
+            value: {
+              completedactivities: completedactivities


Suggested change

completedactivities: completedactivities

completedActivities: '{{completedActivities}}'

SergioSim · 2024-10-08T12:33:10Z

templates/chat.mustache

@@ -69,7 +82,7 @@
      })
      .then(({token}) => token)
  ]);
-
+  const completedactivities = [];


Suggested change

const completedactivities = [];

Isn't the completedActivities variable already defined in the Mustache template?

completedactivities is defined in the mustache template, but as an empty array. I'll fix that using the data passed from the block. I'll fix that.

SergioSim · 2024-10-08T12:35:02Z

templates/chat.mustache

Missing doc string for the completedActivities context variable (line 29)

Okay, I'll add it

block_iagora.php

SergioSim · 2024-10-11T08:23:53Z

block_iagora.php

+                $uncompletedactivities[] = $cm->name;
+            }
+        }
+        // Return the array of completed activities and uncompleted activities .


Suggested change

// Return the array of completed activities and uncompleted activities .

Isn't this information is already present in the function docstring?

block_iagora.php

SergioSim · 2024-10-11T08:36:26Z

templates/chat.mustache

@@ -28,11 +28,14 @@
    Context variables required for this template:
    * chatId: The ID of the chat div element where to render the chat block.
    * tokenEndpointURL: The Copilot Token Endpoint URL for native apps.
+    * completedActivities: A JSON string containing the list of activities the user has already completed.
+    * uncompletedActivities: A JSON string containing the list of activities the user has not yet completed.


Missing docstrings for userAvatarImage and userAvatarInitials

SergioSim · 2024-10-11T08:38:38Z

templates/chat.mustache


    Example context (json):
    {
        "chatId": "iagora_chat_55a6cad25a0f6",
        "tokenEndpointURL": "https://insert/your/copilot/endpoint/url"
+


Missing example values for completedActivities, uncompletedActivities, userAvatarImage and userAvatarInitials

block_iagora.php

templates/chat.mustache

Update the block_iagora to include customisable avatar initials and profil image.

Arame22 force-pushed the track-user-completion branch from 6940969 to 4402d19 Compare September 20, 2024 08:13

SergioSim assigned Arame22 Sep 20, 2024

SergioSim added the enhancement New feature or request label Sep 20, 2024

SergioSim self-requested a review September 20, 2024 08:24

SergioSim reviewed Sep 20, 2024

View reviewed changes

Arame22 force-pushed the track-user-completion branch 6 times, most recently from 5aacf45 to 9e3f576 Compare September 25, 2024 20:39

Arame22 force-pushed the track-user-completion branch 6 times, most recently from dfcae7f to 6b5b399 Compare October 8, 2024 10:47

✨(projet) get user completion ecover the student's progress

0c56826

use moodle's completion tracker to track student progress

Arame22 force-pushed the track-user-completion branch from 6b5b399 to 0c56826 Compare October 8, 2024 10:52

SergioSim reviewed Oct 8, 2024

View reviewed changes

Arame22 force-pushed the track-user-completion branch 3 times, most recently from 8b5b855 to e5495b9 Compare October 10, 2024 14:58

SergioSim reviewed Oct 11, 2024

View reviewed changes

Arame22 force-pushed the track-user-completion branch 6 times, most recently from c479f42 to cdaaa50 Compare October 11, 2024 17:50

Arame22 force-pushed the track-user-completion branch 3 times, most recently from 7f59af2 to 517e618 Compare October 11, 2024 18:33

✨(projet) customize the look of iagora

03e8f46

Update the block_iagora to include customisable avatar initials and profil image.

Arame22 force-pushed the track-user-completion branch from 517e618 to 03e8f46 Compare October 11, 2024 18:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨(projet) get user completionrecover the student's progress #9

✨(projet) get user completionrecover the student's progress #9

Arame22 commented Sep 20, 2024

SergioSim Sep 20, 2024

Arame22 Sep 23, 2024

SergioSim Sep 20, 2024

SergioSim Sep 20, 2024

SergioSim Sep 20, 2024

SergioSim Sep 20, 2024

SergioSim left a comment

SergioSim Oct 8, 2024

Arame22 Oct 8, 2024

SergioSim Oct 8, 2024

Arame22 Oct 8, 2024 •

edited

Loading

SergioSim Oct 8, 2024

Arame22 Oct 8, 2024

SergioSim Oct 8, 2024

Arame22 Oct 8, 2024

SergioSim Oct 8, 2024

SergioSim Oct 8, 2024

Arame22 Oct 8, 2024

SergioSim Oct 8, 2024

Arame22 Oct 8, 2024

SergioSim Oct 11, 2024

SergioSim Oct 11, 2024

SergioSim Oct 11, 2024

	// Marquer l'activité comme vue pour la complétion si le suivi est activé
	// Mark activity as viewed if tracking is enabled.

	'progress' => $progressPercentage
	'progressPercentage' => $progressPercentage

	'completedactivities' => json_encode($this->get_student_progress()),
	'completedActivities' => json_encode($this->get_student_progress()),

	completedactivities: completedactivities
	completedActivities: '{{completedActivities}}'

✨(projet) get user completionrecover the student's progress #9

Are you sure you want to change the base?

✨(projet) get user completionrecover the student's progress #9

Conversation

Arame22 commented Sep 20, 2024

Purpose

Proposal

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SergioSim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Arame22 Oct 8, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Arame22 Oct 8, 2024 •

edited

Loading