[Rollup] Remove builders from TermsGroupConfig #32507

tlrx · 2018-07-31T17:21:50Z

While working on adding the Create Rollup Job API to the high level REST client (#29827), I noticed that the configuration objects like TermsGroupConfig rely on the Builder pattern in order to create or parse instances. These builders are doing some validation but the same validation could be done within the constructor itself or on the server side when appropriate.

This pull request removes the builder for TermsGroupConfig, removes some other methods that I consider not really usefull once the TermsGroupConfig object will be exposed in the high level REST client. It also simplifies the parsing logic.

Related to #29827

Remove

elasticmachine · 2018-07-31T17:21:52Z

Pinging @elastic/es-search-aggs

jimczi

Nice cleanup, I left some comments but only to remind us that we should do the same for the other group configs.

jimczi · 2018-07-31T18:52:10Z

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/rollup/job/TermsGroupConfig.java

-public class TermsGroupConfig implements Writeable, ToXContentFragment {
-    private static final String NAME = "term_group_config";
-    public static final ObjectParser<TermsGroupConfig.Builder, Void> PARSER = new ObjectParser<>(NAME, TermsGroupConfig.Builder::new);
+public class TermsGroupConfig implements Writeable, ToXContentObject {


The other configs should also implement ToXContentObject and change their toXContent but let's do that in a follow up.

I agree and I'll take care of this if that's OK. I already have most of the changes in a local branch.

jimczi · 2018-07-31T18:54:40Z

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/rollup/job/TermsGroupConfig.java

-                throw new IllegalArgumentException("Parameter [" + FIELDS + "] must have at least one value.");
-            }
-            return new TermsGroupConfig(fields.toArray(new String[0]));
-        }


We should also remove the other builders to be consistent. WDYT @polyfractal ? I can do that in a follow up.

I agree and I'll take care of this if that's OK. I already have most of the changes in a local branch.

go for it, thanks @tlrx !

tlrx · 2018-07-31T19:03:22Z

@jimczi sorry, I didn't give enough background. I'm doing these cleanups so that we can expose the other configs more safely in the high level rest client. I already have most of the changes in a local branch.

I plan to remove the builders in all config objects, also simplify the parsing logic everywhere, and also remove the toBuilders() and toAggCap() methods. Once it's done I'll be able to move the config objects and the PutRollupJobRequest object in the right place.

But now I have two reviewers ;)

polyfractal

LGTM too :) Thanks @tlrx

polyfractal · 2018-07-31T21:00:06Z

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/rollup/job/TermsGroupConfig.java

@@ -94,14 +103,6 @@ private TermsGroupConfig(String[] fields) {
        return map;
    }

