Skip to content

Commit 000f6c3

Browse files
ddfridleyddfridley
authored
Merge pull request #218 from EnCiv/get-userranks#205
Get userranks#205
2 parents 3097016 + 282dbf1 commit 000f6c3

10 files changed

+294
-89
lines changed

‎app/dturn/dturn.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -474,7 +474,7 @@ module.exports.putGroupings = putGroupings
474474

475475
function rankMostImportant(discussionId, round, userId, statementId, rank = 1) {
476476
/* this is where we will write it to the database
477-
Rankings.push({statementId,round,ranking: 'most', userId, parentId: discussionId})
477+
Ranks.push({statementId,round,ranking: 'most', userId, parentId: discussionId})
478478
*/
479479
deltaShownItemsRank(discussionId, round, statementId, rank)
480480
Discussions[discussionId].Uitems[userId][round].shownStatementIds[statementId].rank = rank

‎app/models/__tests__/rankings.js ‎app/models/__tests__/ranks.js

+21-14
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,68 @@
11
// https://github.com/EnCiv/civil-pursuit/issues/136
22

33
const { Mongo, Collection } = require('@enciv/mongo-collections')
4-
const Rankings = require('../rankings')
4+
const Ranks = require('../ranks')
55

66
beforeAll(async () => {
77
await Mongo.connect(global.__MONGO_URI__, { useUnifiedTopology: true })
8-
await Rankings.setCollectionProps()
8+
await Ranks.setCollectionProps()
99
})
1010

1111
beforeEach(async () => {
12-
await Rankings.drop()
13-
await Rankings.setCollectionProps()
14-
await Rankings.createIndexes([
15-
{ key: { parentId: 1, userId: 1 }, name: 'unique_parentId_userId_index', unique: true },
16-
])
12+
await Ranks.drop()
13+
await Ranks.setCollectionProps()
14+
await Ranks.createIndexes([{ key: { parentId: 1, userId: 1 }, name: 'unique_parentId_userId_index', unique: true }])
1715
})
1816

1917
afterAll(async () => {
2018
await Mongo.disconnect()
2119
})
2220

23-
describe('Rankings Model', () => {
21+
describe('Ranks Model', () => {
2422
it('should be set up correctly', () => {
25-
expect(Rankings.collectionName).toEqual('rankings')
23+
expect(Ranks.collectionName).toEqual('ranks')
2624
})
2725

2826
it('should insert a valid document', async () => {
2927
const validDoc = {
3028
parentId: 'parent1',
3129
userId: 'user1',
30+
discussionId: 'discussion1',
31+
stage: 'pre',
32+
category: 'category1',
3233
}
33-
const result = await Rankings.insertOne(validDoc)
34+
const result = await Ranks.insertOne(validDoc)
3435
expect(result.acknowledged).toBe(true)
3536
})
3637

3738
it('should not insert an invalid document', async () => {
3839
const invalidDoc = {
3940
userId: 'user1',
4041
}
41-
await expect(Rankings.insertOne(invalidDoc)).rejects.toThrow('Document failed validation')
42+
await expect(Ranks.insertOne(invalidDoc)).rejects.toThrow('Document failed validation')
4243
})
4344

4445
it('should enforce unique indexes', async () => {
4546
const doc1 = {
4647
parentId: 'parent2',
4748
userId: 'user2',
49+
discussionId: 'discussion2',
50+
stage: 'stage2',
51+
category: 'category2',
4852
}
4953
const doc2 = {
5054
parentId: 'parent2',
5155
userId: 'user2',
56+
discussionId: 'discussion2',
57+
stage: 'stage2',
58+
category: 'category2',
5259
}
53-
await Rankings.insertOne(doc1)
54-
await expect(Rankings.insertOne(doc2)).rejects.toThrow('duplicate key error')
60+
await Ranks.insertOne(doc1)
61+
await expect(Ranks.insertOne(doc2)).rejects.toThrow('duplicate key error')
5562
})
5663

5764
it('should have the correct indexes', async () => {
58-
const indexes = await Rankings.indexes()
65+
const indexes = await Ranks.indexes()
5966
expect(indexes).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'unique_parentId_userId_index' })]))
6067
})
6168
})

‎app/models/rankings.js

-36
This file was deleted.

