Explicit Poll Workspace Implementation

Author: ajindal-mdx

src/main/java/org/jenkinsci/plugins/p4/PerforceScm.java

@@ -47,8 +47,10 @@
 import org.jenkinsci.plugins.p4.changes.P4ChangeSet;
 import org.jenkinsci.plugins.p4.changes.P4GraphRef;
 import org.jenkinsci.plugins.p4.changes.P4LabelRef;
+import org.jenkinsci.plugins.p4.changes.P4PollRef;
 import org.jenkinsci.plugins.p4.changes.P4Ref;
 import org.jenkinsci.plugins.p4.client.ConnectionHelper;
+import org.jenkinsci.plugins.p4.client.TempClientHelper;
 import org.jenkinsci.plugins.p4.credentials.P4BaseCredentials;
 import org.jenkinsci.plugins.p4.credentials.P4CredentialsImpl;
 import org.jenkinsci.plugins.p4.credentials.P4InvalidCredentialException;
@@ -97,6 +99,7 @@
 import java.util.Optional;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import java.util.stream.Collectors;
 
 public class PerforceScm extends SCM {
 
@@ -530,10 +533,13 @@ private List<P4Ref> lookForChanges(FilePath buildWorkspace, Workspace ws, Run<?,
 			return null;
 		}
 
+		List<P4PollRef> lastPollPathRefs = TagAction.getLastPollChange(lastRun, listener, syncID);
+
 		// Create task
 		PollTask task = new PollTask(credential, lastRun, listener, filter, lastRefs);
 		task.setWorkspace(ws);
 		task.setLimit(pin);
+		task.setPollRefChanges(lastPollPathRefs);
 
 		// Execute remote task
 		List<P4Ref> changes = buildWorkspace.act(task);
@@ -650,10 +656,41 @@ To help lookForChanges() find the correct change to build, sending it the previo
 			task.setIncrementalChanges(changes);
 		}
 
+		// Adding all the pollPath and their latest changes in a list
+		List<P4Ref> finalPollPathList = new ArrayList<P4Ref>();
+		if (ws instanceof ManualWorkspaceImpl) {
+			String workspacePollpath = ((ManualWorkspaceImpl) ws).getSpec().getPollPath();
+			List<String> pollPathList = new ArrayList<>();
+			// Extract and clean comma-separated polling paths
+			if (workspacePollpath != null && !workspacePollpath.isEmpty()) {
+				pollPathList = Arrays.stream(workspacePollpath.split(","))
+						.map(String::trim)
+						.filter(s -> !s.isEmpty())
+						.collect(Collectors.toList());
+			}
+
+			if(!pollPathList.isEmpty()) {
+				try (TempClientHelper p4 = new TempClientHelper(null, credential, listener, null)) {
+					for (String pollPath : pollPathList) {
+						// Fetching the latest change for each polling path
+						List<P4Ref> changes = p4.listHaveChangesForPollPath(new P4PollRef(0, pollPath));
+						if (!changes.isEmpty()) {
+							P4Ref latestChange = changes.get(0);
+							P4PollRef pollRef = new P4PollRef(latestChange.getChange(), pollPath);
+							finalPollPathList.add(pollRef);
+						}
+					}
+				} catch (Exception ex) {
+					throw new RuntimeException("Error while processing polling paths: ", ex);
+				}
+			}
+		}
+
 		// Add tagging action to build, enabling label support.
 		TagAction tag = new TagAction(run, credential);
 		tag.setWorkspace(ws);
 		tag.setRefChanges(task.getSyncChange());
+		tag.setPollPathChanges(finalPollPathList);
 		// JENKINS-37442: Make the log file name available
 		tag.setChangelog(changelogFile);
 		// JENKINS-39107: Make Depot location of Jenkins file available

src/main/java/org/jenkinsci/plugins/p4/changes/P4PollRef.java

