1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308import type { CollectionPermission, Payload, PayloadRequest } from 'payload'
import assert from 'assert'
import path from 'path'
import { createLocalReq } from 'payload'
import { getEntityPermissions } from 'payload/internal'
import { fileURLToPath } from 'url'
import { afterAll, beforeAll, describe, expect, it, vitest } from 'vitest'
import { initPayloadInt } from '../helpers/initPayloadInt.js'
import { whereCacheSameSlug, whereCacheUniqueSlug } from './shared.js'
const filename = fileURLToPath(import.meta.url)
const dirname = path.dirname(filename)
const describePostgres = process.env.PAYLOAD_DATABASE?.startsWith('postgres')
? describe
: describe.skip
let payload: Payload
let req: PayloadRequest
describePostgres('Access Control - postgres logs', () => {
beforeAll(async () => {
const initialized = await initPayloadInt(
dirname,
undefined,
undefined,
'config.postgreslogs.ts',
)
assert(initialized.payload)
assert(initialized.restClient)
;({ payload } = initialized)
req = await createLocalReq(
{
user: {
id: 123 as any,
collection: 'users',
roles: ['admin'],
createdAt: new Date().toISOString(),
updatedAt: new Date().toISOString(),
email: 'test@test.com',
},
},
payload,
)
})
afterAll(async () => {
if (payload) {
await payload.destroy()
}
})
describe('Tests', () => {
describe('where query cache - same where queries', () => {
it('should cache identical where queries across operations, without passing data (2 DB calls total)', async () => {
const doc = await payload.create({
collection: whereCacheSameSlug,
data: {
title: 'Test Document',
userRole: 'admin',
},
})
const consoleCount = vitest.spyOn(console, 'log').mockImplementation(() => {})
// Get permissions - all operations return same where query
const permissions = await getEntityPermissions({
id: doc.id,
blockReferencesPermissions: {} as any,
entity: payload.collections[whereCacheSameSlug].config,
entityType: 'collection',
operations: ['read', 'update', 'delete'],
fetchData: true,
req,
})
// 1 db call across all operations due to cache, + 1 for the document fetch
expect(consoleCount).toHaveBeenCalledTimes(2)
consoleCount.mockRestore()
expect(permissions).toEqual({
fields: {
title: { read: { permission: true }, update: { permission: true } },
userRole: { read: { permission: true }, update: { permission: true } },
updatedAt: { read: { permission: true }, update: { permission: true } },
createdAt: { read: { permission: true }, update: { permission: true } },
},
read: { permission: true, where: { userRole: { equals: 'admin' } } },
update: { permission: true, where: { userRole: { equals: 'admin' } } },
delete: { permission: true, where: { userRole: { equals: 'admin' } } },
} satisfies CollectionPermission)
})
it('should cache identical where queries across operations, with passing data (1 DB call total)', async () => {
const doc = await payload.create({
collection: whereCacheSameSlug,
data: {
title: 'Test Document',
userRole: 'noAccess',
},
})
const consoleCount = vitest.spyOn(console, 'log').mockImplementation(() => {})
// Get permissions - all operations return same where query
const permissions = await getEntityPermissions({
id: doc.id,
blockReferencesPermissions: {} as any,
entity: payload.collections[whereCacheSameSlug].config,
entityType: 'collection',
operations: ['read', 'update', 'delete'],
fetchData: true,
req,
data: doc,
})
// 1 db call across all operations due to cache
expect(consoleCount).toHaveBeenCalledTimes(1)
consoleCount.mockRestore()
expect(permissions).toEqual({
fields: {
title: { read: { permission: false }, update: { permission: false } },
userRole: { read: { permission: false }, update: { permission: false } },
updatedAt: { read: { permission: false }, update: { permission: false } },
createdAt: { read: { permission: false }, update: { permission: false } },
},
read: { permission: false, where: { userRole: { equals: 'admin' } } },
update: { permission: false, where: { userRole: { equals: 'admin' } } },
delete: { permission: false, where: { userRole: { equals: 'admin' } } },
} satisfies CollectionPermission)
})
})
describe('where query cache - unique where queries', () => {
it('should handle unique where queries per operation (1 DB call per operation)', async () => {
const doc = await payload.create({
collection: whereCacheUniqueSlug,
data: {
title: 'Test Document',
readRole: 'admin',
updateRole: 'noAccess',
deleteRole: 'admin',
},
})
const consoleCount = vitest.spyOn(console, 'log').mockImplementation(() => {})
// Get permissions - each operation returns unique where query
const permissions = await getEntityPermissions({
id: doc.id,
blockReferencesPermissions: {} as any,
entity: payload.collections[whereCacheUniqueSlug].config,
entityType: 'collection',
operations: ['read', 'update', 'delete'],
fetchData: true,
req,
})
// 3 access control operations with unique where + 1 for the document fetch, since we're not passing data.
expect(consoleCount).toHaveBeenCalledTimes(4)
consoleCount.mockRestore()
expect(permissions).toEqual({
fields: {
title: { read: { permission: true }, update: { permission: false } },
readRole: { read: { permission: true }, update: { permission: false } },
updateRole: { read: { permission: true }, update: { permission: false } },
deleteRole: { read: { permission: true }, update: { permission: false } },
updatedAt: { read: { permission: true }, update: { permission: false } },
createdAt: { read: { permission: true }, update: { permission: false } },
},
read: { permission: true, where: { readRole: { equals: 'admin' } } },
update: { permission: false, where: { updateRole: { equals: 'admin' } } },
delete: { permission: true, where: { deleteRole: { equals: 'admin' } } },
} satisfies CollectionPermission)
})
it('should handle unique where queries per operation (1 DB call per operation), no data fetch when passing data', async () => {
const doc = await payload.create({
collection: whereCacheUniqueSlug,
data: {
title: 'Test Document',
readRole: 'admin',
updateRole: 'noAccess',
deleteRole: 'admin',
},
})
const consoleCount = vitest.spyOn(console, 'log').mockImplementation(() => {})
// Get permissions - each operation returns unique where query
const permissions = await getEntityPermissions({
id: doc.id,
blockReferencesPermissions: {} as any,
entity: payload.collections[whereCacheUniqueSlug].config,
entityType: 'collection',
operations: ['read', 'update', 'delete'],
fetchData: true,
req,
data: doc,
})
// 3 access control operations with unique where, no data fetch since we're passing data
expect(consoleCount).toHaveBeenCalledTimes(3)
consoleCount.mockRestore()
expect(permissions).toEqual({
fields: {
title: { read: { permission: true }, update: { permission: false } },
readRole: { read: { permission: true }, update: { permission: false } },
updateRole: { read: { permission: true }, update: { permission: false } },
deleteRole: { read: { permission: true }, update: { permission: false } },
updatedAt: { read: { permission: true }, update: { permission: false } },
createdAt: { read: { permission: true }, update: { permission: false } },
},
read: { permission: true, where: { readRole: { equals: 'admin' } } },
update: { permission: false, where: { updateRole: { equals: 'admin' } } },
delete: { permission: true, where: { deleteRole: { equals: 'admin' } } },
} satisfies CollectionPermission)
})
it('should return correct permissions with mixed results', async () => {
const doc = await payload.create({
collection: whereCacheUniqueSlug,
data: {
title: 'Test Document 2',
readRole: 'noAccess',
updateRole: 'admin',
deleteRole: 'noAccess',
},
})
const permissions = await getEntityPermissions({
id: doc.id,
blockReferencesPermissions: {} as any,
entity: payload.collections[whereCacheUniqueSlug].config,
entityType: 'collection',
operations: ['read', 'update', 'delete'],
fetchData: true,
req,
})
expect(permissions).toEqual({
fields: {
title: { read: { permission: false }, update: { permission: true } },
readRole: { read: { permission: false }, update: { permission: true } },
updateRole: { read: { permission: false }, update: { permission: true } },
deleteRole: { read: { permission: false }, update: { permission: true } },
updatedAt: { read: { permission: false }, update: { permission: true } },
createdAt: { read: { permission: false }, update: { permission: true } },
},
read: { permission: false, where: { readRole: { equals: 'admin' } } },
delete: { permission: false, where: { deleteRole: { equals: 'admin' } } },
update: { permission: true, where: { updateRole: { equals: 'admin' } } },
} satisfies CollectionPermission)
})
it('ensure no db calls when fetchData is false', async () => {
const _doc = await payload.create({
collection: whereCacheUniqueSlug,
data: {
title: 'Test Document',
readRole: 'admin',
updateRole: 'noAccess',
deleteRole: 'admin',
},
})
const consoleCount = vitest.spyOn(console, 'log').mockImplementation(() => {})
// Get permissions - each operation returns unique where query
const permissions = await getEntityPermissions({
blockReferencesPermissions: {} as any,
entity: payload.collections[whereCacheUniqueSlug].config,
entityType: 'collection',
operations: ['read', 'update', 'delete'],
fetchData: false,
req,
})
expect(consoleCount).toHaveBeenCalledTimes(0)
consoleCount.mockRestore()
expect(permissions).toEqual({
// TODO: Permissions currently default to true when fetchData is false, this should be changed to false in 4.0.
fields: {
title: { read: { permission: true }, update: { permission: true } },
readRole: { read: { permission: true }, update: { permission: true } },
updateRole: { read: { permission: true }, update: { permission: true } },
deleteRole: { read: { permission: true }, update: { permission: true } },
updatedAt: { read: { permission: true }, update: { permission: true } },
createdAt: { read: { permission: true }, update: { permission: true } },
},
read: { permission: true, where: { readRole: { equals: 'admin' } } },
update: { permission: true, where: { updateRole: { equals: 'admin' } } },
delete: { permission: true, where: { deleteRole: { equals: 'admin' } } },
} satisfies CollectionPermission)
})
})
})
})