Bug 91291

Probably better to just figure out what is so slow and then make it faster.

yes, this would be also a way to fix that

I'm not able to reproduce any delay when closing Project Properties of
J2SEProject. Either modified of unmodified. What JDK do you use? What and how
many projects you have opened in IDE? How many files is opened in editor? Is
anything running in the IDE?

I can reproduce it everytime.

1. Start NetBeans
2. No project is opened
3. Create new J2SE project
4. Open project properties
5. Don't change anything and click OK
6. Gray rectangle is shown for 2 seconds in place where properties dialog was
shown. The IDE does not response this time.

Nothing else is running in the IDE. There is open only Main.java file which is
automatically opened when the project is created.

The IDE is not responsive for mentioned time with any JDK, the only difference
is that the gray rectangle is shown only with JDK 1.5 and lower, not with 1.6.

Yes, I have already seen it, the critical information that was missing is "...
only with JDK 1.5 and lower, not with 1.6.". I was running on JDK 1.6.

To make it clear - it is not responsive on 1.6 as well, it is only not so
visible because the gray rectangle is not shown but the behaviour is the same.

Of course :-)

Long description of grey rectangle fix is at
http://weblogs.java.net/blog/chet/archive/2005/04/swing_update_no_1.html

Simple trick is to resize the window and if EDT is occupied by some long running
task it will not be redrawn again.

Saving project properties is indeed done in AWT, but rescheduling the save outside of AWT would be very risky change
now, given that it can affect any project type. The UI freeze is visible only on JDK 1.5, on JDK 1.6 the gray rectangle
effect is fixed and UI looks responsive, of course the problem is still there but user won't probably notice that. There
was a fix in java/j2seproject which partially improve the behavior when saving project properties, see issue #99747 -
events about classpath change will be fired asynchronously.

Issue 99747 claims to fix a problem introduced by the classpath exclude mechanism, so it probably doesn't address the
original problem. The 

Why is this being waived without trying the suggestion in desc2 first? Also, what is risky about rescheduling the save
to another thread? It probably needs to be done with a modal progress dialog, and it seems to be each project type would
have to do it explicitly.

I didn't mean that issue #99747 fixes original problem. It fixed event firing that was done during saving project
properties synchronously, so it might improve performance.

Rescheduling anything in projects is always risky. Threading is also kind of API which others rely upon unknowingly.

My idea was to let each project type save the customizer in a background worker thread explicitly (while displaying a
progress dialog). Specificall, this would be handled by the ActionListener that implementations of CustomizerProvider
pass to createCustomizerDialog(). It would not change anything in the ProjectCustomizer threading. But it would not work
well for the categories other than those registered by the project type. Also the progress dialog would not include all
the saveProject() calls (one is e.g. in XyzProjectProperties and another in CustomizerDialog). So if a dialog modal
dialog is to be displayed for the whole save operation, it would probably have to be in the customizer.

I tried to use wait cursor in OptionListener in CustomizerDialog but it didn't work well.

Correct fix of the problem require substantial rewrite of the project customizer API, introducing new API, new threading
model and of course rewrite of all project types customizers. Estimated work seems to be from two weeks to one month
without rewrite needed in all project types. Changing threading in important part of project infrastructure just before
Beta1 is too risky and it can be source of new issues. I was told that this rewrite was already planed around 4.0, but
was deferred because of lack of resources and potential impact of the change. Hence I'm proposing again to waive this
issue for NB 6.0 release.

If the save inside AWT is really very visible performance problem, then I think we can implement low risk, compatible 
solution even for 6.0:

The general idea is to add new "store" listener - one that is called after the OK button listener, outside of AWT 
thread.

That way the project types can split its logic. In the existing OK button listener, just get the data from the UI 
elements and models. And in the "store" listener (which is called later from a non-AWT thread) really store them and 
do all the expensive processing.

As far as I can tell this means addition of three-four methods:

