[BACKLOG-25665] Improve error handling in Field Selection dialog of J…

…SON Input Step (#5800)

plugins/get-fields/core/src/main/java/org/pentaho/getfields/endpoint/GetFieldsEndpoint.java

@@ -22,6 +22,7 @@
 
 package org.pentaho.getfields.endpoint;
 
+import org.pentaho.di.core.exception.KettleFileException;
 import org.pentaho.getfields.types.json.JsonSampler;
 import org.pentaho.getfields.types.json.node.Node;
 
@@ -57,8 +58,10 @@ private Response loadJson( String path ) {
     Node node = null;
     try {
       node = jsonSampler.sample( path );
-    } catch ( IOException e ) {
+    } catch ( KettleFileException e ) { // Cannot find file OR no permissions
       return Response.status( Response.Status.NOT_FOUND ).build();
+    } catch ( IOException e ) { // Invalid JSON structure
+      return Response.status( Response.Status.NOT_ACCEPTABLE ).build();
     }
 
     return Response.ok( node ).build();

plugins/get-fields/core/src/main/java/org/pentaho/getfields/extension/GetFieldsExtensionPoint.java

@@ -22,6 +22,9 @@
 import org.pentaho.di.ui.core.GetFieldsDialogOperation;
 import org.pentaho.getfields.dialog.GetFieldsDialog;
 
+import java.util.HashMap;
+import java.util.Map;
+
 /**
  * Created by ddiroma on 08/13/18.
  */
@@ -33,14 +36,23 @@
 )
 public class GetFieldsExtensionPoint implements ExtensionPointInterface {
 
+  private static final Map<String, String> INPUT_TYPES;
+
+  static {
+    // The input types are the step id's of individual steps that map to the string used in the get fields dialog
+    // Add more input types as they are added to use get fields extension point
+    INPUT_TYPES  = new HashMap<>();
+    INPUT_TYPES.put( "JSON Input", "JSON" );
+  }
+
   @Override public void callExtensionPoint( LogChannelInterface logChannelInterface, Object o ) throws KettleException {
     GetFieldsDialogOperation getFieldsDialogOperation = (GetFieldsDialogOperation) o;
     GetFieldsDialog getFieldsDialog = new GetFieldsDialog( getFieldsDialogOperation.getShell(),
             getFieldsDialogOperation.getWidth(), getFieldsDialogOperation.getHeight(), getFieldsDialogOperation
             .getFilename() );
-    String name = getFieldsDialogOperation.getStepMeta().getName();
-    getFieldsDialog.setTitle( name );
-    getFieldsDialog.setType( name );
+    String title = getFieldsDialogOperation.getTitle(); // this is for the dialog title AND the key for input type
+    getFieldsDialog.setTitle( title );
+    getFieldsDialog.setType( INPUT_TYPES.get( title ) );
     getFieldsDialog.open();
     getFieldsDialogOperation.setPaths( getFieldsDialog.getPaths() );
   }

plugins/get-fields/core/src/main/java/org/pentaho/getfields/types/json/JsonSampler.java

@@ -107,11 +107,11 @@ public Node sample( InputStream inputStream ) throws IOException {
    * @return The sampled Node
    * @throws IOException
    */
-  public Node sample( String file ) throws IOException {
+  public Node sample( String file ) throws IOException, KettleFileException {
     try {
       return sample( KettleVFS.getInputStream( file ) );
     } catch ( KettleFileException kfe ) {
-      return null;
+      throw kfe;
     }
   }
 

plugins/get-fields/core/src/main/javascript/app/app.component.js

@@ -72,18 +72,28 @@ define([
     function onInit() {
       var path = $location.search().path;
       vm.type = $location.search().type;
-      $timeout(function() {
-        if (vm.showMessage) {
-          vm.showMessageText = true;
-        }
-      }, 1000);
-      dt.sample(path).then(function(response) {
-        vm.tree = response.data;
-        vm.showMessage = false;
-      }, function() {
-        _showMessage(i18n.get("get-fields-plugin.app.unable-to-access.label", {dataType: vm.type}),
-          i18n.get("get-fields.plugin.app.unable-to-access.message"));
-      });
+      if (path === "") { // No file path specified in step
+        _showMessage(i18n.get("get-fields-plugin.app.unable-to-view.label", {dataType: vm.type}),
+          i18n.get("get-fields.plugin.app.unable-to-view.message", {dataType: vm.type}));
+      } else {
+        $timeout(function() {
+          if (vm.showMessage) {
+            vm.showMessageText = true;
+          }
+        }, 1000);
+        dt.sample(path).then(function(response) {
+          vm.tree = response.data;
+          vm.showMessage = false;
+        }, function(response) {
+          if (response.status === 404) { // Cannot find file OR no permissions
+            _showMessage(i18n.get("get-fields-plugin.app.unable-to-access.label", {dataType: vm.type}),
+              i18n.get("get-fields.plugin.app.unable-to-access.message"));
+          } else { // Invalid JSON structure OR other issue
+            _showMessage(i18n.get("get-fields-plugin.app.unable-to-view.label", {dataType: vm.type}),
+              i18n.get("get-fields.plugin.app.unable-to-view.message", {dataType: vm.type}));
+          }
+        });
+      }
     }
 
     function doSearch(value) {

plugins/get-fields/core/src/main/javascript/app/components/message/message.css

@@ -50,7 +50,11 @@ message .message .title {
   font-family: OpenSansLight;
 }
 
+message .message .title.messageNoSpinner {
+  margin-bottom: 24px;
+}
+
 message .message .messageTxt {
-  line-height: 28px;
+  line-height: 24px;
   font-size: 14px;
 }

plugins/get-fields/core/src/main/javascript/app/components/message/message.html

@@ -1,7 +1,7 @@
 <div class="message">
   <div class="icon" ng-if="vm.showSpinner"></div>
   <div class="text" ng-if="(vm.title || vm.message) && vm.showText">
-    <div class="title">
+    <div class="title" ng-class="{messageNoSpinner : !vm.showSpinner}">
       {{vm.title}}
     </div>
     <div class="messageTxt">

plugins/get-fields/core/src/main/resources/i18n/get-fields/messages.properties

@@ -8,16 +8,15 @@ get-fields-plugin.app.cancel.button=Cancel
 get-fields-plugin.app.help.link=Help
 get-fields-plugin.app.clear-selection.label=Clear Selection
 get-fields-plugin.app.resample.label=Resample
+## Error message 1 -- Cannot find search value
 get-fields-plugin.app.unable-to-find.label=Unable to find "{searchField}"
 get-fields.plugin.app.unable-to-find.message=Sorry, we were unable to find that field. Please try another search or increase your sample size.
+## Error message 2 -- Cannot find file OR no permissions
 get-fields-plugin.app.unable-to-access.label=Unable to access your {dataType} data
 get-fields.plugin.app.unable-to-access.message=It looks like the location you specified is either incorrect or you do not have access. Check your settings in the File tab and try again.
-
-## get-fields-error component
-get-fields-plugin.error.unable-to-make-selection.header=Unable to make selection
-get-fields-plugin.error.unable-to-make-selection.message=The selection you are trying to make cannot be made with your current selection. You can use an additional {0} step or deselect the other fields.
-get-fields-plugin.error.unable-to-resample.header=UX still needs to define this
-get-fields-plugin.error.unable-to-resample.message=UX still needs to define this
+## Error message 3 -- No file path specified in step OR Invalid JSON structure OR other issue
+get-fields-plugin.app.unable-to-view.label=Unable to view {dataType} fields
+get-fields.plugin.app.unable-to-view.message=It looks like there is no input specified, so we are unable to display {dataType} fields. Please add an input in the "Field" tab and try again.
 
 ## get-fields-message component
 get-fields-plugin.message.title=Just a moment

plugins/get-fields/core/src/main/resources/i18n/get-fields/messages_en.properties

@@ -8,16 +8,15 @@ get-fields-plugin.app.cancel.button=Cancel
 get-fields-plugin.app.help.link=Help
 get-fields-plugin.app.clear-selection.label=Clear Selection
 get-fields-plugin.app.resample.label=Resample
+## Error message 1 -- Cannot find search value
 get-fields-plugin.app.unable-to-find.label=Unable to find "{searchField}"
 get-fields.plugin.app.unable-to-find.message=Sorry, we were unable to find that field. Please try another search or increase your sample size.
+## Error message 2 -- Cannot find file OR no permissions
 get-fields-plugin.app.unable-to-access.label=Unable to access your {dataType} data
 get-fields.plugin.app.unable-to-access.message=It looks like the location you specified is either incorrect or you do not have access. Check your settings in the File tab and try again.
-
-## get-fields-error component
-get-fields-plugin.error.unable-to-make-selection.header=Unable to make selection
-get-fields-plugin.error.unable-to-make-selection.message=The selection you are trying to make cannot be made with your current selection. You can use an additional {0} step or deselect the other fields.
-get-fields-plugin.error.unable-to-resample.header=UX still needs to define this
-get-fields-plugin.error.unable-to-resample.message=UX still needs to define this
+## Error message 3 -- No file path specified in step OR Invalid JSON structure OR other issue
+get-fields-plugin.app.unable-to-view.label=Unable to view {dataType} fields
+get-fields.plugin.app.unable-to-view.message=It looks like there is no input specified, so we are unable to display {dataType} fields. Please add an input in the "Field" tab and try again.
 
 ## get-fields-message component
 get-fields-plugin.message.title=Just a moment

plugins/json/core/src/main/java/org/pentaho/di/ui/trans/steps/jsoninput/JsonInputDialog.java

@@ -1480,8 +1480,8 @@ private void get() {
       // Call new get fields dialog
       if ( wFilenameList.getItemCount() > 0 ) {
         String filename = transMeta.environmentSubstitute( wFilenameList.getItem( 0 )[ 0 ] );
-        GetFieldsDialogOperation getFieldsDialogOperation = new GetFieldsDialogOperation( shell, stepMeta, 540, 588,
-                filename );
+        GetFieldsDialogOperation getFieldsDialogOperation = new GetFieldsDialogOperation( shell, 540, 588, filename,
+          BaseMessages.getString( PKG, "JsonInput.GetFields.Dialog.Title" ) );
         ExtensionPointHandler.callExtensionPoint( null, KettleExtensionPoint.GetFieldsExtension.id,
                 getFieldsDialogOperation );
 

plugins/json/core/src/main/resources/org/pentaho/di/trans/steps/jsoninput/messages/messages_en_US.properties

@@ -5,6 +5,7 @@
 JsonInput.name=JSON input
 JsonInput.description=Extract relevant portions out of JSON structures (file or incoming field) and output rows
 JsonInput.category=Input
+JsonInput.GetFields.Dialog.Title=JSON Input
 
 JsonInputDialog.Limit.Label=Limit
 JsonInputDialog.FilenameEdit.Button=&Edit

ui/src/main/java/org/pentaho/di/ui/core/GetFieldsDialogOperation.java

@@ -16,7 +16,6 @@
 package org.pentaho.di.ui.core;
 
 import org.eclipse.swt.widgets.Shell;
-import org.pentaho.di.trans.step.StepMeta;
 
 import java.util.List;
 
@@ -25,18 +24,18 @@
  */
 public class GetFieldsDialogOperation {
   private Shell shell;
-  private StepMeta stepMeta;
   private int width;
   private int height;
   private String filename;
+  private String title;
   private List<String> paths;
 
-  public GetFieldsDialogOperation( Shell shell, StepMeta stepMeta, int width, int height, String filename ) {
+  public GetFieldsDialogOperation( Shell shell, int width, int height, String filename, String title ) {
     this.shell = shell;
-    this.stepMeta = stepMeta;
     this.width = width;
     this.height = height;
     this.filename = filename;
+    this.title = title;
   }
 
   public Shell getShell() {
@@ -47,14 +46,6 @@ public void setShell( Shell shell ) {
     this.shell = shell;
   }
 
-  public StepMeta getStepMeta() {
-    return stepMeta;
-  }
-
-  public void setStepMeta( StepMeta stepMeta ) {
-    this.stepMeta = stepMeta;
-  }
-
   public int getWidth() {
     return width;
   }
@@ -86,4 +77,12 @@ public List<String> getPaths() {
   public void setPaths( List<String> paths ) {
     this.paths = paths;
   }
+
+  public String getTitle() {
+    return title;
+  }
+
+  public void setTitle( String title ) {
+    this.title = title;
+  }
 }