@codeclimbers/server 0.0.1

package/src/v1/database/knex.ts

@@ -0,0 +1,107 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import Knex, { Knex as KnexTypes } from 'knex'
+
+import { Module } from '@nestjs/common'
+import { KnexModule } from 'nestjs-knex'
+import * as path from 'path'
+import {
+  forOwn,
+  isPlainObject,
+  snakeCase,
+  camelCase,
+} from '../../../utils/helpers.util'
+import { initDBDir, DB_PATH, BIN_PATH } from '../../../utils/node.util'
+
+const deepMapKeys = function (obj: any, fn: any) {
+  const x: { [key: string]: any } = {}
+
+  forOwn(obj, function (v, k) {
+    if (Array.isArray(v)) {
+      v = v.map(function (x) {
+        return isPlainObject(x) ? deepMapKeys(x, fn) : x
+      })
+    }
+    if (isPlainObject(v)) {
+      v = deepMapKeys(v, fn)
+    }
+    x[fn(v, k)] = v
+  })
+
+  return x
+}
+
+const postProcessResponse = (result: any) => {
+  if (!result) {
+    return result
+  }
+  return camelCaseKeys(result)
+}
+
+const wrapIdentifier = (value: any, origImpl: any) => {
+  if (snakeCase(value)) {
+    return origImpl(snakeCase(value))
+  } else {
+    return origImpl(value)
+  }
+}
+
+const camelCaseKeys = (obj: any) => {
+  if (Array.isArray(obj)) {
+    return obj.map((row) => {
+      return deepMapKeys(row, (v: any, k: any) => camelCase(k))
+    })
+  } else {
+    return deepMapKeys(obj, (v: any, k: any) => camelCase(k))
+  }
+}
+
+const IS_TEST = process.env.NODE_ENV === 'test'
+
+initDBDir()
+
+// https://github.com/knex/knex/issues/1871#issuecomment-452342526
+export const SQL_LITE_TEST_FILE = 'codeclimber.test.sqlite'
+
+const knexConfig: KnexTypes.Config = {
+  client: 'sqlite3',
+  connection: {
+    filename: IS_TEST ? SQL_LITE_TEST_FILE : DB_PATH,
+  },
+  migrations: {
+    directory: path.join(BIN_PATH, 'migrations'),
+    tableName: 'knex_migrations',
+  },
+  seeds: {
+    directory: path.join(BIN_PATH, 'seeds'),
+  },
+  useNullAsDefault: true,
+  postProcessResponse, // Stuff coming back from the DB
+  wrapIdentifier, // Anything going into the DB
+  // debug: true,
+  // log: {
+  //   warn(message) {
+  //     console.log(message)
+  //   },
+  //   error(message) {
+  //     console.log(message)
+  //   },
+  //   deprecate(message) {
+  //     console.log(message)
+  //   },
+  //   debug(message) {
+  //     console.log(message)
+  //   },
+  // },
+}
+
+export const knex = Knex(knexConfig)
+
+const knexModule = KnexModule.forRoot({
+  config: knexConfig,
+})
+
+@Module({
+  imports: [knexModule],
+  exports: [knexModule],
+})
+export class DbModule {}

package/src/v1/database/migrations.ts

@@ -0,0 +1,13 @@
+import { Logger } from '@nestjs/common'
+import { knex } from './knex'
+
+export const startMigrations = async () => {
+  Logger.log('Running Migrations')
+
+  try {
+    // Locations of migrations is relative to project root
+    await knex.migrate.latest()
+  } finally {
+    Logger.log('Migrations Complete')
+  }
+}

package/src/v1/database/models/pulse.d.ts

@@ -0,0 +1,24 @@
+declare namespace CodeClimbers {
+  export interface Pulse {
+    id?: number
+    userId: string // Used by wakatime to identify the user (email address).  We store as "local"
+    entity: string // The activity that was done. The file worked on or the url of the site visited
+    type: string // What type of entity it is.  For example: 'file' or 'domain'
+    category?: string // What category the activity falls under.  For example: 'coding', 'browsing', 'designing'
+    project?: string // The project the activity was done under. Gathered from the directory name the work was done from. Only used for 'file' type activities
+    branch?: string // The branch the activity was done under. Gathered from the git branch the work was done from. Only used for 'file' type activities
+    language?: string // The language the activity was done in. Gathered from the file extension. Only used for 'file' type activities
+    isWrite: boolean // Whether the activity was a write operation.  If false, it was a read operation
+    editor: string // if the activity was done in an editor, the name of the editor.  Only used for 'file' type activities
+    operatingSystem: string // The operating system the activity was done on.  Gathered from the user agent
+    application?: string // The application the activity was done in.
+    machine: string // The machine the activity was done on.  Gathered from the user agent
+    userAgent: string // The user agent of the activity.  Used to determine the operating system and application
+    time: string // The time the activity was done.  In ISO format
+    hash: string // A hash of the activity.  Used to determine if the activity is a duplicate. Browser extension sends a lot of duplicate activities
+    origin?: string // unused
+    originId?: string // unused
+    createdAt: string // The time the activity was created in the database.  In ISO format
+    description?: string // A description of the activity generated by the cli based on the other fields
+  }
+}

