feat: modern implementation by jacobtipp · Pull Request #107 · felangel/bloc.js

jacobtipp · 2023-02-09T14:06:35Z

Status

IN DEVELOPMENT

Breaking Changes

YES

Description

Update API to reflect modern v8.x Dart implementation

Type of Change

✨ New feature (non-breaking change which adds functionality)
🛠️ Bug fix (non-breaking change which fixes an issue)
❌ Breaking change (fix or feature that would cause existing functionality to change)
🧹 Code refactor
✅ Build configuration change
📝 Documentation
🗑️ Chore

erickjtorres · 2023-02-10T16:11:15Z

LGTM

better long term support without breaking current build

jacobtipp · 2023-02-11T17:02:43Z

LGTM

I changed the node engine compatibility from version 6 to 14. I believe this is why the CI was failing, as it was running node version 10. Most newer packages support node v14+ only nowadays. Also I have marked this pull request as a draft. I still need to add Cubit/Bloc and their respective tests.

jacobtipp · 2023-02-16T03:37:12Z

These are some big changes. I've tried to keep the implementation as close as possible to the original with 100% code coverage.

Some things to note related to Typescript, JavaScript, and limitations:

Events must be classes. Which means enums can't be used as events. It is discouraged to use enums in Typescript because they aren't native to JavaScript and will require extra code to be compiled to mimic it's behavior at runtime. Using es6 classes for bloc events makes more sense and gives us consistency. Use discriminated unions instead of enums whenever possible.
Typescript doesn't have callabale classes. Which means the emitter instance cannot be used as a function. However, in JavaScript, all functions are objects, so I've created a "callable emitter" that simply proxies all calls to the actual emitter instance. This can be seen here

felangel · 2023-02-16T06:07:21Z

These are some big changes. I've tried to keep the implementation as close as possible to the original with 100% code coverage.

Some things to note related to Typescript, JavaScript, and limitations:

Events must be classes. Which means enums can't be used as events. It is discouraged to use enums in Typescript because they aren't native to JavaScript and will require extra code to be compiled to mimic it's behavior at runtime. Using es6 classes for bloc events makes more sense and gives us consistency. Use discriminated unions instead of enums whenever possible.

Typescript doesn't have callabale classes. Which means the emitter instance cannot be used as a function. However, in JavaScript, all functions are objects, so I've created a "callable emitter" that simply proxies all calls to the actual emitter instance. This can be seen here

Thanks so much for the huge contribution! I’ll make sure to review this within the next few days 🙏💯

codecov-commenter · 2023-02-16T06:08:32Z

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (69e71fe) 100.00% compared to head (2c906df) 100.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##            master      #107    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files            1         9     +8     
  Lines           33       196   +163     
  Branches         5        12     +7     
==========================================
+ Hits            33       196   +163

Impacted Files	Coverage Δ
packages/bloc/lib/src/base.ts	`100.00% <100.00%> (ø)`
packages/bloc/lib/src/bloc-observer.ts	`100.00% <100.00%> (ø)`
packages/bloc/lib/src/bloc.ts	`100.00% <100.00%> (ø)`
packages/bloc/lib/src/change.ts	`100.00% <100.00%> (ø)`
packages/bloc/lib/src/cubit.ts	`100.00% <100.00%> (ø)`
packages/bloc/lib/src/emitter.ts	`100.00% <100.00%> (ø)`
packages/bloc/lib/src/event.ts	`100.00% <100.00%> (ø)`
packages/bloc/lib/src/index.ts	`100.00% <100.00%> (ø)`

... and 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

BREAKING CHANGE: sync with felangel/bloc.js#107

# [1.0.0-beta.3](bloc-v1.0.0-beta.2...bloc-v1.0.0-beta.3) (2023-02-19) ### Features * **bloc:** 💥 ✨ sync with bloc.js fork ([3912488](3912488)) ### BREAKING CHANGES * **bloc:** sync with felangel/bloc.js#107

