Get modified object list for selective pull using background jobs (#278)

Author: shubhamWaghmare-sap

org.abapgit.adt.backend/src/org/abapgit/adt/backend/IRepositoryService.java

@@ -121,6 +121,22 @@ void repositoryChecks(IProgressMonitor monitor, IExternalRepositoryInfoRequest c
 	IAbapGitPullModifiedObjects getModifiedObjects(IProgressMonitor monitor, IRepository currRepository,
 			String user, String password);
 
+	/**
+	 * Returns the locally modified objects for the given repository via background job
+	 *
+	 * @param currRepository
+	 *            Repository for which the modified Objects are to be fetched
+	 * @param user
+	 *            User
+	 * @param password
+	 *            Repository Password
+	 * @param monitor
+	 *            Progress monitor
+	 * @return Modified Objects for the given repository
+	 */
+	IAbapGitPullModifiedObjects getModifiedObjectsWithBackgroundJob(IProgressMonitor monitor, IRepository currRepository, String user,
+			String password);
+
 	//Valid for older backend before 2105 where selective pull feature is not supported
 	/*
 	 * TODO: To be deleted after 2105 back end release with selective pull feature reaches all customers
@@ -169,4 +185,12 @@ IAbapObjects pullRepository(IRepository existingRepository, String branch, Strin
 	IAbapObjects pullRepository(IRepository existingRepository, String branch, String transportRequest, String user, String password,
 			IAbapGitPullModifiedObjects selectedObjectsToPull, IProgressMonitor monitor);
 
+	/**
+	 * Check if background jobs is supported
+	 *
+	 * @param monitor
+	 *            Progress Monitor
+	 * @return If background job is possible or not.
+	 */
+	boolean isBackgroundJobSupported(IProgressMonitor monitor);
 }

org.abapgit.adt.backend/src/org/abapgit/adt/backend/internal/RepositoryService.java

@@ -16,12 +16,14 @@
 import org.abapgit.adt.backend.model.agitpullmodifiedobjects.IAbapGitPullModifiedObjects;
 import org.eclipse.core.runtime.IProgressMonitor;
 
+import com.sap.adt.communication.background.AdtBackgroundRestResourceFactory;
 import com.sap.adt.communication.content.IContentHandler;
 import com.sap.adt.communication.message.HeadersFactory;
 import com.sap.adt.communication.message.IHeaders;
 import com.sap.adt.communication.resources.AdtRestResourceFactory;
 import com.sap.adt.communication.resources.IRestResource;
 import com.sap.adt.communication.resources.UriBuilder;
+import com.sap.adt.compatibility.background.AdtBackgroundRunUriDiscoveryFactory;
 import com.sap.adt.compatibility.exceptions.OutDatedClientException;
 import com.sap.adt.compatibility.filter.AdtCompatibleRestResourceFilterFactory;
 import com.sap.adt.compatibility.filter.IAdtCompatibleRestResourceFilter;
@@ -331,4 +333,48 @@ public IAbapObjects pullRepository(IRepository existingRepository, String branch
 		return restResource.post(monitor, IAbapObjects.class, abapGitPullReq);
 	}
 
+	@Override
+	public boolean isBackgroundJobSupported(IProgressMonitor monitor) {
+		// check whether background job framework is available and is accessible by the user.
+		// if not available or not authorized the uri would be null.
+		if (AdtBackgroundRunUriDiscoveryFactory.createBackgroundRunUriDiscovery(this.destinationId)
+				.getBackgroundRunUriIfAuthorized(monitor) != null) {
+			return true;
+		}
+		return false;
+	}
+
+	private IRestResource getBackgroundRestResource(String uri, String destinationId, IProgressMonitor monitor) {
+		URI backgroundUri = AdtBackgroundRunUriDiscoveryFactory.createBackgroundRunUriDiscovery(destinationId)
+				.getBackgroundRunUriIfAuthorized(monitor);
+		if (backgroundUri != null) {
+			return AdtBackgroundRestResourceFactory.createBackgroundRestResourceFactory().createResourceWithStatelessSession(backgroundUri,
+					URI.create(uri), destinationId);
+		}
+		return AdtRestResourceFactory.createRestResourceFactory().createResourceWithStatelessSession(URI.create(uri), destinationId);
+	}
+
+	@Override
+	public IAbapGitPullModifiedObjects getModifiedObjectsWithBackgroundJob(IProgressMonitor monitor, IRepository currRepository,
+			String user, String password) {
+		URI uriToModifiedObjects = getURIFromAtomLink(currRepository, IRepositoryService.RELATION_MODIFIED_OBJECTS);
+
+		IHeaders headers = null;
+		if (user != null && password != null) {
+			headers = getHttpHeadersForCredentials(user, password);
+		}
+
+		IRestResource restResource = getBackgroundRestResource(uriToModifiedObjects.getPath(), this.destinationId, monitor);
+
+		IContentHandler<IAbapGitPullModifiedObjects> responseContentHandlerV1 = new AbapGitPullModifiedObjectsContentHandlerV1();
+		restResource.addContentHandler(responseContentHandlerV1);
+
+		IAdtCompatibleRestResourceFilter compatibilityFilter = AdtCompatibleRestResourceFilterFactory
+				.createFilter(responseContentHandlerV1);
+		restResource.addRequestFilter(compatibilityFilter);
+		restResource.addResponseFilter(compatibilityFilter);
+
+		return restResource.get(monitor, headers, IAbapGitPullModifiedObjects.class);
+	}
+
 }

