Refactor: codebase cleanup #509

mattyg · 2022-06-30T20:44:52Z

Overview

Docs

docstrings for all api functions
docstrings for all discord-bot functions

Refactor

move period/controllers/assignments non-controller functions into period/utils/assignments
remove redundant functions: praiseWithScore
modify InlineLabelClosable to use InlineLabel and use in Praise component, remove no longer needed ResetQuantificationButton
remove unncessary transformer wrapper functions, standardize function naming
check if umzug migrations are complete before running migrations
generate praise _id labels (i.e. #abcd) in backend, pass to frontend via PraiseDto
add types to express Request when expecting parameters in Request.body
modify getRandomString to use more secure crypto.randomBytes

Build

delete and regenerate yarn.lock file to upgrade packages and resolve conflicts
confirm discord.js function Util.cleanContent works with updated packages
add placeholder .eslintrc to discord-bot

Cleanup

search for and remove all "TODO" comments -- move to github tickets
delete unused functions
remove unused exports
add eslint rule for import ordering, and standardize import orders
run eslint on frontend build
re-add eslint rule import/no-default-exports and update all exports / imports to reflect. This ensures that all imported functions are named identically as when they are exported, which I think gives more clarity to devs.
standardize typescript path aliases formatted as @/blah and @blah between api and frontend -- now both are @/blah

…lers/assignment into utils/assignment

…thub tickets

…sed internally to module

…e InlineLabelClosable in Praise component, remove unneeded ResetQuantificationButton

…, rename for simplicity

…, rename for clarity

…n, rename for clarity

…rename for clarity

…ction, rename for clarity

…rder on all packages

… force all imports to have identical names to their original function name. Update all function exports and imports to reflect this rule (except for those loaded with React.lazy which only supports default exports)

…' for consistency with frontend path aliases

…ite, without specifying specific time delay

…flict. Fix new build errors arising from dependency minor updates. Ignore one build error I was unable to diagnose.

…t by mongoose schema defaults)

…is missing from /praise or /forward commands

…ormat()' and change formatting to iso standard yyyy-mm-dd

…labels used on frontend (i.e. #1234), pass to frontend via PraiseDto

… body

….randomBytes

…ors /warnings

mattyg · 2022-06-30T21:19:19Z

No idea why the github actions aren't running -- maybe because there are so many file changes the trigger checks are timing out?

Anyway you might need to run a lint, build and test locally to confirm.

kristoferlund

What a needed cleanup, great, thanks! ✨

kristoferlund · 2022-07-01T11:33:21Z

packages/api/src/eventlog/types.ts

@@ -10,7 +10,7 @@ export enum EventLogTypeKey {
  SETTING = 'SETTING',
 }

-export interface EventLog {
+interface EventLog {


Great not to export these types! Avoids accidental use.

mattyg added 30 commits June 28, 2022 18:49

docs(api): add docstrings to all api functions

9c47028

refactor(api): extract out non-controller functions in period/control…

7ba425c

…lers/assignment into utils/assignment

docs(api): add docstrings to praise controller functions

1376227

build(frontend): enable eslint on craco builds

e0355b4

chore: delete commented-out code

33287e6

chore: delete unecessary 'TODO' comments, and move necesary one to gi…

41ae834

…thub tickets

chore(frontend): linting fix

5d3263e

chore: delete all unused functions / code

cf5ee60

chore: remove 'export' from all functions / variables that are only u…

92b48f1

…sed internally to module

refactor(frontend): modify InlineLabelClosable to use InlineLable, us…

6457fca

…e InlineLabelClosable in Praise component, remove unneeded ResetQuantificationButton

refactor(api): remove unnecessary period transformer wrapper function…

c355f49

…, rename for simplicity

chore(api): rename periodsettingTransformer for clarity

469e614

refactor(api): remove unnecessary praise transformer wrapper function…

7cdff39

…, rename for clarity

refactor(api): remove unnecessary setting transformer wrapper functio…

55794cf

…n, rename for clarity

refactor(api): remove unnecessary user transformer wrapper function, …

87a6515

…rename for clarity

refactor(api): remove unnecessary useraccount transformer wrapper fun…

c5d3301

…ction, rename for clarity

build(api): add eslint rule import/order to specify a module import o…

88914df

…rder on all packages

chore(api): standardize import orders in api

aa930cc

chore(frontend); standardize import orders in frontend

28d94a2

chore(frontend): fix lint warnings

44cbb3a

chore(discord-bot): linting fixes

5583f41

refactor(api): rename typescript path aliases from '@BLAH' to '@/blah…

c59432b

…' for consistency with frontend path aliases

test(api): ensure all migrations are complete before starting test su…

161c608

…ite, without specifying specific time delay

Merge branch 'main' into refactor/codebase_cleanup

50b4bd9

build: delete yarn.lock and re-generate to resolve incomprensible con…

fb2fa65

…flict. Fix new build errors arising from dependency minor updates. Ignore one build error I was unable to diagnose.

chore(api): remove unclear comment

4c75fac

refactor(api): remove unncessary default values (which are already se…

e6b3f48

…t by mongoose schema defaults)

fix(discord-bot): respond with PRAISE_REASON_MISSING_ERROR if reason …

a28871e

…is missing from /praise or /forward commands

refactor(discord-bot): replace custom date formatter with date-fns 'f…

24564b9

…ormat()' and change formatting to iso standard yyyy-mm-dd

mattyg added 9 commits June 30, 2022 15:12

fix(api): missing export on type used in discord-bot

e863cd9

doc(discord-bot): add docstrings to all functions, linting fixes

689a367

build(discord-bot): add basic eslint config

ee33435

refactor: on backend generate a field _idLabelRealized for praise id …

4492a5b

…labels used on frontend (i.e. #1234), pass to frontend via PraiseDto

refactor(api): define type of Request where expecting data in request…

570986a

… body

refactor(api): replace custom nonce-generator with more secure crypto…

584258e

….randomBytes

build(frontend): re-enable eslint rules that were not causing any err…

4a4470e

…ors /warnings

Merge branch 'main' into refactor/codebase_cleanup

6341d26

build: allow manual trigger of github actions api, frontend, discord-bot

30b225b

mattyg changed the title ~~Refactor/codebase cleanup~~ Refactor: codebase cleanup Jun 30, 2022

mattyg requested a review from kristoferlund June 30, 2022 21:19

kristoferlund approved these changes Jul 1, 2022

View reviewed changes

kristoferlund merged commit 2860161 into main Jul 1, 2022

kristoferlund deleted the refactor/codebase_cleanup branch July 1, 2022 12:07

kristoferlund mentioned this pull request Jul 1, 2022

v0.10.0 #512

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor: codebase cleanup #509

Refactor: codebase cleanup #509

mattyg commented Jun 30, 2022 •

edited

Loading

mattyg commented Jun 30, 2022

kristoferlund left a comment

kristoferlund Jul 1, 2022

Refactor: codebase cleanup #509

Refactor: codebase cleanup #509

Conversation

mattyg commented Jun 30, 2022 • edited Loading

mattyg commented Jun 30, 2022

kristoferlund left a comment

Choose a reason for hiding this comment

kristoferlund Jul 1, 2022

Choose a reason for hiding this comment

mattyg commented Jun 30, 2022 •

edited

Loading