embulk-input-zendesk-all 0.3.7

data/src/main/java/org/embulk/input/zendesk/services/ZendeskNPSService.java

@@ -0,0 +1,30 @@
+package org.embulk.input.zendesk.services;
+
+import org.embulk.input.zendesk.ZendeskInputPlugin;
+import org.embulk.input.zendesk.utils.ZendeskConstants;
+import org.embulk.input.zendesk.utils.ZendeskUtils;
+
+public class ZendeskNPSService extends ZendeskNormalServices
+{
+    public ZendeskNPSService(final ZendeskInputPlugin.PluginTask task)
+    {
+        super(task);
+    }
+
+    public boolean isSupportIncremental()
+    {
+        return true;
+    }
+
+    @Override
+    protected String buildURI(final int page, final long startTime)
+    {
+        return ZendeskUtils.getURIBuilder(task.getLoginUrl())
+                .setPath(ZendeskConstants.Url.API_NPS_INCREMENTAL
+                        + "/"
+                        + task.getTarget().getJsonName()
+                        + ".json")
+                .setParameter(ZendeskConstants.Field.START_TIME, String.valueOf(startTime))
+                .toString();
+    }
+}

data/src/main/java/org/embulk/input/zendesk/services/ZendeskNormalServices.java

@@ -0,0 +1,347 @@
+package org.embulk.input.zendesk.services;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Throwables;
+import org.apache.http.HttpStatus;
+import org.apache.http.client.utils.URIBuilder;
+import org.embulk.config.ConfigException;
+import org.embulk.config.TaskReport;
+import org.embulk.input.zendesk.RecordImporter;
+import org.embulk.input.zendesk.ZendeskInputPlugin;
+import org.embulk.input.zendesk.clients.ZendeskRestClient;
+import org.embulk.input.zendesk.models.Target;
+import org.embulk.input.zendesk.models.ZendeskException;
+import org.embulk.input.zendesk.utils.ZendeskConstants;
+import org.embulk.input.zendesk.utils.ZendeskDateUtils;
+import org.embulk.input.zendesk.utils.ZendeskUtils;
+import org.embulk.spi.Exec;
+import org.slf4j.Logger;
+
+import java.time.Instant;
+
+import java.util.Iterator;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.LinkedBlockingQueue;
+import java.util.concurrent.ThreadPoolExecutor;
+import java.util.concurrent.TimeUnit;
+
+public abstract class ZendeskNormalServices implements ZendeskService
+{
+    private static final Logger logger = Exec.getLogger(ZendeskNormalServices.class);
+
+    protected ZendeskInputPlugin.PluginTask task;
+
+    private ZendeskRestClient zendeskRestClient;
+
+    protected ZendeskNormalServices(final ZendeskInputPlugin.PluginTask task)
+    {
+        this.task = task;
+    }
+
+    public TaskReport addRecordToImporter(final int taskIndex, final RecordImporter recordImporter)
+    {
+        TaskReport taskReport = Exec.newTaskReport();
+
+        if (isSupportIncremental()) {
+            importDataForIncremental(task, recordImporter, taskReport);
+        }
+        else {
+            if(task.getTarget().equals(Target.SATISFACTION_RATINGS)){
+                importDataForNonIncremental(task, taskIndex, recordImporter, true);
+            }
+            else{
+                importDataForNonIncremental(task, taskIndex, recordImporter, false);
+            }
+        }
+
+        return taskReport;
+    }
+
+    public JsonNode getDataFromPath(String path, final int page, final boolean isPreview, final long startTime)
+    {
+        if (path.isEmpty()) {
+            path = buildURI(page, startTime);
+        }
+
+        final String response = getZendeskRestClient().doGet(path, task, isPreview);
+        return ZendeskUtils.parseJsonObject(response);
+    }
+
+    protected abstract String buildURI(int page, long startTime);
+
+    @VisibleForTesting
+    protected ZendeskRestClient getZendeskRestClient()
+    {
+        if (zendeskRestClient == null) {
+            zendeskRestClient = new ZendeskRestClient();
+        }
+        return zendeskRestClient;
+    }
+
+    private void importDataForIncremental(final ZendeskInputPlugin.PluginTask task, final RecordImporter recordImporter, final TaskReport taskReport)
+    {
+        long initStartTime = 0;
+        long startTime = 0;
+        long endTime = Long.MAX_VALUE;
+
+        if (task.getStartTime().isPresent()) {
+            startTime = ZendeskDateUtils.getStartTime(task.getStartTime().get());
+            initStartTime = startTime;
+        }
+
+        if (task.getEndTime().isPresent()) {
+            endTime = ZendeskDateUtils.isoToEpochSecond(task.getEndTime().get());
+        }
+
+        // For incremental target, we will run in one task but split in multiple threads inside for data deduplication.
+        // Run with incremental will contain duplicated data.
+        ThreadPoolExecutor pool = null;
+        try {
+            final Set<String> knownIds = ConcurrentHashMap.newKeySet();
+            pool = new ThreadPoolExecutor(
+                    10, 100, 60, TimeUnit.SECONDS, new LinkedBlockingQueue<>()
+            );
+
+            long apiEndTime = 0;
+            int afterStartTimeIndex = 11;
+            while (true) {
+                int recordCount = 0;
+
+                // Page argument isn't used in incremental API so we just set it to 0
+                final JsonNode result = getDataFromPath("", 0, false, startTime);
+                final Iterator<JsonNode> iterator = ZendeskUtils.getListRecords(result, task.getTarget().getJsonName());
+
+                if (result.has(ZendeskConstants.Field.END_TIME)){
+                    apiEndTime = result.get(ZendeskConstants.Field.END_TIME).asLong();
+                }
+                else{
+                    if(result.has(ZendeskConstants.Field.NEXT_PAGE)){
+                        String next_page = result.get(ZendeskConstants.Field.NEXT_PAGE).textValue();
+                        apiEndTime = Long.parseLong(next_page.substring(next_page.indexOf(ZendeskConstants.Field.START_TIME)+afterStartTimeIndex));
+                    }
+                }
+                logger.info("Api END Time = '{}'", apiEndTime);
+                int numberOfRecords = 0;
+                if (result.has(ZendeskConstants.Field.COUNT)) {
+                    numberOfRecords = result.get(ZendeskConstants.Field.COUNT).asInt();
+                }
+
+                while (iterator.hasNext()) {
+                    final JsonNode recordJsonNode = iterator.next();
+
+                    if (isUpdatedBySystem(recordJsonNode, startTime)) {
+                        continue;
+                    }
+
+                    // Contain some records  that later than end_time. Checked and don't add.
+                    // Because the api already sorted by updated_at or timestamp for ticket_events, we just need to break no need to check further.
+                    if (apiEndTime > endTime) {
+                        long checkedTime = 0;
+                        if (recordJsonNode.has(ZendeskConstants.Field.UPDATED_AT) && !recordJsonNode.get(ZendeskConstants.Field.UPDATED_AT).isNull()) {
+                            checkedTime = ZendeskDateUtils.isoToEpochSecond(recordJsonNode.get(ZendeskConstants.Field.UPDATED_AT).textValue());
+                        }
+
+                        // ticket events is updated by system not user's action so it only has timestamp field
+                        if (task.getTarget().equals(Target.TICKET_EVENTS) && recordJsonNode.has("timestamp") && !recordJsonNode.get("timestamp").isNull()) {
+                            checkedTime = recordJsonNode.get("timestamp").asLong();
+                        }
+
+                        // scores (or response) is only store rated_at time
+                        if (task.getTarget().equals(Target.SCORES) && recordJsonNode.has("rated_at") && !recordJsonNode.get("rated_at").isNull()) {
+                            checkedTime = ZendeskDateUtils.isoToEpochSecond(recordJsonNode.get("rated_at").textValue());
+                        }
+
+                        if (checkedTime > endTime) {
+                            break;
+                        }
+                    }
+
+                    if (task.getDedup()) {
+                        final String recordID = recordJsonNode.get(ZendeskConstants.Field.ID).asText();
+
+                        // add success -> no duplicate
+                        if (!knownIds.add(recordID)) {
+                            continue;
+                        }
+                    }
+
+                    pool.submit(() -> fetchSubResourceAndAddToImporter(recordJsonNode, task, recordImporter));
+                    recordCount++;
+                    if (Exec.isPreview()) {
+                        return;
+                    }
+                }
+
+                logger.info("Fetched '{}' records from start_time '{}'", recordCount, startTime);
+
+                // https://developer.zendesk.com/rest_api/docs/support/incremental_export#pagination
+                // When there are more than 1000 records share the same time stamp, the count > 1000
+                startTime = startTime == apiEndTime
+                        ? apiEndTime + 1
+                        : apiEndTime;
+
+                if (numberOfRecords < ZendeskConstants.Misc.MAXIMUM_RECORDS_INCREMENTAL || startTime > endTime) {
+                    break;
+                }
+            }
+
+            if (!Exec.isPreview()) {
+                storeStartTimeForConfigDiff(taskReport, initStartTime, startTime);
+            }
+        }
+        finally {
+            if (pool != null) {
+                pool.shutdown();
+                try {
+                    pool.awaitTermination(Long.MAX_VALUE, TimeUnit.MILLISECONDS);
+                }
+                catch (final InterruptedException e) {
+                    logger.warn("Error when wait pool to finish");
+                    throw Throwables.propagate(e);
+                }
+            }
+        }
+    }
+
+    private void storeStartTimeForConfigDiff(final TaskReport taskReport, final long initStartTime, final long resultEndTime)
+    {
+        if (task.getIncremental()) {
+            long nextStartTime;
+            long now = Instant.now().getEpochSecond();
+            // no record to add
+            if (resultEndTime == 0) {
+                nextStartTime = now;
+            }
+            else {
+                if (task.getEndTime().isPresent()) {
+                    long endTime = ZendeskDateUtils.isoToEpochSecond(task.getEndTime().get());
+                    nextStartTime = endTime + 1;
+                }
+                else {
+                    // NOTE: start_time compared as "=>", not ">".
+                    // If we will use end_time for next start_time, we got the same records that are fetched
+                    // end_time + 1 is workaround for that
+                    nextStartTime = resultEndTime + 1;
+                }
+            }
+
+            if (task.getEndTime().isPresent()) {
+                long endTime = ZendeskDateUtils.isoToEpochSecond(task.getEndTime().get());
+                taskReport.set(ZendeskConstants.Field.END_TIME, nextStartTime + endTime - initStartTime);
+            }
+
+            taskReport.set(ZendeskConstants.Field.START_TIME, nextStartTime);
+        }
+    }
+
+    private void fetchSubResourceAndAddToImporter(final JsonNode jsonNode, final ZendeskInputPlugin.PluginTask task, final RecordImporter recordImporter)
+    {
+        task.getIncludes().forEach(include -> {
+            final String relatedObjectName = include.trim();
+
+            final URIBuilder uriBuilder = ZendeskUtils.getURIBuilder(task.getLoginUrl())
+                    .setPath(ZendeskConstants.Url.API
+                            + "/" + task.getTarget().toString()
+                            + "/" + jsonNode.get(ZendeskConstants.Field.ID).asText()
+                            + "/" + relatedObjectName + ".json");
+            try {
+                final JsonNode result = getDataFromPath(uriBuilder.toString(), 0, false, 0);
+                if (result != null && result.has(relatedObjectName)) {
+                    ((ObjectNode) jsonNode).set(include, result.get(relatedObjectName));
+                }
+            }
+            catch (final ConfigException e) {
+                // Sometimes we get 404 when having invalid endpoint, so ignore when we get 404 InvalidEndpoint
+                if (!(e.getCause() instanceof ZendeskException && ((ZendeskException) e.getCause()).getStatusCode() == HttpStatus.SC_NOT_FOUND)) {
+                    throw e;
+                }
+            }
+        });
+
+        recordImporter.addRecord(jsonNode);
+    }
+
+    private boolean isUpdatedBySystem(final JsonNode recordJsonNode, final long startTime)
+    {
+        /*
+         * https://developer.zendesk.com/rest_api/docs/core/incremental_export#excluding-system-updates
+         * "generated_timestamp" will be updated when Zendesk internal changing
+         * "updated_at" will be updated when ticket data was changed
+         * start_time for query parameter will be processed on Zendesk with generated_timestamp,
+         * but it was calculated by record' updated_at time.
+         * So the doesn't changed record from previous import would be appear by Zendesk internal changes.
+         */
+        if (recordJsonNode.has(ZendeskConstants.Field.GENERATED_TIMESTAMP) && recordJsonNode.has(ZendeskConstants.Field.UPDATED_AT)) {
+            final String recordUpdatedAtTime = recordJsonNode.get(ZendeskConstants.Field.UPDATED_AT).asText();
+            final long recordUpdatedAtToEpochSecond = ZendeskDateUtils.isoToEpochSecond(recordUpdatedAtTime);
+
+            return recordUpdatedAtToEpochSecond <= startTime;
+        }
+
+        return false;
+    }
+
+    private void importDataForNonIncremental(final ZendeskInputPlugin.PluginTask task,  final int taskIndex, RecordImporter recordImporter, final boolean getStartDate)
+    {
+        long startTime = 0;
+
+        if (Target.SATISFACTION_RATINGS.equals(task.getTarget())){
+            if (getStartDate && task.getStartTime().isPresent()) {
+                startTime = ZendeskDateUtils.getStartTime(task.getStartTime().get());
+            }
+            logger.info("Start time = {}", startTime);
+
+            int i = 1;
+            final Set<String> knownIds = ConcurrentHashMap.newKeySet();
+            while (true) {
+                final JsonNode result = getDataFromPath("", taskIndex +i, false, startTime);
+                final Iterator<JsonNode> iterator = ZendeskUtils.getListRecords(result, task.getTarget().getJsonName());
+                while (iterator.hasNext()) {
+                    final JsonNode recordJsonNode = iterator.next();
+
+                    if (task.getDedup()) {
+                        final String recordID = recordJsonNode.get(ZendeskConstants.Field.ID).asText();
+
+                        // add success -> no duplicate
+                        if (!knownIds.add(recordID)) {
+                            continue;
+                        }
+                    }
+                    fetchSubResourceAndAddToImporter(recordJsonNode, task, recordImporter);
+
+                    if (Exec.isPreview()) {
+                        break;
+                    }
+                }
+
+                    i++;
+                if(result.has(ZendeskConstants.Field.NEXT_PAGE)){
+                    String next_page = result.get(ZendeskConstants.Field.NEXT_PAGE).textValue();
+                    if (next_page == null){
+                        logger.info("No next page exists. Exiting...");
+                        return;
+                    }
+                    logger.info("Next page = {}", next_page);
+                }
+                }
+
+        }
+        else{
+
+            // Page start from 1 => page = taskIndex + 1
+            final JsonNode result = getDataFromPath("", taskIndex + 1 , false, 0);
+            final Iterator<JsonNode> iterator = ZendeskUtils.getListRecords(result, task.getTarget().getJsonName());
+            while (iterator.hasNext()) {
+                fetchSubResourceAndAddToImporter(iterator.next(), task, recordImporter);
+
+                if (Exec.isPreview()) {
+                    break;
+                }
+            }
+        }
+
+    }
+}

