[AT-10] Add helpful errors / messaging around config files

CHANGELOG.md

@@ -7,6 +7,13 @@
   - Improve client:check output [#934](https://github.com/apollographql/apollo-tooling/pull/934)
 - `apollo-language-server`
   - Replace checkOperations mutation with new validateOperations mutation [#934](https://github.com/apollographql/apollo-tooling/pull/934)
+  - Include config files into a project's fileSet [#897](https://github.com/apollographql/apollo-tooling/pull/897)
+  - Add hook into workspace for communicating out when configs are loaded or when errors are found [#897](https://github.com/apollographql/apollo-tooling/pull/897)
+  - Add fn to workspace for reloading a project with a given config URI [#897](https://github.com/apollographql/apollo-tooling/pull/897)
+  - Reload project when config file is changed [#897](https://github.com/apollographql/apollo-tooling/pull/897)
+  - Update error handling from within the server (send as message). This message can be listened for and handled by the consumer [#897](https://github.com/apollographql/apollo-tooling/pull/897)
+- `vscode-apollo`
+  - Update statusBar to reflect new possible "warning" states [#897](https://github.com/apollographql/apollo-tooling/pull/897)
 
 ## `[email protected]`
 

packages/apollo-language-server/src/config.ts

@@ -4,7 +4,6 @@ import TypeScriptLoader from "@endemolshinegroup/cosmiconfig-typescript-loader";
 import { resolve, dirname } from "path";
 import { readFileSync, existsSync } from "fs";
 import { merge } from "lodash/fp";
-
 import {
   ServiceID,
   ServiceSpecifier,
@@ -139,6 +138,8 @@ export interface LoadConfigSettings {
   // config loading only works on node so we default to
   // process.cwd()
   configPath?: string;
+  configFileName?: string;
+  requireConfig?: boolean;
   name?: string;
   type?: "service" | "client";
 }
@@ -273,18 +274,27 @@ const getServiceFromKey = (key: string | undefined): string | undefined => {
 // XXX load .env files automatically
 export const loadConfig = async ({
   configPath,
+  configFileName,
+  requireConfig = false,
   name,
   type
 }: LoadConfigSettings): Promise<ApolloConfig> => {
   const explorer = cosmiconfig(MODULE_NAME, {
-    searchPlaces: getSearchPlaces(configPath),
+    searchPlaces: getSearchPlaces(configFileName),
     loaders
   });
 
   let loadedConfig = (await explorer.search(configPath)) as ConfigResult<
     ApolloConfigFormat
   >;
 
+  if (requireConfig && !loadedConfig) {
+    throw new Error(
+      `No Apollo config found for project. For more information, please refer to:
+      https://bit.ly/2ByILPj`
+    );
+  }
+
   // add API to the env
   let engineConfig = {},
     nameFromKey;
@@ -328,7 +338,7 @@ export const loadConfig = async ({
     resolvedType = "service";
   } else {
     throw new Error(
-      "Unable to resolve project type. Please add either a client or service config. For more information, please refer to https://www.apollographql.com/docs/references/apollo-config.html"
+      "Unable to resolve project type. Please add either a client or service config. For more information, please refer to https://bit.ly/2ByILPj"
     );
   }
 
@@ -339,24 +349,24 @@ export const loadConfig = async ({
     loadedConfig = {
       isEmpty: false,
       filepath: configPath || process.cwd(),
-      config:
-        resolvedType === "client"
+      config: {
+        ...(loadedConfig && loadedConfig.config),
+        ...(resolvedType === "client"
           ? {
-              ...(loadedConfig ? loadedConfig.config : {}),
               client: {
                 ...DefaultConfigBase,
-                ...(loadedConfig ? loadedConfig.config.client : {}),
+                ...(loadedConfig && loadedConfig.config.client),
                 service: resolvedName
               }
             }
           : {
-              ...(loadedConfig ? loadedConfig.config : {}),
               service: {
                 ...DefaultConfigBase,
-                ...(loadedConfig ? loadedConfig.config.service : {}),
+                ...(loadedConfig && loadedConfig.config.service),
                 name: resolvedName
               }
-            }
+            })
+      }
     };
   }
 

packages/apollo-language-server/src/project/base.ts

@@ -143,6 +143,11 @@ export abstract class GraphQLProject implements GraphQLSchemaProvider {
     return this.readyPromise;
   }
 
+  public updateConfig(config: ApolloConfig) {
+    this.config = config;
+    return this.initialize();
+  }
+
   public resolveSchema(config: SchemaResolveConfig): Promise<GraphQLSchema> {
     this.lastLoadDate = +new Date();
     return this.schemaProvider.resolveSchema(config);

packages/apollo-language-server/src/project/client.ts

@@ -94,7 +94,7 @@ export class GraphQLClientProject extends GraphQLProject {
       // the URI of the folder _containing_ the apollo.config.js is the true project's root.
       // if a config doesn't have a uri associated, we can assume the `rootURI` is the project's root.
       rootURI: config.configDirURI || rootURI,
-      includes: config.client.includes,
+      includes: [...config.client.includes, ".env", "apollo.config.js"],
       excludes: config.client.excludes
     });
 

packages/apollo-language-server/src/project/service.ts

@@ -26,7 +26,7 @@ export class GraphQLServiceProject extends GraphQLProject {
   }: GraphQLServiceProjectConfig) {
     const fileSet = new FileSet({
       rootURI: config.configDirURI || rootURI,
-      includes: config.service.includes,
+      includes: [...config.service.includes, ".env", "apollo.config.js"],
       excludes: config.service.excludes
     });
 

packages/apollo-language-server/src/schema/providers/index.ts

@@ -49,5 +49,7 @@ export function schemaProviderFromConfig(
     }
   }
 
-  throw new Error("No provider was created for config");
+  throw new Error(
+    "No schema provider was created, because the project type was unable to be resolved from your config. Please add either a client or service config. For more information, please refer to https://bit.ly/2ByILPj"
+  );
 }

packages/apollo-language-server/src/server.ts

@@ -6,7 +6,8 @@ import {
   ProposedFeatures,
   TextDocuments,
   FileChangeType,
-  ServerCapabilities
+  ServerCapabilities,
+  WorkspaceFolder
 } from "vscode-languageserver";
 import { QuickPickItem } from "vscode";
 import { GraphQLWorkspace } from "./workspace";
@@ -17,6 +18,12 @@ const connection = createConnection(ProposedFeatures.all);
 
 let hasWorkspaceFolderCapability = false;
 
+// Awaitable promise for sending messages before the connection is initialized
+let initializeConnection: () => void;
+const whenConnectionInitialized: Promise<void> = new Promise(
+  resolve => (initializeConnection = resolve)
+);
+
 const workspace = new GraphQLWorkspace(
   new LanguageServerLoadingHandler(connection),
   {
@@ -43,13 +50,23 @@ workspace.onSchemaTags(params => {
   );
 });
 
-connection.onInitialize(async params => {
-  let capabilities = params.capabilities;
+workspace.onConfigFilesFound(async params => {
+  await whenConnectionInitialized;
+
+  connection.sendNotification(
+    "apollographql/configFilesFound",
+    params instanceof Error
+      ? // Can't stringify Errors, just results in "{}"
+        JSON.stringify({ message: params.message, stack: params.stack })
+      : JSON.stringify(params)
+  );
+});
+
+connection.onInitialize(async ({ capabilities, workspaceFolders }) => {
   hasWorkspaceFolderCapability = !!(
     capabilities.workspace && capabilities.workspace.workspaceFolders
   );
 
-  const workspaceFolders = params.workspaceFolders;
   if (workspaceFolders) {
     // We wait until all projects are added, because after `initialize` returns we can get additional requests
     // like `textDocument/codeLens`, and that way these can await `GraphQLProject#whenReady` to make sure
@@ -82,6 +99,7 @@ connection.onInitialize(async params => {
 });
 
 connection.onInitialized(async () => {
+  initializeConnection();
   if (hasWorkspaceFolderCapability) {
     connection.workspace.onDidChangeWorkspaceFolders(async event => {
       await Promise.all([
@@ -108,48 +126,25 @@ documents.onDidChangeContent(params => {
 });
 
 connection.onDidChangeWatchedFiles(params => {
-  for (const change of params.changes) {
-    const uri = change.uri;
-
-    // FIXME: Re-enable updating projects when config files change.
-
-    // const filePath = Uri.parse(change.uri).fsPath;
-    // if (
-    //   filePath.endsWith("apollo.config.js") ||
-    //   filePath.endsWith("package.json")
-    // ) {
-    //   const projectForConfig = Array.from(
-    //     workspace.projectsByFolderUri.values()
-    //   )
-    //     .flatMap(arr => arr)
-    //     .find(proj => {
-    //       return proj.configFile === filePath;
-    //     });
-
-    //   if (projectForConfig) {
-    //     const newConfig = findAndLoadConfig(
-    //       dirname(projectForConfig.configFile),
-    //       false,
-    //       true
-    //     );
-
-    //     if (newConfig) {
-    //       projectForConfig.updateConfig(newConfig);
-    //     }
-    //   }
-    // }
+  for (const { uri, type } of params.changes) {
+    if (
+      uri.endsWith("apollo.config.js") ||
+      uri.endsWith("package.json") ||
+      uri.endsWith(".env")
+    ) {
+      workspace.reloadProjectForConfig(uri);
+    }
 
     // Don't respond to changes in files that are currently open,
     // because we'll get content change notifications instead
-
-    if (change.type === FileChangeType.Changed) {
+    if (type === FileChangeType.Changed) {
       continue;
     }
 
     const project = workspace.projectForFile(uri);
     if (!project) continue;
 
-    switch (change.type) {
+    switch (type) {
       case FileChangeType.Created:
         project.fileDidChange(uri);
         break;