Merge pull request #199 from digma-ai/feature/code-object-id-parsers

noamkfir · web-flow · commit 1423868ff34c · 2022-10-13T16:29:16.000+03:00
Unify CodeObjectInfo objects and introduce CodeObjectIdParsers to fix language-specific code object id alias generation
diff --git a/src/services/codeObject.ts b/src/services/codeObject.ts
@@ -34,4 +34,62 @@ export class CodeObjectId {
         return spanCodeObjectId.substring(ix + this.codeObjectSeparator.length);
     }
 
-}
+}
+
+export interface CodeObjectInfo {
+	id: string;
+	get displayName(): string;
+    get ids(): string[];
+    get idsWithType(): string[];
+}
+
+export class EmptyCodeObjectInfo implements CodeObjectInfo {
+    id: string = '';
+    get displayName(): string {
+        return '';
+    }
+    get ids(): string[] {
+        return [this.id];
+    }
+    get idsWithType(): string[] {
+        return this.ids;
+    }
+}
+
+export class MinimalCodeObjectInfo implements CodeObjectInfo {
+    constructor(
+        public id: string,
+        private _displayName: string,
+    ) {
+    }
+    get displayName(): string {
+        return this._displayName;
+    }
+    get ids(): string[] {
+        return [this.id];
+    }
+    get idsWithType(): string[] {
+        return this.ids;
+    }
+}
+
+export interface ICodeObjectIdParser {
+    parse(codeObjectId: string): CodeObjectInfo;
+    generateAliases(codeObjectId: string): string[];
+}
+
+export class CommonCodeObjectIdParser implements ICodeObjectIdParser {
+    parse(codeObjectId: string): CodeObjectInfo {
+        const [path, method] = codeObjectId.split(CodeObjectId.codeObjectSeparator);
+        return new MinimalCodeObjectInfo(codeObjectId, method);
+    }
+
+    generateAliases(codeObjectId: string): string[] {
+        const folders = codeObjectId.split('/');
+        const aliases = [codeObjectId];
+        for (let i = 1; i < folders.length; i++) {
+            aliases.push(folders.slice(i, folders.length).join('/'));
+        }
+        return aliases;
+    }
+}
diff --git a/src/services/documentInfoProvider.ts b/src/services/documentInfoProvider.ts
@@ -5,7 +5,7 @@ import { Logger } from "./logger";
 import { SymbolProvider } from './languages/symbolProvider';
 import { Token, TokenType } from './languages/tokens';
 import { Dictionary, Future } from './utils';
-import { EndpointInfo, SpanLocationInfo as SpanLocationInfo, SymbolInfo, CodeObjectInfo, IParametersExtractor, CodeObjectLocationInfo } from './languages/extractors';
+import { EndpointInfo, SpanLocationInfo as SpanLocationInfo, SymbolInfo, IParametersExtractor, CodeObjectLocationInfo } from './languages/extractors';
 import { InstrumentationInfo } from './EditorHelper';
 import { SymbolInformation } from 'vscode';
 import { WorkspaceState } from '../state';
