emiliosetiadarma commented on code in PR #5947: URL: https://github.com/apache/nifi/pull/5947#discussion_r848794830
########## nifi-nar-bundles/nifi-social-media-bundle/nifi-twitter-processors/src/main/java/org/apache/nifi/processors/twitter/TwitterStreamAPI.java: ########## @@ -0,0 +1,174 @@ +/* + * 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.twitter; + +import com.twitter.clientlib.ApiException; +import com.twitter.clientlib.TwitterCredentialsBearer; +import com.twitter.clientlib.api.TwitterApi; +import org.apache.nifi.logging.ComponentLog; +import org.apache.nifi.processor.ProcessContext; +import org.apache.nifi.processor.exception.ProcessException; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.util.HashSet; +import java.util.Set; +import java.util.concurrent.BlockingQueue; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.TimeUnit; + +public class TwitterStreamAPI { + public static final String SEARCH_ENDPOINT = "Search Endpoint"; + public static final String SAMPLE_ENDPOINT = "Sample Endpoint"; + public static final String SAMPLE_PATH = "/2/tweets/sample/stream"; + public static final String SEARCH_PATH = "/2/tweets/search/stream"; + + private static final String BEARER_TOKEN_PROPERTY_NAME = "bearer-token"; + private static final String TWEET_FIELDS_PROPERTY_NAME = "tweet-fields"; + private static final String USER_FIELDS_PROPERTY_NAME = "user-fields"; + private static final String MEDIA_FIELDS_PROPERTY_NAME = "media-fields"; + private static final String POLL_FIELDS_PROPERTY_NAME = "poll-fields"; + private static final String PLACE_FIELDS_PROPERTY_NAME = "place-fields"; + private static final String EXPANSIONS_PROPERTY_NAME = "expansions"; + private static final String BACKFILL_MINUTES_PROPERTY_NAME = "backfill-minutes"; + + private final BlockingQueue<String> queue; + private final ComponentLog logger; + + private final ExecutorService executorService; + + private final Set<String> tweetFields; + private final Set<String> userFields; + private final Set<String> mediaFields; + private final Set<String> pollFields; + private final Set<String> placeFields; + private final Set<String> expansions; + private final int backfillMinutes; + private final TwitterApi api; + private InputStream stream; + + private Set<String> parseCommaSeparatedListPropreties(final ProcessContext context, final String propertyName) { + Set<String> fields = null; + if (context.getProperty(propertyName).isSet()) { + fields = new HashSet<>(); + final String fieldsString = context.getProperty(propertyName).getValue(); + for (final String field: fieldsString.split(",")) { + fields.add(field.trim()); + } + } + return fields; + } + + public TwitterStreamAPI(final ProcessContext context, final BlockingQueue<String> queue, final ComponentLog logger) { + assert context != null; + assert queue != null; + assert logger != null; + + this.queue = queue; + this.logger = logger; + + this.tweetFields = parseCommaSeparatedListPropreties(context, TWEET_FIELDS_PROPERTY_NAME); + this.userFields = parseCommaSeparatedListPropreties(context, USER_FIELDS_PROPERTY_NAME); + this.mediaFields = parseCommaSeparatedListPropreties(context, MEDIA_FIELDS_PROPERTY_NAME); + this.pollFields = parseCommaSeparatedListPropreties(context, POLL_FIELDS_PROPERTY_NAME); + this.placeFields = parseCommaSeparatedListPropreties(context, PLACE_FIELDS_PROPERTY_NAME); + this.expansions = parseCommaSeparatedListPropreties(context, EXPANSIONS_PROPERTY_NAME); + this.backfillMinutes = context.getProperty(BACKFILL_MINUTES_PROPERTY_NAME).asInteger(); + + TwitterCredentialsBearer creds = new TwitterCredentialsBearer(context.getProperty(BEARER_TOKEN_PROPERTY_NAME).getValue()); + api = new TwitterApi(); + api.setTwitterCredentials(creds); + + this.executorService = Executors.newSingleThreadExecutor(); + } + + public String getBasePath() { + return api.getApiClient().getBasePath(); + } + + public void setBasePath(final String path) { + api.getApiClient().setBasePath(path); + } + + /** + * This method would be called when we would like the stream to get started. This method will spin off a thread that + * will continue to queue tweets on to the given queue passed in the constructor. The thread will continue + * to run until {@code stop} is called. + * @param endpoint {@code TwitterStreamAPI.SAMPLE_ENDPOINT} or {@code TwitterStreamAPI.SEARCH_ENDPOINT} + */ + public void start(final String endpoint) { + try { + if (endpoint.equals(SAMPLE_ENDPOINT)) { + stream = api.tweets().sampleStream(expansions, tweetFields, userFields, mediaFields, placeFields, pollFields, backfillMinutes); + } else if (endpoint.equals(SEARCH_ENDPOINT)) { + stream = api.tweets().searchStream(expansions, tweetFields, userFields, mediaFields, placeFields, pollFields, backfillMinutes); + } else { + throw new ProcessException("Endpoint was invalid value: " + endpoint); + } + } catch (ApiException e) { + logger.error("Received error {}: {}", e.getCode(), e.getMessage()); + } + + executorService.execute(new TweetQueuer()); + } + + /** + * This method would be called when we would like the stream to get stopped. The stream will be closed and the + * executorService will be shut down. If it fails to shutdown, then it will be forcefully terminated. + */ + public void stop() { + try { + stream.close(); + } catch (IOException e) { + logger.error("IOException occurred while closing stream: {}", e.getMessage()); + } + + executorService.shutdown(); + try { + if (!executorService.awaitTermination(3, TimeUnit.SECONDS)) { + executorService.shutdownNow(); + } + } catch (InterruptedException e) { + executorService.shutdownNow(); + logger.error("InterruptedException occurred while waiting for executor service to shut down: {}", e.getMessage()); + } + } + + private class TweetQueuer implements Runnable { + @Override + public void run() { + try (BufferedReader reader = new BufferedReader(new InputStreamReader(stream))) { Review Comment: I think a SSL handshake exception would occur when the API makes the HTTP request and fetches the stream of tweets. Will wrap the starting stream in a processException to try and catch this. Thanks for the comment! -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
