Added ignoredPaths option #22

MaverickMartyn · 2019-01-31T10:34:58Z

I added an option to supply an array of state paths to not persist.
This includes a unit test.
It simply works by cloning the state object, and deleting any properties that should not be persisted.
It then persists the modified clone instead,

I think this is my first actual pull request, so I hope it lives up to everyone's expectations.
Please let me know if something isn't working.

Update to v1.0.3

Stormtv · 2019-02-04T23:34:17Z

@MaverickMartyn I played around with the changes in my local fork and everything seems to be working great. I'd recommend @MrEmelianenko to pull this in.

I think getting rid of the blacklist and whitelist might be a good idea since this solves their use cases. Also it is very dangerous to have bugs such as #19 when working with secure applications.

MaverickMartyn · 2019-02-07T22:30:15Z

@Stormtv I agree that blacklist/whitelists should probably be removed, but I want o note this:
This PR does NOT solve all use cases of the blacklist and whitelist.
We could add an "inverted" option to cover the whitelist part, but one thing to note is that the store is still saved upon each commit, even if no "to-be-persisted"-data actually changes.
For example, in an app I am working on, I use the store to store the current playback time for a video.
This changes very often, and persisting the store on each commit, can cause IO issues.

Using the blacklist in combination with this, however works great.
I am thinking, maybe rename these things and redefine their purposes?

Maybe with an options structure like this:

{
    // Ignores specific paths on the state object, when persisting.
    ignoredPaths: ['test.testy', 'testy2.moretesty'],
    // Blocks commits from triggering a persistence update.
    ignoredCommits: ['TESTCOMMIT', 'ANOTHERCOMMIT'],
    // Changes the behavior from blacklist-like to whitelist-like. Default to false. Maybe another name?
    invertIgnored: true,
}

EDIT: Changed my proposal, to no longer suggest throwing an error, if inverting without supplying any of the other suggested params.

EDIT 2:
I now have a local test with all of this implemented, with unit tests as well.
It passes both the existing and my newly added unit tests at the moment.
Let me know if you want to take a look at it, and I'll update my master branch. :)

EDIT 3:
Pushed the changes mentioned in edit 2.

MaverickMartyn · 2019-02-18T00:35:13Z

@MrEmelianenko @Stormtv Bump?

NoelDavies · 2019-02-22T19:59:09Z

@MaverickMartyn can you just return early? the else if's aren't needed and:

Cause the codeclimate CI test to fail
Add to cyclomatic complexity
Add code smell

If you remove the else if's with just if's, it'll be nice :)

NoelDavies · 2019-02-22T23:53:23Z

@MaverickMartyn This is also a breaking change for some people, you'd need to keep the remaining functionality in there, and also you need to update the docs for your PR :)

MaverickMartyn · 2019-02-27T12:20:07Z

I just couldn't be asked to fix the Code Climate issue at the time. :)
I'll take a look at it later, and implement your suggestions after I get home.

akodkod · 2019-02-28T14:16:29Z

@MaverickMartyn please fix all issues and I'll merge this into master. Thank you!

MaverickMartyn · 2019-03-03T03:16:00Z

@MrEmelianenko One last minor issue: The bundle size is 2 kB and the file ./dist/persisted-state.js is now 2.17 kB.
I didn't want to change the bundle size limit without asking first, so should I just up the limit to 3?

MaverickMartyn · 2019-03-06T00:04:32Z

@MrEmelianenko I just need to know if I can change the maximum size limit mentioned above.
Other than that, everything is done.

Stormtv · 2019-03-06T18:20:45Z

I personally think changing the max size to 3kB is fine. @MaverickMartyn but it would be nice is @MrEmelianenko would sign off on it :)

Minify the dist files this should make the bundlesize pass

MaverickMartyn · 2019-04-02T15:44:06Z

@Stormtv @MrEmelianenko I just accepted @Stormtv's pull request, which takes care of the bundle size limit. We should be good to go now.
Sorry about the slow response time. Life happens. :)

Stormtv · 2019-04-03T18:25:43Z

@MaverickMartyn @MrEmelianenko Turns out we did not need to increase the bundle size. I just made sure to minify the dist files in the PR which solved bundle size violation.

Stormtv · 2019-04-09T13:42:39Z

@MrEmelianenko Any update on this, would greatly appreciate this being included in vuex-electron.

NoelDavies · 2019-04-16T03:03:44Z