@@ -311,16 +311,15 @@ export class DocumentInfoProvider implements vscode.Disposable
         spans: SpanLocationInfo[],
         endpoints: EndpointInfo[],
     ): Promise<MethodInfo[]> {
+        const codeObjectIdParser = await this.symbolProvider.getCodeObjectIdParser(document);
+        if(!codeObjectIdParser) {
+            return [];
+        }
+
         let methods: MethodInfo[] = [];
 
         for(let symbol of symbols) {
-            var folders = symbol.id.split("/");
-            let aliases = [];
-            aliases.push(symbol.id);
-            for (let i=1;i<folders.length;i++){
-                aliases.push(folders.slice(i, folders.length).join("/"));
-
-            }
+            const aliases = codeObjectIdParser.generateAliases(symbol.id);
             const method = new MethodInfo(
                 symbol.id,
                 symbol.name,
diff --git a/src/services/languages/extractors.ts b/src/services/languages/extractors.ts
@@ -1,5 +1,6 @@
 import * as vscode from 'vscode';
 import { DocumentSymbol } from 'vscode-languageclient';
+import { CodeObjectInfo } from '../codeObject';
 import { DocumentInfoProvider, ParameterInfo } from '../documentInfoProvider';
 import { SymbolProvider, SymbolTree } from './symbolProvider';
 import { Token } from './tokens';
@@ -13,16 +14,9 @@ export interface SymbolInfo {
     documentUri: vscode.Uri;
 }
 
-export interface CodeObjectInfo {
-    id: string;
-    get ids(): string[];
-    get idsWithType(): string[];
-}
-
-export interface CodeObjectLocationInfo extends CodeObjectInfo{
+export interface CodeObjectLocationInfo extends CodeObjectInfo {
     range: vscode.Range;
     documentUri: vscode.Uri;
-
 }
 
 export class EndpointInfo implements CodeObjectLocationInfo {
@@ -31,13 +25,20 @@ export class EndpointInfo implements CodeObjectLocationInfo {
         public method: string,
         public path: string,
         public range: vscode.Range,
-        public documentUri: vscode.Uri) { }
-        get idsWithType() {
-            return ['endpoint:' + this.id];
-        }
-        get ids() {
-            return [ this.id];
-        }
+        public documentUri: vscode.Uri,
+    ) { }
+
+    get displayName(): string {
+        return this.method;
+    }
+
+    get idsWithType() {
+        return ['endpoint:' + this.id];
+    }
+
+    get ids() {
+        return [ this.id];
+    }
 }
 
 export class SpanLocationInfo implements CodeObjectLocationInfo {
@@ -47,7 +48,12 @@ export class SpanLocationInfo implements CodeObjectLocationInfo {
         public aliases: string[],
         public duplicates: SpanLocationInfo[],
         public range: vscode.Range,
-        public documentUri: vscode.Uri) { }
+        public documentUri: vscode.Uri,
+    ) { }
+
+    get displayName(): string {
+        return this.name;
+    }
 
     get idsWithType() {
         return this.ids.map(x=> 'span:' + x);
@@ -65,7 +71,7 @@ export interface IMethodExtractor {
     extractMethods(
         document: vscode.TextDocument,
         docSymbols: DocumentSymbol[],
-        tokens: Token []
+        tokens: Token [],
     ): Promise<SymbolInfo[]>;
 }
 
diff --git a/src/services/languages/javascript/codeObjectIdParser.ts b/src/services/languages/javascript/codeObjectIdParser.ts
@@ -0,0 +1,49 @@
+import { CodeObjectId, CodeObjectInfo, ICodeObjectIdParser } from './../../codeObject';
+
+export class JSCodeObjectInfo implements CodeObjectInfo {    
+    constructor(
+        public id: string,
+        public packageName: string,
+        public modulePath: string,
+        public symbol: string,
+    ) {
+    }
+
+    get displayName(): string {
+        return this.symbol || '';
+    }
+
+    get ids(): string[] {
+        return [this.id];
+    }
+
+    get idsWithType(): string[] {
+        return this.ids;
+    }
+}
+
+export class JSCodeObjectIdParser implements ICodeObjectIdParser {
+    parse(codeObjectId: string): JSCodeObjectInfo {
+        const pattern = /([\w\@/-]+):(.+)\$_\$(.*)/;
+        const matches = codeObjectId.match(pattern);
+        const [ , packageName, modulePath, symbol ] = matches ?? ['', '', '', ''];
+        return new JSCodeObjectInfo(
+            codeObjectId,
+            packageName,
+            modulePath,
+            symbol,
+        );
+    }
+
+    generateAliases(codeObjectId: string): string[] {
+        const objectPrefix = 'Object.';
+        const info: JSCodeObjectInfo = this.parse(codeObjectId);
+        const prefixedAliased = info.symbol.startsWith(objectPrefix)
+            ? info.symbol.substring(objectPrefix.length)
+            : `${objectPrefix}${info.symbol}`;
+        return [
+            codeObjectId,
+            `${info.packageName}:${info.modulePath}${CodeObjectId.codeObjectSeparator}${prefixedAliased}`,
+        ];
+    }
+}
diff --git a/src/services/languages/javascript/languageExtractor.ts b/src/services/languages/javascript/languageExtractor.ts
@@ -9,6 +9,8 @@ import { JSMethodExtractor } from './methodExtractor';
 import { JSSpanExtractor } from './spanExtractor';
 import { JSPackageReader } from './packageReader';
 import { JSPackageToUriConverter } from './modulePathToUriConverters';
+import { ICodeObjectIdParser } from '../../codeObject';
+import { JSCodeObjectIdParser } from './codeObjectIdParser';
 
 export class JSLanguageExtractor extends LanguageExtractor {
     private packageReader: JSPackageReader = new JSPackageReader();
@@ -44,4 +46,8 @@ export class JSLanguageExtractor extends LanguageExtractor {
             new JSPackageToUriConverter(packagesMap),
         ];
     }
+
+    public getCodeObjectIdParser(): ICodeObjectIdParser {
+        return new JSCodeObjectIdParser();
+    }
 }
diff --git a/src/services/languages/javascript/modulePathToUriConverters.ts b/src/services/languages/javascript/modulePathToUriConverters.ts
@@ -1,6 +1,7 @@
 import { dirname, join } from 'path';
 import * as vscode from 'vscode';
 import { IModulePathToUriConverter, ModulePathInfo } from '../modulePathToUriConverters';
+import { JSCodeObjectIdParser } from './codeObjectIdParser';
 
 export class JSPackageToUriConverter implements IModulePathToUriConverter {
 
@@ -26,30 +27,3 @@ export class JSPackageToUriConverter implements IModulePathToUriConverter {
         }
     }
 }
-
-interface JSCodeObjectInfo {
-    packageName: string
-    modulePath: string
-    symbol: string
-}
-
-class JSCodeObjectIdParser {
-    parse(codeObjectId: string): JSCodeObjectInfo {
-        const pattern = /([\w\@/-]+):(?:.)+\$_\$(?:.)*/;
-        const matches = codeObjectId.match(pattern);
-        if(matches) {
-            const [ , packageName, modulePath, symbol ] = matches;
-            return {
-                packageName,
-                modulePath,
-                symbol,
-            };
-        }
-
-        return {
-            packageName: '',
-            modulePath: '',
-            symbol: '',
-        };
-    }
-}
diff --git a/src/services/languages/javascript/symbolInfoExtractors.ts b/src/services/languages/javascript/symbolInfoExtractors.ts
@@ -64,8 +64,7 @@ export class NamedFunctionDeclarationSymbolInfoExtractor extends SymbolInfoExtra
             const functionMatch = `\\s*function\\s*${symbol.name}`; //should handle only function declaration, and filter out function call like db.getAll()
             const match = textLine.text.match(functionMatch);
             if(match !== undefined && match !== null) {
-                const names = [name, `Object.${name}`];
-                return super.extract(symbol, codeObjectPath, names, document, symbolPath);
+                return super.extract(symbol, codeObjectPath, name, document, symbolPath);
             }
         }
         return [];
diff --git a/src/services/languages/languageExtractor.ts b/src/services/languages/languageExtractor.ts
@@ -4,6 +4,7 @@ import { IMethodPositionSelector, DefaultMethodPositionSelector } from './method
 import { IMethodExtractor, IParametersExtractor, IEndpointExtractor, ISpanExtractor } from './extractors';
 import { BasicParametersExtractor } from './defaultImpls';
 import { IModulePathToUriConverter } from './modulePathToUriConverters';
+import { ICodeObjectIdParser, CommonCodeObjectIdParser } from '../codeObject';
 
 export interface ILanguageExtractor {
     requiredExtensionLoaded: boolean;
@@ -16,6 +17,7 @@ export interface ILanguageExtractor {
     getSpanExtractors(codeInspector: CodeInspector): ISpanExtractor[];
     validateConfiguration(): Promise<void>;
     getModulePathToUriConverters(): Promise<IModulePathToUriConverter[]>;
+    getCodeObjectIdParser(): ICodeObjectIdParser;
 }
 
 export abstract class LanguageExtractor implements ILanguageExtractor {
@@ -45,4 +47,8 @@ export abstract class LanguageExtractor implements ILanguageExtractor {
     }
 
     public abstract getModulePathToUriConverters(): Promise<IModulePathToUriConverter[]>;
+
+    public getCodeObjectIdParser(): ICodeObjectIdParser {
+        return new CommonCodeObjectIdParser();
+    }
 }
diff --git a/src/services/languages/symbolProvider.ts b/src/services/languages/symbolProvider.ts
@@ -9,6 +9,7 @@ import { ILanguageExtractor } from './languageExtractor';
 import { Token, TokenType } from './tokens';
 import { BasicParametersExtractor } from './defaultImpls';
 import { IMethodPositionSelector, DefaultMethodPositionSelector } from './methodPositionSelector';
+import { ICodeObjectIdParser } from '../codeObject';
 
 export function trendToCodIcon(trend: number): string 
 {
@@ -250,6 +251,13 @@ export class SymbolProvider
         return supportedLanguage;
     }
 
+    public async getCodeObjectIdParser(document: vscode.TextDocument): Promise<ICodeObjectIdParser | undefined> {
+        const supportedLanguage = await this.getSupportedLanguageExtractor(document);
+        if(supportedLanguage) {
+            return supportedLanguage.getCodeObjectIdParser();
+        }
+    }
+
     private async loadRequiredExtension(language: ILanguageExtractor) : Promise<boolean> {
         const extension = vscode.extensions.getExtension(language.requiredExtensionId);
         if (!extension) 
diff --git a/src/views/codeAnalytics/InsightListView/ErrorsInsight.ts b/src/views/codeAnalytics/InsightListView/ErrorsInsight.ts
@@ -1,7 +1,6 @@
 import { CodeObjectId } from "../../../services/codeObject";
 import { IListViewItemBase } from "../../ListView/IListViewItem";
 import { WebViewUris } from "../../webViewUtils";
-import { CodeObjectInfo } from "../codeAnalyticsView";
 import { HtmlHelper } from "../common";
 import {
     CodeObjectInsight,
diff --git a/src/views/codeAnalytics/InsightListView/HotspotInsight.ts b/src/views/codeAnalytics/InsightListView/HotspotInsight.ts
@@ -1,7 +1,6 @@
 import { CodeObjectId } from "../../../services/codeObject";
 import { IListViewItemBase } from "../../ListView/IListViewItem";
 import { WebViewUris } from "../../webViewUtils";
-import { CodeObjectInfo } from "../codeAnalyticsView";
 import { CodeObjectInsight, IInsightListViewItemsCreator } from "./IInsightListViewItemsCreator";
 import { InsightTemplateHtml } from "./ItemRender/insightTemplateHtml";
 
diff --git a/src/views/codeAnalytics/InsightListView/IInsightListViewItemsCreator.ts b/src/views/codeAnalytics/InsightListView/IInsightListViewItemsCreator.ts
@@ -2,7 +2,6 @@ import { decimal, integer } from "vscode-languageclient";
 import { UsageStatusResults } from "../../../services/analyticsProvider";
 import { IListViewItemBase } from "../../ListView/IListViewItem";
 import { WebViewUris } from "../../webViewUtils";
-import { CodeObjectInfo } from "../codeAnalyticsView";
 import { EndpointInsight, adjustHttpRouteIfNeeded, adjustHttpInsightIfNeeded } from "./EndpointInsight";
 
 export interface CodeObjectInsight extends Insight{
diff --git a/src/views/codeAnalytics/codeAnalyticsView.ts b/src/views/codeAnalytics/codeAnalyticsView.ts
@@ -32,6 +32,7 @@ import { ErrorFlowParameterDecorator } from "./decorators/errorFlowParameterDeco
 import { DigmaCommands } from "../../commands";
 import { EnvSelectStatusBar } from "./StatusBar/envSelectStatusBar";
 import { AnalyticsCodeLens } from "../../analyticsCodeLens";
+import { CodeObjectInfo, MinimalCodeObjectInfo, EmptyCodeObjectInfo } from "../../services/codeObject";
 //import { DigmaFileDecorator } from "../../decorators/fileDecorator";
 
 
@@ -128,11 +129,6 @@ export class CodeAnalyticsView implements vscode.Disposable
 	}
 }
 
-export interface CodeObjectInfo {
-	id: string,
-	methodName: string
-}
-
 class CodeAnalyticsViewProvider implements vscode.WebviewViewProvider,vscode.Disposable
 {  
  
@@ -359,10 +355,10 @@ class CodeAnalyticsViewProvider implements vscode.WebviewViewProvider,vscode.Dis
         //     return;
         // }
 
-		const codeObject = <CodeObjectInfo>{ 
-            id: methodInfo?.symbol.id, 
-            methodName: methodInfo?.displayName
-        };
+		const codeObject: CodeObjectInfo =
+            methodInfo
+                ? new MinimalCodeObjectInfo(methodInfo.symbol.id, methodInfo.displayName)
+                : new EmptyCodeObjectInfo();
         return codeObject;
 	}
 
diff --git a/src/views/codeAnalytics/common.ts b/src/views/codeAnalytics/common.ts
diff --git a/src/views/codeAnalytics/errorsViewTab.ts b/src/views/codeAnalytics/errorsViewTab.ts
diff --git a/src/views/codeAnalytics/insightsViewTab.ts b/src/views/codeAnalytics/insightsViewTab.ts
diff --git a/src/views/codeAnalytics/summaryViewTab.ts b/src/views/codeAnalytics/summaryViewTab.ts
diff --git a/src/views/errors/ErrorsHtmlBuilder.ts b/src/views/errors/ErrorsHtmlBuilder.ts

Original file line number	Diff line number	Diff line change
`@@ -64,8 +64,7 @@ export class NamedFunctionDeclarationSymbolInfoExtractor extends SymbolInfoExtra`
`64`	`64`	const functionMatch = `\\sfunction\\s${symbol.name}`; //should handle only function declaration, and filter out function call like db.getAll()
`65`	`65`	`const match = textLine.text.match(functionMatch);`
`66`	`66`	`if(match !== undefined && match !== null) {`
`67`		- const names = [name, `Object.${name}`];
`68`		`- return super.extract(symbol, codeObjectPath, names, document, symbolPath);`
	`67`	`+ return super.extract(symbol, codeObjectPath, name, document, symbolPath);`
`69`	`68`	`}`
`70`	`69`	`}`
`71`	`70`	`return [];`