-    public Map<String, Object> getMetadata() {
-        return Collections.emptyMap();


Just a note: this is a no-op for Terms, but the other groups (date, histo) use it to store the interval. So we'll need to preserve that functionality somehow/somewhere for the other groups

I agree, we'll keep this for the other groups.

polyfractal · 2018-07-31T21:02:24Z

and also remove the toBuilders() and toAggCap() methods.

Is the plan to move this functionality into the indexer and capabilities APIs, or something else?

tlrx · 2018-08-01T07:47:24Z

Is the plan to move this functionality into the indexer and capabilities APIs, or something else?

Yes, something like this. We need to remove them from the config objects that will be exposed through the high level rest client.

While working on adding the Create Rollup Job API to the high level REST client (#29827), I noticed that the configuration objects like TermsGroupConfig rely on the Builder pattern in order to create or parse instances. These builders are doing some validation but the same validation could be done within the constructor itself or on the server side when appropriate. This commit removes the builder for TermsGroupConfig, removes some other methods that I consider not really usefull once the TermsGroupConfig object will be exposed in the high level REST client. It also simplifies the parsing logic. Related to #29827

tlrx · 2018-08-01T08:03:31Z

Thanks @jimczi and @polyfractal !

@throws

* 6.x: Fix scriptdocvalues tests with dates Correct minor typo in explain.asciidoc for HLRC Fix painless whitelist and warnings from backporting #31441 Build: Add elastic maven to repos used by BuildPlugin (#32549) Scripting: Conditionally use java time api in scripting (#31441) [ML] Improve error when no available field exists for rule scope (#32550) [ML] Improve error for functions with limited rule condition support (#32548) [ML] Remove multiple_bucket_spans [ML] Fix thread leak when waiting for job flush (#32196) (#32541) Painless: Clean Up PainlessField (#32525) Add @AwaitsFix for #32554 Remove broken @link in Javadoc Add AwaitsFix to failing test - see #32546 SQL: Added support for string manipulating functions with more than one parameter (#32356) [DOCS] Reloadable Secure Settings (#31713) Fix compilation error introduced by #32339 [Rollup] Remove builders from TermsGroupConfig (#32507) Use hostname instead of IP with SPNEGO test (#32514) Switch x-pack rolling restart to new style Requests (#32339) [DOCS] Small fixes in rule configuration page (#32516) Painless: Clean up PainlessMethod (#32476) SQL: Add test for handling of partial results (#32474) Docs: Add missing migration doc for logging change Build: Remove shadowing from benchmarks (#32475) Docs: Add all JDKs to CONTRIBUTING.md Logging: Make node name consistent in logger (#31588) High-level client: fix clusterAlias parsing in SearchHit (#32465) REST high-level client: parse back _ignored meta field (#32362) backport fix of reduceRandom fix (#32508) Add licensing enforcement for FIPS mode (#32437) INGEST: Clean up Java8 Stream Usage (#32059) (#32485) Improve the error message when an index is incompatible with field aliases. (#32482) Mute testFilterCacheStats Scripting: Fix painless compiler loader to know about context classes (#32385) [ML][DOCS] Fix typo applied_to => applies_to Mute SSLTrustRestrictionsTests on JDK 11 Changed ReindexRequest to use Writeable.Reader (#32401) Increase max chunk size to 256Mb for repo-azure (#32101) Mute KerberosAuthenticationIT fix no=>not typo (#32463) HLRC: Add delete watch action (#32337) Fix calculation of orientation of polygons (#27967) [Kerberos] Add missing javadocs (#32469) Fix missing JavaDoc for @throws in several places in KerberosTicketValidator. Make get all app privs requires "*" permission (#32460) Ensure KeyStoreWrapper decryption exceptions are handled (#32472) update rollover to leverage write-alias semantics (#32216) [Kerberos] Remove Kerberos bootstrap checks (#32451) Switch security to new style Requests (#32290) Switch security spi example to new style Requests (#32341) Painless: Add PainlessConstructor (#32447) Update Fuzzy Query docs to clarify default behavior re max_expansions (#30819) Remove > from Javadoc (fatal with Java 11) Tests: Fix convert error tests to use fixed value (#32415) IndicesClusterStateService should replace an init. replica with an init. primary with the same aId (#32374) auto-interval date histogram - 6.x backport (#32107) [CI] Mute DocumentSubsetReaderTests testSearch [TEST] Mute failing InternalEngineTests#testSeqNoAndCheckpoints TEST: testDocStats should always use forceMerge (#32450) TEST: Avoid deletion in FlushIT AwaitsFix IndexShardTests#testDocStats Painless: Add method type to method. (#32441) Remove reference to non-existent store type (#32418) [TEST] Mute failing FlushIT test Fix ordering of bootstrap checks in docs (#32417) Wrong discovery.type for azure in breaking changes (#32432) Mute ConvertProcessorTests failing tests TESTS: Move netty leak detection to paranoid level (#32354) (#32425) Upgrade to Lucene-7.5.0-snapshot-608f0277b0 (#32390) [Kerberos] Avoid vagrant update on precommit (#32416) TEST: Avoid triggering merges in FlushIT [DOCS] Fixes formatting of scope object in job resource Switch x-pack/plugin to new style Requests (#32327) Release requests in cors handle (#32410) Remove BouncyCastle dependency from runtime (#32402) Copy missing segment attributes in getSegmentInfo (#32396) Rest HL client: Add put license action (#32214) Docs: Correcting a typo in tophits (#32359) Build: Stop double generating buildSrc pom (#32408) Switch x-pack full restart to new style Requests (#32294) Painless: Clean Up PainlessClass Variables (#32380) [ML] Consistent pattern for strict/lenient parser names (#32399) Add Restore Snapshot High Level REST API Update update-settings.asciidoc (#31378) Introduce index store plugins (#32375) Rank-Eval: Reduce scope of an unchecked supression Make sure _forcemerge respects `max_num_segments`. (#32291)

* master: HLRC: Move commercial clients from XPackClient (#32596) Add cluster UUID to Cluster Stats API response (#32206) Security: move User to protocol project (#32367) [TEST] Test for shard failures, add debug to testProfileMatchesRegular Minor fix for javadoc (applicable for java 11). (#32573) Painless: Move Some Lookup Logic to PainlessLookup (#32565) TEST: Avoid merges in testSeqNoAndCheckpoints [Rollup] Remove builders from HistoGroupConfig (#32533) Mutes failing SQL string function tests due to #32589 fixed elements in array of produced terms (#32519) INGEST: Enable default pipelines (#32286) Remove cluster state initial customs (#32501) Mutes LicensingDocumentationIT due to #32580 [ML] Remove multiple_bucket_spans (#32496) [ML] Rename JobProvider to JobResultsProvider (#32551) Correct minor typo in explain.asciidoc for HLRC Build: Add elastic maven to repos used by BuildPlugin (#32549) Clarify the error message when a pipeline agg is used in the 'order' parameter. (#32522) Revert "[test] turn on host io cache for opensuse (#32053)" Enable packaging tests on suse boxes [ML] Improve error when no available field exists for rule scope (#32550) [ML] Improve error for functions with limited rule condition support (#32548) Painless: Clean Up PainlessField (#32525) Add @AwaitsFix for #32554 Remove broken @link in Javadoc Scripting: Conditionally use java time api in scripting (#31441) [ML] Fix thread leak when waiting for job flush (#32196) (#32541) Add AwaitsFix to failing test - see #32546 Core: Minor size reduction for AbstractComponent (#32509) SQL: Added support for string manipulating functions with more than one parameter (#32356) [DOCS] Reloadable Secure Settings (#31713) Watcher: Reenable HttpSecretsIntegrationTests#testWebhookAction test (#32456) [Rollup] Remove builders from TermsGroupConfig (#32507) Use hostname instead of IP with SPNEGO test (#32514) Switch x-pack rolling restart to new style Requests (#32339) NETWORKING: Fix Netty Leaks by upgrading to 4.1.28 (#32511) [DOCS] Small fixes in rule configuration page (#32516) Painless: Clean up PainlessMethod (#32476) Build: Remove shadowing from benchmarks (#32475) Docs: Add all JDKs to CONTRIBUTING.md Add licensing enforcement for FIPS mode (#32437) SQL: Add test for handling of partial results (#32474) Mute testFilterCacheStats [ML][DOCS] Fix typo applied_to => applies_to Scripting: Fix painless compiler loader to know about context classes (#32385)

Same motivation as #32507 but for the DateHistogramGroupConfig configuration object. This pull request also changes the format of the time zone from a Joda's DateTimeZone to a simple String. It should help to port the API to the high level rest client and allows clients to not be forced to use the Joda Time library. Serialization is impacted but does not need a backward compatibility layer as DateTimeZone are serialized as String anyway. XContent also expects a String for timezone, so I found it easier to move everything to String. Related to #29827

[Rollup] Remove builders from TermsGroupConfig

4f4e07b

Remove

tlrx added review v7.0.0 >refactoring :StorageEngine/Rollup Turn fine-grained time-based data into coarser-grained data labels Jul 31, 2018

tlrx requested a review from polyfractal July 31, 2018 17:21

jimczi approved these changes Jul 31, 2018

View reviewed changes

$polyfractal$

polyfractal approved these changes Jul 31, 2018

View reviewed changes

$polyfractal$

polyfractal reviewed Jul 31, 2018

View reviewed changes

tlrx merged commit 82fe67b into elastic:master Aug 1, 2018

tlrx deleted the remove-builders-from-rollup-terms-group-config branch August 1, 2018 07:47

tlrx added the v6.5.0 label Aug 1, 2018

This was referenced Aug 1, 2018

[Rollup] Remove builders from HistoGroupConfig #32533

Merged

[Rollup] Remove builders from MetricConfig #32536

Merged

[Rollup] Remove builders from DateHistogramGroupConfig #32555

Merged

colings86 added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Rollup] Remove builders from TermsGroupConfig #32507

[Rollup] Remove builders from TermsGroupConfig #32507

tlrx commented Jul 31, 2018 •

edited

Loading

elasticmachine commented Jul 31, 2018

jimczi left a comment

jimczi Jul 31, 2018

tlrx Jul 31, 2018

jimczi Jul 31, 2018

tlrx Jul 31, 2018

jimczi Jul 31, 2018

tlrx commented Jul 31, 2018

$@polyfractal$ polyfractal left a comment

$@polyfractal$ polyfractal Jul 31, 2018

tlrx Aug 1, 2018

polyfractal commented Jul 31, 2018

tlrx commented Aug 1, 2018

tlrx commented Aug 1, 2018

[Rollup] Remove builders from TermsGroupConfig #32507

[Rollup] Remove builders from TermsGroupConfig #32507

Conversation

tlrx commented Jul 31, 2018 • edited Loading

elasticmachine commented Jul 31, 2018

jimczi left a comment

Choose a reason for hiding this comment

jimczi Jul 31, 2018

Choose a reason for hiding this comment

tlrx Jul 31, 2018

Choose a reason for hiding this comment

jimczi Jul 31, 2018

Choose a reason for hiding this comment

tlrx Jul 31, 2018

Choose a reason for hiding this comment

jimczi Jul 31, 2018

Choose a reason for hiding this comment

tlrx commented Jul 31, 2018

polyfractal left a comment

Choose a reason for hiding this comment

polyfractal Jul 31, 2018

Choose a reason for hiding this comment

tlrx Aug 1, 2018

Choose a reason for hiding this comment

polyfractal commented Jul 31, 2018

tlrx commented Aug 1, 2018

tlrx commented Aug 1, 2018

tlrx commented Jul 31, 2018 •

edited

Loading

$@polyfractal$ polyfractal left a comment

$@polyfractal$ polyfractal Jul 31, 2018