feat: make renderer state initialization synchronous by default #280

matmalkowski · 2020-10-31T18:53:20Z

Apart from implementing the synchronous initialisation, (and keeping the async one OPT-IN via options), I've also moved a bit a code to stand alone modules and added some more unit tests

resolves #278

Implements #278

matmalkowski · 2020-10-31T18:56:12Z

@sapkra Here you go ;)

src/constants/index.ts

sapkra · 2020-10-31T20:08:49Z

src/fetchState/index.ts

+import fetchInitialState from './fetchInitialState'
+import fetchInitialStateAsync from './fetchInitialStateAsync'
+
+export { fetchInitialState, fetchInitialStateAsync }


If you could use normal exports instead of default exports here, you could do something like this:

Suggested change

import fetchInitialState from './fetchInitialState'

import fetchInitialStateAsync from './fetchInitialStateAsync'

export { fetchInitialState, fetchInitialStateAsync }

export * from './fetchInitialState'

export * from './fetchInitialStateAsync'

I'm following here the rule of default export if its only module export (as in prefer-default-export from eslint)

It's a very controversial topic and more a design decision in my opinion. I really didn't liked it in my code that I have to implement more complexity for reexporting variables and that it is possible to introduce typos because default imports don't rely on the correct exported naming.

There is a huge discussion about it in this issue: airbnb/javascript#1365

In my codebase I completely disabled this rule and going to use named exports only. Additionally it should help with tree shaking.

src/options/RendererStateSyncEnhancerOptions.ts

sapkra · 2020-10-31T21:42:16Z

src/fetchState/replaceState.ts

+    payload: S
+}
+
+const REPLACE_STATE = 'electron-redux.REPLACE_STATE'


I would prefer to have all actions at one place but it's also fine like this.

This is action type that is redux specific, and its scoped only to this module, while others are grouped as ipc events topic or channels, hence the separation

src/fetchState/fetchInitialStateAsync.ts

src/options/RendererStateSyncEnhancerOptions.ts

Co-authored-by: Burkhard Reffeling <burkhard.reffeling@gmail.com>

hardchor

Thanks for addressing all comments! LGTM :)

matmalkowski · 2020-11-27T10:44:09Z

🎉 This PR is included in version 2.0.0-alpha.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

