From dfbc7dfc212afcaebdde262a1c974c7942d1d826 Mon Sep 17 00:00:00 2001 From: Matthew Burgess Date: Thu, 8 Sep 2022 18:28:12 -0500 Subject: [PATCH] NIFI-8111: Add JSLTTransformJSON Processor This closes #4797 Signed-off-by: David Handermann --- nifi-assembly/pom.xml | 6 + .../nifi-jslt-bundle/nifi-jslt-nar/pom.xml | 35 +++ .../src/main/resources/META-INF/LICENSE | 202 +++++++++++++++ .../src/main/resources/META-INF/NOTICE | 36 +++ .../nifi-jslt-processors/pom.xml | 76 ++++++ .../processors/jslt/JSLTTransformJSON.java | 244 ++++++++++++++++++ .../org.apache.nifi.processor.Processor | 15 ++ .../jslt/TestJSLTTransformJSON.java | 166 ++++++++++++ .../src/test/resources/arrayOutput.json | 15 ++ .../src/test/resources/arrayTransform.json | 9 + .../src/test/resources/cardinalityOutput.json | 13 + .../test/resources/cardinalityTransform.json | 15 ++ .../test/resources/dynamicKeyTransform.json | 12 + .../resources/dynamicKeyTransformOutput.json | 21 ++ .../expressionLanguageTransform.json | 8 + .../src/test/resources/input.json | 13 + .../src/test/resources/inputArray.json | 26 ++ .../src/test/resources/simpleOutput.json | 8 + .../src/test/resources/simpleTransform.json | 8 + nifi-nar-bundles/nifi-jslt-bundle/pom.xml | 45 ++++ nifi-nar-bundles/pom.xml | 1 + 21 files changed, 974 insertions(+) create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-nar/pom.xml create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-nar/src/main/resources/META-INF/LICENSE create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-nar/src/main/resources/META-INF/NOTICE create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/pom.xml create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/main/java/org/apache/nifi/processors/jslt/JSLTTransformJSON.java create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/main/resources/META-INF/services/org.apache.nifi.processor.Processor create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/java/org/apache/nifi/processors/jslt/TestJSLTTransformJSON.java create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/arrayOutput.json create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/arrayTransform.json create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/cardinalityOutput.json create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/cardinalityTransform.json create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/dynamicKeyTransform.json create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/dynamicKeyTransformOutput.json create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/expressionLanguageTransform.json create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/input.json create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/inputArray.json create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/simpleOutput.json create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/simpleTransform.json create mode 100644 nifi-nar-bundles/nifi-jslt-bundle/pom.xml diff --git a/nifi-assembly/pom.xml b/nifi-assembly/pom.xml index 599873016c..3b932c882e 100644 --- a/nifi-assembly/pom.xml +++ b/nifi-assembly/pom.xml @@ -928,6 +928,12 @@ language governing permissions and limitations under the License. --> 1.19.0-SNAPSHOT nar + + org.apache.nifi + nifi-jslt-nar + 1.19.0-SNAPSHOT + nar + diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-nar/pom.xml b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-nar/pom.xml new file mode 100644 index 0000000000..d69a1d419e --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-nar/pom.xml @@ -0,0 +1,35 @@ + + + + 4.0.0 + + + org.apache.nifi + nifi-jslt-bundle + 1.19.0-SNAPSHOT + + + nifi-jslt-nar + nar + + + + org.apache.nifi + nifi-jslt-processors + 1.19.0-SNAPSHOT + + + diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-nar/src/main/resources/META-INF/LICENSE b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-nar/src/main/resources/META-INF/LICENSE new file mode 100644 index 0000000000..d645695673 --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-nar/src/main/resources/META-INF/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-nar/src/main/resources/META-INF/NOTICE b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-nar/src/main/resources/META-INF/NOTICE new file mode 100644 index 0000000000..f2a96ef8c8 --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-nar/src/main/resources/META-INF/NOTICE @@ -0,0 +1,36 @@ +nifi-jslt-record-nar +Copyright 2014-2020 The Apache Software Foundation + +This product includes software developed at +The Apache Software Foundation (http://www.apache.org/). + +****************** +Apache Software License v2 +****************** + +The following binary components are provided under the Apache Software License v2 + + (ASLv2) JSLT + + (ASLv2) Jackson JSON processor + The following NOTICE information applies: + # Jackson JSON processor + + Jackson is a high-performance, Free/Open Source JSON processing library. + It was originally written by Tatu Saloranta (tatu.saloranta@iki.fi), and has + been in development since 2007. + It is currently developed by a community of developers, as well as supported + commercially by FasterXML.com. + + ## Licensing + + Jackson core and extension components may licensed under different licenses. + To find the details that apply to this artifact see the accompanying LICENSE file. + For more information, including possible other licensing options, contact + FasterXML.com (http://fasterxml.com). + + ## Credits + + A list of contributors may be found from CREDITS file, which is included + in some artifacts (usually source distributions); but is always available + from the source code management (SCM) system project uses. diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/pom.xml b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/pom.xml new file mode 100644 index 0000000000..a5d3462026 --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/pom.xml @@ -0,0 +1,76 @@ + + + + 4.0.0 + + + org.apache.nifi + nifi-jslt-bundle + 1.19.0-SNAPSHOT + + + nifi-jslt-processors + jar + + + + org.apache.nifi + nifi-api + + + org.apache.nifi + nifi-utils + 1.19.0-SNAPSHOT + + + com.schibsted.spt.data + jslt + + + com.fasterxml.jackson.core + jackson-core + + + com.fasterxml.jackson.core + jackson-databind + + + com.github.ben-manes.caffeine + caffeine + 2.9.3 + + + org.apache.nifi + nifi-mock + 1.19.0-SNAPSHOT + test + + + + + + + org.apache.rat + apache-rat-plugin + + + src/test/resources/*.json + + + + + + diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/main/java/org/apache/nifi/processors/jslt/JSLTTransformJSON.java b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/main/java/org/apache/nifi/processors/jslt/JSLTTransformJSON.java new file mode 100644 index 0000000000..0bec73220d --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/main/java/org/apache/nifi/processors/jslt/JSLTTransformJSON.java @@ -0,0 +1,244 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.nifi.processors.jslt; + +import com.fasterxml.jackson.core.JsonParseException; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.ObjectWriter; +import com.github.benmanes.caffeine.cache.Cache; +import com.github.benmanes.caffeine.cache.Caffeine; +import com.schibsted.spt.data.jslt.Expression; +import com.schibsted.spt.data.jslt.JsltException; +import com.schibsted.spt.data.jslt.Parser; +import org.apache.nifi.annotation.behavior.InputRequirement; +import org.apache.nifi.annotation.behavior.SideEffectFree; +import org.apache.nifi.annotation.behavior.SupportsBatching; +import org.apache.nifi.annotation.behavior.SystemResource; +import org.apache.nifi.annotation.behavior.SystemResourceConsideration; +import org.apache.nifi.annotation.behavior.WritesAttribute; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnScheduled; +import org.apache.nifi.annotation.lifecycle.OnShutdown; +import org.apache.nifi.annotation.lifecycle.OnStopped; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.ValidationContext; +import org.apache.nifi.components.ValidationResult; +import org.apache.nifi.expression.ExpressionLanguageScope; +import org.apache.nifi.flowfile.FlowFile; +import org.apache.nifi.flowfile.attributes.CoreAttributes; +import org.apache.nifi.logging.ComponentLog; +import org.apache.nifi.processor.AbstractProcessor; +import org.apache.nifi.processor.ProcessContext; +import org.apache.nifi.processor.ProcessSession; +import org.apache.nifi.processor.ProcessorInitializationContext; +import org.apache.nifi.processor.Relationship; +import org.apache.nifi.processor.exception.ProcessException; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.util.StopWatch; + +import java.io.IOException; +import java.io.InputStream; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Set; +import java.util.concurrent.TimeUnit; + +@SideEffectFree +@SupportsBatching +@Tags({"json", "jslt", "transform"}) +@InputRequirement(InputRequirement.Requirement.INPUT_REQUIRED) +@SystemResourceConsideration(resource = SystemResource.MEMORY) +@WritesAttribute(attribute = "mime.type", description = "Always set to application/json") +@CapabilityDescription("Applies a JSLT transformation to the FlowFile JSON payload. A new FlowFile is created " + + "with transformed content and is routed to the 'success' relationship. If the JSLT transform " + + "fails, the original FlowFile is routed to the 'failure' relationship.") +public class JSLTTransformJSON extends AbstractProcessor { + + public static final PropertyDescriptor JSLT_TRANSFORM = new PropertyDescriptor.Builder() + .name("jslt-transform-transformation") + .displayName("JSLT Transformation") + .description("JSLT Transformation for transform of JSON data. Any NiFi Expression Language present will be evaluated first to get the final transform to be applied.") + .expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .required(true) + .build(); + + public static final PropertyDescriptor PRETTY_PRINT = new PropertyDescriptor.Builder() + .name("jslt-transform-pretty_print") + .displayName("Pretty Print") + .description("Apply pretty-print formatting to the output of the JSLT transform") + .required(true) + .allowableValues("true", "false") + .defaultValue("false") + .build(); + + public static final PropertyDescriptor TRANSFORM_CACHE_SIZE = new PropertyDescriptor.Builder() + .name("jslt-transform-cache-size") + .displayName("Transform Cache Size") + .description("Compiling a JSLT Transform can be fairly expensive. Ideally, this will be done only once. However, if the Expression Language is used in the transform, we may need " + + "a new Transform for each FlowFile. This value controls how many of those Transforms we cache in memory in order to avoid having to compile the Transform each time.") + .expressionLanguageSupported(ExpressionLanguageScope.NONE) + .addValidator(StandardValidators.POSITIVE_INTEGER_VALIDATOR) + .defaultValue("1") + .required(true) + .build(); + + public static final Relationship REL_SUCCESS = new Relationship.Builder() + .name("success") + .description("The FlowFile with transformed content will be routed to this relationship") + .build(); + public static final Relationship REL_FAILURE = new Relationship.Builder() + .name("failure") + .description("If a FlowFile fails processing for any reason (for example, the FlowFile is not valid JSON), it will be routed to this relationship") + .build(); + + private List descriptors; + private Set relationships; + private static final ObjectMapper jsonObjectMapper = new ObjectMapper(); + + /** + * A cache for transform objects. It keeps values indexed by JSLT specification string. + */ + private Cache transformCache; + + @Override + protected void init(final ProcessorInitializationContext context) { + final List descriptors = new ArrayList<>(); + descriptors.add(JSLT_TRANSFORM); + descriptors.add(PRETTY_PRINT); + descriptors.add(TRANSFORM_CACHE_SIZE); + this.descriptors = Collections.unmodifiableList(descriptors); + + final Set relationships = new HashSet<>(); + relationships.add(REL_SUCCESS); + relationships.add(REL_FAILURE); + this.relationships = Collections.unmodifiableSet(relationships); + } + + @Override + public Set getRelationships() { + return this.relationships; + } + + @Override + public final List getSupportedPropertyDescriptors() { + return descriptors; + } + + @Override + protected Collection customValidate(ValidationContext validationContext) { + final List results = new ArrayList<>(super.customValidate(validationContext)); + + // If no EL present, pre-compile the script (and report any errors as to mark the processor invalid) + if (!validationContext.getProperty(JSLT_TRANSFORM).isExpressionLanguagePresent()) { + final String transform = validationContext.getProperty(JSLT_TRANSFORM).getValue(); + try { + Parser.compileString(transform); + } catch (JsltException je) { + results.add(new ValidationResult.Builder().subject(JSLT_TRANSFORM.getDisplayName()).valid(false).explanation("error in transform: " + je.getMessage()).build()); + } + } else { + // Expression Language is present, we won't know if the transform is valid until the EL is evaluated + results.add(new ValidationResult.Builder().subject(JSLT_TRANSFORM.getDisplayName()).valid(true).build()); + } + return results; + + } + + @OnScheduled + public void onScheduled(final ProcessContext context) { + int maxTransformsToCache = context.getProperty(TRANSFORM_CACHE_SIZE).asInteger(); + transformCache = Caffeine.newBuilder() + .maximumSize(maxTransformsToCache) + .build(); + // Precompile the transform if it hasn't been done already (and if there is no Expression Language present) + if (!context.getProperty(JSLT_TRANSFORM).isExpressionLanguagePresent()) { + final String transform = context.getProperty(JSLT_TRANSFORM).getValue(); + try { + transformCache.put(transform, Parser.compileString(transform)); + } catch (JsltException je) { + throw new ProcessException("Error compiling JSLT transform: " + je.getMessage(), je); + } + } + } + + @Override + public void onTrigger(final ProcessContext context, final ProcessSession session) throws ProcessException { + final FlowFile original = session.get(); + if (original == null) { + return; + } + + final ComponentLog logger = getLogger(); + final StopWatch stopWatch = new StopWatch(true); + + JsonNode firstJsonNode; + try (final InputStream in = session.read(original)) { + firstJsonNode = readJson(in); + } catch (final Exception e) { + logger.error("Failed to transform {}; routing to failure", original, e); + session.transfer(original, REL_FAILURE); + return; + } + + try { + final String transform = context.getProperty(JSLT_TRANSFORM).evaluateAttributeExpressions(original).getValue(); + Expression jsltExpression = transformCache.get(transform, currString -> Parser.compileString(transform)); + + final JsonNode transformedJson = jsltExpression.apply(firstJsonNode); + final ObjectWriter writer = context.getProperty(PRETTY_PRINT).asBoolean() ? jsonObjectMapper.writerWithDefaultPrettyPrinter() : jsonObjectMapper.writer(); + final Object outputObject; + if (transformedJson == null || transformedJson.isNull()) { + logger.warn("JSLT transform resulted in no data"); + outputObject = null; + } else { + outputObject = transformedJson; + } + FlowFile transformed = session.write(original, out -> { + if (outputObject != null) { + writer.writeValue(out, outputObject); + } + }); + transformed = session.putAttribute(transformed, CoreAttributes.MIME_TYPE.key(), "application/json"); + session.transfer(transformed, REL_SUCCESS); + session.getProvenanceReporter().modifyContent(transformed, "Modified With " + transform, stopWatch.getElapsed(TimeUnit.MILLISECONDS)); + logger.debug("Transformed {}", original); + } catch (final Exception ex) { + logger.error("JSLT Transform failed {}", original, ex); + session.transfer(original, REL_FAILURE); + } + } + + @OnStopped + @OnShutdown + public void onStopped(ProcessContext context) { + transformCache.cleanUp(); + } + + private JsonNode readJson(final InputStream in) throws IOException { + try { + return jsonObjectMapper.readTree(in); + } catch (final JsonParseException e) { + throw new IOException("Could not parse data as JSON", e); + } + } +} diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/main/resources/META-INF/services/org.apache.nifi.processor.Processor b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/main/resources/META-INF/services/org.apache.nifi.processor.Processor new file mode 100644 index 0000000000..bf0ab4289a --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/main/resources/META-INF/services/org.apache.nifi.processor.Processor @@ -0,0 +1,15 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +org.apache.nifi.processors.jslt.JSLTTransformJSON \ No newline at end of file diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/java/org/apache/nifi/processors/jslt/TestJSLTTransformJSON.java b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/java/org/apache/nifi/processors/jslt/TestJSLTTransformJSON.java new file mode 100644 index 0000000000..f51f356554 --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/java/org/apache/nifi/processors/jslt/TestJSLTTransformJSON.java @@ -0,0 +1,166 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.nifi.processors.jslt; + +import org.apache.nifi.util.MockFlowFile; +import org.apache.nifi.util.TestRunner; +import org.apache.nifi.util.TestRunners; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.HashMap; +import java.util.Map; +import java.util.regex.Pattern; + +public class TestJSLTTransformJSON { + + private final static Path JSON_INPUT = Paths.get("src/test/resources/input.json"); + private TestRunner runner = TestRunners.newTestRunner(new JSLTTransformJSON()); + + @BeforeEach + public void setup() { + runner = TestRunners.newTestRunner(new JSLTTransformJSON()); + } + + @Test + public void testBadInput() throws IOException { + final String inputFlowFile = "I am not JSON"; + final String transform = new String(Files.readAllBytes(Paths.get("src/test/resources/simpleTransform.json"))); + runner.setProperty(JSLTTransformJSON.JSLT_TRANSFORM, transform); + runner.setProperty(JSLTTransformJSON.PRETTY_PRINT, "true"); + runner.enqueue(inputFlowFile); + runner.run(); + runner.assertTransferCount(JSLTTransformJSON.REL_SUCCESS, 0); + runner.assertTransferCount(JSLTTransformJSON.REL_FAILURE, 1); + } + + @Test + public void testInvalidJSLTTransform() { + final TestRunner runner = TestRunners.newTestRunner(new JSLTTransformJSON()); + final String invalidTransform = "invalid"; + runner.setProperty(JSLTTransformJSON.JSLT_TRANSFORM, invalidTransform); + runner.assertNotValid(); + } + + @Test + public void testSimpleJSLT() throws IOException { + final String inputFlowFile = new String(Files.readAllBytes(JSON_INPUT)); + final String transform = new String(Files.readAllBytes(Paths.get("src/test/resources/simpleTransform.json"))); + runner.setProperty(JSLTTransformJSON.JSLT_TRANSFORM, transform); + runner.setProperty(JSLTTransformJSON.PRETTY_PRINT, "true"); + runner.enqueue(inputFlowFile); + runner.run(); + runner.assertTransferCount(JSLTTransformJSON.REL_SUCCESS, 1); + runner.assertTransferCount(JSLTTransformJSON.REL_FAILURE, 0); + MockFlowFile flowFile = runner.getFlowFilesForRelationship(JSLTTransformJSON.REL_SUCCESS).get(0); + final String expectedOutput = new String(Files.readAllBytes(Paths.get("src/test/resources/simpleOutput.json"))); + flowFile.assertContentEquals(translateNewLines(expectedOutput)); + } + + @Test + public void testTransform() throws IOException { + final String inputFlowFile = new String(Files.readAllBytes(JSON_INPUT)); + final String transform = new String(Files.readAllBytes(Paths.get("src/test/resources/dynamicKeyTransform.json"))); + runner.setProperty(JSLTTransformJSON.JSLT_TRANSFORM, transform); + runner.setProperty(JSLTTransformJSON.PRETTY_PRINT, "true"); + runner.enqueue(inputFlowFile); + runner.run(); + runner.assertTransferCount(JSLTTransformJSON.REL_SUCCESS, 1); + runner.assertTransferCount(JSLTTransformJSON.REL_FAILURE, 0); + MockFlowFile flowFile = runner.getFlowFilesForRelationship(JSLTTransformJSON.REL_SUCCESS).get(0); + final String expectedOutput = new String(Files.readAllBytes(Paths.get("src/test/resources/dynamicKeyTransformOutput.json"))); + flowFile.assertContentEquals(translateNewLines(expectedOutput)); + } + + // This test verifies the capability of JSLT to perform a "cardinality ONE" operation (i.e. get first element if array) like JOLT has + @Test + public void testCardinality() throws IOException { + final String inputFlowFile = new String(Files.readAllBytes(JSON_INPUT)); + final String transform = new String(Files.readAllBytes(Paths.get("src/test/resources/cardinalityTransform.json"))); + runner.setProperty(JSLTTransformJSON.JSLT_TRANSFORM, transform); + runner.setProperty(JSLTTransformJSON.PRETTY_PRINT, "true"); + runner.enqueue(inputFlowFile); + runner.run(); + runner.assertTransferCount(JSLTTransformJSON.REL_SUCCESS, 1); + runner.assertTransferCount(JSLTTransformJSON.REL_FAILURE, 0); + MockFlowFile flowFile = runner.getFlowFilesForRelationship(JSLTTransformJSON.REL_SUCCESS).get(0); + final String expectedOutput = new String(Files.readAllBytes(Paths.get("src/test/resources/cardinalityOutput.json"))); + flowFile.assertContentEquals(translateNewLines(expectedOutput)); + } + + @Test + public void testExpressionLanguageTransform() throws IOException { + final String inputFlowFile = new String(Files.readAllBytes(JSON_INPUT)); + final String transform = new String(Files.readAllBytes(Paths.get("src/test/resources/expressionLanguageTransform.json"))); + runner.setProperty(JSLTTransformJSON.JSLT_TRANSFORM, transform); + runner.assertValid(); + runner.setProperty(JSLTTransformJSON.PRETTY_PRINT, "true"); + Map attrs = new HashMap<>(); + attrs.put("rating.range", "RatingRange"); + attrs.put("rating.quality", ".rating.quality.value"); + runner.enqueue(inputFlowFile, attrs); + runner.run(); + runner.assertTransferCount(JSLTTransformJSON.REL_SUCCESS, 1); + runner.assertTransferCount(JSLTTransformJSON.REL_FAILURE, 0); + MockFlowFile flowFile = runner.getFlowFilesForRelationship(JSLTTransformJSON.REL_SUCCESS).get(0); + final String expectedOutput = new String(Files.readAllBytes(Paths.get("src/test/resources/simpleOutput.json"))); + flowFile.assertContentEquals(translateNewLines(expectedOutput)); + } + + @Test + public void testArrayJSLT() throws IOException { + final String inputFlowFile = new String(Files.readAllBytes(Paths.get("src/test/resources/inputArray.json"))); + final String transform = new String(Files.readAllBytes(Paths.get("src/test/resources/arrayTransform.json"))); + runner.setProperty(JSLTTransformJSON.JSLT_TRANSFORM, transform); + runner.setProperty(JSLTTransformJSON.PRETTY_PRINT, "true"); + runner.enqueue(inputFlowFile); + runner.run(); + runner.assertTransferCount(JSLTTransformJSON.REL_SUCCESS, 1); + runner.assertTransferCount(JSLTTransformJSON.REL_FAILURE, 0); + MockFlowFile flowFile = runner.getFlowFilesForRelationship(JSLTTransformJSON.REL_SUCCESS).get(0); + final String expectedOutput = new String(Files.readAllBytes(Paths.get("src/test/resources/arrayOutput.json"))); + flowFile.assertContentEquals(translateNewLines(expectedOutput)); + } + + @Test + public void testJSLTNoOutput() throws IOException { + final String input = "{\"a\":1}"; + final String transform = ".b"; + runner.setProperty(JSLTTransformJSON.JSLT_TRANSFORM, transform); + runner.setProperty(JSLTTransformJSON.PRETTY_PRINT, "true"); + runner.enqueue(input); + runner.run(); + runner.assertTransferCount(JSLTTransformJSON.REL_SUCCESS, 1); + runner.assertTransferCount(JSLTTransformJSON.REL_FAILURE, 0); + MockFlowFile flowFile = runner.getFlowFilesForRelationship(JSLTTransformJSON.REL_SUCCESS).get(0); + flowFile.assertContentEquals(new byte[0]); + } + + /* + * Translate newlines (expected to be in *nix format to be in the codebase) to the system's line separator (to support Windows, e.g.) + */ + private String translateNewLines(final String text) { + final String lineSeparator = System.getProperty("line.separator"); + final Pattern pattern = Pattern.compile("\n", Pattern.MULTILINE); + final String translated = pattern.matcher(text).replaceAll(lineSeparator); + return translated; + } +} \ No newline at end of file diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/arrayOutput.json b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/arrayOutput.json new file mode 100644 index 0000000000..19c0640e33 --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/arrayOutput.json @@ -0,0 +1,15 @@ +[ { + "SecondaryRatings" : { + "quality" : { + "Value" : 3, + "RatingRange" : 3 + } + } +}, { + "SecondaryRatings" : { + "quality" : { + "Value" : 13, + "RatingRange" : 13 + } + } +} ] \ No newline at end of file diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/arrayTransform.json b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/arrayTransform.json new file mode 100644 index 0000000000..5ace32f14e --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/arrayTransform.json @@ -0,0 +1,9 @@ +[for (.) + { + "SecondaryRatings" : { + "quality" : { + "Value" : .rating.primary.value, + "RatingRange" : .rating.quality.value + } + } + }] \ No newline at end of file diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/cardinalityOutput.json b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/cardinalityOutput.json new file mode 100644 index 0000000000..d2f4a8cb0b --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/cardinalityOutput.json @@ -0,0 +1,13 @@ +{ + "rating" : { + "primary" : { + "value" : 3 + }, + "series" : { + "value" : 5 + }, + "quality" : { + "value" : 3 + } + } +} \ No newline at end of file diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/cardinalityTransform.json b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/cardinalityTransform.json new file mode 100644 index 0000000000..6c9a830d6d --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/cardinalityTransform.json @@ -0,0 +1,15 @@ +def first(node) + if (is-array($node)) + $node[0] + else + $node + + +{ + "rating": { + for(.rating) + .key : { + "value": first(."value".value) + } + } +} \ No newline at end of file diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/dynamicKeyTransform.json b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/dynamicKeyTransform.json new file mode 100644 index 0000000000..f2a581ee88 --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/dynamicKeyTransform.json @@ -0,0 +1,12 @@ +{ + "Range": 5, + "Rating": .rating.primary.value, + "SecondaryRatings": { + for(.rating) + .key: { + "Id": .key, + "Range": 5, + "Value": .value."value" + } + } +} \ No newline at end of file diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/dynamicKeyTransformOutput.json b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/dynamicKeyTransformOutput.json new file mode 100644 index 0000000000..f6fff35493 --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/dynamicKeyTransformOutput.json @@ -0,0 +1,21 @@ +{ + "Range" : 5, + "Rating" : 3, + "SecondaryRatings" : { + "primary" : { + "Id" : "primary", + "Range" : 5, + "Value" : 3 + }, + "series" : { + "Id" : "series", + "Range" : 5, + "Value" : [ 5, 4 ] + }, + "quality" : { + "Id" : "quality", + "Range" : 5, + "Value" : 3 + } + } +} \ No newline at end of file diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/expressionLanguageTransform.json b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/expressionLanguageTransform.json new file mode 100644 index 0000000000..c04f9e7a86 --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/expressionLanguageTransform.json @@ -0,0 +1,8 @@ +{ + "SecondaryRatings" : { + "quality" : { + "Value" : .rating.primary.value, + "${rating.range}" : ${rating.quality} + } + } +} \ No newline at end of file diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/input.json b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/input.json new file mode 100644 index 0000000000..12d85dbe98 --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/input.json @@ -0,0 +1,13 @@ +{ + "rating": { + "primary": { + "value": 3 + }, + "series": { + "value": [5,4] + }, + "quality": { + "value": 3 + } + } +} \ No newline at end of file diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/inputArray.json b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/inputArray.json new file mode 100644 index 0000000000..772116b366 --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/inputArray.json @@ -0,0 +1,26 @@ +[{ + "rating": { + "primary": { + "value": 3 + }, + "series": { + "value": [5,4] + }, + "quality": { + "value": 3 + } + } + }, + { + "rating": { + "primary": { + "value": 13 + }, + "series": { + "value": [15,14] + }, + "quality": { + "value": 13 + } + } + }] \ No newline at end of file diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/simpleOutput.json b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/simpleOutput.json new file mode 100644 index 0000000000..cca41ba3cb --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/simpleOutput.json @@ -0,0 +1,8 @@ +{ + "SecondaryRatings" : { + "quality" : { + "Value" : 3, + "RatingRange" : 3 + } + } +} \ No newline at end of file diff --git a/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/simpleTransform.json b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/simpleTransform.json new file mode 100644 index 0000000000..ae19a3c42b --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/nifi-jslt-processors/src/test/resources/simpleTransform.json @@ -0,0 +1,8 @@ +{ + "SecondaryRatings" : { + "quality" : { + "Value" : .rating.primary.value, + "RatingRange" : .rating.quality.value + } + } +} \ No newline at end of file diff --git a/nifi-nar-bundles/nifi-jslt-bundle/pom.xml b/nifi-nar-bundles/nifi-jslt-bundle/pom.xml new file mode 100644 index 0000000000..817c6505b3 --- /dev/null +++ b/nifi-nar-bundles/nifi-jslt-bundle/pom.xml @@ -0,0 +1,45 @@ + + + + 4.0.0 + + + org.apache.nifi + nifi-nar-bundles + 1.19.0-SNAPSHOT + + + org.apache.nifi + nifi-jslt-bundle + 1.19.0-SNAPSHOT + pom + + + nifi-jslt-processors + nifi-jslt-nar + + + + + + com.schibsted.spt.data + jslt + 0.1.13 + + + + + diff --git a/nifi-nar-bundles/pom.xml b/nifi-nar-bundles/pom.xml index d9521d3396..33df36837c 100755 --- a/nifi-nar-bundles/pom.xml +++ b/nifi-nar-bundles/pom.xml @@ -120,6 +120,7 @@ nifi-flow-registry-client-bundle nifi-shopify-bundle nifi-iceberg-bundle + nifi-jslt-bundle