@@ -0,0 +1,79 @@
+package org.jenkinsci.plugins.p4.changes;
+
+import com.perforce.p4java.core.IChangelistSummary;
+import com.perforce.p4java.core.file.IFileSpec;
+import org.jenkinsci.plugins.p4.client.ClientHelper;
+import org.jenkinsci.plugins.p4.client.ConnectionHelper;
+
+import java.util.List;
+
+public class P4PollRef implements P4Ref {
+
+	private final long change;
+	private final String pollPath;
+
+	public P4PollRef(long change, String pollPath) {
+		this.change = change;
+		this.pollPath = pollPath;
+	}
+
+	@Override
+	public P4ChangeEntry getChangeEntry(ClientHelper p4) throws Exception {
+		P4ChangeEntry cl = new P4ChangeEntry();
+		IChangelistSummary summary = p4.getChangeSummary(change);
+		cl.setChange(p4, summary);
+		return cl;
+	}
+
+	@Override
+	public boolean isLabel() {
+		return false;
+	}
+
+	@Override
+	public boolean isCommit() {
+		return false;
+	}
+
+	@Override
+	public long getChange() {
+		return change;
+	}
+
+	public String getPollPath() {
+		return pollPath;
+	}
+
+	@Override
+	public List<IFileSpec> getFiles(ConnectionHelper p4, int limit) throws Exception {
+		return p4.getChangeFiles(change, limit);
+	}
+
+	@Override
+	public String toString() {
+		return Long.toString(change);
+	}
+
+	@Override
+	public boolean equals(Object obj) {
+		if (obj instanceof P4PollRef) {
+			P4PollRef ref = (P4PollRef) obj;
+			if (ref.getPollPath().equals(this.pollPath) && ref.getChange()==this.change) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+	@Override
+	public int compareTo(Object obj) {
+		if (equals(obj)) {
+			return 0;
+		}
+		if (obj instanceof P4PollRef) {
+			P4PollRef ref = (P4PollRef) obj;
+			return (int) (change - ref.getChange());
+		}
+		throw new ClassCastException();
+	}
+}

src/main/java/org/jenkinsci/plugins/p4/client/ClientHelper.java

@@ -41,6 +41,7 @@
 import org.jenkinsci.plugins.p4.changes.P4ChangeRef;
 import org.jenkinsci.plugins.p4.changes.P4GraphRef;
 import org.jenkinsci.plugins.p4.changes.P4LabelRef;
+import org.jenkinsci.plugins.p4.changes.P4PollRef;
 import org.jenkinsci.plugins.p4.changes.P4Ref;
 import org.jenkinsci.plugins.p4.credentials.P4BaseCredentials;
 import org.jenkinsci.plugins.p4.populate.AutoCleanImpl;
@@ -1388,6 +1389,33 @@ public List<P4Ref> listHaveChanges(List<P4Ref> fromRefs) throws Exception {
 		return listHaveChanges(path);
 	}
 
+	/**
+	 * Fetches a list of changes for a directory poll path (other than client view mapping)
+	 *
+	 * @param from List of from revisions
+	 * @return changelist To Revision
+	 * @throws Exception push up stack
+	 */
+	public List<P4Ref> listHaveChangesForPollPath(P4PollRef from) throws Exception {
+		List<P4Ref> finalChanges = new ArrayList<P4Ref>();
+
+		if (from.getChange() >= 0) {
+			String path = from.getPollPath() + "/...@" + from.getChange() + ",now";
+			log("P4: Polling with range: " + from + ",now for poll path: " + from.getPollPath());
+
+			List<P4Ref> changes = listChanges(path);
+			if (changes.size() > 0) {
+				P4PollRef firstChange = new P4PollRef(changes.get(0).getChange(), from.getPollPath());
+				if (!from.equals(firstChange)) {
+					finalChanges.add(firstChange);
+					return finalChanges;
+				}
+			}
+		}
+
+		return finalChanges;
+	}
+
 	/**
 	 * Fetches a list of changes needed to update the workspace to the specified
 	 * limit. The limit could be a Perforce change number, label or counter.

src/main/java/org/jenkinsci/plugins/p4/tagging/TagAction.java

@@ -10,6 +10,7 @@
 import org.jenkinsci.plugins.p4.PerforceScm;
 import org.jenkinsci.plugins.p4.changes.P4ChangeRef;
 import org.jenkinsci.plugins.p4.changes.P4LabelRef;
+import org.jenkinsci.plugins.p4.changes.P4PollRef;
 import org.jenkinsci.plugins.p4.changes.P4Ref;
 import org.jenkinsci.plugins.p4.changes.P4Revision;
 import org.jenkinsci.plugins.p4.client.ClientHelper;
@@ -41,6 +42,7 @@ public class TagAction extends AbstractScmTagAction {
 	private List<String> tags = new ArrayList<String>();
 
 	private List<P4Ref> refChanges;
+	private List<P4PollRef> pollRefChanges;
 
 	private P4Revision buildChange;
 	private P4Review review;
@@ -298,6 +300,36 @@ public static List<P4Ref> getLastChange(Run<?, ?> run, TaskListener listener, St
 		return changes;
 	}
 
+	public static List<P4PollRef> getLastPollChange(Run<?, ?> run, TaskListener listener, String syncID) {
+		List<P4PollRef> changes = new ArrayList<>();
+
+		List<TagAction> actions = lastActions(run);
+
+		if (actions == null || syncID == null || syncID.isEmpty()) {
+			listener.getLogger().println("No previous build found...");
+			return changes;
+		}
+
+		logger.fine("   using syncID: " + syncID);
+
+		boolean found = false;
+		for (TagAction action : actions) {
+			if (syncID.equals(action.getSyncID())) {
+				List<P4PollRef> pollChanges = action.getPollPathChanges();
+
+				if (pollChanges != null && !pollChanges.isEmpty()) {
+					for (P4PollRef poll : pollChanges) {
+						if (poll.getPollPath() != null && !changes.contains(poll)) {
+							changes.add(poll);
+						}
+					}
+				}
+			}
+		}
+
+		return changes;
+	}
+
 	/**
 	 * Find the last action; use this for environment variable as the last action has the latest values.
 	 *
@@ -353,4 +385,19 @@ public void setJenkinsPath(String jenkinsPath) {
 	public String getJenkinsPath() {
 		return jenkinsPath;
 	}
+
+	public void setPollPathChanges(List<P4Ref> finalPollPathList) {
+		List<P4PollRef> changes = new ArrayList<P4PollRef>();
+
+		for(P4Ref ref : finalPollPathList) {
+			P4PollRef poll = new P4PollRef(ref.getChange(), ((P4PollRef)ref).getPollPath());
+			changes.add(poll);
+		}
+		this.pollRefChanges = changes;
+	}
+
+	public List<P4PollRef> getPollPathChanges() {
+		return this.pollRefChanges;
+	}
+
 }

src/main/java/org/jenkinsci/plugins/p4/tasks/CheckoutTask.java

@@ -14,6 +14,7 @@
 import org.jenkinsci.plugins.p4.changes.P4ChangeEntry;
 import org.jenkinsci.plugins.p4.changes.P4ChangeRef;
 import org.jenkinsci.plugins.p4.changes.P4LabelRef;
+import org.jenkinsci.plugins.p4.changes.P4PollRef;
 import org.jenkinsci.plugins.p4.changes.P4Ref;
 import org.jenkinsci.plugins.p4.client.ClientHelper;
 import org.jenkinsci.plugins.p4.console.P4Logging;
@@ -315,6 +316,9 @@ public List<P4ChangeEntry> getChangesFull(List<P4Ref> lastRefs) {
 					}
 				} else {
 					// add classic changes
+					if(build instanceof P4PollRef) {
+						continue;
+					}
 					List<P4Ref> changes = p4.listChanges(lastRefs, build);
 					for (P4Ref change : changes) {
 						P4ChangeEntry cl = change.getChangeEntry(p4);

src/main/java/org/jenkinsci/plugins/p4/tasks/PollTask.java

@@ -12,6 +12,7 @@
 import jenkins.security.Roles;
 import org.jenkinsci.plugins.p4.changes.P4ChangeRef;
 import org.jenkinsci.plugins.p4.changes.P4LabelRef;
+import org.jenkinsci.plugins.p4.changes.P4PollRef;
 import org.jenkinsci.plugins.p4.changes.P4Ref;
 import org.jenkinsci.plugins.p4.client.ClientHelper;
 import org.jenkinsci.plugins.p4.filters.Filter;
@@ -37,13 +38,15 @@ public class PollTask extends AbstractTask implements FileCallable<List<P4Ref>>,
 
 	private final List<Filter> filter;
 	private final List<P4Ref> lastRefs;
+	private List<P4PollRef> lastPollRefs;
 
 	private String pin;
 
 	public PollTask(String credential, Run<?, ?> run, TaskListener listener, List<Filter> filter, List<P4Ref> lastRefs) {
 		super(credential, run, listener);
 		this.filter = filter;
 		this.lastRefs = lastRefs;
+		this.lastPollRefs = getPollRefChanges();
 	}
 
 	@SuppressWarnings("unchecked")
@@ -94,13 +97,30 @@ public Object task(ClientHelper p4) throws Exception {
 			}
 		}
 
+		// Poll polling path changes
+		if (changes.isEmpty() && !lastPollRefs.isEmpty()) {
+			List<P4Ref> pollChanges = new ArrayList<P4Ref>();
+
+			for (P4PollRef ref : lastPollRefs) {
+				pollChanges = p4.listHaveChangesForPollPath(ref);
+				changes.addAll(pollChanges);
+			}
+		}
 		return changes;
 	}
 
 	public void setLimit(String expandedPin) {
 		pin = expandedPin;
 	}
 
+	public void setPollRefChanges(List<P4PollRef> pollRefs) {
+		lastPollRefs = pollRefs;
+	}
+
+	public List<P4PollRef> getPollRefChanges() {
+		return lastPollRefs;
+	}
+
 	/**
 	 * Returns true if change should be filtered
 	 *

src/main/java/org/jenkinsci/plugins/p4/workspace/WorkspaceSpec.java

@@ -36,6 +36,16 @@ public class WorkspaceSpec extends AbstractDescribableImpl<WorkspaceSpec> implem
 
 	private final String serverID;
 	private final boolean backup;
+	private String pollPath;
+
+	public String getPollPath() {
+		return pollPath;
+	}
+
+	@DataBoundSetter
+	 public void setPollPath(String pollPath) {
+		this.pollPath = pollPath;
+	 }
 
 	public String getStreamName() {
 		return streamName;
@@ -96,6 +106,7 @@ public WorkspaceSpec(boolean allwrite, boolean clobber, boolean compress,
 		this.type = type;
 		this.serverID = serverID;
 		this.backup = backup;
+		this.pollPath = getPollPath();
 	}
 
 	// Default setup for Classic Workspace
@@ -114,6 +125,7 @@ public WorkspaceSpec(String view, String changeView) {
 		this.type = null;
 		this.serverID = null;
 		this.backup = true;
+		this.pollPath = getPollPath();
 	}
 
 	@Deprecated

src/main/resources/org/jenkinsci/plugins/p4/workspace/ManualWorkspaceImpl/config.jelly

@@ -40,6 +40,7 @@
 				document.getElementById("id.stream").value = json.stream;
 				document.getElementById("id.line").value = json.line;
 				document.getElementById("id.view").value = json.view;
+				document.getElementById("id.pollPath").value = json.pollPath;
 			});
 		}
 	</script>