Validate too deep nested files (#680)

* Validate too deep nested files * Reduce number of tests and fix lint errors Co-authored-by: Bronley Plumb <bronley@gmail.com>
rokucommunity · Sep 1, 2022 · f99e014 · f99e014
1 parent e089eb7
commit f99e014
Show file tree

Hide file tree

Showing 5 changed files with 65 additions and 1 deletion.
diff --git a/src/DiagnosticMessages.ts b/src/DiagnosticMessages.ts
@@ -694,6 +694,11 @@ export let DiagnosticMessages = {
         message: `Unexpected statement found outside of function body`,
         code: 1133,
         severity: DiagnosticSeverity.Error
+    }),
+    detectedTooDeepFileSource: (numberOfParentDirectories: number) => ({
+        message: `Expected directory depth no larger than 7, but found ${numberOfParentDirectories}.`,
+        code: 1134,
+        severity: DiagnosticSeverity.Error
     })
 };
 

diff --git a/src/Scope.spec.ts b/src/Scope.spec.ts
@@ -277,6 +277,26 @@ describe('Scope', () => {
             ]);
         });
 
+        it('Validates NOT too deep nested files', () => {
+            program.setFile('source/folder2/folder3/folder4/folder5/folder6/folder7/main.brs', ``);
+            program.setFile('source/folder2/folder3/folder4/folder5/folder6/folder7/main2.bs', ``);
+            program.setFile('components/folder2/folder3/folder4/folder5/folder6/folder7/ButtonSecondary.xml', `<component name="ButtonSecondary" extends="ButtonBase" />`);
+            program.validate();
+            expectZeroDiagnostics(program);
+        });
+
+        it('Validates too deep nested files', () => {
+            program.setFile('source/folder2/folder3/folder4/folder5/folder6/folder7/folder8/main.brs', ``);
+            program.setFile('source/folder2/folder3/folder4/folder5/folder6/folder7/folder8/main2.bs', ``);
+            program.setFile('components/folder2/folder3/folder4/folder5/folder6/folder7/folder8/ButtonSecondary.xml', `<component name="ButtonSecondary" extends="ButtonBase" />`);
+            program.validate();
+            expectDiagnostics(program, [
+                DiagnosticMessages.detectedTooDeepFileSource(8),
+                DiagnosticMessages.detectedTooDeepFileSource(8),
+                DiagnosticMessages.detectedTooDeepFileSource(8)
+            ]);
+        });
+
         it('detects unknown namespace sub-names', () => {
             program.setFile('source/main.bs', `
                 sub main()

diff --git a/src/files/BrsFile.ts b/src/files/BrsFile.ts
@@ -362,6 +362,7 @@ export class BrsFile {
     }
 
     public validate() {
+        util.validateTooDeepFile(this);
         //only validate the file if it was actually parsed (skip files containing typedefs)
         if (!this.hasTypedef) {
             this.validateImportStatements();

diff --git a/src/files/XmlFile.ts b/src/files/XmlFile.ts
@@ -218,6 +218,7 @@ export class XmlFile {
 
 
     public validate() {
+        util.validateTooDeepFile(this);
         if (this.parser.ast.root) {
             this.validateComponent(this.parser.ast);
         } else {

diff --git a/src/util.ts b/src/util.ts
@@ -26,18 +26,32 @@ import type { DottedGetExpression, Expression, VariableExpression } from './pars
 import { Logger, LogLevel } from './Logger';
 import type { Identifier, Locatable, Token } from './lexer/Token';
 import { TokenKind } from './lexer/TokenKind';
-import { isCallExpression, isCallfuncExpression, isDottedGetExpression, isExpression, isIndexedGetExpression, isNamespacedVariableNameExpression, isVariableExpression, isXmlAttributeGetExpression } from './astUtils/reflection';
+import { isBrsFile, isCallExpression, isCallfuncExpression, isDottedGetExpression, isExpression, isIndexedGetExpression, isNamespacedVariableNameExpression, isVariableExpression, isXmlAttributeGetExpression, isXmlFile } from './astUtils/reflection';
 import { WalkMode } from './astUtils/visitors';
 import { CustomType } from './types/CustomType';
 import { SourceNode } from 'source-map';
 import type { SGAttribute } from './parser/SGTypes';
 import * as requireRelative from 'require-relative';
+import type { BrsFile } from './files/BrsFile';
+import type { XmlFile } from './files/XmlFile';
 
 export class Util {
     public clearConsole() {
         // process.stdout.write('\x1Bc');
     }
 
+    /**
+     * Returns the number of parent directories in the filPath
+     * @param filePath
+     */
+    public getParentDirectoryCount(filePath: string | undefined) {
+        if (!filePath) {
+            return -1;
+        } else {
+            return filePath.replace(/^pkg:/, '').split(/[\\\/]/).length - 1;
+        }
+    }
+
     /**
      * Determine if the file exists
      * @param filePath
@@ -1409,6 +1423,29 @@ export class Util {
     public rangeToString(range: Range) {
         return `${range?.start?.line}:${range?.start?.character}-${range?.end?.line}:${range?.end?.character}`;
     }
+
+    public validateTooDeepFile(file: (BrsFile | XmlFile)) {
+        //find any files nested too deep
+        let pkgPath = file.pkgPath ?? file.pkgPath.toString();
+        let rootFolder = pkgPath.replace(/^pkg:/, '').split(/[\\\/]/)[0].toLowerCase();
+
+        if (isBrsFile(file) && rootFolder !== 'source') {
+            return;
+        }
+
+        if (isXmlFile(file) && rootFolder !== 'components') {
+            return;
+        }
+
+        let fileDepth = this.getParentDirectoryCount(pkgPath);
+        if (fileDepth >= 8) {
+            file.addDiagnostics([{
+                ...DiagnosticMessages.detectedTooDeepFileSource(fileDepth),
+                file: file,
+                range: this.createRange(0, 0, 0, Number.MAX_VALUE)
+            }]);
+        }
+    }
 }
 
 /**