org.abapgit.adt.ui/src/org/abapgit/adt/ui/internal/i18n/messages.properties

@@ -73,7 +73,7 @@ AbapGitWizardPageBranchAndPackage_chbox_activate_tooltip=Try to activate all obj
 AbapGitWizardPageBranchAndPackage_btn_browse=Browse...
 AbapGitWizardPageBranchAndPackage_combobox_branch_message=Specify a branch
 AbapGitWizardPageBranchAndPackage_description=Select repository branch, target ABAP package
-AbapGitWizardPageBranchAndPackage_FetchingModifiedObjectsForPull=Fetching objects differing between local and remote repository.
+AbapGitWizardPageBranchAndPackage_FetchingModifiedObjectsForPull=Fetching objects differing between local and remote repository...
 AbapGitWizardPageBranchAndPackageAndFolderLogic_description=Select repository branch, target ABAP package and folder logic
 AbapGitWizardPageBranchAndPackage_label_branch=Branch\:
 AbapGitWizardPageBranchAndPackage_label_package=Package\:

org.abapgit.adt.ui/src/org/abapgit/adt/ui/internal/util/RepositoryUtil.java

@@ -58,8 +58,14 @@ public static String getBranchNameFromRef(String branchRef) {
 	 */
 
 	public static void fetchAndExtractModifiedObjectsToPull(IRepository repository, IRepositoryService repoService, CloneData cloneData) {
-		IAbapGitPullModifiedObjects abapPullModifiedObjects = repoService.getModifiedObjects(new NullProgressMonitor(), repository,
-				cloneData.user, cloneData.pass);
+		IAbapGitPullModifiedObjects abapPullModifiedObjects;
+		if (repoService.isBackgroundJobSupported(new NullProgressMonitor())) {
+			abapPullModifiedObjects = repoService.getModifiedObjectsWithBackgroundJob(new NullProgressMonitor(), repository, cloneData.user,
+					cloneData.pass);
+		}else {
+			abapPullModifiedObjects = repoService.getModifiedObjects(new NullProgressMonitor(), repository,
+					cloneData.user, cloneData.pass);
+		}
 
 		//Client side adjustment to the overwrite objects, and remove any objects from the package warning objects.
 		//TODO Fix this in the backend.

org.abapgit.adt.ui/src/org/abapgit/adt/ui/internal/wizards/AbapGitWizardPageBranchAndPackage.java

@@ -16,14 +16,19 @@
 import org.abapgit.adt.backend.model.abapgitexternalrepo.IBranch;
 import org.abapgit.adt.backend.model.abapgitrepositories.IRepository;
 import org.abapgit.adt.backend.model.abapgitrepositories.IRepository.FolderLogic;
+import org.abapgit.adt.ui.AbapGitUIPlugin;
 import org.abapgit.adt.ui.internal.i18n.Messages;
 import org.abapgit.adt.ui.internal.util.AbapGitUIServiceFactory;
 import org.abapgit.adt.ui.internal.util.IAbapGitService;
 import org.abapgit.adt.ui.internal.util.RepositoryUtil;
 import org.abapgit.adt.ui.internal.wizards.AbapGitWizard.CloneData;
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.NullProgressMonitor;
+import org.eclipse.core.runtime.OperationCanceledException;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.core.runtime.jobs.Job;
 import org.eclipse.jface.dialogs.DialogPage;
 import org.eclipse.jface.layout.GridDataFactory;
 import org.eclipse.jface.operation.IRunnableWithProgress;
@@ -38,11 +43,16 @@
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.events.SelectionAdapter;
 import org.eclipse.swt.events.SelectionEvent;
+import org.eclipse.swt.layout.GridData;
 import org.eclipse.swt.layout.GridLayout;
 import org.eclipse.swt.widgets.Button;
 import org.eclipse.swt.widgets.Composite;
+import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Label;
+import org.eclipse.swt.widgets.ProgressBar;
 
+import com.sap.adt.communication.exceptions.CommunicationException;
+import com.sap.adt.communication.resources.ResourceException;
 import com.sap.adt.tools.core.model.adtcore.IAdtObjectReference;
 import com.sap.adt.tools.core.ui.packages.AdtPackageProposalProviderFactory;
 import com.sap.adt.tools.core.ui.packages.AdtPackageServiceUIFactory;
@@ -68,6 +78,10 @@ public class AbapGitWizardPageBranchAndPackage extends WizardPage {
 	private boolean backButtonEnabled = true;
 	private final ApackParameters lastApackCall;
 
+	private ProgressBar progressBar;
+
+	private Label progressBarLabel;
+
 	public AbapGitWizardPageBranchAndPackage(IProject project, String destination, CloneData cloneData, Boolean pullAction) {
 		super(PAGE_NAME);
 		this.project = project;
@@ -175,6 +189,8 @@ public void widgetSelected(SelectionEvent event) {
 			});
 		}
 
+		createProgressBarComposite(container);
+
 		setControl(container);
 
 		if (this.cloneData.url != null) {
@@ -197,6 +213,35 @@ public void widgetSelected(SelectionEvent event) {
 		}
 	}
 
+	private void createProgressBarComposite(Composite container) {
+		Composite progressBarComposite = new Composite(container, SWT.NONE);
+		progressBarComposite.setLayout(new GridLayout(1, false)); // 1 column layout
+
+		this.progressBarLabel = new Label(progressBarComposite, SWT.NONE);
+		this.progressBarLabel.setText(Messages.AbapGitWizardPageBranchAndPackage_FetchingModifiedObjectsForPull);
+		this.progressBarLabel.setLayoutData(new GridData(SWT.BEGINNING, SWT.END, true, false));
+
+		this.progressBar = new ProgressBar(progressBarComposite, SWT.INDETERMINATE);
+		GridData pBGD = new GridData(SWT.FILL, SWT.END, true, false);
+		this.progressBar.setLayoutData(pBGD);
+
+		GridData pbCompGD = new GridData(SWT.FILL, SWT.END, true, true);
+		pbCompGD.horizontalSpan = 3;
+		progressBarComposite.setLayoutData(pbCompGD);
+
+		setProgressVisible(false);
+	}
+
+	public void setProgressVisible(boolean visible) {
+		if (this.progressBar != null && !this.progressBar.isDisposed()) {
+			this.progressBar.setVisible(visible);
+		}
+
+		if (this.progressBarLabel != null && !this.progressBarLabel.isDisposed()) {
+			this.progressBarLabel.setVisible(visible);
+		}
+	}
+
 	private void setLnpSequence(boolean chboxValue) {
 		this.chboxLinkAndPull = chboxValue;
 	}
@@ -302,7 +347,7 @@ public void setVisible(boolean visible) {
 
 	@Override
 	public boolean canFlipToNextPage() {
-		return true;
+		return true && isPageComplete();
 	}
 
 	@Override
@@ -316,18 +361,51 @@ public IWizardPage getNextPage() {
 			// This is valid only for back end versions from 2105 where selective pull is supported.
 			// If selectivePull is not supported, fetching modified objects is not required and all objects are to be pulled
 			if (abapGitService.isSelectivePullSupported(repository)) {
-				try {
-					getContainer().run(true, true, new IRunnableWithProgress() {
+				setPageComplete(false);
+				setProgressVisible(true);
 
-						@Override
-						public void run(IProgressMonitor monitor) throws InvocationTargetException, InterruptedException {
-							monitor.beginTask(Messages.AbapGitWizardPageBranchAndPackage_FetchingModifiedObjectsForPull, IProgressMonitor.UNKNOWN);
+				Job myRequestJob = new Job(Messages.AbapGitWizardPageBranchAndPackage_FetchingModifiedObjectsForPull) {
+
+					@Override
+					protected IStatus run(IProgressMonitor monitor) {
+						try {
+							if (monitor.isCanceled()) {
+								return Status.CANCEL_STATUS;
+							}
 							RepositoryUtil.fetchAndExtractModifiedObjectsToPull(repository, repoService,
 									AbapGitWizardPageBranchAndPackage.this.cloneData);
+
+							if (monitor.isCanceled()) {
+								return Status.CANCEL_STATUS;
+							}
+						} catch (CommunicationException e) {
+							return new Status(IStatus.ERROR, AbapGitUIPlugin.PLUGIN_ID, e.getLocalizedMessage(), e);
+						} catch (ResourceException e) {
+							return new Status(IStatus.ERROR, AbapGitUIPlugin.PLUGIN_ID, e.getLocalizedMessage(), e);
+						} catch (OperationCanceledException e) {
+							return new Status(IStatus.ERROR, AbapGitUIPlugin.PLUGIN_ID, e.getLocalizedMessage(), e);
+						} finally {
+							monitor.done();
 						}
-					});
-				} catch (InvocationTargetException | InterruptedException e) {
-					setMessage(e.getMessage(), DialogPage.ERROR);
+						return Status.OK_STATUS;
+					}
+				};
+
+				myRequestJob.setUser(true);
+				myRequestJob.schedule();
+
+				// wait for the job to finish
+				Display display = Display.getDefault();
+				while (myRequestJob.getResult() == null) {
+					if (!display.readAndDispatch()) {
+						display.sleep();
+					}
+				}
+
+				setProgressVisible(false);
+
+				if (myRequestJob.getResult().getSeverity() != Status.OK && myRequestJob.getResult().getSeverity() != Status.INFO) {
+					setErrorMessage(myRequestJob.getResult().getMessage());
 					setPageComplete(false);
 					return null;
 				}