improve code nav search heuristics: search across repositories, and expand language filter to resolve related langs like TypeScript, JavaScript, TSX, and JSX.

Author: brendan-kellam

docs/docs/search/code-navigation.mdx

@@ -31,7 +31,7 @@ Code navigation is **search-based**, meaning it uses the same code search engine
 Given a `symbolName`, along with information about the file the symbol is contained within (`git_revision`, and `language`), runs the following search:
 
 ```bash
-\\b{symbolName}\\b rev:{git_revision} lang:{language}
+\\b{symbolName}\\b rev:{git_revision} lang:{language} case:yes
 ```
 
 ### Find definitions

packages/web/src/app/[domain]/browse/[...path]/components/codePreviewPanel.tsx

@@ -211,7 +211,6 @@ export const CodePreviewPanel = ({
                     {editorRef && hasCodeNavEntitlement && (
                         <SymbolHoverPopup
                             editorRef={editorRef}
-                            repoName={repoName}
                             revisionName={revisionName}
                             language={language}
                             onFindReferences={onFindReferences}

packages/web/src/app/[domain]/search/components/codePreviewPanel/codePreview.tsx

@@ -270,7 +270,6 @@ export const CodePreview = ({
                     {editorRef && hasCodeNavEntitlement && (
                         <SymbolHoverPopup
                             editorRef={editorRef}
-                            repoName={repoName}
                             language={file.language}
                             revisionName={file.revision}
                             onFindReferences={onFindReferences}

packages/web/src/app/api/(server)/references/route.ts

@@ -20,15 +20,11 @@ export const GET = async (request: NextRequest) => {
     const symbolName = requiredQueryParamGuard(request, "symbolName");
     if (isServiceError(symbolName)) return serviceErrorResponse(symbolName);
 
-    const repoName = requiredQueryParamGuard(request, "repoName");
-    if (isServiceError(repoName)) return serviceErrorResponse(repoName);
-
     const language = requiredQueryParamGuard(request, "language");
     if (isServiceError(language)) return serviceErrorResponse(language);
 
     const references = await findSearchBasedSymbolReferences({
         symbolName,
-        repoName,
         language,
     }, domain);
     if (isServiceError(references)) return serviceErrorResponse(references);

packages/web/src/ee/features/codeNav/components/exploreMenu/index.tsx

@@ -44,7 +44,6 @@ export const ExploreMenu = ({
         queryFn: () => unwrapServiceError(
             findSearchBasedSymbolReferences({
                 symbolName: selectedSymbolInfo.symbolName,
-                repoName: selectedSymbolInfo.repoName,
                 language: selectedSymbolInfo.language,
                 revisionName: selectedSymbolInfo.revisionName,
             }, domain)
@@ -61,7 +60,6 @@ export const ExploreMenu = ({
         queryFn: () => unwrapServiceError(
             findSearchBasedSymbolDefinitions({
                 symbolName: selectedSymbolInfo.symbolName,
-                repoName: selectedSymbolInfo.repoName,
                 language: selectedSymbolInfo.language,
                 revisionName: selectedSymbolInfo.revisionName,
             }, domain)

packages/web/src/ee/features/codeNav/components/symbolHoverPopup/index.tsx

@@ -10,7 +10,6 @@ import { SymbolDefinitionPreview } from "./symbolDefinitionPreview";
 
 interface SymbolHoverPopupProps {
     editorRef: ReactCodeMirrorRef;
-    repoName: string;
     language: string;
     revisionName: string;
     onFindReferences: (symbolName: string) => void;
@@ -19,7 +18,6 @@ interface SymbolHoverPopupProps {
 
 export const SymbolHoverPopup: React.FC<SymbolHoverPopupProps> = ({
     editorRef,
-    repoName,
     revisionName,
     language,
     onFindReferences,
@@ -31,7 +29,6 @@ export const SymbolHoverPopup: React.FC<SymbolHoverPopupProps> = ({
     const symbolInfo = useHoveredOverSymbolInfo({
         editorRef,
         isSticky,
-        repoName,
         revisionName,
         language,
     });

packages/web/src/ee/features/codeNav/components/symbolHoverPopup/useHoveredOverSymbolInfo.ts

@@ -10,7 +10,6 @@ import { SYMBOL_HOVER_TARGET_DATA_ATTRIBUTE } from "./symbolHoverTargetsExtensio
 interface UseHoveredOverSymbolInfoProps {
     editorRef: ReactCodeMirrorRef;
     isSticky: boolean;
-    repoName: string;
     revisionName: string;
     language: string;
 }
@@ -36,7 +35,6 @@ const SYMBOL_HOVER_POPUP_MOUSE_OUT_TIMEOUT_MS = 100;
 export const useHoveredOverSymbolInfo = ({
     editorRef,
     isSticky,
-    repoName,
     revisionName,
     language,
 }: UseHoveredOverSymbolInfoProps): HoveredOverSymbolInfo | undefined => {
@@ -52,11 +50,10 @@ export const useHoveredOverSymbolInfo = ({
     }, [symbolElement]);
 
     const { data: symbolDefinitions, isLoading: isSymbolDefinitionsLoading } = useQuery({
-        queryKey: ["definitions", symbolName, repoName, revisionName, language, domain],
+        queryKey: ["definitions", symbolName, revisionName, language, domain],
         queryFn: () => unwrapServiceError(
             findSearchBasedSymbolDefinitions({
                 symbolName: symbolName!,
-                repoName,
                 language,
                 revisionName,
             }, domain)

packages/web/src/features/codeNav/actions.ts

@@ -4,7 +4,6 @@ import { sew, withAuth, withOrgMembership } from "@/actions";
 import { searchResponseSchema } from "@/features/search/schemas";
 import { search } from "@/features/search/searchApi";
 import { isServiceError } from "@/lib/utils";
-import escapeStringRegexp from "escape-string-regexp";
 import { FindRelatedSymbolsResponse } from "./types";
 import { ServiceError } from "@/lib/serviceError";
 import { SearchResponse } from "../search/types";
@@ -15,7 +14,6 @@ const MAX_REFERENCE_COUNT = 1000;
 export const findSearchBasedSymbolReferences = async (
     props: {
         symbolName: string,
-        repoName: string,
         language: string,
         revisionName?: string,
     },
@@ -25,12 +23,11 @@ export const findSearchBasedSymbolReferences = async (
         withOrgMembership(session, domain, async () => {
             const {
                 symbolName,
-                repoName,
                 language,
                 revisionName = "HEAD",
             } = props;
 
-            const query = `\\b${symbolName}\\b repo:^${escapeStringRegexp(repoName)}$ rev:${revisionName} lang:${language}`
+            const query = `\\b${symbolName}\\b rev:${revisionName} ${getExpandedLanguageFilter(language)} case:yes`;
 
             const searchResult = await search({
                 query,
@@ -50,7 +47,6 @@ export const findSearchBasedSymbolReferences = async (
 export const findSearchBasedSymbolDefinitions = async (
     props: {
         symbolName: string,
-        repoName: string,
         language: string,
         revisionName?: string,
     },
@@ -60,12 +56,11 @@ export const findSearchBasedSymbolDefinitions = async (
         withOrgMembership(session, domain, async () => {
             const {
                 symbolName,
-                repoName,
                 language,
                 revisionName = "HEAD",
             } = props;
 
-            const query = `sym:\\b${symbolName}\\b repo:^${escapeStringRegexp(repoName)}$ rev:${revisionName} lang:${language}`
+            const query = `sym:\\b${symbolName}\\b rev:${revisionName} ${getExpandedLanguageFilter(language)}`;
 
             const searchResult = await search({
                 query,
@@ -107,4 +102,17 @@ const parseRelatedSymbolsSearchResponse = (searchResult: SearchResponse) => {
     }));
 
     return parser.parseAsync(searchResult);
+}
+
+// Expands the language filter to include all variants of the language.
+const getExpandedLanguageFilter = (language: string) => {
+    switch (language) {
+        case "TypeScript":
+        case "JavaScript":
+        case "JSX":
+        case "TSX":
+            return `(lang:TypeScript or lang:JavaScript or lang:JSX or lang:TSX)`
+        default:
+            return `lang:${language}`
+    }
 }