Skip to content

Feature/background job implementation #300

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Feature/background job implementation #300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b1b9252
background framework implementation chanegs
aarnapant-sap Oct 23, 2025
fea7118
changing the relation name to sync with backend
aarnapant-sap Nov 4, 2025
c09cf6d
removing additional error popup dialog
aarnapant-sap Nov 4, 2025
9a415ac
resource relation handling, Util class for AbapGitView
aarnapant-sap Nov 18, 2025
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
1 change: 1 addition & 0 deletions org.abapgit.adt.backend/src/org/abapgit/adt/backend/IRepositoryService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
public interface IRepositoryService {

String RELATION_PULL = "http://www.sap.com/adt/abapgit/relations/pull"; //$NON-NLS-1$
String RELATION_PULL_WITHOUT_BG = "http://www.sap.com/adt/abapgit/relations/pull/v2"; //$NON-NLS-1$
Copy link
Collaborator

@shubhamWaghmare-sap shubhamWaghmare-sap Nov 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Variable name, could be RELATION_PULL_WITH_BG_RUN

String RELATION_STATUS = "http://www.sap.com/adt/abapgit/relations/status"; //$NON-NLS-1$
String RELATION_LOG = "http://www.sap.com/adt/abapgit/relations/log"; //$NON-NLS-1$
String RELATION_STAGE = "http://www.sap.com/adt/abapgit/relations/stage"; //$NON-NLS-1$
Expand Down
46 changes: 32 additions & 14 deletions org.abapgit.adt.backend/src/org/abapgit/adt/backend/internal/RepositoryService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ public class RepositoryService implements IRepositoryService {

private final String destinationId;
private final URI uri;
private String result;
Copy link
Collaborator

@shubhamWaghmare-sap shubhamWaghmare-sap Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This variable is not used.


public RepositoryService(String destinationId, URI uri) {
this.destinationId = destinationId;
Expand Down Expand Up @@ -101,7 +102,8 @@ public IAbapObjects cloneRepository(String url, String branch, String targetPack
IContentHandler<IAbapObjects> responseContentHandlerV1 = new AbapObjectContentHandlerV1();
restResource.addContentHandler(responseContentHandlerV1);

IAdtCompatibleRestResourceFilter compatibilityFilter = AdtCompatibleRestResourceFilterFactory.createFilter(responseContentHandlerV1);
IAdtCompatibleRestResourceFilter compatibilityFilter = AdtCompatibleRestResourceFilterFactory
.createFilter(responseContentHandlerV1);
restResource.addRequestFilter(compatibilityFilter);

return restResource.post(monitor, IAbapObjects.class, repository);
Expand Down Expand Up @@ -204,8 +206,7 @@ public void repositoryChecks(IProgressMonitor monitor, IExternalRepositoryInfoRe
restResource.addRequestFilter(compatibilityFilter);
restResource.addResponseFilter(compatibilityFilter);
if (credentials != null) {
headers = getHttpHeadersForCredentials(credentials.getUser(),
credentials.getPassword());
headers = getHttpHeadersForCredentials(credentials.getUser(), credentials.getPassword());
}
restResource.post(monitor, headers, null);
}
Expand Down Expand Up @@ -267,8 +268,8 @@ public URI getURIFromAtomLink(IRepository repository, String relation) {
}

@Override
public IAbapGitPullModifiedObjects getModifiedObjects(IProgressMonitor monitor, IRepository currRepository,
String user, String password) throws OutDatedClientException {
public IAbapGitPullModifiedObjects getModifiedObjects(IProgressMonitor monitor, IRepository currRepository, String user,
String password) throws OutDatedClientException {
URI uriToModifiedObjects = getURIFromAtomLink(currRepository, IRepositoryService.RELATION_MODIFIED_OBJECTS);

IHeaders headers = null;
Expand All @@ -277,8 +278,7 @@ public IAbapGitPullModifiedObjects getModifiedObjects(IProgressMonitor monitor,
}

IRestResource restResource = AdtRestResourceFactory.createRestResourceFactory()
.createResourceWithStatelessSession(uriToModifiedObjects,
this.destinationId);
.createResourceWithStatelessSession(uriToModifiedObjects, this.destinationId);

IContentHandler<IAbapGitPullModifiedObjects> responseContentHandlerV1 = new AbapGitPullModifiedObjectsContentHandlerV1();
restResource.addContentHandler(responseContentHandlerV1);
Expand All @@ -292,13 +292,31 @@ public IAbapGitPullModifiedObjects getModifiedObjects(IProgressMonitor monitor,

}

// CHNG: Change it back to original pull relation
Copy link
Collaborator

@shubhamWaghmare-sap shubhamWaghmare-sap Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the comment.

@Override
public IAbapObjects pullRepository(IRepository existingRepository, String branch, String transportRequest, String user, String password,
IAbapGitPullModifiedObjects selectedObjectsToPull, IProgressMonitor monitor) {
URI uriToRepo = getURIFromAtomLink(existingRepository, IRepositoryService.RELATION_PULL);
IRestResource restResource = AdtRestResourceFactory.createRestResourceFactory().createResourceWithStatelessSession(uriToRepo,
this.destinationId);

IRestResource restResource = null;
URI uriToRepo = null;
// check if background job framework is available and is accessible by the user.
Copy link
Collaborator

@shubhamWaghmare-sap shubhamWaghmare-sap Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove comments. The method names should be sufficient.

if (isBackgroundJobSupported(monitor)) {
// get new pull without background resource URI
uriToRepo = getURIFromAtomLink(existingRepository, IRepositoryService.RELATION_PULL_WITHOUT_BG);
// check whether URI is available in the system (this depends on the back end version)
if (uriToRepo != null) {
restResource = getBackgroundRestResource(uriToRepo.getPath(), this.destinationId, monitor);
}
}
// if rest resource is still null, rollback to normal pull URI
if (restResource == null) {
uriToRepo = getURIFromAtomLink(existingRepository, IRepositoryService.RELATION_PULL);
restResource = AdtRestResourceFactory.createRestResourceFactory().createResourceWithStatelessSession(uriToRepo,
this.destinationId);
}
if (restResource == null) {
// if rest resource could not be created, throw exception
throw new IllegalStateException("Unable to create REST resource for pull operation."); //$NON-NLS-1$
}
IContentHandler<IAbapGitPullRequest> requestContentHandlerV1 = new AbapGitPullRequestContentHandler();
restResource.addContentHandler(requestContentHandlerV1);

Expand All @@ -316,9 +334,9 @@ public IAbapObjects pullRepository(IRepository existingRepository, String branch
}

if (selectedObjectsToPull != null) {
abapGitPullReq.setPackageWarningObjects(selectedObjectsToPull.getPackageWarningObjects());
abapGitPullReq.setOverwriteObjects(selectedObjectsToPull.getOverwriteObjects());
}
abapGitPullReq.setPackageWarningObjects(selectedObjectsToPull.getPackageWarningObjects());
abapGitPullReq.setOverwriteObjects(selectedObjectsToPull.getOverwriteObjects());
}

IAdtCompatibleRestResourceFilter compatibilityFilter = AdtCompatibleRestResourceFilterFactory.createFilter(new IContentHandler[0]);
restResource.addRequestFilter(compatibilityFilter);
Expand Down
3 changes: 1 addition & 2 deletions org.abapgit.adt.ui/src/org/abapgit/adt/ui/internal/repositories/AbapGitView.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -563,9 +563,8 @@ public void run() {
WizardDialog wizardDialog = new WizardDialog(AbapGitView.this.viewer.getControl().getShell(),
new AbapGitWizardPull(AbapGitView.this.lastProject, this.selRepo, allRepositories));
wizardDialog.open();
}

updateView(true);
}
}
};
this.actionPullWizard.setText(Messages.AbapGitView_context_pull);
Expand Down
33 changes: 33 additions & 0 deletions org.abapgit.adt.ui/src/org/abapgit/adt/ui/internal/repositories/AbapGitViewUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
package org.abapgit.adt.ui.internal.repositories;

import org.eclipse.ui.IViewPart;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.PlatformUI;

public class AbapGitViewUtils {
private static AbapGitViewUtils instance;

private AbapGitViewUtils() {}

public static synchronized AbapGitViewUtils getInstance() {
if (instance == null) {
instance = new AbapGitViewUtils();
}
return instance;
}

public void refreshView() {
org.eclipse.swt.widgets.Display.getDefault().asyncExec(() -> {
Copy link
Collaborator

@shubhamWaghmare-sap shubhamWaghmare-sap Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Import Display API and then use.

IWorkbenchPage page = PlatformUI.getWorkbench().getActiveWorkbenchWindow() != null
? PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage()
: null;
if (page != null) {
IViewPart view = page.findView(AbapGitView.ID);
if (view instanceof AbapGitView) {
((AbapGitView) view).refresh();
Comment on lines +25 to +27
Copy link
Collaborator

@shubhamWaghmare-sap shubhamWaghmare-sap Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This logic needs to find the view from all the active views.
I want to avoid this call.
Hence, looking at some other way to keep stuff decoupled.

So,

  1. Refresh of a view should be decoupled from the pull wizard.
  2. Refresh should be part of the action which starts the pull.
  3. Avoid a central disconnected utility just to refresh UI.

Hence I was looking into a callback mechanism.

Copy link
Collaborator

@shubhamWaghmare-sap shubhamWaghmare-sap Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In our actionPullWizard implementation, we could first implement a callback as lamba expression.


		this.actionPullWizard = new Action() {

			private IRepository selRepo;

			public void run() {
				// Create callback that refreshes the view
				Runnable onPullComplete = () -> AbapGitView.this.updateView(true);

and we can send it within the constructor of AbapGitWizardPull and add it as an instance variable.

Then in our finally block of the job, we can run this call back.

} finally {
					// Execute callback after job completes
					if (AbapGitWizardPull.this.onPullComplete!= null) {
						Display.getDefault().asyncExec(AbapGitWizardPull.this.onPullComplete);
					}
				}

Copy link
Collaborator

@shubhamWaghmare-sap shubhamWaghmare-sap Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But also this could be over-engineering and we can as well just pass the AbapGit view instance to the wizard and refresh the view.
Given we have the wizards initiated directly from the view, this should be fine as well.

}
}
});
}

}
3 changes: 2 additions & 1 deletion ...apgit.adt.ui/src/org/abapgit/adt/ui/internal/repositories/actions/SwitchbranchAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import org.abapgit.adt.ui.AbapGitUIPlugin;
import org.abapgit.adt.ui.internal.i18n.Messages;
import org.abapgit.adt.ui.internal.repositories.AbapGitView;
import org.abapgit.adt.ui.internal.repositories.AbapGitViewUtils;
import org.abapgit.adt.ui.internal.repositories.exceptions.PackageRefNotFoundException;
import org.abapgit.adt.ui.internal.wizards.AbapGitWizardSwitchBranch;
import org.eclipse.core.resources.IProject;
Expand Down Expand Up @@ -54,7 +55,7 @@ public void run() {
e.getLocalizedMessage());
}
}
this.AbapGitView.refresh();
AbapGitViewUtils.getInstance().refreshView();

}

Expand Down
76 changes: 43 additions & 33 deletions org.abapgit.adt.ui/src/org/abapgit/adt/ui/internal/wizards/AbapGitWizardPull.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.abapgit.adt.backend.IApackManifest;
import org.abapgit.adt.backend.IApackManifest.IApackDependency;
Expand All @@ -14,11 +15,16 @@
import org.abapgit.adt.backend.model.agitpullmodifiedobjects.IAbapGitPullModifiedObjects;
import org.abapgit.adt.ui.AbapGitUIPlugin;
import org.abapgit.adt.ui.internal.i18n.Messages;
import org.abapgit.adt.ui.internal.repositories.AbapGitViewUtils;
import org.abapgit.adt.ui.internal.repositories.IRepositoryModifiedObjects;
import org.abapgit.adt.ui.internal.util.AbapGitUIServiceFactory;
import org.abapgit.adt.ui.internal.wizards.AbapGitWizard.CloneData;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.Assert;
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;
import org.eclipse.jface.dialogs.DialogPage;
import org.eclipse.jface.dialogs.IMessageProvider;
import org.eclipse.jface.dialogs.IPageChangingListener;
Expand Down Expand Up @@ -148,61 +154,65 @@ public void addPages() {
@Override
public boolean performFinish() {

try {
getContainer().run(true, true, new IRunnableWithProgress() {
// Extracting variable earlier to ensure consistency in asynchronous code flow
Set<IRepositoryModifiedObjects> overwriteObjects = AbapGitWizardPull.this.pageOverwriteObjectsSelection.getSelectedObjects();
Set<IRepositoryModifiedObjects> packageWarningObjects = AbapGitWizardPull.this.pagePackageWarningObjectsSelection
.getSelectedObjects();

@Override
public void run(IProgressMonitor monitor) throws InvocationTargetException, InterruptedException {
Job pullRepoJob = new Job(Messages.AbapGitWizard_task_pulling_repository) {
@Override
protected IStatus run(IProgressMonitor monitor) {
try {
monitor.beginTask(Messages.AbapGitWizard_task_pulling_repository, IProgressMonitor.UNKNOWN);

IRepositoryService repoService = RepositoryServiceFactory.createRepositoryService(AbapGitWizardPull.this.destination,
monitor);

//get the selected objects to be pulled
// Get the selected objects to be pulled
AbapGitWizardPull.this.repoToSelectedObjects = AbapGitUIServiceFactory.createAbapGitPullService()
.getSelectedObjectsToPullforRepo(AbapGitWizardPull.this.pageOverwriteObjectsSelection.getSelectedObjects(),
AbapGitWizardPull.this.pagePackageWarningObjectsSelection.getSelectedObjects());
.getSelectedObjectsToPullforRepo(overwriteObjects, packageWarningObjects);

//pull the selected objects
// Pull the selected objects
repoService.pullRepository(AbapGitWizardPull.this.selRepoData, AbapGitWizardPull.this.selRepoData.getBranchName(),
AbapGitWizardPull.this.transportPage.getTransportRequestNumber(), AbapGitWizardPull.this.cloneData.user,
AbapGitWizardPull.this.cloneData.pass,
AbapGitWizardPull.this.repoToSelectedObjects.get(AbapGitWizardPull.this.selRepoData.getUrl()), monitor);

// Pull dependencies if any
if (AbapGitWizardPull.this.cloneData.hasDependencies()) {
pullDependencies(monitor, repoService);
}

return Status.OK_STATUS;
} catch (ResourceException e) {
return new Status(IStatus.ERROR, AbapGitUIPlugin.PLUGIN_ID, e.getMessage(), e);
} finally {
AbapGitViewUtils.getInstance().refreshView();
}
}

private void pullDependencies(IProgressMonitor monitor, IRepositoryService repoService) {
for (IApackDependency apackDependency : AbapGitWizardPull.this.cloneData.apackManifest.getDescriptor()
.getDependencies()) {
if (apackDependency.requiresSynchronization()) {
IRepository dependencyRepository = repoService.getRepositoryByURL(AbapGitWizardPull.this.cloneData.repositories,
apackDependency.getGitUrl());
if (dependencyRepository != null) {
repoService.pullRepository(dependencyRepository, IApackManifest.MASTER_BRANCH,
AbapGitWizardPull.this.transportPage.getTransportRequestNumber(),
AbapGitWizardPull.this.cloneData.user, AbapGitWizardPull.this.cloneData.pass,
AbapGitWizardPull.this.repoToSelectedObjects.get(dependencyRepository.getUrl()), monitor);
private void pullDependencies(IProgressMonitor monitor, IRepositoryService repoService) {
for (IApackDependency apackDependency : AbapGitWizardPull.this.cloneData.apackManifest.getDescriptor().getDependencies()) {
if (apackDependency.requiresSynchronization()) {
IRepository dependencyRepository = repoService.getRepositoryByURL(AbapGitWizardPull.this.cloneData.repositories,
apackDependency.getGitUrl());
if (dependencyRepository != null) {
repoService.pullRepository(dependencyRepository, IApackManifest.MASTER_BRANCH,
AbapGitWizardPull.this.transportPage.getTransportRequestNumber(), AbapGitWizardPull.this.cloneData.user,
AbapGitWizardPull.this.cloneData.pass,
AbapGitWizardPull.this.repoToSelectedObjects.get(dependencyRepository.getUrl()), monitor);
}
}
}
}
}
});

return true;
};

pullRepoJob.setUser(true); // Shows the job in progress view
pullRepoJob.schedule();

return true;
Comment on lines +212 to +214
Copy link
Collaborator

@shubhamWaghmare-sap shubhamWaghmare-sap Nov 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we somehow trigger a refresh of the view once the job has finished ?
The status is not updated in the viewer after job has completed.

Copy link
Collaborator Author

@aarnapant-sap aarnapant-sap Nov 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in the AbapGitView I see a updateView(true) after pull action is triggered however I also don't see it actually refreshing once the pull is done. Will check why thats happening

Copy link
Collaborator

@shubhamWaghmare-sap shubhamWaghmare-sap Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check the callback related logic in other comment. What are your thoughts on it.


} catch (InterruptedException e) {
return false;
} catch (InvocationTargetException e) {
((WizardPage) getContainer().getCurrentPage()).setPageComplete(false);
((WizardPage) getContainer().getCurrentPage()).setMessage(e.getTargetException().getMessage(), DialogPage.ERROR);
return false;
} catch (ResourceException e) {
((WizardPage) getContainer().getCurrentPage()).setPageComplete(false);
((WizardPage) getContainer().getCurrentPage()).setMessage(e.getMessage(), DialogPage.ERROR);
return false;
}
}

@Override
Expand Down