feat: Sync Course Dates to Calendar #228

HamzaIsrar12 · 2024-02-11T19:00:26Z

Description

Calendar Sync Integration

Integrated Sync to Calendar switch on the Course Dates tab.
Dynamically show/hide switch based on Remote config.
Added user permission prompt for calendar access.
Added confirmation alert for initial course additions.
Included course dates as events in the local app calendar.
Added AlertDialog Loader for event creation/update.
Implemented Calendar preference for streamlined alert management.
Added user prompt for updating or removing the calendar.
Added a prompt for out-of-sync calendar situations.
Update calendar events on the 'Shift Due Dates' CTA.

Remote Config for Calendar Feature

Retrieve the remote config from Django Admin within the enrollments API. Store the configuration in CorePreferences, ensuring it is updated with each enrollment API call.

The CalendarSync Config now manages specific values pertinent to the Calendar Sync integration on both the Course Home and Dates tab.

Waffle flags/config on LMS Django Admin:

Open LMS Django Admin and go to Mobile API → Mobile configs.
Make sure you have access to the table mobile_api_admin.
Add a config with the name: configs whose value needs to be a JSON dictionary having the following format and key/value pairs:

  {
    "course_dates_calendar_sync": {
      "ios": {
        "enabled": true,
        "self_paced_enabled": true,
        "instructor_paced_enabled": true,
        "deep_links_enabled": false
      },
      "android": {
        "enabled": true,
        "self_paced_enabled": true,
        "instructor_paced_enabled": true,
        "deep_links_enabled": false
      }
    }
  }

Note

The backend team is working to fix some issues with Remote Config, in the meanwhile please enable the feature locally by passing default values to data model AppConfig.

Screenshots

1. Default State	2. Calendar Permission Dialog	3. Permission Dialog	4. Detail Dialog

5. Calendar Syncing	6. View Calendar Events	7. Remove Calendar	8. Out Of Sync Calendar

Demo

Calendar.Sync.webm

course/src/main/java/org/openedx/course/presentation/calendarsync/CalendarUtils.kt

moiz994 · 2024-02-14T11:32:26Z

@HamzaIsrar12 It would be better to update the pop-up messages for the following 2 cases:

Add Calendar
Remove Calendar

Case: Add Calendar
Content:
Title: Add Course Dates to Calendar
Body: Would you like to add "" dates to your calendar?

You can edit or remove your course dates at any time from your calendar or settings.

CTAs: Cancel | Add

Case: Remove Calendar
Content:
Title: Remove Course Dates from Calendar
Body: Would you like to remove the "" dates from your calendar?
CTAs: Cancel | Remove

Additional info:
Calendar name is a combination of the app name and course name. i.e. - = edX - Harvard's CS50

omerhabib26

Cases are working fine as expected but some code improvements can be made.

app/src/main/java/org/openedx/app/data/storage/PreferencesManager.kt

core/src/main/java/org/openedx/core/utils/TimeUtils.kt

core/src/main/java/org/openedx/core/data/model/AppConfig.kt

core/src/main/java/org/openedx/core/system/notifier/CourseCalenderSyncEvent.kt

...main/java/org/openedx/course/presentation/calendarsync/CourseContainerCalendarSyncUIState.kt

course/src/main/java/org/openedx/course/presentation/calendarsync/DialogProperties.kt

course/src/main/java/org/openedx/course/presentation/container/CourseContainerFragment.kt

...main/java/org/openedx/course/presentation/calendarsync/CourseContainerCalendarSyncUIState.kt

volodymyr-chekyrta · 2024-02-19T09:37:59Z

@HamzaIsrar12, Could you please provide documentation on configuring the CourseEnrollments "config" on the LMS?
I need it to finish the review.

moiz994 · 2024-02-19T14:43:32Z

@HamzaIsrar12, Could you please provide documentation on configuring the CourseEnrollments "config" on the LMS? I need it to finish the review.

Hamza is out sick today. @omerhabib26 or @farhan-arshad-dev can either one of you help here?

HamzaIsrar12 · 2024-02-20T08:02:03Z

@volodymyr-chekyrta

Waffle flags/config on LMS Django Admin:

Open LMS Django Admin and go to Mobile API → Mobile configs.
Make sure you have access to the table mobile_api_admin.
Add a config with the name: configs whose value needs to be a JSON dictionary having the following format and key/value pairs:

  {
    "course_dates_calendar_sync": {
      "ios": {
        "enabled": true,
        "self_paced_enabled": true,
        "instructor_paced_enabled": true,
        "deep_links_enabled": false
      },
      "android": {
        "enabled": true,
        "self_paced_enabled": true,
        "instructor_paced_enabled": true,
        "deep_links_enabled": false
      }
    }
  }

omerhabib26

Some minor nits

app/src/main/java/org/openedx/app/data/storage/PreferencesManager.kt

core/src/main/java/org/openedx/core/data/model/CalendarSyncConfig.kt

course/src/main/java/org/openedx/course/presentation/calendarsync/CalendarSyncDialog.kt

course/src/main/java/org/openedx/course/presentation/calendarsync/CalendarManager.kt

omerhabib26 · 2024-02-20T07:47:00Z

course/src/main/java/org/openedx/course/presentation/dates/CourseDatesFragment.kt

