You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@metron.apache.org by merrimanr <gi...@git.apache.org> on 2018/10/10 15:01:51 UTC
[GitHub] metron pull request #1233: METRON-1816: Date format Stellar function
GitHub user merrimanr opened a pull request:
https://github.com/apache/metron/pull/1233
METRON-1816: Date format Stellar function
## Contributor Comments
This PR adds a Stellar function that wraps the Java SimpleDateFormat class. The first argument is a date format string and is required. The second argument is epoch time and is optional (defaults to current time). The third argument is a timezone and is also option (default time zone of the environment is used if missing).
### Testing
This has been tested in full dev:
1. Spin up full dev and launch the Stellar REPL. The `DATE_FORMAT` function should be available:
```
Stellar, Go!
Functions are loading lazily in the background and will be unavailable until loaded fully.
{}
[Stellar]>>> %functions DATE
DATE_FORMAT, IS_DATE
```
2. Create a variable and set it to an epoch time:
```
[Stellar]>>> epoch := 1472131630748L
1472131630748
```
3. Use the `DATE_FORMAT` function to format the value in the epoch field created in the previous step. The result should be a correctly formatted date that matches the format string, epoch time and timezone:
```
[Stellar]>>> DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzz', epoch, 'EST')
Thu Aug 25 2016 08:27:10 EST
```
4. Format the date using the default timezone. The result should match the default timezone of your environment:
```
[Stellar]>>> DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzzz', epoch)
Thu Aug 25 2016 01:27:10 Coordinated Universal Time
```
5. Format the date using the current time:
```
[Stellar]>>> DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzz', 'GMT')
Tue Oct 09 2018 10:13:24 GMT
```
6. Format the date using the current time and default time zone:
```
[Stellar]>>> DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzzz')
Tue Oct 09 2018 10:12:54 Coordinated Universal Time
```
## Pull Request Checklist
Thank you for submitting a contribution to Apache Metron.
Please refer to our [Development Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235) for the complete guide to follow for contributions.
Please refer also to our [Build Verification Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview) for complete smoke testing guides.
In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check the following:
### For all changes:
- [x] Is there a JIRA ticket associated with this PR? If not one needs to be created at [Metron Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
- [x] Does your PR title start with METRON-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
- [x] Has your PR been rebased against the latest commit within the target branch (typically master)?
### For code changes:
- [x] Have you included steps to reproduce the behavior or problem that is being changed or addressed?
- [x] Have you included steps or a guide to how the change may be verified and tested manually?
- [x] Have you ensured that the full suite of tests and checks have been executed in the root metron folder via:
```
mvn -q clean integration-test install && dev-utilities/build-utils/verify_licenses.sh
```
- [x] Have you written or updated unit tests and or integration tests to verify your changes?
- [x] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [x] Have you verified the basic functionality of the build by building and running locally with Vagrant full-dev environment or the equivalent?
### For documentation related changes:
- [x] Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via `site-book/target/site/index.html`:
```
cd site-book
mvn site
```
#### Note:
Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
It is also recommended that [travis-ci](https://travis-ci.org) is set up for your personal repository such that your branches are built there before submitting a pull request.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/merrimanr/incubator-metron METRON-1816
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/1233.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #1233
----
commit 6db3f7dda16ab141af5d342eaa240f61a0e62fd9
Author: merrimanr <me...@...>
Date: 2018-10-10T14:47:10Z
initial commit
commit 1fa9cb9f966d5d88070e4eb75c45aa939d4859b3
Author: merrimanr <me...@...>
Date: 2018-10-10T15:01:22Z
fixed test
----
---
[GitHub] metron issue #1233: METRON-1816: Date format Stellar function
Posted by merrimanr <gi...@git.apache.org>.
Github user merrimanr commented on the issue:
https://github.com/apache/metron/pull/1233
The existing Stellar date functions use SimpleDateFormat and already have a caching layer built in so I decided to reuse what was already there. Happy to switch to DateTimeFormatter here or in a follow on.
---
[GitHub] metron issue #1233: METRON-1816: Date format Stellar function
Posted by simonellistonball <gi...@git.apache.org>.
Github user simonellistonball commented on the issue:
https://github.com/apache/metron/pull/1233
@ottobackwards wouldn't ISO constant support require us to do a check on the string before passing to the DateFormat instance, which on something that is likely to be run A LOT (i.e. multiple times for every message) could actually be a significant for performance, which I would say outweighs the convenience of not having to remember what the format looks like.
---
[GitHub] metron issue #1233: METRON-1816: Date format Stellar function
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on the issue:
https://github.com/apache/metron/pull/1233
I'm not sure what you mean? Can you elaborate?
Also, I'm actually thinking of using DateFormatter and the new java time api's:
https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html
---
[GitHub] metron issue #1233: METRON-1816: Date format Stellar function
Posted by simonellistonball <gi...@git.apache.org>.
Github user simonellistonball commented on the issue:
https://github.com/apache/metron/pull/1233
Right, I hear that! I also really like the idea of a follow on function that returns the default formats as a great solution to this problem. Should we do that?
---
[GitHub] metron pull request #1233: METRON-1816: Date format Stellar function
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/metron/pull/1233
---
[GitHub] metron pull request #1233: METRON-1816: Date format Stellar function
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on a diff in the pull request:
https://github.com/apache/metron/pull/1233#discussion_r226064136
--- Diff: metron-stellar/stellar-common/src/main/java/org/apache/metron/stellar/dsl/functions/DateFunctions.java ---
@@ -109,6 +110,13 @@ public static long getEpochTime(String date, String format, Optional<String> tim
return sdf.parse(date).getTime();
}
+ public static String getDateFormat(String format, Optional<Long> epochTime, Optional<String> timezone) {
+ Long time = epochTime.orElseGet(System::currentTimeMillis);
+ TimezonedFormat fmt = timezone.map(s -> new TimezonedFormat(format, s)).orElseGet(() -> new TimezonedFormat(format));
+ SimpleDateFormat sdf = formatCache.get(fmt).get();
--- End diff --
are there any errors we need to wrap here?
---
[GitHub] metron pull request #1233: METRON-1816: Date format Stellar function
Posted by merrimanr <gi...@git.apache.org>.
Github user merrimanr commented on a diff in the pull request:
https://github.com/apache/metron/pull/1233#discussion_r226383027
--- Diff: metron-stellar/stellar-common/src/main/java/org/apache/metron/stellar/dsl/functions/DateFunctions.java ---
@@ -109,6 +110,13 @@ public static long getEpochTime(String date, String format, Optional<String> tim
return sdf.parse(date).getTime();
}
+ public static String getDateFormat(String format, Optional<Long> epochTime, Optional<String> timezone) {
+ Long time = epochTime.orElseGet(System::currentTimeMillis);
+ TimezonedFormat fmt = timezone.map(s -> new TimezonedFormat(format, s)).orElseGet(() -> new TimezonedFormat(format));
+ SimpleDateFormat sdf = formatCache.get(fmt).get();
--- End diff --
There are no exceptions thrown by any calls in this method. What are you thinking we should do?
---
[GitHub] metron issue #1233: METRON-1816: Date format Stellar function
Posted by simonellistonball <gi...@git.apache.org>.
Github user simonellistonball commented on the issue:
https://github.com/apache/metron/pull/1233
Looks like a very useful gap filler to me. +1 (non-binding) by inspection from me for sure.
---
[GitHub] metron issue #1233: METRON-1816: Date format Stellar function
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on the issue:
https://github.com/apache/metron/pull/1233
we should support the ISO date format constants so that users don't have to copy those formats.
---
[GitHub] metron issue #1233: METRON-1816: Date format Stellar function
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on the issue:
https://github.com/apache/metron/pull/1233
This comes to mind for me, because using Nifi processors that take date formats and in other places I'm sick of cutting and pasting complex ISO formats into configurations when there are named formatters in java. This is just a suggestion, not a blocker.
We could create a new set of Stellar functions or something using an enum of formats like we do with other things in the future.
---
[GitHub] metron issue #1233: METRON-1816: Date format Stellar function
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on the issue:
https://github.com/apache/metron/pull/1233
+1
---
[GitHub] metron pull request #1233: METRON-1816: Date format Stellar function
Posted by merrimanr <gi...@git.apache.org>.
Github user merrimanr commented on a diff in the pull request:
https://github.com/apache/metron/pull/1233#discussion_r226382248
--- Diff: metron-stellar/stellar-common/src/test/java/org/apache/metron/stellar/dsl/functions/DateFunctionsTest.java ---
@@ -225,4 +226,36 @@ public void testDayOfYearNow() {
public void testDayOfYearNull() {
Object result = run("DAY_OF_YEAR(nada)");
}
+
+ @Test
+ public void testDateFormat() {
+ Object result = run("DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzz', epoch, 'EST')");
+ assertEquals("Thu Aug 25 2016 08:27:10 EST", result);
+ }
+
+ @Test
+ public void testDateFormatDefault() {
+ Object result = run("DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzzz')");
+ assertTrue(result.toString().endsWith(TimeZone.getDefault().getDisplayName(true, 1)));
+ }
+
+ @Test
+ public void testDateFormatNow() {
+ Object result = run("DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzz', 'GMT')");
+ assertTrue(result.toString().endsWith("GMT"));
+ }
+
+ @Test
+ public void testDateFormatDefaultTimezone() {
+ Object result = run("DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzzz', epoch)");
+ assertTrue(result.toString().endsWith(TimeZone.getDefault().getDisplayName(true, 1)));
+ }
+
+ /**
+ * If refer to variable that does not exist, expect ParseException.
+ */
+ @Test(expected = ParseException.class)
+ public void testDateFormatNull() {
+ Object result = run("DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzz', nada, 'EST')");
+ }
--- End diff --
Done
---
[GitHub] metron issue #1233: METRON-1816: Date format Stellar function
Posted by simonellistonball <gi...@git.apache.org>.
Github user simonellistonball commented on the issue:
https://github.com/apache/metron/pull/1233
I would worry about having to parse the strong argument to determine whether to use a constant or custom formatter, but I guess my concern is limited because we’re caching the formatter anyway so maybe I’m just over thinking it. Just very conscious we should keep performance at front of mind for this.
---
[GitHub] metron pull request #1233: METRON-1816: Date format Stellar function
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on a diff in the pull request:
https://github.com/apache/metron/pull/1233#discussion_r226064248
--- Diff: metron-stellar/stellar-common/src/test/java/org/apache/metron/stellar/dsl/functions/DateFunctionsTest.java ---
@@ -225,4 +226,36 @@ public void testDayOfYearNow() {
public void testDayOfYearNull() {
Object result = run("DAY_OF_YEAR(nada)");
}
+
+ @Test
+ public void testDateFormat() {
+ Object result = run("DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzz', epoch, 'EST')");
+ assertEquals("Thu Aug 25 2016 08:27:10 EST", result);
+ }
+
+ @Test
+ public void testDateFormatDefault() {
+ Object result = run("DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzzz')");
+ assertTrue(result.toString().endsWith(TimeZone.getDefault().getDisplayName(true, 1)));
+ }
+
+ @Test
+ public void testDateFormatNow() {
+ Object result = run("DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzz', 'GMT')");
+ assertTrue(result.toString().endsWith("GMT"));
+ }
+
+ @Test
+ public void testDateFormatDefaultTimezone() {
+ Object result = run("DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzzz', epoch)");
+ assertTrue(result.toString().endsWith(TimeZone.getDefault().getDisplayName(true, 1)));
+ }
+
+ /**
+ * If refer to variable that does not exist, expect ParseException.
+ */
+ @Test(expected = ParseException.class)
+ public void testDateFormatNull() {
+ Object result = run("DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzz', nada, 'EST')");
+ }
--- End diff --
Can we have a test for an invalid format
---