# [1.0.0-beta.2](react-bloc-v1.0.0-beta.1...react-bloc-v1.0.0-beta.2) (2023-02-19) ### Features * **bloc:** 💥 ✨ sync with bloc.js fork ([3912488](3912488)) ### BREAKING CHANGES * **bloc:** sync with felangel/bloc.js#107

# [1.0.0-beta.2](bloc-concurrency-v1.0.0-beta.1...bloc-concurrency-v1.0.0-beta.2) (2023-02-19) ### Features * **bloc:** 💥 ✨ sync with bloc.js fork ([3912488](3912488)) ### BREAKING CHANGES * **bloc:** sync with felangel/bloc.js#107

# [1.0.0-beta.2](bloc-todos-v1.0.0-beta.1...bloc-todos-v1.0.0-beta.2) (2023-02-19) ### Features * **bloc:** 💥 ✨ sync with bloc.js fork ([3912488](3912488)) ### BREAKING CHANGES * **bloc:** sync with felangel/bloc.js#107

# [1.0.0-beta.2](hacker-news-v1.0.0-beta.1...hacker-news-v1.0.0-beta.2) (2023-02-19) ### Features * **bloc:** 💥 ✨ sync with bloc.js fork ([3912488](3912488)) ### BREAKING CHANGES * **bloc:** sync with felangel/bloc.js#107

# 1.0.0-fix-release.1 (2023-03-10) ### Bug Fixes * **bloc:** 🐛 added State to BlocBaseConfig generic argument ([e0cda85](e0cda85)) * **bloc:** 🐛 change historyLimit to 1 ([359085f](359085f)) * **bloc:** 🐛 rethrow errors caught inside emit ([8d20c83](8d20c83)) * **bloc:** 🐛 rethrow unhandled error from eventHandler ([19cef9f](19cef9f)) * **bloc:** 🐛 switched to vite for bundling ([a9780d5](a9780d5)) * **build:** 🐛 📦️ set sideEffects flag to false ([8ee593a](8ee593a)) * **state:** 🐛 change property stateName to name ([a360c93](a360c93)) * **state:** 🐛 make immer peer dependency ([4382844](4382844)) * **state:** 🐛 switched to vite for bundling ([a1c7847](a1c7847)) ### Features * **bloc:** ✨ added BlocHistory class for time travel ([14334b1](14334b1)) * **bloc:** ✨ added customizable subject option ([5818057](5818057)) * **bloc:** ✨ added history ([0777c1e](0777c1e)) * **bloc:** ✨ use Subject instead of BehaviourSubject ([ffc0df8](ffc0df8)) * **bloc:** 💥 ✨ sync with bloc.js fork ([3912488](3912488)) * **ci:** ✨ 👷 ci trigger ([0720886](0720886)) * **ci:** ✨ 👷 ci trigger for @jacobtipp/react-bloc ([f7130a1](f7130a1)) * **ci:** ✨ 👷 ci trigger for @jacobtipp/state ([d19970f](d19970f)) * initial commit [skip-ci] ([904a867](904a867)) ### BREAKING CHANGES * **bloc:** sync with felangel/bloc.js#107

