Skip to content

Painless: Add whitelist extensions#28161

Merged
rjernst merged 4 commits intoelastic:masterfrom
rjernst:painless_whitelist
Jan 15, 2018
Merged

Painless: Add whitelist extensions#28161
rjernst merged 4 commits intoelastic:masterfrom
rjernst:painless_whitelist

Conversation

@rjernst
Copy link
Copy Markdown
Member

@rjernst rjernst commented Jan 9, 2018

This commit adds a PainlessExtension which may be plugged in via SPI to
add additional classes, methods and members to the painless whitelist on
a per context basis. An example plugin adding and using a whitelist is
also added.

@rjernst
Painless: Add whitelist extensions
60e44d1 
This commit adds a PainlessExtension which may be plugged in via SPI to
add additional classes, methods and members to the painless whitelist on
a per context basis. An example plugin adding and using a whitelist is
also added.
@rjernst
Copy link
Copy Markdown
Member Author

rjernst commented Jan 9, 2018

@debadair I'm really not sure where to link/mention this in the docs. The example plugin I've added here is the "source of truth" for this feature, so I don't really want to add any code to docs, but referencing the file and mentioning it is possible somewhere might be good. Can you suggest a place (or it could be done as a followup)?

jdconrad
jdconrad approved these changes Jan 9, 2018
View reviewed changes
Copy link
Copy Markdown
Contributor

@jdconrad jdconrad left a comment

Choose a reason for hiding this comment

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

LGTM. We've worked closely enough on this together that any changes I would have requested have already been made. Thanks for doing this!

@jdconrad
Copy link
Copy Markdown
Contributor

jdconrad commented Jan 10, 2018

@rjernst Looked into the failure - noting here. We either need to move the resource files to the same package as Whitelist was moved to or we need to update the WHITELIST_FILES constant to point to the appropriate files.

@jdconrad
Copy link
Copy Markdown
Contributor

jdconrad commented Jan 10, 2018

I pushed a fix.

@jdconrad
Copy link
Copy Markdown
Contributor

jdconrad commented Jan 10, 2018

@elasticmachine Please test this.

