Satisfy minimum requirements for full typescript project (#37)

* Feature: satisfy minimum for full typescript

* Feature: change report structure from array to object

* Chore: jsdoc

* Refactor: PR review suggestions

* Refactor: type out simple reports

* Refactor: rename variables

* Refactor: more types for now some logic errors

* Chore: docs

* Fix: type -> interface

* Chore: comments

* Type refactor

* Improve report to discord message

* Make it optional

* Improve discord message creation

* renames

* Record to index

Author: FranjoMindek

src/analytics/charts.js src/analytics/charts.ts

@@ -1,11 +1,20 @@
-import * as ImageCharts from "image-charts";
+import ImageCharts from "image-charts";
+
+export interface ChartData {
+  series: { [column: string]: number[] };
+  periodEnds: string[];
+}
 
 // Expects data to be:
 //   data = { series: { name: [number] }, periodEnds: [string] }
 // Returns a string, URL leading to image-charts.com that contains query with exact
 // instructions how to display this chart via image.
-export function buildChartImageUrl(data, title, type = "line") {
-  const chart = ImageCharts()
+export function buildChartImageUrl(
+  data: ChartData,
+  title: string,
+  type = "line",
+) {
+  const chart = new ImageCharts()
     .cht(type === "line" ? "ls" : "bvs") // Type: lines or vertical bars? Could also be other things.
     .chtt(title) // Title.
     .chd(

src/analytics/cli.ts

@@ -1,61 +1,70 @@
 import logger from "../utils/logger";
 import { getAnalyticsErrorMessage } from "./errors";
 import * as reports from "./reports";
+import {
+  AllTimePeriodReport,
+  ChartReport,
+  TextReport,
+} from "./reports/reports";
 
 async function cliReport() {
   const events = await reports.fetchEventsForReportGenerator();
 
-  printTitle("TOTAL REPORT");
-  showReportInCLI(await reports.generateTotalReport(events));
+  printReportTitle("TOTAL REPORT");
+  printReportInCLI(await reports.generateTotalReport(events));
 
-  printTitle("DAILY REPORT");
-  showReportInCLI(await reports.generateDailyReport(events));
+  printReportTitle("DAILY REPORT");
+  printReportInCLI(await reports.generateDailyReport(events));
 
-  printTitle("WEEKLY REPORT");
-  showReportInCLI(await reports.generateWeeklyReport(events));
+  printReportTitle("WEEKLY REPORT");
+  printReportInCLI(await reports.generateWeeklyReport(events));
 
-  printTitle("MONTHLY REPORT");
-  showReportInCLI(await reports.generateMonthlyReport(events));
+  printReportTitle("MONTHLY REPORT");
+  printReportInCLI(await reports.generateMonthlyReport(events));
 
-  printTitle("ALL TIME MONTHLY REPORT (CSVs)");
-  await allTimeMonthlyActiveUsersAndProjectsCsvCliReport(events);
+  printReportTitle("ALL TIME MONTHLY REPORT (CSVs)");
+  printAllTimeMonthlyReportCsvInCLI(
+    await reports.generateAllTimeMonthlyReport(events),
+  );
 }
 
 // Outputs CSV of total metrics since the start of tracking them,
 // while skipping cohort analytis because that would be too complex.
 // Useful for manually producing charts that show total progress of Wasp.
-async function allTimeMonthlyActiveUsersAndProjectsCsvCliReport(events) {
-  const report = await reports.generateAllTimeMonthlyReport(events);
+function printAllTimeMonthlyReportCsvInCLI(
+  allTimePeriodReort: AllTimePeriodReport,
+) {
+  const { userActivityReport, projectsReport } = allTimePeriodReort;
 
   console.log("\n[CSV] Num active users");
-  const activeUsersReport = report[0];
-  for (const row of activeUsersReport.csv) {
+  for (const row of userActivityReport.csv) {
     console.log(row.join(","));
   }
 
   console.log("\n[CSV] Num projects");
-  console.log(",created diff,created cumm,built diff,built cumm");
-  const projectsReport = report[1];
+  console.log("created diff,created cumm,built diff,built cumm");
   for (const row of projectsReport.csv) {
     console.log(row.join(","));
   }
 }
 
-function showReportInCLI(report) {
-  for (const metric of report) {
+function printReportInCLI(
+  compositeReport: Record<string, Partial<TextReport & ChartReport>>,
+) {
+  for (const simpleReport of Object.values(compositeReport)) {
     console.log();
-    if (metric.text) {
-      for (const textLine of metric.text) {
+    if (simpleReport.text) {
+      for (const textLine of simpleReport.text) {
         console.log(textLine);
       }
     }
-    if (metric.chart) {
-      console.log("- Chart: ", metric.chart.toURL());
+    if (simpleReport.chart) {
+      console.log("- Chart: ", simpleReport.chart.toURL());
     }
   }
 }
 
-function printTitle(text) {
+function printReportTitle(text) {
   console.log(`\x1b[33m \n\n${text} \x1b[0m`);
 }
 

src/analytics/eventContext.ts

@@ -1,7 +1,6 @@
 import { type PosthogEvent } from "./events";
 
 /**
- * @param event
  * @returns Context values, all lowercase strings.
  */
 export function getEventContextValues(event: PosthogEvent): string[] {

src/analytics/executionEnvs.js src/analytics/executionEnvs.ts

@@ -1,4 +1,4 @@
-import * as _ from "lodash";
+import _ from "lodash";
 
 import { getEventContextValues } from "./eventContext";
 
@@ -41,7 +41,7 @@ export function groupEventsByExecutionEnv(events) {
 
 function getExecutionEnvFromEventContext(event) {
   const contextValues = getEventContextValues(event);
-  for (let [key, actor] of Object.entries(executionEnvs)) {
+  for (const [key, actor] of Object.entries(executionEnvs)) {
     if (contextValues.includes(actor.contextKey)) {
       return key;
     }

src/analytics/moment.js src/analytics/moment.ts

@@ -1,4 +1,4 @@
-import * as moment from "moment";
+import moment from "moment";
 
 // Here we set moment to use ISO-8601, Europe locale.
 moment.updateLocale("en", {

src/analytics/reports/events.ts

@@ -1,10 +1,10 @@
-import * as _ from "lodash";
+import retry from "async-retry";
+import _ from "lodash";
 
-import moment from "../moment";
-import { type PosthogEvent, fetchAllCliEvents } from "../events";
 import { addEventContextValue } from "../eventContext";
+import { type PosthogEvent, fetchAllCliEvents } from "../events";
 import { executionEnvs } from "../executionEnvs";
-import * as retry from "async-retry";
+import moment from "../moment";
 
 // These filters, when applyed to a list of events, remove
 // events that we don't want to go into analysis
@@ -120,7 +120,7 @@ export async function fetchEventsForReportGenerator() {
       retries: 10,
       minTimeout: 5 * 1000,
       maxTimeout: 60 * 1000,
-      onRetry: (e) => {
+      onRetry: (e: Error) => {
         console.error(
           "Error happened while fetching events for report generator, trying again:",
           e.message ?? e,

src/analytics/reports/index.ts

@@ -1,38 +1,36 @@
 import moment from "../moment";
+import {
+  generateAllTimePeriodReport,
+  generatePeriodReport,
+} from "./periodReport";
+import { AllTimePeriodReport, PeriodReport } from "./reports";
 export { fetchEventsForReportGenerator } from "./events";
 export { generateTotalReport } from "./totalReport";
-import { generatePeriodReport } from "./periodReport";
 
-export async function generateDailyReport(
+export function generateDailyReport(
   prefetchedEvents = undefined,
   numPeriods = undefined,
-) {
-  return generatePeriodReport(numPeriods ?? 14, "day", prefetchedEvents, false);
+): Promise<PeriodReport> {
+  return generatePeriodReport(numPeriods ?? 14, "day", prefetchedEvents);
 }
 
-export async function generateWeeklyReport(
+export function generateWeeklyReport(
   prefetchedEvents = undefined,
   numPeriods = undefined,
-) {
+): Promise<PeriodReport> {
   return generatePeriodReport(numPeriods ?? 12, "week", prefetchedEvents);
 }
 
-export async function generateMonthlyReport(
+export function generateMonthlyReport(
   prefetchedEvents = undefined,
   numPeriods = undefined,
-  genCohortRetentionReport = true,
-) {
-  return generatePeriodReport(
-    numPeriods ?? 12,
-    "month",
-    prefetchedEvents,
-    genCohortRetentionReport,
-  );
+): Promise<PeriodReport> {
+  return generatePeriodReport(numPeriods ?? 12, "month", prefetchedEvents);
 }
 
-export async function generateAllTimeMonthlyReport(
+export function generateAllTimeMonthlyReport(
   prefetchedEvents = undefined,
-) {
+): Promise<AllTimePeriodReport> {
   const numMonths = moment().diff(moment("2021-01-01"), "months") + 1;
-  return generateMonthlyReport(prefetchedEvents, numMonths, false);
+  return generateAllTimePeriodReport(numMonths, "month", prefetchedEvents);
 }

src/analytics/reports/periodReport/cohortRetentionReport.js src/analytics/reports/periodReport/cohortRetentionReport.ts

@@ -1,22 +1,22 @@
-import * as _ from "lodash";
-import { newSimpleTable } from "../../table";
+import _ from "lodash";
+
 import { groupEventsByExecutionEnv } from "../../executionEnvs";
+import { newSimpleTable } from "../../table";
 import { fetchEventsForReportGenerator } from "../events";
-
-import { groupEventsByUser, getIntersection } from "../utils";
-
+import { CohortRetentionReport } from "../reports";
+import { getIntersection, groupEventsByUser } from "../utils";
 import {
   calcLastNPeriods,
-  groupEventsByPeriods,
   getActiveUserIds,
+  groupEventsByPeriods,
   isEventInPeriod,
 } from "./common";
 
 export async function generateCohortRetentionReport(
   numPeriods,
   periodName,
   prefetchedEvents = undefined,
-) {
+): Promise<CohortRetentionReport> {
   const periodNameShort = periodName[0];
 
   // All events, sorted by time (starting with oldest), with events caused by Wasp team members
@@ -88,21 +88,19 @@ export async function generateCohortRetentionReport(
   const fmt = (m) => m.format("DD-MM-YY");
   const firstPeriod = periods[0];
   const lastPeriod = _.last(periods);
-  const report = [
-    {
-      text: [
-        "==== Cohort Retention ====",
-        "```",
-        table.toString(),
-        "```",
-        `Period of ${periodNameShort}  #0: ${fmt(firstPeriod[0])} - ${fmt(
-          firstPeriod[1],
-        )}`,
-        `Period of ${periodNameShort} #${periods.length - 1}: ${fmt(
-          lastPeriod[0],
-        )} - ${fmt(lastPeriod[1])}`,
-      ],
-    },
-  ];
+  const report = {
+    text: [
+      "==== Cohort Retention ====",
+      "```",
+      table.toString(),
+      "```",
+      `Period of ${periodNameShort}  #0: ${fmt(firstPeriod[0])} - ${fmt(
+        firstPeriod[1],
+      )}`,
+      `Period of ${periodNameShort} #${periods.length - 1}: ${fmt(
+        lastPeriod[0],
+      )} - ${fmt(lastPeriod[1])}`,
+    ],
+  };
   return report;
 }

src/analytics/reports/periodReport/common.js src/analytics/reports/periodReport/common.ts

@@ -1,4 +1,4 @@
-import * as _ from "lodash";
+import _ from "lodash";
 
 import moment from "../../moment";
 
@@ -49,7 +49,7 @@ export function calcLastNPeriods(numPeriods, periodName) {
 // If there are N periods, it will return a list with N sublists, where each sublist
 // contains events for a corresponding period.
 export function groupEventsByPeriods(events, periods) {
-  let eventsByPeriods = [];
+  const eventsByPeriods = [];
   let currentPeriodIdx = 0;
   let currentPeriodEvents = [];
   for (const event of events) {