Merge pull request #381 from jimkyndemeyer/rework-introspection-errors

Reworked introspection query handling

Author: vepanimas

resources/messages/GraphQLMessages.properties

@@ -1,21 +1,22 @@
 # Notifications
-graphql.notification.introspection.error.title=GraphQL introspection error
+graphql.notification.introspection.error.title=GraphQL introspection
 graphql.notification.introspection.error.body=A valid schema could not be built using the introspection result.<br/>Error: {0}
 graphql.notification.introspection.spec.error.body=A valid schema could not be built using the introspection result. The endpoint may not follow the GraphQL Specification.<br/>Error: {0}
+graphql.notification.introspection.parse.error=The server introspection response cannot be parsed as a valid JSON object.
+graphql.notification.introspection.empty.errors=Encountered empty error array, which does not conform to the GraphQL spec.
 graphql.notification.error.title=GraphQL error
-graphql.notification.response=Response
 graphql.notification.stack.trace=Stack trace
 graphql.notification.retry.without.defaults=Retry (skip default values from now on)
 graphql.notification.retry=Retry
-graphql.notification.unable.to.open.editor=Unable to open an editor for '{0}'
-graphql.notification.unable.to.create.file=Unable to create file '{0}' in directory '{1}'.<br/>Error: {2}
+graphql.notification.unable.to.open.editor=Unable to open an editor for ''{0}''
+graphql.notification.unable.to.create.file=Unable to create file ''{0}'' in directory ''{1}''.<br/>Error: {2}
 graphql.notification.invalid.config.file=Invalid config file
 graphql.notification.empty.schema.path=Please set a non-empty `schemaPath` field in the config file.
 graphql.notification.empty.endpoint.url=Please set a non-empty endpoint `url` field in the config file.
 graphql.notification.unable.to.parse.file=Unable to parse {0}
 graphql.notification.load.schema.from.endpoint.title=Get GraphQL schema from endpoint now?
-graphql.notification.load.schema.from.endpoint.body=Introspect '{0}' to update the local schema file.
-graphql.notification.load.schema.from.endpoint.action=Introspect '{0}'
+graphql.notification.load.schema.from.endpoint.body=Introspect ''{0}'' to update the local schema file.
+graphql.notification.load.schema.from.endpoint.action=Introspect ''{0}''
 
 # Introspection
 graphql.introspection.missing.data=Expected `data` key to be present in query result.

src/main/com/intellij/lang/jsgraphql/ide/editor/GraphQLIntrospectionJsonToSDLLineMarkerProvider.java