# 1.0.0-fix-release.1 (2023-03-10) ### Bug Fixes * **bloc-provider:** 🐛 explicitily accept BlocBase<any> for bloc prop array ([0d75ee2](0d75ee2)) * **bloc:** 🐛 added State to BlocBaseConfig generic argument ([e0cda85](e0cda85)) * **bloc:** 🐛 rethrow errors caught inside emit ([8d20c83](8d20c83)) * **bloc:** 🐛 rethrow unhandled error from eventHandler ([19cef9f](19cef9f)) * **bloc:** 🐛 switched to vite for bundling ([a9780d5](a9780d5)) * **build:** 🐛 📦️ set sideEffects flag to false ([8ee593a](8ee593a)) * **react-bloc:** 🐛 added memoization to hooks where needed ([a1cfeeb](a1cfeeb)) * **react-bloc:** 🐛 fix path for types in package.json ([8aa5c35](8aa5c35)) * **react-bloc:** 🐛 populate BlocListener with initial state ([bd84382](bd84382)) * **react-bloc:** 🐛 satisfy react-hooks/rules-of-hooks ([08d029a](08d029a)) * **react-bloc:** 🐛 set private to false in package.json ([18fb19c](18fb19c)) * **state:** 🐛 change property stateName to name ([a360c93](a360c93)) * **state:** 🐛 make immer peer dependency ([4382844](4382844)) * **state:** 🐛 switched to vite for bundling ([a1c7847](a1c7847)) ### Features * **bloc:** ✨ added customizable subject option ([5818057](5818057)) * **bloc:** ✨ added history ([0777c1e](0777c1e)) * **bloc:** 💥 ✨ sync with bloc.js fork ([3912488](3912488)) * **ci:** ✨ 👷 ci trigger ([0720886](0720886)) * **ci:** ✨ 👷 ci trigger for @jacobtipp/react-bloc ([f7130a1](f7130a1)) * **ci:** ✨ 👷 ci trigger for @jacobtipp/state ([d19970f](d19970f)) * initial commit [skip-ci] ([904a867](904a867)) * **react-bloc:** ✨ add useDebugValue ([526fc9b](526fc9b)) ### BREAKING CHANGES * **bloc:** sync with felangel/bloc.js#107

# 1.0.0-fix-release.1 (2023-03-10) ### Bug Fixes * **bloc-concurrency:** 🐛 update type definitions path ([2e37905](2e37905)) * **bloc:** 🐛 added State to BlocBaseConfig generic argument ([e0cda85](e0cda85)) * **bloc:** 🐛 rethrow errors caught inside emit ([8d20c83](8d20c83)) * **bloc:** 🐛 rethrow unhandled error from eventHandler ([19cef9f](19cef9f)) * **bloc:** 🐛 switched to vite for bundling ([a9780d5](a9780d5)) * **build:** 🐛 📦️ set sideEffects flag to false ([8ee593a](8ee593a)) * **state:** 🐛 change property stateName to name ([a360c93](a360c93)) * **state:** 🐛 make immer peer dependency ([4382844](4382844)) * **state:** 🐛 switched to vite for bundling ([a1c7847](a1c7847)) ### Features * **bloc:** ✨ added customizable subject option ([5818057](5818057)) * **bloc:** ✨ added history ([0777c1e](0777c1e)) * **bloc:** 💥 ✨ sync with bloc.js fork ([3912488](3912488)) * **ci:** ✨ 👷 ci trigger ([0720886](0720886)) * **ci:** ✨ 👷 ci trigger for @jacobtipp/bloc-concurrency ([6d1de94](6d1de94)) * **ci:** ✨ 👷 ci trigger for @jacobtipp/react-bloc ([f7130a1](f7130a1)) * **ci:** ✨ 👷 ci trigger for @jacobtipp/state ([d19970f](d19970f)) * initial commit [skip-ci] ([904a867](904a867)) ### BREAKING CHANGES * **bloc:** sync with felangel/bloc.js#107

