Modified error text, added comments for regex (#4103)

appsmithorg · Apr 22, 2021 · 2eec2fb · 2eec2fb
1 parent 9dff696
commit 2eec2fb
Show file tree

Hide file tree

Showing 10 changed files with 17 additions and 10 deletions.
diff --git a/...r/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/AppendMethod.java b/...r/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/AppendMethod.java
@@ -37,7 +37,7 @@ public AppendMethod(ObjectMapper objectMapper) {
     @Override
     public boolean validateMethodRequest(MethodConfig methodConfig) {
         if (methodConfig.getSpreadsheetId() == null || methodConfig.getSpreadsheetId().isBlank()) {
-            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Id");
+            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Url");
         }
         if (methodConfig.getSheetName() == null || methodConfig.getSheetName().isBlank()) {
             throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Sheet name");

diff --git a/...psmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/BulkAppendMethod.java b/...psmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/BulkAppendMethod.java
@@ -38,7 +38,7 @@ public BulkAppendMethod(ObjectMapper objectMapper) {
     @Override
     public boolean validateMethodRequest(MethodConfig methodConfig) {
         if (methodConfig.getSpreadsheetId() == null || methodConfig.getSpreadsheetId().isBlank()) {
-            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Id");
+            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Url");
         }
         if (methodConfig.getSheetName() == null || methodConfig.getSheetName().isBlank()) {
             throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Sheet name");

diff --git a/...psmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/BulkUpdateMethod.java b/...psmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/BulkUpdateMethod.java
@@ -38,7 +38,7 @@ public BulkUpdateMethod(ObjectMapper objectMapper) {
     @Override
     public boolean validateMethodRequest(MethodConfig methodConfig) {
         if (methodConfig.getSpreadsheetId() == null || methodConfig.getSpreadsheetId().isBlank()) {
-            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Id");
+            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Url");
         }
         if (methodConfig.getSheetName() == null || methodConfig.getSheetName().isBlank()) {
             throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Sheet name");

diff --git a/...er/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/ClearMethod.java b/...er/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/ClearMethod.java
@@ -22,7 +22,7 @@ public ClearMethod(ObjectMapper objectMapper) {
     @Override
     public boolean validateMethodRequest(MethodConfig methodConfig) {
         if (methodConfig.getSpreadsheetId() == null || methodConfig.getSpreadsheetId().isBlank()) {
-            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Id");
+            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Url");
         }
         if (methodConfig.getSpreadsheetRange() == null || methodConfig.getSpreadsheetRange().isBlank()) {
             throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Data Range");

diff --git a/...ver/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/CopyMethod.java b/...ver/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/CopyMethod.java
@@ -22,7 +22,7 @@ public CopyMethod(ObjectMapper objectMapper) {
     @Override
     public boolean validateMethodRequest(MethodConfig methodConfig) {
         if (methodConfig.getSpreadsheetId() == null || methodConfig.getSpreadsheetId().isBlank()) {
-            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Id");
+            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Url");
         }
         if (methodConfig.getSheetId() == null || methodConfig.getSheetId().isBlank()) {
             throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Sheet Id");

diff --git a/...ppsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/DeleteRowMethod.java b/...ppsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/DeleteRowMethod.java
@@ -30,7 +30,7 @@ public DeleteRowMethod(ObjectMapper objectMapper) {
     @Override
     public boolean validateMethodRequest(MethodConfig methodConfig) {
         if (methodConfig.getSpreadsheetId() == null || methodConfig.getSpreadsheetId().isBlank()) {
-            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Id");
+            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Url");
         }
         if (methodConfig.getSheetName() == null || methodConfig.getSheetName().isBlank()) {
             throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Sheet name");

diff --git a/...smith-plugins/googleSheetsPlugin/src/main/java/com/external/config/DeleteSheetMethod.java b/...smith-plugins/googleSheetsPlugin/src/main/java/com/external/config/DeleteSheetMethod.java
@@ -32,7 +32,7 @@ public DeleteSheetMethod(ObjectMapper objectMapper) {
     @Override
     public boolean validateMethodRequest(MethodConfig methodConfig) {
         if (methodConfig.getSpreadsheetId() == null || methodConfig.getSpreadsheetId().isBlank()) {
-            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Id");
+            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Url");
         }
         if (GoogleSheets.SHEET.equalsIgnoreCase(methodConfig.getDeleteFormat())) {
             if (methodConfig.getSheetName() == null || methodConfig.getSheetName().isBlank()) {

diff --git a/...ppsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/GetValuesMethod.java b/...ppsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/GetValuesMethod.java
@@ -33,14 +33,21 @@ public GetValuesMethod(ObjectMapper objectMapper) {
         this.objectMapper = objectMapper;
     }
 
+    // Used to capture the range of columns in this request. The handling for this regex makes sure that
+    // all possible combinations of A1 notation for a range map to a common format
     Pattern findAllRowsPattern = Pattern.compile("([a-zA-Z]*)\\d*:([a-zA-Z]*)\\d*");
+
+    // The starting row for a range is captured using this pattern to find its relative index from table heading
     Pattern findOffsetRowPattern = Pattern.compile("(\\d+):");
+
+    // Since the value for this pattern is coming from an API response, it also contains the sheet name
+    // We use this pattern to retrieve only range information
     Pattern sheetRangePattern = Pattern.compile(".*!([a-zA-Z]*)\\d*:([a-zA-Z]*)\\d*");
 
     @Override
     public boolean validateMethodRequest(MethodConfig methodConfig) {
         if (methodConfig.getSpreadsheetId() == null || methodConfig.getSpreadsheetId().isBlank()) {
-            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Id");
+            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Url");
         }
         if (methodConfig.getSheetName() == null || methodConfig.getSheetName().isBlank()) {
             throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Sheet name");

diff --git a/...ver/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/InfoMethod.java b/...ver/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/InfoMethod.java
@@ -23,7 +23,7 @@ public InfoMethod(ObjectMapper objectMapper) {
     @Override
     public boolean validateMethodRequest(MethodConfig methodConfig) {
         if (methodConfig.getSpreadsheetId() == null || methodConfig.getSpreadsheetId().isBlank()) {
-            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Id");
+            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Url");
         }
 
         return true;

diff --git a/...r/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/UpdateMethod.java b/...r/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/UpdateMethod.java
@@ -35,7 +35,7 @@ public UpdateMethod(ObjectMapper objectMapper) {
     @Override
     public boolean validateMethodRequest(MethodConfig methodConfig) {
         if (methodConfig.getSpreadsheetId() == null || methodConfig.getSpreadsheetId().isBlank()) {
-            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Id");
+            throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Spreadsheet Url");
         }
         if (methodConfig.getSheetName() == null || methodConfig.getSheetName().isBlank()) {
             throw new AppsmithPluginException(AppsmithPluginError.PLUGIN_ERROR, "Missing required field Sheet name");