@rjernst rjernst merged commit 18463e7 into elastic:master Jan 15, 2018
@rjernst rjernst deleted the painless_whitelist branch January 15, 2018 19:28
rjernst added a commit that referenced this pull request Jan 15, 2018
@rjernst
Painless: Add whitelist extensions (#28161)
f84a8af 
This commit adds a PainlessExtension which may be plugged in via SPI to
add additional classes, methods and members to the painless whitelist on
a per context basis. An example plugin adding and using a whitelist is
also added.
jasontedor added a commit to jasontedor/elasticsearch that referenced this pull request Jan 15, 2018
@jasontedor
Merge branch 'master' into compile-with-jdk-9
30dbcb4 
* master: (21 commits)
  [GEO] Add WKT Support to GeoBoundingBoxQueryBuilder
  Painless: Add whitelist extensions (elastic#28161)
  Fix daitch_mokotoff phonetic filter to use the dedicated Lucene filter (elastic#28225)
  Avoid doing redundant work when checking for self references. (elastic#26927)
  Fix casts in HotThreads. (elastic#27578)
  Ignore the `-snapshot` suffix when comparing the Lucene version in the build and the docs. (elastic#27927)
  Allow update of `eager_global_ordinals` on `_parent`. (elastic#28014)
  Fix NPE on composite aggregation with sub-aggregations that need scores (elastic#28129)
  `MockTcpTransport` to connect asynchronously (elastic#28203)
  Fix synonym phrase query expansion for cross_fields parsing (elastic#28045)
  Introduce elasticsearch-core jar (elastic#28191)
  elastic#28218: Update the Lucene version for 6.2.0 after backport
  upgrade to lucene 7.2.1 (elastic#28218)
  [Docs] Fix an error in painless-types.asciidoc (elastic#28221)
  Adds metadata to rewritten aggregations (elastic#28185)
  Update version of TaskInfo header serialization after backport
  TEST: Tightens file-based condition in peer-recovery
  Correct backport replica rollback to 6.2 (elastic#28181)
  Backport replica rollback to 6.2 (elastic#28181)
  Rename deleteLocalTranslog to createNewTranslog
  ...
martijnvg added a commit that referenced this pull request Jan 16, 2018
@martijnvg
Merge remote-tracking branch 'es/6.x' into ccr-6.x
76809e7 
* es/6.x: (31 commits)
  Fix eclipse build. (#28236)
  Never return null from Strings.tokenizeToStringArray (#28224)
  Fallback to TransportMasterNodeAction for cluster health retries (#28195)
  [Docs] Changes to ingest.asciidoc (#28212)
  TEST: Update logging for testAckedIndexing
  [GEO] Deprecate field parameter in GeoBoundingBoxQueryBuilder
  [GEO] Add WKT Support to GeoBoundingBoxQueryBuilder
  Avoid doing redundant work when checking for self references. (#26927)
  Fix casts in HotThreads. (#27578)
  Ignore the `-snapshot` suffix when comparing the Lucene version in the build and the docs. (#27927)
  Allow update of `eager_global_ordinals` on `_parent`. (#28014)
  Painless: Add whitelist extensions (#28161)
  Fix daitch_mokotoff phonetic filter to use the dedicated Lucene filter (#28225)
  Fix NPE on composite aggregation with sub-aggregations that need scores (#28129)
  #28045 restore removed import after backport
  Fix synonym phrase query expansion for cross_fields parsing (#28045)
  Introduce elasticsearch-core jar (#28191)
  upgrade to lucene 7.2.1 (#28218)
  [Docs] Fix an error in painless-types.asciidoc (#28221)
  Consistent updates of IndexShardSnapshotStatus (#28130)
  ...
martijnvg added a commit that referenced this pull request Jan 16, 2018
@martijnvg
Merge remote-tracking branch 'es/master' into ccr
f2093e7 
* es/master: (30 commits)
  [Docs] Fix Java Api index administration usage (#28133)
  Fix eclipse build. (#28236)
  Never return null from Strings.tokenizeToStringArray (#28224)
  Fallback to TransportMasterNodeAction for cluster health retries (#28195)
  [Docs] Changes to ingest.asciidoc (#28212)
  TEST: Update logging for testAckedIndexing
  [GEO] Add WKT Support to GeoBoundingBoxQueryBuilder
  Painless: Add whitelist extensions (#28161)
  Fix daitch_mokotoff phonetic filter to use the dedicated Lucene filter (#28225)
  Avoid doing redundant work when checking for self references. (#26927)
  Fix casts in HotThreads. (#27578)
  Ignore the `-snapshot` suffix when comparing the Lucene version in the build and the docs. (#27927)
  Allow update of `eager_global_ordinals` on `_parent`. (#28014)
  Fix NPE on composite aggregation with sub-aggregations that need scores (#28129)
  `MockTcpTransport` to connect asynchronously (#28203)
  Fix synonym phrase query expansion for cross_fields parsing (#28045)
  Introduce elasticsearch-core jar (#28191)
  #28218: Update the Lucene version for 6.2.0 after backport
  upgrade to lucene 7.2.1 (#28218)
  [Docs] Fix an error in painless-types.asciidoc (#28221)
  ...
jasontedor added a commit to jasontedor/elasticsearch that referenced this pull request Jan 16, 2018
@jasontedor
Merge branch 'master' into mrjar
57972df 
* master: (35 commits)
  Move the multi-get response tests to server
  Require JDK 9 for compilation (elastic#28071)
  Revert "[Docs] Fix Java Api index administration usage (elastic#28133)"
  Revert "[Docs] Fix base directory to include for put_mapping.asciidoc"
  Added multi get api to the high level rest client.
  [Docs] Clarify numeric datatype ranges (elastic#28240)
  [Docs] Fix base directory to include for put_mapping.asciidoc
  Open engine should keep only starting commit (elastic#28228)
  [Docs] Fix Java Api index administration usage (elastic#28133)
  Fix eclipse build. (elastic#28236)
  Never return null from Strings.tokenizeToStringArray (elastic#28224)
  Fallback to TransportMasterNodeAction for cluster health retries (elastic#28195)
  [Docs] Changes to ingest.asciidoc (elastic#28212)
  TEST: Update logging for testAckedIndexing
  [GEO] Add WKT Support to GeoBoundingBoxQueryBuilder
  Painless: Add whitelist extensions (elastic#28161)
  Fix daitch_mokotoff phonetic filter to use the dedicated Lucene filter (elastic#28225)
  Avoid doing redundant work when checking for self references. (elastic#26927)
  Fix casts in HotThreads. (elastic#27578)
  Ignore the `-snapshot` suffix when comparing the Lucene version in the build and the docs. (elastic#27927)
  ...
@polyfractal polyfractal mentioned this pull request Jan 18, 2018
Closed
@clintongormley clintongormley added :Core/Infra/Scripting Scripting abstractions, Painless, and Mustache and removed :Plugin Lang Painless labels Feb 14, 2018
@byoungb
Copy link
Copy Markdown

byoungb commented Feb 21, 2018

Any chance on allowing these newly whitelisted Painless extensions in aggregation scripts?

{
  "query": {
    "match_all": {}
  },
  "aggregations": {
    "statuses": {
      "terms": {
        "script": {
          "source": "def e = new ExampleWhitelistedClass(64, 42); return e.publicMember + e.privateMemberAccessor + ExampleWhitelistedClass.CONSTANT;",
          "lang": "painless"
        }
      }
    }
  }
}

@rjernst
Copy link
Copy Markdown
Member Author

rjernst commented Feb 21, 2018

@byoungb
Please ask questions on our forum. We use github for feature requests and confirmed bug reports. Commenting on a closed PR is a likely way to have your problem overlooked.

@byoungb
Copy link
Copy Markdown

byoungb commented Feb 21, 2018

I already had but thought it might fit here since this was where the code originated.
https://discuss.elastic.co/t/how-do-you-use-the-examplewhitelistextension-in-terms-aggregations/120551/2

@jimczi jimczi added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jdconrad jdconrad jdconrad approved these changes

Assignees

No one assigned

Labels

:Core/Infra/Scripting Scripting abstractions, Painless, and Mustache >enhancement v6.2.0 v7.0.0-beta1

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@rjernst @jdconrad @byoungb @clintongormley @jimczi