feat(discord-bot): Implement Discord Bot Prototype #468

PongDev · 2023-01-25T00:17:42Z

Why did you create this PR

Implement New Discord Bot for CU Get Reg

What did you do

Implement Discord Bot Prototype

Demo

https://dev.cugetreg.com

Checklist

Deploy a demo
Check browsers compatibility
Wrote coverage tests

leomotors · 2023-01-25T02:28:34Z

Please fix conflict so I can review

don't force push

saenyakorn · 2023-01-25T02:37:34Z

Can you explain more about the features of this bot. It would be great if you put some image what bot can do here.

Please explain as much as possible you can. So, we'll review this feature later

PongDev · 2023-01-25T06:08:15Z

Please fix conflict so I can review

don't force push

I merge wrong branch ;w;

PongDev · 2023-01-25T06:42:50Z

Can you explain more about the features of this bot. It would be great if you put some image what bot can do here.
Please explain as much as possible you can. So, we'll review this feature later

This is a prototype of a discord bot, for now it main feature is summary user usage for 1 week, however the core module of this bot support many metric and dimension for used in further.

This prototype design based on issue 439. (#439)

Example feature

saenyakorn · 2023-01-25T13:03:17Z

What does the report look like when the bot send a it into Discord?

PongDev · 2023-01-25T13:16:25Z

Look like this for example, actually it support both text message and image but text message format is not yet discuss to other, so it has core code and template for that for now. However from the code, text command can be code in very short time (estimate may be < 1 week)

The bot use slash command to register channel to send report and report will send at specific cron job time

PongDev · 2023-01-25T13:19:47Z

Note that this is only a prototype of CU Get Reg Bot, for further improvement I think we should discuss for more further information to used in development

bombnp · 2023-01-25T14:16:13Z

package.json

    "slate-react": "^0.82.0",
    "styled-components": "^5.3.5",
    "tough-cookie": "^4.0.0",
    "tslib": "^2.4.0",
    "uuid": "^8.3.2",
    "winston": "^3.8.2",


why are these guys moved to devDependencies? these are prod deps

I will move it, it may due to fix merge conflict

bombnp · 2023-01-25T14:19:10Z

apps/discord-bot/.eslintrc.json

+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}


what is this file here for? doesn't this literally ignore every error?

It is copy from apps/api/.eslintrc.json

Can you recommend how I should lint this apps?

@saenyakorn did u add this in api?

bombnp · 2023-01-25T14:27:17Z

apps/discord-bot/src/core/CUGetReg.ts

+  get commands(): Map<string, ICommand> {
+    return this.commandList
+  }


it's best if you keep the getter and private variable the same name, but prefix private var with underscore _.

Suggested change

get commands(): Map<string, ICommand> {

return this.commandList

}

get commands(): Map<string, ICommand> {

return this._commands

}

I will do as your recommended. Also can you provided me convention reference, so I can know more info.

i don't really have it, it's what i've seen and it really is easier to understand

apps/discord-bot/src/core/CUGetRegCommands.ts

bombnp · 2023-01-25T14:30:28Z

apps/discord-bot/src/core/CUGetRegCommands.ts

+import { PingCommand } from '../command/ping'
+import { RegisterReportChannelCommand } from '../command/registerReportChannel'
+
+export const CUGetRegCommands: ICommand[] = [PingCommand, RegisterReportChannelCommand]


Also i think it's unnecessary to prefix everything with CUGetReg. Leave things as like commands, hooks, etc.

apps/discord-bot/src/core/CUGetRegScheduler.ts

bombnp · 2023-01-25T14:37:44Z

apps/discord-bot/src/google-analytic/google-analytic-extended.ts

