Skip to content

Use mime type from config field in Elasticsearch indexer while posting HTTP request #41

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

Merged
jakub-bochenski merged 10 commits into from
May 8, 2018
Merged

Use mime type from config field in Elasticsearch indexer while posting HTTP request #41

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a359903
Drop charset from content type in Elasticsearch indexer
Dec 16, 2017
117ee91
Refactor to make code unit-testable
Dec 22, 2017
d6e2d73
Merge branch 'master' into master
VamanKulkarni Dec 28, 2017
7576829
Merge branch 'master' into master
VamanKulkarni Feb 18, 2018
4146ffe
Updates required due to code refactoring
Feb 18, 2018
722137e
Merge branch 'master' of https://github.com/jenkinsci/logstash-plugin
Mar 31, 2018
6a670a5
Do not allow invalid mimetype to be saved
Apr 1, 2018
4fabced
Merge branch 'master' of https://github.com/jenkinsci/logstash-plugin
Apr 14, 2018
e67b6a8
Incorporate review comments
Apr 14, 2018
ed77e45
Incorporate review comments
May 8, 2018
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
11 changes: 11 additions & 0 deletions src/main/java/jenkins/plugins/logstash/LogstashInstallation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ public static final class Descriptor extends ToolDescriptor<LogstashInstallation
public String username;
public String password;
public String key;
public String mimeType;

public Descriptor() {
super();
Expand Down Expand Up @@ -124,5 +125,15 @@ public FormValidation doCheckString(@QueryParameter("value") String value) {

return FormValidation.ok();
}
public FormValidation doCheckMimeType(@QueryParameter("value") String value) {
if (StringUtils.isBlank(value)) {
return FormValidation.error(Messages.ValueIsRequired());
}
// Mime type validation as per RFC-4288.
if (!value.matches("^[\\w#&+_$.\\-\\^]+/[\\w#&+_$.\\-\\^]+$")) {
Copy link

@jakub-bochenski jakub-bochenski Dec 22, 2017

Choose a reason for hiding this comment

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

I think it's better to reuse https://hc.apache.org/httpcomponents-core-ga/httpcore/apidocs/org/apache/http/entity/ContentType.html#parse(java.lang.String)

Copy link
Author

@VamanKulkarni VamanKulkarni Dec 23, 2017

Choose a reason for hiding this comment

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

I did think of this earlier. But I did not end up using it in my code because I realized it does not actually parse Mime-Type. for e.g. ContentType.parse("application/json%%") (which is clearly not a valid mime-type) does not complain instead it returns ContentType object with this invalid mimetype.
For this reason I did not use it in the code and ended up validating by my own as per RFC-4288. This would potentially eliminate unwanted surprises that could cause with invalid mime-type.

Copy link

@jakub-bochenski jakub-bochenski Dec 28, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

OK, I assumed

    ParseException - if the given text does not represent a valid Content-Type value.

means it does validate it

Copy link
Author

@VamanKulkarni VamanKulkarni Dec 29, 2017

Choose a reason for hiding this comment

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

It just validates Content-Type as a whole and does not look for mime-type validity.

Copy link

@mwinter69 mwinter69 Dec 29, 2017

Choose a reason for hiding this comment

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

You could use javax.activation.MimeType
This does validate the mimetype. Though it seems & is a valid character in a mimetype. Mimetype fails when you use §
see RFC 2045

return FormValidation.error(Messages.ProvideValidMimeType());
}
return FormValidation.ok();
}
}
}
18 changes: 15 additions & 3 deletions src/main/java/jenkins/plugins/logstash/persistence/ElasticSearchDao.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,14 @@
import java.io.PrintStream;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.StandardCharsets;

import com.google.common.collect.Range;

import jenkins.model.Jenkins;
import jenkins.plugins.logstash.LogstashInstallation;
import jenkins.plugins.logstash.LogstashInstallation.Descriptor;

/**
* Elastic Search Data Access Object.
*
Expand Down Expand Up @@ -94,9 +99,16 @@ public ElasticSearchDao(String host, int port, String key, String username, Stri
}

HttpPost getHttpPost(String data) {
HttpPost postRequest;
postRequest = new HttpPost(uri);
StringEntity input = new StringEntity(data, ContentType.APPLICATION_JSON);
HttpPost postRequest = new HttpPost(uri);
// char encoding is set to UTF_8 since this request posts a JSON string
StringEntity input = new StringEntity(data, StandardCharsets.UTF_8);
try {
Descriptor logstashPluginConfig = (Descriptor) Jenkins.getInstance().getDescriptor(LogstashInstallation.class);
input.setContentType(logstashPluginConfig.mimeType);
} catch (NullPointerException e){
input.setContentType(ContentType.APPLICATION_JSON.toString());
}

postRequest.setEntity(input);
if (auth != null) {
postRequest.addHeader("Authorization", "Basic " + auth);
Expand Down
4 changes: 4 additions & 0 deletions src/main/resources/jenkins/plugins/logstash/LogstashInstallation/global.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
checkUrl="'${resURL}/descriptorByName/LogstashInstallation/checkString?value='+escape(this.value)" />
</f:entry>
<f:advanced>
<f:entry title="${%MIME type}" field="mimeType">
<f:textbox value="${descriptor.mimeType}" default="application/json"
Copy link

@jakub-bochenski jakub-bochenski Dec 22, 2017

Choose a reason for hiding this comment

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

I'm not sure if the existing installations will get null or the default value.
Can we set the default to match the previous value?

Copy link
Author

@VamanKulkarni VamanKulkarni Dec 23, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

I am not sure if I understand that correctly. Even in case of null, Content-Type will be set to ContentType.APPLICATION_JSON. Default value is no different then the previous one it is just that it is set in different way :) i.e. the default value is set to application/json and the String entity is initialized with charset=UTF-8.

Copy link

@jakub-bochenski jakub-bochenski Dec 28, 2017

Choose a reason for hiding this comment

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

OK I get it now.
Can we make it more explicit in the description that the mimeType input doesn't accept any parameters (incl. charset)?

checkUrl="'${resURL}/descriptorByName/LogstashInstallation/checkMimeType?value='+escape(this.value)" />
</f:entry>
<f:entry title="${%Syslog format}" field="syslogFormat">
<f:enum value="${descriptor.syslogFormat}">${it.name()}</f:enum>
</f:entry>
Expand Down
6 changes: 6 additions & 0 deletions src/main/resources/jenkins/plugins/logstash/LogstashInstallation/help-mimeType.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<div>
<p>
MIME type of the request body that is sent to ELASTICSEARCH indexer. It should be at least of the form <b>type/subtype</b><br>
For e.g. <i>application/json</i>
</p>
</div>
1 change: 1 addition & 0 deletions src/main/resources/jenkins/plugins/logstash/Messages.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ DisplayName = Send console log to Logstash
ValueIsInt = Value must be an integer
ValueIsRequired = Value is required
PleaseProvideHost = Please set a valid host name
ProvideValidMimeType = Please provide valid MIME type. (e.g application/json)