Skip to content

EventScoreAPI #11

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

Open
wants to merge 3 commits into
base: ms-training-2
Choose a base branch
from
Open

EventScoreAPI #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
991f01a
EventScoreAPI and tests
michmitz Dec 24, 2021
436dc97
New edge cases, minor refactor
michmitz Jan 3, 2022
b6ad1c0
Fix algorithm, add correct test expectation
michmitz Jan 4, 2022
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
176 changes: 173 additions & 3 deletions src/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//write tests here
import { CustomError, UserAPI } from "./index"
// //write tests here
import { CustomError, EventScoreAPI, UserAPI } from "./index"

describe('Tests will go here!', () => {
let users: UserAPI
Expand Down Expand Up @@ -223,4 +223,174 @@ describe('Tests will go here!', () => {
}
})
})


describe('EventScore API', () => {
it('Returns an entire array if it is five events or less', () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Might be worth having tests for edge cases: arrays of length 0 and 5.

const events = new EventScoreAPI([
{
timestamp: 123123123,
eventType: "new message",
},
{
timestamp: 123123124,
eventType: "new message",
},
{
timestamp: 123123125,
eventType: "new message",
},
])

const result = events.calcHighestScoreArrSequence()

expect(result).toStrictEqual([
{
timestamp: 123123123,
eventType: "new message",
},
{
timestamp: 123123124,
eventType: "new message",
},
{
timestamp: 123123125,
eventType: "new message",
},
])
})

it('Returns an empty array if there are no events', () => {
const events = new EventScoreAPI([])

const result = events.calcHighestScoreArrSequence()

expect(result).toStrictEqual([])
})

it('Returns an array of five events if the array length is five', () => {
const events = new EventScoreAPI([
{
timestamp: 123123123,
eventType: "new message",
},
{
timestamp: 123123124,
eventType: "new message",
},
{
timestamp: 123123125,
eventType: "new message",
},
{
timestamp: 123123124,
eventType: "new message",
},
{
timestamp: 123123125,
eventType: "new message",
},
])

const result = events.calcHighestScoreArrSequence()

expect(result).toStrictEqual([
{
timestamp: 123123123,
eventType: "new message",
},
{
timestamp: 123123124,
eventType: "new message",
},
{
timestamp: 123123125,
eventType: "new message",
},
{
timestamp: 123123124,
eventType: "new message",
},
{
timestamp: 123123125,
eventType: "new message",
},
])
})

it('Returns a subarray - no greater than 5 contiguous elements - where the total event type score is the highest', () => {
const events = new EventScoreAPI([
{
timestamp: 123123123,
eventType: "new message",
},
{
timestamp: 123123124,
eventType: "view",
},
{
timestamp: 123123125,
eventType: "screenshot",
},
{
timestamp: 123123125,
eventType: "screenshot",
},
{
timestamp: 123123125,
eventType: "screenshot",
},
{
timestamp: 123123125,
eventType: "screenshot",
},
{
timestamp: 123123125,
eventType: "view",
},
{
timestamp: 123123125,
eventType: "screenshot",
},
{
timestamp: 123123125,
eventType: "new message",
},
{
timestamp: 123123125,
eventType: "screenshot",
},
{
timestamp: 123123125,
eventType: "screenshot",
},
{
timestamp: 123123125,
eventType: "screenshot",
},
])
const result = events.calcHighestScoreArrSequence()

expect(result).toStrictEqual([
{
timestamp: 123123124,
eventType: "view",
},
{
timestamp: 123123125,
eventType: "screenshot",
},
{
timestamp: 123123125,
eventType: "screenshot",
},
{
timestamp: 123123125,
eventType: "screenshot",
},
{
timestamp: 123123125,
eventType: "screenshot",
},
])
})
})
61 changes: 60 additions & 1 deletion src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//Define class here
// Define class here

export interface User {
readonly id?: number
Expand Down Expand Up @@ -82,3 +82,62 @@ export class UserAPI {
}
}
}

//
//
// EVENT API

export interface Event {
readonly timestamp: number
readonly eventType: "new message" | "view" | "screenshot"
}

export class EventScoreAPI {
private score: number
private eventArr: ReadonlyArray<Event>

constructor(eventArr: ReadonlyArray<Event>) {
this.eventArr = eventArr
this.score = 0
}

public calcHighestScoreArrSequence = (): ReadonlyArray<Event> => {
let tempCount: number = 0
let highestScoreArr: ReadonlyArray<Event> = []
Copy link
Contributor

Choose a reason for hiding this comment

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

While insignificant in this case, as highestScoreArr is going to have max length of 5, it is possible to solve this without storing the returned highestScoreArr, and instead just directly return it.


if (this.eventArr.length <= 5) {
return this.eventArr
} else {
this.eventArr.forEach((event, i) => {
const { eventType } = event

if (eventType === "screenshot") {
Copy link
Contributor

Choose a reason for hiding this comment

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

Yup, can definitely refactor the conversion of eventType to a scoring value.

tempCount += 3
} else if (eventType === "view") {
tempCount += 2
} else {
tempCount += 1
}

if (i > 4) {
const eventTypeToSubtract = this.eventArr[i - 5].eventType

if (eventTypeToSubtract === "screenshot") {
tempCount -= 3
} else if (eventTypeToSubtract === "view") {
tempCount -= 2
} else {
tempCount -= 1
}
}

if (tempCount > this.score) {
this.score = tempCount
highestScoreArr = this.eventArr.slice(i - 4, i + 1)
return highestScoreArr
}
})
}
return highestScoreArr
}
}