* feat: migrate to typescript (#259) * feat: migrate to typescript This is WIP * feat: package.json cleanup * chore: remove eslint config rules * chore: more cleaning * chore: add tsc tests * chore: reorganize export structure * chore: add some basic e2e tests * buid: add GH action for PR * fix: e2e test memory leak fix * chore: vscode workspace settings * fix: update username in package.json * chore: rollup.config simplify * chore: add eslint (#268) * chore: add eslint This PR adds eslint setup to the reposiory. It doesn't fix existing errors/warnings - should get addressed in follow up Pull Requests since the codebase isn't final now anyway. Errors so far: ``` /Users/maciej.malkowski/git/github.com/klarna/electron-redux/src/syncMain.ts 18:56 error Async arrow function has no 'await' expression @typescript-eslint/require-await 46:3 error Unsafe return of an any typed value @typescript-eslint/no-unsafe-return /Users/maciej.malkowski/git/github.com/klarna/electron-redux/src/syncRenderer.ts 21:8 error Unsafe assignment of an any value @typescript-eslint/no-unsafe-assignment 61:4 error Unsafe return of an any typed value @typescript-eslint/no-unsafe-return 76:3 error Unsafe return of an any typed value @typescript-eslint/no-unsafe-return 85:27 warning Unexpected any. Specify a different type @typescript-eslint/no-explicit-any 93:3 error Promises must be handled appropriately or explicitly marked as ignored with the `void` operator @typescript-eslint/no-floating-promises 105:3 error Unsafe return of an any typed value @typescript-eslint/no-unsafe-return 105:32 warning Unexpected any. Specify a different type @typescript-eslint/no-explicit-any /Users/maciej.malkowski/git/github.com/klarna/electron-redux/src/utils/actions.ts 15:31 warning Missing return type on function @typescript-eslint/explicit-module-boundary-types /Users/maciej.malkowski/git/github.com/klarna/electron-redux/src/utils/json.ts 6:9 error Unsafe assignment of an any value @typescript-eslint/no-unsafe-assignment 7:3 error Unsafe member access .__hydrate_type on an any value @typescript-eslint/no-unsafe-member-access 22:24 warning Missing return type on function @typescript-eslint/explicit-module-boundary-types 22:36 warning Argument 'value' should be typed with a non-any type @typescript-eslint/explicit-module-boundary-types 22:43 warning Unexpected any. Specify a different type @typescript-eslint/no-explicit-any 23:6 error Unsafe member access .__hydrate_type on an any value @typescript-eslint/no-unsafe-member-access 27:13 error Unsafe member access .__hydrate_type on an any value @typescript-eslint/no-unsafe-member-access 28:18 error Unsafe member access .items on an any value @typescript-eslint/no-unsafe-member-access 31:2 error Unsafe return of an any typed value @typescript-eslint/no-unsafe-return /Users/maciej.malkowski/git/github.com/klarna/electron-redux/src/utils/misc.ts 7:44 warning Missing return type on function @typescript-eslint/explicit-module-boundary-types 24:29 warning Missing return type on function @typescript-eslint/explicit-module-boundary-types 33:31 warning Missing return type on function @typescript-eslint/explicit-module-boundary-types /Users/maciej.malkowski/git/github.com/klarna/electron-redux/tests/e2e.spec.ts 21:5 error Unexpected `await` of a non-Promise (non-"Thenable") value @typescript-eslint/await-thenable 36:12 error Unexpected `await` of a non-Promise (non-"Thenable") value @typescript-eslint/await-thenable 45:12 error Unexpected `await` of a non-Promise (non-"Thenable") value @typescript-eslint/await-thenable /Users/maciej.malkowski/git/github.com/klarna/electron-redux/tests/e2e/main/index.ts 31:5 error Promises must be handled appropriately or explicitly marked as ignored with the `void` operator @typescript-eslint/no-floating-promises 31:44 error Invalid type "string | undefined" of template literal expression @typescript-eslint/restrict-template-expressions 33:5 error Promises must be handled appropriately or explicitly marked as ignored with the `void` operator @typescript-eslint/no-floating-promises 54:1 error Promises must be handled appropriately or explicitly marked as ignored with the `void` operator @typescript-eslint/no-floating-promises /Users/maciej.malkowski/git/github.com/klarna/electron-redux/tests/e2e/renderer/index.ts 9:5 warning Forbidden non-null assertion @typescript-eslint/no-non-null-assertion 18:5 warning Forbidden non-null assertion @typescript-eslint/no-non-null-assertion 22:5 warning Forbidden non-null assertion @typescript-eslint/no-non-null-assertion 32:5 warning Forbidden non-null assertion @typescript-eslint/no-non-null-assertion /Users/maciej.malkowski/git/github.com/klarna/electron-redux/tests/typescript/syncMain.ts 5:7 warning 'store' is assigned a value but never used @typescript-eslint/no-unused-vars /Users/maciej.malkowski/git/github.com/klarna/electron-redux/tests/typescript/syncRenderer.ts 5:7 warning 'store' is assigned a value but never used @typescript-eslint/no-unused-vars ✖ 35 problems (20 errors, 15 warnings) ``` * fix: fix test related type issues * chore: add prettier & format the code (#269) This PR adds the prettier code formatter with custom config, and formats existing code according to those rulles. Pre-commit hook to format staged files was also added. * feat: add Code of Conduct & bump version (#270) This pull request adds Code of Conducts and marks the change as breaking for semanric release to bump the version to v2 BREAKING CHANGE: TS rewrite * feat: add semantic-release setup for automatic deployments (#271) * feat: add semantic-release setup for automatic deployments This adds the setup for semantic-release. master/beta/alpha branch changes will get deployed to npm with version depending on the commit message * chore: add PR linter * chore: add more events tro trigger the check * fix: remove default custom serialization and make it an opt-in option (#272) Removing custom serializer as a default, since its not alligned with redux recomendation about store & serialization fix #261 * fix: reduce bundle size by limiting external dependencies (#276) I removed external dependency of `flux-standard-action` that includes entire loadash with it when imported. Instead, I re-implemented single function we are using and relied on single modules from loadash that are required. Should reduce the size significantly * feat: ignore devtools when sending actions to renderers (#275) Co-authored-by: Maciej Małkowski <monkey3310@gmail.com> * chore: add README & LICENSE (#281) * chore: add README & LICENSE As per title, adding initial README file & LICENSE. It will need some work for sure, I've left the missing links as TODO * chore: more badges * chore: apply suggestions from code review Co-authored-by: Burkhard Reffeling <burkhard.reffeling@gmail.com> * Update LICENSE.md Co-authored-by: Burkhard Reffeling <burkhard.reffeling@gmail.com> * feat: make renderer state initialization synchronous by default (#280) * feat: make renderer state initialization synchronous by default Implements #278 * code review comments * chore: spelling Co-authored-by: Burkhard Reffeling <burkhard.reffeling@gmail.com> * chore: code review comments Co-authored-by: Burkhard Reffeling <burkhard.reffeling@gmail.com> * docs: setup base documentation website (#277) * docussaurus initial setup * base docussaurus config * add base gh-pages deployment action * remove unnecessary job step * test changing baseurl * fix last commit * fix last commit * remove trailing slash * fix baseUrl config * add basic content based on readme * use yarn in gh-pages action Co-authored-by: Maciej Małkowski <monkey3310@gmail.com> * feat: add option for denyList (#274) * fix: align enhancer style with standards to wrap the middleware (#284) * fix: align enhancer style with standards to wrap the middleware * fix: align enhancer style with standards to wrap the middleware * docs: adding initial content for v2 (#290) * docs: adding initial content for v2 Adding some initial content for Version 2, including expected file tree of documentation & legacy v1 docs paragraph. * chore: apply suggestions from code review Co-authored-by: Burkhard Reffeling <burkhard.reffeling@gmail.com> Co-authored-by: Burkhard Reffeling <burkhard.reffeling@gmail.com> * docs: fixing doc build issue with missing paths (#295) Also adding PR build step to prevent this from happening again * chore: update semrel lint to run on forks * fix(#285): add composeWithStateSync to resolve issues with enhancer order (#296) * fix(#285): add composeWithStateSync to resolve issues with enhancer order * fix: resolve PR comments * chore: add type tests * docs: update README getting started and add changes to FAQ Co-authored-by: Maciej Małkowski <monkey3310@gmail.com> * chore: update README * chore: update README links * chore: adding basic example of usage in raw scenario + moving integration tests (#299) * chore: adding basic example of usage in raw scenario * chore: work in progress * chore: trying to add tests * chore: fixing e2e tests and making them runnable * fix package.json * chore: code review comments addressed * feat: use contextBridge in favour of requiring nodeIntegration (#300) * feat: use contextBridge in favour of requiring nodeIntegration Due to security concerns related to usage of nodeIntegration flag, according to best electron practices, renderer functions should be exposed with contextBridge. This PR does exactly that. It also changes a bit API to accomodate for this feature * feat: fixing issues with test enviroment * fix: add missing preventDoubleInitialization() check * change the scope of the contextBridge bindings to only expose high level API --------- Co-authored-by: Paul Tiedtke <PaulTiedtke@web.de> Co-authored-by: Burkhard Reffeling <burkhard.reffeling@gmail.com> Co-authored-by: António Almeida <theantonioalmeida@gmail.com> Co-authored-by: Jonas Snellinckx <jo.snel@hotmail.com>

feat: make renderer state initialization synchronous by default

3725089

Implements #278

matmalkowski added enhancement ✨ v2 All issues related to v2 hacktoberfest-accepted labels Oct 31, 2020

matmalkowski added this to the 2.0 milestone Oct 31, 2020

matmalkowski requested review from hardchor and victorhqc October 31, 2020 18:53

matmalkowski self-assigned this Oct 31, 2020

matmalkowski linked an issue Oct 31, 2020 that may be closed by this pull request

Renderer process store should be initialized in a synchronous matter to keep the backward compatibility #278

Closed

sapkra reviewed Oct 31, 2020

View reviewed changes

src/constants/index.ts Outdated Show resolved Hide resolved

sapkra reviewed Oct 31, 2020

View reviewed changes

src/options/RendererStateSyncEnhancerOptions.ts Outdated Show resolved Hide resolved

code review comments

a011752

sapkra reviewed Oct 31, 2020

View reviewed changes

hardchor reviewed Nov 9, 2020

View reviewed changes

src/fetchState/fetchInitialStateAsync.ts Outdated Show resolved Hide resolved

hardchor reviewed Nov 9, 2020

View reviewed changes

src/options/RendererStateSyncEnhancerOptions.ts Outdated Show resolved Hide resolved

hardchor reviewed Nov 9, 2020

View reviewed changes

src/options/RendererStateSyncEnhancerOptions.ts Outdated Show resolved Hide resolved

matmalkowski and others added 2 commits November 16, 2020 09:52

chore: spelling

a2a4c0c

Co-authored-by: Burkhard Reffeling <burkhard.reffeling@gmail.com>

chore: code review comments

470262d

matmalkowski requested a review from hardchor November 16, 2020 09:24

Merge branch 'alpha' into sync-init

2c846f5

hardchor approved these changes Nov 27, 2020

View reviewed changes

matmalkowski merged commit 09017fe into alpha Nov 27, 2020

matmalkowski deleted the sync-init branch November 27, 2020 10:42

matmalkowski mentioned this pull request Nov 27, 2020

Renderer process store should be initialized in a synchronous matter to keep the backward compatibility #278

Closed

matmalkowski added the released on @alpha label Nov 27, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: make renderer state initialization synchronous by default #280

feat: make renderer state initialization synchronous by default #280

matmalkowski commented Oct 31, 2020

matmalkowski commented Oct 31, 2020

sapkra Oct 31, 2020

matmalkowski Oct 31, 2020

sapkra Oct 31, 2020

sapkra Oct 31, 2020

matmalkowski Oct 31, 2020

hardchor left a comment

matmalkowski commented Nov 27, 2020

feat: make renderer state initialization synchronous by default #280

feat: make renderer state initialization synchronous by default #280

Conversation

matmalkowski commented Oct 31, 2020

matmalkowski commented Oct 31, 2020

sapkra Oct 31, 2020

Choose a reason for hiding this comment

matmalkowski Oct 31, 2020

Choose a reason for hiding this comment

sapkra Oct 31, 2020

Choose a reason for hiding this comment

sapkra Oct 31, 2020

Choose a reason for hiding this comment

matmalkowski Oct 31, 2020

Choose a reason for hiding this comment

hardchor left a comment

Choose a reason for hiding this comment

matmalkowski commented Nov 27, 2020