# 1.0.0-fix-publish.1 (2023-03-11) ### Bug Fixes * **bloc:** 🐛 added State to BlocBaseConfig generic argument ([e0cda85](e0cda85)) * **bloc:** 🐛 change historyLimit to 1 ([359085f](359085f)) * **bloc:** 🐛 rethrow errors caught inside emit ([8d20c83](8d20c83)) * **bloc:** 🐛 rethrow unhandled error from eventHandler ([4c7b3b6](4c7b3b6)) * **bloc:** 🐛 switched to vite for bundling ([a9780d5](a9780d5)) * **bloc:** 🐛 trigger release ([d33d70b](d33d70b)) * **build:** 🐛 📦️ set sideEffects flag to false ([8ee593a](8ee593a)) * **state:** 🐛 change property stateName to name ([a360c93](a360c93)) * **state:** 🐛 make immer peer dependency ([4382844](4382844)) * **state:** 🐛 switched to vite for bundling ([a1c7847](a1c7847)) ### Features * **bloc:** ✨ added BlocHistory class for time travel ([14334b1](14334b1)) * **bloc:** ✨ added customizable subject option ([5818057](5818057)) * **bloc:** ✨ added history ([0777c1e](0777c1e)) * **bloc:** ✨ use Subject instead of BehaviourSubject ([ffc0df8](ffc0df8)) * **bloc:** 💥 ✨ sync with bloc.js fork ([3912488](3912488)) * **ci:** ✨ 👷 ci trigger ([0720886](0720886)) * **ci:** ✨ 👷 ci trigger for @jacobtipp/react-bloc ([f7130a1](f7130a1)) * **ci:** ✨ 👷 ci trigger for @jacobtipp/state ([d19970f](d19970f)) * initial commit [skip-ci] ([904a867](904a867)) ### BREAKING CHANGES * **bloc:** sync with felangel/bloc.js#107

# 1.0.0-fix-publish.1 (2023-03-11) ### Bug Fixes * **bloc-provider:** 🐛 explicitily accept BlocBase<any> for bloc prop array ([0d75ee2](0d75ee2)) * **bloc:** 🐛 added State to BlocBaseConfig generic argument ([e0cda85](e0cda85)) * **bloc:** 🐛 rethrow errors caught inside emit ([8d20c83](8d20c83)) * **bloc:** 🐛 rethrow unhandled error from eventHandler ([4c7b3b6](4c7b3b6)) * **bloc:** 🐛 switched to vite for bundling ([a9780d5](a9780d5)) * **bloc:** 🐛 trigger release ([d33d70b](d33d70b)) * **build:** 🐛 📦️ set sideEffects flag to false ([8ee593a](8ee593a)) * **react-bloc:** 🐛 added memoization to hooks where needed ([a1cfeeb](a1cfeeb)) * **react-bloc:** 🐛 fix path for types in package.json ([8aa5c35](8aa5c35)) * **react-bloc:** 🐛 populate BlocListener with initial state ([bd84382](bd84382)) * **react-bloc:** 🐛 satisfy react-hooks/rules-of-hooks ([08d029a](08d029a)) * **react-bloc:** 🐛 set private to false in package.json ([18fb19c](18fb19c)) * **state:** 🐛 change property stateName to name ([a360c93](a360c93)) * **state:** 🐛 make immer peer dependency ([4382844](4382844)) * **state:** 🐛 switched to vite for bundling ([a1c7847](a1c7847)) ### Features * **bloc:** ✨ added customizable subject option ([5818057](5818057)) * **bloc:** ✨ added history ([0777c1e](0777c1e)) * **bloc:** 💥 ✨ sync with bloc.js fork ([3912488](3912488)) * **ci:** ✨ 👷 ci trigger ([0720886](0720886)) * **ci:** ✨ 👷 ci trigger for @jacobtipp/react-bloc ([f7130a1](f7130a1)) * **ci:** ✨ 👷 ci trigger for @jacobtipp/state ([d19970f](d19970f)) * initial commit [skip-ci] ([904a867](904a867)) * **react-bloc:** ✨ add useDebugValue ([526fc9b](526fc9b)) ### BREAKING CHANGES * **bloc:** sync with felangel/bloc.js#107

