Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Streamline control flow in FileInfoReader #605

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Streamline control flow in FileInfoReader #605

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
154 changes: 64 additions & 90 deletions ...ox.p2.transport.ecf/src/org/eclipse/equinox/internal/p2/transport/ecf/FileInfoReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;
import org.eclipse.core.runtime.*;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.ecf.core.*;
import org.eclipse.ecf.core.security.IConnectContext;
import org.eclipse.ecf.filetransfer.*;
Expand All @@ -31,151 +29,127 @@
import org.eclipse.equinox.internal.p2.repository.Messages;
import org.eclipse.osgi.util.NLS;

/**
* The FileInfoReader is a {@link Job} similar to {@link FileReader}, but without the support
* from ECF (there is currently no way to wait on a BrowseRequest job, as this is internal to
* ECF). If such support is added, this class is easily modified.
*/
class FileInfoReader {
private final int connectionRetryCount;
private final long connectionRetryDelay;
private final IConnectContext connectContext;

/**
* Create a new FileInfoReader that will retry failed connection attempts and sleep some amount of time between each
* attempt.
* Create a new FileInfoReader that will retry failed connection attempts and
* sleep some amount of time between each attempt.
*/
FileInfoReader(IConnectContext aConnectContext) {
connectionRetryCount = RepositoryPreferences.getConnectionRetryCount();
connectionRetryDelay = RepositoryPreferences.getConnectionMsRetryDelay();
connectContext = aConnectContext;
}

long getLastModified(URI location, IProgressMonitor monitor)
long getLastModified(URI uri, IProgressMonitor monitor)
throws AuthenticationFailedException, FileNotFoundException, CoreException, JREHttpClientRequiredException {
if (monitor != null) {
monitor.beginTask(location.toString(), 1);
}
try {
AtomicReference<IRemoteFile> remote = new AtomicReference<>();
sendBrowseRequest(location, remote::set, IProgressMonitor.nullSafe(monitor));
IRemoteFile file = remote.get();
if (file == null) {
throw new FileNotFoundException(location.toString());
}
return file.getInfo().getLastModified();
} finally {
if (monitor != null) {
monitor.done();
}
}
}

private void sendBrowseRequest(URI uri, Consumer<IRemoteFile> remoteFileConsumer, IProgressMonitor monitor)
throws CoreException, FileNotFoundException, AuthenticationFailedException, JREHttpClientRequiredException {
SubMonitor convert = SubMonitor.convert(monitor, uri.toString(), connectionRetryCount);
IContainer container;
try {
container = ContainerFactory.getDefault().createContainer();
} catch (ContainerCreateException e) {
throw RepositoryStatusHelper.fromExceptionMessage(e ,Messages.ecf_configuration_error);
throw RepositoryStatusHelper.fromExceptionMessage(e, Messages.ecf_configuration_error);
}

IRemoteFileSystemBrowserContainerAdapter adapter = container.getAdapter(IRemoteFileSystemBrowserContainerAdapter.class);
IRemoteFileSystemBrowserContainerAdapter adapter = container
.getAdapter(IRemoteFileSystemBrowserContainerAdapter.class);
if (adapter == null) {
throw RepositoryStatusHelper.fromMessage(Messages.ecf_configuration_error);
}
adapter.setConnectContextForAuthentication(connectContext);
CoreException summary = new CoreException(Status.error("All download attempts failed")); //$NON-NLS-1$
for (int retryCount = 0; retryCount < connectionRetryCount; retryCount++) {
if (monitor.isCanceled()) {
if (convert.isCanceled()) {
throw new OperationCanceledException();
}
Exception exception = null;
AtomicReference<IRemoteFile> remote = new AtomicReference<>();
AtomicReference<Exception> exception = new AtomicReference<>();
try {
AtomicReference<Exception> callbackException = new AtomicReference<>();
IFileID fileID = FileIDFactory.getDefault().createFileID(adapter.getBrowseNamespace(), uri.toString());
CountDownLatch latch = new CountDownLatch(1);
IRemoteFileSystemRequest browseRequest = adapter.sendBrowseRequest(fileID,
event -> {
Exception e = event.getException();
if (e != null) {
callbackException.set(e);
latch.countDown();
} else if (event instanceof IRemoteFileSystemBrowseEvent) {
IRemoteFileSystemBrowseEvent fsbe = (IRemoteFileSystemBrowseEvent) event;
IRemoteFile[] remoteFiles = fsbe.getRemoteFiles();
if (remoteFiles != null && remoteFiles.length > 0) {
remoteFileConsumer.accept(remoteFiles[0]);
}
monitor.worked(1);
latch.countDown();
} else {
latch.countDown();
}
});
IRemoteFileSystemRequest browseRequest = adapter.sendBrowseRequest(fileID, event -> {
Exception e = event.getException();
if (e != null) {
exception.set(e);
} else if (event instanceof IRemoteFileSystemBrowseEvent) {
IRemoteFileSystemBrowseEvent fsbe = (IRemoteFileSystemBrowseEvent) event;
IRemoteFile[] remoteFiles = fsbe.getRemoteFiles();
if (remoteFiles != null && remoteFiles.length > 0) {
remote.set(remoteFiles[0]);
}
convert.worked(1);
}
latch.countDown();
});
while (!latch.await(1, TimeUnit.SECONDS)) {
if (monitor.isCanceled()) {
if (convert.isCanceled()) {
browseRequest.cancel();
throw new OperationCanceledException();
}
}
exception = callbackException.get();
} catch (RemoteFileSystemException | FileCreateException e) {
exception = e;
exception.set(e);
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
LogHelper.log(new Status(IStatus.WARNING, Activator.ID,
"Unexpected interrupt while waiting on ECF browse request", e)); //$NON-NLS-1$
throw new OperationCanceledException();
}
if (checkException(uri, retryCount, exception)) {
return;
Exception e = exception.get();
if (e == null) {
IRemoteFile remoteFile = remote.get();
if (remoteFile == null) {
throw new FileNotFoundException(uri.toString());
}
return remoteFile.getInfo().getLastModified();
}
summary.addSuppressed(exception);
checkException(uri, retryCount, e);
summary.addSuppressed(e);
}
throw summary;
}

/**
* Utility method to check exception condition and determine if retry should be done.
* If there was an exception it is translated into one of the specified exceptions and thrown.
* Utility method to check exception condition and determine if retry should be
* done. If there was an exception it is translated into one of the specified
* exceptions and thrown.
*
* @param uri the URI being read - used for logging purposes
* @param uri the URI being read - used for logging purposes
* @param attemptCounter - the current attempt number (start with 0)
* @return true if the exception is an IOException and attemptCounter < connectionRetryCount, false otherwise
* @throws JREHttpClientRequiredException
* @return true if the exception is an IOException and attemptCounter <
* connectionRetryCount, false otherwise
* @throws JREHttpClientRequiredException
*/
private boolean checkException(URI uri, int attemptCounter, Exception exception)
throws CoreException, FileNotFoundException, AuthenticationFailedException, JREHttpClientRequiredException {
// note that 'exception' could have been captured in a callback
if (exception != null) {
// check if HTTP client needs to be changed
RepositoryStatusHelper.checkJREHttpClientRequired(exception);
// check if HTTP client needs to be changed
RepositoryStatusHelper.checkJREHttpClientRequired(exception);

// if this is a authentication failure - it is not meaningful to continue
RepositoryStatusHelper.checkPermissionDenied(exception);
// if this is a authentication failure - it is not meaningful to continue
RepositoryStatusHelper.checkPermissionDenied(exception);

// if this is a file not found - it is not meaningful to continue
RepositoryStatusHelper.checkFileNotFound(exception, uri);
// if this is a file not found - it is not meaningful to continue
RepositoryStatusHelper.checkFileNotFound(exception, uri);

Throwable t = RepositoryStatusHelper.unwind(exception);
if (t instanceof CoreException)
throw RepositoryStatusHelper.unwindCoreException((CoreException) t);

if (t instanceof IOException && attemptCounter < connectionRetryCount - 1) {
// TODO: Retry only certain exceptions or filter out
// some exceptions not worth retrying
//
try {
LogHelper.log(new Status(IStatus.WARNING, Activator.ID, NLS.bind(Messages.connection_to_0_failed_on_1_retry_attempt_2, new String[] {uri.toString(), t.getMessage(), String.valueOf(attemptCounter)}), t));
Thread.sleep(connectionRetryDelay);
return false;
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
}
Throwable t = RepositoryStatusHelper.unwind(exception);
if (t instanceof CoreException) {
throw RepositoryStatusHelper.unwindCoreException((CoreException) t);
}
if (t instanceof IOException && attemptCounter < connectionRetryCount - 1) {
LogHelper
.log(new Status(IStatus.WARNING, Activator.ID,
NLS.bind(Messages.connection_to_0_failed_on_1_retry_attempt_2,
new String[] { uri.toString(), t.getMessage(), String.valueOf(attemptCounter) }),
t));
try {
Thread.sleep(connectionRetryDelay);
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new OperationCanceledException();
}
throw RepositoryStatusHelper.wrap(exception);
}
return true;
throw RepositoryStatusHelper.wrap(exception);
}
}
Loading