NIFI-14459: Creating processor to update box metadata template

[ncover21]

Summary

NIFI-14459

Creating processor to update a box metadata template given a desired state. Fetches existing metadata template and compares with what is provided in flowFile content. Reference documentation used:

• https://github.com/box/developer.box.com/blob/main/content/guides/metadata/2-templates/5-update.md
• https://github.com/box/developer.box.com/blob/main/content/guides/metadata/1-quick-start/5-update-template.md

Tracking

Please complete the following tracking steps prior to pull request creation.

Issue Tracking

• Apache NiFi Jira issue created

Pull Request Tracking

• Pull Request title starts with Apache NiFi Jira issue number, such as NIFI-00000
• Pull Request commit message starts with Apache NiFi Jira issue number, as such NIFI-00000

Pull Request Formatting

• Pull Request based on current revision of the main branch
• Pull Request refers to a feature branch with one commit containing changes

Verification

Please indicate the verification steps performed prior to pull request creation.

Build

• Build completed using mvn clean install -P contrib-check
  • JDK 21

Licensing

• New dependencies are compatible with the Apache License 2.0 according to the License Policy
• New dependencies are documented in applicable LICENSE and NOTICE files

Documentation

• Documentation formatting appears as expected in rendered files

[awelless]

Solid draft.
Added a few comments related to behavior during field changes and a bunch of comments related to the style.

[awelless]

In CreateBoxMetadataTemplate the used scope is enterprise only. Without any possible configuration. Shall we do the same here?

[awelless]

I'm vary of having a class with uncontrollably mutable fields.
What do you think about making it a record and providing a builder? If that sounds too verbose, a record with with methods, perhaps?

    private record FieldDefinition(
        String key,
        String type,
        String displayName,
        boolean hidden,
        String description,
        List<String> options
    ) {
        static class Builder {
            private String key;
            private String type;
            private String displayName;
            private boolean hidden;
            private String description;
            private List<String> options;
            
            Builder(String key, String type) {
                // ...
            }
            
            void displayName(String displayName) {
                // ...
            }
        }
    }

    private record FieldDefinition( 
        String key,
        String type,
        String displayName,
        boolean hidden,
        String description,
        List<String> options
    ) {
        FieldDefinition(String key, String type) {
            this(key, type, null, false, null, emptyList());
        }
        
        FieldDefinition withDisplayName(String displayName) {
            return new FieldDefinition(key, type, displayName, hidden, description, options);
        }
        
        // ...
    }

[awelless]

Let's use a Box class instead of manual json creation.

        final MetadataTemplate.Field data = new MetadataTemplate.Field();
        data.setKey(field.key);
        data.setType(field.type);

        final MetadataTemplate.FieldOperation operation = new MetadataTemplate.FieldOperation();

        operation.setOp(MetadataTemplate.Operation.addField);
        operation.setData(data);

[ncover21]

Interesting, was looking at https://developer.box.com/guides/metadata/templates/update/ so i thought i would have to format everything. I'll try it out

[awelless]

Same here. Let's build MetadataTemplate.FieldOperation in-place.

[awelless]

In this processor the key always matches. That's our immutable field identifier and we use it to match existing and desired fields.

Otherwise it's impossible to detect field key changes using the desired state only.

[awelless]

According to this doc a field type can't be changed.
So perhaps we should create an error if the types don't match?

[awelless]

Unfortunately, this isn't that simple :(

[awelless]

And here. MetadataTemplate.FieldOperation

[awelless]

Let's also check what operations were created.

[awelless]

There is no need to mock the fields, as they can be created easily.

Suggested change

	final MetadataTemplate.Field field1 = mock(MetadataTemplate.Field.class);
	when(field1.getKey()).thenReturn("name");
	when(field1.getDisplayName()).thenReturn("Name");
	when(field1.getType()).thenReturn("string");
	when(field1.getIsHidden()).thenReturn(false);
	final MetadataTemplate.Field field1 = new MetadataTemplate.Field();
	field1.setKey("name");
	field1.setDisplayName("Name");
	field1.setType("string");
	field1.setIsHidden(false);