feat: First step at the rewrite #1

kyranet · 2019-11-10T17:46:21Z

Tasks

Finish initial implementation.
Write documentation.
Write tests.

Changelog

Added

Added Unit Testing.
Added examples for a large set of methods.
Added bare null as an option to reset a key in SettingsFolder#{update}.
Added Serializer#{validate,resolve} to allow further control on how SettingsGateway handles the data.
Added context to the settingsUpdate and settingsCreate events, they contain the raw changes, guild, language, etc.
Added extraContext to the SettingsFolderResetOptions type, this value is pased in all places (Serializer#validate, SchemaEntry#filter, settingsUpdate and settingsCreate events, and more).

Changed

Tweaked Serializer#deserialize's arguments to (SerializableValue, SerializerUpdateContext).
Renamed SchemaEntry#{min,max} to SchemaEntry#{minimum,maximum}.
Tweaked SettingsFolder's value type to be more accurate.
Tweaked SettingsFolderUpdateOptions's option to produce a TypeScript compiler error when arrayAction is set to 'overwrite' and arrayIndex is defined.
Tweaked SettingsFolder#client to throw an error when it's uninitialized.
Tweaked SettingsFolder#{reset,update} to return a much more useful struct.
When specifying arrayIndex in SettingsFolder#update and arrayAction is defined as add, all entries will be inserted at given index.
When specifying arrayIndex in SettingsFolder#update and arrayAction is defined as remove, as many entries as given will be removed from given index.
When specifying arrayIndex in SettingsFolder#update and arrayAction is not defined or defined as auto, all entries will replace the existing ones.

Removed

Removed throwOnError option in SettingsFolder#{reset,update}, they will now always throw when they encounter an error.

Fixed

Resolved bug where Schema#get would throw an error if a path did not exist.
Resolved bug where Schema#{add,remove} was still callable even after being initialized.
Resolved bug where SettingsFolder#get would throw an error if a path did not exist.
Resolved type bug in SettingsFolder#pluck.
Resolved bug in SettingsFolder#resolve not resolving into objects when specifying a folder path.
Resolved bug in SettingsFolder#reset where database conditions were not handled correctly.
Resolved bug in SettingsFolder#update where options would sometimes type error.
Resolved bug in SettingsFolder's patch function not allowing non-literal objects to be used.
Resolved bug in SettingsFolder#{reset,update} patching after emit.
Fixed the types from the Provider and SQLProvider classes.

PyroTechniac

Could only review parts of it, but found what I could.

src/lib/gateway/GatewayDriver.ts

ESM for when?

.eslintrc.json

Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com>

…ethods Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com>

Invalid entries should be removed, they should never stay as it corrupts the data.

Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com>

vladfrangu

For now, have these, I gotta go for a minute or so

src/lib/gateway/Gateway.ts

src/lib/gateway/GatewayDriver.ts

src/lib/gateway/GatewayStorage.ts

favna

2 quick remarks, will look in more detail in mo. in the train rn.

tsconfig.json

PyroTechniac

Just one thing, other than that it looks good.

src/lib/schema/Schema.ts

Co-Authored-By: Gryffon Bellish <owenbellish@gmail.com>

src/lib/schema/SchemaEntry.ts

src/lib/settings/Settings.ts

src/lib/settings/SettingsFolder.ts

src/lib/structures/ProviderStore.ts

favna

You did ask

src/index.ts

src/lib/gateway/Gateway.ts

src/lib/settings/SettingsFolder.ts

tsconfig.json

favna

You did ask

feat: First step at the rewrite

c49f1ed

kyranet added the enhancement label Nov 10, 2019

kyranet changed the title ~~feat: First step at the rewrite~~ [WIP] feat: First step at the rewrite Nov 10, 2019

kyranet added 5 commits November 10, 2019 20:24

feat: Added more progress

2a0d373

feat: Added more things

eaff9ba

git: Why do we not ignore yarn-error.log?

85398f7

refactor: Move code around and finished Settings and GatewayDriver

dfe163c

misc: Deleted yarn-error.log

968058f

PyroTechniac suggested changes Nov 11, 2019

View reviewed changes

src/lib/gateway/GatewayDriver.ts Show resolved Hide resolved

kyranet added 2 commits November 11, 2019 16:44

feat: Added all structures

95d30e5

lint: Fixed several ESLint warnings

fd50d31

kyranet mentioned this pull request Nov 11, 2019

SettingsGateway: The Final Rewrite dirigeants/klasa#875

Closed

4 tasks

kyranet added 3 commits November 11, 2019 17:35

build: Resolved all build errors

869a33e

fix: Resovled circular references

5978f15

ESM for when?

tests: Added first mock classes and fixed a few things

a8ac06f

bdistin previously requested changes Nov 12, 2019

View reviewed changes

.eslintrc.json Outdated Show resolved Hide resolved

kyranet and others added 14 commits November 29, 2019 13:02

tests: Add a bunch of tests and fixed a few things

ed6ab6f

misc: More tests, finalized SG and fixed bugs

d8e46a5

polyfill: Added ObjectFromEntries for Node.js v10 compatibility

abd34f8

misc: Fixed SchemaEntry#edit, added examples and tests

0065363

Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com>

docs: I heard you liked examples

181716f

docs: Added more examples

7eb7def

misc: Finalized SchemaEntry's tests, documented more, moved resolve m…

4668d66

…ethods Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com>

fix: Better _checkSchemaFolder and freeze SchemaEntry instances

9761129

Invalid entries should be removed, they should never stay as it corrupts the data.

misc: Refactor code and added more tests

5aae670

Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com>

tests: Fixed Settings tests

b857e36

misc: Resolved bug in Settings upsert code, added more tests

135e209

Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com>

chore: Update all dependencies

73e7b6c

build: Enable declarationMap

b45dcc1

ci: Use Crawl's action and Node.js 12

a222327

vladfrangu suggested changes Dec 9, 2019

View reviewed changes

src/lib/gateway/Gateway.ts Outdated Show resolved Hide resolved

src/lib/gateway/GatewayDriver.ts Outdated Show resolved Hide resolved

src/lib/gateway/GatewayStorage.ts Outdated Show resolved Hide resolved

src/lib/gateway/GatewayStorage.ts Outdated Show resolved Hide resolved

favna reviewed Dec 9, 2019

View reviewed changes

tsconfig.json Outdated Show resolved Hide resolved

tsconfig.json Outdated Show resolved Hide resolved

kyranet added 2 commits December 9, 2019 18:17

misc: Resolved code review by @vladfrangu

74a4085

misc: Resolved code review by @favna

b4ec819

kyranet added 4 commits December 9, 2019 18:47

git: Ignore all .xml and .log files

105d652

chore: Update all dependencies

4df9f91

package: Update the name, description, and repository.url

5af9b29

npm: Add .github and remove unused/inexistent files

16e431a

PyroTechniac suggested changes Dec 9, 2019

View reviewed changes

src/lib/schema/Schema.ts Outdated Show resolved Hide resolved

Update src/lib/schema/Schema.ts

fc0ef32

Co-Authored-By: Gryffon Bellish <owenbellish@gmail.com>

PyroTechniac approved these changes Dec 9, 2019

View reviewed changes

vladfrangu reviewed Dec 9, 2019

View reviewed changes

src/lib/schema/SchemaEntry.ts Show resolved Hide resolved

vladfrangu suggested changes Dec 9, 2019

View reviewed changes

src/lib/settings/Settings.ts Outdated Show resolved Hide resolved

src/lib/settings/SettingsFolder.ts Outdated Show resolved Hide resolved

src/lib/structures/ProviderStore.ts Outdated Show resolved Hide resolved

favna suggested changes Dec 9, 2019

View reviewed changes

kyranet added 2 commits December 9, 2019 23:07

misc: Resolved all requested changes from @vladfrangu and @favna

c6da24b

style: Re-add _ prefix to methods users are not supposed to use

f7b38ca

vladfrangu approved these changes Dec 9, 2019

View reviewed changes

kyranet removed the request for review from tech6hutch December 9, 2019 22:34

favna approved these changes Dec 9, 2019

View reviewed changes

kyranet merged commit bf60f41 into master Dec 9, 2019

kyranet deleted the impl branch December 9, 2019 22:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: First step at the rewrite #1

feat: First step at the rewrite #1

kyranet commented Nov 10, 2019 •

edited

PyroTechniac left a comment

vladfrangu left a comment

favna left a comment

PyroTechniac left a comment

favna left a comment

favna left a comment

feat: First step at the rewrite #1

feat: First step at the rewrite #1

Conversation

kyranet commented Nov 10, 2019 • edited

Tasks

Changelog

Added

Changed

Removed

Fixed

PyroTechniac left a comment

Choose a reason for hiding this comment

vladfrangu left a comment

Choose a reason for hiding this comment

favna left a comment

Choose a reason for hiding this comment

PyroTechniac left a comment

Choose a reason for hiding this comment

favna left a comment

Choose a reason for hiding this comment

favna left a comment

Choose a reason for hiding this comment

kyranet commented Nov 10, 2019 •

edited