chore(server) - Update how we determine what a CloudFormation template is (#250)

* Update how we determine what a cfn template is
* Support json for hover

Author: kddejong

server/src/handlers/helpers.ts

@@ -1,36 +1,3 @@
-import { Connection } from "vscode-languageserver";
-
-export function isCloudFormation(
-  template: string,
-  filename: string,
-  cfnConnection: Connection
-): Boolean {
-  if (/"?AWSTemplateFormatVersion"?\s*/.exec(template)) {
-    cfnConnection.console.log(
-      "Determined this file is a CloudFormation Template. " +
-        filename +
-        ". Found the string AWSTemplateFormatVersion"
-    );
-    return true;
-  }
-  if (/\n?"?Resources"?\s*:/.exec(template)) {
-    if (
-      /"?Type"?\s*:\s*"?'?[a-zA-Z0-9]{2,64}::[a-zA-Z0-9]{2,64}/.exec(template)
-    ) {
-      // filter out serverless.io templates
-      if (!(/\nresources:/.exec(template) && /\nprovider:/.exec(template))) {
-        cfnConnection.console.log(
-          "Determined this file is a CloudFormation Template. " +
-            filename +
-            ". Found 'Resources' and 'Type: [a-zA-Z0-9]{2,64}::[a-zA-Z0-9]{2,64}'"
-        );
-        return true;
-      }
-    }
-  }
-  return false;
-}
-
 export function isYaml(filename: string): Boolean {
   if (filename.endsWith(".yaml") || filename.endsWith(".yml")) {
     return true;

server/src/handlers/languageHandlers.ts

@@ -30,6 +30,7 @@ import {
   PropertyASTNodeImpl,
   StringASTNodeImpl,
 } from "yaml-language-server/out/server/src/languageservice/parser/jsonParser07";
+import { MarkdownString } from "../utils/markdownString";
 
 // code adopted from https://github.com/redhat-developer/yaml-language-server/blob/main/src/languageserver/handlers/languageHandlers.ts
 export class LanguageHandlers extends YamlLanguageHandlers {
@@ -187,16 +188,24 @@ export class LanguageHandlers extends YamlLanguageHandlers {
       return Promise.resolve(undefined);
     }
 
-    const results = await this.cfnLanguageService.doHover(
+    let hover: Hover = {
+      contents: new MarkdownString().toMarkupContent(),
+    };
+
+    let results = await this.cfnLanguageService.doHover(
       document,
       textDocumentPositionParams.position
     );
 
+    if (results !== null) {
+      hover = results;
+    }
+
     let [node, template] = getNode(document, textDocumentPositionParams);
 
     function updateHover(map: CfnType, nodeValue: string) {
       if (map.has(nodeValue)) {
-        results.contents = map.getKeyMarkupContent(nodeValue);
+        hover.contents = map.getKeyMarkupContent(nodeValue);
       }
     }
 
@@ -224,6 +233,6 @@ export class LanguageHandlers extends YamlLanguageHandlers {
       console.debug(error);
     }
 
-    return results;
+    return hover;
   }
 }

server/src/handlers/validationHandler.ts

@@ -23,7 +23,7 @@ import { CfnLint } from "../services/cfnlint";
 import { Diagnostic } from "vscode-languageserver-types";
 import { LanguageService } from "yaml-language-server";
 import { ValidationHandler as YamlValidationHandler } from "yaml-language-server/out/server/src/languageserver/handlers/validationHandlers";
-import { isCloudFormation } from "./helpers";
+import { getNode } from "../utils/cfnParser";
 
 // code adopted from https://github.com/redhat-developer/yaml-language-server/blob/main/src/languageserver/handlers/validationHandlers.ts
 export class ValidationHandler extends YamlValidationHandler {
@@ -115,18 +115,23 @@ export class ValidationHandler extends YamlValidationHandler {
 
     let fileToLint = URI.parse(uri).fsPath;
 
-    let isCfn = isCloudFormation(
-      document.getText(),
-      uri.toString(),
-      this.cfnConnection
-    );
+    let [_, template] = getNode(document, {
+      textDocument: document,
+      position: {
+        line: 0,
+        character: 0,
+      },
+    });
 
-    this.cfnConnection.sendNotification("cfn/isPreviewable", isCfn);
+    this.cfnConnection.sendNotification(
+      "cfn/isPreviewable",
+      template.isValidTemplate
+    );
 
     let buildGraph = this.cfnSettings.isPreviewing[uri];
 
     return new Promise<Diagnostic[]>((resolve, reject) => {
-      if (isCfn) {
+      if (template.isValidTemplate) {
         if (
           this.cfnSettings.cfnLintPath.includes(" --registry-schemas ") ||
           this.cfnSettings.cfnLintPath.includes(" -s ")

server/src/utils/cfnParser.ts

@@ -37,6 +37,8 @@ export class CfnType extends Map<string, TypeInfo> {
 }
 
 export interface CfnTypes {
+  isValidTemplate: boolean; // stores if this a CFN template
+  formatVersion: string | undefined;
   parameters: CfnType;
   resources: CfnType;
 }
@@ -58,6 +60,8 @@ export function getNode(
   position: TextDocumentPositionParams
 ): [ASTNode, CfnTypes] | null {
   let cfnTypes: CfnTypes = {
+    isValidTemplate: false,
+    formatVersion: undefined,
     parameters: new CfnType("Parameter"),
     resources: new CfnType("Resource"),
   };
@@ -79,6 +83,12 @@ export function getNode(
           if (visit.valueNode instanceof ObjectASTNodeImpl) {
             filteredSections.set(visit.keyNode.value, visit.valueNode);
           }
+        } else if (
+          ["AWSTemplateFormatVersion"].indexOf(visit.keyNode.value) > -1
+        ) {
+          if (visit.valueNode instanceof StringASTNodeImpl) {
+            cfnTypes.formatVersion = visit.valueNode.value;
+          }
         }
       });
     }
@@ -101,6 +111,10 @@ export function getNode(
         }
       });
     }
+
+    if (cfnTypes.resources.size > 0 || cfnTypes.formatVersion !== undefined) {
+      cfnTypes.isValidTemplate = true;
+    }
     return [currentDoc.getNodeFromOffset(offset), cfnTypes];
   } catch (error) {
     console.debug(error);