Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(AnnotationService): getLatestScoreAnnotation() #1469

Merged
merged 2 commits into from
Oct 16, 2023
Merged

refactor(AnnotationService): getLatestScoreAnnotation() #1469

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5191b41
refactor(AnnotationService): getLatestScoreAnnotation()
hirokiterashima Oct 13, 2023
63332bd
getLatestAnnotations() return null instead of undefined
hirokiterashima Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/app/classroom-monitor/component-new-work-badge/component-new-work-badge.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ export class ComponentNewWorkBadgeComponent {
}
let latestTeacherScore = null;
if (latestAnnotations && latestAnnotations.score) {
if (latestAnnotations.score !== 'autoScore') {
if (latestAnnotations.score.type !== 'autoScore') {
latestTeacherScore = latestAnnotations.score;
}
}
Expand Down
77 changes: 59 additions & 18 deletions src/app/services/annotationService.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,41 +5,82 @@ import { AnnotationService } from '../../assets/wise5/services/annotationService
import { ProjectService } from '../../assets/wise5/services/projectService';
import { StudentTeacherCommonServicesModule } from '../student-teacher-common-services.module';
import demoProjectJSON_import from './sampleData/curriculum/Demo.project.json';
import { Annotation } from '../../assets/wise5/common/Annotation';

let service: AnnotationService;
let projectService: ProjectService;
let demoProjectJSON: any;

const annotations = [
{
toWorkgroupId: 1,
type: 'score',
nodeId: 'node2',
componentId: '7edwu1p29b',
data: { value: 1 }
},
{
toWorkgroupId: 1,
type: 'autoScore',
nodeId: 'node3',
componentId: '0sef5ya2wj',
data: { value: 2 }
}
];
const annotation1 = {
toWorkgroupId: 1,
type: 'score',
nodeId: 'node2',
componentId: '7edwu1p29b',
data: { value: 1 }
};
const annotation2 = {
toWorkgroupId: 1,
type: 'comment',
nodeId: 'node2',
componentId: '7edwu1p29b',
data: { value: 'Nice job!' }
};
const annotation3 = {
toWorkgroupId: 1,
type: 'autoScore',
nodeId: 'node3',
componentId: '0sef5ya2wj',
data: { value: 2 }
};
const annotation4 = {
toWorkgroupId: 1,
type: 'autoScore',
nodeId: 'node2',
componentId: '7edwu1p29b',
data: { value: 5 }
};
const annotations = [annotation1, annotation2, annotation3, annotation4];

describe('AnnotationService', () => {
beforeEach(() => {
TestBed.configureTestingModule({
imports: [HttpClientTestingModule, StudentTeacherCommonServicesModule]
});
service = TestBed.inject(AnnotationService);
service.annotations = annotations as Annotation[];
projectService = TestBed.inject(ProjectService);
demoProjectJSON = copy(demoProjectJSON_import);
projectService.setProject(demoProjectJSON);
});
getLatestScoreAnnotation();
getTotalScore();
});

function getLatestScoreAnnotation() {
describe('getLatestScoreAnnotation()', () => {
getLatestScoreAnnotation_NoMatch_ReturnNull();
getLatestScoreAnnotation_MultipleMatches_ReturnLatestAnnotation();
});
}

function getLatestScoreAnnotation_NoMatch_ReturnNull() {
describe('no matching annotation is found', () => {
it('returns null', () => {
expect(service.getLatestScoreAnnotation('nodeX', 'componentX', 10, 'any')).toBeUndefined();
});
});
}

function getLatestScoreAnnotation_MultipleMatches_ReturnLatestAnnotation() {
describe('multiple annotations are found', () => {
it('returns latest annotation', () => {
expect(service.getLatestScoreAnnotation('node2', '7edwu1p29b', 1, 'any')).toEqual(
annotation4 as Annotation
);
});
});
}

function getTotalScore() {
describe('getTotalScore()', () => {
getTotalScore_noAnnotationForWorkgroup_return0();
Expand All @@ -57,7 +98,7 @@ function getTotalScore_noAnnotationForWorkgroup_return0() {

function getTotalScore_returnSumScoresAutoScoresForWorkgroup() {
it('should return sum of annotation scores and autoscores for workgroup', () => {
expect(service.getTotalScore(annotations)).toEqual(3);
expect(service.getTotalScore(annotations)).toEqual(7);
});
}

Expand All @@ -73,6 +114,6 @@ function getTotalScore_omitInActiveNodes() {
function getTotalScore_omitExcludFromTotalScoreNodes() {
it('should omit scores for nodes marked as excludeFromTotalScore', () => {
projectService.getComponent('node3', '0sef5ya2wj').excludeFromTotalScore = true;
expect(service.getTotalScore(annotations)).toEqual(1);
expect(service.getTotalScore(annotations)).toEqual(5);
});
}
3 changes: 2 additions & 1 deletion src/app/services/studentPeerGroupService.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ import { ProjectService } from '../../assets/wise5/services/projectService';
import { StudentDataService } from '../../assets/wise5/services/studentDataService';
import { StudentPeerGroupService } from '../../assets/wise5/services/studentPeerGroupService';
import { StudentTeacherCommonServicesModule } from '../student-teacher-common-services.module';
import { Annotation } from '../../assets/wise5/common/Annotation';

let annotationService: AnnotationService;
const componentId1 = 'component1';
let configService: ConfigService;
const dummyAnnotation = { id: 200, data: {} };
const dummyAnnotation = { id: 200, data: {} } as Annotation;
const dummyStudentData = { id: 100, studentData: {} };
let http: HttpClient;
const nodeId1 = 'node1';
Expand Down
3 changes: 2 additions & 1 deletion src/assets/wise5/common/constraint/strategies/ScoreConstraintStrategy.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { AnnotationService } from '../../../services/annotationService';
import { ConfigService } from '../../../services/configService';
import { StudentDataService } from '../../../services/studentDataService';
import { ScoreConstraintStrategy } from './ScoreConstraintStrategy';
import { Annotation } from '../../Annotation';

let annotationService: AnnotationService;
let configService: ConfigService;
Expand Down Expand Up @@ -47,7 +48,7 @@ function evaluate() {

function expectEvaluate(criteria: any, score: number, expected: boolean): void {
spyOn(configService, 'getWorkgroupId').and.returnValue(1);
spyOn(annotationService, 'getLatestScoreAnnotation').and.returnValue({});
spyOn(annotationService, 'getLatestScoreAnnotation').and.returnValue({} as Annotation);
spyOn(annotationService, 'getScoreValueFromScoreAnnotation').and.returnValue(score);
expect(strategy.evaluate(criteria)).toEqual(expected);
}
80 changes: 26 additions & 54 deletions src/assets/wise5/services/annotationService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,7 +443,7 @@ export class AnnotationService {
nodeId,
componentId,
workgroupId,
scoreType = null,
scoreType: 'score' | 'autoScore' | 'any' = 'any',
commentType = null
) {
let latestScoreAnnotation = this.getLatestScoreAnnotation(
Expand Down Expand Up @@ -530,59 +530,31 @@ export class AnnotationService {
return null;
}

/**
* Get the latest score annotation
* @param nodeId the node id
* @param componentId the component id
* @param workgroupId the workgroup id
* @param scoreType (optional) the type of score
* e.g.
* 'autoScore' for auto graded score
* 'score' for teacher graded score
* 'any' for auto graded score or teacher graded score
* @returns the latest score annotation
*/
getLatestScoreAnnotation(nodeId, componentId, workgroupId, scoreType = null) {
let annotation = null;
const annotations = this.getAnnotations();

if (scoreType == null) {
scoreType = 'any';
}

for (let a = annotations.length - 1; a >= 0; a--) {
const tempAnnotation = annotations[a];
if (tempAnnotation != null) {
let acceptAnnotation = false;
const tempNodeId = tempAnnotation.nodeId;
const tempComponentId = tempAnnotation.componentId;
const tempToWorkgroupId = tempAnnotation.toWorkgroupId;
const tempAnnotationType = tempAnnotation.type;

if (
nodeId == tempNodeId &&
componentId == tempComponentId &&
workgroupId == tempToWorkgroupId
) {
if (
scoreType === 'any' &&
(tempAnnotationType === 'autoScore' || tempAnnotationType === 'score')
) {
acceptAnnotation = true;
} else if (scoreType === 'autoScore' && tempAnnotationType === 'autoScore') {
acceptAnnotation = true;
} else if (scoreType === 'score' && tempAnnotationType === 'score') {
acceptAnnotation = true;
}

if (acceptAnnotation) {
annotation = tempAnnotation;
break;
}
}
}
}
return annotation;
getLatestScoreAnnotation(
nodeId: string,
componentId: string,
workgroupId: number,
scoreType: 'score' | 'autoScore' | 'any' = 'any'
): Annotation {
return this.getAnnotations()
.filter(
(annotation) =>
annotation.nodeId == nodeId &&
annotation.componentId == componentId &&
annotation.toWorkgroupId == workgroupId &&
this.matchesScoreType(annotation, scoreType)
)
.at(-1);
}

private matchesScoreType(
annotation: Annotation,
scoreType: 'score' | 'autoScore' | 'any'
): boolean {
return (
['autoScore', 'score'].includes(annotation.type) &&
(scoreType === 'any' || annotation.type === scoreType)
);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be something like this to be more concise?

    return (
      (scoreType === 'any' && ['autoScore', 'score'].includes(annotation.type)) ||
      annotation.type === scoreType
    );

}

isThereAnyScoreAnnotation(nodeId, componentId, periodId) {
Expand Down
Loading