@@ -0,0 +1,53 @@
+import { GoogleAnalyticData } from './google-analytic'
+
+export class GoogleAnalyticDataExtended extends GoogleAnalyticData {


why not just put this in GoogleAnalyticData if we're only gonna use the extended version only?

especially since GoogleAnalyticData is our own class.

This is for reusable of class, since GoogleAnalyticsData is core system of google analytics which directly use google analytics api, however GoogleAnalyticsDataExtended is only a set of command that a shortcut of calling core analytics command.

So the main reason is to separate between the necessary one and the shortcut one, however any other solution is accept if you have recommended.

There's literally no reason to split up the code into an "Extended" version, when the subclass is already our code in our repo and you're always going to use the extended one. This is way harder to read imo. Put it in the same class.

In fact, the only core method that interfaces directly with the google analytics api is the getMetrics method, which it literally just an http client.

apps/discord-bot/src/database/sqlite/SQLiteDatabaseDriver.ts

bombnp · 2023-01-25T14:59:37Z

apps/discord-bot/src/hook/command.ts

+    }
+
+    try {
+      await command.execute(client, interaction)


no need to await, command.execute(..) is not async func

apps/discord-bot/src/hook/ready.ts

apps/discord-bot/src/command/registerReportChannel.ts

bombnp · 2023-01-27T04:04:27Z

apps/discord-bot/src/core/CUGetReg.ts

  }

  get db(): IDatabase {
-    return this.database
+    return this._database


same goes here

bombnp · 2023-01-27T04:04:38Z

apps/discord-bot/src/core/CUGetReg.ts

  get commands(): Map<string, ICommand> {
-    return this.commandList
+    return this._commandList
  }


i meant get commands() should match the private variable name _commands not _commandList

bombnp · 2023-01-27T04:15:01Z

Why is there so many package.json changes (package name ordering is out of place, versions are upgraded)? That should not happen when you add new packages for your new app.

Since we're using the same package.json for every single app, changing so many dependencies could break other apps and should be avoided.

bombnp · 2023-01-27T04:17:17Z

In fact, i'd say do this:

Delete node_modules folder
Revert package.json and pnpm lock file back to its original commit
Selectively add new packages that you need for discord bot (prod dependencies and dev dependencies). This should NOT mess up other dependencies.
Commit and push new package.json and lock file to this branch

saenyakorn · 2023-01-27T06:32:58Z

Because we may have other features for Discord bot like #438, I would like you to use discord-nestjs, the powerful DiscordJS-wrapper library based on Nestjs, as a main library for implementing Discord bot. Since, Nestjs is fully come with Typescript and Decorator that make other easy to read through the code.

saenyakorn · 2023-01-27T06:35:37Z

Here is the example repos that implemented with discord-nestjs. Feel free to copy the code from them.

bombnp · 2023-01-27T09:07:17Z

hold up this might conflict package.json with turborepo migration in #470

PongDev · 2023-01-30T02:17:29Z

hold up this might conflict package.json with turborepo migration in #470

do you mean hold the pull request or hold the migration?

bombnp · 2023-01-30T02:56:20Z

hold up this might conflict package.json with turborepo migration in #470

do you mean hold the pull request or hold the migration?

hold the PR, as it would conflict the package.json a lot. U could keep on implementing the bot tho (like as @saenyakorn suggested), just be prepared to fix the package.json conflict

bombnp · 2023-02-02T17:40:28Z

@PongDev #470 is merged.

bombnp · 2023-02-02T17:41:35Z

u'll need to create a new package.json in your app directory with your own dependencies. No more piling every dependencies into single package.json at root.

PongDev and others added 11 commits December 30, 2022 20:32

Initialize Discord Bot Apps

517dc4c

Add discord.js package

e6ab576

Scaffolding Discord Bot

c68d72f

Implement Ping-Pong

980d6b0

Implement Basic Database with SQLite

e6c4005

Add Scheduler to Send Message At Specific Time

15b4d6a

Add Google Analytic Data API

eee2558

fix: possible crash due to un-awaited save

bda7fa5

remove deploy stage in action

87c8541

fix gened section data

5372002

Add Image Report

f9f6a5c

PongDev requested review from saenyakorn, leomotors, suphon-t and bombnp January 25, 2023 00:17

leomotors changed the title ~~[Discort-Bot] Implement Discort Bot Prototype~~ feat(discord-bot): Implement Discord Bot Prototype Jan 25, 2023

fix: merge commit

b6461ae

PongDev force-pushed the PongDev-Leo/discord-bot branch from d05d214 to b6461ae Compare January 25, 2023 06:03

bombnp requested changes Jan 25, 2023

View reviewed changes

apps/discord-bot/src/command/registerReportChannel.ts Outdated Show resolved Hide resolved

PongDev added 2 commits January 26, 2023 07:33

refactor: as recommended by comment

2cb0093

refactor: rename hook type file from hook.ts to type.ts

8811d82

bombnp requested changes Jan 27, 2023

View reviewed changes

bombnp force-pushed the beta branch from a364098 to c436920 Compare February 27, 2023 17:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(discord-bot): Implement Discord Bot Prototype #468

feat(discord-bot): Implement Discord Bot Prototype #468

PongDev commented Jan 25, 2023 •

edited by leomotors

Loading

leomotors commented Jan 25, 2023 •

edited

Loading

saenyakorn commented Jan 25, 2023

PongDev commented Jan 25, 2023

PongDev commented Jan 25, 2023 •

edited

Loading

saenyakorn commented Jan 25, 2023

PongDev commented Jan 25, 2023

PongDev commented Jan 25, 2023

bombnp Jan 25, 2023

PongDev Jan 25, 2023

bombnp Jan 25, 2023

PongDev Jan 26, 2023

PongDev Jan 26, 2023

bombnp Jan 27, 2023

bombnp Jan 25, 2023

PongDev Jan 26, 2023 •

edited

Loading

bombnp Jan 27, 2023 •

edited

Loading

bombnp Jan 25, 2023

PongDev Jan 26, 2023

bombnp Jan 25, 2023

bombnp Jan 25, 2023

PongDev Jan 26, 2023

bombnp Jan 27, 2023

bombnp Jan 25, 2023

bombnp Jan 27, 2023

bombnp Jan 27, 2023

bombnp commented Jan 27, 2023 •

edited

Loading

bombnp commented Jan 27, 2023 •

edited

Loading

saenyakorn commented Jan 27, 2023

saenyakorn commented Jan 27, 2023 •

edited

Loading

bombnp commented Jan 27, 2023 •

edited

Loading

PongDev commented Jan 30, 2023

bombnp commented Jan 30, 2023

bombnp commented Feb 2, 2023

bombnp commented Feb 2, 2023

		@@ -0,0 +1,53 @@
		import { GoogleAnalyticData } from './google-analytic'

		export class GoogleAnalyticDataExtended extends GoogleAnalyticData {

feat(discord-bot): Implement Discord Bot Prototype #468

Are you sure you want to change the base?

feat(discord-bot): Implement Discord Bot Prototype #468

Conversation

PongDev commented Jan 25, 2023 • edited by leomotors Loading

Why did you create this PR

What did you do

Demo

Checklist

leomotors commented Jan 25, 2023 • edited Loading

saenyakorn commented Jan 25, 2023

PongDev commented Jan 25, 2023

PongDev commented Jan 25, 2023 • edited Loading

saenyakorn commented Jan 25, 2023

PongDev commented Jan 25, 2023

PongDev commented Jan 25, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PongDev Jan 26, 2023 • edited Loading

Choose a reason for hiding this comment

bombnp Jan 27, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bombnp commented Jan 27, 2023 • edited Loading

bombnp commented Jan 27, 2023 • edited Loading

saenyakorn commented Jan 27, 2023

saenyakorn commented Jan 27, 2023 • edited Loading

bombnp commented Jan 27, 2023 • edited Loading

PongDev commented Jan 30, 2023

bombnp commented Jan 30, 2023

bombnp commented Feb 2, 2023

bombnp commented Feb 2, 2023

PongDev commented Jan 25, 2023 •

edited by leomotors

Loading

leomotors commented Jan 25, 2023 •

edited

Loading

PongDev commented Jan 25, 2023 •

edited

Loading

PongDev Jan 26, 2023 •

edited

Loading

bombnp Jan 27, 2023 •

edited

Loading

bombnp commented Jan 27, 2023 •

edited

Loading

bombnp commented Jan 27, 2023 •

edited

Loading

saenyakorn commented Jan 27, 2023 •

edited

Loading

bombnp commented Jan 27, 2023 •

edited

Loading