‎app/models/ranks.js

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
// https://github.com/EnCiv/civil-pursuit/issues/136
2+
// https://github.com/EnCiv/civil-pursuit/issues/205
3+
4+
const { Mongo, Collection } = require('@enciv/mongo-collections')
5+
6+
class Ranks extends Collection {
7+
static collectionName = 'ranks'
8+
9+
static collectionOptions = {
10+
validator: {
11+
$jsonSchema: {
12+
bsonType: 'object',
13+
title: 'Ranks Object Validation',
14+
required: ['parentId', 'stage', 'discussionId', 'category', 'userId'],
15+
properties: {
16+
parentId: {
17+
bsonType: 'string',
18+
description: "'parentId' must be a string and is required",
19+
},
20+
stage: {
21+
bsonType: 'string',
22+
description: "'stage' must be a string and is required",
23+
},
24+
discussionId: {
25+
bsonType: 'string',
26+
description: "'discussionId' must be a string and is required",
27+
},
28+
category: {
29+
bsonType: 'string',
30+
description: "'category' must be a string and is required",
31+
},
32+
userId: {
33+
bsonType: 'string',
34+
description: "'userId' must be a string and is required",
35+
},
36+
},
37+
},
38+
},
39+
}
40+
41+
static collectionIndexes = [
42+
{ key: { parentId: 1 }, name: 'parentId_index' },
43+
{ key: { userId: 1 }, name: 'userId_index' },
44+
]
45+
}
46+
47+
Ranks.setCollectionProps()
48+
49+
module.exports = Ranks

‎app/socket-apis/__tests__/get-top-ranked-whys-for-point.js

