Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Optimize JobLocalConfiguration #321

Merged
merged 2 commits into from
Aug 24, 2024
Merged

Optimize JobLocalConfiguration #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b9aa9d
Optimize `JobLocalConfiguration`
jglick Aug 2, 2024
8e11b89
Simpler to just keep the change comment in memory
jglick Aug 9, 2024
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
72 changes: 1 addition & 71 deletions src/main/java/hudson/plugins/jobConfigHistory/FileHistoryDao.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,6 @@
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.SystemUtils;
import org.w3c.dom.Document;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;

import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileFilter;
Expand Down Expand Up @@ -353,69 +343,9 @@ private void createNewHistoryEntryAndCopyConfig(final XmlFile configFile,
}
}

/**
* Find this in the configFile:<br>
* &emsp; &lt;hudson.plugins.jobConfigHistory.JobLocalConfiguration plugin="jobConfigHistory@2.25-SNAPSHOT"&gt;<br>
* &emsp; &emsp; &lt;changeReasonComment&gt;MY_CHANGE_REASON_COMMENT&lt;/changeReasonComment&gt;<br>
* &emsp; &lt;/hudson.plugins.jobConfigHistory.JobLocalConfiguration&gt;<br>
* and delete it, receiving the changeReasonComment, if present.
*
* @param configFile the config file
* @return the String in changeReasonComment, if found. Optional.empty(), else.
* @throws IOException configFile is read.
* @throws SAXException parsing the configFile.
* @throws TransformerException parsing the configFile.
* @throws ParserConfigurationException configuring the xml parser.
*/
private Optional<String> removeChangeReasonComment(final XmlFile configFile) throws IOException, SAXException, TransformerException, ParserConfigurationException {
Document configFiledocument = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(configFile.getFile());

NodeList jobLocalConfigurationNodes = configFiledocument.getElementsByTagName(JobConfigHistoryConsts.JOB_LOCAL_CONFIGURATION_XML_TAG);
if (jobLocalConfigurationNodes.getLength() > 1) {
LOG.log(FINEST, "tag \"{0}\" found twice in {1}, not saving the change reason comment.",
new Object[]{JobConfigHistoryConsts.JOB_LOCAL_CONFIGURATION_XML_TAG, configFile.getFile()});
return Optional.empty();
} else if (jobLocalConfigurationNodes.getLength() == 1) {
org.w3c.dom.Node jobLocalConfiguration = jobLocalConfigurationNodes.item(0);
NodeList jlcChildren = jobLocalConfiguration.getChildNodes();
org.w3c.dom.Node changeReasonCommentNode = null;
for (int i = 0; i < jlcChildren.getLength(); ++i) {
org.w3c.dom.Node node = jlcChildren.item(i);
if (node.getNodeName().equals(JobConfigHistoryConsts.CHANGE_REASON_COMMENT_XML_TAG)) {
changeReasonCommentNode = node;
}
}
if (changeReasonCommentNode != null) {
//tag is found. Might contain no comment (getTextContent() returns "").
String changeReasonComment = changeReasonCommentNode.getTextContent();
if (changeReasonComment != null) {
//delete jobLocalConfiguration node from document
jobLocalConfiguration.getParentNode().removeChild(jobLocalConfiguration);
//save xml
TransformerFactory.newInstance().newTransformer()
.transform(new DOMSource(configFiledocument), new StreamResult(configFile.getFile()));

return changeReasonComment.isEmpty() ? Optional.empty() : Optional.of(changeReasonComment);
} else return Optional.empty();
} else return Optional.empty();
} else {
//no jobLocalConfiguration node found. Should be there even if the message field was empty!
LOG.log(FINEST, "tag \"{0}\" not found in {1}, no comment could be found.",
new Object[]{JobConfigHistoryConsts.JOB_LOCAL_CONFIGURATION_XML_TAG, configFile.getFile()});
return Optional.empty();
}
}

@Override
public void saveItem(final XmlFile file) {
//remove the changeReasonComment entry from the xml file. (before checking duplicates!)
Optional<String> changeReasonCommentOptional;
try {
changeReasonCommentOptional = removeChangeReasonComment(file);
} catch (IOException | SAXException | TransformerException | ParserConfigurationException e) {
LOG.log(WARNING, "Error occurred while trying to extract changeReasonComment from config file: {0}", e);
changeReasonCommentOptional = Optional.empty();
}
Optional<String> changeReasonCommentOptional = JobLocalConfiguration.lastChangeReasonComment(file);

if (checkDuplicate(file)) {
createNewHistoryEntryAndCopyConfig(file,
Expand Down
23 changes: 23 additions & 0 deletions src/main/java/hudson/plugins/jobConfigHistory/JobLocalConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
package hudson.plugins.jobConfigHistory;

import hudson.Extension;
import hudson.Util;
import hudson.XmlFile;
import hudson.model.AbstractProject;
import hudson.model.Item;
import hudson.model.Job;
import hudson.model.JobProperty;
import hudson.model.JobPropertyDescriptor;
import hudson.util.FormValidation;
import java.io.File;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import net.sf.json.JSONObject;
import org.kohsuke.stapler.AncestorInPath;
import org.kohsuke.stapler.DataBoundConstructor;
Expand All @@ -20,6 +27,12 @@
private static final Logger LOG = Logger
.getLogger(JobLocalConfiguration.class.getName());

private static final Map<File, String> lastChangeReasonCommentByXmlFile = Collections.synchronizedMap(new HashMap<>());

static Optional<String> lastChangeReasonComment(XmlFile file) {
return Optional.ofNullable(lastChangeReasonCommentByXmlFile.remove(file.getFile()));
}

private final String changeReasonComment;


Expand Down Expand Up @@ -48,6 +61,16 @@
return true;
}

@Override
public JobProperty<?> newInstance(StaplerRequest req, JSONObject formData) throws FormException {
JobLocalConfiguration jp = (JobLocalConfiguration) super.newInstance(req, formData);
Job<?, ?> job = req.findAncestorObject(Job.class);
if (job != null) {
lastChangeReasonCommentByXmlFile.put(job.getConfigFile().getFile(), Util.fixEmptyAndTrim(jp.changeReasonComment));
}
return null;

Check warning on line 71 in src/main/java/hudson/plugins/jobConfigHistory/JobLocalConfiguration.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Not covered lines 

Lines 66-71 are not covered by tests
}

public boolean configure(StaplerRequest request, JSONObject jsonObject) throws FormException {
LOG.info("CONFIGURE");
throw new FormException("form exception", "localValues.changeReasonComment");
Expand Down