+                                if (calendarSyncUIState.isCalendarSyncEnabled) {
+                                    item {
+                                        CalendarSyncCard(
+                                            modifier = Modifier.padding(bottom = 16.dp),


still pending

course/src/main/java/org/openedx/course/presentation/dates/CourseDatesFragment.kt

course/src/main/java/org/openedx/course/presentation/container/CourseContainerViewModel.kt

core/src/main/java/org/openedx/core/data/model/CourseEnrollments.kt

core/src/main/java/org/openedx/core/domain/model/AppConfig.kt

course/src/main/java/org/openedx/course/presentation/calendarsync/CalendarManager.kt

volodymyr-chekyrta

LGTM 👍

k1rill

just one question about commented code

k1rill

LGTM

Calendar Sync Integration: - Integrated "Sync to Calendar" switch on Course Dates tab. - Dynamically show/hide switch based on Remote config. - Added user permission prompt for calendar access. - Added confirmation alert for initial course additions. - Included course dates as events in the local app calendar. - Added AlertDialog Loader for event creation/update. - Implemented Calendar preference for streamlined alert management. - Added user prompt for updating or removing the calendar. - Added a prompt for out-of-sync calendar situations. - Update calendar events on 'Shift Due Dates' CTA. Remote Config for Calendar Feature: - Retrieve remote config from LMS within the enrollments API. Store the configuration in CorePreferences, ensuring it is updated with each enrollments API call. - The CalendarSync Config now manages specific values pertinent to the Calendar Sync integration on both the Course Home and Dates tab. Fixes: LEARNER-9801

HamzaIsrar12 linked an issue Feb 11, 2024 that may be closed by this pull request

[Android] Option "Sync Dates to Calendar" #105

Closed

HamzaIsrar12 requested review from omerhabib26, farhan-arshad-dev, volodymyr-chekyrta, k1rill and dixidroid February 11, 2024 19:11

volodymyr-chekyrta reviewed Feb 12, 2024

View reviewed changes

course/src/main/java/org/openedx/course/presentation/calendarsync/CalendarUtils.kt Outdated Show resolved Hide resolved

volodymyr-chekyrta reviewed Feb 12, 2024

View reviewed changes

course/src/main/java/org/openedx/course/presentation/calendarsync/CalendarUtils.kt Outdated Show resolved Hide resolved

omerhabib26 requested changes Feb 14, 2024

View reviewed changes

HamzaIsrar12 requested review from volodymyr-chekyrta and omerhabib26 February 15, 2024 22:44

omerhabib26 requested changes Feb 20, 2024

View reviewed changes

k1rill requested changes Feb 21, 2024

View reviewed changes

HamzaIsrar12 force-pushed the hamza/LEARNER-9801 branch from 948a47a to efa1c5e Compare February 22, 2024 14:02

HamzaIsrar12 requested review from k1rill and omerhabib26 February 22, 2024 14:02

omerhabib26 previously approved these changes Feb 22, 2024

View reviewed changes

volodymyr-chekyrta previously approved these changes Feb 26, 2024

View reviewed changes

k1rill reviewed Feb 26, 2024

View reviewed changes

k1rill self-requested a review February 26, 2024 10:41

k1rill previously approved these changes Feb 26, 2024

View reviewed changes

HamzaIsrar12 dismissed stale reviews from k1rill, volodymyr-chekyrta, and omerhabib26 via dcc8d5e February 26, 2024 11:01

HamzaIsrar12 force-pushed the hamza/LEARNER-9801 branch from efa1c5e to dcc8d5e Compare February 26, 2024 11:01

k1rill self-requested a review February 26, 2024 11:22

k1rill approved these changes Feb 26, 2024

View reviewed changes

HamzaIsrar12 merged commit 92d697f into openedx:develop Feb 26, 2024
3 checks passed

HamzaIsrar12 deleted the hamza/LEARNER-9801 branch February 26, 2024 12:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Sync Course Dates to Calendar #228

feat: Sync Course Dates to Calendar #228

HamzaIsrar12 commented Feb 11, 2024 •

edited

Loading

moiz994 commented Feb 14, 2024 •

edited

Loading

omerhabib26 left a comment

volodymyr-chekyrta commented Feb 19, 2024

moiz994 commented Feb 19, 2024

HamzaIsrar12 commented Feb 20, 2024

omerhabib26 left a comment

omerhabib26 Feb 20, 2024

volodymyr-chekyrta left a comment

k1rill left a comment

k1rill left a comment

feat: Sync Course Dates to Calendar #228

feat: Sync Course Dates to Calendar #228

Conversation

HamzaIsrar12 commented Feb 11, 2024 • edited Loading

Description

Calendar Sync Integration

Remote Config for Calendar Feature

Note

Screenshots

Demo

moiz994 commented Feb 14, 2024 • edited Loading

omerhabib26 left a comment

Choose a reason for hiding this comment

volodymyr-chekyrta commented Feb 19, 2024

moiz994 commented Feb 19, 2024

HamzaIsrar12 commented Feb 20, 2024

omerhabib26 left a comment

Choose a reason for hiding this comment

omerhabib26 Feb 20, 2024

Choose a reason for hiding this comment

volodymyr-chekyrta left a comment

Choose a reason for hiding this comment

k1rill left a comment

Choose a reason for hiding this comment

k1rill left a comment

Choose a reason for hiding this comment

HamzaIsrar12 commented Feb 11, 2024 •

edited

Loading

moiz994 commented Feb 14, 2024 •

edited

Loading