+42-22
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
const getTopRankedWhysForPoint = require('../get-top-ranked-whys-for-point')
44
const Points = require('../../models/points')
5-
const Rankings = require('../../models/rankings')
5+
const Ranks = require('../../models/ranks')
66
const { Mongo } = require('@enciv/mongo-collections')
77
const { MongoMemoryServer } = require('mongodb-memory-server')
88
const { ObjectId } = require('mongodb')
@@ -25,7 +25,7 @@ afterAll(async () => {
2525
describe('getTopRankedWhysForPoint', () => {
2626
beforeEach(async () => {
2727
await Points.deleteMany({})
28-
await Rankings.deleteMany({})
28+
await Ranks.deleteMany({})
2929
})
3030

3131
test('user is not logged in', async () => {
@@ -66,7 +66,7 @@ describe('getTopRankedWhysForPoint', () => {
6666
expect(cb.mock.calls[0][0].length).toBe(1)
6767
})
6868

69-
test('five whys for the point, different rankings, pageSize is 5', async () => {
69+
test('five whys for the point, different ranks, pageSize is 5', async () => {
7070
const user = { id: USER1 }
7171
const cb = jest.fn()
7272
const whys = Array.from({ length: 5 }, (_, i) => ({
@@ -80,23 +80,27 @@ describe('getTopRankedWhysForPoint', () => {
8080
}))
8181
await Points.insertMany(whys)
8282

83-
const rankings = []
83+
const ranks = []
8484
whys.forEach(why => {
8585
for (let j = 0; j < Math.floor(Math.random() * 10); j++) {
86-
rankings.push({
86+
ranks.push({
8787
_id: new ObjectId(),
8888
parentId: why._id.toString(),
8989
userId: USER1,
90+
round: why.round,
91+
stage: 'pre',
92+
category: why.category,
93+
discussionId: 'discussion-1',
9094
})
9195
}
9296
})
93-
await Rankings.insertMany(rankings)
97+
await Ranks.insertMany(ranks)
9498
await getTopRankedWhysForPoint.call({ synuser: user }, POINT1, 'most', 0, 5, cb)
9599
expect(cb).toHaveBeenCalledWith(expect.any(Array))
96100
expect(cb.mock.calls[0][0].length).toBe(5)
97101
})
98102

99-
test('eleven whys for the point, different rankings, pageSize is 5', async () => {
103+
test('eleven whys for the point, different ranks, pageSize is 5', async () => {
100104
const user = { id: USER1 }
101105
const cb = jest.fn()
102106
const whys = Array.from({ length: 11 }, (_, i) => ({
@@ -110,23 +114,27 @@ describe('getTopRankedWhysForPoint', () => {
110114
}))
111115
await Points.insertMany(whys)
112116

113-
const rankings = []
117+
const ranks = []
114118
whys.forEach(why => {
115119
for (let j = 0; j < Math.floor(Math.random() * 10); j++) {
116-
rankings.push({
120+
ranks.push({
117121
_id: new ObjectId(),
118122
parentId: why._id.toString(),
119123
userId: USER1,
124+
round: why.round,
125+
stage: 'pre',
126+
category: why.category,
127+
discussionId: 'discussion-1',
120128
})
121129
}
122130
})
123-
await Rankings.insertMany(rankings)
131+
await Ranks.insertMany(ranks)
124132
await getTopRankedWhysForPoint.call({ synuser: user }, POINT1, 'most', 0, 5, cb)
125133
expect(cb).toHaveBeenCalledWith(expect.any(Array))
126134
expect(cb.mock.calls[0][0].length).toBe(5)
127135
})
128136

129-
test('eleven whys for the point, different rankings, start is 5, pageSize is 5', async () => {
137+
test('eleven whys for the point, different ranks, start is 5, pageSize is 5', async () => {
130138
const user = { id: USER1 }
131139
const cb = jest.fn()
132140
const whys = Array.from({ length: 11 }, (_, i) => ({
@@ -140,23 +148,27 @@ describe('getTopRankedWhysForPoint', () => {
140148
}))
141149
await Points.insertMany(whys)
142150

143-
const rankings = []
151+
const ranks = []
144152
whys.forEach(why => {
145153
for (let j = 0; j < Math.floor(Math.random() * 10); j++) {
146-
rankings.push({
154+
ranks.push({
147155
_id: new ObjectId(),
148156
parentId: why._id.toString(),
149157
userId: USER1,
158+
round: why.round,
159+
stage: 'pre',
160+
category: why.category,
161+
discussionId: 'discussion-1',
150162
})
151163
}
152164
})
153-
await Rankings.insertMany(rankings)
165+
await Ranks.insertMany(ranks)
154166
await getTopRankedWhysForPoint.call({ synuser: user }, POINT1, 'most', 5, 5, cb)
155167
expect(cb).toHaveBeenCalledWith(expect.any(Array))
156168
expect(cb.mock.calls[0][0].length).toBe(5)
157169
})
158170

159-
test('eleven whys for the point, different rankings, start is 10, pageSize is 5', async () => {
171+
test('eleven whys for the point, different ranks, start is 10, pageSize is 5', async () => {
160172
const user = { id: USER1 }
161173
const cb = jest.fn()
162174
const whys = Array.from({ length: 11 }, (_, i) => ({
@@ -170,23 +182,27 @@ describe('getTopRankedWhysForPoint', () => {
170182
}))
171183
await Points.insertMany(whys)
172184

173-
const rankings = []
185+
const ranks = []
174186
whys.forEach(why => {
175187
for (let j = 0; j < Math.floor(Math.random() * 10); j++) {
176-
rankings.push({
188+
ranks.push({
177189
_id: new ObjectId(),
178190
parentId: why._id.toString(),
179191
userId: USER1,
192+
round: why.round,
193+
stage: 'pre',
194+
category: why.category,
195+
discussionId: 'discussion-1',
180196
})
181197
}
182198
})
183-
await Rankings.insertMany(rankings)
199+
await Ranks.insertMany(ranks)
184200
await getTopRankedWhysForPoint.call({ synuser: user }, POINT1, 'most', 10, 5, cb)
185201
expect(cb).toHaveBeenCalledWith(expect.any(Array))
186202
expect(cb.mock.calls[0][0].length).toBe(1) // Only 1 why should be returned
187203
})
188204

189-
test('eleven whys for the point, different rankings, start is 15, pageSize is 5', async () => {
205+
test('eleven whys for the point, different ranks, start is 15, pageSize is 5', async () => {
190206
const user = { id: USER1 }
191207
const cb = jest.fn()
192208
const whys = Array.from({ length: 11 }, (_, i) => ({
@@ -200,17 +216,21 @@ describe('getTopRankedWhysForPoint', () => {
200216
}))
201217
await Points.insertMany(whys)
202218

203-
const rankings = []
219+
const ranks = []
204220
whys.forEach(why => {
205221
for (let j = 0; j < Math.floor(Math.random() * 10); j++) {
206-
rankings.push({
222+
ranks.push({
207223
_id: new ObjectId(),
208224
parentId: why._id.toString(),
209225
userId: USER1,
226+
round: why.round,
227+
stage: 'pre',
228+
category: why.category,
229+
discussionId: 'discussion-1',
210230
})
211231
}
212232
})
213-
await Rankings.insertMany(rankings)
233+
await Ranks.insertMany(ranks)
214234
await getTopRankedWhysForPoint.call({ synuser: user }, POINT1, 'most', 15, 5, cb)
215235
expect(cb).toHaveBeenCalledWith([]) // No whys should be returned
216236
})

0 commit comments

Comments
 (0)