mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-09-11 12:55:37 +03:00
Refactored members stats module into class
refs #12537 - Class syntax is preferred over module functions because of constructor parameter injection (DI) which allows for easier module decoupling and testing
This commit is contained in:
parent
e62c4075f0
commit
10304c79a4
@ -4,7 +4,6 @@ const Promise = require('bluebird');
|
||||
const moment = require('moment-timezone');
|
||||
const errors = require('@tryghost/errors');
|
||||
const GhostMailer = require('../../services/mail').GhostMailer;
|
||||
const config = require('../../../shared/config');
|
||||
const models = require('../../models');
|
||||
const membersService = require('../../services/members');
|
||||
const jobsService = require('../../services/jobs');
|
||||
@ -417,15 +416,9 @@ module.exports = {
|
||||
}
|
||||
},
|
||||
async query(frame) {
|
||||
const siteTimezone = settingsCache.get('timezone');
|
||||
const days = frame.options.days === 'all-time' ? 'all-time' : Number(frame.options.days || 30);
|
||||
const isSQLite = config.get('database:client') === 'sqlite3';
|
||||
|
||||
return await membersService.stats({
|
||||
siteTimezone,
|
||||
days,
|
||||
isSQLite
|
||||
});
|
||||
return await membersService.stats.fetch(days);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
@ -1,7 +1,8 @@
|
||||
const MembersSSR = require('@tryghost/members-ssr');
|
||||
|
||||
const db = require('../../data/db');
|
||||
const MembersConfigProvider = require('./config');
|
||||
const MembersCSVImporter = require('./importer');
|
||||
const MembersStats = require('./stats');
|
||||
const createMembersApiInstance = require('./api');
|
||||
const createMembersSettingsInstance = require('./settings');
|
||||
const {events} = require('../../lib/common');
|
||||
@ -95,7 +96,11 @@ const membersService = {
|
||||
|
||||
importer: new MembersCSVImporter({storagePath: config.getContentPath('data')}, settingsCache, () => membersApi),
|
||||
|
||||
stats: require('./stats')
|
||||
stats: new MembersStats({
|
||||
db: db,
|
||||
settingsCache: settingsCache,
|
||||
isSQLite: config.get('database:client') === 'sqlite3'
|
||||
})
|
||||
};
|
||||
|
||||
module.exports = membersService;
|
||||
|
@ -1,37 +1,66 @@
|
||||
const moment = require('moment-timezone');
|
||||
const Promise = require('bluebird');
|
||||
const db = require('../../../data/db');
|
||||
|
||||
const stats = async ({siteTimezone, days, isSQLite}) => {
|
||||
const dateFormat = 'YYYY-MM-DD HH:mm:ss';
|
||||
const tzOffsetMins = moment.tz(siteTimezone).utcOffset();
|
||||
|
||||
// get total members before other stats because the figure is used multiple times
|
||||
async function getTotalMembers() {
|
||||
const result = await db.knex.raw('SELECT COUNT(id) AS total FROM members');
|
||||
return isSQLite ? result[0].total : result[0][0].total;
|
||||
const dateFormat = 'YYYY-MM-DD HH:mm:ss';
|
||||
class MembersStats {
|
||||
constructor({db, settingsCache, isSQLite}) {
|
||||
this._db = db;
|
||||
this._settingsCache = settingsCache;
|
||||
this._isSQLite = isSQLite;
|
||||
}
|
||||
const totalMembers = await getTotalMembers();
|
||||
|
||||
async function getTotalMembersInRange() {
|
||||
/**
|
||||
* Fetches count of all members
|
||||
*/
|
||||
async getTotalMembers() {
|
||||
const result = await this._db.knex.raw('SELECT COUNT(id) AS total FROM members');
|
||||
return this._isSQLite ? result[0].total : result[0][0].total;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param {Number | String} days - number of days to fetch of 'all-time' to get for all existing records
|
||||
* @param {Number} totalMembers - number of registered members
|
||||
* @param {String} siteTimezone - site's current timezone
|
||||
*/
|
||||
async getTotalMembersInRange({days, totalMembers, siteTimezone}) {
|
||||
if (days === 'all-time') {
|
||||
return totalMembers;
|
||||
}
|
||||
|
||||
const startOfRange = moment.tz(siteTimezone).subtract(days - 1, 'days').startOf('day').utc().format(dateFormat);
|
||||
const result = await db.knex.raw('SELECT COUNT(id) AS total FROM members WHERE created_at >= ?', [startOfRange]);
|
||||
return isSQLite ? result[0].total : result[0][0].total;
|
||||
const result = await this._db.knex.raw('SELECT COUNT(id) AS total FROM members WHERE created_at >= ?', [startOfRange]);
|
||||
return this._isSQLite ? result[0].total : result[0][0].total;
|
||||
}
|
||||
|
||||
async function getTotalMembersOnDatesInRange() {
|
||||
/**
|
||||
* Fetches member signups for current day
|
||||
*
|
||||
* @param {String} siteTimezone - site's current timezone
|
||||
*/
|
||||
async getNewMembersToday({siteTimezone}) {
|
||||
const startOfToday = moment.tz(siteTimezone).startOf('day').utc().format(dateFormat);
|
||||
const result = await this._db.knex.raw('SELECT count(id) AS total FROM members WHERE created_at >= ?', [startOfToday]);
|
||||
return this._isSQLite ? result[0].total : result[0][0].total;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param {Number | String} days - number of days to fetch of 'all-time' to get for all existing records
|
||||
* @param {Number} totalMembers - number of registered members
|
||||
* @param {String} siteTimezone - site's current timezone
|
||||
*/
|
||||
async getTotalMembersOnDatesInRange({days, totalMembers, siteTimezone}) {
|
||||
const startOfRange = moment.tz(siteTimezone).subtract(days - 1, 'days').startOf('day').utc().format(dateFormat);
|
||||
const tzOffsetMins = moment.tz(siteTimezone).utcOffset();
|
||||
|
||||
let result;
|
||||
|
||||
if (isSQLite) {
|
||||
if (this._isSQLite) {
|
||||
const dateModifier = `${Math.sign(tzOffsetMins) === -1 ? '' : '+'}${tzOffsetMins} minutes`;
|
||||
|
||||
result = await db.knex('members')
|
||||
.select(db.knex.raw('DATE(created_at, ?) AS created_at, COUNT(DATE(created_at, ?)) AS count', [dateModifier, dateModifier]))
|
||||
result = await this._db.knex('members')
|
||||
.select(this._db.knex.raw('DATE(created_at, ?) AS created_at, COUNT(DATE(created_at, ?)) AS count', [dateModifier, dateModifier]))
|
||||
.where((builder) => {
|
||||
if (days !== 'all-time') {
|
||||
builder.whereRaw('created_at >= ?', [startOfRange]);
|
||||
@ -42,8 +71,8 @@ const stats = async ({siteTimezone, days, isSQLite}) => {
|
||||
const hours = (Math.abs(tzOffsetMins) - mins) / 60;
|
||||
const utcOffset = `${Math.sign(tzOffsetMins) === -1 ? '-' : '+'}${hours}:${mins < 10 ? '0' : ''}${mins}`;
|
||||
|
||||
result = await db.knex('members')
|
||||
.select(db.knex.raw('DATE(CONVERT_TZ(created_at, \'+00:00\', ?)) AS created_at, COUNT(CONVERT_TZ(created_at, \'+00:00\', ?)) AS count', [utcOffset, utcOffset]))
|
||||
result = await this._db.knex('members')
|
||||
.select(this._db.knex.raw('DATE(CONVERT_TZ(created_at, \'+00:00\', ?)) AS created_at, COUNT(CONVERT_TZ(created_at, \'+00:00\', ?)) AS count', [utcOffset, utcOffset]))
|
||||
.where((builder) => {
|
||||
if (days !== 'all-time') {
|
||||
builder.whereRaw('created_at >= ?', [startOfRange]);
|
||||
@ -86,21 +115,25 @@ const stats = async ({siteTimezone, days, isSQLite}) => {
|
||||
return output;
|
||||
}
|
||||
|
||||
async function getNewMembersToday() {
|
||||
const startOfToday = moment.tz(siteTimezone).startOf('day').utc().format(dateFormat);
|
||||
const result = await db.knex.raw('SELECT count(id) AS total FROM members WHERE created_at >= ?', [startOfToday]);
|
||||
return isSQLite ? result[0].total : result[0][0].total;
|
||||
/**
|
||||
* Fetches member's signup statistics
|
||||
*
|
||||
* @param {Number | String} days - number of days to fetch of 'all-time' to get for all existing records
|
||||
*/
|
||||
async fetch(days) {
|
||||
const siteTimezone = this._settingsCache.get('timezone');
|
||||
const totalMembers = await this.getTotalMembers();
|
||||
|
||||
// perform final calculations in parallel
|
||||
const results = await Promise.props({
|
||||
total: totalMembers,
|
||||
total_in_range: this.getTotalMembersInRange({days, totalMembers, siteTimezone}),
|
||||
total_on_date: this.getTotalMembersOnDatesInRange({days, totalMembers, siteTimezone}),
|
||||
new_today: this.getNewMembersToday({siteTimezone})
|
||||
});
|
||||
|
||||
return results;
|
||||
}
|
||||
}
|
||||
|
||||
// perform final calculations in parallel
|
||||
const results = await Promise.props({
|
||||
total: totalMembers,
|
||||
total_in_range: getTotalMembersInRange(),
|
||||
total_on_date: getTotalMembersOnDatesInRange(),
|
||||
new_today: getNewMembersToday()
|
||||
});
|
||||
|
||||
return results;
|
||||
};
|
||||
|
||||
module.exports = stats;
|
||||
module.exports = MembersStats;
|
||||
|
Loading…
Reference in New Issue
Block a user