Bug 275089 - [ui] Indicate both user readable name and IU id in explanation message and in the wizard
Summary: [ui] Indicate both user readable name and IU id in explanation message and in...
Status: RESOLVED FIXED
Alias: None
Product: Equinox
Classification: Eclipse Project
Component: p2 (show other bugs)
Version: 3.5   Edit
Hardware: PC All
: P3 minor (vote)
Target Milestone: 3.5 RC1   Edit
Assignee: Susan McCourt CLA
QA Contact:
URL:
Whiteboard:
Keywords: polish
Depends on:
Blocks:
 
Reported: 2009-05-05 21:47 EDT by Pascal Rapicault CLA
Modified: 2009-05-06 16:06 EDT (History)
2 users (show)

See Also:
dj.houghton: review+
dj.houghton: review+


Attachments
Patch adding externalized name in the message (3.90 KB, patch)
2009-05-05 22:40 EDT, Pascal Rapicault CLA
no flags Details | Diff
patch that adds id column to the error reporting page of install, update, and uninstall wizards (11.46 KB, patch)
2009-05-06 15:08 EDT, Susan McCourt CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Pascal Rapicault CLA 2009-05-05 21:47:16 EDT
When an explanation error is reported, the IU id is shown. This makes it hard for the user which things that he is trying to install are incriminated in the problem being reported.
Comment 1 Pascal Rapicault CLA 2009-05-05 22:39:07 EDT
Message before the change
Cannot complete the install because one or more required items could not be found.
  Software being installed: org.tigris.subversion.subclipse.mylyn.feature.group 3.0.0
  Missing requirement: org.tigris.subversion.subclipse.mylyn.feature.group 3.0.0 requires 'org.eclipse.mylyn.team.ui [3.0.0,4.0.0)' but it could not be found

After the change
Cannot complete the install because one or more required items could not be found.
  Software being installed: Subclipse Integration for Mylyn 3.x (Optional) 3.0.0 (org.tigris.subversion.subclipse.mylyn.feature.group 3.0.0)
  Missing requirement: Subclipse Integration for Mylyn 3.x (Optional) 3.0.0 (org.tigris.subversion.subclipse.mylyn.feature.group 3.0.0) requires 'org.eclipse.mylyn.tasks.ui [3.0.0,4.0.0)' but it could not be found
Comment 2 Pascal Rapicault CLA 2009-05-05 22:40:46 EDT
Created attachment 134558 [details]
Patch adding externalized name in the message
Comment 3 DJ Houghton CLA 2009-05-06 10:33:06 EDT
I have released a slightly modified patch. (NLS'd one more message)

I'm not a huge fan of using #toString in messages but I'm not going to go through and change all of them this late in the game. Besides, as Pascal points out, it was like that when I got here. :-)
Comment 4 Susan McCourt CLA 2009-05-06 11:58:14 EDT
(In reply to comment #3)
> I have released a slightly modified patch. (NLS'd one more message)
> 
> I'm not a huge fan of using #toString in messages but I'm not going to go
> through and change all of them this late in the game. Besides, as Pascal points
> out, it was like that when I got here. :-)
> 

One problem with this approach is that the name used is not localized.  The user might see a different name in the UI than what is reported below.   This is why we have not pushed on this in the past.  See bug 253203 comment 4.

Is this acceptable?  
Comment 5 Susan McCourt CLA 2009-05-06 14:33:12 EDT
I think changes in the UI have made this problem worse than it was in 3.4.  The install details page in all the wizards shows both the name and the id.  This was intentional because errors are reported by id.

However, in M7 we now report errors on the first page of the wizard rather than moving to the details page.  What was forgotten was to add an id column on this page so that errors would be meaningful.

I think this might be a better fix than what is proposed in this bug.  Since the IU name is not localized, with the current fix there is a risk that the user won't recognize the name either.  I also think putting both the name and id makes it harder to read.  These error messages are already too long.  So we are making it more verbose and potentially incorrect, so I would be in favor of removing this fix.

I can take this bug and focus it on "include the IU id in the error reporting page".  I think that the longer term issue of including the localized name in error messages is covered somewhat by bug 253203.

I'll wait to hear from Pascal.
Comment 6 Susan McCourt CLA 2009-05-06 14:40:38 EDT
talked to Pascal.  He is not worried about the localization issue as it is not common, however we agree that adding the id to the error reporting page will cover the case where the name has been localized.  At least then the user will see the id for a reference point.

Moving to me to fix this part.
Comment 7 Susan McCourt CLA 2009-05-06 15:08:08 EDT
Created attachment 134677 [details]
patch that adds id column to the error reporting page of install, update, and uninstall wizards

This patch looks busy, but basically it's moving the id column handling up into the superclass, thereby removing a bunch of code from one subclass and adding concrete implementations to previously abstract methods in the superclass.

I verified that the install error page, the update selection/error page, and the uninstall selection/error page now have an id column.  Note this is the first page in the update and uninstall wizards, and the second page in the install wizard (which appears only if there is an error).
Comment 8 Susan McCourt CLA 2009-05-06 15:08:45 EDT
DJ, can you review the second patch (the UI part)?
Comment 9 DJ Houghton CLA 2009-05-06 16:06:06 EDT
Looks good. 
Released to HEAD.