Merge pull request #3326 from github/koesie10/add-endpoint-type

Add endpoint type to method definition

Author: koesie10

extensions/ql-vscode/src/model-editor/bqrs.ts

@@ -3,7 +3,7 @@ import type {
   BqrsEntityValue,
 } from "../common/bqrs-cli-types";
 import type { Method, Usage } from "./method";
-import { CallClassification } from "./method";
+import { EndpointType, CallClassification } from "./method";
 import type { ModeledMethodType } from "./modeled-method";
 import { parseLibraryFilename } from "./library";
 import { Mode } from "./shared/mode";
@@ -33,6 +33,7 @@ export function decodeBqrsToMethods(
     let libraryVersion: string | undefined;
     let type: ModeledMethodType;
     let classification: CallClassification;
+    let endpointType = EndpointType.Method;
 
     if (mode === Mode.Application) {
       [
@@ -62,7 +63,16 @@ export function decodeBqrsToMethods(
       classification = CallClassification.Unknown;
     }
 
+    if ((type as string) === "") {
+      type = "none";
+    }
+
+    if (methodName === "") {
+      endpointType = EndpointType.Class;
+    }
+
     const signature = definition.createMethodSignature({
+      endpointType,
       packageName,
       typeName,
       methodName,
@@ -93,6 +103,7 @@ export function decodeBqrsToMethods(
         library,
         libraryVersion,
         signature,
+        endpointType,
         packageName,
         typeName,
         methodName,

extensions/ql-vscode/src/model-editor/languages/ruby/access-paths.ts

@@ -1,4 +1,5 @@
 import { parseAccessPathTokens } from "../../shared/access-paths";
+import { EndpointType } from "../../method";
 
 const methodTokenRegex = /^Method\[(.+)]$/;
 
@@ -62,3 +63,7 @@ export function rubyPath(methodName: string, path: string) {
 
   return `${methodPath}.${path}`;
 }
+
+export function rubyEndpointType(methodName: string) {
+  return methodName === "" ? EndpointType.Class : EndpointType.Method;
+}

extensions/ql-vscode/src/model-editor/languages/ruby/index.ts

@@ -7,6 +7,7 @@ import { getArgumentsList } from "../../method";
 import {
   parseRubyAccessPath,
   parseRubyMethodFromPath,
+  rubyEndpointType,
   rubyMethodPath,
   rubyMethodSignature,
   rubyPath,
@@ -37,11 +38,11 @@ export const ruby: ModelsAsDataLanguage = {
         );
         return {
           type: "source",
-          input: "",
           output,
           kind: row[2] as string,
           provenance: "manual",
           signature: rubyMethodSignature(typeName, methodName),
+          endpointType: rubyEndpointType(methodName),
           packageName: "",
           typeName,
           methodName,
@@ -70,10 +71,10 @@ export const ruby: ModelsAsDataLanguage = {
         return {
           type: "sink",
           input,
-          output: "",
           kind: row[2] as string,
           provenance: "manual",
           signature: rubyMethodSignature(typeName, methodName),
+          endpointType: rubyEndpointType(methodName),
           packageName: "",
           typeName,
           methodName,
@@ -104,6 +105,7 @@ export const ruby: ModelsAsDataLanguage = {
           kind: row[4] as string,
           provenance: "manual",
           signature: rubyMethodSignature(typeName, methodName),
+          endpointType: rubyEndpointType(methodName),
           packageName: "",
           typeName,
           methodName,
@@ -127,11 +129,10 @@ export const ruby: ModelsAsDataLanguage = {
         const methodName = parseRubyMethodFromPath(row[1] as string);
         return {
           type: "neutral",
-          input: "",
-          output: "",
           kind: row[2] as string,
           provenance: "manual",
           signature: rubyMethodSignature(typeName, methodName),
+          endpointType: rubyEndpointType(methodName),
           packageName: "",
           typeName,
           methodName,
@@ -156,6 +157,7 @@ export const ruby: ModelsAsDataLanguage = {
           relatedTypeName: row[0] as string,
           path,
           signature: rubyMethodSignature(typeName, methodName),
+          endpointType: rubyEndpointType(methodName),
           packageName: "",
           typeName,
           methodName,

extensions/ql-vscode/src/model-editor/languages/ruby/suggestions.ts

@@ -7,7 +7,11 @@ import type {
 import type { ModelsAsDataLanguage } from "../models-as-data";
 import type { AccessPathSuggestionRow } from "../../suggestions";
 import { isDefinitionType } from "../../suggestions";
-import { parseRubyMethodFromPath, rubyMethodSignature } from "./access-paths";
+import {
+  parseRubyMethodFromPath,
+  rubyEndpointType,
+  rubyMethodSignature,
+} from "./access-paths";
 
 function checkTupleFormat(
   tuple: BqrsCellValue[],
@@ -64,6 +68,7 @@ export function parseAccessPathSuggestionsResults(
       return {
         method: {
           packageName: "",
+          endpointType: rubyEndpointType(methodName),
           typeName: type,
           methodName,
           methodParameters: "",

extensions/ql-vscode/src/model-editor/languages/static/index.ts

@@ -4,7 +4,7 @@ import type { DataTuple } from "../../model-extension-file";
 import { sharedExtensiblePredicates, sharedKinds } from "../shared";
 import { filterFlowModelQueries, parseFlowModelResults } from "./generate";
 import type { MethodArgument } from "../../method";
-import { getArgumentsList } from "../../method";
+import { EndpointType, getArgumentsList } from "../../method";
 
 function readRowToMethod(row: DataTuple[]): string {
   return `${row[0]}.${row[1]}#${row[3]}${row[4]}`;
@@ -38,11 +38,11 @@ export const staticLanguage: ModelsAsDataLanguage = {
       ],
       readModeledMethod: (row) => ({
         type: "source",
-        input: "",
         output: row[6] as string,
         kind: row[7] as string,
         provenance: row[8] as Provenance,
         signature: readRowToMethod(row),
+        endpointType: EndpointType.Method,
         packageName: row[0] as string,
         typeName: row[1] as string,
         methodName: row[3] as string,
@@ -70,10 +70,10 @@ export const staticLanguage: ModelsAsDataLanguage = {
       readModeledMethod: (row) => ({
         type: "sink",
         input: row[6] as string,
-        output: "",
         kind: row[7] as string,
         provenance: row[8] as Provenance,
         signature: readRowToMethod(row),
+        endpointType: EndpointType.Method,
         packageName: row[0] as string,
         typeName: row[1] as string,
         methodName: row[3] as string,
@@ -106,6 +106,7 @@ export const staticLanguage: ModelsAsDataLanguage = {
         kind: row[8] as string,
         provenance: row[9] as Provenance,
         signature: readRowToMethod(row),
+        endpointType: EndpointType.Method,
         packageName: row[0] as string,
         typeName: row[1] as string,
         methodName: row[3] as string,
@@ -128,11 +129,10 @@ export const staticLanguage: ModelsAsDataLanguage = {
       ],
       readModeledMethod: (row) => ({
         type: "neutral",
-        input: "",
-        output: "",
         kind: row[4] as string,
         provenance: row[5] as Provenance,
         signature: `${row[0]}.${row[1]}#${row[2]}${row[3]}`,
+        endpointType: EndpointType.Method,
         packageName: row[0] as string,
         typeName: row[1] as string,
         methodName: row[2] as string,

extensions/ql-vscode/src/model-editor/method.ts

@@ -17,7 +17,13 @@ export type Usage = Call & {
   readonly classification: CallClassification;
 };
 
+export enum EndpointType {
+  Method = "method",
+  Class = "class",
+}
+
 export interface MethodDefinition {
+  readonly endpointType: EndpointType;
   /**
    * The package name in Java, or the namespace in C#, e.g. `org.sql2o` or `System.Net.Http.Headers`.
    *

extensions/ql-vscode/src/model-editor/modeled-method-empty.ts

@@ -7,6 +7,7 @@ export function createEmptyModeledMethod(
   methodSignature: MethodSignature,
 ) {
   const canonicalMethodSignature: MethodSignature = {
+    endpointType: methodSignature.endpointType,
     packageName: methodSignature.packageName,
     typeName: methodSignature.typeName,
     methodName: methodSignature.methodName,

extensions/ql-vscode/src/model-editor/shared/validation.ts

@@ -25,6 +25,7 @@ function canonicalizeModeledMethod(
   modeledMethod: ModeledMethod,
 ): ModeledMethod {
   const methodSignature: MethodSignature = {
+    endpointType: modeledMethod.endpointType,
     signature: modeledMethod.signature,
     packageName: modeledMethod.packageName,
     typeName: modeledMethod.typeName,

extensions/ql-vscode/src/stories/model-editor/LibraryRow.stories.tsx

@@ -1,7 +1,7 @@
 import type { Meta, StoryFn } from "@storybook/react";
 
 import { LibraryRow as LibraryRowComponent } from "../../view/model-editor/LibraryRow";
-import { CallClassification } from "../../model-editor/method";
+import { CallClassification, EndpointType } from "../../model-editor/method";
 import { createMockModelEditorViewState } from "../../../test/factories/model-editor/view-state";
 
 export default {
@@ -22,6 +22,7 @@ LibraryRow.args = {
       library: "sql2o",
       libraryVersion: "1.6.0",
       signature: "org.sql2o.Connection#createQuery(String)",
+      endpointType: EndpointType.Method,
       packageName: "org.sql2o",
       typeName: "Connection",
       methodName: "createQuery",
@@ -44,6 +45,7 @@ LibraryRow.args = {
       library: "sql2o",
       libraryVersion: "1.6.0",
       signature: "org.sql2o.Query#executeScalar(Class)",
+      endpointType: EndpointType.Method,
       packageName: "org.sql2o",
       typeName: "Query",
       methodName: "executeScalar",
@@ -66,6 +68,7 @@ LibraryRow.args = {
       library: "sql2o",
       libraryVersion: "1.6.0",
       signature: "org.sql2o.Sql2o#open()",
+      endpointType: EndpointType.Method,
       packageName: "org.sql2o",
       typeName: "Sql2o",
       methodName: "open",
@@ -88,6 +91,7 @@ LibraryRow.args = {
       library: "sql2o",
       libraryVersion: "1.6.0",
       signature: "org.sql2o.Sql2o#Sql2o(String,String,String)",
+      endpointType: EndpointType.Method,
       packageName: "org.sql2o",
       typeName: "Sql2o",
       methodName: "Sql2o",
@@ -110,6 +114,7 @@ LibraryRow.args = {
       library: "sql2o",
       libraryVersion: "1.6.0",
       signature: "org.sql2o.Sql2o#Sql2o(String)",
+      endpointType: EndpointType.Method,
       packageName: "org.sql2o",
       typeName: "Sql2o",
       methodName: "Sql2o",
@@ -150,6 +155,7 @@ LibraryRow.args = {
         kind: "jndi-injection",
         provenance: "df-generated",
         signature: "org.sql2o.Sql2o#Sql2o(String)",
+        endpointType: EndpointType.Method,
         packageName: "org.sql2o",
         typeName: "Sql2o",
         methodName: "Sql2o",
@@ -164,6 +170,7 @@ LibraryRow.args = {
         kind: "taint",
         provenance: "df-manual",
         signature: "org.sql2o.Connection#createQuery(String)",
+        endpointType: EndpointType.Method,
         packageName: "org.sql2o",
         typeName: "Connection",
         methodName: "createQuery",
@@ -178,6 +185,7 @@ LibraryRow.args = {
         kind: "taint",
         provenance: "manual",
         signature: "org.sql2o.Sql2o#open()",
+        endpointType: EndpointType.Method,
         packageName: "org.sql2o",
         typeName: "Sql2o",
         methodName: "open",
@@ -190,6 +198,7 @@ LibraryRow.args = {
         kind: "summary",
         provenance: "df-generated",
         signature: "org.sql2o.Query#executeScalar(Class)",
+        endpointType: EndpointType.Method,
         packageName: "org.sql2o",
         typeName: "Query",
         methodName: "executeScalar",
@@ -202,6 +211,7 @@ LibraryRow.args = {
         kind: "sink",
         provenance: "df-generated",
         signature: "org.sql2o.Sql2o#Sql2o(String,String,String)",
+        endpointType: EndpointType.Method,
         packageName: "org.sql2o",
         typeName: "Sql2o",
         methodName: "Sql2o",

extensions/ql-vscode/src/stories/model-editor/MethodRow.stories.tsx

@@ -4,7 +4,7 @@ import type { Meta, StoryFn } from "@storybook/react";
 
 import { MethodRow as MethodRowComponent } from "../../view/model-editor/MethodRow";
 import type { Method } from "../../model-editor/method";
-import { CallClassification } from "../../model-editor/method";
+import { EndpointType, CallClassification } from "../../model-editor/method";
 import type { ModeledMethod } from "../../model-editor/modeled-method";
 import { MULTIPLE_MODELS_GRID_TEMPLATE_COLUMNS } from "../../view/model-editor/ModeledMethodDataGrid";
 import { DataGrid } from "../../view/common/DataGrid";
@@ -46,6 +46,7 @@ const Template: StoryFn<typeof MethodRowComponent> = (args) => {
 const method: Method = {
   library: "sql2o-1.6.0.jar",
   signature: "org.sql2o.Sql2o#open()",
+  endpointType: EndpointType.Method,
   packageName: "org.sql2o",
   typeName: "Sql2o",
   methodName: "open",
@@ -86,6 +87,7 @@ const modeledMethod: ModeledMethod = {
   kind: "taint",
   provenance: "manual",
   signature: "org.sql2o.Sql2o#open()",
+  endpointType: EndpointType.Method,
   packageName: "org.sql2o",
   typeName: "Sql2o",
   methodName: "open",