Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: use contextBridge in favour of requiring nodeIntegration #300

Merged
merged 4 commits into from
Jun 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions examples/basic/src/main/index.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import url from 'url'
import { app, BrowserWindow } from 'electron'
import { stateSyncEnhancer } from 'electron-redux'
import { stateSyncEnhancer } from 'electron-redux/main'
import { createStore } from 'redux'
import { rootReducer } from '../store'

const TESTING = process.env.SPECTRON === 'true'
// ==================================================================
// electron related boiler-plate to create window with singe renderer
let mainWindow: BrowserWindow | null
Expand All @@ -13,7 +14,11 @@ async function createWindow() {
width: 800,
height: 600,
webPreferences: {
nodeIntegration: true,
preload: `${__dirname}/preload.js`,
// PROD app should be running with contextIsolation: true for security reasons. Disabled only while running e2e tests
matmalkowski marked this conversation as resolved.
Show resolved Hide resolved
contextIsolation: !TESTING,
// ONLY TRUE FOR TESTING - SPECTRON needs node integration to be able to access the remote modules.
nodeIntegration: TESTING,
},
})
await mainWindow.loadURL(
Expand Down
2 changes: 1 addition & 1 deletion examples/basic/src/renderer/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import { createStore } from 'redux'
import { rootReducer } from '../store'
import { stateSyncEnhancer } from 'electron-redux'
import { stateSyncEnhancer } from 'electron-redux/renderer'
import {
decrementGlobalCounter,
decrementLocalCounter,
Expand Down
2 changes: 2 additions & 0 deletions examples/basic/src/renderer/preload.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// Include me in your preload script!
require('electron-redux/preload')
1 change: 1 addition & 0 deletions examples/basic/webpack.renderer.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ module.exports = {
mode: 'production',
entry: {
renderer: './src/renderer/index.ts',
preload: './src/renderer/preload.ts',
},
target: 'electron-renderer',
plugins: [
Expand Down
6 changes: 6 additions & 0 deletions main/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"internal": true,
"main": "../lib/main.js",
"module": "../es/main.js",
"types": "../types/main.d.ts"
}
10 changes: 6 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,16 @@
],
"license": "MIT",
"private": false,
"main": "lib/electron-redux.js",
"module": "es/electron-redux.js",
"main": "lib/index.js",
"module": "es/index.js",
"types": "types/index.d.ts",
"files": [
"lib",
"es",
"types"
"types",
"main",
"renderer",
"preload"
],
"scripts": {
"clean": "rimraf lib es coverage types",
Expand Down Expand Up @@ -48,7 +51,6 @@
"@babel/preset-env": "^7.11.5",
"@babel/preset-typescript": "^7.10.4",
"@rollup/plugin-commonjs": "^15.0.0",
"@rollup/plugin-node-resolve": "^9.0.0",
"@types/jest": "^26.0.14",
"@types/lodash.isplainobject": "^4.0.6",
"@types/lodash.isstring": "^4.0.6",
Expand Down
6 changes: 6 additions & 0 deletions preload/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"internal": true,
"main": "../lib/preload.js",
"module": "../es/preload.js",
"types": "../types/preload.d.ts"
}
6 changes: 6 additions & 0 deletions renderer/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"internal": true,
"main": "../lib/renderer.js",
"module": "../es/renderer.js",
"types": "../types/renderer.d.ts"
}
45 changes: 16 additions & 29 deletions rollup.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import nodeResolve from '@rollup/plugin-node-resolve'
import babel from 'rollup-plugin-babel'
import commonjs from '@rollup/plugin-commonjs'
import typescript from 'rollup-plugin-typescript2'
Expand All @@ -7,38 +6,26 @@ import pkg from './package.json'

const extensions = ['.ts']

const basePlugins = [
commonjs(),
nodeResolve({
extensions,
}),
typescript({ useTsconfigDeclarationDir: true }),
]
const basePlugins = [commonjs(), typescript({ useTsconfigDeclarationDir: true })]

const baseConfig = {
external: Object.keys(pkg.peerDependencies || {}),
plugins: [
...basePlugins,
babel({
extensions,
}),
],
}

export default [
// CommonJS
{
input: 'src/index.ts',
output: { file: 'lib/electron-redux.js', format: 'cjs', indent: false },
external: Object.keys(pkg.peerDependencies || {}),
plugins: [
...basePlugins,
babel({
extensions,
}),
],
},

// ES
{
input: 'src/index.ts',
output: { file: 'es/electron-redux.js', format: 'es', indent: false },
external: Object.keys(pkg.peerDependencies || {}),
plugins: [
...basePlugins,
babel({
extensions,
}),
...baseConfig,
input: ['src/index.ts', 'src/main.ts', 'src/renderer.ts', 'src/preload.ts'],
output: [
{ dir: 'lib', format: 'cjs' },
{ dir: 'es', format: 'es' },
],
},
]
57 changes: 32 additions & 25 deletions src/composeWithStateSync.ts
Original file line number Diff line number Diff line change
@@ -1,44 +1,51 @@
/* eslint-disable @typescript-eslint/ban-types */

import { StoreEnhancer } from 'redux'
import { forwardAction } from './forwardAction'
import { forwardAction, ProcessForwarder } from './utils/forwardAction'
import { StateSyncOptions } from './options/StateSyncOptions'
import { stateSyncEnhancer } from './stateSyncEnhancer'
import { StateSyncEnhancer } from './utils/types'

const forwardActionEnhancer = (options?: StateSyncOptions): StoreEnhancer => (createStore) => (
reducer,
preloadedState
) => {
const forwardActionEnhancer = (
processForwarder: ProcessForwarder,
options?: StateSyncOptions
): StoreEnhancer => (createStore) => (reducer, preloadedState) => {
const store = createStore(reducer, preloadedState)

return forwardAction(store, options)
return forwardAction(store, processForwarder, options)
}

const extensionCompose = (options: StateSyncOptions) => (
...funcs: StoreEnhancer[]
): StoreEnhancer => {
const extensionCompose = (
stateSyncEnhancer: StateSyncEnhancer,
processForwarder: ProcessForwarder,
options: StateSyncOptions
) => (...funcs: StoreEnhancer[]): StoreEnhancer => {
return (createStore) => {
return [
stateSyncEnhancer({ ...options, preventActionReplay: true }),
...funcs,
forwardActionEnhancer(options),
forwardActionEnhancer(processForwarder, options),
].reduceRight((composed, f) => f(composed), createStore)
}
}

export function composeWithStateSync(
options: StateSyncOptions
): (...funcs: Function[]) => StoreEnhancer
export function composeWithStateSync(...funcs: StoreEnhancer[]): StoreEnhancer
export function composeWithStateSync(
firstFuncOrOpts: StoreEnhancer | StateSyncOptions,
...funcs: StoreEnhancer[]
): StoreEnhancer | ((...funcs: StoreEnhancer[]) => StoreEnhancer) {
if (arguments.length === 0) {
return stateSyncEnhancer()
}
if (arguments.length === 1 && typeof firstFuncOrOpts === 'object') {
return extensionCompose(firstFuncOrOpts)
export function createComposer(
stateSyncEnhancer: StateSyncEnhancer,
processForwarder: ProcessForwarder
) {
return function composeWithStateSync(
firstFuncOrOpts: StoreEnhancer | StateSyncOptions,
...funcs: Array<StoreEnhancer>
): StoreEnhancer {
if (arguments.length === 0) {
return stateSyncEnhancer({})
}
if (arguments.length === 1 && typeof firstFuncOrOpts === 'object') {
return extensionCompose(stateSyncEnhancer, processForwarder, firstFuncOrOpts)()
}
return extensionCompose(
stateSyncEnhancer,
processForwarder,
{}
)(firstFuncOrOpts as StoreEnhancer, ...funcs)
}
return extensionCompose({})(firstFuncOrOpts as StoreEnhancer, ...funcs)
}
4 changes: 0 additions & 4 deletions src/fetchState/index.ts

This file was deleted.

51 changes: 0 additions & 51 deletions src/forwardAction.ts

This file was deleted.

14 changes: 2 additions & 12 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
import { mainStateSyncEnhancer } from './mainStateSyncEnhancer'
import { stopForwarding } from './utils'
import { rendererStateSyncEnhancer } from './rendererStateSyncEnhancer'
import { stateSyncEnhancer } from './stateSyncEnhancer'
import { composeWithStateSync } from './composeWithStateSync'
import { stopForwarding } from './utils/actions'

export {
mainStateSyncEnhancer,
rendererStateSyncEnhancer,
stopForwarding,
stateSyncEnhancer,
composeWithStateSync,
}
export { stopForwarding }
24 changes: 18 additions & 6 deletions src/mainStateSyncEnhancer.ts → src/main.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
import { ipcMain, webContents } from 'electron'
import { Action, StoreEnhancer } from 'redux'
import { IPCEvents } from './constants'
import { forwardAction } from './forwardAction'
import { forwardAction } from './utils/forwardAction'
import { forwardActionToRenderers } from './main/forwardActionToRenderers'
import { MainStateSyncEnhancerOptions } from './options/MainStateSyncEnhancerOptions'
import { stopForwarding } from './utils'
import { preventDoubleInitialization, stopForwarding } from './utils'
import { StateSyncOptions } from './options/StateSyncOptions'
import { createComposer } from './composeWithStateSync'

/**
* Creates new instance of main process redux enhancer.
* @param {MainStateSyncEnhancerOptions} options Additional enhancer options
* @returns StoreEnhancer
*/
export const mainStateSyncEnhancer = (
options: MainStateSyncEnhancerOptions = {}
): StoreEnhancer<any> => (createStore) => {
export const stateSyncEnhancer = (options: MainStateSyncEnhancerOptions = {}): StoreEnhancer => (
createStore
) => {
preventDoubleInitialization()

return (reducer, preloadedState) => {
const store = createStore(reducer, preloadedState)

Expand Down Expand Up @@ -42,6 +47,13 @@ export const mainStateSyncEnhancer = (
})
})

return forwardAction(store, options)
return forwardAction(store, forwardActionToRenderers, options)
}
}

// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
export const composeWithStateSync = (
firstFuncOrOpts: StoreEnhancer | StateSyncOptions,
...funcs: StoreEnhancer[]
): StoreEnhancer =>
createComposer(stateSyncEnhancer, forwardActionToRenderers)(firstFuncOrOpts, ...funcs)
17 changes: 17 additions & 0 deletions src/main/forwardActionToRenderers.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { webContents } from 'electron'
import { IPCEvents } from 'src/constants'
import { MainStateSyncEnhancerOptions } from 'src/options/MainStateSyncEnhancerOptions'
import { validateAction } from 'src/utils'

export const forwardActionToRenderers = <A>(
action: A,
options: MainStateSyncEnhancerOptions = {}
): void => {
if (validateAction(action, options.denyList)) {
webContents.getAllWebContents().forEach((contents) => {
// Ignore chromium devtools
if (contents.getURL().startsWith('devtools://')) return
matmalkowski marked this conversation as resolved.
Show resolved Hide resolved
contents.send(IPCEvents.ACTION, action)
})
}
}
Loading