@@ -65,7 +65,7 @@ public LineMarkerInfo<?> getLineMarkerInfo(@NotNull PsiElement element) {
                 generateAction.set(() -> {
                     try {
                         final String introspectionJson = element.getContainingFile().getText();
-                        final String schemaAsSDL = graphQLIntrospectionService.printIntrospectionJsonAsGraphQL(introspectionJson);
+                        final String schemaAsSDL = graphQLIntrospectionService.printIntrospectionAsGraphQL(introspectionJson);
 
                         final VirtualFile jsonFile = element.getContainingFile().getVirtualFile();
                         final String outputFileName = jsonFile.getName() + ".graphql";

src/main/com/intellij/lang/jsgraphql/ide/editor/GraphQLIntrospectionService.java

@@ -42,20 +42,19 @@ public void actionPerformed(@NotNull AnActionEvent e, @NotNull Notification noti
         Notifications.Bus.notify(notification);
     }
 
-    public static void showRequestExceptionNotification(@NotNull NotificationAction retry,
-                                                        @NotNull String url,
-                                                        @NotNull String error,
-                                                        @NotNull NotificationType notificationType,
-                                                        @NotNull Project project) {
-        Notifications.Bus.notify(
-            new Notification(
-                NOTIFICATION_GROUP_ID,
-                GraphQLBundle.message("graphql.notification.error.title"),
-                url + ": " + error,
-                notificationType
-            ).addAction(retry),
-            project
-        );
+    public static void showGraphQLRequestErrorNotification(@NotNull NotificationAction retry,
+                                                           @NotNull String url,
+                                                           @NotNull Exception error,
+                                                           @NotNull NotificationType notificationType,
+                                                           @NotNull Project project) {
+        Notification notification = new Notification(
+            NOTIFICATION_GROUP_ID,
+            GraphQLBundle.message("graphql.notification.error.title"),
+            url + ": " + GraphQLNotificationUtil.formatExceptionMessage(error),
+            notificationType
+        ).addAction(retry);
+
+        Notifications.Bus.notify(notification, project);
     }
 
     public static void addRetryFailedSchemaIntrospectionAction(@NotNull Notification notification,

src/main/com/intellij/lang/jsgraphql/ide/notifications/GraphQLNotificationUtil.java

@@ -162,7 +162,7 @@ private GraphQLValidatedTypeDefinitionRegistry getRegistry(@NotNull PsiElement s
                     if (psiFile != null) {
                         try {
                             synchronized (GRAPHQL_INTROSPECTION_JSON_TO_SDL) {
-                                final String introspectionJsonAsGraphQL = GraphQLIntrospectionService.getInstance(project).printIntrospectionJsonAsGraphQL(psiFile.getText());
+                                final String introspectionJsonAsGraphQL = GraphQLIntrospectionService.getInstance(project).printIntrospectionAsGraphQL(psiFile.getText());
                                 final GraphQLFile currentSDLPsiFile = psiFile.getUserData(GRAPHQL_INTROSPECTION_JSON_TO_SDL);
                                 if (currentSDLPsiFile != null && currentSDLPsiFile.getText().equals(introspectionJsonAsGraphQL)) {
                                     // already have a PSI file that matches the introspection SDL

src/main/com/intellij/lang/jsgraphql/schema/GraphQLRegistryProvider.java

@@ -473,24 +473,16 @@ private static Gson createQueryJsonSerializer() {
             .create();
     }
 
-    public enum QueryResultDisplay {
-        ALWAYS,
-        ON_ERRORS_ONLY
-    }
-
-    public void showQueryResult(String jsonResponse, QueryResultDisplay display) {
-        if (fileEditor instanceof TextEditor) {
-            final TextEditor fileEditor = (TextEditor) this.fileEditor;
-            updateQueryResultEditor(jsonResponse, fileEditor, true);
-            if (display == QueryResultDisplay.ON_ERRORS_ONLY) {
-                final Integer errorCount = getErrorCount(jsonResponse);
-                if (errorCount == null || errorCount > 0) {
-                    showQueryResultEditor(fileEditor);
-                }
-            } else {
-                showQueryResultEditor(fileEditor);
-            }
+    public void showQueryResult(@NotNull String jsonResponse) {
+        if (!(fileEditor instanceof TextEditor)) {
+            return;
         }
+
+        ApplicationManager.getApplication().invokeLater(() -> {
+            TextEditor textEditor = (TextEditor) fileEditor;
+            updateQueryResultEditor(jsonResponse, textEditor, true);
+            showQueryResultEditor(textEditor);
+        });
     }
 
     private void showQueryResultEditor(TextEditor textEditor) {

src/main/com/intellij/lang/jsgraphql/v1/ide/project/JSGraphQLLanguageUIProjectService.java

@@ -1,12 +1,13 @@
 package com.intellij.lang.jsgraphql.ide.editor;
 
-import com.intellij.openapi.vfs.VfsUtil;
+import com.intellij.openapi.vfs.VfsUtilCore;
 import com.intellij.testFramework.fixtures.BasePlatformTestCase;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.junit.Assert;
 
 import java.io.IOException;
+import java.util.Objects;
 
 public class GraphQLIntrospectionServiceTest extends BasePlatformTestCase {
 
@@ -40,16 +41,16 @@ public void testPrintIntrospectionWithNullFields() {
 
     private void doTest(@NotNull String source, @NotNull String expected) {
         myFixture.configureByText(
-                "result.graphql",
-                new GraphQLIntrospectionService(getProject()).printIntrospectionJsonAsGraphQL(readSchemaJson(source))
+            "result.graphql",
+            new GraphQLIntrospectionService(getProject()).printIntrospectionAsGraphQL(Objects.requireNonNull(readSchemaJson(source)))
         );
         myFixture.checkResultByFile(expected);
     }
 
     @Nullable
     private String readSchemaJson(@NotNull String path) {
         try {
-            return VfsUtil.loadText(myFixture.copyFileToProject(path));
+            return VfsUtilCore.loadText(myFixture.copyFileToProject(path));
         } catch (IOException e) {
             return null;
         }