# 1.0.0-fix-publish.1 (2023-03-11) ### Bug Fixes * **bloc-concurrency:** 🐛 update type definitions path ([2e37905](2e37905)) * **bloc:** 🐛 added State to BlocBaseConfig generic argument ([e0cda85](e0cda85)) * **bloc:** 🐛 rethrow errors caught inside emit ([8d20c83](8d20c83)) * **bloc:** 🐛 rethrow unhandled error from eventHandler ([4c7b3b6](4c7b3b6)) * **bloc:** 🐛 switched to vite for bundling ([a9780d5](a9780d5)) * **bloc:** 🐛 trigger release ([d33d70b](d33d70b)) * **build:** 🐛 📦️ set sideEffects flag to false ([8ee593a](8ee593a)) * **state:** 🐛 change property stateName to name ([a360c93](a360c93)) * **state:** 🐛 make immer peer dependency ([4382844](4382844)) * **state:** 🐛 switched to vite for bundling ([a1c7847](a1c7847)) ### Features * **bloc:** ✨ added customizable subject option ([5818057](5818057)) * **bloc:** ✨ added history ([0777c1e](0777c1e)) * **bloc:** 💥 ✨ sync with bloc.js fork ([3912488](3912488)) * **ci:** ✨ 👷 ci trigger ([0720886](0720886)) * **ci:** ✨ 👷 ci trigger for @jacobtipp/bloc-concurrency ([6d1de94](6d1de94)) * **ci:** ✨ 👷 ci trigger for @jacobtipp/react-bloc ([f7130a1](f7130a1)) * **ci:** ✨ 👷 ci trigger for @jacobtipp/state ([d19970f](d19970f)) * initial commit [skip-ci] ([904a867](904a867)) ### BREAKING CHANGES * **bloc:** sync with felangel/bloc.js#107

jacobtipp added 2 commits February 9, 2023 04:23

build(tslint): removed tslint and added eslint

59d059b

build(eslint): add support for linting tests

dc7492d

jacobtipp mentioned this pull request Feb 9, 2023

Update API to modern Dart implementation #108

Open

jacobtipp changed the title ~~Feat/modern implementation~~ feat: modern implementation Feb 9, 2023

felangel assigned jacobtipp Feb 10, 2023

felangel added the enhancement New feature or request label Feb 10, 2023

build(typescript): bump v3.0.3 to v4.9.5

a222878

erickjtorres previously approved these changes Feb 10, 2023

View reviewed changes

ci: support node v14

c6b4008

better long term support without breaking current build

jacobtipp dismissed erickjtorres’s stale review via c6b4008 February 11, 2023 16:32

jacobtipp marked this pull request as draft February 11, 2023 16:51

jacobtipp added 6 commits February 16, 2023 00:07

build(eslint): use underscore for no-unused-vars

ce01c77

feat(bloc): modern bloc api

4c061f5

chore(prettier): update from v1.14.3 to v2.8.4

14a95bf

build(eslint): require noImplicitOverride

5e6ade5

style: format repo with updated changes

7a1cf6b

test(bloc): add missing expect.assertions

f851694

jacobtipp marked this pull request as ready for review February 16, 2023 02:36

jacobtipp added a commit to jacobtipp/bloc-state that referenced this pull request Feb 19, 2023

feat(bloc): 💥 ✨ sync with bloc.js fork

3912488

BREAKING CHANGE: sync with felangel/bloc.js#107

Merge branch 'master' into feat/modern-implementation

2c906df

zsoerenm approved these changes Mar 28, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: modern implementation#107

feat: modern implementation#107
jacobtipp wants to merge 11 commits intofelangel:masterfrom
jacobtipp:feat/modern-implementation

jacobtipp commented Feb 9, 2023

Uh oh!

erickjtorres commented Feb 10, 2023

Uh oh!

jacobtipp commented Feb 11, 2023

Uh oh!

jacobtipp commented Feb 16, 2023

Uh oh!

felangel commented Feb 16, 2023

Uh oh!

codecov-commenter commented Feb 16, 2023 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

jacobtipp commented Feb 9, 2023

Status

Breaking Changes

Description

Type of Change

Uh oh!

erickjtorres commented Feb 10, 2023

Uh oh!

jacobtipp commented Feb 11, 2023

Uh oh!

jacobtipp commented Feb 16, 2023

Uh oh!

felangel commented Feb 16, 2023

Uh oh!

codecov-commenter commented Feb 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov-commenter commented Feb 16, 2023 •

edited

Loading