feat: add error report

fix #133

Author: HerringtonDarkholme

src/types.ts

@@ -43,7 +43,10 @@ export type Definition = {
       id: number
       inputValue: string
     }
-    error: Error
+    error: {
+      id: number
+      error: Error
+    }
   }
   child2parent: {
     search: {

src/view.ts

@@ -187,8 +187,11 @@ function setupParentPort(webviewView: vscode.WebviewView) {
     }
     await getPatternRes(payload.inputValue, {
       onData,
-      onError(e) {
-        parentPort.postMessage('error', e)
+      onError(error) {
+        parentPort.postMessage('error', {
+          error,
+          ...payload
+        })
       }
     })
     parentPort.postMessage('searchEnd', payload)

src/webview/SearchSidebar/SearchProviderMessage/index.tsx

@@ -53,13 +53,31 @@ interface SearchProviderMessageProps {
   resultCount: number
   fileCount: number
   pattern: string
+  error: Error | null
 }
 
 const SearchProviderMessage = ({
   pattern,
   resultCount,
-  fileCount
+  fileCount,
+  error
 }: SearchProviderMessageProps) => {
+  if (error) {
+    return (
+      <div style={style}>
+        Error occurs when running <code>ast-grep</code>.<br />
+        Make sure you{' '}
+        <VSCodeLink href="https://ast-grep.github.io/guide/quick-start.html#installation">
+          installed the binary
+        </VSCodeLink>{' '}
+        and the command <code>ast-grep</code> is accessible{' '}
+        <VSCodeLink href="https://github.com/ast-grep/ast-grep-vscode/issues/133#issuecomment-1943153446">
+          by your editor
+        </VSCodeLink>
+        .
+      </div>
+    )
+  }
   return (
     <>
       {resultCount === 0 ? (

src/webview/SearchSidebar/index.tsx

@@ -17,7 +17,8 @@ export const SearchSidebar = () => {
     searchCount,
     groupedByFileSearchResult,
     refreshSearchResult,
-    searching
+    searching,
+    searchError
   } = useSearchResult(inputValue)
 
   // rendering tree is too expensive, useDeferredValue
@@ -35,6 +36,7 @@ export const SearchSidebar = () => {
       />
       <SearchProviderMessage
         pattern={queryInFlight}
+        error={searchError}
         resultCount={searchCount}
         fileCount={groupedByFileSearchResult.length}
       />

src/webview/hooks/useSearch.tsx

@@ -13,6 +13,7 @@ let grouped = [] as [string, DisplayResult[]][]
 let queryInFlight = ''
 let searching = true
 let notify = () => {}
+let searchError: Error | null = null
 // we will not immediately drop previous result
 // instead, use a stale flag and update it on streaming or end
 let hasStaleResult = false
@@ -22,6 +23,7 @@ function postSearch(inputValue: string) {
   childPort.postMessage('search', { id, inputValue })
   searching = true
   hasStaleResult = true
+  searchError = null
   notify()
 }
 
@@ -52,6 +54,16 @@ childPort.onMessage('searchEnd', event => {
   notify()
 })
 
+childPort.onMessage('error', event => {
+  if (event.id !== id) {
+    return
+  }
+  searchError = event.error
+  searching = false
+  grouped = []
+  notify()
+})
+
 function groupBy(matches: DisplayResult[]) {
   const groups = new Map<string, DisplayResult[]>()
   for (const match of matches) {
@@ -104,6 +116,7 @@ export const useSearchResult = (inputValue: string) => {
   return {
     queryInFlight,
     searching,
+    searchError,
     groupedByFileSearchResult: grouped,
     searchCount: grouped.reduce((a, l) => a + l[1].length, 0),
     refreshSearchResult