Merge pull request #3962 from dpalou/MOBILE-4528

MOBILE-4528 chat: Decouple from initial bundle

src/addons/mod/chat/chat.module.ts

@@ -19,12 +19,11 @@ import { CoreCourseHelper } from '@features/course/services/course-helper';
 import { CoreCourseModuleDelegate } from '@features/course/services/module-delegate';
 import { CoreCourseModulePrefetchDelegate } from '@features/course/services/module-prefetch-delegate';
 import { CoreMainMenuTabRoutingModule } from '@features/mainmenu/mainmenu-tab-routing.module';
-import { AddonModChatComponentsModule } from './components/components.module';
-import { AddonModChatProvider } from './services/chat';
 import { AddonModChatIndexLinkHandler } from './services/handlers/index-link';
 import { AddonModChatListLinkHandler } from './services/handlers/list-link';
-import { AddonModChatModuleHandler, AddonModChatModuleHandlerService } from './services/handlers/module';
-import { AddonModChatPrefetchHandler } from './services/handlers/prefetch';
+import { AddonModChatModuleHandler } from './services/handlers/module';
+import { getPrefetchHandlerInstance } from './services/handlers/prefetch';
+import { ADDON_MOD_CHAT_COMPONENT, ADDON_MOD_CHAT_PAGE_NAME } from './constants';
 
 /**
  * Get mod chat services.
@@ -41,29 +40,40 @@ export async function getModChatServices(): Promise<Type<unknown>[]> {
     ];
 }
 
+/**
+ * Get mod chat component modules.
+ *
+ * @returns Chat component modules.
+ */
+export async function getModChatComponentModules(): Promise<unknown[]> {
+    const { AddonModChatComponentsModule } = await import('@addons/mod/chat/components/components.module');
+
+    return [AddonModChatComponentsModule];
+}
+
 const routes: Routes = [
     {
-        path: AddonModChatModuleHandlerService.PAGE_NAME,
+        path: ADDON_MOD_CHAT_PAGE_NAME,
         loadChildren: () => import('./chat-lazy.module').then(m => m.AddonModChatLazyModule),
     },
 ];
 
 @NgModule({
     imports: [
         CoreMainMenuTabRoutingModule.forChild(routes),
-        AddonModChatComponentsModule,
     ],
     providers: [
         {
             provide: APP_INITIALIZER,
             multi: true,
             useValue: () => {
+                CoreCourseModulePrefetchDelegate.registerHandler(getPrefetchHandlerInstance());
+
                 CoreCourseModuleDelegate.registerHandler(AddonModChatModuleHandler.instance);
                 CoreContentLinksDelegate.registerHandler(AddonModChatIndexLinkHandler.instance);
                 CoreContentLinksDelegate.registerHandler(AddonModChatListLinkHandler.instance);
-                CoreCourseModulePrefetchDelegate.registerHandler(AddonModChatPrefetchHandler.instance);
 
-                CoreCourseHelper.registerModuleReminderClick(AddonModChatProvider.COMPONENT);
+                CoreCourseHelper.registerModuleReminderClick(ADDON_MOD_CHAT_COMPONENT);
             },
         },
     ],

src/addons/mod/chat/components/index/index.ts

@@ -19,8 +19,8 @@ import { IonContent } from '@ionic/angular';
 import { CoreNavigator } from '@services/navigator';
 import { CoreTimeUtils } from '@services/utils/time';
 import { CoreTime } from '@singletons/time';
-import { AddonModChat, AddonModChatChat, AddonModChatProvider } from '../../services/chat';
-import { AddonModChatModuleHandlerService } from '../../services/handlers/module';
+import { AddonModChat, AddonModChatChat } from '../../services/chat';
+import { ADDON_MOD_CHAT_COMPONENT, ADDON_MOD_CHAT_PAGE_NAME } from '../../constants';
 
 /**
  * Component that displays a chat.
@@ -31,7 +31,7 @@ import { AddonModChatModuleHandlerService } from '../../services/handlers/module
 })
 export class AddonModChatIndexComponent extends CoreCourseModuleMainActivityComponent implements OnInit {
 
-    component = AddonModChatProvider.COMPONENT;
+    component = ADDON_MOD_CHAT_COMPONENT;
     pluginName = 'chat';
     chat?: AddonModChatChat;
     chatTime?: string;
@@ -88,7 +88,7 @@ export class AddonModChatIndexComponent extends CoreCourseModuleMainActivityComp
         const title = this.chat?.name || this.moduleName;
 
         CoreNavigator.navigateToSitePath(
-            AddonModChatModuleHandlerService.PAGE_NAME + `/${this.courseId}/${this.module.id}/chat`,
+            `${ADDON_MOD_CHAT_PAGE_NAME}/${this.courseId}/${this.module.id}/chat`,
             {
                 params: {
                     title,
@@ -103,7 +103,7 @@ export class AddonModChatIndexComponent extends CoreCourseModuleMainActivityComp
      */
     viewSessions(): void {
         CoreNavigator.navigateToSitePath(
-            AddonModChatModuleHandlerService.PAGE_NAME + `/${this.courseId}/${this.module.id}/sessions`,
+            `${ADDON_MOD_CHAT_PAGE_NAME}/${this.courseId}/${this.module.id}/sessions`,
             {
                 params: {
                     chatId: this.chat!.id,

src/addons/mod/chat/constants.ts

@@ -0,0 +1,23 @@
+// (C) Copyright 2015 Moodle Pty Ltd.
+//
+// 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.
+
+export const ADDON_MOD_CHAT_COMPONENT = 'mmaModChat';
+
+// Routing.
+export const ADDON_MOD_CHAT_PAGE_NAME = 'mod_chat';
+
+// Handlers.
+export const ADDON_MOD_CHAT_PREFETCH_NAME = 'AddonModChat';
+export const ADDON_MOD_CHAT_PREFETCH_MODNAME = 'chat';
+export const ADDON_MOD_CHAT_PREFETCH_COMPONENT = ADDON_MOD_CHAT_PAGE_NAME;

src/addons/mod/chat/pages/chat/chat.ts

@@ -26,7 +26,7 @@ import { NgZone, Translate } from '@singletons';
 import { CoreEvents } from '@singletons/events';
 import { Subscription } from 'rxjs';
 import { AddonModChatUsersModalComponent, AddonModChatUsersModalResult } from '../../components/users-modal/users-modal';
-import { AddonModChat, AddonModChatProvider, AddonModChatUser } from '../../services/chat';
+import { AddonModChat, AddonModChatUser } from '../../services/chat';
 import { AddonModChatFormattedMessage, AddonModChatHelper } from '../../services/chat-helper';
 import { CoreTime } from '@singletons/time';
 import { CoreAnalytics, CoreAnalyticsEventType } from '@services/analytics';
@@ -41,6 +41,8 @@ import { CoreAnalytics, CoreAnalyticsEventType } from '@services/analytics';
 })
 export class AddonModChatChatPage implements OnInit, OnDestroy, CanLeave {
 
+    protected static readonly POLL_INTERVAL = 4000;
+
     @ViewChild(IonContent) content?: IonContent;
     @ViewChild(CoreSendMessageFormComponent) sendMessageForm?: CoreSendMessageFormComponent;
 
@@ -252,7 +254,7 @@ export class AddonModChatChatPage implements OnInit, OnDestroy, CanLeave {
         // Start polling.
         this.polling = window.setInterval(() => {
             CoreUtils.ignoreErrors(this.fetchMessagesInterval());
-        }, AddonModChatProvider.POLL_INTERVAL);
+        }, AddonModChatChatPage.POLL_INTERVAL);
     }
 
     /**

src/addons/mod/chat/services/chat.ts

@@ -22,17 +22,15 @@ import { CoreUser } from '@features/user/services/user';
 import { CoreSites, CoreSitesCommonWSOptions, CoreSitesReadingStrategy } from '@services/sites';
 import { CoreWSExternalFile, CoreWSExternalWarning } from '@services/ws';
 import { makeSingleton, Translate } from '@singletons';
-
-const ROOT_CACHE_KEY = 'AddonModChat:';
+import { ADDON_MOD_CHAT_COMPONENT } from '../constants';
 
 /**
  * Service that provides some features for chats.
  */
 @Injectable({ providedIn: 'root' })
 export class AddonModChatProvider {
 
-    static readonly COMPONENT = 'mmaModChat';
-    static readonly POLL_INTERVAL = 4000;
+    protected static readonly ROOT_CACHE_KEY = 'AddonModChat:';
 
     /**
      * Get a chat.
@@ -51,7 +49,7 @@ export class AddonModChatProvider {
         const preSets: CoreSiteWSPreSets = {
             cacheKey: this.getChatsCacheKey(courseId),
             updateFrequency: CoreSite.FREQUENCY_RARELY,
-            component: AddonModChatProvider.COMPONENT,
+            component: ADDON_MOD_CHAT_COMPONENT,
             ...CoreSites.getReadingStrategyPreSets(options.readingStrategy), // Include reading strategy preSets.
         };
 
@@ -99,7 +97,7 @@ export class AddonModChatProvider {
         await CoreCourseLogHelper.log(
             'mod_chat_view_chat',
             params,
-            AddonModChatProvider.COMPONENT,
+            ADDON_MOD_CHAT_COMPONENT,
             id,
             siteId,
         );
@@ -126,7 +124,7 @@ export class AddonModChatProvider {
         await CoreCourseLogHelper.log(
             'mod_chat_view_sessions',
             params,
-            AddonModChatProvider.COMPONENT,
+            ADDON_MOD_CHAT_COMPONENT,
             id,
         );
     }
@@ -232,7 +230,7 @@ export class AddonModChatProvider {
             chatsid: sessionId,
         };
         const preSets: CoreSiteWSPreSets = {
-            component: AddonModChatProvider.COMPONENT,
+            component: ADDON_MOD_CHAT_COMPONENT,
             componentId: options.cmId,
             ...CoreSites.getReadingStrategyPreSets(options.readingStrategy), // Include reading strategy preSets.
         };
@@ -265,7 +263,7 @@ export class AddonModChatProvider {
         const preSets: CoreSiteWSPreSets = {
             cacheKey: this.getSessionsCacheKey(chatId, groupId, showAll),
             updateFrequency: CoreSite.FREQUENCY_SOMETIMES,
-            component: AddonModChatProvider.COMPONENT,
+            component: ADDON_MOD_CHAT_COMPONENT,
             componentId: options.cmId,
             ...CoreSites.getReadingStrategyPreSets(options.readingStrategy), // Include reading strategy preSets.
         };
@@ -303,7 +301,7 @@ export class AddonModChatProvider {
         const preSets: CoreSiteWSPreSets = {
             cacheKey: this.getSessionMessagesCacheKey(chatId, sessionStart, groupId),
             updateFrequency: CoreSite.FREQUENCY_RARELY,
-            component: AddonModChatProvider.COMPONENT,
+            component: ADDON_MOD_CHAT_COMPONENT,
             componentId: options.cmId,
             ...CoreSites.getReadingStrategyPreSets(options.readingStrategy), // Include reading strategy preSets.
         };
@@ -393,7 +391,7 @@ export class AddonModChatProvider {
      * @returns Cache key.
      */
     protected getChatsCacheKey(courseId: number): string {
-        return ROOT_CACHE_KEY + 'chats:' + courseId;
+        return AddonModChatProvider.ROOT_CACHE_KEY + 'chats:' + courseId;
     }
 
     /**
@@ -415,7 +413,7 @@ export class AddonModChatProvider {
      * @returns Cache key prefix.
      */
     protected getSessionsCacheKeyPrefix(chatId: number): string {
-        return ROOT_CACHE_KEY + 'sessions:' + chatId + ':';
+        return AddonModChatProvider.ROOT_CACHE_KEY + 'sessions:' + chatId + ':';
     }
 
     /**
@@ -437,7 +435,7 @@ export class AddonModChatProvider {
      * @returns Cache key prefix.
      */
     protected getSessionMessagesCacheKeyPrefix(chatId: number): string {
-        return ROOT_CACHE_KEY + 'sessionsMessages:' + chatId + ':';
+        return AddonModChatProvider.ROOT_CACHE_KEY + 'sessionsMessages:' + chatId + ':';
     }
 
 }

src/addons/mod/chat/services/handlers/module.ts

@@ -17,19 +17,17 @@ import { Injectable, Type } from '@angular/core';
 import { CoreModuleHandlerBase } from '@features/course/classes/module-base-handler';
 import { CoreCourseModuleHandler } from '@features/course/services/module-delegate';
 import { makeSingleton } from '@singletons';
-import { AddonModChatIndexComponent } from '../../components/index';
+import { ADDON_MOD_CHAT_PAGE_NAME } from '../../constants';
 
 /**
  * Handler to support chat modules.
  */
 @Injectable({ providedIn: 'root' })
 export class AddonModChatModuleHandlerService extends CoreModuleHandlerBase implements CoreCourseModuleHandler {
 
-    static readonly PAGE_NAME = 'mod_chat';
-
     name = 'AddonModChat';
     modName = 'chat';
-    protected pageName = AddonModChatModuleHandlerService.PAGE_NAME;
+    protected pageName = ADDON_MOD_CHAT_PAGE_NAME;
 
     supportedFeatures = {
         [CoreConstants.FEATURE_GROUPS]: true,
@@ -47,6 +45,8 @@ export class AddonModChatModuleHandlerService extends CoreModuleHandlerBase impl
      * @inheritdoc
      */
     async getMainComponent(): Promise<Type<unknown>> {
+        const { AddonModChatIndexComponent } = await import('@addons/mod/chat/components/index');
+
         return AddonModChatIndexComponent;
     }