refactor(DataService): add modifiers and remove unused code (#2026)

WISE-Community · Dec 20, 2024 · f4e35e2 · f4e35e2
1 parent 867d8a2
commit f4e35e2
Show file tree

Hide file tree

Showing 17 changed files with 183 additions and 305 deletions.
diff --git a/...omMonitorComponents/milestones/milestone-grading-view/milestone-grading-view.component.ts b/...omMonitorComponents/milestones/milestone-grading-view/milestone-grading-view.component.ts
@@ -32,23 +32,23 @@ export class MilestoneGradingViewComponent extends NodeGradingViewComponent {
     protected annotationService: AnnotationService,
     protected classroomStatusService: ClassroomStatusService,
     protected configService: ConfigService,
+    protected dataService: TeacherDataService,
     protected dialog: MatDialog,
     protected milestoneService: MilestoneService,
     protected notificationService: NotificationService,
     protected peerGroupService: TeacherPeerGroupService,
-    protected projectService: TeacherProjectService,
-    protected teacherDataService: TeacherDataService
+    protected projectService: TeacherProjectService
   ) {
     super(
       annotationService,
       classroomStatusService,
       configService,
+      dataService,
       dialog,
       milestoneService,
       notificationService,
       peerGroupService,
-      projectService,
-      teacherDataService
+      projectService
     );
   }
 
@@ -57,9 +57,8 @@ export class MilestoneGradingViewComponent extends NodeGradingViewComponent {
     this.node = this.projectService.getNode(this.nodeId);
     if (this.milestone.report.locations.length > 1) {
       this.firstNodeId = this.milestone.report.locations[0].nodeId;
-      this.lastNodeId = this.milestone.report.locations[
-        this.milestone.report.locations.length - 1
-      ].nodeId;
+      this.lastNodeId =
+        this.milestone.report.locations[this.milestone.report.locations.length - 1].nodeId;
     }
     this.componentId = this.milestone.componentId;
     this.retrieveStudentData();
@@ -131,15 +130,7 @@ export class MilestoneGradingViewComponent extends NodeGradingViewComponent {
       componentType = null,
       category = 'Navigation',
       data = { milestoneId: this.milestone.id };
-    this.teacherDataService.saveEvent(
-      context,
-      nodeId,
-      componentId,
-      componentType,
-      category,
-      event,
-      data
-    );
+    this.dataService.saveEvent(context, nodeId, componentId, componentType, category, event, data);
   }
 
   onUpdateExpand({ workgroupId, value }): void {
@@ -185,15 +176,7 @@ export class MilestoneGradingViewComponent extends NodeGradingViewComponent {
       componentType = null,
       category = 'Navigation',
       data = { milestoneId: this.milestone.id, workgroupId: workgroupId };
-    this.teacherDataService.saveEvent(
-      context,
-      nodeId,
-      componentId,
-      componentType,
-      category,
-      event,
-      data
-    );
+    this.dataService.saveEvent(context, nodeId, componentId, componentType, category, event, data);
   }
 
   protected sortWorkgroups(): void {

diff --git a/...r/classroomMonitorComponents/nodeGrading/node-grading-view/node-grading-view.component.ts b/...r/classroomMonitorComponents/nodeGrading/node-grading-view/node-grading-view.component.ts
@@ -49,12 +49,12 @@ export class NodeGradingViewComponent implements OnInit {
     protected annotationService: AnnotationService,
     protected classroomStatusService: ClassroomStatusService,
     protected configService: ConfigService,
+    protected dataService: TeacherDataService,
     protected dialog: MatDialog,
     protected milestoneService: MilestoneService,
     protected notificationService: NotificationService,
     protected peerGroupService: TeacherPeerGroupService,
-    protected projectService: TeacherProjectService,
-    protected teacherDataService: TeacherDataService
+    protected projectService: TeacherProjectService
   ) {}
 
   ngOnInit(): void {
@@ -66,7 +66,7 @@ export class NodeGradingViewComponent implements OnInit {
     this.maxScore = this.getMaxScore();
     this.node = this.projectService.getNode(this.nodeId);
     this.nodeHasWork = this.projectService.nodeHasWork(this.nodeId);
-    this.sort = this.teacherDataService.nodeGradingSort;
+    this.sort = this.dataService.nodeGradingSort;
     this.nodeContent = this.projectService.getNodeById(this.nodeId);
     this.milestoneReport = this.milestoneService.getMilestoneReportByNodeId(this.nodeId);
     this.peerGroupingTags = Array.from(this.peerGroupService.getPeerGroupingTags(this.node));
@@ -113,7 +113,7 @@ export class NodeGradingViewComponent implements OnInit {
     );
 
     this.subscriptions.add(
-      this.teacherDataService.studentWorkReceived$.subscribe(({ studentWork }) => {
+      this.dataService.studentWorkReceived$.subscribe(({ studentWork }) => {
         const workgroupId = studentWork.workgroupId;
         if (studentWork.nodeId === this.nodeId && this.workgroupsById[workgroupId]) {
           this.updateWorkgroup(workgroupId);
@@ -122,14 +122,14 @@ export class NodeGradingViewComponent implements OnInit {
     );
 
     this.subscriptions.add(
-      this.teacherDataService.currentPeriodChanged$.subscribe(() => {
+      this.dataService.currentPeriodChanged$.subscribe(() => {
         this.milestoneReport = this.milestoneService.getMilestoneReportByNodeId(this.nodeId);
       })
     );
   }
 
   protected retrieveStudentData(node: Node = this.node): void {
-    this.teacherDataService.retrieveStudentDataForNode(node).subscribe(() => {
+    this.dataService.retrieveStudentDataForNode(node).subscribe(() => {
       this.teacherWorkgroupId = this.configService.getWorkgroupId();
       this.workgroups = copy(this.configService.getClassmateUserInfos()).filter(
         (workgroup) =>
@@ -298,7 +298,7 @@ export class NodeGradingViewComponent implements OnInit {
   }
 
   private getLatestWorkTimeByWorkgroupId(workgroupId: number): string {
-    const componentStates = this.teacherDataService.getComponentStatesByNodeId(this.nodeId);
+    const componentStates = this.dataService.getComponentStatesByNodeId(this.nodeId);
     for (const componentState of componentStates.reverse()) {
       if (componentState.workgroupId === workgroupId) {
         return componentState.serverSaveTime;
@@ -308,7 +308,7 @@ export class NodeGradingViewComponent implements OnInit {
   }
 
   private getLatestAnnotationTimeByWorkgroupId(workgroupId: number): string {
-    const annotations = this.teacherDataService.getAnnotationsByNodeId(this.nodeId);
+    const annotations = this.dataService.getAnnotationsByNodeId(this.nodeId);
     for (const annotation of annotations.reverse()) {
       // TODO: support checking for annotations from shared teachers
       if (
@@ -346,14 +346,14 @@ export class NodeGradingViewComponent implements OnInit {
   getNodeCompletion(nodeId: string): number {
     return this.classroomStatusService.getNodeCompletion(
       nodeId,
-      this.teacherDataService.getCurrentPeriodId()
+      this.dataService.getCurrentPeriodId()
     ).completionPct;
   }
 
   getNodeAverageScore(): any {
     const averageScore = this.classroomStatusService.getNodeAverageScore(
       this.nodeId,
-      this.teacherDataService.getCurrentPeriodId()
+      this.dataService.getCurrentPeriodId()
     );
     if (averageScore === null) {
       return 'N/A';
@@ -363,7 +363,7 @@ export class NodeGradingViewComponent implements OnInit {
   }
 
   isWorkgroupShown(workgroup: any): boolean {
-    return this.teacherDataService.isWorkgroupShown(workgroup);
+    return this.dataService.isWorkgroupShown(workgroup);
   }
 
   protected showRubric(): void {
@@ -379,7 +379,7 @@ export class NodeGradingViewComponent implements OnInit {
     } else {
       this.sort = value;
     }
-    this.teacherDataService.nodeGradingSort = this.sort;
+    this.dataService.nodeGradingSort = this.sort;
     this.sortWorkgroups();
   }
 

diff --git a/...ssets/wise5/classroomMonitor/dataExport/strategies/AbstractComponentDataExportStrategy.ts b/...ssets/wise5/classroomMonitor/dataExport/strategies/AbstractComponentDataExportStrategy.ts
@@ -98,7 +98,7 @@ export abstract class AbstractComponentDataExportStrategy extends AbstractDataEx
   protected abstract getComponentTypeWithUnderscore(): string;
 
   protected getComponentStates(component: any): ComponentState[] {
-    let componentStates = this.teacherDataService.getComponentStatesByComponentId(component.id);
+    let componentStates = this.dataService.getComponentStatesByComponentId(component.id);
     this.sortByWorkgroupIdAndTimestamp(componentStates);
     this.calculateRevisionNumbers(componentStates);
     if (this.allOrLatest === 'latest') {

diff --git a/src/assets/wise5/classroomMonitor/dataExport/strategies/AbstractDataExportStrategy.ts b/src/assets/wise5/classroomMonitor/dataExport/strategies/AbstractDataExportStrategy.ts
@@ -17,7 +17,7 @@ export abstract class AbstractDataExportStrategy implements DataExportStrategy {
   dataExportService: DataExportService;
   projectService: TeacherProjectService;
   protected allOrLatest: 'all' | 'latest' = 'all';
-  teacherDataService: TeacherDataService;
+  dataService: TeacherDataService;
 
   setDataExportContext(context: DataExportContext) {
     this.context = context;
@@ -26,7 +26,7 @@ export abstract class AbstractDataExportStrategy implements DataExportStrategy {
     this.configService = context.controller.configService;
     this.dataExportService = context.controller.dataExportService;
     this.projectService = context.controller.projectService;
-    this.teacherDataService = context.controller.dataService;
+    this.dataService = context.controller.dataService;
   }
 
   abstract export();

diff --git a/...wise5/classroomMonitor/dataExport/strategies/DialogGuidanceComponentDataExportStrategy.ts b/...wise5/classroomMonitor/dataExport/strategies/DialogGuidanceComponentDataExportStrategy.ts
@@ -26,7 +26,7 @@ export class DialogGuidanceComponentDataExportStrategy extends AbstractComponent
 
   private addDialogGuidanceSpecificHeaderColumns(component: any, headerRow: string[]): void {
     headerRow.push(this.itemIdLabel);
-    const componentStates = this.teacherDataService.getComponentStatesByComponentId(component.id);
+    const componentStates = this.dataService.getComponentStatesByComponentId(component.id);
     const ideaNames = this.getIdeaNames(componentStates);
     const scoreNames = this.getScoreNames(componentStates);
     for (let i = 1; i <= this.getMaxNumberOfStudentResponses(componentStates); i++) {

diff --git a/...ets/wise5/classroomMonitor/dataExport/strategies/DiscussionComponentDataExportStrategy.ts b/...ets/wise5/classroomMonitor/dataExport/strategies/DiscussionComponentDataExportStrategy.ts
@@ -44,7 +44,7 @@ export class DiscussionComponentDataExportStrategy extends AbstractComponentData
     nodeId: string
   ) {
     const rows = [];
-    const componentStates = this.teacherDataService.getComponentStatesByComponentId(component.id);
+    const componentStates = this.dataService.getComponentStatesByComponentId(component.id);
     const structuredPosts = this.getStructuredPosts(componentStates);
     let rowCounter = 1;
     for (let threadId of Object.keys(structuredPosts)) {

diff --git a/src/assets/wise5/classroomMonitor/dataExport/strategies/ExportStrategyTester.ts b/src/assets/wise5/classroomMonitor/dataExport/strategies/ExportStrategyTester.ts
@@ -55,7 +55,7 @@ export class ExportStrategyTester {
   studentWorkTimestamp2 = millisecondsToDateTime(this.studentWorkTimestampMilliseconds2);
   studentWorkTimestamp3 = millisecondsToDateTime(this.studentWorkTimestampMilliseconds3);
   studentWorkTimestamp4 = millisecondsToDateTime(this.studentWorkTimestampMilliseconds4);
-  teacherDataService: TeacherDataService;
+  dataService: TeacherDataService;
   teacherProjectService: TeacherProjectService;
   teacherWebSocketService: TeacherWebSocketService = new TeacherWebSocketService(
     null,
@@ -117,10 +117,10 @@ export class ExportStrategyTester {
   }
 
   setUpTeacherDataService(): void {
-    this.teacherDataService = new TeacherDataService(
-      null,
+    this.dataService = new TeacherDataService(
       this.annotationService,
       this.configService,
+      null,
       this.teacherProjectService,
       this.teacherWebSocketService
     );
@@ -138,15 +138,15 @@ export class ExportStrategyTester {
     this.componentExportStrategy.configService = this.configService;
     this.componentExportStrategy.dataExportService = this.dataExportService;
     this.componentExportStrategy.projectService = this.teacherProjectService;
-    this.componentExportStrategy.teacherDataService = this.teacherDataService;
+    this.componentExportStrategy.dataService = this.dataService;
   }
 
   createDataExportComponent(): any {
     const controller = new ExportItemComponent(
       this.annotationService,
       this.configService,
       this.dataExportService,
-      this.teacherDataService,
+      this.dataService,
       null,
       this.teacherProjectService,
       null,
@@ -159,7 +159,7 @@ export class ExportStrategyTester {
   }
 
   setStudentData(componentStates: any[]): void {
-    this.teacherDataService.processComponentStates(componentStates);
+    this.dataService.processComponentStates(componentStates);
   }
 
   setAnnotations(annotations: any[]): void {

diff --git a/src/assets/wise5/classroomMonitor/dataExport/strategies/LabelComponentDataExportStrategy.ts b/src/assets/wise5/classroomMonitor/dataExport/strategies/LabelComponentDataExportStrategy.ts
@@ -13,7 +13,7 @@ export class LabelComponentDataExportStrategy extends AbstractComponentDataExpor
 
   protected generateComponentHeaderRow(component: any): string[] {
     const headerRow = [...this.defaultColumnNames];
-    const componentStates = this.teacherDataService.getComponentStatesByComponentId(component.id);
+    const componentStates = this.dataService.getComponentStatesByComponentId(component.id);
     const maxCountLabel = this.getMaxLabelCount(componentStates);
     for (let i = 1; i <= maxCountLabel; i++) {
       headerRow.push(`Label ${i}`);

diff --git a/...sets/wise5/classroomMonitor/dataExport/strategies/OneWorkgroupPerRowDataExportStrategy.ts b/...sets/wise5/classroomMonitor/dataExport/strategies/OneWorkgroupPerRowDataExportStrategy.ts
@@ -116,7 +116,7 @@ export class OneWorkgroupPerRowDataExportStrategy extends AbstractDataExportStra
                 if (this.exportComponent(selectedNodesMap, nodeId, componentId)) {
                   var columnIdPrefix = nodeId + '-' + componentId;
                   var componentState =
-                    this.teacherDataService.getLatestComponentStateByWorkgroupIdNodeIdAndComponentId(
+                    this.dataService.getLatestComponentStateByWorkgroupIdNodeIdAndComponentId(
                       workgroupId,
                       nodeId,
                       componentId
@@ -247,7 +247,7 @@ export class OneWorkgroupPerRowDataExportStrategy extends AbstractDataExportStra
 
   private getLatestBranchPathTakenEvent(workgroupId: number, nodeId: string): any {
     return (
-      this.teacherDataService
+      this.dataService
         .getEventsByWorkgroupId(workgroupId)
         .findLast((event) => event.nodeId === nodeId && event.event === 'branchPathTaken') ?? null
     );

diff --git a/...ssets/wise5/classroomMonitor/dataExport/strategies/PeerChatComponentDataExportStrategy.ts b/...ssets/wise5/classroomMonitor/dataExport/strategies/PeerChatComponentDataExportStrategy.ts
@@ -30,7 +30,7 @@ export class PeerChatComponentDataExportStrategy extends AbstractComponentDataEx
 
   protected generateComponentHeaderRow(component: any): string[] {
     const headerRow = [...this.defaultColumnNames];
-    const componentStates = this.teacherDataService.getComponentStatesByComponentId(component.id);
+    const componentStates = this.dataService.getComponentStatesByComponentId(component.id);
     this.insertPromptColumns(headerRow, component);
     this.insertQuestionColumns(headerRow, component, componentStates);
     return headerRow;
@@ -110,7 +110,7 @@ export class PeerChatComponentDataExportStrategy extends AbstractComponentDataEx
     columnNameToNumber: any,
     nodeId: string
   ): any[] {
-    const componentStates = this.teacherDataService.getComponentStatesByComponentId(component.id);
+    const componentStates = this.dataService.getComponentStatesByComponentId(component.id);
     const sortedComponentStates = this.sortByPeerGroupIdAndTimestamp(componentStates);
     const workRows = [];
     for (let r = 0; r < sortedComponentStates.length; r++) {

diff --git a/src/assets/wise5/classroomMonitor/dataExport/strategies/RawDataExportStrategy.ts b/src/assets/wise5/classroomMonitor/dataExport/strategies/RawDataExportStrategy.ts
@@ -39,9 +39,7 @@ export class RawDataExportStrategy extends AbstractDataExportStrategy {
           var workgroupId = workgroup.workgroupId;
           if (this.controller.includeStudentWork) {
             workgroup.studentWork = [];
-            var componentStates = this.teacherDataService.getComponentStatesByWorkgroupId(
-              workgroupId
-            );
+            var componentStates = this.dataService.getComponentStatesByWorkgroupId(workgroupId);
             if (componentStates != null) {
               for (var c = 0; c < componentStates.length; c++) {
                 var componentState = componentStates[c];
@@ -59,7 +57,7 @@ export class RawDataExportStrategy extends AbstractDataExportStrategy {
           }
           if (this.controller.includeAnnotations) {
             workgroup.annotations = [];
-            var annotations = this.teacherDataService.getAnnotationsToWorkgroupId(workgroupId);
+            var annotations = this.dataService.getAnnotationsToWorkgroupId(workgroupId);
             if (annotations != null) {
               for (var a = 0; a < annotations.length; a++) {
                 var annotation = annotations[a];
@@ -77,7 +75,7 @@ export class RawDataExportStrategy extends AbstractDataExportStrategy {
           }
           if (this.controller.includeEvents) {
             workgroup.events = [];
-            var events = this.teacherDataService.getEventsByWorkgroupId(workgroupId);
+            var events = this.dataService.getEventsByWorkgroupId(workgroupId);
             if (events != null) {
               for (var e = 0; e < events.length; e++) {
                 var event = events[e];

diff --git a/src/assets/wise5/classroomMonitor/dataExport/strategies/StudentWorkDataExportStrategy.ts b/src/assets/wise5/classroomMonitor/dataExport/strategies/StudentWorkDataExportStrategy.ts
@@ -93,10 +93,10 @@ export class StudentWorkDataExportStrategy extends AbstractDataExportStrategy {
         var componentRevisionCounter = {};
         let componentStates = [];
         if (this.exportType === 'allStudentWork') {
-          componentStates = this.teacherDataService.getComponentStatesByWorkgroupId(workgroupId);
+          componentStates = this.dataService.getComponentStatesByWorkgroupId(workgroupId);
         } else if (this.exportType === 'latestStudentWork') {
           this.injectRevisionCounterIntoComponentStates(
-            this.teacherDataService.getComponentStatesByWorkgroupId(workgroupId)
+            this.dataService.getComponentStatesByWorkgroupId(workgroupId)
           );
           componentStates = this.getLatestComponentStatesByWorkgroupId(workgroupId);
         }
@@ -171,7 +171,7 @@ export class StudentWorkDataExportStrategy extends AbstractDataExportStrategy {
     const componentStates = [];
     const componentsFound = {};
     const componentStatesForWorkgroup =
-      this.teacherDataService.getComponentStatesByWorkgroupId(workgroupId);
+      this.dataService.getComponentStatesByWorkgroupId(workgroupId);
     for (let csb = componentStatesForWorkgroup.length - 1; csb >= 0; csb--) {
       const componentState = componentStatesForWorkgroup[csb];
       const key = componentState.nodeId + '-' + componentState.componentId;