Add save as menu option #3289

Madhu94 · 2018-02-01T18:55:10Z

Trying to close #2816

I'd like some quick, initial feedback on this.

I am checking the tests. The UI needs some work too (maybe a directory picker instead of a text box?)

Thanks.

takluyver · 2018-02-02T11:38:30Z

I would expect save-as to work without needing any changes to the REST API or the server. It should update the path for the notebook file in the frontend, and then do a regular save (i.e. a PUT request to the URL of the new file).

This is in line with how 'save as' works in most applications: it changes the file path you're working on, so if you open A and then 'save as' B, subsequent saves will write B until you use 'save as' again.

Some applications have a separate 'save a copy' action, which lets you write file B but keep working on A. I don't think that's a priority to add to the notebook - not many other apps have it.

Madhu94 · 2018-02-02T11:59:10Z

That's how I started but I think this line stopped me.

I'll make the changes, thanks

takluyver · 2018-02-02T12:01:34Z

Yup, I'd just send the whole contents again (for now, every save does that). The notebook may have changed since it was last saved, so copying the file we saved before may not be right.

Madhu94 · 2018-02-13T16:49:58Z

@takluyver Don't you think that if "Save As" behaves almost like "Save", the user could accidentally overwrite a notebook, if they are not careful?

I guess "save as" should do an additional check and warn the user that the file exists..

takluyver · 2018-02-14T11:19:05Z

Yes, ideally if the user tries to 'save as' over an existing file, they should be warned about that.

Madhu94 · 2018-03-11T18:28:02Z

@takluyver Now the user is asked to confirm if they want to overwrite, if a notebook exists with the same name. Let me know if these changes are okay.

takluyver · 2018-03-13T15:51:28Z

I think the frontend stuff (the dialog, updating the URL, etc.) should be able to mostly use the code we already have in static/notebook/js/savewidget.js to rename a notebook. On this side, I would do what you started out doing on the server side: have an option like copy_file: true to switch the behaviour from moving to copying.

Madhu94 · 2018-03-13T16:41:49Z

On this side, I would do what you started out doing on the server side: have an option like copy_file: true to switch the behaviour from moving to copying.

Did you mean for reusing the dialog, I should use a flag ?

takluyver · 2018-03-13T16:53:03Z

Yep, so it would be called like this:

notebook.save_widget.rename_notebook({notebook: notebook, copy_file: true});

Madhu94 · 2018-03-17T19:01:20Z

I've factored out the common portions for "save as" and rename. I know this isn't what you had in mind, but using a flag brought a lot of "if -else" clauses within the click handler of rename. I'll do that if you feel strongly about it though. Re the feature itself, do you think it should take paths relative to current directory and not the notebook root ? That's how creating a new notebook works..

…

On 13-Mar-2018 10:23 PM, "Thomas Kluyver" ***@***.***> wrote: Yep, so it would be called like this: notebook.save_widget.rename_notebook({notebook: notebook, copy_file: true}); — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#3289 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AImSDAaCdVPTHyAa7-e6hvdtyyMv3dtWks5td_lzgaJpZM4R2G_h> .

takluyver · 2018-03-19T11:30:15Z

From a user perspective, I think the starting point should be the directory the notebook is currently saved in. The REST API should always work with paths from the notebook root, though.

takluyver · 2018-03-19T11:32:22Z

notebook/static/notebook/js/notebook.js

@@ -2845,6 +2845,57 @@ define([
        }
    };

