Skip to content

Commit

Permalink
fix(Events): Duplicate node entered and node exited events (#1875)
Browse files Browse the repository at this point in the history
  • Loading branch information
@geoffreykwan
geoffreykwan authored Aug 4, 2024
1 parent d59eaca commit bb7e816
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 87 deletions.
15 changes: 12 additions & 3 deletions src/assets/wise5/services/studentDataService.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,20 @@ export class StudentDataService extends DataService {
private componentDirtySource: Subject<boolean> = new Subject<boolean>();
public componentDirty$: Observable<any> = this.componentDirtySource.asObservable();
private componentSaveTriggeredSource: Subject<boolean> = new Subject<boolean>();
public componentSaveTriggered$: Observable<any> = this.componentSaveTriggeredSource.asObservable();
public componentSaveTriggered$: Observable<any> =
this.componentSaveTriggeredSource.asObservable();
private componentSubmitDirtySource: Subject<boolean> = new Subject<boolean>();
public componentSubmitDirty$: Observable<any> = this.componentSubmitDirtySource.asObservable();
private componentSubmitTriggeredSource: Subject<boolean> = new Subject<boolean>();
public componentSubmitTriggered$: Observable<any> = this.componentSubmitTriggeredSource.asObservable();
public componentSubmitTriggered$: Observable<any> =
this.componentSubmitTriggeredSource.asObservable();
private componentStudentDataSource: Subject<any> = new Subject<any>();
public componentStudentData$: Observable<any> = this.componentStudentDataSource.asObservable();
private dataRetrievedSource: Subject<any> = new Subject<any>();
public dataRetrieved$: Observable<any> = this.dataRetrievedSource.asObservable();
private studentWorkSavedToServerSource: Subject<any> = new Subject<any>();
public studentWorkSavedToServer$: Observable<any> = this.studentWorkSavedToServerSource.asObservable();
public studentWorkSavedToServer$: Observable<any> =
this.studentWorkSavedToServerSource.asObservable();
private navItemIsExpandedSource: Subject<any> = new Subject<any>();
public navItemIsExpanded$: Observable<any> = this.navItemIsExpandedSource.asObservable();
private nodeStatusesChangedSource: Subject<void> = new Subject<void>();
Expand Down Expand Up @@ -281,6 +284,12 @@ export class StudentDataService extends DataService {
return this.saveToServer(componentStates, events, annotations);
}

saveEvents(events: any): Promise<any> {
const componentStates = undefined;
const annotations = undefined;
return this.saveToServer(componentStates, events, annotations);
}

createNewEvent(nodeId, componentId, context, componentType, category, event, data) {
return {
nodeId: nodeId,
Expand Down
59 changes: 14 additions & 45 deletions src/assets/wise5/vle/node/node.component.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,16 +133,20 @@ export class NodeComponent implements OnInit {
})
);

this.studentDataService.currentNodeChanged$.subscribe(() => {
this.nodeUnloaded(this.node.id);
if (this.node.isEvaluateTransitionLogicOn('exitNode')) {
this.nodeService.evaluateTransitionLogic();
}
this.initializeNode();
});
this.studentDataService.nodeStatusesChanged$.subscribe(() => {
this.updateComponentVisibility();
});
this.subscriptions.add(
this.studentDataService.currentNodeChanged$.subscribe(() => {
if (this.node.isEvaluateTransitionLogicOn('exitNode')) {
this.nodeService.evaluateTransitionLogic();
}
this.initializeNode();
})
);

this.subscriptions.add(
this.studentDataService.nodeStatusesChanged$.subscribe(() => {
this.updateComponentVisibility();
})
);
}

initializeNode(): void {
Expand All @@ -165,22 +169,6 @@ export class NodeComponent implements OnInit {
this.latestComponentState = latestComponentState;
}

const componentId = null;
const componentType = null;
const category = 'Navigation';
const event = 'nodeEntered';
const eventData = {
nodeId: this.node.id
};
this.studentDataService.saveVLEEvent(
this.node.id,
componentId,
componentType,
category,
event,
eventData
);

if (this.configService.isPreview()) {
this.rubric = this.node.rubric;
this.showRubric = this.rubric != null && this.rubric != '';
Expand Down Expand Up @@ -444,29 +432,10 @@ export class NodeComponent implements OnInit {
);
}

private nodeUnloaded(nodeId: string): void {
const componentId = null;
const componentType = null;
const category = 'Navigation';
const event = 'nodeExited';
const eventData = {
nodeId: nodeId
};
this.studentDataService.saveVLEEvent(
nodeId,
componentId,
componentType,
category,
event,
eventData
);
}

private registerExitListener(): void {
this.subscriptions.add(
this.sessionService.exit$.subscribe(() => {
this.stopAutoSaveInterval();
this.nodeUnloaded(this.node.id);
})
);
}
Expand Down
82 changes: 43 additions & 39 deletions src/assets/wise5/vle/vle.component.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { ActivatedRoute, Router } from '@angular/router';
import { WiseLinkService } from '../../../app/services/wiseLinkService';
import { convertToPNGFile } from '../common/canvas/canvas';
import { NodeStatusService } from '../services/nodeStatusService';
import { DomSanitizer, SafeResourceUrl } from '@angular/platform-browser';
import { SafeResourceUrl } from '@angular/platform-browser';

@Component({
selector: 'vle',
Expand Down Expand Up @@ -55,6 +55,11 @@ export class VLEComponent implements AfterViewInit {
private wiseLinkService: WiseLinkService
) {}

@HostListener('window:beforeunload')
beforeUnload(): void {
this.saveNodeExitedEvent();
}

ngAfterViewInit(): void {
this.initializeVLEService.initialized$.subscribe((initialized: boolean) => {
if (initialized) {
Expand Down Expand Up @@ -103,6 +108,7 @@ export class VLEComponent implements AfterViewInit {
this.currentNode = this.studentDataService.getCurrentNode();
this.setLayoutState();
this.initializeSubscriptions();
this.saveNodeEnteredEvent();
}

ngOnDestroy() {
Expand Down Expand Up @@ -165,49 +171,17 @@ export class VLEComponent implements AfterViewInit {
this.subscriptions.add(
this.studentDataService.currentNodeChanged$.subscribe(({ previousNode }) => {
this.currentNode = this.studentDataService.getCurrentNode();
let currentNodeId = this.currentNode.id;

const currentNodeId = this.currentNode.id;
this.studentDataService.updateStackHistory(currentNodeId);
this.nodeStatusService.setNodeIsVisited(currentNodeId);

let componentId, componentType, category, eventName, eventData, eventNodeId;
if (previousNode != null && this.projectService.isGroupNode(previousNode.id)) {
// going from group to node or group to group
componentId = null;
componentType = null;
category = 'Navigation';
eventName = 'nodeExited';
eventData = {
nodeId: previousNode.id
};
eventNodeId = previousNode.id;
this.studentDataService.saveVLEEvent(
eventNodeId,
componentId,
componentType,
category,
eventName,
eventData
);
const events = [];
if (previousNode != null) {
events.push(this.createNodeExitedEvent(previousNode.id));
}
events.push(this.createNodeEnteredEvent());
this.studentDataService.saveEvents(events);

if (this.projectService.isGroupNode(currentNodeId)) {
componentId = null;
componentType = null;
category = 'Navigation';
eventName = 'nodeEntered';
eventData = {
nodeId: currentNodeId
};
eventNodeId = currentNodeId;
this.studentDataService.saveVLEEvent(
eventNodeId,
componentId,
componentType,
category,
eventName,
eventData
);
} else {
this.scrollToTop();
}
Expand Down Expand Up @@ -387,4 +361,34 @@ export class VLEComponent implements AfterViewInit {
}
};
}

private saveNodeEnteredEvent(): void {
this.studentDataService.saveEvents([this.createNodeEnteredEvent()]);
}

private saveNodeExitedEvent(): void {
this.studentDataService.saveEvents([this.createNodeExitedEvent()]);
}

private createNodeEnteredEvent(): any {
return this.createNodeEvent('nodeEntered');
}

private createNodeExitedEvent(nodeId: string = this.currentNode.id): any {
return this.createNodeEvent('nodeExited', nodeId);
}

private createNodeEvent(eventName: string, nodeId: string = this.currentNode.id): any {
return this.studentDataService.createNewEvent(
nodeId,
null,
'VLE',
null,
'Navigation',
eventName,
{
nodeId: nodeId
}
);
}
}

0 comments on commit bb7e816

Please sign in to comment.