Improve chat validation dueto Chat endpoint update

treasure-data · Oct 23, 2024 · c8ce68c · c8ce68c
1 parent f37e5ce
commit c8ce68c
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 66 deletions.
diff --git a/src/main/java/org/embulk/input/zendesk/clients/ZendeskRestClient.java b/src/main/java/org/embulk/input/zendesk/clients/ZendeskRestClient.java
@@ -173,11 +173,7 @@ private boolean isResponseStatusToRetry(final int status, final String message,
                 // In case we can't parse the message, error should not be show here
             }
 
-            if (target.equals(Target.CHAT) && !Pattern.compile(ZendeskConstants.Regex.CHAT_LOGIN_URL).matcher(loginURL).matches()) {
-                throw new ConfigException("Invalid login url. Check that you are using https://www.zopim.com to import chat data.");
-            }
-
-            if (!target.equals(Target.CHAT) && !Pattern.compile(ZendeskConstants.Regex.LOGIN_URL).matcher(loginURL).matches()) {
+            if (!Pattern.compile(ZendeskConstants.Regex.LOGIN_URL).matcher(loginURL).matches()) {
                 throw new ConfigException("Invalid login url. Check that you are using the correct Zendesk url (https://example.zendesk.com/) to import data.");
             }
 
@@ -214,12 +210,7 @@ else if (status != ZendeskConstants.HttpStatus.TOO_MANY_REQUEST) {
         // Won't retry for 4xx range errors except above. Almost they should be ConfigError e.g. 403 Forbidden
         if (status / 100 == 4) {
             if (status == HttpStatus.SC_UNAUTHORIZED) {
-                if (target.equals(Target.CHAT)) {
-                    throw new ConfigException("Invalid credentials. Check that you are using your Zopim credentials to import Chat data.");
-                }
-                else {
-                    throw new ConfigException("Invalid credentials. Check that you are using your Zendesk credentials to import non-Chat data.");
-                }
+                throw new ConfigException("Invalid credentials. Check that you are using your Zendesk credentials.");
             }
 
             if (status == HttpStatus.SC_FORBIDDEN) {

diff --git a/src/main/java/org/embulk/input/zendesk/utils/ZendeskConstants.java b/src/main/java/org/embulk/input/zendesk/utils/ZendeskConstants.java
@@ -68,7 +68,6 @@ public static class Regex
     {
         public static final String ID = "_id$";
         public static final String LOGIN_URL = "^https?://+[a-z0-9_\\\\-]+(.zendesk.com/?)$";
-        public static final String CHAT_LOGIN_URL = "^https://www.zopim.com/?$";
     }
 
     public static class HttpStatus

diff --git a/src/test/java/org/embulk/input/zendesk/clients/TestZendeskRestClient.java b/src/test/java/org/embulk/input/zendesk/clients/TestZendeskRestClient.java
@@ -150,37 +150,14 @@ public void doGetRetry404()
         verify(zendeskRestClient, times(expectedRetryTime)).createHttpClient();
     }
 
-    @Test
-    public void doThrowWrongHostExceptionForChatWhen404()
-    {
-        setup("doGet404");
-        ConfigSource configSource = ZendeskTestHelper.getConfigSource("incremental.yml");
-        configSource.set("auth_method", "oauth");
-        configSource.set("access_token", "token");
-        configSource.set("target", "chat");
-        configSource.set("login_url", "https://abc.zendesk.com");
-        PluginTask pluginTask = CONFIG_MAPPER.map(configSource, PluginTask.class);
-
-        String expectedMessage = "Invalid login url. Check that you are using https://www.zopim.com to import chat data.";
-        int expectedRetryTime = 1;
-        try {
-            zendeskRestClient.doGet("any", pluginTask, false);
-            fail("Should not reach here");
-        }
-        catch (final Exception e) {
-            assertEquals(expectedMessage, e.getMessage());
-        }
-        verify(zendeskRestClient, times(expectedRetryTime)).createHttpClient();
-    }
-
     @Test
     public void doThrowWrongHostExceptionForNonChatWhen404()
     {
         setup("doGet404");
         ConfigSource configSource = ZendeskTestHelper.getConfigSource("incremental.yml");
         configSource.set("auth_method", "oauth");
         configSource.set("access_token", "token");
-        configSource.set("login_url", "https://www.zopim.com/");
+        configSource.set("login_url", "https://www.chat.zendesk.com/");
         PluginTask pluginTask = CONFIG_MAPPER.map(configSource, PluginTask.class);
 
         String expectedMessage = "Invalid login url. Check that you are using the correct Zendesk url (https://example.zendesk.com/) to import data.";
@@ -195,40 +172,17 @@ public void doThrowWrongHostExceptionForNonChatWhen404()
         verify(zendeskRestClient, times(expectedRetryTime)).createHttpClient();
     }
 
-    @Test
-    public void doThrowCredentialWrongExceptionForChatWhen401()
-    {
-        setup("credentialFail401");
-        ConfigSource configSource = ZendeskTestHelper.getConfigSource("incremental.yml");
-        configSource.set("auth_method", "oauth");
-        configSource.set("access_token", "token");
-        configSource.set("target", "chat");
-        configSource.set("login_url", "https://abc.zendesk.com");
-        PluginTask pluginTask = CONFIG_MAPPER.map(configSource, PluginTask.class);
-
-        String expectedMessage = "Invalid credentials. Check that you are using your Zopim credentials to import Chat data.";
-        int expectedRetryTime = 1;
-        try {
-            zendeskRestClient.doGet("any", pluginTask, false);
-            fail("Should not reach here");
-        }
-        catch (final Exception e) {
-            assertEquals(expectedMessage, e.getMessage());
-        }
-        verify(zendeskRestClient, times(expectedRetryTime)).createHttpClient();
-    }
-
     @Test
     public void doThrowCredentialWrongExceptionForNonChatWhen401()
     {
         setup("credentialFail401");
         ConfigSource configSource = ZendeskTestHelper.getConfigSource("incremental.yml");
         configSource.set("auth_method", "oauth");
         configSource.set("access_token", "token");
-        configSource.set("login_url", "https://www.zopim.com/");
+        configSource.set("login_url", "https://www.chat.zendesk.com/");
         PluginTask pluginTask = CONFIG_MAPPER.map(configSource, PluginTask.class);
 
-        String expectedMessage = "Invalid credentials. Check that you are using your Zendesk credentials to import non-Chat data.";
+        String expectedMessage = "Invalid credentials. Check that you are using your Zendesk credentials.";
         int expectedRetryTime = 1;
         try {
             zendeskRestClient.doGet("any", pluginTask, false);

diff --git a/src/test/java/org/embulk/input/zendesk/services/TestZendeskChatService.java b/src/test/java/org/embulk/input/zendesk/services/TestZendeskChatService.java
@@ -58,9 +58,9 @@ public void testFetchData()
         JsonNode dataSearchJson = ZendeskTestHelper.getJsonFromFile("data/chat_search.json");
         JsonNode dataJson = ZendeskTestHelper.getJsonFromFile("data/chat.json");
 
-        when(zendeskRestClient.doGet(eq("https://www.zopim.com/api/v2/chats/search?q=timestamp%3A%5B2018-09-15T05%3A00%3A00Z+TO+2019-09-29T05%3A00%3A00Z%5D&page=1"), any(), anyBoolean())).thenReturn(dataSearchJson.toString());
+        when(zendeskRestClient.doGet(eq("https://www.chat.zendesk.com/api/v2/chats/search?q=timestamp%3A%5B2018-09-15T05%3A00%3A00Z+TO+2019-09-29T05%3A00%3A00Z%5D&page=1"), any(), anyBoolean())).thenReturn(dataSearchJson.toString());
 
-        when(zendeskRestClient.doGet(eq("https://www.zopim.com/api/v2/chats?ids=id_1%2Cid_2"), any(), anyBoolean())).thenReturn(dataJson.toString());
+        when(zendeskRestClient.doGet(eq("https://www.chat.zendesk.com/api/v2/chats?ids=id_1%2Cid_2"), any(), anyBoolean())).thenReturn(dataJson.toString());
 
         zendeskChatService.fetchData("2018-09-15T05:00:00Z", "2019-09-29T05:00:00Z", 1, recordImporter);
 

diff --git a/src/test/resources/config/chat.yml b/src/test/resources/config/chat.yml
@@ -1,5 +1,5 @@
 type: zendesk
-login_url: https://www.zopim.com
+login_url: https://www.chat.zendesk.com
 auth_method: basic
 username: username
 password: password

diff --git a/src/test/resources/data/chat_search.json b/src/test/resources/data/chat_search.json
@@ -4,14 +4,14 @@
       "id": "id_1",
       "timestamp": "2019-10-12T21:43:23Z",
       "preview": "abc",
-      "url": "https://www.zopim.com/api/v2/chats/id_1",
+      "url": "https://www.chat.zendesk.com/api/v2/chats/id_1",
       "type": "offline_msg"
     },
     {
       "id": "id_2",
       "timestamp": "2019-10-12T20:02:54Z",
       "preview": "abc",
-      "url": "https://www.zopim.com/api/v2/chats/id_2",
+      "url": "https://www.chat.zendesk.com/api/v2/chats/id_2",
       "type": "offline_msg"
     }
   ],