Fix database load lifecycle and stale transaction results

This commit is contained in:
eyck committed 2026-11-15 09:05:50 +01:00
1 parent d48fa68280
commit 7bceaa0635
15 files changed
+594 -209

No files matched your search

@@ -119,7 +119,19 @@ public class WaveformDb extends HierNode implements IWaveformDb, PropertyChangeL
* @return true, if successful * @return true, if successful
*/ */
@Override @Override
public synchronized boolean load(File inp) { public boolean load(File inp) {
List<PropertyChangeEvent> 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<PropertyChangeEvent> notifications) {
for (IWaveformDbLoaderFactory factory : getLoaders()) { for (IWaveformDbLoaderFactory factory : getLoaders()) {
if (!factory.canLoad(inp)) continue; if (!factory.canLoad(inp)) continue;
IWaveformDbLoader loader = factory.getLoader(); IWaveformDbLoader loader = factory.getLoader();
@@ -146,13 +158,14 @@ public class WaveformDb extends HierNode implements IWaveformDb, PropertyChangeL
if (name == null) name = getFileBasename(inp.getName()); if (name == null) name = getFileBasename(inp.getName());
for (RelationType type : types) if (!relationTypes.contains(type)) relationTypes.add(type); for (RelationType type : types) if (!relationTypes.contains(type)) relationTypes.add(type);
synchronized (pending) { synchronized (pending) {
for (PropertyChangeEvent event : pending) propertyChange(event); for (PropertyChangeEvent event : pending) applyWaveform(event);
if (!pending.isEmpty()) addWaveformNotifications(notifications);
} }
loaded = true; loaded = true;
pcs.firePropertyChange(IHierNode.LOADING_FINISHED, null, Boolean.TRUE); notifications.add(new PropertyChangeEvent(this, IHierNode.LOADING_FINISHED, null, Boolean.TRUE));
return true; return true;
} }
pcs.firePropertyChange(IHierNode.LOADING_FINISHED, null, Boolean.FALSE); notifications.add(new PropertyChangeEvent(this, IHierNode.LOADING_FINISHED, null, Boolean.FALSE));
return false; return false;
} }
@@ -197,37 +210,28 @@ public class WaveformDb extends HierNode implements IWaveformDb, PropertyChangeL
@Override @Override
public void propertyChange(PropertyChangeEvent evt) { public void propertyChange(PropertyChangeEvent evt) {
if (IWaveformDbLoader.SIGNAL_ADDED.equals(evt.getPropertyName()) List<PropertyChangeEvent> notifications = new ArrayList<>();
|| IWaveformDbLoader.STREAM_ADDED.equals(evt.getPropertyName())) { synchronized (this) {
IWaveform waveform = (IWaveform) evt.getNewValue(); if (applyWaveform(evt)) addWaveformNotifications(notifications);
waveforms.put(waveform.getFullName(), waveform); }
putInHierarchy(waveform); notifications.forEach(pcs::firePropertyChange);
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);
}
}
/** private boolean applyWaveform(PropertyChangeEvent evt) {
* Builds the hierarchy nodes. String property = evt.getPropertyName();
*/ if (!IWaveformDbLoader.SIGNAL_ADDED.equals(property)
private synchronized void buildHierarchyNodes() { && !IWaveformDbLoader.STREAM_ADDED.equals(property)
boolean needsSorting = false; && !IWaveformDbLoader.GENERATOR_ADDED.equals(property)) return false;
for (IWaveform stream : getAllWaves()) { IWaveform waveform = (IWaveform) evt.getNewValue();
if (stream.getParent() == null) { waveforms.put(waveform.getFullName(), waveform);
putInHierarchy(stream); if (!IWaveformDbLoader.GENERATOR_ADDED.equals(property)) putInHierarchy(waveform);
needsSorting = true; return true;
} }
}
if (needsSorting) { private void addWaveformNotifications(List<PropertyChangeEvent> notifications) {
pcs.firePropertyChange(IHierNode.WAVEFORMS, null, waveforms); notifications.add(new PropertyChangeEvent(this, IHierNode.WAVEFORMS, null, new HashMap<>(waveforms)));
pcs.firePropertyChange(IHierNode.CHILDS, null, childNodes); notifications.add(new PropertyChangeEvent(this, IHierNode.CHILDS, null, new ArrayList<>(childNodes)));
} }
}
private synchronized void putInHierarchy(IWaveform waveform) { private synchronized void putInHierarchy(IWaveform waveform) {
String[] hier = waveform.getName().split("\\."); String[] hier = waveform.getName().split("\\.");
@@ -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<File> files;
private final PropertyChangeListener listener;
private final Job job;
private volatile boolean cancelled;
private boolean closed;
public DatabaseLoadSession(IWaveformDb database, List<File> files,
PropertyChangeListener listener, Consumer<IStatus> 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();
}
}
@@ -43,6 +43,11 @@ public class FileMonitor {
enabled=true; enabled=true;
} }
public void dispose() {
timer.cancel();
timerEntries.clear();
}
/** /**
* Adds a monitored file with a FileChangeListener. * Adds a monitored file with a FileChangeListener.
* *
@@ -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<T> implements AutoCloseable {
private final AtomicLong generation = new AtomicLong();
private final Consumer<Runnable> dispatch;
private final Consumer<T> publish;
private Job job;
private volatile boolean closed;
public LatestJob(Consumer<Runnable> dispatch, Consumer<T> publish) {
this.dispatch = dispatch;
this.publish = publish;
}
/** Called by the owning UI thread, as are cancel() and close(). */
public void schedule(String name, Function<IProgressMonitor, T> 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();
}
}
@@ -28,6 +28,7 @@ import org.eclipse.e4.core.di.annotations.Optional;
import org.eclipse.e4.core.services.events.IEventBroker; import org.eclipse.e4.core.services.events.IEventBroker;
import org.eclipse.e4.ui.di.Focus; import org.eclipse.e4.ui.di.Focus;
import org.eclipse.e4.ui.di.UIEventTopic; 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.services.EMenuService;
import org.eclipse.e4.ui.workbench.modeling.ESelectionService; import org.eclipse.e4.ui.workbench.modeling.ESelectionService;
import org.eclipse.jface.viewers.IContentProvider; import org.eclipse.jface.viewers.IContentProvider;
@@ -83,6 +84,8 @@ public class DesignBrowser {
/** The event broker. */ /** The event broker. */
@Inject IEventBroker eventBroker; @Inject IEventBroker eventBroker;
@Inject UISynchronize sync;
/** The selection service. */ /** The selection service. */
@Inject ESelectionService selectionService; @Inject ESelectionService selectionService;
@@ -123,23 +126,23 @@ public class DesignBrowser {
/** The waveform viewer part. */ /** The waveform viewer part. */
private WaveformViewer waveformViewerPart; private WaveformViewer waveformViewerPart;
private IWaveformDb subscribedDatabase;
/** The tree viewer pcl. */ /** The tree viewer pcl. */
private PropertyChangeListener treeViewerPCL = evt -> { private PropertyChangeListener treeViewerPCL = evt -> sync.asyncExec(() -> {
if(IHierNode.CHILDS.equals(evt.getPropertyName())){ //$NON-NLS-1$ if (treeViewer.getControl().isDisposed() || waveformViewerPart == null
treeViewer.getTree().getDisplay().asyncExec(() -> treeViewer.refresh()); || evt.getSource() != subscribedDatabase
} else if(IHierNode.WAVEFORMS.equals(evt.getPropertyName())) { || subscribedDatabase != waveformViewerPart.getDatabase()) return;
treeViewer.getTree().getDisplay().asyncExec(() -> { if (IHierNode.CHILDS.equals(evt.getPropertyName())) {
treeViewer.setInput(new IWaveformDb[]{waveformViewerPart.getDatabase()}); treeViewer.refresh();
treeViewer.refresh(); } else if (IHierNode.WAVEFORMS.equals(evt.getPropertyName())) {
}); treeViewer.setInput(new IWaveformDb[]{subscribedDatabase});
} else if(IHierNode.LOADING_FINISHED.equals(evt.getPropertyName())) { treeViewer.refresh();
if(!treeViewer.getControl().isDisposed()) } else if (IHierNode.LOADING_FINISHED.equals(evt.getPropertyName())) {
treeViewer.getTree().getDisplay().asyncExec(() -> { treeViewer.update(subscribedDatabase, null);
treeViewer.update(waveformViewerPart.getDatabase(), null); updateButtons();
DesignBrowser.this.updateButtons();
});
} }
}; });
/** The sash paint listener. */ /** The sash paint listener. */
protected PaintListener sashPaintListener= e -> { protected PaintListener sashPaintListener= e -> {
@@ -167,6 +170,11 @@ public class DesignBrowser {
createTreeViewerComposite(top); createTreeViewerComposite(top);
Composite bottom = new Composite(sashForm, SWT.NONE); Composite bottom = new Composite(sashForm, SWT.NONE);
createTableComposite(bottom); createTableComposite(bottom);
parent.addDisposeListener(event -> {
if (subscribedDatabase != null)
subscribedDatabase.removePropertyChangeListener(treeViewerPCL);
subscribedDatabase = null;
});
sashForm.setWeights(new int[] {100, 100}); sashForm.setWeights(new int[] {100, 100});
sashForm.SASH_WIDTH=5; sashForm.SASH_WIDTH=5;
@@ -372,14 +380,11 @@ public class DesignBrowser {
setWaveformDb(database); setWaveformDb(database);
} }
@SuppressWarnings("unchecked")
public void setWaveformDb(IWaveformDb database) { public void setWaveformDb(IWaveformDb database) {
Object input = treeViewer.getInput(); if (subscribedDatabase == database) return;
if(input instanceof List<?>){ if (subscribedDatabase != null)
IWaveformDb db = ((List<IWaveformDb>)input).get(0); subscribedDatabase.removePropertyChangeListener(treeViewerPCL);
if(db==database) return; // do nothing if old and new database is the same subscribedDatabase = database;
((List<IWaveformDb>)input).get(0).removePropertyChangeListener(treeViewerPCL);
}
treeViewer.setInput(new IWaveformDb[]{database}); treeViewer.setInput(new IWaveformDb[]{database});
Object state=this.waveformViewerPart.retrieveDesignBrowerState(); Object state=this.waveformViewerPart.retrieveDesignBrowerState();
if(state instanceof DBState) if(state instanceof DBState)
@@ -1,12 +1,12 @@
package com.minres.scviewer.e4.application.parts; package com.minres.scviewer.e4.application.parts;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List; import java.util.List;
import java.util.concurrent.ConcurrentHashMap; import java.util.HashMap;
import java.util.Map;
import java.util.stream.Collectors; 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.ObservableList;
import org.eclipse.core.databinding.observable.list.WritableList; import org.eclipse.core.databinding.observable.list.WritableList;
import org.eclipse.jface.databinding.viewers.ObservableListContentProvider; 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.TableViewer;
import org.eclipse.jface.viewers.TableViewerColumn; import org.eclipse.jface.viewers.TableViewerColumn;
import org.eclipse.swt.SWT; import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener; import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.layout.FillLayout; 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.EventEntry;
import com.minres.scviewer.database.EventKind; import com.minres.scviewer.database.EventKind;
import com.minres.scviewer.database.IWaveform; 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.ITx;
import com.minres.scviewer.database.tx.ITxEvent; import com.minres.scviewer.database.tx.ITxEvent;
import com.minres.scviewer.database.ui.TrackEntry; 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.AbstractTransactionTreeContentProvider;
import com.minres.scviewer.e4.application.parts.txTableTree.AttributeLabelProvider; import com.minres.scviewer.e4.application.parts.txTableTree.AttributeLabelProvider;
import com.minres.scviewer.e4.application.parts.txTableTree.TransactionTreeNode; import com.minres.scviewer.e4.application.parts.txTableTree.TransactionTreeNode;
@@ -76,7 +79,9 @@ public class TransactionList extends Composite {
private TableViewer tableViewer = null; private TableViewer tableViewer = null;
Thread updateThread = null; private LatestJob<TransactionData> updateJob;
private record TransactionData(List<ITx> transactions, List<AttributeNameBean> attributes) {}
private TableColumn valueColumn = null; private TableColumn valueColumn = null;
@@ -185,8 +190,8 @@ public class TransactionList extends Composite {
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
@Override @Override
public Object[] getElements(Object inputElement) { public Object[] getElements(Object inputElement) {
if (inputElement instanceof ArrayList<?>) { if (inputElement instanceof List<?>) {
return ((ArrayList<ITx>) inputElement).stream().map(tx-> new TransactionTreeNode(tx, TransactionTreeNodeType.TX)).collect(Collectors.toList()).toArray(); return ((List<ITx>) inputElement).stream().map(tx-> new TransactionTreeNode(tx, TransactionTreeNodeType.TX)).collect(Collectors.toList()).toArray();
} }
return new Object[0]; return new Object[0];
} }
@@ -233,54 +238,60 @@ public class TransactionList extends Composite {
// Turn on the header and the lines // Turn on the header and the lines
table.setHeaderVisible(true); table.setHeaderVisible(true);
table.setLinesVisible(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) { public void setInput(TrackEntry trackEntry) {
if(trackEntry==null || !trackEntry.waveform.getType().isTransaction()) { final IWaveform requestedStream = trackEntry != null && trackEntry.waveform.getType().isTransaction()
attrNames.clear(); ? trackEntry.waveform : null;
tableViewer.setInput(emptyList); if (requestedStream != null && stream == requestedStream) return;
} else if(stream != trackEntry.waveform) { updateJob.cancel();
stream=trackEntry.waveform; stream = requestedStream;
tableViewer.setInput(emptyList); attrNames.clear();
try{ tableViewer.setInput(emptyList);
if(updateThread!=null) if (requestedStream == null) return;
updateThread.interrupt();
}catch(SecurityException e){} updateJob.schedule("Read transactions", monitor -> {
updateThread = new Thread(()-> { final Map<String, DataType> propNames = new HashMap<>();
final ConcurrentHashMap<String, DataType> propNames=new ConcurrentHashMap<>(); final List<ITx> txList = new ArrayList<>();
Collection<EventEntry> values = stream.getEvents().entrySet(); if (monitor.isCanceled()) throw new OperationCanceledException();
final List<ITx> txList = values.parallelStream() for (EventEntry entry : requestedStream.getEvents().entrySet()) {
.map(e->e.events) if (monitor.isCanceled()) throw new OperationCanceledException();
.map(Arrays::asList) if (entry.events == null) continue;
.flatMap(List::stream) for (IEvent event : entry.events) {
.filter(evt -> evt.getKind()==EventKind.BEGIN || evt.getKind()==EventKind.SINGLE) if (monitor.isCanceled()) throw new OperationCanceledException();
.map(evt-> { if (event.getKind() == EventKind.BEGIN || event.getKind() == EventKind.SINGLE) {
ITx tx = ((ITxEvent)evt).getTransaction(); ITx tx = ((ITxEvent) event).getTransaction();
tx.getAttributes().forEach(attr -> propNames.put(attr.getName(), attr.getDataType())); tx.getAttributes().forEach(attr -> propNames.put(attr.getName(), attr.getDataType()));
return tx; txList.add(tx);
}) }
.sorted((t1, t2)-> Long.compare(t1.getBeginTime(),t2.getBeginTime())) }
.collect(Collectors.toList()); }
final List<AttributeNameBean> newAttrNames=propNames.entrySet().stream() if (monitor.isCanceled()) throw new OperationCanceledException();
.sorted((e1,e2)->e1.getKey().compareTo(e2.getKey())) txList.sort((t1, t2) -> Long.compare(t1.getBeginTime(), t2.getBeginTime()));
.map(e -> new AttributeNameBean(e.getKey(), e.getValue())) final List<AttributeNameBean> newAttrNames = propNames.entrySet().stream()
.collect(Collectors.toList()); .sorted(Map.Entry.comparingByKey())
getDisplay().asyncExec(() -> { .map(e -> new AttributeNameBean(e.getKey(), e.getValue()))
if(tableViewer.getControl().isDisposed()) return; .collect(Collectors.toList());
tableViewer.setInput(txList); return new TransactionData(txList, newAttrNames);
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();
}
} }
public void setSearchProps(String propName, DataType type, String propValue) { public void setSearchProps(String propName, DataType type, String propValue) {
@@ -33,12 +33,6 @@ import javax.inject.Inject;
import javax.inject.Named; import javax.inject.Named;
import org.eclipse.core.commands.ParameterizedCommand; 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;
import org.eclipse.core.runtime.preferences.IEclipsePreferences.IPreferenceChangeListener; import org.eclipse.core.runtime.preferences.IEclipsePreferences.IPreferenceChangeListener;
import org.eclipse.core.runtime.preferences.IEclipsePreferences.PreferenceChangeEvent; 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.AppModelId;
import com.minres.scviewer.e4.application.Messages; import com.minres.scviewer.e4.application.Messages;
import com.minres.scviewer.e4.application.internal.status.WaveStatusBarControl; 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.FileMonitor;
import com.minres.scviewer.e4.application.internal.util.IFileChangeListener; import com.minres.scviewer.e4.application.internal.util.IFileChangeListener;
import com.minres.scviewer.e4.application.internal.util.IModificationChecker; import com.minres.scviewer.e4.application.internal.util.IModificationChecker;
@@ -209,6 +204,10 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
/** The database. */ /** The database. */
private IWaveformDb database; private IWaveformDb database;
private volatile DatabaseLoadSession loadSession;
private volatile boolean disposed;
/** The check for updates. */ /** The check for updates. */
private boolean checkForUpdates; private boolean checkForUpdates;
@@ -271,11 +270,6 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
store=prefs; store=prefs;
showHover=hover; showHover=hover;
database = dbFactory.getDatabase(); 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)); parent.setLayout(new FillLayout(SWT.HORIZONTAL));
IEclipseContext ctx = myPart.getContext(); IEclipseContext ctx = myPart.getContext();
@@ -404,7 +398,7 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
ePartService.addPartListener(new PartListener() { ePartService.addPartListener(new PartListener() {
@Override @Override
public void partActivated(MPart part) { public void partActivated(MPart part) {
if (part == myPart) { if (part == myPart && !disposed) {
if (fileChecker != null) if (fileChecker != null)
fileChecker.check(); fileChecker.check();
updateAll(); updateAll();
@@ -511,8 +505,11 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
@PreDestroy @PreDestroy
public void closeDatabase() { public void closeDatabase() {
if(database.isLoaded()) if (disposed) return;
database.close(); disposed = true;
fileMonitor.dispose();
fileChecker = null;
if (loadSession != null) loadSession.close();
} }
@Inject @Inject
@@ -537,6 +534,7 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
@Inject @Inject
@Optional @Optional
public void reactOnReloadDatabaseChange(@Preference(nodePath = PreferenceConstants.PREFERENCES_SCOPE, value = PreferenceConstants.DATABASE_RELOAD) Boolean checkForUpdates) { public void reactOnReloadDatabaseChange(@Preference(nodePath = PreferenceConstants.PREFERENCES_SCOPE, value = PreferenceConstants.DATABASE_RELOAD) Boolean checkForUpdates) {
if (disposed) return;
if (checkForUpdates.booleanValue()) { if (checkForUpdates.booleanValue()) {
fileChecker = fileMonitor.addFileChangeListener(WaveformViewer.this, filesToLoad, FILE_CHECK_INTERVAL); fileChecker = fileMonitor.addFileChangeListener(WaveformViewer.this, filesToLoad, FILE_CHECK_INTERVAL);
} else { } else {
@@ -550,89 +548,63 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
*/ */
@Override @Override
public void preferenceChange(PreferenceChangeEvent event) { public void preferenceChange(PreferenceChangeEvent event) {
if (!PreferenceConstants.DATABASE_RELOAD.equals(event.getKey()) && !PreferenceConstants.SHOW_HOVER.equals(event.getKey())){ if (!PreferenceConstants.DATABASE_RELOAD.equals(event.getKey()) && !PreferenceConstants.SHOW_HOVER.equals(event.getKey())) {
waveformPane.setStyleProvider(new WaveformStyleProvider(store)); } sync.asyncExec(() -> {
} if (!disposed && waveformPane != null && !myParent.isDisposed())
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;
} }
} }
/**
* Load database.
*
* @param state the state
*/
protected void loadDatabase(final Map<String, String> state) { protected void loadDatabase(final Map<String, String> state) {
loadDatabase(state, 1000L); loadDatabase(state, 1000L);
} }
protected void loadDatabase(final Map<String, String> state, long delay) { protected void loadDatabase(final Map<String, String> state, long delay) {
if (disposed) return;
fileMonitor.removeFileChangeListener(this); fileMonitor.removeFileChangeListener(this);
database.setName(filesToLoad.stream().map(File::getName).reduce(null, (prefix, element) -> prefix==null? element : prefix + ","+ element)); fileChecker = null;
Job job = new Job(Messages.WaveformViewer_15) { if (loadSession != null) {
@Override setSelection(null);
protected IStatus run(IProgressMonitor monitor) { loadSession.close();
IProgressMonitor progressGroup = getJobManager().createProgressGroup(); waveformPane.getStreamList().clear();
JobGroup jobGroup = new JobGroup(Messages.WaveformViewer_15, filesToLoad.size(), filesToLoad.size()); waveformPane.update();
filesToLoad.forEach((final File file) -> { database = dbFactory.getDatabase();
Job job = new DbLoadJob(Messages.WaveformViewer_16 + file.getName(), file); }
job.setProgressGroup(progressGroup, 1); final IWaveformDb requestedDatabase = database;
job.setJobGroup(jobGroup); final List<File> requestedFiles = List.copyOf(filesToLoad);
job.schedule(); final Map<String, String> 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;
} }
}; }, result -> sync.asyncExec(() -> {
job.setName("Load Database"); if (!isCurrentDatabase(requestedDatabase)) return;
job.setSystem(true); if (!result.isOK()) {
job.schedule(delay); // let the UI initialize so that we have a progress monitor 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) /* (non-Javadoc)
@@ -640,30 +612,20 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
*/ */
@Override @Override
public void fileChanged(List<File> file) { public void fileChanged(List<File> file) {
final Display display = myParent.getDisplay(); final DatabaseLoadSession requestedSession = loadSession;
display.asyncExec(() -> { fileMonitor.removeFileChangeListener(this);
if (MessageDialog.openQuestion(display.getActiveShell(), Messages.WaveformViewer_17, sync.asyncExec(() -> {
if (disposed || myParent.isDisposed() || loadSession != requestedSession) return;
if (MessageDialog.openQuestion(myParent.getShell(), Messages.WaveformViewer_17,
Messages.WaveformViewer_18)) { Messages.WaveformViewer_18)) {
reloadDatabase(); reloadDatabase();
} }
}); });
fileMonitor.removeFileChangeListener(this);
} }
public void reloadDatabase() { public void reloadDatabase() {
Map<String, String> state = new HashMap<>(); Map<String, String> state = new HashMap<>();
saveWaveformViewerState(state); 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()) if (!filesToLoad.isEmpty())
loadDatabase(state, 0L); loadDatabase(state, 0L);
} }
@@ -1259,6 +1221,7 @@ public class WaveformViewer implements IFileChangeListener, IPreferenceChangeLis
* @param e * @param e
*/ */
public void widgetDisposed(DisposeEvent e) { public void widgetDisposed(DisposeEvent e) {
closeDatabase();
disposeListenerNumber -= 1; disposeListenerNumber -= 1;
if( disposeListenerNumber == 0) { //if the last tab is closed, reset statusbar if( disposeListenerNumber == 0) { //if the last tab is closed, reset statusbar
eventBroker.post(WaveStatusBarControl.CURSOR_TIME, null); eventBroker.post(WaveStatusBarControl.CURSOR_TIME, null);
+1
View File
@@ -18,6 +18,7 @@
<module>tests/com.minres.scviewer.database.test</module> <module>tests/com.minres.scviewer.database.test</module>
<module>plugins/com.minres.scviewer.database.ui.swt</module> <module>plugins/com.minres.scviewer.database.ui.swt</module>
<module>plugins/com.minres.scviewer.e4.application</module> <module>plugins/com.minres.scviewer.e4.application</module>
<module>tests/com.minres.scviewer.e4.application.test</module>
<module>plugins/com.minres.scviewer.e4.application.help</module> <module>plugins/com.minres.scviewer.e4.application.help</module>
<module>plugins/com.minres.scviewer.ui</module> <module>plugins/com.minres.scviewer.ui</module>
<module>features/com.minres.scviewer.database.feature</module> <module>features/com.minres.scviewer.database.feature</module>
@@ -71,6 +71,28 @@ public class DatabaseLifecycleTest {
} finally { db.unbind(factory);db.close(); } } 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<String> 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 @Test
public void invalidFtrFailsAndLoaderCanBeReusedAfterDisposal() throws Exception { public void invalidFtrFailsAndLoaderCanBeReusedAfterDisposal() throws Exception {
FtrDbLoader loader = new FtrDbLoader();Path invalid = Files.createTempFile("invalid-ftr-", ".ftr"); FtrDbLoader loader = new FtrDbLoader();Path invalid = Files.createTempFile("invalid-ftr-", ".ftr");
@@ -0,0 +1,2 @@
/target/
/bin/
@@ -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
@@ -0,0 +1,3 @@
bin.includes = META-INF/,\
.
source.. = src/
@@ -0,0 +1,26 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>com.minres.scviewer.e4.application.test</artifactId>
<version>2.19.6</version>
<parent>
<groupId>com.minres.scviewer</groupId>
<artifactId>com.minres.scviewer.parent</artifactId>
<version>2.19.6</version>
<relativePath>../..</relativePath>
</parent>
<packaging>eclipse-test-plugin</packaging>
<build>
<plugins>
<plugin>
<groupId>org.eclipse.tycho</groupId>
<artifactId>tycho-surefire-plugin</artifactId>
<version>${tycho-version}</version>
<configuration>
<useUIHarness>false</useUIHarness>
<useUIThread>false</useUIThread>
</configuration>
</plugin>
</plugins>
</build>
</project>
@@ -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<File> 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<IWaveform> getAllWaves() { return List.of(); }
@Override public List<RelationType> 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<File> files = new ArrayList<>(List.of(new File("first"), new File("second")));
AtomicReference<IStatus> 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(); }
}
}
@@ -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<Runnable> 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<Runnable> ui = new LinkedBlockingQueue<>();
List<String> displayed = new ArrayList<>();
try (LatestJob<String> 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<Runnable> ui = new LinkedBlockingQueue<>();
List<String> displayed = new ArrayList<>();
try (LatestJob<String> 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<Runnable> ui = new LinkedBlockingQueue<>();
List<String> displayed = new ArrayList<>();
LatestJob<String> 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());
}
}