+
+    Notebook.prototype.save_notebook_as = function() {


I'd probably put this method into savewidget.js because of the symmetry with rename.

takluyver · 2018-03-19T11:37:26Z

notebook/static/notebook/js/notebook.js

+    Notebook.prototype.save_notebook_as = function() {
+            // If current notebook has some changes, save them
+            if (this.writable && this.dirty) {
+                this.save_notebook();


I don't think I'd expect 'save as' to save over the old name as well, though it's a bit complicated by autosave. @minrk @gnestor @Carreau ?

This is to save the current notebook before navigating away. We did agree that "Save as" would open the newly created notebook (Right? Did I misunderstand?), so I thought we should try to save the current notebook before moving away. I think "make a copy" and "trust" do this too.

This is to save the current notebook before navigating away. We did agree that "Save as" would open the newly created notebook (Right? Did I misunderstand?), so I thought we should try to save the current notebook before moving away. I think "make a copy" and "trust" do this too.

If you do open the new notebook, then this will likely be almost identical to "Make a Copy", Should we have "Make a copy" take a parameter which is the new name/path ?

takluyver · 2018-03-19T11:37:48Z

notebook/static/notebook/js/notebook.js

+                dialog_title: i18n.msg._('Save As'),
+                message: i18n.msg._('Enter a notebook path relative to notebook dir'),
+                message_classname: 'save-message',
+                button_name: 'Save',


This should probably be translatable.

takluyver · 2018-03-19T11:44:37Z

notebook/static/notebook/js/notebook.js

+                      return that.contents.save(nb_path, model)
+                          .then(function(data) {
+                              var dir_path = utils.get_body_data("baseUrl");
+                              window.open(utils.url_path_join(dir_path, "notebooks", data.path), '_self');


There's already code to deal with updating the address bar and other details when the notebook is renamed, based on the notebook_renamed.Notebook event. Instead of calling window.open(), we should make sure that event fires, as on this line:

notebook/notebook/static/notebook/js/notebook.js

Line 3036 in 5fdf8c2

that.events.trigger('notebook_renamed.Notebook', json);

We should also ensure that the session is updated - that links a kernel to a filename. See the line above the one I just linked to.

I'm not sure if triggering event will cause the new notebook to open up...I'll check and get back.

takluyver · 2018-03-19T11:47:00Z

notebook/static/notebook/js/savewidget.js

+   */
+   SaveWidget.prototype._nb_name_dialog = function(options) {
+       var that = this;
+       var dialog_template = _.template(`<p class="<%= classname %>"><%= msg %></p>


Neat! I assume the _.template() makes it translatable?

No, I'm sorry. Underscore templates are just plain html templates. This was just an attempt to share some of the ui code for "save as" and "rename".

Madhu94 · 2018-03-21T14:12:07Z

From a user perspective, I think the starting point should be the directory the notebook is currently saved in. The REST API should always work with paths from the notebook root, though.

I.e. "save as" will be restricted to the current dir + all subdirectories therein ?

Madhu94 · 2018-04-15T13:23:06Z

@takluyver I'm sorry, this PR "fell through the cracks". I will try to wind this up in the next few days

Madhu94 · 2018-04-19T17:39:38Z

I'm really, really sorry, but I'm not able to understand why the above changes are requested, hence a lot of delay. I'll come out and place my concerns here -
I don't get how save as and rename are symmetrical.
Rename

patches an existing notebook
Updates the url and
changes the kernel session

Save As

creates a new notebook
checks that a notebook of the same name does not exist
Opens the newly created notebook (hence no need to change the session in the kernel ??)
The only shared code I could find is that we need a very similar dialog box - we could use underscore templates here.

Please let me know why you think "save as" and "rename" should be implemented the same.

Thanks for your patience.

takluyver · 2018-04-19T19:25:23Z

Let me try to put those as I see them:

Rename

Pick a new name that doesn't already exist
Ask the server to move the notebook file to the new name
Update the session so that our kernel is associated with the new name
Update the frontend (URL, notebook name in the page, possibly other things)

Save as

Pick a new name that doesn't already exist
Ask the server to copy the notebook file to the new name
Update the session so that our kernel is associated with the new name
Update the frontend (URL, notebook name in the page, possibly other things)

Does that make it clearer?

I think maybe the disconnect is that you're talking about opening the new notebook after 'save as' - are you thinking it would open a second tab, so you would have both notebooks open? It's an interesting idea, but what I describe is the way lots of familiar programs do 'save as' - you have just one editor open afterwards, and it's associated with the new file.

Madhu94 · 2018-04-20T20:53:32Z

I see. The disconnect was because I implemented "save as" to work with any path relative to the notebook's root_dir, and I don't think that can be implemented with a rename.

I guess that isn't relevant now as we later agreed to implement save as only in the current directory.

Thanks a lot for the expanation, I will implement "Save As" as rename + save.

Carreau · 2018-04-20T21:00:31Z

notebook/templates/notebook.html

@@ -32,6 +32,7 @@
 data-ws-url="{{ws_url | urlencode}}"
 data-notebook-name="{{notebook_name | urlencode}}"
 data-notebook-path="{{notebook_path | urlencode}}"
+data-server-root="{{server_root}}"


I would like to try that without exposing server_root it is potentially sensitive informations, and we tried out best to not expose it anywhere in the UI. The root is usually represented as the Home icon.

As far as I can tell having this information is only for display purpose, so I would just stay with the home icon.

I actually disagree. I don't think server_root is really that sensitive, and it's probably not hard to work out from the list of files, which is already accessible. The last time we thought about this was before we enabled authentication by default; now that we've done that, I think we can be slightly more relaxed about showing this kind of information.

We've been using the home icon for lack of anything better, but I don't think it's great UI:

It's easy to confuse with your home directory, especially as the two are sometimes but not always the same. File managers frequently use a very similar icon for your home directory, e.g. in Gnome:

It obscures where the files are actually stored, if you want to go and work with them outside the notebook. At one point Anaconda's GUI launcher would create a directory like 'Notebooks' to run the server in, which is hard to discover from inside.

We should make sure it comes from the contents manager and works if it's empty, to allow for non-filesystem contents managers. But I think the benefits of showing it outweigh the disadvantages.

Carreau · 2018-04-20T21:03:24Z

I agree with your plan, and think that with this approach we have something really close to what "Make a copy" does, and it would be nice to get both functionality closer. I think that "Save as..." may be more familiar than "Make a copy", and we could try to see if "Make a copy" could be removed in the longer term.

Madhu94 · 2018-04-20T21:59:27Z

I'm a little confused now I think it would be easier to decide what to do if we fix on how "Save As" should behave - save a new notebook in the current directory or anywhere relative to root_dir ? If we decide that it is the current directory, I agree with @takluyver that this feature is a lot like rename If not, rename may not be identical to Save As.

…

On Sat 21 Apr, 2018, 2:33 AM Matthias Bussonnier, ***@***.***> wrote: I agree with your plan, and think that with this approach we have something really close to what "Make a copy" does, and it would be nice to get both functionality closer. I think that "Save as..." may be more familiar than "Make a copy", and we could try to see if "Make a copy" could be removed in the longer term. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#3289 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AImSDGShpd_A3tnmSeExIbTeQ3cPmMz2ks5tqk0ggaJpZM4R2G_h> .

takluyver · 2018-04-21T06:32:50Z

I implemented "save as" to work with any path relative to the notebook's root_dir, and I don't think that can be implemented with a rename.

Ah, my bad. Rename and move are the same operation in the REST API, and I thought we'd made the GUI so that rename could move it to a different folder, but I was wrong about that.

I think it would be easier to decide what to do if we fix on how "Save As" should behave - save a new notebook in the current directory or anywhere relative to root_dir ?

I think it should be able to save anywhere under the server root directory, but in terms of the UI, it should work relative to the directory the notebook is already in. So if I start the notebook server at /home/takluyver and open a notebook /home/takluyver/foo/ThisNotebook.ipynb, then 'Save as' should assume that I want to stay in the foo folder unless I tell it otherwise.

Madhu94 · 2018-04-29T13:57:16Z

unless I tell it otherwise.

So, if the user types bar/copynotebook.ipynb inside foo, we save under /home/takluyver/foo/bar/copynotebook.ipynb?

Madhu94 · 2018-04-29T16:00:36Z

I've changed it back to the original implementation which behaved a little like "Make a copy". Even deciding to make it relative to current dir should be as easy as appending $('body').attr('data-notebook-path') to the notebook path, let me know.

takluyver · 2018-04-29T16:08:23Z

So, if the user types bar/copynotebook.ipynb inside foo, we save under /home/takluyver/foo/bar/copynotebook.ipynb?

Yes... but if possible, could we make it so that when the dialog appears, foo/ is already filled in, and the cursor is at the end? So you could type a name to save in the same folder, or backspace to take it to another folder.

takluyver · 2018-04-29T16:12:47Z

notebook/static/notebook/js/notebook.js

+                             };
+                            return that.contents.save(nb_path, model)
+                                .then(function(data) {
+                                    window.open(data.path, '_self');


Here I think we should use the same functions that rename uses to update the session and the page:

notebook/notebook/static/notebook/js/notebook.js

Lines 2984 to 2985 in 2aca6f9

that.session.rename_notebook(json.path);

that.events.trigger('notebook_renamed.Notebook', json);

Madhu94 · 2018-04-29T18:42:35Z

I think I got the behavior you wanted now. (Although the save as method has become a callback+promise hell...)

takluyver

The code and the functionality are looking good now, but I found a few minor UI issues.

I'd also like to have a basic Selenium test for this - see this folder: https://github.com/jupyter/notebook/tree/master/notebook/tests/selenium

takluyver · 2018-04-30T14:27:27Z

notebook/static/notebook/js/notebook.js

-
+
+    Notebook.prototype.save_notebook_as = function() {
+        // If current notebook has some changes, save them, or the copied notebook won't have them.


Is this still needed? We're sending a new copy of the notebook to the new name, so I don't think we need to save it at the old name again first.

takluyver · 2018-04-30T14:31:49Z

notebook/static/notebook/js/notebook.js

+        ).append($('<label />').attr('for', 'save-as-dialog')
+            .html('<i class="fa fa-home"></i>')
+        ).append(
+            $('<input/>').attr('type','text').attr('size','25')


This input area doesn't show up well for me. I think you're missing the form-control class that the rename dialog uses:

notebook/notebook/static/notebook/js/savewidget.js

Line 83 in 2aca6f9

$('<input/>').attr('type','text').attr('size','25').addClass('form-control')

Also, I hope we can get rid of the inline styling a couple of lines below.

takluyver · 2018-04-30T14:34:47Z

notebook/static/notebook/js/notebook.js

+                        return false;
+                    }
+                });
+                d.find('input[type="text"]').focus().select();


This currently selects the path pre-filled in the input, which is not ideal. Can we make it put the cursor at the end of the input already there?

takluyver · 2018-04-30T14:35:28Z

notebook/templates/notebook.html

@@ -89,6 +89,9 @@
                        <li id="copy_notebook"
                            title="{% trans %}Open a copy of this notebook's contents and start a new kernel{% endtrans %}">
                            <a href="#">{% trans %}Make a Copy...{% endtrans %}</a></li>
+                        <li id="save_notebook_as"
+                            title="{% trans %}Save a copy of the notebook's contents and start a new kernel{% endtrans %}">
+                            <a href="#">{% trans %}Save as{% endtrans %}</a></li>


This label should end ... to indicate that it brings up a dialog rather than acting immediately.

Madhu94 · 2018-05-13T19:38:03Z

I'd also like to have a basic Selenium test for this - see this folder: https://github.com/jupyter/notebook/tree/master/notebook/tests/selenium

I added one. Also took care of the css issues.

Madhu94 · 2018-06-13T18:57:07Z

Hi @takluyver @Carreau, any updates here ?

takluyver · 2018-06-17T09:35:10Z

notebook/static/notebook/js/notebook.js

+                                   $('.save-message').html(`<span style='color:red;'>${msg}</span>`);
+                                });
+                        }
+                        that.contents.get(nb_path, {type: 'notebook'}).then(function(data) {


This should at least use content: false to avoid getting the full content of the other notebook if it does exist. It's also not great in that it assumes any error getting a model means that the file is not there.

The right way to do this is probably to add a parameter when saving, to ask the server to throw an error if the filename already exists. Maybe this way of doing it is good enough for now, though. I'd like to get some other opinions on it.

This should at least use content: false to avoid getting the full content of the other notebook if it does exist.

This is done, thank you.

It's also not great in that it assumes any error getting a model means that the file is not there.

I will try to think of a better way. Maybe we go back to something like my original implementation which used a flag to toggle between copy/save on the server..

if it exists Don't get entire contents of the notebooks, while checking if it exists

Madhu94 · 2018-06-18T18:10:04Z

What do you think of adding a HEAD HTTP method to the contents handler? This would simply call contents_manager.file_exists or contents_manager.dir_exists. (I'm not sure if things like this are "done")

It might be better than adding a flag while saving, I don't like how that looks -

if exists:
    if model.get('overwrite', True):
        yield gen.maybe_future(self._save(model.get("model"), path))
     else:
         raise web.HTTPError(400, "File with that name exists")

takluyver · 2018-06-18T18:32:16Z

That's roughly what content: false already does, but with the metadata in the JSON model rather than HTTP headers.

@minrk @Carreau @mpacer I'd like to get another pair of eyes on this PR if possible. Thanks!

takluyver · 2018-06-18T18:37:24Z

@Madhu94 It seems to be failing the tests, if you could take a look.

Madhu94 · 2018-06-18T18:43:29Z

@Madhu94 It seems to be failing the tests, if you could take a look.

".CodeMirror-code" still did not exist" => I thought this was some transient Travis bug, will check

takluyver · 2018-06-18T20:46:11Z

I think that error can mean it's failing to load the notebook page - it waits for a codemirror block to exist to check that the notebook is loading correctly. The fact that it's doing that on all frontend tests suggests that there's a real problem somewhere (though it might be that something else changed at the same time).

ES6 syntax is not available to us

minrk · 2018-06-20T10:37:38Z

I tracked down the test failure to some ES6 syntax in the new javascript. Removing that should let the tests pass.

takluyver · 2018-06-20T10:51:23Z

Indeed it does :-). Thanks Min, and thanks @Madhu94 for your patience with this. Merging now.

takluyver · 2018-06-20T10:51:44Z

Heads up @mpacer that this is another change for 5.6.

Madhu94 · 2018-06-20T10:55:04Z

Thanks @minrk, I was having a lot of trouble with that. Thanks for all your help, @taklyuver

…

On Wed 20 Jun, 2018, 4:21 PM Thomas Kluyver, ***@***.***> wrote: Indeed it does :-). Thanks Min, and thanks @Madhu94 <https://github.com/Madhu94> for your patience with this. Merging now. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#3289 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AImSDP-dMzwgQozXqYk9ynoy6eIxXVhoks5t-ik1gaJpZM4R2G_h> .

rachelgshaffer · 2018-10-03T18:10:47Z

@Madhu94 @takluyver quick question... I am curious about the implementation here. The tooltip indicates that it starts a new session but seems the intent was to associate the new name with the same kernel session. I wanted to double check on the actual behavior: does it keep the same kernel or start a new one?

takluyver · 2018-10-22T14:24:50Z

@rachelgshaffer it should be keeping the same session and changing the filename associated with it. The 'start a new kernel' language in the tooltip is misleading copy-pasta, I think. Do you want to make a PR to fix that?

Madhu94 force-pushed the add-save-as-menu-option branch from f97e26e to 50d6297 Compare February 6, 2018 20:15

Madhu94 force-pushed the add-save-as-menu-option branch from 0610bd5 to 21b7710 Compare March 11, 2018 17:40

Madhu94 changed the title ~~[WIP] Add save as menu option~~ Add save as menu option Mar 11, 2018

Madhu94 force-pushed the add-save-as-menu-option branch from 21b7710 to 5fdf8c2 Compare March 17, 2018 18:57

takluyver reviewed Mar 19, 2018

View reviewed changes

Carreau reviewed Apr 20, 2018

View reviewed changes

Madhu94 force-pushed the add-save-as-menu-option branch from 5fdf8c2 to d3b29ed Compare April 29, 2018 15:58

takluyver reviewed Apr 29, 2018

View reviewed changes

takluyver reviewed Apr 30, 2018

View reviewed changes

Madhu94 added 4 commits May 13, 2018 00:05

Add 'Save As' option to the menu

fd25ae1

UI changes

ee79a7f

Switch sessions instead of opening in new window

9b18d07

More UI changes

84e565c

Madhu94 force-pushed the add-save-as-menu-option branch from 576d3ea to 84e565c Compare May 12, 2018 18:36

Add basic selenium test case

eab1e70

takluyver reviewed Jun 17, 2018

View reviewed changes

Don't get entire contents of the notebooks, while checking

81c6eed

if it exists Don't get entire contents of the notebooks, while checking if it exists

Remove ES6 syntax from save_notebook_as

0c81fc3

ES6 syntax is not available to us

takluyver merged commit 5766341 into jupyter:master Jun 20, 2018

minrk added this to the 5.6 milestone Jun 20, 2018

github-actions bot added the status:resolved-locked label Mar 30, 2021

github-actions bot locked as resolved and limited conversation to collaborators Mar 30, 2021

	that.session.rename_notebook(json.path);
	that.events.trigger('notebook_renamed.Notebook', json);



		Notebook.prototype.save_notebook_as = function() {
		// If current notebook has some changes, save them, or the copied notebook won't have them.

Add save as menu option #3289

Add save as menu option #3289

Conversation

Madhu94 commented Feb 1, 2018 • edited Loading

takluyver commented Feb 2, 2018

Madhu94 commented Feb 2, 2018 • edited Loading

takluyver commented Feb 2, 2018

Madhu94 commented Feb 13, 2018 • edited Loading

takluyver commented Feb 14, 2018

Madhu94 commented Mar 11, 2018 • edited Loading

takluyver commented Mar 13, 2018

Madhu94 commented Mar 13, 2018 • edited Loading

takluyver commented Mar 13, 2018

Madhu94 commented Mar 17, 2018 via email

takluyver commented Mar 19, 2018

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Madhu94 commented Mar 21, 2018

Madhu94 commented Apr 15, 2018

Madhu94 commented Apr 19, 2018 • edited Loading

takluyver commented Apr 19, 2018

Madhu94 commented Apr 20, 2018 • edited Loading

Choose a reason for hiding this comment

takluyver Apr 21, 2018 • edited Loading

Choose a reason for hiding this comment

Carreau commented Apr 20, 2018

Madhu94 commented Apr 20, 2018 via email

takluyver commented Apr 21, 2018

Madhu94 commented Apr 29, 2018

Madhu94 commented Apr 29, 2018 • edited Loading

takluyver commented Apr 29, 2018

Choose a reason for hiding this comment

Madhu94 commented Apr 29, 2018

takluyver 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

Madhu94 commented May 13, 2018

Madhu94 commented Jun 13, 2018

Choose a reason for hiding this comment

Madhu94 Jun 17, 2018 • edited Loading

Choose a reason for hiding this comment

Madhu94 commented Jun 18, 2018 • edited Loading

takluyver commented Jun 18, 2018

takluyver commented Jun 18, 2018

Madhu94 commented Jun 18, 2018

takluyver commented Jun 18, 2018

minrk commented Jun 20, 2018

takluyver commented Jun 20, 2018

takluyver commented Jun 20, 2018

Madhu94 commented Jun 20, 2018 via email

rachelgshaffer commented Oct 3, 2018

takluyver commented Oct 22, 2018

Madhu94 commented Feb 1, 2018 •

edited

Loading

Madhu94 commented Feb 2, 2018 •

edited

Loading

Madhu94 commented Feb 13, 2018 •

edited

Loading

Madhu94 commented Mar 11, 2018 •

edited

Loading

Madhu94 commented Mar 13, 2018 •

edited

Loading

Madhu94 commented Apr 19, 2018 •

edited

Loading

Madhu94 commented Apr 20, 2018 •

edited

Loading

takluyver Apr 21, 2018 •

edited

Loading

Madhu94 commented Apr 29, 2018 •

edited

Loading

Madhu94 Jun 17, 2018 •

edited

Loading

Madhu94 commented Jun 18, 2018 •

edited

Loading