ProjectCustomizer.createCustomizerDialog(...., ActionListener okButtonListener, ActionListener storeListener, ...)
ProjectCustomizer.Category.setStoreListener(ActionListener l);
ProjectCustomizer.Category.getStoreListener();

plus some unit tests to guarantee that without use of the new methods everything behaves compatibly with 5.x and with 
new methods the store is called after and outside of AWT thread. 

Indeed, each project that wishes to benefit from this enhanced behaviou, has to use the new methods, but that is a 
price for low level impact, compatible implementation.

Created attachment 47314 [details]
patch file

I've attached patch file with implementation proposed by Jarda. Special listener can be provided that will do the time
consuming save operation. When the listener is executed IDE is blocked by modal dialog with progress bar. Current
implementation works without any change. The only difference from previous implementation for code that doesn't use new
API is that save of project metadata is now done off AWT EQ (only if the project itself is modified), but blocked by
modal dialog. Project type that would want to take advantage of this change needs to divide the processing of project
customizer into two parts - one that gathers data from components and models and the second that does save operation. It
means that it doesn't fix the original problem, but provides way to all project types to do it. Special store listener
can be also used for any category.

I forgot to reassign to apireviews.

Created attachment 47439 [details]
context diff

Missing word or phrase in Javadoc: "Creates standard which can be used..."

looks generally ok. Do you have a rewrite of j2seproject as sample reimplementation? Can you attach it to the issue?

Created attachment 47612 [details]
patch file with javadoc fix

Created attachment 47614 [details]
j2seproject with new API patch file

I've attached patch file addressing Jesse's comment and also patch file with change in j2seproject.

javadoc_fix.patch still seems to have "Creates standard which can be used for implementation...".

Sorry, then I probably misunderstood your comment. Please explain what's wrong with javadoc and possibly provide some
hint. Thanks

I will integrate the patch tomorrow (including fixed javadoc).

"patch file with javadoc fix" still contains one method with a missing word "dialog" or similar:

+    /** Creates standard which can be used for implementation
                        ^^^
+     * of {@link org.netbeans.spi.project.ui.CustomizerProvider}. Use this version if you need 
+     * to run processing of the customizer data partially off AWT Event Queue. You don't need
+     * to call <code>pack()</code> method on the dialog. The resulting dialog will
+     * be non-modal. <br>
+     * Call <code>show()</code> on the dialog to make it visible. If you want the dialog to be
+     * closed after user presses the "OK" button you have to call hide() and dispose() on it.
+     * (Usually in the <code>actionPerformed(...)</code> method of the listener
+     * you provided as a parameter. In case of the click on the "Cancel" button
+     * the dialog will be closed automatically.
+     * @since org.netbeans.modules.projectuiapi/1 1.25
+     * @param categories array of descriptions of categories to be shown in the
+     *        dialog. Note that categories have the <code>valid</code>
+     *        property. If any of the given categories is not valid cusomizer's
+     *        OK button will be disabled until all categories become valid
+     *        again.
+     * @param componentProvider creator of GUI components for categories in the
+     *        customizer dialog.
+     * @param preselectedCategory name of one of the supplied categories or null.
+     *        Category with given name will be selected. If  <code>null</code>
+     *        or if the category of given name does not exist the first category will
+     *        be selected.
+     * @param okOptionListener listener which will be notified when the user presses
+     *        the OK button.
+     * @param storeListener listener which will be notified when the user presses OK button.
+     *        Listener will be executed after okOptionListener outside of AWT EventQueue.
+     *        Usually to be used to save modified files on disk.
+     * @param helpCtx Help context for the dialog, which will be used when the
+     *        panels in the customizer do not specify their own help context.
+     * @return standard project customizer dialog.
+     */
+    public static Dialog createCustomizerDialog( Category[] categories,
+                                                 CategoryComponentProvider componentProvider,
+                                                 String preselectedCategory,
+                                                 ActionListener okOptionListener,
+                                                 ActionListener storeListener,
+                                                 HelpCtx helpCtx ) {

Fixed by providing new methods in API to allow to run time consuming part of project customizer processing outside of
AWT Event Queue. Project types that want to take advantage of it needs to fix their code.

Checking in src/org/netbeans/modules/project/uiapi/CustomizerDialog.java;
/cvs/projects/projectuiapi/src/org/netbeans/modules/project/uiapi/CustomizerDialog.java,v  <--  CustomizerDialog.java
new revision: 1.13; previous revision: 1.12
done
Checking in src/org/netbeans/modules/project/uiapi/Bundle.properties;
/cvs/projects/projectuiapi/src/org/netbeans/modules/project/uiapi/Bundle.properties,v  <--  Bundle.properties
new revision: 1.17; previous revision: 1.16
done
RCS file: /cvs/projects/projectuiapi/src/org/netbeans/modules/project/uiapi/SavingProjectDataPanel.java,v
done
Checking in src/org/netbeans/modules/project/uiapi/SavingProjectDataPanel.java;
/cvs/projects/projectuiapi/src/org/netbeans/modules/project/uiapi/SavingProjectDataPanel.java,v  <-- 
SavingProjectDataPanel.java
initial revision: 1.1
done
RCS file: /cvs/projects/projectuiapi/src/org/netbeans/modules/project/uiapi/SavingProjectDataPanel.form,v
done
Checking in src/org/netbeans/modules/project/uiapi/SavingProjectDataPanel.form;
/cvs/projects/projectuiapi/src/org/netbeans/modules/project/uiapi/SavingProjectDataPanel.form,v  <-- 
SavingProjectDataPanel.form
initial revision: 1.1
done
RCS file: /cvs/projects/projectuiapi/test/unit/src/org/netbeans/spi/project/ui/support/ProjectCustomizerListenersTest.java,v
done
Checking in test/unit/src/org/netbeans/spi/project/ui/support/ProjectCustomizerListenersTest.java;
/cvs/projects/projectuiapi/test/unit/src/org/netbeans/spi/project/ui/support/ProjectCustomizerListenersTest.java,v  <--
 ProjectCustomizerListenersTest.java
initial revision: 1.1
done
Checking in apichanges.xml;
/cvs/projects/projectuiapi/apichanges.xml,v  <--  apichanges.xml
new revision: 1.33; previous revision: 1.32
done
Checking in nbproject/project.xml;
/cvs/projects/projectuiapi/nbproject/project.xml,v  <--  project.xml
new revision: 1.21; previous revision: 1.20
done
Checking in src/org/netbeans/spi/project/ui/support/ProjectCustomizer.java;
/cvs/projects/projectuiapi/src/org/netbeans/spi/project/ui/support/ProjectCustomizer.java,v  <--  ProjectCustomizer.java
new revision: 1.16; previous revision: 1.15
done

Fixed for j2seproject.

Checking in CustomizerProviderImpl.java;
/cvs/java/j2seproject/src/org/netbeans/modules/java/j2seproject/ui/customizer/CustomizerProviderImpl.java,v  <-- 
CustomizerProviderImpl.java
new revision: 1.13; previous revision: 1.12
done

Reverting of the API fix for running saving of project properties off AWT EQ. 
API was considered as dangerous with possibility of causing various deadlocks (e.g. issue #114535).

j2seproject fix was already reverted as part of issue #114535 issue fix.

Revert commit log:

IDE: [10/4/07 9:55 AM] Committing started
Checking in src/org/netbeans/modules/project/uiapi/CustomizerDialog.java;
/cvs/projects/projectuiapi/src/org/netbeans/modules/project/uiapi/CustomizerDialog.java,v  <--  CustomizerDialog.java
new revision: 1.15; previous revision: 1.14
done
Checking in src/org/netbeans/modules/project/uiapi/Bundle.properties;
/cvs/projects/projectuiapi/src/org/netbeans/modules/project/uiapi/Bundle.properties,v  <--  Bundle.properties
new revision: 1.20; previous revision: 1.19
done
Removing src/org/netbeans/modules/project/uiapi/SavingProjectDataPanel.java;
/cvs/projects/projectuiapi/src/org/netbeans/modules/project/uiapi/SavingProjectDataPanel.java,v  <-- 
SavingProjectDataPanel.java
new revision: delete; previous revision: 1.2
done
Removing src/org/netbeans/modules/project/uiapi/SavingProjectDataPanel.form;
/cvs/projects/projectuiapi/src/org/netbeans/modules/project/uiapi/SavingProjectDataPanel.form,v  <-- 
SavingProjectDataPanel.form
new revision: delete; previous revision: 1.1
done
Removing test/unit/src/org/netbeans/spi/project/ui/support/ProjectCustomizerListenersTest.java;
/cvs/projects/projectuiapi/test/unit/src/org/netbeans/spi/project/ui/support/ProjectCustomizerListenersTest.java,v  <--
 ProjectCustomizerListenersTest.java
new revision: delete; previous revision: 1.2
done
Checking in apichanges.xml;
/cvs/projects/projectuiapi/apichanges.xml,v  <--  apichanges.xml
new revision: 1.35; previous revision: 1.34
done
Checking in nbproject/project.xml;
/cvs/projects/projectuiapi/nbproject/project.xml,v  <--  project.xml
new revision: 1.23; previous revision: 1.22
done
Checking in src/org/netbeans/spi/project/ui/support/ProjectCustomizer.java;
/cvs/projects/projectuiapi/src/org/netbeans/spi/project/ui/support/ProjectCustomizer.java,v  <--  ProjectCustomizer.java
new revision: 1.19; previous revision: 1.18
done

No objections against waiver - considered as approved.

Fixed. Commiting back storeListener to allow to save project properties off AWT EQ. Fixed in j2seproject, webproject,
ejbjarproject and clientproject.

Checking in projects/projectuiapi/src/org/netbeans/modules/project/uiapi/Bundle.properties;
/cvs/projects/projectuiapi/src/org/netbeans/modules/project/uiapi/Bundle.properties,v  <--  Bundle.properties
new revision: 1.21; previous revision: 1.20
done
Checking in projects/projectuiapi/src/org/netbeans/modules/project/uiapi/SavingProjectDataPanel.form;
/cvs/projects/projectuiapi/src/org/netbeans/modules/project/uiapi/SavingProjectDataPanel.form,v  <-- 
SavingProjectDataPanel.form
new revision: 1.3; previous revision: 1.2
done
Checking in projects/projectuiapi/src/org/netbeans/modules/project/uiapi/CustomizerDialog.java;
/cvs/projects/projectuiapi/src/org/netbeans/modules/project/uiapi/CustomizerDialog.java,v  <--  CustomizerDialog.java
new revision: 1.16; previous revision: 1.15
done
Checking in projects/projectuiapi/src/org/netbeans/modules/project/uiapi/SavingProjectDataPanel.java;
/cvs/projects/projectuiapi/src/org/netbeans/modules/project/uiapi/SavingProjectDataPanel.java,v  <-- 
SavingProjectDataPanel.java
new revision: 1.4; previous revision: 1.3
done
Checking in j2ee/ejbjarproject/src/org/netbeans/modules/j2ee/ejbjarproject/ui/customizer/CustomizerProviderImpl.java;
/cvs/j2ee/ejbjarproject/src/org/netbeans/modules/j2ee/ejbjarproject/ui/customizer/CustomizerProviderImpl.java,v  <-- 
CustomizerProviderImpl.java
new revision: 1.20; previous revision: 1.19
done
Checking in projects/projectuiapi/nbproject/project.properties;
/cvs/projects/projectuiapi/nbproject/project.properties,v  <--  project.properties
new revision: 1.35; previous revision: 1.34
done
Checking in projects/projectuiapi/nbproject/project.xml;
/cvs/projects/projectuiapi/nbproject/project.xml,v  <--  project.xml
new revision: 1.24; previous revision: 1.23
done
Checking in java/j2seproject/src/org/netbeans/modules/java/j2seproject/ui/customizer/CustomizerProviderImpl.java;
/cvs/java/j2seproject/src/org/netbeans/modules/java/j2seproject/ui/customizer/CustomizerProviderImpl.java,v  <-- 
CustomizerProviderImpl.java
new revision: 1.16; previous revision: 1.15
done
Checking in projects/projectapi/src/org/netbeans/api/project/ProjectManager.java;
/cvs/projects/projectapi/src/org/netbeans/api/project/ProjectManager.java,v  <--  ProjectManager.java
new revision: 1.40; previous revision: 1.39
done
Checking in j2ee/clientproject/src/org/netbeans/modules/j2ee/clientproject/ui/customizer/CustomizerProviderImpl.java;
/cvs/j2ee/clientproject/src/org/netbeans/modules/j2ee/clientproject/ui/customizer/CustomizerProviderImpl.java,v  <-- 
CustomizerProviderImpl.java
new revision: 1.11; previous revision: 1.10
done
Checking in projects/projectuiapi/apichanges.xml;
/cvs/projects/projectuiapi/apichanges.xml,v  <--  apichanges.xml
new revision: 1.36; previous revision: 1.35
done
Checking in projects/projectuiapi/test/unit/src/org/netbeans/spi/project/ui/support/ProjectCustomizerListenersTest.java;
/cvs/projects/projectuiapi/test/unit/src/org/netbeans/spi/project/ui/support/ProjectCustomizerListenersTest.java,v  <--
 ProjectCustomizerListenersTest.java
new revision: 1.4; previous revision: 1.3
done
Checking in projects/projectapi/test/unit/src/org/netbeans/api/project/ProjectManagerTest.java;
/cvs/projects/projectapi/test/unit/src/org/netbeans/api/project/ProjectManagerTest.java,v  <--  ProjectManagerTest.java
new revision: 1.17; previous revision: 1.16
done
Checking in web/project/src/org/netbeans/modules/web/project/ui/customizer/CustomizerProviderImpl.java;
/cvs/web/project/src/org/netbeans/modules/web/project/ui/customizer/CustomizerProviderImpl.java,v  <-- 
CustomizerProviderImpl.java
new revision: 1.20; previous revision: 1.19
done
Checking in projects/projectuiapi/src/org/netbeans/spi/project/ui/support/ProjectCustomizer.java;
/cvs/projects/projectuiapi/src/org/netbeans/spi/project/ui/support/ProjectCustomizer.java,v  <--  ProjectCustomizer.java
new revision: 1.20; previous revision: 1.19
done

Fixed in EarProject as well. Thanks Milan for fixing this in Java EE area.

Checking in src/org/netbeans/modules/j2ee/earproject/ui/customizer/CustomizerProviderImpl.java;
/cvs/j2ee/earproject/src/org/netbeans/modules/j2ee/earproject/ui/customizer/CustomizerProviderImpl.java,v  <--  
CustomizerProviderImpl.java
new revision: 1.3; previous revision: 1.2
done

It seems that part of this fix was rollbacked by mkleint by fixing issue #44035 = reopening.

To make it clear - the only project type that doesn't contain this fix is j2seproject.

Pushed back again to main:

http://hg.netbeans.org/main/rev/7e9138744004

j2seproject fix won't be available for NetBeans 6.1 because the rollback was discovered late in the release cycle. Other
project types contain the fix.

Integrated into 'main-golden', will be available in build *200809200201* on http://bits.netbeans.org/dev/nightly/ (upload may still be in progress)
Changeset: http://hg.netbeans.org/main/rev/9839724a6882
User: Milan Kubec <mkubec@netbeans.org>
Log: #146072: reverting runAtomicAction part of the fix for issue #91291; might cause undefined behavior