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

provide seamless migration for existing users to upcoming major version #78

Open
1 of 2 tasks
abhijithvijayan opened this issue Feb 7, 2020 · 2 comments
Open
1 of 2 tasks
Labels
breaking change release: minor status: on hold Hold this for a while topic: ux Issues and PRs related to the user experience type: maintenance An issue or pull request describing a change that isn't a bug, feature or documentation change

Comments

@abhijithvijayan
Copy link
Member

abhijithvijayan commented Feb 7, 2020

  • Set up a function to update extension settings (from browser local storage)
    to the new settings keys
    Map the keys like autoCopy : true to the new
"settings": {
   "autocopy": true,
   ...
}

on the installation / initialization of new major version.

  • Remove this feature after all the users have switched to the new major version

Without this mapping, the extension will UX issues for those who are using it currently.

@abhijithvijayan abhijithvijayan added breaking change effort: med up to a week topic: ux Issues and PRs related to the user experience type: maintenance An issue or pull request describing a change that isn't a bug, feature or documentation change labels Feb 7, 2020
@abhijithvijayan
Copy link
Member Author

abhijithvijayan commented Mar 9, 2020

Current fields in local storage of almost all users

{
	"URL_array": [],
	"host": "https://google.com",
	"key": "this is the api key",
	"pwd": "password",
	"userOptions": {
		"autoCopy": true,
		"devMode": true,
		"keepHistory": true,
		"pwdForUrls": true
	}
}

Migrate to

{
	"settings": {
		"advanced": true,
		"apikey": "he;;obaby",
		"customhost": "https://google.com",
		"history": false
	}
}

@abhijithvijayan abhijithvijayan added the status: WIP Work in progress ... inputs welcome! ❤️ label Mar 9, 2020
@abhijithvijayan abhijithvijayan added release: minor status: on hold Hold this for a while and removed effort: med up to a week status: WIP Work in progress ... inputs welcome! ❤️ labels Mar 9, 2020
@abhijithvijayan
Copy link
Member Author

Migration actions are performed once on popup open(once extension is updated to v4.x.x) if previous keys exist on browser local storage.

The code can be removed once all the users receive the update.
I have tested with basic options enabled as well as advanced options(like custom host) enabled. It works. :)

I will leave this issue open if someone runs into issue on migration.

@abhijithvijayan abhijithvijayan pinned this issue Mar 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change release: minor status: on hold Hold this for a while topic: ux Issues and PRs related to the user experience type: maintenance An issue or pull request describing a change that isn't a bug, feature or documentation change
Projects
None yet
Development

No branches or pull requests

1 participant