osate / osate2

Open Source AADL2 Tool Environment
http://osate.org
Eclipse Public License 2.0
39 stars 8 forks source link

AADL resources which reference contributed properties are rebuilt needlessly #1145

Closed philip-alldredge closed 6 years ago

philip-alldredge commented 6 years ago

Summary

Xtext is rebuilding all open AADL resources which reference a contributed property set whenever any file in the workspace is changed. This was observed while debugging an issue with the graphical editor but the issue is not believed to be caused by the graphical editor.

With smaller workspaces, this is not likely to cause many issues. However, with larger workspaces, it can cause performance issues if many editors are open. It is troublesome for the graphical editor because moving a shape and saving results in rebuilding the Xtext resource.

Expected and Current Behavior

It is expected when a non-AADL resource changed in the workspace is changed, then it would not trigger any change to the AADL resources.

The current behavior is that when any change occurs in the workspace, document change notifications are sent for all AADL Xtext editors which have an Xtext document that references a contributed property set.

NOTE: Disabling the addition of contributed resources to "toBeBuilt" in PropertiesToBeBuiltComputerContribution causes the resource not to be built. Should there be a check to only build if the contributed resources have changed? Is such a change possible?

Steps to Reproduce

Even though it does not appear to be caused by the graphical editor, it is easier to notice with the graphical editor. However, is can also be noticed using the Progress view in OSATE.

  1. (Optional). Add a print statement inside of org.osate.ge.internal.ui.xtext.OpenAadlResources.createModelListener which prints the changed resource. System.err.println("CHANGED: " + openResource.uri);
  2. Create an AADL Project
  3. Create a simple AADL package which references a contributed property set.
  4. Open it in the text editor.
  5. Open the Progress view in OSATE.
  6. Make a change and save any file in the workspace. For example changing a file named "README.txt".
  7. The model listener created by org.osate.ge.internal.ui.xtext.OpenAadlResources.createModelListener is called. The Progress view will briefly show that it is rebuilding the workspace. An AUTO_BUILD is likely expected but rebuilding individual resources is not expected.

Example AADL package.

package test
public
    with ARINC653;
    system top
    end top;

    system implementation top.impl
    end top.impl;
end test;

Environment

lwrage commented 6 years ago

@philip-alldredge FYI: Xtext logs which files are built in the Xtext console if it's open.

lwrage commented 6 years ago

We will look at performance improvements in the scalability task.

lwrage commented 6 years ago

I cannot reproduce this. I see the following, instead: Whenever a modified files (form projects P and Q, say) are saved, a workspace build is triggered. During the build of projects P and Q, the contributed AADL files are processed but not when other projects in the workspace are being built. This is not optimal. As the contributed files haven't changed, they should only be processed during a full build.

philip-alldredge commented 6 years ago

As long as I have the AADL file which references such a property open, it occurs anytime a file in an AADL project is changed. If the file is in a non-AADL project, the change notification does not occur.

lwrage commented 6 years ago

I guess rebuilding of the open files happens because the the contributed property sets they depend on have been rebuilt. Turning off that build may solve the whole issue.

philip-alldredge commented 6 years ago

Agreed.