Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 1x 1x 1x 1x 1x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 5x 5x 7x 7x 1x 1x 7x 2x 2x 7x 5x 5x 5x 7x 7x 7x 7x 1x 1x 28x 28x 1x 1x 42x 42x 1x 1x 7x 7x 7x 7x 7x 7x 7x 7x 7x 1x 1x 7x 7x 7x 7x 1x 1x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 1x 1x 1x 1x 7x 7x 7x 7x 7x 24x 7x 7x 7x 7x 24x 24x 24x 24x 24x 24x 24x 24x 7x 7x 7x 7x 1x 1x 1x 1x 7x 7x 7x 7x 61x 61x 7x 7x 7x 7x 1x 1x 1x 1x 7x 7x 7x 7x 7x 7x 7x 7x 1x 1x 1x 1x 7x 7x 7x 2x 7x 5x 5x 7x 38x 7x 7x 7x 7x 1x 1x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 1x | import dayjs from 'dayjs';
import {ensureDirectoryExistence, isArrayWithContent, isSet, isVerbose} from "./util.js";
import fs from "fs";
import {formatSession, intValueOf, pad, plural, secondsToHms} from "./mapper/reportMappers.js";
const ENUMERATION_LIMIT = 10;
const verbose = isVerbose;
export default class ReportGenerator {
constructor(umamiSite, reportContent = 'pageviews|events|sessions|urls', period = '24h',
unit = 'hour', umamiSiteStats = null, sitePageViews = null, siteEvents = null,
siteSessions = null, siteMetricsUrl = null) {
this.site = umamiSite;
this.siteStats = umamiSiteStats;
this.sitePageViews = sitePageViews;
this.siteEvents = siteEvents;
this.siteSessions = siteSessions;
this.siteMetricsUrl = siteMetricsUrl;
this.reportContent = reportContent;
this.reportContents = reportContent?.length > 0 ? reportContent.split('|') : [];
this.period = period;
this.unit = unit;
this.reportDateTime = dayjs().format('DD/MM/YYYY HH:mm')
}
/**
* generate Umami report data
*/
static async produceReportData({
site, siteStats, sitePageViews, siteEvents, siteSessions, siteMetricsUrl,
outputFilename = null,
reportContent = 'pageviews|events|sessions|urls',
period = '24h', unit = 'hour'
}) {
const generator = new ReportGenerator(site, reportContent, period, unit,
siteStats, sitePageViews, siteEvents, siteSessions, siteMetricsUrl);
const umamiOneLineReport = generator.oneLineReport();
const umamiReport = generator.detailedReport();
const pageViews = siteStats?.pageviews || 0; // v3: direct number (no .value)
let result = {
umamiOneLineReport,
umamiReport,
pageViews
};
const {targetFile} = await ReportGenerator.produceResultFile("umamiReport", umamiReport,
outputFilename);
if (isSet(targetFile)) {
result["umamiReportFile"] = targetFile;
}
return result;
}
static async produceResultFile(resultName, resultValue, targetFile) {
if (!isSet(targetFile)) {
return {};
}
if (targetFile?.includes("..")) {// this may be improved..
throw new Error("Unsecure output file refused");
}
try {
ensureDirectoryExistence(targetFile);
fs.writeFileSync(targetFile, resultValue);
verbose && console.info(`produce action result (targetFile): ${targetFile}`);
return {targetFile};
} catch (error) {
console.error(`ERROR: unable to write to ${targetFile} : ${error.message}`);
}
}
hasContent(type) {
return this.reportContents.includes(type);
}
getPageViews() {
return intValueOf(this.siteStats?.pageviews); // v3: direct number (no .value)
}
oneLineReport() {
const pageViews = this.getPageViews();
if (pageViews === 0) {
return `${this.site.domain} [${this.period}] : no views`;
}
const eventsCount = this.eventsCount();
return `${this.site.domain} [${this.period}] : `
+ `${intValueOf(pageViews)} views (${intValueOf(this.siteStats?.visitors)} unique ` // v3: 'visitors' instead of 'uniques.value'
+ `${intValueOf(this.siteStats?.bounces)} bounce) ` // v3: direct number
+ (eventsCount > 0 ? `${eventsCount} events ` : '')
+ `${secondsToHms(intValueOf(this.siteStats?.totaltime))} totaltime`; // v3: direct number
}
eventsCount() {
if (!Array.isArray(this.siteEvents)) {
console.log("warn : siteEvents is not an array : please double check api usage");
return 0;
}
return (this.siteEvents === undefined || this.siteEvents === null || this.siteEvents.length < 1) ? 0 :
this.siteEvents.reduce((from, obj) => from + obj.y, 0);
}
enrichReportWithStats(umamiReport) {
if (!isSet(this.siteStats)) {
return umamiReport;
}
const pageViews = this.getPageViews();
if (pageViews === 0) {
return `for ${this.site.domain} [${this.period}] : no views`;
}
let report = umamiReport;
report += `for ${this.site.domain} [${this.period}]\n\n`;
report += ` p (p-1) stats\n`;
report += `------------------\n`;
report += ` - ${pad(intValueOf(pageViews))} (${pad(intValueOf(this.siteStats?.comparison?.pageviews))}) page views\n`; // v3: .comparison instead of .prev
report += ` - ${pad(intValueOf(this.siteStats?.visitors))} (${pad(intValueOf(this.siteStats?.comparison?.visitors))}) visitors\n`; // v3: direct number + .comparison
report += ` - ${pad(intValueOf(this.siteStats?.visits))} (${pad(intValueOf(this.siteStats?.comparison?.visits))}) visits\n`; // v3: direct number + .comparison
report += ` - ${pad(intValueOf(this.siteStats?.bounces))} (${pad(intValueOf(this.siteStats?.comparison?.bounces))}) bounces\n`; // v3: direct number + .comparison
report += ` - ${secondsToHms(intValueOf(this.siteStats?.totaltime))} (${secondsToHms(intValueOf(this.siteStats?.comparison?.totaltime))}) totaltime\n`; // v3: direct number + .comparison
report += '\n\n';
return report;
}
// sitePageViews : {"pageviews":[{"t":"2022-07-08 20:00:00","y":4},{"t":"2022-07-09 10:00:00","y":2}],"sessions":[{"t":"2022-07-08 20:00:00","y":2},{"t":"2022-07-09 10:00:00","y":1}]}
enrichReportWithPageViews(umamiReport) {
if (!isArrayWithContent(this.sitePageViews?.pageviews) || this.getPageViews() < 1) {
return umamiReport;
}
let report = umamiReport;
report += `📊 page views\n`;
let hasShow = false;
this.sitePageViews.pageviews.forEach(page => {
if (!hasShow) {
console.log("this.sitePageViews")
console.log(JSON.stringify(this.sitePageViews))
hasShow = true;
}
let sessionsCount;
let pageDateTime;
if (page.x) {// based on x abscissa (recent)
sessionsCount = this.sitePageViews?.sessions.find(session => session.x === page.x).y || 0;
pageDateTime = page.x?.substring(5,16);
} else {// based on t abscissa (old-version)
sessionsCount = this.sitePageViews?.sessions.find(session => session.t === page.t).y || 0;
pageDateTime = page.t.substring(5,16);
}
report += ` - ${pageDateTime} ${plural(page.y, 'page', 'pages', 3)} (${plural(sessionsCount, 'session', 'sessions', 2)})\n`;
});
report += '\n\n';
return report;
}
// siteEvents : events: [{"x":"cookies validate","t":"2022-07-09 22:00:00","y":1},{"x":"cookies validate","t":"2022-07-10 11:00:00","y":1},{"x":"list clocks","t":"2022-07-10 11:00:00","y":16},{"x":"cookies validate","t":"2022-07-10 14:00:00","y":1},{"x":"product 554422","t":"2022-07-10 14:00:00","y":1}]
enrichReportWithEvents(umamiReport) {
if (!isArrayWithContent(this.siteEvents) || this.getPageViews() < 1) {
return umamiReport;
}
let report = umamiReport;
report += `📊 events\n - `;
report += this.siteEvents.map(event => {
const {x, y} = event;// no more date
return `${y}x [${x}]`;
}).join(", ");
report += '\n\n';
return report;
}
// siteSessions : { data: [{id:...,websiteId:...,hostname:... (...)}], count: 1, page: 1, pageSize: 5, orderBy: '-views'}
// id websiteId hostname browser os device screen language country subdivision1 city firstAt lastAt visits views createdAt
enrichReportWithSessions(umamiReport) {
const data = this.siteSessions?.data;
if (!isArrayWithContent(data) || this.getPageViews() < 1) {
return umamiReport;// no session
}
let report = umamiReport;
report += `🥇 top 5 sessions by views\n`;
report += data.map(formatSession).join("\n");
report += '\n\n';
return report;
}
// siteMetricsUrl : [{"x":"https://www.exemple.fr/listing/1234","y":2},{"x":"https://www.exemple.fr/listing/5555?lang=fr","y":1},{"x":"https://www.creharmony.fr/listing/5556?lang=fr","y":1}]
enrichReportWithMetricsUrl(umamiReport) {
if (!isArrayWithContent(this.siteMetricsUrl) || this.getPageViews() < 1) {
return umamiReport;
}
let report = umamiReport;
if (this.siteMetricsUrl.length > ENUMERATION_LIMIT) {
report += `🥇 top ${ENUMERATION_LIMIT} urls\n`;
} else {
report += `📊 urls\n`;
}
this.siteMetricsUrl.slice(0, ENUMERATION_LIMIT).forEach(metricUrl => {
report += ` - ${metricUrl.y}x [${metricUrl.x}]\n`;
});
report += '\n\n';
return report;
}
detailedReport() {
let umamiReport = `# ${this.reportDateTime} - Umami report `
umamiReport = this.enrichReportWithStats(umamiReport);
if (this.hasContent('pageviews')) {
umamiReport = this.enrichReportWithPageViews(umamiReport);
}
if (this.hasContent('events')) {
umamiReport = this.enrichReportWithEvents(umamiReport);
}
if (this.hasContent('sessions')) {
umamiReport = this.enrichReportWithSessions(umamiReport);
}
if (this.hasContent('urls')) {
umamiReport = this.enrichReportWithMetricsUrl(umamiReport);
}
return umamiReport;
}
}
|