From 7bceaa063515fc4d00bf7c6d5cc0c6b788a6e48e Mon Sep 17 00:00:00 2001 From: Eyck Jentzsch Date: Sun, 15 Nov 2026 09:05:50 +0100 Subject: [PATCH] Fix database load lifecycle and stale transaction results --- .../database/internal/WaveformDb.java | 72 ++++---- .../internal/util/DatabaseLoadSession.java | 100 +++++++++++ .../internal/util/FileMonitor.java | 5 + .../application/internal/util/LatestJob.java | 56 ++++++ .../e4/application/parts/DesignBrowser.java | 49 ++--- .../e4/application/parts/TransactionList.java | 113 ++++++------ .../e4/application/parts/WaveformViewer.java | 167 +++++++----------- pom.xml | 1 + .../database/test/DatabaseLifecycleTest.java | 22 +++ .../.gitignore | 2 + .../META-INF/MANIFEST.MF | 9 + .../build.properties | 3 + .../pom.xml | 26 +++ .../util/DatabaseLoadSessionTest.java | 115 ++++++++++++ .../internal/util/LatestJobTest.java | 63 +++++++ 15 files changed, 594 insertions(+), 209 deletions(-) create mode 100644 plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/internal/util/DatabaseLoadSession.java create mode 100644 plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/internal/util/LatestJob.java create mode 100644 tests/com.minres.scviewer.e4.application.test/.gitignore create mode 100644 tests/com.minres.scviewer.e4.application.test/META-INF/MANIFEST.MF create mode 100644 tests/com.minres.scviewer.e4.application.test/build.properties create mode 100644 tests/com.minres.scviewer.e4.application.test/pom.xml create mode 100644 tests/com.minres.scviewer.e4.application.test/src/com/minres/scviewer/e4/application/internal/util/DatabaseLoadSessionTest.java create mode 100644 tests/com.minres.scviewer.e4.application.test/src/com/minres/scviewer/e4/application/internal/util/LatestJobTest.java diff --git a/plugins/com.minres.scviewer.database/src/com/minres/scviewer/database/internal/WaveformDb.java b/plugins/com.minres.scviewer.database/src/com/minres/scviewer/database/internal/WaveformDb.java index 6e24ec3..58a9a35 100644 --- a/plugins/com.minres.scviewer.database/src/com/minres/scviewer/database/internal/WaveformDb.java +++ b/plugins/com.minres.scviewer.database/src/com/minres/scviewer/database/internal/WaveformDb.java @@ -119,7 +119,19 @@ public class WaveformDb extends HierNode implements IWaveformDb, PropertyChangeL * @return true, if successful */ @Override - public synchronized boolean load(File inp) { + public boolean load(File inp) { + List notifications = new ArrayList<>(); + boolean result; + synchronized (this) { + result = loadLocked(inp, notifications); + } + // A listener may wait for the UI, which in turn may need close(). + // Never invoke external listeners while holding the database lock. + notifications.forEach(pcs::firePropertyChange); + return result; + } + + private boolean loadLocked(File inp, List notifications) { for (IWaveformDbLoaderFactory factory : getLoaders()) { if (!factory.canLoad(inp)) continue; IWaveformDbLoader loader = factory.getLoader(); @@ -146,13 +158,14 @@ public class WaveformDb extends HierNode implements IWaveformDb, PropertyChangeL if (name == null) name = getFileBasename(inp.getName()); for (RelationType type : types) if (!relationTypes.contains(type)) relationTypes.add(type); synchronized (pending) { - for (PropertyChangeEvent event : pending) propertyChange(event); + for (PropertyChangeEvent event : pending) applyWaveform(event); + if (!pending.isEmpty()) addWaveformNotifications(notifications); } loaded = true; - pcs.firePropertyChange(IHierNode.LOADING_FINISHED, null, Boolean.TRUE); + notifications.add(new PropertyChangeEvent(this, IHierNode.LOADING_FINISHED, null, Boolean.TRUE)); return true; } - pcs.firePropertyChange(IHierNode.LOADING_FINISHED, null, Boolean.FALSE); + notifications.add(new PropertyChangeEvent(this, IHierNode.LOADING_FINISHED, null, Boolean.FALSE)); return false; } @@ -197,37 +210,28 @@ public class WaveformDb extends HierNode implements IWaveformDb, PropertyChangeL @Override public void propertyChange(PropertyChangeEvent evt) { - if (IWaveformDbLoader.SIGNAL_ADDED.equals(evt.getPropertyName()) - || IWaveformDbLoader.STREAM_ADDED.equals(evt.getPropertyName())) { - IWaveform waveform = (IWaveform) evt.getNewValue(); - waveforms.put(waveform.getFullName(), waveform); - putInHierarchy(waveform); - pcs.firePropertyChange(IHierNode.WAVEFORMS, null, waveforms); - pcs.firePropertyChange(IHierNode.CHILDS, null, childNodes); - } else if (IWaveformDbLoader.GENERATOR_ADDED.equals(evt.getPropertyName())) { - IWaveform generator = (IWaveform) evt.getNewValue(); - waveforms.put(generator.getFullName(), generator); - pcs.firePropertyChange(IHierNode.WAVEFORMS, null, waveforms); - pcs.firePropertyChange(IHierNode.CHILDS, null, childNodes); - } - } + List notifications = new ArrayList<>(); + synchronized (this) { + if (applyWaveform(evt)) addWaveformNotifications(notifications); + } + notifications.forEach(pcs::firePropertyChange); + } - /** - * Builds the hierarchy nodes. - */ - private synchronized void buildHierarchyNodes() { - boolean needsSorting = false; - for (IWaveform stream : getAllWaves()) { - if (stream.getParent() == null) { - putInHierarchy(stream); - needsSorting = true; - } - } - if (needsSorting) { - pcs.firePropertyChange(IHierNode.WAVEFORMS, null, waveforms); - pcs.firePropertyChange(IHierNode.CHILDS, null, childNodes); - } - } + private boolean applyWaveform(PropertyChangeEvent evt) { + String property = evt.getPropertyName(); + if (!IWaveformDbLoader.SIGNAL_ADDED.equals(property) + && !IWaveformDbLoader.STREAM_ADDED.equals(property) + && !IWaveformDbLoader.GENERATOR_ADDED.equals(property)) return false; + IWaveform waveform = (IWaveform) evt.getNewValue(); + waveforms.put(waveform.getFullName(), waveform); + if (!IWaveformDbLoader.GENERATOR_ADDED.equals(property)) putInHierarchy(waveform); + return true; + } + + private void addWaveformNotifications(List notifications) { + notifications.add(new PropertyChangeEvent(this, IHierNode.WAVEFORMS, null, new HashMap<>(waveforms))); + notifications.add(new PropertyChangeEvent(this, IHierNode.CHILDS, null, new ArrayList<>(childNodes))); + } private synchronized void putInHierarchy(IWaveform waveform) { String[] hier = waveform.getName().split("\\."); diff --git a/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/internal/util/DatabaseLoadSession.java b/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/internal/util/DatabaseLoadSession.java new file mode 100644 index 0000000..da022d2 --- /dev/null +++ b/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/internal/util/DatabaseLoadSession.java @@ -0,0 +1,100 @@ +package com.minres.scviewer.e4.application.internal.util; + +import java.beans.PropertyChangeListener; +import java.io.File; +import java.util.List; +import java.util.function.Consumer; + +import org.eclipse.core.runtime.IProgressMonitor; +import org.eclipse.core.runtime.IStatus; +import org.eclipse.core.runtime.OperationCanceledException; +import org.eclipse.core.runtime.Status; +import org.eclipse.core.runtime.jobs.Job; + +import com.minres.scviewer.database.IWaveformDb; + +/** Owns one database and its background load, including cancellation and cleanup. */ +public final class DatabaseLoadSession implements AutoCloseable { + private final IWaveformDb database; + private final List files; + private final PropertyChangeListener listener; + private final Job job; + private volatile boolean cancelled; + private boolean closed; + + public DatabaseLoadSession(IWaveformDb database, List files, + PropertyChangeListener listener, Consumer completion) { + this.database = database; + this.files = List.copyOf(files); + this.listener = event -> { + if (!cancelled) listener.propertyChange(event); + }; + database.addPropertyChangeListener(this.listener); + job = new Job("Load Database") { + @Override + protected IStatus run(IProgressMonitor monitor) { + IStatus result; + synchronized (DatabaseLoadSession.this) { + try { + result = load(monitor); + } catch (OperationCanceledException e) { + result = Status.CANCEL_STATUS; + } catch (RuntimeException e) { + result = new Status(IStatus.ERROR, "com.minres.scviewer.e4.application", + "Cannot load database", e); + } finally { + monitor.done(); + } + } + if (!cancelled) completion.accept(result); + return result; + } + }; + job.setSystem(true); + } + + private IStatus load(IProgressMonitor monitor) { + monitor.beginTask("Load Database", files.size()); + for (File file : files) { + if (cancelled || monitor.isCanceled()) return Status.CANCEL_STATUS; + monitor.subTask(file.getName()); + if (!database.load(file)) { + return new Status(IStatus.ERROR, "com.minres.scviewer.e4.application", + "Cannot load " + file.getAbsolutePath()); + } + monitor.worked(1); + } + return cancelled || monitor.isCanceled() ? Status.CANCEL_STATUS : Status.OK_STATUS; + } + + public void schedule(long delay) { + job.schedule(delay); + } + + public boolean isCancelled() { + return cancelled; + } + + @Override + public void close() { + cancelled = true; + job.cancel(); + // A loader may not support interruption. Wait for it only on a worker, + // and close even when the load was cancelled before its job started. + Job cleanup = new Job("Close Database") { + @Override + protected IStatus run(IProgressMonitor monitor) { + synchronized (DatabaseLoadSession.this) { + if (!closed) { + closed = true; + database.removePropertyChangeListener(listener); + database.close(); + } + } + return Status.OK_STATUS; + } + }; + cleanup.setSystem(true); + cleanup.schedule(); + } +} diff --git a/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/internal/util/FileMonitor.java b/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/internal/util/FileMonitor.java index e933f98..818ce2e 100644 --- a/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/internal/util/FileMonitor.java +++ b/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/internal/util/FileMonitor.java @@ -43,6 +43,11 @@ public class FileMonitor { enabled=true; } + public void dispose() { + timer.cancel(); + timerEntries.clear(); + } + /** * Adds a monitored file with a FileChangeListener. * diff --git a/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/internal/util/LatestJob.java b/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/internal/util/LatestJob.java new file mode 100644 index 0000000..8eceb99 --- /dev/null +++ b/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/internal/util/LatestJob.java @@ -0,0 +1,56 @@ +package com.minres.scviewer.e4.application.internal.util; + +import java.util.concurrent.atomic.AtomicLong; +import java.util.function.Consumer; +import java.util.function.Function; + +import org.eclipse.core.runtime.IProgressMonitor; +import org.eclipse.core.runtime.IStatus; +import org.eclipse.core.runtime.Status; +import org.eclipse.core.runtime.jobs.Job; + +/** Publishes only the latest request, including when older results are already queued. */ +public final class LatestJob implements AutoCloseable { + private final AtomicLong generation = new AtomicLong(); + private final Consumer dispatch; + private final Consumer publish; + private Job job; + private volatile boolean closed; + + public LatestJob(Consumer dispatch, Consumer publish) { + this.dispatch = dispatch; + this.publish = publish; + } + + /** Called by the owning UI thread, as are cancel() and close(). */ + public void schedule(String name, Function query) { + if (closed) return; + cancel(); + final long request = generation.get(); + job = new Job(name) { + @Override + protected IStatus run(IProgressMonitor monitor) { + if (monitor.isCanceled()) return Status.CANCEL_STATUS; + T result = query.apply(monitor); + if (monitor.isCanceled() || closed || generation.get() != request) return Status.CANCEL_STATUS; + dispatch.accept(() -> { + if (!closed && generation.get() == request) publish.accept(result); + }); + return Status.OK_STATUS; + } + }; + job.setSystem(true); + job.schedule(); + } + + public void cancel() { + generation.incrementAndGet(); + if (job != null) job.cancel(); + } + + @Override + public void close() { + closed = true; + cancel(); + } +} diff --git a/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/parts/DesignBrowser.java b/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/parts/DesignBrowser.java index a224c12..ec828d9 100644 --- a/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/parts/DesignBrowser.java +++ b/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/parts/DesignBrowser.java @@ -28,6 +28,7 @@ import org.eclipse.e4.core.di.annotations.Optional; import org.eclipse.e4.core.services.events.IEventBroker; import org.eclipse.e4.ui.di.Focus; import org.eclipse.e4.ui.di.UIEventTopic; +import org.eclipse.e4.ui.di.UISynchronize; import org.eclipse.e4.ui.services.EMenuService; import org.eclipse.e4.ui.workbench.modeling.ESelectionService; import org.eclipse.jface.viewers.IContentProvider; @@ -83,6 +84,8 @@ public class DesignBrowser { /** The event broker. */ @Inject IEventBroker eventBroker; + @Inject UISynchronize sync; + /** The selection service. */ @Inject ESelectionService selectionService; @@ -123,23 +126,23 @@ public class DesignBrowser { /** The waveform viewer part. */ private WaveformViewer waveformViewerPart; + private IWaveformDb subscribedDatabase; + /** The tree viewer pcl. */ - private PropertyChangeListener treeViewerPCL = evt -> { - if(IHierNode.CHILDS.equals(evt.getPropertyName())){ //$NON-NLS-1$ - treeViewer.getTree().getDisplay().asyncExec(() -> treeViewer.refresh()); - } else if(IHierNode.WAVEFORMS.equals(evt.getPropertyName())) { - treeViewer.getTree().getDisplay().asyncExec(() -> { - treeViewer.setInput(new IWaveformDb[]{waveformViewerPart.getDatabase()}); - treeViewer.refresh(); - }); - } else if(IHierNode.LOADING_FINISHED.equals(evt.getPropertyName())) { - if(!treeViewer.getControl().isDisposed()) - treeViewer.getTree().getDisplay().asyncExec(() -> { - treeViewer.update(waveformViewerPart.getDatabase(), null); - DesignBrowser.this.updateButtons(); - }); + private PropertyChangeListener treeViewerPCL = evt -> sync.asyncExec(() -> { + if (treeViewer.getControl().isDisposed() || waveformViewerPart == null + || evt.getSource() != subscribedDatabase + || subscribedDatabase != waveformViewerPart.getDatabase()) return; + if (IHierNode.CHILDS.equals(evt.getPropertyName())) { + treeViewer.refresh(); + } else if (IHierNode.WAVEFORMS.equals(evt.getPropertyName())) { + treeViewer.setInput(new IWaveformDb[]{subscribedDatabase}); + treeViewer.refresh(); + } else if (IHierNode.LOADING_FINISHED.equals(evt.getPropertyName())) { + treeViewer.update(subscribedDatabase, null); + updateButtons(); } - }; + }); /** The sash paint listener. */ protected PaintListener sashPaintListener= e -> { @@ -167,6 +170,11 @@ public class DesignBrowser { createTreeViewerComposite(top); Composite bottom = new Composite(sashForm, SWT.NONE); createTableComposite(bottom); + parent.addDisposeListener(event -> { + if (subscribedDatabase != null) + subscribedDatabase.removePropertyChangeListener(treeViewerPCL); + subscribedDatabase = null; + }); sashForm.setWeights(new int[] {100, 100}); sashForm.SASH_WIDTH=5; @@ -372,14 +380,11 @@ public class DesignBrowser { setWaveformDb(database); } - @SuppressWarnings("unchecked") public void setWaveformDb(IWaveformDb database) { - Object input = treeViewer.getInput(); - if(input instanceof List){ - IWaveformDb db = ((List)input).get(0); - if(db==database) return; // do nothing if old and new database is the same - ((List)input).get(0).removePropertyChangeListener(treeViewerPCL); - } + if (subscribedDatabase == database) return; + if (subscribedDatabase != null) + subscribedDatabase.removePropertyChangeListener(treeViewerPCL); + subscribedDatabase = database; treeViewer.setInput(new IWaveformDb[]{database}); Object state=this.waveformViewerPart.retrieveDesignBrowerState(); if(state instanceof DBState) diff --git a/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/parts/TransactionList.java b/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/parts/TransactionList.java index 609f157..d7245cb 100644 --- a/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/parts/TransactionList.java +++ b/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/parts/TransactionList.java @@ -1,12 +1,12 @@ package com.minres.scviewer.e4.application.parts; import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collection; import java.util.List; -import java.util.concurrent.ConcurrentHashMap; +import java.util.HashMap; +import java.util.Map; import java.util.stream.Collectors; +import org.eclipse.core.runtime.OperationCanceledException; import org.eclipse.core.databinding.observable.list.ObservableList; import org.eclipse.core.databinding.observable.list.WritableList; import org.eclipse.jface.databinding.viewers.ObservableListContentProvider; @@ -19,6 +19,7 @@ import org.eclipse.jface.viewers.StructuredSelection; import org.eclipse.jface.viewers.TableViewer; import org.eclipse.jface.viewers.TableViewerColumn; import org.eclipse.swt.SWT; +import org.eclipse.swt.widgets.Display; import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.events.SelectionListener; import org.eclipse.swt.layout.FillLayout; @@ -35,9 +36,11 @@ import com.minres.scviewer.database.DataType; import com.minres.scviewer.database.EventEntry; import com.minres.scviewer.database.EventKind; import com.minres.scviewer.database.IWaveform; +import com.minres.scviewer.database.IEvent; import com.minres.scviewer.database.tx.ITx; import com.minres.scviewer.database.tx.ITxEvent; import com.minres.scviewer.database.ui.TrackEntry; +import com.minres.scviewer.e4.application.internal.util.LatestJob; import com.minres.scviewer.e4.application.parts.txTableTree.AbstractTransactionTreeContentProvider; import com.minres.scviewer.e4.application.parts.txTableTree.AttributeLabelProvider; import com.minres.scviewer.e4.application.parts.txTableTree.TransactionTreeNode; @@ -76,7 +79,9 @@ public class TransactionList extends Composite { private TableViewer tableViewer = null; - Thread updateThread = null; + private LatestJob updateJob; + + private record TransactionData(List transactions, List attributes) {} private TableColumn valueColumn = null; @@ -185,8 +190,8 @@ public class TransactionList extends Composite { @SuppressWarnings("unchecked") @Override public Object[] getElements(Object inputElement) { - if (inputElement instanceof ArrayList) { - return ((ArrayList) inputElement).stream().map(tx-> new TransactionTreeNode(tx, TransactionTreeNodeType.TX)).collect(Collectors.toList()).toArray(); + if (inputElement instanceof List) { + return ((List) inputElement).stream().map(tx-> new TransactionTreeNode(tx, TransactionTreeNodeType.TX)).collect(Collectors.toList()).toArray(); } return new Object[0]; } @@ -233,54 +238,60 @@ public class TransactionList extends Composite { // Turn on the header and the lines table.setHeaderVisible(true); table.setLinesVisible(true); + final Display display = getDisplay(); + updateJob = new LatestJob<>(task -> { + if (!display.isDisposed()) display.asyncExec(task); + }, data -> { + if (isDisposed()) return; + attrNames.addAll(data.attributes()); + if (!attrNames.isEmpty()) { + txFilter.setSearchProp(attrNames.get(0).getName(), attrNames.get(0).getType()); + txFilter.setSearchValue(searchPropValue.getText()); + } + tableViewer.setInput(data.transactions()); + searchPropComboViewer.refresh(); + viewPropComboViewer.refresh(); + }); + addDisposeListener(event -> { + updateJob.close(); + attrNames.dispose(); + }); } public void setInput(TrackEntry trackEntry) { - if(trackEntry==null || !trackEntry.waveform.getType().isTransaction()) { - attrNames.clear(); - tableViewer.setInput(emptyList); - } else if(stream != trackEntry.waveform) { - stream=trackEntry.waveform; - tableViewer.setInput(emptyList); - try{ - if(updateThread!=null) - updateThread.interrupt(); - }catch(SecurityException e){} - updateThread = new Thread(()-> { - final ConcurrentHashMap propNames=new ConcurrentHashMap<>(); - Collection values = stream.getEvents().entrySet(); - final List txList = values.parallelStream() - .map(e->e.events) - .map(Arrays::asList) - .flatMap(List::stream) - .filter(evt -> evt.getKind()==EventKind.BEGIN || evt.getKind()==EventKind.SINGLE) - .map(evt-> { - ITx tx = ((ITxEvent)evt).getTransaction(); - tx.getAttributes().forEach(attr -> propNames.put(attr.getName(), attr.getDataType())); - return tx; - }) - .sorted((t1, t2)-> Long.compare(t1.getBeginTime(),t2.getBeginTime())) - .collect(Collectors.toList()); - final List newAttrNames=propNames.entrySet().stream() - .sorted((e1,e2)->e1.getKey().compareTo(e2.getKey())) - .map(e -> new AttributeNameBean(e.getKey(), e.getValue())) - .collect(Collectors.toList()); - getDisplay().asyncExec(() -> { - if(tableViewer.getControl().isDisposed()) return; - tableViewer.setInput(txList); - attrNames.clear(); - attrNames.addAll(newAttrNames); - if(!attrNames.isEmpty()) - txFilter.setSearchProp(attrNames.get(0).getName(), attrNames.get(0).getType()); - if (searchPropComboViewer!=null) - searchPropComboViewer.refresh(); - if (viewPropComboViewer!=null) - viewPropComboViewer.refresh(); - }); - updateThread=null; - }); - updateThread.start(); - } + final IWaveform requestedStream = trackEntry != null && trackEntry.waveform.getType().isTransaction() + ? trackEntry.waveform : null; + if (requestedStream != null && stream == requestedStream) return; + updateJob.cancel(); + stream = requestedStream; + attrNames.clear(); + tableViewer.setInput(emptyList); + if (requestedStream == null) return; + + updateJob.schedule("Read transactions", monitor -> { + final Map propNames = new HashMap<>(); + final List txList = new ArrayList<>(); + if (monitor.isCanceled()) throw new OperationCanceledException(); + for (EventEntry entry : requestedStream.getEvents().entrySet()) { + if (monitor.isCanceled()) throw new OperationCanceledException(); + if (entry.events == null) continue; + for (IEvent event : entry.events) { + if (monitor.isCanceled()) throw new OperationCanceledException(); + if (event.getKind() == EventKind.BEGIN || event.getKind() == EventKind.SINGLE) { + ITx tx = ((ITxEvent) event).getTransaction(); + tx.getAttributes().forEach(attr -> propNames.put(attr.getName(), attr.getDataType())); + txList.add(tx); + } + } + } + if (monitor.isCanceled()) throw new OperationCanceledException(); + txList.sort((t1, t2) -> Long.compare(t1.getBeginTime(), t2.getBeginTime())); + final List newAttrNames = propNames.entrySet().stream() + .sorted(Map.Entry.comparingByKey()) + .map(e -> new AttributeNameBean(e.getKey(), e.getValue())) + .collect(Collectors.toList()); + return new TransactionData(txList, newAttrNames); + }); } public void setSearchProps(String propName, DataType type, String propValue) { diff --git a/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/parts/WaveformViewer.java b/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/parts/WaveformViewer.java index 2dd646a..0821e2b 100644 --- a/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/parts/WaveformViewer.java +++ b/plugins/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/parts/WaveformViewer.java @@ -33,12 +33,6 @@ import javax.inject.Inject; import javax.inject.Named; import org.eclipse.core.commands.ParameterizedCommand; -import org.eclipse.core.runtime.IProgressMonitor; -import org.eclipse.core.runtime.IStatus; -import org.eclipse.core.runtime.OperationCanceledException; -import org.eclipse.core.runtime.Status; -import org.eclipse.core.runtime.jobs.Job; -import org.eclipse.core.runtime.jobs.JobGroup; import org.eclipse.core.runtime.preferences.IEclipsePreferences; import org.eclipse.core.runtime.preferences.IEclipsePreferences.IPreferenceChangeListener; import org.eclipse.core.runtime.preferences.IEclipsePreferences.PreferenceChangeEvent; @@ -110,6 +104,7 @@ import com.minres.scviewer.database.ui.swt.WaveformViewFactory; import com.minres.scviewer.e4.application.AppModelId; import com.minres.scviewer.e4.application.Messages; import com.minres.scviewer.e4.application.internal.status.WaveStatusBarControl; +import com.minres.scviewer.e4.application.internal.util.DatabaseLoadSession; import com.minres.scviewer.e4.application.internal.util.FileMonitor; import com.minres.scviewer.e4.application.internal.util.IFileChangeListener; import com.minres.scviewer.e4.application.internal.util.IModificationChecker; @@ -209,6 +204,10 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis /** The database. */ private IWaveformDb database; + private volatile DatabaseLoadSession loadSession; + + private volatile boolean disposed; + /** The check for updates. */ private boolean checkForUpdates; @@ -271,11 +270,6 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis store=prefs; showHover=hover; database = dbFactory.getDatabase(); - database.addPropertyChangeListener(evt -> { - if (IHierNode.WAVEFORMS.equals(evt.getPropertyName())) { //$NON-NLS-1$ - myParent.getDisplay().syncExec(() -> waveformPane.setMaxTime(database.getMaxTime())); - } - }); parent.setLayout(new FillLayout(SWT.HORIZONTAL)); IEclipseContext ctx = myPart.getContext(); @@ -404,7 +398,7 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis ePartService.addPartListener(new PartListener() { @Override public void partActivated(MPart part) { - if (part == myPart) { + if (part == myPart && !disposed) { if (fileChecker != null) fileChecker.check(); updateAll(); @@ -511,8 +505,11 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis @PreDestroy public void closeDatabase() { - if(database.isLoaded()) - database.close(); + if (disposed) return; + disposed = true; + fileMonitor.dispose(); + fileChecker = null; + if (loadSession != null) loadSession.close(); } @Inject @@ -537,6 +534,7 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis @Inject @Optional public void reactOnReloadDatabaseChange(@Preference(nodePath = PreferenceConstants.PREFERENCES_SCOPE, value = PreferenceConstants.DATABASE_RELOAD) Boolean checkForUpdates) { + if (disposed) return; if (checkForUpdates.booleanValue()) { fileChecker = fileMonitor.addFileChangeListener(WaveformViewer.this, filesToLoad, FILE_CHECK_INTERVAL); } else { @@ -550,89 +548,63 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis */ @Override public void preferenceChange(PreferenceChangeEvent event) { - if (!PreferenceConstants.DATABASE_RELOAD.equals(event.getKey()) && !PreferenceConstants.SHOW_HOVER.equals(event.getKey())){ - waveformPane.setStyleProvider(new WaveformStyleProvider(store)); } - } - - class DbLoadJob extends Job { - final File file; - public DbLoadJob(String name, final File file) { - super(name); - this.file=file; - } - - @Override - protected IStatus run(IProgressMonitor monitor) { - boolean res = database.load(file); - database.addPropertyChangeListener(waveformPane); - return res?Status.OK_STATUS:Status.CANCEL_STATUS; + if (!PreferenceConstants.DATABASE_RELOAD.equals(event.getKey()) && !PreferenceConstants.SHOW_HOVER.equals(event.getKey())) { + sync.asyncExec(() -> { + if (!disposed && waveformPane != null && !myParent.isDisposed()) + waveformPane.setStyleProvider(new WaveformStyleProvider(store)); + }); } } - /** - * Load database. - * - * @param state the state - */ + protected void loadDatabase(final Map state) { loadDatabase(state, 1000L); } protected void loadDatabase(final Map state, long delay) { + if (disposed) return; fileMonitor.removeFileChangeListener(this); - database.setName(filesToLoad.stream().map(File::getName).reduce(null, (prefix, element) -> prefix==null? element : prefix + ","+ element)); - Job job = new Job(Messages.WaveformViewer_15) { - @Override - protected IStatus run(IProgressMonitor monitor) { - IProgressMonitor progressGroup = getJobManager().createProgressGroup(); - JobGroup jobGroup = new JobGroup(Messages.WaveformViewer_15, filesToLoad.size(), filesToLoad.size()); - filesToLoad.forEach((final File file) -> { - Job job = new DbLoadJob(Messages.WaveformViewer_16 + file.getName(), file); - job.setProgressGroup(progressGroup, 1); - job.setJobGroup(jobGroup); - job.schedule(); + fileChecker = null; + if (loadSession != null) { + setSelection(null); + loadSession.close(); + waveformPane.getStreamList().clear(); + waveformPane.update(); + database = dbFactory.getDatabase(); + } + final IWaveformDb requestedDatabase = database; + final List requestedFiles = List.copyOf(filesToLoad); + final Map requestedState = state == null ? Map.of() : new HashMap<>(state); + final String requestedConfig = partConfig; + requestedDatabase.setName(requestedFiles.stream().map(File::getName).collect(java.util.stream.Collectors.joining(","))); + myPart.getContext().set(IWaveformDb.class, requestedDatabase); + loadSession = new DatabaseLoadSession(requestedDatabase, requestedFiles, event -> { + if (IHierNode.WAVEFORMS.equals(event.getPropertyName()) + || IHierNode.LOADING_FINISHED.equals(event.getPropertyName())) { + sync.asyncExec(() -> { + if (isCurrentDatabase(requestedDatabase)) + waveformPane.setMaxTime(requestedDatabase.getMaxTime()); }); - try { - jobGroup.join(0, monitor); - } catch (OperationCanceledException e) { - throw new OperationCanceledException(Messages.WaveformViewer_14); - }catch (InterruptedException e) { - // Restore interrupted state... - Thread.currentThread().interrupt(); - throw new OperationCanceledException(Messages.WaveformViewer_14); - } - if (monitor.isCanceled()) - throw new OperationCanceledException(Messages.WaveformViewer_14); - - - IStatus result = jobGroup.getResult(); - if( (!result.isMultiStatus() && result.getCode() != Status.OK_STATUS.getCode() ) || - (result.isMultiStatus() && result.getChildren().length > 0 && result.getChildren()[0].getCode() != Status.OK_STATUS.getCode() ) ){ - // kill editor and pop up warning for user - sync.asyncExec(() -> { - if(myParent.isDisposed()) return; - final Display display = myParent.getDisplay(); - MessageDialog.openWarning(display.getActiveShell(), "Error loading database", "Database cannot be loaded. Aborting..."); - ePartService.hidePart(myPart, true); - }); - } else - sync.asyncExec(()->{ - waveformPane.setMaxTime(database.getMaxTime()); - if(partConfig!=null && !partConfig.isEmpty()) - loadState(partConfig); - if (state != null && !state.isEmpty()) - restoreWaveformViewerState(state); - if(designBrowser!=null) - designBrowser.setWaveformDb(database); - fileChecker = null; - if (checkForUpdates) - fileChecker = fileMonitor.addFileChangeListener(WaveformViewer.this, filesToLoad, FILE_CHECK_INTERVAL); - }); - return result; } - }; - job.setName("Load Database"); - job.setSystem(true); - job.schedule(delay); // let the UI initialize so that we have a progress monitor + }, result -> sync.asyncExec(() -> { + if (!isCurrentDatabase(requestedDatabase)) return; + if (!result.isOK()) { + MessageDialog.openWarning(myParent.getShell(), "Error loading database", result.getMessage()); + ePartService.hidePart(myPart, true); + return; + } + waveformPane.setMaxTime(requestedDatabase.getMaxTime()); + if (requestedConfig != null && !requestedConfig.isEmpty()) loadState(requestedConfig); + if (!requestedState.isEmpty()) restoreWaveformViewerState(requestedState); + if (designBrowser != null) designBrowser.setWaveformDb(requestedDatabase); + if (checkForUpdates) + fileChecker = fileMonitor.addFileChangeListener(this, requestedFiles, FILE_CHECK_INTERVAL); + })); + loadSession.schedule(delay); + } + + private boolean isCurrentDatabase(IWaveformDb requestedDatabase) { + return !disposed && !myParent.isDisposed() && database == requestedDatabase + && loadSession != null && !loadSession.isCancelled(); } /* (non-Javadoc) @@ -640,30 +612,20 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis */ @Override public void fileChanged(List file) { - final Display display = myParent.getDisplay(); - display.asyncExec(() -> { - if (MessageDialog.openQuestion(display.getActiveShell(), Messages.WaveformViewer_17, + final DatabaseLoadSession requestedSession = loadSession; + fileMonitor.removeFileChangeListener(this); + sync.asyncExec(() -> { + if (disposed || myParent.isDisposed() || loadSession != requestedSession) return; + if (MessageDialog.openQuestion(myParent.getShell(), Messages.WaveformViewer_17, Messages.WaveformViewer_18)) { reloadDatabase(); } }); - fileMonitor.removeFileChangeListener(this); } public void reloadDatabase() { Map state = new HashMap<>(); saveWaveformViewerState(state); - setSelection(null); - waveformPane.getStreamList().clear(); - waveformPane.update(); - if(database.isLoaded()) - database.close(); - database = dbFactory.getDatabase(); - database.addPropertyChangeListener(evt -> { - if (IHierNode.WAVEFORMS.equals(evt.getPropertyName()) || IHierNode.LOADING_FINISHED.equals(evt.getPropertyName())) { //$NON-NLS-1$ - myParent.getDisplay().syncExec(() -> waveformPane.setMaxTime(database.getMaxTime())); - } - }); if (!filesToLoad.isEmpty()) loadDatabase(state, 0L); } @@ -1259,6 +1221,7 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis * @param e */ public void widgetDisposed(DisposeEvent e) { + closeDatabase(); disposeListenerNumber -= 1; if( disposeListenerNumber == 0) { //if the last tab is closed, reset statusbar eventBroker.post(WaveStatusBarControl.CURSOR_TIME, null); diff --git a/pom.xml b/pom.xml index 0b42fbc..147fc4c 100644 --- a/pom.xml +++ b/pom.xml @@ -18,6 +18,7 @@ tests/com.minres.scviewer.database.test plugins/com.minres.scviewer.database.ui.swt plugins/com.minres.scviewer.e4.application + tests/com.minres.scviewer.e4.application.test plugins/com.minres.scviewer.e4.application.help plugins/com.minres.scviewer.ui features/com.minres.scviewer.database.feature diff --git a/tests/com.minres.scviewer.database.test/src/com/minres/scviewer/database/test/DatabaseLifecycleTest.java b/tests/com.minres.scviewer.database.test/src/com/minres/scviewer/database/test/DatabaseLifecycleTest.java index cf2e103..d7e90df 100644 --- a/tests/com.minres.scviewer.database.test/src/com/minres/scviewer/database/test/DatabaseLifecycleTest.java +++ b/tests/com.minres.scviewer.database.test/src/com/minres/scviewer/database/test/DatabaseLifecycleTest.java @@ -71,6 +71,28 @@ public class DatabaseLifecycleTest { } finally { db.unbind(factory);db.close(); } } + @Test + public void notificationsRunOutsideDatabaseLockAndSeeCommittedState() { + WaveformDb db = new WaveformDb(); + Loader loader = new Loader(false); + IWaveformDbLoaderFactory factory = factory(loader); + db.bind(factory); + java.util.List notifications = new java.util.ArrayList<>(); + db.addPropertyChangeListener(event -> { + assertFalse("Listeners must be able to hand work to a thread calling close()", Thread.holdsLock(db)); + assertTrue(db.isLoaded()); + assertEquals(100, db.getMaxTime()); + assertEquals(1, db.getAllWaves().size()); + notifications.add(event.getPropertyName()); + }); + try { + assertTrue(db.load(new File("success.review"))); + assertTrue(notifications.contains(IHierNode.WAVEFORMS)); + assertTrue(notifications.contains(IHierNode.CHILDS)); + assertTrue(notifications.contains(IHierNode.LOADING_FINISHED)); + } finally { db.unbind(factory); db.close(); } + } + @Test public void invalidFtrFailsAndLoaderCanBeReusedAfterDisposal() throws Exception { FtrDbLoader loader = new FtrDbLoader();Path invalid = Files.createTempFile("invalid-ftr-", ".ftr"); diff --git a/tests/com.minres.scviewer.e4.application.test/.gitignore b/tests/com.minres.scviewer.e4.application.test/.gitignore new file mode 100644 index 0000000..0f63015 --- /dev/null +++ b/tests/com.minres.scviewer.e4.application.test/.gitignore @@ -0,0 +1,2 @@ +/target/ +/bin/ diff --git a/tests/com.minres.scviewer.e4.application.test/META-INF/MANIFEST.MF b/tests/com.minres.scviewer.e4.application.test/META-INF/MANIFEST.MF new file mode 100644 index 0000000..20d67bb --- /dev/null +++ b/tests/com.minres.scviewer.e4.application.test/META-INF/MANIFEST.MF @@ -0,0 +1,9 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: SCViewer application tests +Bundle-SymbolicName: com.minres.scviewer.e4.application.test +Bundle-Version: 2.19.6 +Fragment-Host: com.minres.scviewer.e4.application +Bundle-RequiredExecutionEnvironment: JavaSE-17 +Require-Bundle: org.junit + diff --git a/tests/com.minres.scviewer.e4.application.test/build.properties b/tests/com.minres.scviewer.e4.application.test/build.properties new file mode 100644 index 0000000..5113c5f --- /dev/null +++ b/tests/com.minres.scviewer.e4.application.test/build.properties @@ -0,0 +1,3 @@ +bin.includes = META-INF/,\ + . +source.. = src/ diff --git a/tests/com.minres.scviewer.e4.application.test/pom.xml b/tests/com.minres.scviewer.e4.application.test/pom.xml new file mode 100644 index 0000000..5cd3038 --- /dev/null +++ b/tests/com.minres.scviewer.e4.application.test/pom.xml @@ -0,0 +1,26 @@ + + 4.0.0 + com.minres.scviewer.e4.application.test + 2.19.6 + + com.minres.scviewer + com.minres.scviewer.parent + 2.19.6 + ../.. + + eclipse-test-plugin + + + + org.eclipse.tycho + tycho-surefire-plugin + ${tycho-version} + + false + false + + + + + diff --git a/tests/com.minres.scviewer.e4.application.test/src/com/minres/scviewer/e4/application/internal/util/DatabaseLoadSessionTest.java b/tests/com.minres.scviewer.e4.application.test/src/com/minres/scviewer/e4/application/internal/util/DatabaseLoadSessionTest.java new file mode 100644 index 0000000..9fbace8 --- /dev/null +++ b/tests/com.minres.scviewer.e4.application.test/src/com/minres/scviewer/e4/application/internal/util/DatabaseLoadSessionTest.java @@ -0,0 +1,115 @@ +package com.minres.scviewer.e4.application.internal.util; + +import static org.junit.Assert.*; + +import java.io.File; +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicReference; + +import org.eclipse.core.runtime.IStatus; +import org.junit.Test; + +import com.minres.scviewer.database.HierNode; +import com.minres.scviewer.database.IHierNode; +import com.minres.scviewer.database.IWaveform; +import com.minres.scviewer.database.IWaveformDb; +import com.minres.scviewer.database.RelationType; + +public class DatabaseLoadSessionTest { + private static class Database extends HierNode implements IWaveformDb { + final List loadedFiles = new ArrayList<>(); + final CountDownLatch entered = new CountDownLatch(1); + final CountDownLatch release = new CountDownLatch(1); + final CountDownLatch closed = new CountDownLatch(1); + boolean block; + boolean success = true; + int listenersAtClose; + + @Override public boolean load(File file) { + loadedFiles.add(file); + entered.countDown(); + if (block) { + boolean done = false; + while (!done) { + try { done = release.await(5, TimeUnit.SECONDS); } + catch (InterruptedException e) { /* Simulate a loader that cannot be interrupted. */ } + } + } + pcs.firePropertyChange(IHierNode.LOADING_FINISHED, null, success); + return success; + } + @Override public void close() { + listenersAtClose = pcs.getPropertyChangeListeners().length; + closed.countDown(); + } + @Override public boolean isLoaded() { return !loadedFiles.isEmpty(); } + @Override public long getMaxTime() { return 0; } + @Override public IWaveform getStreamByName(String name) { return null; } + @Override public List getAllWaves() { return List.of(); } + @Override public List getAllRelationTypes() { return List.of(); } + } + + @Test(timeout = 10000) + public void closeDuringLoadDoesNotWaitOrPublishAndSkipsRemainingFiles() throws Exception { + Database db = new Database(); + db.block = true; + AtomicInteger notifications = new AtomicInteger(); + AtomicInteger completions = new AtomicInteger(); + DatabaseLoadSession session = new DatabaseLoadSession(db, + List.of(new File("first"), new File("second")), + event -> notifications.incrementAndGet(), status -> completions.incrementAndGet()); + try { + session.schedule(0); + assertTrue(db.entered.await(5, TimeUnit.SECONDS)); + session.close(); + assertTrue(session.isCancelled()); + assertEquals("Database must remain open while its loader is using it", 1, db.closed.getCount()); + db.release.countDown(); + assertTrue(db.closed.await(5, TimeUnit.SECONDS)); + assertEquals(List.of(new File("first")), db.loadedFiles); + assertEquals(0, notifications.get()); + assertEquals(0, completions.get()); + assertEquals(0, db.listenersAtClose); + } finally { + db.release.countDown(); + session.close(); + } + } + + @Test(timeout = 10000) + public void closeBeforeScheduledLoadStillReleasesDatabase() throws Exception { + Database db = new Database(); + DatabaseLoadSession session = new DatabaseLoadSession(db, List.of(new File("first")), + event -> fail("Cancelled load must not notify"), status -> fail("Cancelled load must not finish")); + session.schedule(60000); + session.close(); + assertTrue(db.closed.await(5, TimeUnit.SECONDS)); + assertTrue(db.loadedFiles.isEmpty()); + assertEquals(0, db.listenersAtClose); + } + + @Test(timeout = 10000) + public void fileListIsSnapshottedAndFirstFailureStopsTheLoad() throws Exception { + Database db = new Database(); + db.success = false; + List files = new ArrayList<>(List.of(new File("first"), new File("second"))); + AtomicReference result = new AtomicReference<>(); + CountDownLatch completed = new CountDownLatch(1); + DatabaseLoadSession session = new DatabaseLoadSession(db, files, event -> {}, status -> { + result.set(status); + completed.countDown(); + }); + try { + files.clear(); + session.schedule(0); + assertTrue(completed.await(5, TimeUnit.SECONDS)); + assertEquals(List.of(new File("first")), db.loadedFiles); + assertEquals(IStatus.ERROR, result.get().getSeverity()); + assertTrue(result.get().getMessage().contains("first")); + } finally { session.close(); } + } +} diff --git a/tests/com.minres.scviewer.e4.application.test/src/com/minres/scviewer/e4/application/internal/util/LatestJobTest.java b/tests/com.minres.scviewer.e4.application.test/src/com/minres/scviewer/e4/application/internal/util/LatestJobTest.java new file mode 100644 index 0000000..d464ab3 --- /dev/null +++ b/tests/com.minres.scviewer.e4.application.test/src/com/minres/scviewer/e4/application/internal/util/LatestJobTest.java @@ -0,0 +1,63 @@ +package com.minres.scviewer.e4.application.internal.util; + +import static org.junit.Assert.*; + +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.BlockingQueue; +import java.util.concurrent.LinkedBlockingQueue; +import java.util.concurrent.TimeUnit; + +import org.junit.Test; + +public class LatestJobTest { + private Runnable take(BlockingQueue queue) throws InterruptedException { + Runnable result = queue.poll(5, TimeUnit.SECONDS); + assertNotNull("Background result was not queued", result); + return result; + } + + @Test + public void olderQueuedResultCannotOverwriteNewSelection() throws Exception { + BlockingQueue ui = new LinkedBlockingQueue<>(); + List displayed = new ArrayList<>(); + try (LatestJob query = new LatestJob<>(ui::add, displayed::add)) { + query.schedule("old selection", monitor -> "old"); + Runnable old = take(ui); + query.schedule("new selection", monitor -> "new"); + Runnable current = take(ui); + current.run(); + old.run(); + assertEquals(List.of("new"), displayed); + } + } + + @Test + public void clearingAndReselectingInputInvalidatesPendingResults() throws Exception { + BlockingQueue ui = new LinkedBlockingQueue<>(); + List displayed = new ArrayList<>(); + try (LatestJob query = new LatestJob<>(ui::add, displayed::add)) { + query.schedule("selection", monitor -> "stream"); + Runnable beforeClear = take(ui); + query.cancel(); + beforeClear.run(); + assertTrue(displayed.isEmpty()); + query.schedule("same selection", monitor -> "stream"); + take(ui).run(); + assertEquals(List.of("stream"), displayed); + } + } + + @Test + public void closingDiscardsQueuedResultsAndPreventsNewWork() throws Exception { + BlockingQueue ui = new LinkedBlockingQueue<>(); + List displayed = new ArrayList<>(); + LatestJob query = new LatestJob<>(ui::add, displayed::add); + query.schedule("selection", monitor -> "stream"); + Runnable queued = take(ui); + query.close(); + queued.run(); + query.schedule("closed", monitor -> { fail("Disposed query must not run"); return ""; }); + assertTrue(displayed.isEmpty()); + } +}