Import/export saved favorites #964

huboneo · 2019-09-02T13:18:32Z

This PR heavily refactors the user favorites implementation, and adds support for importing/exporting saved scripts as a ZIP archive

Key changes

Replaces local user favorites implementation with a new ui kit package @relate-by-ui/saved-scripts (Bugfix saved scripts folder update neo4j-devtools/relate-by-ui#2)
Improves appearance and UX of favorites as per design requests
Updated webpack conf to support symlinked npm packages (for development)
adds ability to import and export user favorites as .zip archive

Unrelated changes

Addresses 2 bugs introduced by :param v2 #962
- Added babel transpilation of node_module as IE does not support lambdas
- Removed duplicate cmd chars in error and disconnected banners

Screenshots

Adding new favorites

Renaming favorites

Exporting favorites

Importing favorites

Running this PR locally

checkout Bugfix saved scripts folder update neo4j-devtools/relate-by-ui#2
yarn install && yarn link in packages/saved-scripts
checkout this PR
-yarn install && yarn link @relate-by-ui/saved-scripts
yarn start

Todo

Add screenshots
Add unit tests for file-drop.utils
Run existing tests once new version of @relate-by-ui/saved-scripts is published

…ated jest.config for lodash-es and react-dnd

- Replaced existing favorites implementation with new components from @relate-by-ui/saved-scripts - Added ability to export and import saved favorites using .zip - Added @relate-by-ui/css for icons and material-ui styles

huboneo · 2019-09-02T13:21:03Z

src/browser/components/FileDrop/FileDrop.jsx

@@ -171,6 +194,10 @@ const mapDispatchToProps = dispatch => {
    saveCypherToFavorites: file => {
      dispatch(addFavorite(file))
    },
+    saveManyFavorites: favorites => {
+      const folders = getFoldersFromFavorites(favorites)
+      console.log('saveManyFavorites', favorites, folders)


oops, this should be calling LOAD_FAVORITES action creator

huboneo · 2019-09-02T13:22:02Z

src/browser/modules/Sidebar/Sidebar.jsx

-        content: AboutDrawer
-      }
-    ]
+function Sidebar (props) {


Since class only had a render() method anyhow...

huboneo · 2019-09-02T13:23:49Z

src/shared/modules/favorites/favoritesDuck.js

@@ -60,7 +65,7 @@ export default function reducer (state = initialState, action) {
      return mergeFavorites(initialState, updatedFavorites)
    case LOAD_FAVORITES:
    case UPDATE_FAVORITES:
-      return mergeFavorites(initialState, action.favorites)
+      return mergeFavorites(action.favorites, state)


I had to change this to ensure favorites got updated. Still not sure how it worked before, or if this is right

Yes, this is strange.

oskarhane

I like the new looks of the favorites sidebar.
And I love that I can rename them from the UI now!

The syncing seems to be working perfectly, well done on that part.

A few things that should be addressed before this goes in (apart from eventual inline comments):

Import doesn't seem to be working in Safari (I have not tried in IE 11 or FF). JS Error is thrown in console.
Re-ordering of favorites does not seem to work anymore. Moving between folders seems to be working though.

oskarhane · 2019-09-10T12:14:04Z

build_scripts/webpack-rules.js

@@ -98,7 +98,7 @@ module.exports = [
    use: ['style-loader', 'css-loader']
  },
  {
-    test: /\.svg$/,
+    test: /\.(svg|png)/,


This break the neo4j logo on :play start. And possibly more places.

This is still an issue.

oskarhane · 2019-09-10T12:16:39Z

package.json

    "deepmerge": "^2.1.1",
    "dnd-core": "^2.5.1",
    "dompurify": "^1.0.11",
    "file-saver": "^1.3.8",
    "firebase": "^5.8.3",
    "isomorphic-fetch": "^2.2.1",
    "jsonic": "^0.3.0",
+    "jszip": "^3.2.2",


We need to verify that this works in IE 11.

oskarhane · 2019-09-10T12:17:04Z

src/browser/components/FileDrop/file-drop.utils.test.js

+  getMissingFoldersFromNames
+} from './file-drop.utils'
+
+describe('file-drop.utils', () => {


oskarhane · 2019-09-10T12:17:35Z

src/browser/modules/Sidebar/favorites.utils.test.js

+  updateFolder
+} from './favorites.utils'
+
+describe('favorites.utils', () => {


oskarhane · 2019-09-10T12:18:23Z

src/shared/modules/favorites/favoritesDuck.js

@@ -60,7 +65,7 @@ export default function reducer (state = initialState, action) {
      return mergeFavorites(initialState, updatedFavorites)
    case LOAD_FAVORITES:
    case UPDATE_FAVORITES:
-      return mergeFavorites(initialState, action.favorites)
+      return mergeFavorites(action.favorites, state)


Yes, this is strange.

oskarhane · 2019-09-10T12:19:20Z

src/shared/services/export-favorites/export-favorites.utils.test.js

+import { SLASH } from './export-favorites.constants'
+import { mapOldFavoritesAndFolders } from './export-favorites.utils'
+
+describe('user-favorites.utils', () => {


huboneo · 2019-09-11T07:39:30Z

@oskarhane thank you for your feedback!

Ok I will investigate
That is an intentional change in this PR. Favorites are now ordered alphabetically and can only be moved between folders.

huboneo · 2019-09-11T12:20:32Z

@oskarhane I've updated the PR to address 1. I also found two unrelated bugs from the browser-lambda-parser PR which I fixed. Please check my changes to build_scripts so that I didn't miss anything

oskarhane

Great!

Dragging a .png file shows error message in top banner rather than in a new error frame. Is that intentional?

oskarhane · 2019-09-12T06:50:10Z

build_scripts/webpack-rules.js

@@ -98,7 +98,7 @@ module.exports = [
    use: ['style-loader', 'css-loader']
  },
  {
-    test: /\.svg$/,
+    test: /\.(svg|png)/,


This is still an issue.

oskarhane · 2019-09-12T06:59:41Z

build_scripts/webpack-rules.js

@@ -23,7 +23,11 @@ const path = require('path')
 module.exports = [
  {
    test: /\.(js|jsx)$/,
-    exclude: /(node_modules)|(cypher-codemirror)|(test_utils)|(dist)/,
+    include: [


I'm a bit worried that this might break something but from my tests it all seems fine.
We should verify each step in the build pipeline after this is merged.

huboneo · 2019-09-12T07:26:49Z

@oskarhane Sorry completely forgot about the webpack bug. Fixed:

oskarhane

LGTM 🎉

Ignore the E2E test failures and merge.

huboneo added 5 commits September 2, 2019 13:58

added needed dependencies, allowed symlinked packages in webpack, upd…

b4a57e0

…ated jest.config for lodash-es and react-dnd

Migrated part of neo4j#951

9a7d60d

- Replaced existing favorites implementation with new components from @relate-by-ui/saved-scripts - Added ability to export and import saved favorites using .zip - Added @relate-by-ui/css for icons and material-ui styles

Allow static scripts

e8a2751

bugfix update folder name clears all folders

e6f679c

added unit tests

18a3218

huboneo added enhancement feature labels Sep 2, 2019

huboneo requested review from linuslundahl and oskarhane September 2, 2019 13:18

huboneo commented Sep 2, 2019

View reviewed changes

huboneo and others added 3 commits September 2, 2019 16:57

Import favorite logic for updating state

480a8a3

Merge branch 'master' into feature-export-favorites

fbc3740

Fixed broken tests and updated saved-scripts version

5dc7e2a

huboneo force-pushed the feature-export-favorites branch from 942ecec to 5dc7e2a Compare September 6, 2019 08:41

Merge branch 'master' into feature-export-favorites

53df189

oskarhane reviewed Sep 10, 2019

View reviewed changes

huboneo added 4 commits September 11, 2019 10:09

bugfix filedrop

7b43b83

bugfix duplicate cmd chars

eec4f61

Bugfixes for IE

17afbe4

webpack fixes for lambda parser

f849b95

huboneo requested a review from oskarhane September 11, 2019 12:19

oskarhane reviewed Sep 12, 2019

View reviewed changes

bugfix webpack PNG loading

627e478

oskarhane approved these changes Sep 12, 2019

View reviewed changes

huboneo merged commit 63e6490 into neo4j:master Sep 12, 2019

huboneo deleted the feature-export-favorites branch September 12, 2019 11:37

huboneo mentioned this pull request Sep 13, 2019

Bugfix saved favorites #968

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Import/export saved favorites #964

Import/export saved favorites #964

huboneo commented Sep 2, 2019 •

edited by OskarDamkjaer

Loading

huboneo Sep 2, 2019

huboneo Sep 2, 2019

huboneo Sep 2, 2019

huboneo Sep 2, 2019

oskarhane Sep 10, 2019

oskarhane left a comment

oskarhane Sep 10, 2019

oskarhane Sep 12, 2019

oskarhane Sep 10, 2019

oskarhane Sep 10, 2019

oskarhane Sep 10, 2019

oskarhane Sep 10, 2019

oskarhane Sep 10, 2019

huboneo commented Sep 11, 2019

huboneo commented Sep 11, 2019

oskarhane left a comment

oskarhane Sep 12, 2019

oskarhane Sep 12, 2019

huboneo commented Sep 12, 2019

oskarhane left a comment •

edited

Loading

Import/export saved favorites #964

Import/export saved favorites #964

Conversation

huboneo commented Sep 2, 2019 • edited by OskarDamkjaer Loading

Key changes

Unrelated changes

Screenshots

Running this PR locally

Todo

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

oskarhane 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

huboneo commented Sep 11, 2019

huboneo commented Sep 11, 2019

oskarhane left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

huboneo commented Sep 12, 2019

oskarhane left a comment • edited Loading

Choose a reason for hiding this comment

huboneo commented Sep 2, 2019 •

edited by OskarDamkjaer

Loading

oskarhane left a comment •

edited

Loading