TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-11-23 22:11:09 +03:00
Code Issues Projects Releases Wiki Activity

Moved the last-seen-at-updater to use the publication timezone

Browse Source 
refs https://github.com/TryGhost/Team/issues/1306

- This removes the limitation described in commit ff46449ad6
- The only edge case is that when a publication changes their timezone, it will have maximum 24 hours where the member last_seen_at could be incorrect
This commit is contained in:
Thibaut Patel 2022-03-01 10:28:45 +01:00
parent d2d7fb3fe7
commit bc5b8109e6
3 changed files with 94 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
ghost/members-events-service/lib/last-seen-at-updater.js
View File

@ -1,6 +1,6 @@
const DomainEvents = require('@tryghost/domain-events');
const {MemberPageViewEvent} = require('@tryghost/member-events');
const moment = require('moment');
const moment = require('moment-timezone');
/**
* Listen for `MemberViewEvent` to update the `member.last_seen_at` timestamp
@ -9,10 +9,21 @@ class LastSeenAtUpdater {
/**
* Initializes the event subscriber
* @param {Object} deps dependencies
* @param {any} deps.memberModel The member model
* @param {Object} deps.models The list of model dependencies
* @param {any} deps.models.Member The Member model
* @param {Object} deps.services The list of service dependencies
* @param {any} deps.services.settingsCache The settings service
*/
constructor({memberModel}) {
this._memberModel = memberModel;
constructor({
models: {
Member
},
services: {
settingsCache
}
}) {
this._memberModel = Member;
this._settingsCacheService = settingsCache;
DomainEvents.subscribe(MemberPageViewEvent, async (event) => {
await this.updateLastSeenAt(event.data.memberId, event.data.memberLastSeenAt, event.timestamp);
});
@ -28,7 +39,8 @@ class LastSeenAtUpdater {
* @param {Date} timestamp The event timestamp
*/
async updateLastSeenAt(memberId, memberLastSeenAt, timestamp) {
if (memberLastSeenAt === null || moment(moment.utc(timestamp).startOf('day')).isAfter(moment.utc(memberLastSeenAt).startOf('day'))) {
const timezone = this._settingsCacheService.get('timezone');
if (memberLastSeenAt === null || moment(moment.utc(timestamp).tz(timezone).startOf('day')).isAfter(moment.utc(memberLastSeenAt).tz(timezone).startOf('day'))) {
await this._memberModel.update({
last_seen_at: moment.utc(timestamp).format('YYYY-MM-DD HH:mm:ss')
}, {

2
ghost/members-events-service/package.json
View File

@ -27,6 +27,6 @@
"dependencies": {
"@tryghost/domain-events": "^0.1.7",
"@tryghost/member-events": "^0.3.5",
"moment": "^2.29.1"
"moment-timezone": "^0.5.34"
}
}

82
ghost/members-events-service/test/last-seen-at-updater.test.js
View File

@ -14,9 +14,63 @@ describe('LastSeenAtUpdater', function () {
const now = moment('2022-02-28T18:00:00Z').utc();
const previousLastSeen = moment('2022-02-27T23:00:00Z').toISOString();
const spy = sinon.spy();
const settingsCache = sinon.stub().returns('Etc/UTC');
new LastSeenAtUpdater({
memberModel: {
update: spy
models: {
Member: {
update: spy
}
},
services: {
settingsCache: {
get: settingsCache
}
}
});
DomainEvents.dispatch(MemberPageViewEvent.create({memberId: '1', memberLastSeenAt: previousLastSeen, url: '/'}, now.toDate()));
assert(spy.calledOnceWithExactly({
last_seen_at: now.format('YYYY-MM-DD HH:mm:ss')
}, {
id: '1'
}), 'The LastSeenAtUpdater should attempt a member update with the current date.');
});
it('works correctly on another timezone (not updating last_seen_at)', async function () {
const now = moment('2022-02-28T04:00:00Z').utc();
const previousLastSeen = moment('2022-02-27T20:00:00Z').toISOString();
const spy = sinon.spy();
const settingsCache = sinon.stub().returns('Asia/Bangkok');
new LastSeenAtUpdater({
models: {
Member: {
update: spy
}
},
services: {
settingsCache: {
get: settingsCache
}
}
});
DomainEvents.dispatch(MemberPageViewEvent.create({memberId: '1', memberLastSeenAt: previousLastSeen, url: '/'}, now.toDate()));
assert(spy.notCalled, 'The LastSeenAtUpdater should attempt a member update when the new timestamp is within the same day in the publication timezone.');
});
it('works correctly on another timezone (updating last_seen_at)', async function () {
const now = moment('2022-02-28T04:00:00Z').utc();
const previousLastSeen = moment('2022-02-27T20:00:00Z').toISOString();
const spy = sinon.spy();
const settingsCache = sinon.stub().returns('Europe/Paris');
new LastSeenAtUpdater({
models: {
Member: {
update: spy
}
},
services: {
settingsCache: {
get: settingsCache
}
}
});
DomainEvents.dispatch(MemberPageViewEvent.create({memberId: '1', memberLastSeenAt: previousLastSeen, url: '/'}, now.toDate()));
@ -31,9 +85,17 @@ describe('LastSeenAtUpdater', function () {
const now = moment('2022-02-28T18:00:00Z');
const previousLastSeen = moment('2022-02-28T00:00:00Z').toISOString();
const spy = sinon.spy();
const settingsCache = sinon.stub().returns('Etc/UTC');
new LastSeenAtUpdater({
memberModel: {
update: spy
models: {
Member: {
update: spy
}
},
services: {
settingsCache: {
get: settingsCache
}
}
});
DomainEvents.dispatch(MemberPageViewEvent.create({memberId: '1', memberLastSeenAt: previousLastSeen, url: '/'}, now.toDate()));
@ -43,9 +105,17 @@ describe('LastSeenAtUpdater', function () {
it('Doesn\'t fire on other events', async function () {
const now = moment('2022-02-28T18:00:00Z');
const spy = sinon.spy();
const settingsCache = sinon.stub().returns('Etc/UTC');
new LastSeenAtUpdater({
memberModel: {
update: spy
models: {
Member: {
update: spy
}
},
services: {
settingsCache: {
get: settingsCache
}
}
});
DomainEvents.dispatch(MemberSubscribeEvent.create({memberId: '1', source: 'api'}, now.toDate()));