enhance(apps/analytics): add computation logic for activity progress #4392
Conversation
📝 WalkthroughWalkthroughThis pull request introduces several changes across multiple files in the analytics module. Key modifications include the addition of new import statements in Changes
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 12
🧹 Outside diff range and nitpick comments (4)
apps/analytics/src/modules/activity_progress/get_course_progress_activities.py (1)
4-5: Consider optimizing the included relations.The current implementation includes all stacks, elements, and responses which could impact performance for courses with large amounts of data. Consider:
- Limiting the number of responses or filtering by date
- Including only necessary fields
Also applies to: 10-11
apps/analytics/src/modules/activity_progress/compute_progress_counts.py (2)
11-13: Consider using list comprehension for element countingThe current implementation uses a loop to count elements, which could be simplified.
- num_elements = 0 - for stack in activity["stacks"]: - num_elements += len(stack["elements"]) + num_elements = sum(len(stack["elements"]) for stack in activity["stacks"])
38-40: Enhance error loggingThe current print statement for no responses could be more informative.
- print("No responses found for activity", activity["id"]) + logging.info(f"No responses found for activity {activity.get('id', 'unknown')}")Consider adding logging import at the top of the file:
import loggingapps/analytics/src/modules/activity_progress/__init__.py (1)
1-4: Consider adding__all__to explicitly define the public API.To make the module's public interface more explicit and maintainable, consider adding an
__all__list.+__all__ = [ + 'get_course_progress_activities', + 'compute_progress_counts', + 'save_practice_quiz_progress', + 'save_microlearning_progress', +] from .get_course_progress_activities import get_course_progress_activities from .compute_progress_counts import compute_progress_counts from .save_practice_quiz_progress import save_practice_quiz_progress from .save_microlearning_progress import save_microlearning_progress🧰 Tools
🪛 Ruff (0.8.0)
1-1:
.get_course_progress_activities.get_course_progress_activitiesimported but unused; consider removing, adding to__all__, or using a redundant alias(F401)
2-2:
.compute_progress_counts.compute_progress_countsimported but unused; consider removing, adding to__all__, or using a redundant alias(F401)
3-3:
.save_practice_quiz_progress.save_practice_quiz_progressimported but unused; consider removing, adding to__all__, or using a redundant alias(F401)
4-4:
.save_microlearning_progress.save_microlearning_progressimported but unused; consider removing, adding to__all__, or using a redundant alias(F401)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (8)
apps/analytics/src/modules/__init__.py(1 hunks)apps/analytics/src/modules/activity_progress/__init__.py(1 hunks)apps/analytics/src/modules/activity_progress/compute_progress_counts.py(1 hunks)apps/analytics/src/modules/activity_progress/get_course_progress_activities.py(1 hunks)apps/analytics/src/modules/activity_progress/save_microlearning_progress.py(1 hunks)apps/analytics/src/modules/activity_progress/save_practice_quiz_progress.py(1 hunks)apps/analytics/src/notebooks/activity_progress.ipynb(1 hunks)apps/analytics/src/notebooks/instance_activity_performance.ipynb(3 hunks)
✅ Files skipped from review due to trivial changes (1)
- apps/analytics/src/notebooks/instance_activity_performance.ipynb
🧰 Additional context used
🪛 Ruff (0.8.0)
apps/analytics/src/modules/__init__.py
7-7: from .activity_progress import * used; unable to detect undefined names
(F403)
apps/analytics/src/modules/activity_progress/__init__.py
1-1: .get_course_progress_activities.get_course_progress_activities imported but unused; consider removing, adding to __all__, or using a redundant alias
(F401)
2-2: .compute_progress_counts.compute_progress_counts imported but unused; consider removing, adding to __all__, or using a redundant alias
(F401)
3-3: .save_practice_quiz_progress.save_practice_quiz_progress imported but unused; consider removing, adding to __all__, or using a redundant alias
(F401)
4-4: .save_microlearning_progress.save_microlearning_progress imported but unused; consider removing, adding to __all__, or using a redundant alias
(F401)
🔇 Additional comments (1)
apps/analytics/src/modules/activity_progress/__init__.py (1)
1-4: LGTM! The imports are correctly structured for module re-exports.
These imports make the activity progress computation functions available at the package level, which aligns with their usage in the Jupyter notebooks.
🧰 Tools
🪛 Ruff (0.8.0)
1-1: .get_course_progress_activities.get_course_progress_activities imported but unused; consider removing, adding to __all__, or using a redundant alias
(F401)
2-2: .compute_progress_counts.compute_progress_counts imported but unused; consider removing, adding to __all__, or using a redundant alias
(F401)
3-3: .save_practice_quiz_progress.save_practice_quiz_progress imported but unused; consider removing, adding to __all__, or using a redundant alias
(F401)
4-4: .save_microlearning_progress.save_microlearning_progress imported but unused; consider removing, adding to __all__, or using a redundant alias
(F401)
apps/analytics/src/modules/activity_progress/get_course_progress_activities.py
Show resolved
Hide resolved
apps/analytics/src/modules/activity_progress/get_course_progress_activities.py
Show resolved
Hide resolved
apps/analytics/src/modules/activity_progress/save_microlearning_progress.py
Show resolved
Hide resolved
apps/analytics/src/modules/activity_progress/save_microlearning_progress.py
Show resolved
Hide resolved
apps/analytics/src/modules/activity_progress/save_practice_quiz_progress.py
Show resolved
Hide resolved
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
klicker-uzh
|
||||||||||||||||||||||||||||
| Project |
klicker-uzh
|
| Branch Review |
activity-progress
|
| Run status |
|
| Run duration | 12m 13s |
| Commit |
|
| Committer | Julius Schlapbach |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
148
|
| View all changes introduced in this branch ↗︎ | |
Summary by CodeRabbit
Release Notes
New Features
get_course_progress_activities,compute_progress_counts,save_practice_quiz_progress, andsave_microlearning_progress.Improvements
instance_activity_performancenotebook.These changes expand the analytics capabilities and improve code clarity for better maintainability.