CIT/Vmeda.Online
3
0
Fork 1
forked from EVOgeek/Vmeda.Online
Code Pull Requests Activity

MOBILE-2556 course: Decrease WS calls to get_courses_by_field

Browse Source
This commit is contained in:
Dani Palou 2018-08-23 08:23:51 +02:00
parent cfb58c96f6
commit cb8195a3f4
1 changed files with 67 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
src/core/courses/providers/courses.ts
View File

@ -349,6 +349,35 @@ export class CoreCoursesProvider {
return this.ROOT_CACHE_KEY + 'course:' + JSON.stringify(ids);
}
/**
* This function is meant to decrease WS calls.
* When requesting a single course that belongs to enrolled courses, request all enrolled courses because
* the WS call is probably cached.
*
* @param {string} [field] The field to search.
* @param {any} [value] The value to match.
* @param {string} [siteId] Site ID. If not defined, use current site.
* @return {Promise<{field: string, value: any}>} Promise resolved with the field and value to use.
*/
protected fixCoursesByFieldParams(field?: string, value?: any, siteId?: string): Promise<{field: string, value: any}> {
if (field == 'id' || field == 'ids') {
const courseIds: any[] = String(value).split(',');
// Use the same optimization as in get admin and nav options. This will return the course IDs to use.
return this.getCourseIdsForAdminAndNavOptions(courseIds, siteId).then((courseIds) => {
if (courseIds.length > 1) {
return {field: 'ids', value: courseIds.join(',')};
} else {
return {field: 'id', value: Number(courseIds[0])};
}
});
} else {
// Nothing to do.
return Promise.resolve({field: field, value: value});
}
}
/**
* Get courses. They can be filtered by field.
*
@ -363,7 +392,18 @@ export class CoreCoursesProvider {
* @return {Promise<any[]>} Promise resolved with the courses.
*/
getCoursesByField(field?: string, value?: any, siteId?: string): Promise<any[]> {
return this.sitesProvider.getSite(siteId).then((site) => {
siteId = siteId || this.sitesProvider.getCurrentSiteId();
const originalValue = value;
let hasChanged = false;
return this.fixCoursesByFieldParams(field, value, siteId).then((result) => {
hasChanged = result.field != field || result.value != value;
field = result.field;
value = result.value;
return this.sitesProvider.getSite(siteId);
}).then((site) => {
const data = {
field: field || '',
value: field ? value : ''
@ -374,6 +414,24 @@ export class CoreCoursesProvider {
return site.read('core_course_get_courses_by_field', data, preSets).then((courses) => {
if (courses.courses) {
if (field == 'ids' && hasChanged) {
// The list of courses requestes was changed to optimize it.
// Return only the ones that were being requested.
const courseIds = String(originalValue).split(','),
finalCourses = [];
courses.courses.forEach((course) => {
const position = courseIds.indexOf(String(course.id));
if (position != -1) {
// Course is in the original list, take it.
finalCourses.push(course);
courseIds.splice(position, 1);
}
});
courses.courses = finalCourses;
}
// Courses will be sorted using sortorder if avalaible.
return courses.courses.sort((a, b) => {
if (typeof a.sortorder == 'undefined' && typeof b.sortorder == 'undefined') {
@ -717,7 +775,14 @@ export class CoreCoursesProvider {
* @return {Promise<any>} Promise resolved when the data is invalidated.
*/
invalidateCoursesByField(field?: string, value?: any, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
siteId = siteId || this.sitesProvider.getCurrentSiteId();
return this.fixCoursesByFieldParams(field, value, siteId).then((result) => {
field = result.field;
value = result.value;
return this.sitesProvider.getSite(siteId);
}).then((site) => {
return site.invalidateWsCacheForKey(this.getCoursesByFieldCacheKey(field, value));
});
}