[CLXR-475][Horizon] Learn offline mode #3637
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| /* | ||
| * Copyright (C) 2026 - present Instructure, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package com.instructure.horizon.espresso | ||
|
|
||
| import android.content.Context | ||
| import androidx.room.Room | ||
| import com.instructure.canvasapi2.utils.ApiPrefs | ||
| import com.instructure.horizon.database.HorizonDatabase | ||
| import com.instructure.horizon.database.dao.HorizonCourseDao | ||
| import com.instructure.horizon.database.dao.HorizonCourseModuleDao | ||
| import com.instructure.horizon.database.dao.HorizonCourseScoreDao | ||
| import com.instructure.horizon.database.dao.HorizonDashboardEnrollmentDao | ||
| import com.instructure.horizon.database.dao.HorizonDashboardModuleItemDao | ||
| import com.instructure.horizon.database.dao.HorizonFileFolderDao | ||
| import com.instructure.horizon.database.dao.HorizonLearnCollectionDao | ||
| import com.instructure.horizon.database.dao.HorizonLearnItemDao | ||
| import com.instructure.horizon.database.dao.HorizonLearnSavedItemDao | ||
| import com.instructure.horizon.database.dao.HorizonLocalFileDao | ||
| import com.instructure.horizon.database.dao.HorizonProgramDao | ||
| import com.instructure.horizon.database.dao.HorizonSyncMetadataDao | ||
| import com.instructure.horizon.di.HorizonHtmlParserQualifier | ||
| import com.instructure.horizon.di.HorizonOfflineModule | ||
| import com.instructure.horizon.offline.HorizonHtmlParserFileSource | ||
| import com.instructure.pandautils.features.offline.sync.HtmlParser | ||
| import dagger.Module | ||
| import dagger.Provides | ||
| import dagger.hilt.android.qualifiers.ApplicationContext | ||
| import dagger.hilt.components.SingletonComponent | ||
| import dagger.hilt.testing.TestInstallIn | ||
| import javax.inject.Singleton | ||
|
|
||
| @Module | ||
| @TestInstallIn(components = [SingletonComponent::class], replaces = [HorizonOfflineModule::class]) | ||
| object HorizonOfflineTestModule { | ||
|
|
||
| @Provides | ||
| @Singleton | ||
| fun provideHorizonDatabase(@ApplicationContext context: Context): HorizonDatabase { | ||
| return Room.inMemoryDatabaseBuilder(context, HorizonDatabase::class.java) | ||
| .allowMainThreadQueries() | ||
| .build() | ||
|
There was a problem hiding this comment.
|
||
| } | ||
|
|
||
| @Provides | ||
| fun provideHorizonDashboardEnrollmentDao(db: HorizonDatabase): HorizonDashboardEnrollmentDao = db.dashboardEnrollmentDao() | ||
|
|
||
| @Provides | ||
| fun provideHorizonProgramDao(db: HorizonDatabase): HorizonProgramDao = db.programDao() | ||
|
|
||
| @Provides | ||
| fun provideHorizonDashboardModuleItemDao(db: HorizonDatabase): HorizonDashboardModuleItemDao = db.dashboardModuleItemDao() | ||
|
|
||
| @Provides | ||
| fun provideHorizonSyncMetadataDao(db: HorizonDatabase): HorizonSyncMetadataDao = db.syncMetadataDao() | ||
|
|
||
| @Provides | ||
| fun provideHorizonLearnItemDao(db: HorizonDatabase): HorizonLearnItemDao = db.learnItemDao() | ||
|
|
||
| @Provides | ||
| fun provideHorizonLearnCollectionDao(db: HorizonDatabase): HorizonLearnCollectionDao = db.learnCollectionDao() | ||
|
|
||
| @Provides | ||
| fun provideHorizonLearnSavedItemDao(db: HorizonDatabase): HorizonLearnSavedItemDao = db.learnSavedItemDao() | ||
|
|
||
| @Provides | ||
| fun provideHorizonCourseDao(db: HorizonDatabase): HorizonCourseDao = db.courseDao() | ||
|
|
||
| @Provides | ||
| fun provideHorizonCourseModuleDao(db: HorizonDatabase): HorizonCourseModuleDao = db.courseModuleDao() | ||
|
|
||
| @Provides | ||
| fun provideHorizonCourseScoreDao(db: HorizonDatabase): HorizonCourseScoreDao = db.courseScoreDao() | ||
|
|
||
| @Provides | ||
| fun provideHorizonLocalFileDao(db: HorizonDatabase): HorizonLocalFileDao = db.localFileDao() | ||
|
|
||
| @Provides | ||
| fun provideHorizonFileFolderDao(db: HorizonDatabase): HorizonFileFolderDao = db.fileFolderDao() | ||
|
|
||
| @Provides | ||
| @HorizonHtmlParserQualifier | ||
| fun provideHorizonHtmlParser( | ||
| fileSource: HorizonHtmlParserFileSource, | ||
| apiPrefs: ApiPrefs, | ||
| @ApplicationContext context: Context, | ||
| ): HtmlParser = HtmlParser(fileSource, apiPrefs, context) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| /* | ||
| * Copyright (C) 2026 - present Instructure, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package com.instructure.horizon.data.datasource | ||
|
|
||
| import com.instructure.canvasapi2.managers.graphql.horizon.CourseWithProgress | ||
| import com.instructure.canvasapi2.managers.graphql.horizon.journey.Program | ||
| import com.instructure.canvasapi2.managers.graphql.horizon.journey.ProgramRequirement | ||
| import com.instructure.horizon.database.dao.HorizonCourseDao | ||
| import com.instructure.horizon.database.dao.HorizonProgramDao | ||
| import com.instructure.horizon.database.dao.HorizonSyncMetadataDao | ||
| import com.instructure.horizon.database.entity.HorizonCourseEntity | ||
| import com.instructure.horizon.database.entity.HorizonProgramCourseRef | ||
| import com.instructure.horizon.database.entity.HorizonProgramEntity | ||
| import com.instructure.horizon.database.entity.HorizonSyncMetadataEntity | ||
| import com.instructure.horizon.database.entity.SyncDataType | ||
| import com.instructure.journey.type.ProgramProgressCourseEnrollmentStatus | ||
| import com.instructure.journey.type.ProgramVariantType | ||
| import java.util.Date | ||
| import javax.inject.Inject | ||
|
|
||
| class CourseDetailsLocalDataSource @Inject constructor( | ||
| private val courseDao: HorizonCourseDao, | ||
| private val programDao: HorizonProgramDao, | ||
| private val syncMetadataDao: HorizonSyncMetadataDao, | ||
| ) { | ||
|
|
||
| suspend fun getCourse(courseId: Long): CourseWithProgress { | ||
| val entity = courseDao.getByCourseId(courseId) | ||
| ?: throw IllegalStateException("Course $courseId not found in cache") | ||
|
There was a problem hiding this comment. Throwing suspend fun getCourse(courseId: Long): CourseWithProgress? {
return courseDao.getByCourseId(courseId)?.toModel()
} |
||
| return entity.toCourseWithProgress() | ||
| } | ||
|
|
||
| suspend fun getProgramsForCourse(courseId: Long): List<Program> { | ||
| val allPrograms = programDao.getAll() | ||
| return allPrograms.mapNotNull { programEntity -> | ||
| val refs = programDao.getRefsForProgram(programEntity.programId) | ||
| val program = programEntity.toProgram(refs) | ||
| if (program.sortedRequirements.any { it.courseId == courseId }) program else null | ||
| } | ||
| } | ||
|
|
||
| suspend fun saveCourseDetails(course: CourseWithProgress, programs: List<Program>) { | ||
| courseDao.insertIfAbsent(listOf(course.toDefaultEntity())) | ||
| courseDao.updateCourseDetailsFields( | ||
| courseId = course.courseId, | ||
| name = course.courseName, | ||
| progress = course.progress, | ||
| imageUrl = course.courseImageUrl, | ||
| courseSyllabus = course.courseSyllabus, | ||
| ) | ||
| val programEntities = programs.map { it.toEntity() } | ||
| val refs = programs.flatMap { program -> | ||
| program.sortedRequirements.mapIndexed { index, req -> | ||
| HorizonProgramCourseRef( | ||
| programId = program.id, | ||
| courseId = req.courseId, | ||
| requirementId = req.id, | ||
| progressId = req.progressId, | ||
| required = req.required, | ||
| progress = req.progress, | ||
| enrollmentStatus = req.enrollmentStatus?.rawValue, | ||
| sortOrder = index, | ||
| ) | ||
| } | ||
| } | ||
| programDao.insertAll(programEntities) | ||
| programDao.insertAllRefs(refs) | ||
| syncMetadataDao.upsert( | ||
| HorizonSyncMetadataEntity( | ||
| dataType = SyncDataType.COURSE_DETAILS, | ||
| lastSyncedAtMs = System.currentTimeMillis(), | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| private fun HorizonCourseEntity.toCourseWithProgress(): CourseWithProgress { | ||
| return CourseWithProgress( | ||
| courseId = courseId, | ||
| courseName = name, | ||
| courseImageUrl = imageUrl, | ||
| courseSyllabus = courseSyllabus, | ||
| progress = progress, | ||
| ) | ||
| } | ||
|
|
||
| private fun CourseWithProgress.toDefaultEntity(): HorizonCourseEntity { | ||
| return HorizonCourseEntity( | ||
| courseId = courseId, | ||
| name = courseName, | ||
| progress = progress, | ||
| imageUrl = courseImageUrl, | ||
| startAtMs = null, | ||
| endAtMs = null, | ||
| requirementCount = null, | ||
| requirementCompletedCount = null, | ||
| completedAtMs = null, | ||
| grade = null, | ||
| workflowState = null, | ||
| lastActivityAtMs = null, | ||
| enrolledAtMs = null, | ||
| courseSyllabus = courseSyllabus, | ||
| moduleItemsDurations = "", | ||
| ) | ||
| } | ||
|
|
||
| private fun Program.toEntity(): HorizonProgramEntity { | ||
| return HorizonProgramEntity( | ||
| programId = id, | ||
| name = name, | ||
| description = description, | ||
| startDateMs = startDate?.time, | ||
| endDateMs = endDate?.time, | ||
| variant = variant.rawValue, | ||
| estimatedDurationMinutes = null, | ||
| courseCount = sortedRequirements.size, | ||
| courseCompletionCount = courseCompletionCount, | ||
| enrolledAtMs = null, | ||
| completionPercentage = null, | ||
| enrollmentStatus = null, | ||
| ) | ||
| } | ||
|
|
||
| private fun HorizonProgramEntity.toProgram(refs: List<HorizonProgramCourseRef>): Program { | ||
| val requirements = refs.sortedBy { it.sortOrder }.map { ref -> | ||
| ProgramRequirement( | ||
| id = ref.requirementId, | ||
| progressId = ref.progressId, | ||
| courseId = ref.courseId, | ||
| required = ref.required, | ||
| progress = ref.progress, | ||
| enrollmentStatus = ref.enrollmentStatus?.let { | ||
| runCatching { ProgramProgressCourseEnrollmentStatus.valueOf(it) }.getOrNull() | ||
| }, | ||
| ) | ||
| } | ||
|
There was a problem hiding this comment. The error handling here is asymmetric: an unknown Consider logging the unrecognised value (or recording it to Crashlytics) so it surfaces during development rather than silently corrupting displayed data. |
||
| return Program( | ||
| id = programId, | ||
| name = name, | ||
| description = description, | ||
| startDate = startDateMs?.let { Date(it) }, | ||
| endDate = endDateMs?.let { Date(it) }, | ||
| variant = runCatching { ProgramVariantType.valueOf(variant) }.getOrDefault(ProgramVariantType.LINEAR), | ||
| courseCompletionCount = courseCompletionCount, | ||
| sortedRequirements = requirements, | ||
| ) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The progress values changed from fractions (
0.25,1.0) to percentages (25.0,100.0). If the real API contract uses a 0–1 scale this mismatch will cause test assertions to diverge from production behaviour (and vice-versa). Please confirm the expected unit and ensure both the mock data and the display logic use the same scale consistently.