I have a need for this too. The ignore paths saved my bacon, but I'm now relying on a specific commit of the OPs PR

dfranssen · 2019-04-18T08:22:22Z

@MrEmelianenko poke

Stormtv · 2019-04-30T00:24:38Z

@MrEmelianenko Can we get this merged please?

Stormtv · 2019-05-08T00:26:01Z

@MrEmelianenko Are you alive <3

Stormtv · 2019-05-14T15:27:14Z

@MrEmelianenko Are there any issues with this PR?

MaverickMartyn · 2019-06-12T07:39:17Z

@MrEmelianenko Just pinging you again, to make sure you see it. :)

akodkod · 2019-08-29T14:11:20Z

#44

vuex-electron存在很一个严重的问题。即使添加了blacklist，但是在下次非blacklist的commit的时候，还是会把所有的state进行持久化。鉴于vuex-electron已经不做维护，使用 MaverickMartyn/vuex-electron 作为替代 refs: vue-electron/vuex-electron#19 refs: vue-electron/vuex-electron#22 refs: https://github.com/MaverickMartyn/vuex-electron

renaldasrep · 2021-01-19T14:07:43Z

ping, would love to see this merged

liuestc · 2021-02-26T03:16:17Z

hi, my option is

const getMutationList = (mutation) => {
  let arr = [];

  for (const i in mutation) {
    arr.push(i);
  }

  return arr;
};
const DeviceMutationList = getMutationList(Device.mutations);

    createPersistedState({
      invertIgnored: true,
      ignoredCommits: DeviceMutationList,
      ignoredPaths: [
        'Device.currentSelected',
        'Device.deviceList',
        'state.Device.deviceList',
        'deviceList',
        'currentSelected',
      ],
    }),

my state is

{
	"state": {
		"Device": {
			"deviceList": [],
			"currentScanDeviceName": "MockPhoneName",
			"currentReconnectDeviceName": "",
			"showCurrentSelectedDeviceOffLine": false,
			"showDeviceAddingSucceed": true,
			"showDeviceAlreadyExist": false,
			"showDeviceReconnectedFailed": false,
			"showCreateDeviceConnectionFailed": false,
			"showDeviceAdding": false,
			"accountList": []
		},
		"Keyword": {
			"keyword": "",
			"needSearch": false
		},
		"QrCode": {
			"qrCode": {
				"ip": "172.23.73.103",
				"port": 9541,
				"createTime": 1614308688995
			}
		},
		"Setting": {
			"videoQuality": "high",
			"gameMode": false,
			"socketAddress": "ws://127.0.0.1:9541",
			"arsTokenPort": 9544,
			"quality": []
		},
		"Counter": {
			"main": 52
		}
	}
}

I don't want to persite the Device info in file, is there my config option error?
I see the vuex.json file have the Device info, how to i config the option,
Looking forward to your answer
@MrEmelianenko

MaverickMartyn · 2021-03-16T18:01:12Z

hi, my option is

const getMutationList = (mutation) => {
  let arr = [];

  for (const i in mutation) {
    arr.push(i);
  }

  return arr;
};
const DeviceMutationList = getMutationList(Device.mutations);

    createPersistedState({
      invertIgnored: true,
      ignoredCommits: DeviceMutationList,
      ignoredPaths: [
        'Device.currentSelected',
        'Device.deviceList',
        'state.Device.deviceList',
        'deviceList',
        'currentSelected',
      ],
    }),

my state is

{
	"state": {
		"Device": {
			"deviceList": [],
			"currentScanDeviceName": "MockPhoneName",
			"currentReconnectDeviceName": "",
			"showCurrentSelectedDeviceOffLine": false,
			"showDeviceAddingSucceed": true,
			"showDeviceAlreadyExist": false,
			"showDeviceReconnectedFailed": false,
			"showCreateDeviceConnectionFailed": false,
			"showDeviceAdding": false,
			"accountList": []
		},
		"Keyword": {
			"keyword": "",
			"needSearch": false
		},
		"QrCode": {
			"qrCode": {
				"ip": "172.23.73.103",
				"port": 9541,
				"createTime": 1614308688995
			}
		},
		"Setting": {
			"videoQuality": "high",
			"gameMode": false,
			"socketAddress": "ws://127.0.0.1:9541",
			"arsTokenPort": 9544,
			"quality": []
		},
		"Counter": {
			"main": 52
		}
	}
}

