Created import/export tab #3146

bertomoore · 2019-07-24T11:35:33Z

Description

Import option allows the user to select the boostnote.config file that contains their preferences.
Export option allows the user to select a directory that will hold their boostnote.config file.

Issue fixed

Issue #3114

Type of changes

⚪ Bug fix (Change that fixed an issue)
⚪ Breaking change (Change that can cause existing functionality to change)
⚪ Improvement (Change that improves the code. Maybe performance or development improvement)
🔘 Feature (Change that adds new functionality)
⚪ Documentation change (Change that modifies the documentation. Maybe typo fixes)

Checklist:

🔘 My code follows the project code style
🔘 I have written test for my code and it has been tested
🔘 All existing tests have been passed
🔘 I have attached a screenshot/video to visualize my change if possible

IssueHunt Summary

Referenced issues

This pull request has been submitted to:

#3114: Export and import preferences

IssueHunt has been backed by the following sponsors. Become a sponsor

ZeroX-DG

Can you allow user to choose a different file name other than boostnote.config? After all, it's just importing and exporting, the config file is still in the system, only the content changed. Thank you for your contribution 👍

ZeroX-DG · 2019-08-15T22:48:37Z

browser/main/modals/PreferencesModal/index.js

@@ -133,7 +142,8 @@ class Preferences extends React.Component {
      {target: 'INFO', label: i18n.__('About')},
      {target: 'CROWDFUNDING', label: i18n.__('Crowdfunding')},
      {target: 'BLOG', label: i18n.__('Blog'), Blog: this.state.BlogAlert},
-      {target: 'SNIPPET', label: i18n.__('Snippets')}
+      {target: 'SNIPPET', label: i18n.__('Snippets')},
+      {target: 'IMPEXP', label: i18n.__('Import/Export'), ImpExp: this.state.ImpExpAlert}


I think Import/Export is not a very suitable name, because in this case we only export config and nothing else. Do you have any idea for another name?

Maybe 'Backup Config', 'Backup Settings', or 'Backup Preferences'

bertomoore · 2019-08-16T09:19:57Z

I removed the name check for 'boostnote.config' when importing files since @ZeroX-DG does have a point in saying that any valid file is fine. I placed a check just to make sure a file is chosen or it will give an alert saying the path is empty.

Out of the recommendations made by @Flexo013 I went with 'Backup Config' for the tab name; my first choice was 'Backup Preferences' but it turned out to be a bit too long in practice. The actual page title is now 'Backup Configuration'.

The titles for the fields now say 'Select Backup File' and 'Create Backup File' respectively. I kept 'Import' and 'Export' for the buttons since they seemed appropriate.

I changed the source code naming to 'backup' except for the instances where 'import' and 'export' were still more appropriate like the file path variables.

Let me know if there are other changes I should make to this PR. Thank you!

ZeroX-DG

Please update your code. (I accidentally approve your code sorry 😢 )

ZeroX-DG · 2019-08-23T12:05:24Z

browser/main/modals/PreferencesModal/BackupTab.js

+    try {
+      const externalConfig = JSON.parse(fs.readFileSync(this.state.newImport.path, 'utf-8'))
+      const { config } = this.state
+      config.hotkey = externalConfig.hotkey


Can you add a inner try catch here to validate the config too? Because otherwise the error message will be File is not valid JSON. which will confuse the user.

ZeroX-DG · 2019-08-23T12:08:46Z

browser/main/modals/PreferencesModal/BackupTab.js

+      `${this.state.newExport.path}/boostnote.config`,
+      JSON.stringify(this.state.config), (err) => {
+        if (err) {
+          return console.log(err)


How about adding some kind of way to notice the user when saving is successful or failed? Because otherwise a think called Gulf of evaluation will happens.

ZeroX-DG · 2020-02-13T23:33:15Z

@bertomoore ping

ZeroX-DG · 2020-02-24T22:29:39Z

Close due to inactivity

bertomoore · 2020-02-29T21:43:38Z

I'm very sorry for the lack of response! I can have the changes up by March 9th if you would like to reopen the PR.

ZeroX-DG · 2020-03-22T02:55:24Z

@bertomoore are you still interested in this PR?

bertomoore · 2020-03-22T03:34:44Z

@ZeroX-DG yes! Sorry I've been very distracted, but I'll work on this PR immediately

bertomoore · 2020-03-29T07:11:16Z

I have updated the error message in the import to check if the error is related to a syntax error, which is the exception thrown by JSON.parse. If this may still conflict with validating the config, I'm happy to change the method of error checking. I also added an alert box whenever "boostnote.config" file is exported successfully. I appreciate your patience and look forward to hearing from you.

ZeroX-DG

Can you change your code a bit please @bertomoore

ZeroX-DG · 2020-04-24T09:40:55Z

browser/main/modals/PreferencesModal/BackupTab.js

+                <input styleName='backup-body-section-path-input'
+                  ref='newImportPath'
+                  placeholder={i18n.__('Select File')}
+                  value={this.state.newImport.path}


Can you add readOnly to the input to remove the React warning please?

ZeroX-DG · 2020-04-24T09:41:02Z

browser/main/modals/PreferencesModal/BackupTab.js

+              <div styleName='backup-body-section-path'>
+                <input styleName='backup-body-section-path-input'
+                  ref='newExportPath'
+                  placeholder={i18n.__('Select Folder')}


Can you add readOnly to the input to remove the React warning please?

ZeroX-DG · 2020-04-24T09:43:55Z

browser/main/modals/PreferencesModal/BackupTab.styl

+      border-color get-theme-var(theme, 'borderColor')
+
+    .backup-button-control
+      background-color get-theme-var(theme, 'button-backgroundColor')


For some reason, the variable button-backgroundColor doesn't exist in dark theme. Can you fix this too? thank you 👍

… color issue in dark theme

bertomoore · 2020-04-26T12:34:37Z

Hello, I added the 'readonly' attributes to the input fields and fixed the issue with the dark button background not present. Let me know if there's anything else I can do. :)

ZeroX-DG · 2020-04-27T01:32:13Z

@bertomoore seem like the eslint is failling? Can you check if this is on your side or is the Travis broken again?

bertomoore · 2020-04-30T10:44:02Z

Sorry about that, I fixed the errors found on the lint now!

ZeroX-DG

Can you fix your code with my suggestions? And can you add translation for those label?

browser/main/modals/PreferencesModal/BackupTab.js

Co-authored-by: Nguyen Viet Hung <viethungax@gmail.com>

ZeroX-DG · 2020-05-11T03:13:12Z

@bertomoore can you add translations for those labels?/ :+1:

bertomoore · 2020-05-11T06:57:53Z

Yes! I will have it up within the next 24 hours 👍🏽

ZeroX-DG

Just some tiny requests before I can approve this PR 😄

ZeroX-DG · 2020-05-12T01:43:41Z

browser/main/modals/PreferencesModal/BackupTab.js

+      this.setState({
+        BackupAlert: {
+          type: 'success',
+          message: i18n.__('Successfully applied!')


I think you miss the translation for this one

ZeroX-DG · 2020-05-12T01:45:31Z

browser/main/modals/PreferencesModal/BackupTab.js

+
+  exportConfig(e) {
+    if (this.state.newExport.path === '') {
+      alert(i18n.__('Please choose a directory for export file.'))


Can you add translation for this one too?

ZeroX-DG · 2020-05-12T01:45:46Z

browser/main/modals/PreferencesModal/BackupTab.js

+        i18n.__(
+          err instanceof SyntaxError
+            ? 'File is not valid JSON.'
+            : 'Something went wrong. Please try again'


Can you add translation for this too?

ZeroX-DG · 2020-05-12T01:46:15Z

browser/main/modals/PreferencesModal/BackupTab.js

+      JSON.stringify(this.state.config),
+      err => {
+        if (err) {
+          alert(i18n.__('Export failed. Please try again'))


Can you add translation for this?

ZeroX-DG · 2020-05-12T01:46:35Z

browser/main/modals/PreferencesModal/BackupTab.js

+    return (
+      <div styleName='root'>
+        <div styleName='group'>
+          <div styleName='group-header'>{i18n.__('Backup Configuration')}</div>


Can you add translation for this one too?

bertomoore · 2020-05-12T04:14:40Z

Sorry about overlooking those! I'll fix it now. :)

ZeroX-DG

LGTM 🎉

Rokt33r · 2020-07-20T11:05:48Z

@bertomoore I tried it but I think we need to improve its UI more. Rather than having file inputs, we can just put buttons and use electron's file save/open dialog. https://www.electronjs.org/docs/api/dialog

Created import/export tab

8d2e6d2

ZeroX-DG added needs extra review 🔎 Pull request requires review from an additional reviewer. awaiting review ❇️ Pull request is awaiting a review. and removed needs extra review 🔎 Pull request requires review from an additional reviewer. labels Jul 26, 2019

bertomoore added 2 commits July 26, 2019 18:19

Added ImpExpTab js and styl file

c4d822b

Style guideline corrections

ff66f97

Flexo013 mentioned this pull request Jul 28, 2019

Allow for syncing of Preferences #1339

Open

bertomoore added 2 commits August 14, 2019 00:53

Added error if import file is invalid JSON file

84acdec

Added error if import file is invalid JSON file

8914f7e

ZeroX-DG reviewed Aug 15, 2019

View reviewed changes

ZeroX-DG added awaiting changes 🖊️ Pull request has been reviewed, but contributor needs to make changes. and removed awaiting review ❇️ Pull request is awaiting a review. labels Aug 15, 2019

bertomoore added 2 commits August 16, 2019 02:49

Updated naming conventions, removed 'boost.config' name check

a177a3f

Renamed files

54f1778

Flexo013 added awaiting review ❇️ Pull request is awaiting a review. and removed awaiting changes 🖊️ Pull request has been reviewed, but contributor needs to make changes. labels Aug 16, 2019

ZeroX-DG approved these changes Aug 23, 2019

View reviewed changes

ZeroX-DG added awaiting changes 🖊️ Pull request has been reviewed, but contributor needs to make changes. and removed awaiting review ❇️ Pull request is awaiting a review. labels Aug 23, 2019

ZeroX-DG closed this Feb 24, 2020

Flexo013 reopened this Mar 1, 2020

bertomoore added 2 commits March 29, 2020 00:58

Updated error alert for import and added alert for successful export

7f3a1fc

Placed successful export alert in writeFile callback

fc8c6de

ZeroX-DG requested changes Apr 24, 2020

View reviewed changes

Added readonly attribute to backup tab input fields. Corrected button…

bc9d3a4

… color issue in dark theme

Fixed lint errors

fee1b64

ZeroX-DG requested changes May 1, 2020

View reviewed changes

browser/main/modals/PreferencesModal/BackupTab.js Outdated Show resolved Hide resolved

browser/main/modals/PreferencesModal/BackupTab.js Outdated Show resolved Hide resolved

ZeroX-DG reviewed May 1, 2020

View reviewed changes

browser/main/modals/PreferencesModal/BackupTab.js Outdated Show resolved Hide resolved

bertomoore and others added 3 commits May 6, 2020 23:11

Update browser/main/modals/PreferencesModal/BackupTab.js

6d6572e

Co-authored-by: Nguyen Viet Hung <viethungax@gmail.com>

Update browser/main/modals/PreferencesModal/BackupTab.js

f0fa26a

Co-authored-by: Nguyen Viet Hung <viethungax@gmail.com>

Update browser/main/modals/PreferencesModal/BackupTab.js

387f194

Co-authored-by: Nguyen Viet Hung <viethungax@gmail.com>

Added translations to Export Config phrases

69419c9

ZeroX-DG requested changes May 12, 2020

View reviewed changes

Added missing translations for Backup Config tab

dffba4c

ZeroX-DG approved these changes May 19, 2020

View reviewed changes

ZeroX-DG added approved 👍 Pull request has been approved by sufficient reviewers. and removed awaiting changes 🖊️ Pull request has been reviewed, but contributor needs to make changes. labels May 19, 2020

daiyam mentioned this pull request Jun 12, 2020

improve export #2612

Merged

Merge branch 'master' into export-preferences

1cbacd5

Rokt33r added this to the v0.16.0 milestone Jul 20, 2020

Fix compile error

8378a2b

Rokt33r added awaiting changes 🖊️ Pull request has been reviewed, but contributor needs to make changes. and removed approved 👍 Pull request has been approved by sufficient reviewers. labels Jul 20, 2020

Rokt33r self-requested a review July 20, 2020 11:06

Rokt33r modified the milestones: v0.16.0, v0.17.0 Jul 20, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Created import/export tab #3146

Created import/export tab #3146

bertomoore commented Jul 24, 2019 •

edited by issuehunt-oss bot

ZeroX-DG left a comment

ZeroX-DG Aug 15, 2019

Flexo013 Aug 15, 2019

bertomoore commented Aug 16, 2019

ZeroX-DG left a comment •

edited

ZeroX-DG Aug 23, 2019

ZeroX-DG Aug 23, 2019

ZeroX-DG commented Feb 13, 2020

ZeroX-DG commented Feb 24, 2020

bertomoore commented Feb 29, 2020

ZeroX-DG commented Mar 22, 2020

bertomoore commented Mar 22, 2020

bertomoore commented Mar 29, 2020

ZeroX-DG left a comment

ZeroX-DG Apr 24, 2020

ZeroX-DG Apr 24, 2020

ZeroX-DG Apr 24, 2020

bertomoore commented Apr 26, 2020

ZeroX-DG commented Apr 27, 2020

bertomoore commented Apr 30, 2020

ZeroX-DG left a comment

ZeroX-DG commented May 11, 2020

bertomoore commented May 11, 2020

ZeroX-DG left a comment

ZeroX-DG May 12, 2020

ZeroX-DG May 12, 2020

ZeroX-DG May 12, 2020

ZeroX-DG May 12, 2020

ZeroX-DG May 12, 2020

bertomoore commented May 12, 2020

ZeroX-DG left a comment

Rokt33r commented Jul 20, 2020

Created import/export tab #3146

Are you sure you want to change the base?

Created import/export tab #3146

Conversation

bertomoore commented Jul 24, 2019 • edited by issuehunt-oss bot

Description

Issue fixed

Type of changes

Checklist:

Referenced issues

ZeroX-DG left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bertomoore commented Aug 16, 2019

ZeroX-DG left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ZeroX-DG commented Feb 13, 2020

ZeroX-DG commented Feb 24, 2020

bertomoore commented Feb 29, 2020

ZeroX-DG commented Mar 22, 2020

bertomoore commented Mar 22, 2020

bertomoore commented Mar 29, 2020

ZeroX-DG left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bertomoore commented Apr 26, 2020

ZeroX-DG commented Apr 27, 2020

bertomoore commented Apr 30, 2020

ZeroX-DG left a comment

Choose a reason for hiding this comment

ZeroX-DG commented May 11, 2020

bertomoore commented May 11, 2020

ZeroX-DG left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bertomoore commented May 12, 2020

ZeroX-DG left a comment

Choose a reason for hiding this comment

Rokt33r commented Jul 20, 2020

bertomoore commented Jul 24, 2019 •

edited by issuehunt-oss bot

ZeroX-DG left a comment •

edited