package/src/v1/database/pulse.repo.ts

@@ -0,0 +1,132 @@
+import { Injectable, Logger } from '@nestjs/common'
+import { InjectKnex, Knex } from 'nestjs-knex'
+import sqlReaderUtil from '../../../utils/sqlReader.util'
+import * as dayjs from 'dayjs'
+
+interface MinutesQuery {
+  minutes: number
+}
+
+@Injectable()
+export class PulseRepo {
+  constructor(@InjectKnex() private readonly knex: Knex) {}
+
+  tableName = 'activities_pulse'
+
+  async getStatusBarDetails(): Promise<CodeClimbers.WakatimePulseStatusDao[]> {
+    const startOfDay = dayjs().startOf('day').toISOString()
+    const endOfDay = dayjs().endOf('day').toISOString()
+    const getTimeQuery = await sqlReaderUtil.getFileContentAsString(
+      'getStatusBarDetails.sql',
+    )
+    return this.knex.raw(getTimeQuery, { startOfDay, endOfDay })
+  }
+
+  async getLatestPulses(): Promise<CodeClimbers.Pulse[] | undefined> {
+    const res = await this.knex<CodeClimbers.Pulse>(this.tableName)
+      .orderBy('created_at', 'desc')
+      .limit(10)
+    return res
+  }
+
+  async getAllPulses(): Promise<CodeClimbers.Pulse[] | undefined> {
+    const res = await this.knex<CodeClimbers.Pulse>(this.tableName).orderBy(
+      'created_at',
+      'desc',
+    )
+    return res
+  }
+
+  getMinutesInRangeQuery(startDate: Date, endDate: Date) {
+    return this.knex<MinutesQuery[]>(this.tableName)
+      .select(this.knex.raw('count(*) * 2 as minutes'))
+      .from(this.tableName)
+      .whereBetween('time', [startDate.toISOString(), endDate.toISOString()])
+      .groupBy(this.knex.raw("strftime('%s', time) / 120"))
+  }
+
+  async getLongestDayInRangeMinutes(
+    startDate: Date,
+    endDate: Date,
+  ): Promise<number> {
+    const getLongestDayMinutesQuery =
+      await sqlReaderUtil.getFileContentAsString(
+        'getLongestDayInRangeMinutes.sql',
+      )
+    const [result] = await this.knex.raw<MinutesQuery[]>(
+      getLongestDayMinutesQuery,
+      {
+        startDate: startDate.toISOString(),
+        endDate: endDate.toISOString(),
+      },
+    )
+
+    return result.minutes
+  }
+
+  async getRangeMinutes(startDate: Date, endDate: Date): Promise<number> {
+    const result: MinutesQuery = await this.knex<MinutesQuery[]>(this.tableName)
+      .with('getMinutes', this.getMinutesInRangeQuery(startDate, endDate))
+      .select(this.knex.raw('count(*) * 2 as minutes'))
+      .first()
+      .from('getMinutes')
+
+    return result.minutes
+  }
+
+  async getCategoryTimeOverview(
+    startDate: string,
+    endDate: string,
+  ): Promise<CodeClimbers.TimeOverview[]> {
+    const query = this.knex<MinutesQuery[]>(this.tableName)
+      .select(this.knex.raw('category, count(*) * 2'))
+      .from(this.tableName)
+      .whereBetween('time', [startDate, endDate])
+      .groupBy(this.knex.raw("strftime('%s', time) / 120"))
+
+    return await this.knex<CodeClimbers.TimeOverviewDao[]>(this.tableName)
+      .with('getMinutes', query)
+      .select(this.knex.raw('category, count() * 2 as minutes'))
+      .groupBy('category')
+      .from('getMinutes')
+  }
+
+  async createPulse(pulse: CodeClimbers.Pulse) {
+    Logger.log('Creating pulse', 'pulse.repo')
+    const res = await this.knex<CodeClimbers.Pulse>(this.tableName)
+      .insert(pulse)
+      .returning('*')
+
+    return res
+  }
+
+  async createPulses(pulses: CodeClimbers.Pulse[]) {
+    Logger.log('Creating pulses', 'pulse.repo')
+    const res = await this.knex<CodeClimbers.Pulse>(this.tableName)
+      .insert(pulses)
+      .returning('*')
+    Logger.log(`created ${pulses.length} pulses`, 'pulse.repo')
+    return res
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  async getUniqueUserAgentsAndLastActive(): Promise<any[]> {
+    const res = await this.knex<CodeClimbers.Pulse>(this.tableName)
+      .select('user_agent', this.knex.raw('MAX(created_at) as last_active'))
+      .groupBy('user_agent')
+      .orderBy('last_active', 'desc')
+    return res
+  }
+
+  async getLatestProject(): Promise<string | undefined> {
+    const res = await this.knex<CodeClimbers.Pulse>(this.tableName)
+      .select('project')
+      .whereNotNull('project')
+      .whereNotIn('project', ['', '<<LAST_PROJECT>>'])
+      .andWhere('time', '<', "datetime('now', '-15 minutes')")
+      .orderBy('time', 'desc')
+      .first()
+
+    return await res?.project
+  }
+}

package/src/v1/database/queries/getCategoryTimeOverview.sql

@@ -0,0 +1,6 @@
+SELECT category, count() AS minutes
+FROM (SELECT category, count()
+      FROM activities_pulse
+      WHERE date(activities_pulse.time) BETWEEN :startDate AND :endDate
+      GROUP BY strftime('%s', time) / 60) 
+GROUP BY category

package/src/v1/database/queries/getLongestDayInRangeMinutes.sql

@@ -0,0 +1,11 @@
+WITH get_total_minutes (time, total_minutes) AS (
+    SELECT time, count() as total_minutes
+    FROM activities_pulse
+    WHERE date(activities_pulse.time) BETWEEN :startDate AND :endDate
+    GROUP BY strftime('%s', time) / 60),
+get_day_minutes (time, day_minutes) AS (
+    SELECT time, count() as day_minutes
+    FROM get_total_minutes
+    GROUP BY strftime('%Y-%m-%d', time))
+SELECT max(day_minutes) as minutes
+FROM get_day_minutes;

package/src/v1/database/queries/getStatusBarDetails.sql

@@ -0,0 +1,42 @@
+WITH heartbeats_with_diff AS (
+        SELECT
+    project,
+    language,
+    editor,
+    operating_system,
+    machine,
+    branch,
+    time,
+    MIN(
+        (JULIANDAY(time) - JULIANDAY(LAG(time) OVER w)) * 86400,
+        120
+    ) AS diff
+FROM
+    activities_pulse
+WHERE
+    time >= :startOfDay
+    AND time < :endOfDay
+WINDOW
+    w AS (ORDER BY time)
+    )
+    SELECT
+        project,
+        language,
+        editor,
+        operating_system,
+        machine,
+        branch,
+        ROUND(SUM(MAX(1, diff))) AS seconds,
+        MIN(time) AS min_heartbeat_time,
+        MAX(time) AS max_heartbeat_time
+    FROM
+        heartbeats_with_diff
+    WHERE
+        diff IS NOT NULL
+    GROUP BY
+        project,
+        language,
+        editor,
+        operating_system,
+        machine,
+        branch

package/src/v1/dtos/createWakatimePulse.dto.ts

@@ -0,0 +1,66 @@
+import { IsBoolean, IsNumber, IsOptional, IsString } from 'class-validator'
+
+export class CreateWakatimePulseDto {
+  @IsOptional()
+  @IsString()
+  userId?: string
+
+  @IsString()
+  entity: string
+
+  @IsString()
+  type: string
+
+  @IsOptional()
+  @IsString()
+  category?: string
+
+  @IsString()
+  project: string
+
+  @IsString()
+  branch: string
+
+  @IsOptional()
+  @IsString()
+  language?: string
+
+  @IsOptional()
+  @IsBoolean()
+  is_write?: boolean
+
+  @IsOptional()
+  @IsString()
+  editor?: string
+
+  @IsOptional()
+  @IsString()
+  operating_system?: string
+
+  @IsOptional()
+  @IsString()
+  machine?: string
+
+  @IsOptional()
+  @IsString()
+  user_agent?: string
+
+  @IsNumber()
+  time: number | string
+
+  @IsOptional()
+  @IsString()
+  hash?: string
+
+  @IsOptional()
+  @IsString()
+  origin?: string
+
+  @IsOptional()
+  @IsString()
+  origin_id?: string
+
+  @IsOptional()
+  @IsString()
+  description?: string
+}

package/src/v1/dtos/getCategoryTimeOverview.dto.ts

@@ -0,0 +1,9 @@
+import { IsDateString } from 'class-validator'
+
+export class GetCategoryTimeOverviewDto {
+  @IsDateString()
+  startDate: string
+
+  @IsDateString()
+  endDate: string
+}

package/src/v1/dtos/getWeekOverview.dto.ts

@@ -0,0 +1,6 @@
+import { IsDateString } from 'class-validator'
+
+export class GetWeekOverviewDto {
+  @IsDateString()
+  date: string
+}

package/src/v1/startup/darwinStartup.service.ts

@@ -0,0 +1,114 @@
+import { Injectable } from '@nestjs/common'
+import * as path from 'node:path'
+import {
+  BIN_PATH,
+  CODE_CLIMBER_META_DIR,
+  NODE_PATH,
+} from '../../../utils/node.util'
+import startupUtil from './startup.util'
+const { Service } = startupUtil.getServiceLib()
+
+@Injectable()
+export class DarwinStartupService implements CodeClimbers.StartupService {
+  private service: typeof Service
+
+  constructor() {
+    this.service = new Service({
+      name: 'CodeClimbers',
+      description: 'CodeClimbers service',
+      script: `${path.join(BIN_PATH, 'startup.js')}`,
+      logpath: CODE_CLIMBER_META_DIR,
+      env: [
+        {
+          name: 'NODE_ENV',
+          value: process.env.NODE_ENV || 'production',
+        },
+        {
+          name: 'CODE_CLIMBER_BIN_PATH',
+          value: BIN_PATH,
+        },
+        {
+          name: 'NODE_PATH',
+          value: NODE_PATH(),
+        },
+        {
+          name: 'DEBUG',
+          value: process.env.DEBUG,
+        },
+      ],
+      logOnAsUser: true,
+      runAsAgent: true,
+      wait: 5,
+      grow: 0,
+      maxRestarts: 10,
+    })
+
+    if (process.env.NODE_ENV === 'development' || process.env.DEBUG === '*') {
+      this.service.on('install', () => {
+        console.log(`${this.service.name} installed`)
+      })
+
+      this.service.on('alreadyinstalled', () => {
+        console.log(`${this.service.name} already installed`)
+      })
+
+      this.service.on('uninstall', () => {
+        console.log(`${this.service.name} uninstalled`)
+      })
+
+      this.service.on('start', () => {
+        console.log(`${this.service.name} started`)
+      })
+
+      this.service.on('stop', () => {
+        console.log(`${this.service.name} stopped`)
+      })
+
+      this.service.on('error', (error) => {
+        console.error(`${this.service.name} error:`, error)
+      })
+    }
+  }
+
+  async enableStartup(): Promise<void> {
+    return new Promise((resolve, reject) => {
+      this.service.install()
+      this.service.on('install', () => {
+        resolve()
+      })
+      this.service.on('alreadyinstalled', () => {
+        resolve()
+      })
+      this.service.on('error', (error) => reject(error))
+    })
+  }
+
+  async disableStartup(): Promise<void> {
+    return new Promise((resolve, reject) => {
+      this.service.uninstall()
+      this.service.on('uninstall', () => resolve())
+      this.service.on('error', (error) => reject(error))
+    })
+  }
+
+  async launchAndEnableStartup(): Promise<void> {
+    await this.enableStartup()
+    return new Promise((resolve, reject) => {
+      this.service.start()
+      this.service.on('start', () => resolve())
+      this.service.on('error', (error) => reject(error))
+    })
+  }
+
+  async closeAndDisableStartup(): Promise<void> {
+    return new Promise((resolve, reject) => {
+      this.service.stop()
+      this.service.on('stop', () => {
+        this.disableStartup()
+          .then(() => resolve())
+          .catch((error) => reject(error))
+      })
+      this.service.on('error', (error) => reject(error))
+    })
+  }
+}

package/src/v1/startup/linuxStartup.service.ts

@@ -0,0 +1,101 @@
+import { Injectable, Logger } from '@nestjs/common'
+// eslint-disable-next-line import/no-unresolved
+import * as path from 'node:path'
+import { BIN_PATH, CODE_CLIMBER_META_DIR } from '../../../utils/node.util'
+import startupUtil from './startup.util'
+const { Service } = startupUtil.getServiceLib()
+
+@Injectable()
+export class DarwinStartupService implements CodeClimbers.StartupService {
+  private service: typeof Service
+
+  constructor() {
+    this.service = new Service({
+      name: 'CodeClimbers',
+      description: 'CodeClimbers service',
+      script: `${path.join(BIN_PATH, 'startup.js')}`,
+      logpath: CODE_CLIMBER_META_DIR,
+      env: [
+        {
+          name: 'NODE_ENV',
+          value: 'production',
+        },
+        {
+          name: 'CODE_CLIMBER_BIN_PATH',
+          value: BIN_PATH,
+        },
+      ],
+      logOnAsUser: true,
+      runAsAgent: true,
+      wait: 5,
+      grow: 0,
+      maxRestarts: 10,
+    })
+
+    this.service.on('install', () => {
+      Logger.log(`${this.service.name.get} installed`)
+    })
+
+    this.service.on('alreadyinstalled', () => {
+      Logger.log(`${this.service.name} already installed`)
+    })
+
+    this.service.on('uninstall', () => {
+      Logger.log(`${this.service.name} uninstalled`)
+    })
+
+    this.service.on('start', () => {
+      Logger.log(`${this.service.name} started`)
+    })
+
+    this.service.on('stop', () => {
+      Logger.log(`${this.service.name} stopped`)
+    })
+
+    this.service.on('error', (error) => {
+      Logger.error(`${this.service.name} error:`, error)
+    })
+  }
+
+  async enableStartup(): Promise<void> {
+    return new Promise((resolve, reject) => {
+      this.service.install()
+      this.service.on('install', () => {
+        resolve()
+      })
+      this.service.on('alreadyinstalled', () => {
+        resolve()
+      })
+      this.service.on('error', (error) => reject(error))
+    })
+  }
+
+  async disableStartup(): Promise<void> {
+    return new Promise((resolve, reject) => {
+      this.service.uninstall()
+      this.service.on('uninstall', () => resolve())
+      this.service.on('error', (error) => reject(error))
+    })
+  }
+
+  async launchAndEnableStartup(): Promise<void> {
+    await this.enableStartup()
+    return new Promise((resolve, reject) => {
+      this.service.start()
+      this.service.on('start', () => resolve())
+      this.service.on('error', (error) => reject(error))
+    })
+  }
+
+  async closeAndDisableStartup(): Promise<void> {
+    return new Promise((resolve, reject) => {
+      this.service.stop()
+      this.service.on('stop', () => {
+        this.disableStartup()
+          .then(() => resolve())
+          .catch((error) => reject(error))
+      })
+      this.service.on('error', (error) => reject(error))
+    })
+  }
+}

package/src/v1/startup/startup.controller.ts

@@ -0,0 +1,23 @@
+import { Controller, Post } from '@nestjs/common'
+import { StartupServiceFactory } from './startupService.factory'
+
+@Controller('/startup')
+export class StartupController {
+  private startupService: CodeClimbers.StartupService
+
+  constructor(private readonly startupServiceFactory: StartupServiceFactory) {
+    this.startupService = this.startupServiceFactory.getStartupService()
+  }
+
+  @Post('/enable')
+  async enableStartup(): Promise<string> {
+    await this.startupService.enableStartup()
+    return 'OK'
+  }
+
+  @Post('/disable')
+  async disableStartup(): Promise<string> {
+    await this.startupService.disableStartup()
+    return 'OK'
+  }
+}

package/src/v1/startup/startup.util.ts

@@ -0,0 +1,21 @@
+/*
+ * these modules are not available on all platforms, so we have to import them conditionally
+ * or we'll get build and runtime errors
+ */
+function getServiceLib() {
+  const os = process.platform
+  switch (os) {
+    case 'darwin':
+      return require('node-mac')
+    case 'linux':
+      return require('node-linux')
+    case 'win32':
+      return require('node-windows')
+    default:
+      throw new Error('Unsupported platform')
+  }
+}
+
+export default {
+  getServiceLib,
+}