I don't want to persite the Device info in file, is there my config option error?
I see the vuex.json file have the Device info, how to i config the option,
Looking forward to your answer
@MrEmelianenko

Hey there guys.

I am fairly sure this repository is no longer being maintained.
I have considered taking over, but I am hard pressed for time at the moment.
While I am unlikely to spend much time maintaining it, feel free to use my fork, if you want.

MaverickMartyn and others added 6 commits January 31, 2019 11:03

Added ignoredPath option.

16c11e2

Added a few comments, and a unit test.

e9779c8

Updated dist files.

167d1de

Merge pull request #1 from vue-electron/master

03cbca3

Update to v1.0.3

Merge branch 'master' into vue-electron#22

0503adb

Merge branch 'vue-electron#22'

cd6c93f

MaverickMartyn added 3 commits February 9, 2019 16:23

Added a launch.json to make working in VS Code a bit nicer.

34dc977

Removed whitelist and blacklist, and added ignoredCommits.

be12856

Added relevant tests for ignoredCommits.

cc7a5a9

NoelDavies mentioned this pull request Feb 23, 2019

Persist partial state #25

Open

MaverickMartyn and others added 3 commits March 1, 2019 23:03

Readded whitelist and blacklist code for compatibility,

863ed84

Added some documentation and comments.

63c467b

Merge branch 'master' into master

b02b2d2

MaverickMartyn added 2 commits March 3, 2019 04:18

Simplified a small bit of code, and updated dist files.

25b83a5

Merge branch 'master' of https://github.com/MaverickMartyn/vuex-electron

1d018d9

NoelDavies approved these changes Mar 6, 2019

View reviewed changes

Stormtv and others added 3 commits March 28, 2019 13:29

Minify The Dist files

79f37c2

Merge remote-tracking branch 'origin/master'

ea5ab57

Merge pull request #3 from Stormtv/master

e6051fa

Minify the dist files this should make the bundlesize pass

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added ignoredPaths option #22

Added ignoredPaths option #22

MaverickMartyn commented Jan 31, 2019

Stormtv commented Feb 4, 2019

MaverickMartyn commented Feb 7, 2019 •

edited

Loading

MaverickMartyn commented Feb 18, 2019

NoelDavies commented Feb 22, 2019

NoelDavies commented Feb 22, 2019

MaverickMartyn commented Feb 27, 2019

akodkod commented Feb 28, 2019

MaverickMartyn commented Mar 3, 2019

MaverickMartyn commented Mar 6, 2019

Stormtv commented Mar 6, 2019

MaverickMartyn commented Apr 2, 2019 •

edited

Loading

Stormtv commented Apr 3, 2019

Stormtv commented Apr 9, 2019

NoelDavies commented Apr 16, 2019

dfranssen commented Apr 18, 2019

Stormtv commented Apr 30, 2019

Stormtv commented May 8, 2019

Stormtv commented May 14, 2019

MaverickMartyn commented Jun 12, 2019

akodkod commented Aug 29, 2019

renaldasrep commented Jan 19, 2021

liuestc commented Feb 26, 2021

MaverickMartyn commented Mar 16, 2021

Added ignoredPaths option #22

Are you sure you want to change the base?

Added ignoredPaths option #22

Conversation

MaverickMartyn commented Jan 31, 2019

Stormtv commented Feb 4, 2019

MaverickMartyn commented Feb 7, 2019 • edited Loading

MaverickMartyn commented Feb 18, 2019

NoelDavies commented Feb 22, 2019

NoelDavies commented Feb 22, 2019

MaverickMartyn commented Feb 27, 2019

akodkod commented Feb 28, 2019

MaverickMartyn commented Mar 3, 2019

MaverickMartyn commented Mar 6, 2019

Stormtv commented Mar 6, 2019

MaverickMartyn commented Apr 2, 2019 • edited Loading

Stormtv commented Apr 3, 2019

Stormtv commented Apr 9, 2019

NoelDavies commented Apr 16, 2019

dfranssen commented Apr 18, 2019

Stormtv commented Apr 30, 2019

Stormtv commented May 8, 2019

Stormtv commented May 14, 2019

MaverickMartyn commented Jun 12, 2019

akodkod commented Aug 29, 2019

renaldasrep commented Jan 19, 2021

liuestc commented Feb 26, 2021

MaverickMartyn commented Mar 16, 2021

MaverickMartyn commented Feb 7, 2019 •

edited

Loading

MaverickMartyn commented Apr 2, 2019 •

edited

Loading