Fix inferred operation name issue with trailing spaces #960

Author: Huachao

README.md

@@ -9,7 +9,7 @@ REST Client allows you to send HTTP request and view the response in Visual Stud
 * Send __GraphQL query__ and author __GraphQL variables__ in editor
 * Send __cURL command__ in editor and copy HTTP request as `cURL command`
 * Auto save and view/clear request history
-* Organize _MULTIPLE_ requests in the same file (separated by `###` delimiter)
+* Compose _MULTIPLE_ requests in a single file (separated by `###` delimiter)
 * View image response directly in pane
 * Save raw response and response body only to local disk
 * Fold and unfold response body

package-lock.json

@@ -70,6 +70,4 @@ export const RequestVariableDefinitionWithNameRegexFactory = (name: string, flag
 
 export const RequestVariableDefinitionRegex: RegExp = RequestVariableDefinitionWithNameRegexFactory("\\w+", "m");
 
-export const NoteCommentRegex = /^\s*(?:#{1,}|\/{2,})\s*@note\s*$/m;
-
 export const LineSplitterRegex: RegExp = /\r?\n/g;

src/common/constants.ts

@@ -2,6 +2,7 @@ import { EOL } from 'os';
 import * as url from 'url';
 import { Clipboard, env, ExtensionContext, QuickInputButtons, window } from 'vscode';
 import Logger from '../logger';
+import { IRestClientSettings, RequestSettings, RestClientSettings } from '../models/configurationSettings';
 import { HARCookie, HARHeader, HARHttpRequest, HARPostData } from '../models/harHttpRequest';
 import { HttpRequest } from '../models/httpRequest';
 import { RequestParserFactory } from '../models/requestParserFactory';
@@ -50,10 +51,12 @@ export class CodeSnippetController {
             return;
         }
 
-        const { text } = selectedRequest;
+        const { text, metadatas } = selectedRequest;
+        const requestSettings = new RequestSettings(metadatas);
+        const settings: IRestClientSettings = new RestClientSettings(requestSettings);
 
         // parse http request
-        const httpRequest = await RequestParserFactory.createRequestParser(text).parseHttpRequest();
+        const httpRequest = await RequestParserFactory.createRequestParser(text, settings).parseHttpRequest();
 
         const harHttpRequest = this.convertToHARHttpRequest(httpRequest);
         const snippet = new HTTPSnippet(harHttpRequest);
@@ -119,10 +122,12 @@ export class CodeSnippetController {
             return;
         }
 
-        const { text } = selectedRequest;
+        const { text, metadatas } = selectedRequest;
+        const requestSettings = new RequestSettings(metadatas);
+        const settings: IRestClientSettings = new RestClientSettings(requestSettings);
 
         // parse http request
-        const httpRequest = await RequestParserFactory.createRequestParser(text).parseHttpRequest();
+        const httpRequest = await RequestParserFactory.createRequestParser(text, settings).parseHttpRequest();
 
         const harHttpRequest = this.convertToHARHttpRequest(httpRequest);
         const addPrefix = !(url.parse(harHttpRequest.url).protocol);

src/controllers/codeSnippetController.ts

@@ -1,6 +1,6 @@
 import { ExtensionContext, Range, TextDocument, ViewColumn, window } from 'vscode';
 import Logger from '../logger';
-import { IRestClientSettings, RequestSettings, RestClientSettings, SystemSettings } from '../models/configurationSettings';
+import { IRestClientSettings, RequestSettings, RestClientSettings } from '../models/configurationSettings';
 import { HistoricalHttpRequest, HttpRequest } from '../models/httpRequest';
 import { RequestMetadata } from '../models/requestMetadata';
 import { RequestParserFactory } from '../models/requestParserFactory';
@@ -19,7 +19,7 @@ export class RequestController {
     private _httpClient: HttpClient;
     private _webview: HttpResponseWebview;
     private _textDocumentView: HttpResponseTextDocumentView;
-    private _lastRequest?: HttpRequest;
+    private _lastRequestSettingTuple: [HttpRequest, IRestClientSettings];
     private _lastPendingRequest?: HttpRequest;
 
     public constructor(context: ExtensionContext) {
@@ -58,19 +58,21 @@ export class RequestController {
         const settings: IRestClientSettings = new RestClientSettings(requestSettings);
 
         // parse http request
-        const httpRequest = await RequestParserFactory.createRequestParser(text).parseHttpRequest(name);
+        const httpRequest = await RequestParserFactory.createRequestParser(text, settings).parseHttpRequest(name);
 
         await this.runCore(httpRequest, settings, document);
     }
 
     @trace('Rerun Request')
     public async rerun() {
-        if (!this._lastRequest) {
+        if (!this._lastRequestSettingTuple) {
             return;
         }
 
+        let [request, settings] = this._lastRequestSettingTuple;
+
         // TODO: recover from last request settings
-        await this.runCore(this._lastRequest, SystemSettings.Instance);
+        await this.runCore(request, settings);
     }
 
     @trace('Cancel Request')
@@ -85,7 +87,8 @@ export class RequestController {
         this._requestStatusEntry.update({ state: RequestState.Pending });
 
         // set last request and last pending request
-        this._lastPendingRequest = this._lastRequest = httpRequest;
+        this._lastPendingRequest = httpRequest;
+        this._lastRequestSettingTuple = [httpRequest, settings];
 
         // set http request
         try {

src/controllers/requestController.ts

@@ -1,18 +1,20 @@
 import { CurlRequestParser } from '../utils/curlRequestParser';
 import { HttpRequestParser } from '../utils/httpRequestParser';
-import { SystemSettings } from './configurationSettings';
+import { IRestClientSettings, SystemSettings } from './configurationSettings';
 import { RequestParser } from './requestParser';
 
 export class RequestParserFactory {
 
     private static readonly curlRegex: RegExp = /^\s*curl/i;
-    private static readonly restClientSettings = SystemSettings.Instance;
 
-    public static createRequestParser(rawHttpRequest: string): RequestParser {
+    public static createRequestParser(rawRequest: string): RequestParser
+    public static createRequestParser(rawRequest: string, settings: IRestClientSettings): RequestParser
+    public static createRequestParser(rawHttpRequest: string, settings?: IRestClientSettings): RequestParser {
+        settings = settings || SystemSettings.Instance;
         if (RequestParserFactory.curlRegex.test(rawHttpRequest)) {
-            return new CurlRequestParser(rawHttpRequest, this.restClientSettings);
+            return new CurlRequestParser(rawHttpRequest, settings);
         } else {
-            return new HttpRequestParser(rawHttpRequest, this.restClientSettings);
+            return new HttpRequestParser(rawHttpRequest, settings);
         }
     }
 }

src/models/requestParserFactory.ts

@@ -1,6 +1,6 @@
 import * as fs from 'fs-extra';
 import { RequestHeaders } from '../models/base';
-import { SystemSettings } from '../models/configurationSettings';
+import { IRestClientSettings } from '../models/configurationSettings';
 import { HttpRequest } from '../models/httpRequest';
 import { RequestParser } from '../models/requestParser';
 import { base64, hasHeader } from './misc';
@@ -12,7 +12,7 @@ const DefaultContentType: string = 'application/x-www-form-urlencoded';
 
 export class CurlRequestParser implements RequestParser {
 
-    public constructor(private readonly requestRawText: string, private readonly settings: SystemSettings) {
+    public constructor(private readonly requestRawText: string, private readonly settings: IRestClientSettings) {
     }
 
     public async parseHttpRequest(name?: string): Promise<HttpRequest> {

src/utils/curlRequestParser.ts

@@ -1,7 +1,7 @@
 import * as fs from 'fs-extra';
 import { EOL } from 'os';
 import { Stream } from 'stream';
-import { SystemSettings } from '../models/configurationSettings';
+import { IRestClientSettings } from '../models/configurationSettings';
 import { FormParamEncodingStrategy } from '../models/formParamEncodingStrategy';
 import { HttpRequest } from '../models/httpRequest';
 import { RequestParser } from '../models/requestParser';
@@ -26,7 +26,7 @@ export class HttpRequestParser implements RequestParser {
     private readonly inputFileSyntax = /^<(?:(?<processVariables>@)(?<encoding>\w+)?)?\s+(?<filepath>.+?)\s*$/;
     private readonly defaultFileEncoding = 'utf8';
 
-    public constructor(private readonly requestRawText: string, private readonly settings: SystemSettings) {
+    public constructor(private readonly requestRawText: string, private readonly settings: IRestClientSettings) {
     }
 
     public async parseHttpRequest(name?: string): Promise<HttpRequest> {
@@ -135,7 +135,7 @@ export class HttpRequestParser implements RequestParser {
             body = await convertStreamToString(body);
         }
 
-        const matched = body?.match(/^\s*query\s+([^@\{\(]+)/i);
+        const matched = body?.match(/^\s*query\s+([^@\{\(\s]+)/i);
         const operationName = matched?.[1];
 
         const graphQlPayload = {