fix: remove problematic file resolution module from webpack sco… (#1489)

* remove problematic file resolution module from webpack scope * resolve webpack dev build issue * moves parser types around in a way that prevents graphql-config modules from resolving in a funky way during webpack dev builds?
graphql · Apr 12, 2020 · 8dab038 · 8dab038
1 parent f19aa0d
commit 8dab038
Show file tree

Hide file tree

Showing 18 changed files with 176 additions and 452 deletions.
diff --git a/packages/graphiql/resources/webpack.config.js b/packages/graphiql/resources/webpack.config.js
@@ -14,14 +14,7 @@ const rootPath = (...args) => relPath('../', ...args);
 
 const resultConfig = {
   mode: process.env.NODE_ENV,
-  entry: isHMR
-    ? [
-        'react-hot-loader/patch', // activate HMR for React
-        'webpack-dev-server/client?http://localhost:8080', // bundle the client for webpack-dev-server and connect to the provided endpoint
-        'webpack/hot/only-dev-server', // bundle the client for hot reloading, only- means to only hot reload for successful updates
-        './cdn.ts', // the entry point of our app
-      ]
-    : './cdn.ts',
+  entry: './cdn.ts',
   context: rootPath('src'),
   output: {
     path: rootPath(),

diff --git a/packages/graphql-language-service-interface/src/GraphQLLanguageService.ts b/packages/graphql-language-service-interface/src/GraphQLLanguageService.ts
@@ -20,11 +20,11 @@ import {
   CompletionItem,
   DefinitionQueryResult,
   Diagnostic,
-  GraphQLCache,
   Uri,
   Position,
   Outline,
   OutlineTree,
+  GraphQLCache,
 } from 'graphql-language-service-types';
 
 import { GraphQLConfig, GraphQLProjectConfig } from 'graphql-config';
@@ -46,11 +46,7 @@ import {
 
 import { getOutline } from './getOutline';
 
-import {
-  getASTNodeAtPosition,
-  requireFile,
-  resolveFile,
-} from 'graphql-language-service-utils';
+import { getASTNodeAtPosition } from 'graphql-language-service-utils';
 
 const {
   FRAGMENT_DEFINITION,
@@ -197,19 +193,11 @@ export class GraphQLLanguageService {
     }
 
     // Check if there are custom validation rules to be used
-    let customRules;
-    const customRulesModulePath = extensions.customValidationRules;
-    if (customRulesModulePath) {
-      /* eslint-disable no-implicit-coercion */
-      const rulesPath = resolveFile(customRulesModulePath);
-      if (rulesPath) {
-        const customValidationRules: (
-          config: GraphQLConfig,
-        ) => ValidationRule[] = await requireFile(rulesPath);
-        if (customValidationRules) {
-          customRules = customValidationRules(this._graphQLConfig);
-        }
-      }
+    let customRules: ValidationRule[] | null = null;
+    const customValidationRules = extensions.customValidationRules;
+    if (customValidationRules) {
+      customRules = customValidationRules(this._graphQLConfig);
+
       /* eslint-enable no-implicit-coercion */
     }
     const schema = await this._graphQLCache.getSchema(
@@ -221,7 +209,12 @@ export class GraphQLLanguageService {
       return [];
     }
 
-    return validateQuery(validationAst, schema, customRules, isRelayCompatMode);
+    return validateQuery(
+      validationAst,
+      schema,
+      customRules as ValidationRule[],
+      isRelayCompatMode,
+    );
   }
 
   public async getAutocompleteSuggestions(

diff --git a/packages/graphql-language-service-interface/src/autocompleteUtils.ts b/packages/graphql-language-service-interface/src/autocompleteUtils.ts
@@ -16,11 +16,11 @@ import {
 } from 'graphql/type/introspection';
 import {
   CompletionItemBase,
-  ContextTokenUnion,
-  State,
   AllTypeInfo,
 } from 'graphql-language-service-types';
 
+import { ContextTokenUnion, State } from 'graphql-language-service-parser';
+
 // Utility for returning the state representing the Definition this token state
 // is within, if any.
 export function getDefinitionState(

diff --git a/packages/graphql-language-service-interface/src/getAutocompleteSuggestions.ts b/packages/graphql-language-service-interface/src/getAutocompleteSuggestions.ts
@@ -26,8 +26,6 @@ import {
   State,
   AllTypeInfo,
   Position,
-  RuleKind,
-  RuleKinds,
 } from 'graphql-language-service-types';
 
 import {
@@ -47,7 +45,12 @@ import {
   isInputType,
 } from 'graphql';
 
-import { CharacterStream, onlineParser } from 'graphql-language-service-parser';
+import {
+  CharacterStream,
+  onlineParser,
+  RuleKind,
+  RuleKinds,
+} from 'graphql-language-service-parser';
 
 import {
   forEachState,

diff --git a/packages/graphql-language-service-interface/src/getDiagnostics.ts b/packages/graphql-language-service-interface/src/getDiagnostics.ts
@@ -64,7 +64,7 @@ export function getDiagnostics(
 export function validateQuery(
   ast: DocumentNode,
   schema: GraphQLSchema | null | undefined = null,
-  customRules?: Array<ValidationRule>,
+  customRules?: Array<ValidationRule> | null,
   isRelayCompatMode?: boolean,
 ): Array<Diagnostic> {
   // We cannot validate the query unless a schema is provided.

diff --git a/packages/graphql-language-service-interface/src/getHoverInformation.ts b/packages/graphql-language-service-interface/src/getHoverInformation.ts
@@ -20,11 +20,8 @@ import {
   GraphQLField,
   GraphQLFieldConfig,
 } from 'graphql';
-import {
-  ContextToken,
-  AllTypeInfo,
-  Position,
-} from 'graphql-language-service-types';
+import { ContextToken } from 'graphql-language-service-parser';
+import { AllTypeInfo, Position } from 'graphql-language-service-types';
 
 import { Hover } from 'vscode-languageserver-types';
 import { getTokenAtPosition, getTypeInfo } from './getAutocompleteSuggestions';

diff --git a/packages/graphql-language-service-parser/src/CharacterStream.ts b/packages/graphql-language-service-parser/src/CharacterStream.ts
@@ -17,11 +17,7 @@
  *        is supplied.
  *
  */
-
-import {
-  TokenPattern,
-  CharacterStreamInterface,
-} from 'graphql-language-service-types';
+import { TokenPattern, CharacterStreamInterface } from './types';
 
 export default class CharacterStream implements CharacterStreamInterface {
   _start: number;

diff --git a/packages/graphql-language-service-parser/src/RuleHelpers.ts b/packages/graphql-language-service-parser/src/RuleHelpers.ts
@@ -9,7 +9,7 @@
 
 // These functions help build matching rules for ParseRules.
 
-import { Rule, Token } from 'graphql-language-service-types';
+import { Rule, Token } from './types';
 
 // An optional rule.
 export function opt(ofRule: Rule | string): Rule {

diff --git a/packages/graphql-language-service-parser/src/Rules.ts b/packages/graphql-language-service-parser/src/Rules.ts
@@ -7,14 +7,8 @@
  *
  */
 
-import {
-  CharacterStreamInterface as CharacterStream,
-  State,
-  Token,
-  Rule,
-  RuleKind,
-  ParseRule,
-} from 'graphql-language-service-types';
+import { State, Token, Rule, RuleKind, ParseRule } from './types';
+import CharacterStream from './CharacterStream';
 import { opt, list, butNot, t, p } from './RuleHelpers';
 
 /**

diff --git a/packages/graphql-language-service-parser/src/index.ts b/packages/graphql-language-service-parser/src/index.ts
@@ -14,3 +14,5 @@ export { LexRules, ParseRules, isIgnored } from './Rules';
 export { butNot, list, opt, p, t } from './RuleHelpers';
 
 export { default as onlineParser } from './onlineParser';
+
+export * from './types';
diff --git a/packages/graphql-language-service-parser/src/onlineParser.ts b/packages/graphql-language-service-parser/src/onlineParser.ts
@@ -31,13 +31,8 @@ import {
   LexRules as LexRulesType,
   ParseRules as ParseRulesType,
 } from './Rules';
-import {
-  CharacterStreamInterface as CharacterStream,
-  State,
-  Token,
-  Rule,
-  RuleKind,
-} from 'graphql-language-service-types';
+import CharacterStream from './CharacterStream';
+import { State, Token, Rule, RuleKind } from './types';
 
 import { LexRules, ParseRules, isIgnored } from './Rules';
 

diff --git a/packages/graphql-language-service-parser/src/types.ts b/packages/graphql-language-service-parser/src/types.ts
@@ -0,0 +1,138 @@
+import { Kind } from 'graphql';
+import { _Kind } from 'graphql/language/kinds';
+import { Maybe } from 'graphql-language-service-types';
+import CharacterStream from './CharacterStream';
+
+export type ContextToken = {
+  start: number;
+  end: number;
+  string: string;
+  state: State;
+  style: string;
+};
+
+export type ContextTokenForCodeMirror = {
+  start: number;
+  end: number;
+  string: string;
+  type: string | null;
+  state: State;
+};
+
+export type ContextTokenUnion = ContextToken | ContextTokenForCodeMirror;
+
+export type RuleOrString = Rule | string;
+
+export type ParseRule =
+  | RuleOrString[]
+  | ((token: Token, stream: CharacterStream) => string | null | void);
+
+export type Token = {
+  kind: string;
+  value: string;
+};
+
+export type Rule = {
+  style?: string;
+  match?: (token: Token) => boolean;
+  update?: (state: State, token: Token) => void;
+  separator?: string | Rule;
+  isList?: boolean;
+  ofRule?: Rule | string;
+};
+
+export type State = {
+  level: number;
+  levels?: number[];
+  prevState: Maybe<State>;
+  rule: Maybe<ParseRule>;
+  kind: Maybe<RuleKind>;
+  name: Maybe<string>;
+  type: Maybe<string>;
+  step: number;
+  needsSeperator: boolean;
+  needsAdvance?: boolean;
+  indentLevel?: number;
+};
+
+export const AdditionalRuleKinds: _AdditionalRuleKinds = {
+  ALIASED_FIELD: 'AliasedField',
+  ARGUMENTS: 'Arguments',
+  SHORT_QUERY: 'ShortQuery',
+  QUERY: 'Query',
+  MUTATION: 'Mutation',
+  SUBSCRIPTION: 'Subscription',
+  TYPE_CONDITION: 'TypeCondition',
+  INVALID: 'Invalid',
+  COMMENT: 'Comment',
+  SCHEMA_DEF: 'SchemaDef',
+  SCALAR_DEF: 'ScalarDef',
+  OBJECT_TYPE_DEF: 'ObjectTypeDef',
+  INTERFACE_DEF: 'InterfaceDef',
+  UNION_DEF: 'UnionDef',
+  ENUM_DEF: 'EnumDef',
+  FIELD_DEF: 'FieldDef',
+  INPUT_DEF: 'InputDef',
+  INPUT_VALUE_DEF: 'InputValueDef',
+  ARGUMENTS_DEF: 'ArgumentsDef',
+  EXTEND_DEF: 'ExtendDef',
+  DIRECTIVE_DEF: 'DirectiveDef',
+};
+
+export type _AdditionalRuleKinds = {
+  ALIASED_FIELD: 'AliasedField';
+  ARGUMENTS: 'Arguments';
+  SHORT_QUERY: 'ShortQuery';
+  QUERY: 'Query';
+  MUTATION: 'Mutation';
+  SUBSCRIPTION: 'Subscription';
+  TYPE_CONDITION: 'TypeCondition';
+  INVALID: 'Invalid';
+  COMMENT: 'Comment';
+  SCHEMA_DEF: 'SchemaDef';
+  SCALAR_DEF: 'ScalarDef';
+  OBJECT_TYPE_DEF: 'ObjectTypeDef';
+  INTERFACE_DEF: 'InterfaceDef';
+  UNION_DEF: 'UnionDef';
+  ENUM_DEF: 'EnumDef';
+  FIELD_DEF: 'FieldDef';
+  INPUT_DEF: 'InputDef';
+  INPUT_VALUE_DEF: 'InputValueDef';
+  ARGUMENTS_DEF: 'ArgumentsDef';
+  EXTEND_DEF: 'ExtendDef';
+  DIRECTIVE_DEF: 'DirectiveDef';
+};
+
+export const RuleKinds = {
+  ...Kind,
+  ...AdditionalRuleKinds,
+};
+
+export type _RuleKinds = _Kind & typeof AdditionalRuleKinds;
+
+export type RuleKind = _RuleKinds[keyof _RuleKinds];
+export type RuleKindEnum = RuleKind;
+export type TokenPattern = string | ((char: string) => boolean) | RegExp;
+
+export interface CharacterStreamInterface {
+  getStartOfToken: () => number;
+  getCurrentPosition: () => number;
+  eol: () => boolean;
+  sol: () => boolean;
+  peek: () => string | null;
+  next: () => string;
+  eat: (pattern: TokenPattern) => string | undefined;
+  eatWhile: (match: TokenPattern) => boolean;
+  eatSpace: () => boolean;
+  skipToEnd: () => void;
+  skipTo: (position: number) => void;
+  match: (
+    pattern: TokenPattern,
+    consume?: Maybe<boolean>,
+    caseFold?: Maybe<boolean>,
+  ) => string[] | boolean;
+  backUp: (num: number) => void;
+  column: () => number;
+  indentation: () => number;
+  current: () => string;
+}
diff --git a/packages/graphql-language-service-server/README.md b/packages/graphql-language-service-server/README.md
@@ -84,10 +84,10 @@ await startServer({
 });
 ```
 
-The graphql features we support are:
+The graphql-config features we support are:
 
-- `customDirectives` - `['@myExampleDirective']`
-- `customValidationRules` - returns rules array with parameter `ValidationContext` from `graphql/validation`;
+- `extensions.customDirectives` - for example `['@myExampleDirective']`
+- `extensions.customValidationRules` - a function that returns rules array with parameter `ValidationContext` from `graphql/validation`. The graphql config must load the module itself.
 
 ### Usage