Added the ability to load env variables from a .env file (#426)

* Added the ability to load env variables from a .env file

* Can now load .env files from multi-root projects

* Can now load .env files from multi-root projects

* Can now load .env files from multi-root projects

* Review improvements

Author: mellson

README.md

@@ -15,6 +15,7 @@ GraphQL language support for WebStorm, IntelliJ IDEA and other IDEs based on the
 - Syntax highlighting, code-formatting, folding, commenter, and brace-matching
 - 'Find Usages' and 'Go to Declaration' for schema types, fields, and fragments
 - 'Structure view' to navigate GraphQL files
+- Load variables from .env files
 
 ## Documentation
 

build.gradle

@@ -28,6 +28,7 @@ dependencies {
     implementation 'com.atlassian.commonmark:commonmark:0.12.1'
     implementation group: 'org.yaml', name: 'snakeyaml', version: '1.21'
     implementation 'fr.opensagres.js:minimatch.java:1.1.0'
+    implementation 'io.github.cdimascio:dotenv-kotlin:6.2.2'
 
     testImplementation group: 'junit', name: 'junit', version: '4.12'
 }

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

@@ -29,6 +29,7 @@
 import com.intellij.openapi.util.Ref;
 import com.intellij.openapi.util.text.StringUtil;
 import com.intellij.openapi.vfs.VirtualFile;
+import com.intellij.psi.PsiDirectory;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiErrorElement;
 import com.intellij.psi.PsiFile;
@@ -48,6 +49,8 @@
  * Line marker for running an introspection against a configured endpoint url in a .graphqlconfig file
  */
 public class GraphQLIntrospectEndpointUrlLineMarkerProvider implements LineMarkerProvider {
+    private String pathOfConfigFileParent;
+
     @Nullable
     @Override
     public LineMarkerInfo<?> getLineMarkerInfo(@NotNull PsiElement element) {
@@ -60,13 +63,14 @@ public LineMarkerInfo<?> getLineMarkerInfo(@NotNull PsiElement element) {
             if (isEndpointUrl(jsonProperty, urlRef) && !hasErrors(jsonProperty.getContainingFile())) {
                 return new LineMarkerInfo<>(jsonProperty, jsonProperty.getTextRange(), AllIcons.RunConfigurations.TestState.Run, Pass.UPDATE_ALL, o -> "Run introspection query to generate GraphQL SDL schema file", (evt, jsonUrl) -> {
 
-                    String introspectionUtl;
+                    String introspectionUrl;
                     if (jsonUrl.getValue() instanceof JsonStringLiteral) {
-                        introspectionUtl = ((JsonStringLiteral) jsonUrl.getValue()).getValue();
+                        introspectionUrl = ((JsonStringLiteral) jsonUrl.getValue()).getValue();
                     } else {
                         return;
                     }
-                    final GraphQLConfigVariableAwareEndpoint endpoint = getEndpoint(introspectionUtl, jsonProperty);
+
+                    final GraphQLConfigVariableAwareEndpoint endpoint = getEndpoint(introspectionUrl, jsonProperty, element.getContainingFile().getVirtualFile());
                     if (endpoint == null) {
                         return;
                     }
@@ -159,7 +163,7 @@ private String getSchemaPath(@NotNull JsonProperty urlElement, boolean showNotif
         return null;
     }
 
-    private GraphQLConfigVariableAwareEndpoint getEndpoint(String url, JsonProperty urlJsonProperty) {
+    private GraphQLConfigVariableAwareEndpoint getEndpoint(String url, JsonProperty urlJsonProperty, VirtualFile configFile) {
         try {
             // if the endpoint is just the url string, headers are not supported
             final JsonProperty parent = PsiTreeUtil.getParentOfType(urlJsonProperty, JsonProperty.class);
@@ -181,7 +185,7 @@ private GraphQLConfigVariableAwareEndpoint getEndpoint(String url, JsonProperty
             }
 
 
-            return new GraphQLConfigVariableAwareEndpoint(endpointConfig, urlJsonProperty.getProject());
+            return new GraphQLConfigVariableAwareEndpoint(endpointConfig, urlJsonProperty.getProject(), configFile);
 
         } catch (Exception e) {
             Notifications.Bus.notify(new Notification("GraphQL", "GraphQL Configuration Error", e.getMessage(), NotificationType.ERROR), urlJsonProperty.getProject());

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

@@ -107,7 +107,7 @@ public void performIntrospectionQueryAndUpdateSchemaPathFile(Project project, Gr
                 return;
             }
 
-            performIntrospectionQueryAndUpdateSchemaPathFile(new GraphQLConfigVariableAwareEndpoint(endpoint, project), schemaPath, configFile);
+            performIntrospectionQueryAndUpdateSchemaPathFile(new GraphQLConfigVariableAwareEndpoint(endpoint, project, configFile), schemaPath, configFile);
         }
 
     }

src/main/com/intellij/lang/jsgraphql/ide/project/graphqlconfig/model/GraphQLConfigVariableAwareEndpoint.java

@@ -13,9 +13,11 @@
 import com.intellij.notification.Notifications;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.ui.DialogWrapper;
+import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.ui.components.JBLabel;
 import com.intellij.ui.components.JBTextField;
 import com.intellij.util.ui.FormBuilder;
+import io.github.cdimascio.dotenv.Dotenv;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -36,10 +38,12 @@ public class GraphQLConfigVariableAwareEndpoint {
 
     private final GraphQLConfigEndpoint endpoint;
     private final Project project;
+    private final VirtualFile configFile;
 
-    public GraphQLConfigVariableAwareEndpoint(GraphQLConfigEndpoint endpoint, Project project) {
+    public GraphQLConfigVariableAwareEndpoint(GraphQLConfigEndpoint endpoint, Project project, VirtualFile configFile) {
         this.endpoint = endpoint;
         this.project = project;
+        this.configFile = configFile;
     }
 
     public String getName() {
@@ -95,7 +99,16 @@ public String expandVariables(String rawValue) {
                 Notifications.Bus.notify(new Notification("GraphQL", "Unsupported variable source", "Supported variables sources are 'env', but got: " + varSource, NotificationType.ERROR));
                 continue;
             }
+
+            // Try to load the variable from the system
             String varValue = GET_ENV_VAR.apply(varName);
+
+            // If the variable wasn't found in the system try to see if the user has a .env file with the variable
+            if (varValue == null || varValue.trim().isEmpty()) {
+                varValue = tryToGetVariableFromDotEnvFile(varName, varValue);
+            }
+
+            // If it still wasn't found present the user with a dialog to enter the variable
             if (varValue == null || varValue.trim().isEmpty()) {
                 final VariableDialog dialog = new VariableDialog(project, varName);
                 if (dialog.showAndGet()) {
@@ -104,12 +117,47 @@ public String expandVariables(String rawValue) {
                     continue;
                 }
             }
+
             matcher.appendReplacement(sb, varValue);
         }
         matcher.appendTail(sb);
         return sb.toString();
     }
 
+    @Nullable
+    private String tryToGetVariableFromDotEnvFile(String varName, String varValue) {
+        Dotenv dotenv;
+
+        // Let's try to load the env file closest to the config file first
+        if (configFile != null) {
+            VirtualFile parentDir = configFile.getParent();
+            if (parentDir != null) {
+                dotenv = Dotenv
+                    .configure()
+                    .directory(parentDir.getPath())
+                    .ignoreIfMalformed()
+                    .ignoreIfMissing()
+                    .load();
+
+                varValue = dotenv.get(varName);
+            }
+        }
+
+        // If that didn't resolve try to load the env file from the root of the project
+        String projectBasePath = project.getBasePath();
+        if (varValue == null && projectBasePath != null) {
+            dotenv = Dotenv
+                .configure()
+                .directory(projectBasePath)
+                .ignoreIfMalformed()
+                .ignoreIfMissing()
+                .load();
+
+            varValue = dotenv.get(varName);
+        }
+        return varValue;
+    }
+
     static class VariableDialog extends DialogWrapper {
 
         private static Map<String, String> previousVariables = Maps.newHashMap();

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

@@ -340,7 +340,7 @@ public void executeGraphQL(Editor editor, VirtualFile virtualFile) {
         if (endpointsModel != null) {
             final GraphQLConfigEndpoint selectedEndpoint = endpointsModel.getSelectedItem();
             if (selectedEndpoint != null && selectedEndpoint.url != null) {
-                final GraphQLConfigVariableAwareEndpoint endpoint = new GraphQLConfigVariableAwareEndpoint(selectedEndpoint, myProject);
+                final GraphQLConfigVariableAwareEndpoint endpoint = new GraphQLConfigVariableAwareEndpoint(selectedEndpoint, myProject, virtualFile);
                 final JSGraphQLQueryContext context = JSGraphQLQueryContextHighlightVisitor.getQueryContextBufferAndHighlightUnused(editor);
 
                 Map<String, Object> requestData = new HashMap<>();

src/test/com/intellij/lang/jsgraphql/ide/project/graphqlconfig/model/GraphQLConfigVariableAwareEndpointTest.java

@@ -26,7 +26,7 @@ public class GraphQLConfigVariableAwareEndpointTest {
     public void getExpandedVariables() {
 
         GraphQLConfigEndpoint endpoint = new GraphQLConfigEndpoint(null, "", "http://localhost/");
-        GraphQLConfigVariableAwareEndpoint variableAwareEndpoint = new GraphQLConfigVariableAwareEndpoint(endpoint, PROJECT);
+        GraphQLConfigVariableAwareEndpoint variableAwareEndpoint = new GraphQLConfigVariableAwareEndpoint(endpoint, PROJECT, null);
 
         // setup env var resolver
         variableAwareEndpoint.GET_ENV_VAR = name -> name + "-value";
@@ -62,4 +62,4 @@ public void getExpandedVariables() {
 
     }
 
-}
+}