You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by GitBox <gi...@apache.org> on 2022/12/01 18:37:57 UTC
[GitHub] [nifi] takraj commented on a diff in pull request #6504: NIFI-10618: Add Asana connector
takraj commented on code in PR #6504:
URL: https://github.com/apache/nifi/pull/6504#discussion_r1037448185
##########
nifi-nar-bundles/nifi-asana-bundle/nifi-asana-processors/src/main/java/org/apache/nifi/processors/asana/GetAsanaObject.java:
##########
@@ -0,0 +1,393 @@
+/*
+ * 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.asana;
+
+import static java.lang.String.format;
+import static java.util.Collections.singletonMap;
+import static java.util.stream.Collectors.groupingBy;
+import static java.util.stream.Collectors.joining;
+import static org.apache.commons.collections4.ListUtils.partition;
+import static org.apache.nifi.processors.asana.AsanaObjectType.AV_COLLECT_PROJECT_EVENTS;
+import static org.apache.nifi.processors.asana.AsanaObjectType.AV_COLLECT_PROJECT_MEMBERS;
+import static org.apache.nifi.processors.asana.AsanaObjectType.AV_COLLECT_PROJECT_STATUS_ATTACHMENTS;
+import static org.apache.nifi.processors.asana.AsanaObjectType.AV_COLLECT_PROJECT_STATUS_UPDATES;
+import static org.apache.nifi.processors.asana.AsanaObjectType.AV_COLLECT_STORIES;
+import static org.apache.nifi.processors.asana.AsanaObjectType.AV_COLLECT_TASKS;
+import static org.apache.nifi.processors.asana.AsanaObjectType.AV_COLLECT_TASK_ATTACHMENTS;
+import static org.apache.nifi.processors.asana.AsanaObjectType.AV_COLLECT_TEAM_MEMBERS;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Set;
+import org.apache.http.entity.ContentType;
+import org.apache.nifi.annotation.behavior.InputRequirement;
+import org.apache.nifi.annotation.behavior.PrimaryNodeOnly;
+import org.apache.nifi.annotation.behavior.TriggerSerially;
+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.components.PropertyDescriptor;
+import org.apache.nifi.components.PropertyDescriptor.Builder;
+import org.apache.nifi.controller.asana.AsanaClient;
+import org.apache.nifi.controller.asana.AsanaClientProviderService;
+import org.apache.nifi.distributed.cache.client.DistributedMapCacheClient;
+import org.apache.nifi.flowfile.FlowFile;
+import org.apache.nifi.flowfile.attributes.CoreAttributes;
+import org.apache.nifi.processor.AbstractProcessor;
+import org.apache.nifi.processor.ProcessContext;
+import org.apache.nifi.processor.ProcessSession;
+import org.apache.nifi.processor.Relationship;
+import org.apache.nifi.processor.exception.ProcessException;
+import org.apache.nifi.processor.util.StandardValidators;
+import org.apache.nifi.processors.asana.utils.AsanaObject;
+import org.apache.nifi.processors.asana.utils.AsanaObjectFetcher;
+import org.apache.nifi.processors.asana.utils.AsanaObjectState;
+import org.apache.nifi.processors.asana.utils.AsanaProjectEventFetcher;
+import org.apache.nifi.processors.asana.utils.AsanaProjectFetcher;
+import org.apache.nifi.processors.asana.utils.AsanaProjectMembershipFetcher;
+import org.apache.nifi.processors.asana.utils.AsanaProjectStatusAttachmentFetcher;
+import org.apache.nifi.processors.asana.utils.AsanaProjectStatusFetcher;
+import org.apache.nifi.processors.asana.utils.AsanaStoryFetcher;
+import org.apache.nifi.processors.asana.utils.AsanaTagFetcher;
+import org.apache.nifi.processors.asana.utils.AsanaTaskAttachmentFetcher;
+import org.apache.nifi.processors.asana.utils.AsanaTaskFetcher;
+import org.apache.nifi.processors.asana.utils.AsanaTeamFetcher;
+import org.apache.nifi.processors.asana.utils.AsanaTeamMemberFetcher;
+import org.apache.nifi.processors.asana.utils.AsanaUserFetcher;
+import org.apache.nifi.reporting.InitializationException;
+
+@TriggerSerially
+@PrimaryNodeOnly
+@InputRequirement(InputRequirement.Requirement.INPUT_FORBIDDEN)
+@WritesAttribute(attribute = GetAsanaObject.ASANA_GID, description = "Global ID of the object in Asana.")
+@Tags({"asana", "source", "ingest"})
+@CapabilityDescription("This processor collects data from Asana")
+public class GetAsanaObject extends AbstractProcessor {
+
+ protected static final String ASANA_GID = "asana.gid";
+ protected static final String ASANA_CLIENT_SERVICE = "asana-controller-service";
+ protected static final String DISTRIBUTED_CACHE_SERVICE = "distributed-cache-service";
+ protected static final String ASANA_OBJECT_TYPE = "asana-object-type";
+ protected static final String ASANA_PROJECT_NAME = "asana-project-name";
+ protected static final String ASANA_SECTION_NAME = "asana-section-name";
+ protected static final String ASANA_TAG_NAME = "asana-tag-name";
+ protected static final String ASANA_TEAM_NAME = "asana-team-name";
+ protected static final String ASANA_OUTPUT_BATCH_SIZE = "asana-output-batch-size";
+ protected static final String REL_NAME_NEW = "new";
+ protected static final String REL_NAME_UPDATED = "updated";
+ protected static final String REL_NAME_REMOVED = "removed";
+
+ protected static final PropertyDescriptor PROP_ASANA_CLIENT_SERVICE = new PropertyDescriptor.Builder()
+ .name(ASANA_CLIENT_SERVICE)
+ .displayName("Asana Client Service")
+ .description("Specify which controller service to use for accessing Asana.")
+ .required(true)
+ .identifiesControllerService(AsanaClientProviderService.class)
+ .build();
+
+ protected static final PropertyDescriptor PROP_DISTRIBUTED_CACHE_SERVICE = new Builder()
+ .name(DISTRIBUTED_CACHE_SERVICE)
+ .displayName("Distributed Cache Service")
+ .description("Cache service to store fetched item fingerprints. These, from the last successful query"
+ + " are stored, in order to enable incremental loading and change detection.")
+ .required(true)
+ .identifiesControllerService(DistributedMapCacheClient.class)
+ .build();
+
+ protected static final PropertyDescriptor PROP_ASANA_OBJECT_TYPE = new PropertyDescriptor.Builder()
+ .name(ASANA_OBJECT_TYPE)
+ .displayName("Object Type")
+ .description("Specify what kind of objects to be collected from Asana")
+ .required(true)
+ .allowableValues(AsanaObjectType.class)
+ .defaultValue(AV_COLLECT_TASKS.getValue())
+ .build();
+
+ protected static final PropertyDescriptor PROP_ASANA_PROJECT = new PropertyDescriptor.Builder()
+ .name(ASANA_PROJECT_NAME)
+ .displayName("Project Name")
+ .description("Fetch only objects in this project. Case sensitive.")
+ .required(true)
+ .addValidator(StandardValidators.NON_BLANK_VALIDATOR)
+ .dependsOn(
+ PROP_ASANA_OBJECT_TYPE,
+ AV_COLLECT_TASKS.getValue(),
+ AV_COLLECT_TASK_ATTACHMENTS.getValue(),
+ AV_COLLECT_PROJECT_MEMBERS.getValue(),
+ AV_COLLECT_STORIES.getValue(),
+ AV_COLLECT_PROJECT_STATUS_UPDATES.getValue(),
+ AV_COLLECT_PROJECT_STATUS_ATTACHMENTS.getValue(),
+ AV_COLLECT_PROJECT_EVENTS.getValue())
+ .build();
+
+ protected static final PropertyDescriptor PROP_ASANA_SECTION = new PropertyDescriptor.Builder()
+ .name(ASANA_SECTION_NAME)
+ .displayName("Section Name")
+ .description("Fetch only objects in this section. Case sensitive.")
+ .addValidator(StandardValidators.NON_BLANK_VALIDATOR)
+ .dependsOn(PROP_ASANA_OBJECT_TYPE,
+ AV_COLLECT_TASKS.getValue(),
+ AV_COLLECT_TASK_ATTACHMENTS.getValue(),
+ AV_COLLECT_STORIES.getValue())
+ .build();
+
+ protected static final PropertyDescriptor PROP_ASANA_TAG = new PropertyDescriptor.Builder()
+ .name(ASANA_TAG_NAME)
+ .displayName("Tag")
+ .description("Fetch only objects having this tag. Case sensitive.")
+ .addValidator(StandardValidators.NON_BLANK_VALIDATOR)
+ .dependsOn(PROP_ASANA_OBJECT_TYPE,
+ AV_COLLECT_TASKS.getValue(),
+ AV_COLLECT_TASK_ATTACHMENTS.getValue(),
+ AV_COLLECT_STORIES.getValue())
+ .build();
+
+ protected static final PropertyDescriptor PROP_ASANA_TEAM_NAME = new PropertyDescriptor.Builder()
+ .name(ASANA_TEAM_NAME)
+ .displayName("Team")
+ .description("Team name. Case sensitive.")
+ .addValidator(StandardValidators.NON_BLANK_VALIDATOR)
+ .dependsOn(PROP_ASANA_OBJECT_TYPE, AV_COLLECT_TEAM_MEMBERS.getValue())
+ .build();
+
+ protected static final PropertyDescriptor PROP_ASANA_OUTPUT_BATCH_SIZE = new PropertyDescriptor.Builder()
+ .name(ASANA_OUTPUT_BATCH_SIZE)
+ .displayName("Output Batch Size")
+ .description("The number of items batched together in a single Flow File. If set to 1 (default), then each item is"
+ + " transferred in a separate Flow File and each will have an asana.gid attribute, to help identifying"
+ + " the fetched item on the server side, if needed. If the batch size is greater than 1, then the"
+ + " specified amount of items are batched together in a single Flow File as a Json array, and the"
+ + " Flow Files won't have the asana.gid attribute.")
+ .defaultValue("1")
+ .required(true)
+ .addValidator(StandardValidators.POSITIVE_INTEGER_VALIDATOR)
+ .build();
+
+ protected static final List<PropertyDescriptor> DESCRIPTORS = Collections.unmodifiableList(Arrays.asList(
+ PROP_ASANA_CLIENT_SERVICE,
+ PROP_DISTRIBUTED_CACHE_SERVICE,
+ PROP_ASANA_OBJECT_TYPE,
+ PROP_ASANA_PROJECT,
+ PROP_ASANA_SECTION,
+ PROP_ASANA_TEAM_NAME,
+ PROP_ASANA_TAG,
+ PROP_ASANA_OUTPUT_BATCH_SIZE
+ ));
+
+ protected static final Relationship REL_NEW = new Relationship.Builder()
+ .name(REL_NAME_NEW)
+ .description("Newly collected objects are routed to this relationship.")
+ .build();
+
+ protected static final Relationship REL_UPDATED = new Relationship.Builder()
+ .name(REL_NAME_UPDATED)
+ .description("Objects that have already been collected earlier, but were updated since, are routed to this relationship.")
+ .build();
+
+ protected static final Relationship REL_REMOVED = new Relationship.Builder()
+ .name(REL_NAME_REMOVED)
+ .description("Notification about deleted objects are routed to this relationship. "
+ + "Flow files will not have any payload. IDs of the resources no longer exist "
+ + "are carried by the asana.gid attribute of the generated FlowFiles.")
+ .build();
+
+ protected static final Set<Relationship> RELATIONSHIPS = Collections.unmodifiableSet(new HashSet<>(Arrays.asList(
+ REL_NEW,
+ REL_UPDATED,
+ REL_REMOVED
+ )));
+
+ private volatile AsanaObjectFetcher objectFetcher;
+ private volatile Integer batchSize;
+
+ @Override
+ public Set<Relationship> getRelationships() {
+ return RELATIONSHIPS;
+ }
+
+ @Override
+ public List<PropertyDescriptor> getSupportedPropertyDescriptors() {
+ return DESCRIPTORS;
+ }
+
+ @OnScheduled
+ public void onScheduled(final ProcessContext context) throws InitializationException {
+ AsanaClientProviderService controllerService = context.getProperty(PROP_ASANA_CLIENT_SERVICE).asControllerService(AsanaClientProviderService.class);
+ AsanaClient client = controllerService.createClient();
+ batchSize = context.getProperty(PROP_ASANA_OUTPUT_BATCH_SIZE).asInteger();
+
+ try {
+ getLogger().debug("Initializing object fetcher...");
+ objectFetcher = createObjectFetcher(context, client);
+ } catch (Exception e) {
+ throw new InitializationException(e);
+ }
+ }
+
+ @Override
+ public void onTrigger(final ProcessContext context, final ProcessSession session) throws ProcessException {
+ try {
+ Map<String, String> state = recoverState(context).orElse(Collections.emptyMap());
+ getLogger().debug("Attempting to load state: {}", state);
+ objectFetcher.loadState(state);
+ } catch (Exception e) {
+ getLogger().info("Failed to recover state. Falling back to clean start.");
+ objectFetcher.clearState();
+ }
+ getLogger().debug("Initial state: {}", objectFetcher.saveState());
+
+ Collection<FlowFile> newItems = new ArrayList<>();
+ Collection<FlowFile> updatedItems = new ArrayList<>();
+ Collection<FlowFile> removedItems = new ArrayList<>();
+ Map<AsanaObjectState, Collection<FlowFile>> flowFiles = new HashMap<>();
+ flowFiles.put(AsanaObjectState.NEW, newItems);
+ flowFiles.put(AsanaObjectState.UPDATED, updatedItems);
+ flowFiles.put(AsanaObjectState.REMOVED, removedItems);
+
+ List<AsanaObject> allObjects = new ArrayList<>();
+
+ AsanaObject nextObject;
+ while ((nextObject = objectFetcher.fetchNext()) != null) {
+ allObjects.add(nextObject);
Review Comment:
@turcsanyip Implemented in cc0997d.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org