Fixing #2479: Allow user to change the project description without needing to publish their project. #2528
Conversation
Description wasn't saving if the project wasn't published. Now, by clicking cancel while the project is unpublished, the description is saved
| @@ -11,7 +11,7 @@ Vagrant.configure("2") do |config| | |||
| # VM, but users are encouraged to test this and make adjustments below (or file PRs) | |||
| # if you find the VM lagging or unresponsive. | |||
| config.vm.provider "virtualbox" do |v| | |||
| v.memory = 1536 | |||
| v.memory = 8000 | |||
flukeout
Oct 16, 2017
Contributor
Does this change need to be part of this PR?
Does this change need to be part of this PR?
jmrodriguesgoncalves
Oct 16, 2017
Author
Not at all, I should actually have left that as it was, that's something I forgot to change. When testing, the loading between pages took a little too long so I thought giving the VM a bunch of space would make things faster on my end. It didn't change anything, and it slipped right by me. We can change it to the way it was before.
Not at all, I should actually have left that as it was, that's something I forgot to change. When testing, the loading between pages took a little too long so I thought giving the VM a bunch of space would make things faster on my end. It didn't change anything, and it slipped right by me. We can change it to the way it was before.
flukeout
Oct 16, 2017
Contributor
Okay yeah, please change it back, thanks!
Okay yeah, please change it back, thanks!
|
OK - thanks for submitting this PR @jmrodriguesgoncalves! My suggestion for this is to save the description when someone clicks outside of the Publish dialog and the dialog closes it. Currently, if I change the description and then click outside of the popup dialog, the change is lost. Hitting the
Let me know your thoughts! |
|
I think that sounds good, I can try to do what you are asking me. Clicking outside would save the description as you said, so we'd use the same code we have now, except, when clicking anywhere outside the Publish dialog. Now, if we click the cancel button, should the description be completely erased, as in, making it blank, or should we have it be the way it was before, which basically kept the string intact while editing the project (so one would still see it there if they were to open the publish dialog again), but not saved if not published (so it would not show up when looking at their list of projects, or if closed and opened again for editing)? |
Changed Vagrant settings back to normal. I also simplified the code and made it clearer as to what the code is currently doing. Guidance is needed for ajax request, as well as how to interact with the outside of the Publish dialog, in order to change how the description is saved (instead of clicking cancel, one would have to click outside the dialog).
|
Yeah the What if we just remove the The other little popups work this way already, the settings panel and file dropdown for example. What do you think @jmrodriguesgoncalves ? Simplifies things a bit for us. |
|
@flukeout I think that is a great idea that not only would simplify the code, but would also be much less confusing for the end user. If we are to go ahead with this idea, I have a quick question for you since you have more familiarity with this code. Just like we talked about on the chat, I am struggling to find the function that deals with the click outside of the dialog box. I have tried setting an event listener for the div under it, "#click-underlay", however that does not seem to work. If you have any input and if we are to go ahead with the UI change as well, let me know and I will get working on it. Thanks again! |
|
Hey @jmrodriguesgoncalves - yeah let's def go ahead with removing the |
|
OK @jmrodriguesgoncalves - I think I found what we need. Check out this line here. That's where |
commented out Cancel button, added non-working click-underlay logic (commented out, may help with review)
|
@flukeout great stuff, never mind the latest 2 pushes, I will try this! |
|
Yeah do what you need, you can just keep updating this PR, we can squash it all into one commit when we merge it. |
Cancel button has been removed from UI. To save the description, all a user needs to do is click outside the dialog box. This works whether the project is published or unpublished.
|
@flukeout So currently, the code does everything that we decided to go with. It saves the description when the user clicks outside of the dialog box, and since the cancel button isn't there anymore, the user won't be as confused. On the back-end however, the solution I used to make this work may not be the most elegant. In order to save the description, the function checks whether or not the project the user is working on is currently published or not. If it isn't, an ajax request is made to "unpublish" the unpublished project. This of course throws an error message, but the description is saved perfectly. If the project is published however, the code attempts an ajax request to publish with that same ID it is published on, changing only the description, which means nothing but that field will change. What this does is basically allow the user to change the description whether or not their project is published. |
|
Hey awesome @jmrodriguesgoncalves - I'll test out the functionality now, and let's ping @gideonthomas so he can provide his thoughts on the back-end piece you asked about. Edit: OK—I confirmed that the expected behaviour is happening! Nice. |
|
@jmrodriguesgoncalves looks like there are some things you can fix in |
Spacing
Code cleanup
|
@jmrodriguesgoncalves let us know when this is ready to re-test! |
|
@humphd got them sorted out, there were some spacing issues! @flukeout, I haven't changed the logic from what you have tested so there shouldn't be any surprises, but let me know! This latest commit has the same functionality as before, just the spacing is now done correctly as to pass the two tests from below |
|
OK, I'll wait on @humphd to weigh in on the changes you made and then I'll do one last functional test before we get this landed. Cheers! |
|
Sorry for getting to this so late. @jmrodriguesgoncalves, I added some suggestions. I would advocate for not forcing a publish just to update the description, even as a quick fix, because the sheer number of requests will kill the database. Would you also be able to rebase your changes as well? Let us know if you have any questions. |
| //throws error since nothing is being unpublished, however this works | ||
| //to save description. This is currently a "hack", a more elegant | ||
| //solution may be implemented after | ||
| Publisher.prototype.setDescription = function() { |
gideonthomas
Oct 20, 2017
Contributor
let's rename this to saveDescription
let's rename this to saveDescription
| //to save description. This is currently a "hack", a more elegant | ||
| //solution may be implemented after | ||
| Publisher.prototype.setDescription = function() { | ||
| var publisher = this; |
gideonthomas
Oct 20, 2017
Contributor
Let's not force a "publish" just to save the description. Instead, let's make the following changes:
To this function:
const publisher = this;
const oldDescription = Project.getDescription();
const description = publisher.dialog.description.val();
if(oldDescription === description) {
return;
}
Project.setDescription(description);
const data = {
title: Project.getTitle(),
description,
dateUpdated: new Date().toISOString()
};
Metadata.update({
update: true,
csrfToken: publisher.csrfToken,
host: Project.getHost(),
id: Project.getId(),
data
}, error => {
console.error("[Thimble] Failed to update project description with: ", error);
});
Let's not force a "publish" just to save the description. Instead, let's make the following changes:
To this function:
const publisher = this;
const oldDescription = Project.getDescription();
const description = publisher.dialog.description.val();
if(oldDescription === description) {
return;
}
Project.setDescription(description);
const data = {
title: Project.getTitle(),
description,
dateUpdated: new Date().toISOString()
};
Metadata.update({
update: true,
csrfToken: publisher.csrfToken,
host: Project.getHost(),
id: Project.getId(),
data
}, error => {
console.error("[Thimble] Failed to update project description with: ", error);
});
gideonthomas
Oct 20, 2017
Contributor
you'll also need to require in the metadata module from https://github.com/mozilla/thimble.mozilla.org/blob/master/public/editor/scripts/project/metadata.js
you'll also need to require in the metadata module from https://github.com/mozilla/thimble.mozilla.org/blob/master/public/editor/scripts/project/metadata.js
jmrodriguesgoncalves
Oct 20, 2017
Author
This does not to work, even with the metadata module included. After inspecting, it seems this is producing a bad request.
This does not to work, even with the metadata module included. After inspecting, it seems this is producing a bad request.
| @@ -283,6 +328,7 @@ Publisher.prototype.unpublish = function() { | |||
| request.always(function() { | |||
| SyncState.completed(); | |||
| publisher.unpublishing = false; | |||
| publickCheck = false; | |||
gideonthomas
Oct 20, 2017
Contributor
what's this?
what's this?
jmrodriguesgoncalves
Oct 20, 2017
Author
Nothing, it has been removed.
Nothing, it has been removed.
WIP
Spacing
Travis CI spacing
Description wasn't saving if the project wasn't published. Now, by clicking cancel while the project is unpublished, the description is saved. Please review this and let me know if there's something that can be fixed.