data/src/main/java/org/embulk/input/zendesk/services/ZendeskService.java

@@ -0,0 +1,14 @@
+package org.embulk.input.zendesk.services;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import org.embulk.config.TaskReport;
+import org.embulk.input.zendesk.RecordImporter;
+
+public interface ZendeskService
+{
+    boolean isSupportIncremental();
+
+    TaskReport addRecordToImporter(int taskIndex, RecordImporter recordImporter);
+
+    JsonNode getDataFromPath(String path, int page, boolean isPreview, long startTime);
+}

data/src/main/java/org/embulk/input/zendesk/services/ZendeskSupportAPIService.java

@@ -0,0 +1,63 @@
+package org.embulk.input.zendesk.services;
+
+import org.apache.http.client.utils.URIBuilder;
+import org.embulk.input.zendesk.ZendeskInputPlugin.PluginTask;
+import org.embulk.input.zendesk.models.Target;
+import org.embulk.input.zendesk.utils.ZendeskConstants;
+import org.embulk.input.zendesk.utils.ZendeskUtils;
+
+public class ZendeskSupportAPIService extends ZendeskNormalServices
+{
+    public ZendeskSupportAPIService(final PluginTask task)
+    {
+        super(task);
+    }
+
+    public boolean isSupportIncremental()
+    {
+        return !(task.getTarget().equals(Target.TICKET_FORMS)
+                || task.getTarget().equals(Target.TICKET_FIELDS)
+                || task.getTarget().equals(Target.SATISFACTION_RATINGS));
+    }
+
+    @Override
+    protected String buildURI(final int page, long startTime)
+    {
+        final URIBuilder uriBuilder = ZendeskUtils.getURIBuilder(task.getLoginUrl()).setPath(buildPath());
+
+        if (isSupportIncremental()) {
+            uriBuilder.setParameter(ZendeskConstants.Field.START_TIME, String.valueOf(startTime));
+            if (Target.TICKET_METRICS.equals(task.getTarget())) {
+                uriBuilder.setParameter("include", "metric_sets");
+            }
+        }
+        else {
+            if (Target.SATISFACTION_RATINGS.equals(task.getTarget())){
+                uriBuilder.setParameter(ZendeskConstants.Field.START_TIME, String.valueOf(startTime))
+                        .setParameter("sort_by", "id")
+                        .setParameter("per_page", String.valueOf(100))
+                        .setParameter("page", String.valueOf(page));
+
+            }
+            else{
+                uriBuilder.setParameter("sort_by", "id")
+                        .setParameter("per_page", String.valueOf(100))
+                        .setParameter("page", String.valueOf(page));
+            }
+        }
+
+        return uriBuilder.toString();
+    }
+
+    private String buildPath()
+    {
+        return (isSupportIncremental() && !(Target.SATISFACTION_RATINGS.equals(task.getTarget()))
+                ? ZendeskConstants.Url.API_INCREMENTAL
+                : ZendeskConstants.Url.API) +
+                "/" +
+                (Target.TICKET_METRICS.equals(task.getTarget())
+                        ? Target.TICKETS.toString()
+                        : task.getTarget().toString())
+                + ".json";
+    }
+}