Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-04-01 02:41:39 -05:00
Code Issues Activity

Refined cache invalidation when updating a user (#19028)

Browse source 
refs https://github.com/TryGhost/Arch/issues/101

Refined the cache invalidation logic so that when updating a user, we
only invalidate the cache when an attribute of the user that is used on
the frontend changes.
This commit is contained in:
Michael Barrett 2023-11-20 14:14:30 +00:00 • committed by GitHub
parent d5492bd63c
commit 55392646e1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 64 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
ghost/core/core/server/api/endpoints/users.js
View file

@ -40,6 +40,39 @@ async function fetchOrCreatePersonalToken(userId) {
return token;
}
function shouldInvalidateCacheAfterChange(model) {
// Model attributes that should trigger cache invalidation when changed
// (because they affect the frontend)
const publicAttrs = [
'name',
'slug',
'profile_image',
'cover_image',
'bio',
'website',
'location',
'facebook',
'twitter',
'status',
'visibility',
'meta_title',
'meta_description'
];
if (model.wasChanged() === false) {
return false;
}
// Check if any of the changed attributes are public
for (const attr of Object.keys(model._changed)) {
if (publicAttrs.includes(attr) === true) {
return true;
}
}
return false;
}
module.exports = {
docName: 'users',
@ -137,11 +170,7 @@ module.exports = {
}));
}
if (model.wasChanged()) {
this.headers.cacheInvalidate = true;
} else {
this.headers.cacheInvalidate = false;
}
this.headers.cacheInvalidate = shouldInvalidateCacheAfterChange(model);
return model;
});

30
ghost/core/test/e2e-api/admin/users.test.js
View file

@ -274,6 +274,36 @@ describe('User API', function () {
jsonResponse.users[0].roles[0].name.should.equal('Administrator');
});
it('Does not trigger cache invalidation when a private attribute on a user has been changed', async function () {
const res = await request.put(localUtils.API.getApiQuery('users/me/'))
.set('Origin', config.get('url'))
.send({
users: [{
comment_notifications: false
}]
})
.expect('Content-Type', /json/)
.expect('Cache-Control', testUtils.cacheRules.private)
.expect(200);
should.equal(res.headers['x-cache-invalidate'], undefined);
});
it('Does not trigger cache invalidation when no attribute on a user has been changed', async function () {
const res = await request.put(localUtils.API.getApiQuery('users/me/'))
.set('Origin', config.get('url'))
.send({
users: [{
facebook: null
}]
})
.expect('Content-Type', /json/)
.expect('Cache-Control', testUtils.cacheRules.private)
.expect(200);
should.equal(res.headers['x-cache-invalidate'], undefined);
});
it('Can destroy an active user and transfer posts to the owner', async function () {
const userId = testUtils.getExistingData().users[1].id;
const userSlug = testUtils.getExistingData().users[1].slug;