feat: migrate to typescript #259

matmalkowski · 2020-09-17T20:39:55Z

This is initial Pull Request with the goal of having brand new, simplified API & native TS support. The change contains few main areas:

I've used the code from @partheseas fork as suggested, with some clean up in the structure
I've re-did the build system to fit TS package management - using rollup to build the bundle
Repo structure has been changed - we don't need monorepo for the 2 projects here, and it would only mean pain in the release process, considering the e2e package was private and without dependencies
I've started with some basic e2e test of the current implementation: simple main & render thread stores synced together and the counter component that updates visuals on both render & main
Added typescript types compatibility test agains basic redux usage. We also should consider extending it with applyMiddleware and other usages that might be breaking.
And ofc GH action to build & test it all so far.

Target branch of this PR is v2 - follow up PRs would setup the semantic-release to help with the deployment process and the v2 branch would be considered an alpha version.

The code itself from my look at it is still rough on the edges and needs some work, I've even added some TODO: comments in the most obvious places, but overall I believe the goal should to be to polish it on the v2 branch with incremental refactors/fixes/tests.

This is WIP

package.json

matmalkowski · 2020-09-23T12:20:55Z

src/syncMain.ts

+		// Stringify the current state, and freeze it to preserve certain types
+		// that you might want to use in your state, but aren't JSON serializable
+		// by default.
+		return JSON.stringify(store.getState(), freeze);


Actually I don't like idea of having this by default baked into the lib - it goes kinda against the redux recommendations itself:

It is highly recommended that you only put plain serializable objects, arrays, and primitives into your store.

I would like to extract this and make it configurable so users when using the middleware can configure it with their own serializer at their own risk (and we ofc can provide them with example serializer used here 👍🏻 )

matmalkowski · 2020-09-23T12:23:15Z

src/syncRenderer.ts

+
+	return (reducer, state) => {
+		const store = createStore(
+			wrapReducer(reducer as any), // TODO: this needs some ❤️


This cast needs some work like mentioned in the comment

matmalkowski · 2020-09-23T12:23:39Z

src/syncRenderer.ts

+			store.dispatch(replaceState(state));
+		});
+
+		// TODO: this needs some ❤️


And this magic TS fix is another thing that needs to get looked at

matmalkowski · 2020-09-23T12:24:47Z

src/utils/actions.ts

+import { FluxStandardAction, isFSA } from "flux-standard-action";
+
+// Certain actions that we should never replay across stores
+const blacklist = [/^@@/, /^redux-form/];


also seems something that we might consider configurable in the future (but maybe not now)

sameoldmadness

LGTM 👍

victorhqc

Thanks for the PR, the code looks good to me. There are things that probably need more discussion about namings probably, and documentation, specially a migration guide if we're planning to introduce breaking changes in API.

Tried to run in a project but the current implementation doesn't work with middlewares, so this could probably be worked on in the next PR.

matmalkowski · 2020-10-19T09:21:30Z

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

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: migrate to typescript

a3de5f7

This is WIP

matmalkowski marked this pull request as draft September 17, 2020 20:40

matmalkowski added 8 commits September 17, 2020 22:51

feat: package.json cleanup

8c2236b

chore: remove eslint config rules

bac5184

chore: more cleaning

a1a159b

chore: add tsc tests

1ef84ff

chore: reorganize export structure

06760b7

chore: add some basic e2e tests

ef966e7

buid: add GH action for PR

9767eab

fix: e2e test memory leak fix

e8ae687

matmalkowski marked this pull request as ready for review September 19, 2020 20:22

matmalkowski added the v2 All issues related to v2 label Sep 19, 2020

matmalkowski requested review from hardchor, victorhqc and sameoldmadness September 19, 2020 20:23

chore: vscode workspace settings

e9742b8

matmalkowski added this to the 2.0 milestone Sep 20, 2020

hardchor reviewed Sep 22, 2020

View reviewed changes

package.json Outdated Show resolved Hide resolved

matmalkowski added 2 commits September 22, 2020 15:04

fix: update username in package.json

a7b9e48

chore: rollup.config simplify

9533de7

matmalkowski commented Sep 23, 2020

View reviewed changes

sameoldmadness approved these changes Sep 28, 2020

View reviewed changes

victorhqc approved these changes Sep 28, 2020

View reviewed changes

matmalkowski merged commit 24b65b5 into v2 Sep 28, 2020

matmalkowski deleted the v2-typescript-rewrite branch September 28, 2020 14:21

matmalkowski mentioned this pull request Sep 29, 2020

Take a look at Typescript types issues as seen in #259 #262

Closed

matmalkowski added the released on @alpha label Oct 19, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: migrate to typescript #259

feat: migrate to typescript #259

matmalkowski commented Sep 17, 2020 •

edited

Loading

matmalkowski Sep 23, 2020 •

edited

Loading

matmalkowski Sep 23, 2020

matmalkowski Sep 23, 2020

matmalkowski Sep 23, 2020

sameoldmadness left a comment

victorhqc left a comment

matmalkowski commented Oct 19, 2020

feat: migrate to typescript #259

feat: migrate to typescript #259

Conversation

matmalkowski commented Sep 17, 2020 • edited Loading

matmalkowski Sep 23, 2020 • edited Loading

Choose a reason for hiding this comment

matmalkowski Sep 23, 2020

Choose a reason for hiding this comment

matmalkowski Sep 23, 2020

Choose a reason for hiding this comment

matmalkowski Sep 23, 2020

Choose a reason for hiding this comment

sameoldmadness left a comment

Choose a reason for hiding this comment

victorhqc left a comment

Choose a reason for hiding this comment

matmalkowski commented Oct 19, 2020

matmalkowski commented Sep 17, 2020 •

edited

Loading

matmalkowski Sep 23, 2020 •

edited

Loading