Merge pull request #124 from smacker/improve_bblfsh_integration

Improve bblfsh integration

Author: smacker

Gopkg.lock

@@ -40,11 +40,11 @@
 
 [[constraint]]
   name = "gopkg.in/bblfsh/sdk.v1"
-  version = "1.15.2"
+  version = "1.16.0"
 
 [[constraint]]
   name = "gopkg.in/bblfsh/client-go.v2"
-  version = "2.4.2"
+  version = "2.5.1"
 
 [[constraint]]
   name = "gopkg.in/DATA-DOG/go-sqlmock.v1"

Gopkg.toml

@@ -286,3 +286,27 @@ curl -X POST \
     }
 }
 ```
+
+## GET /get-languages
+
+Returns programming language supported by bblfsh server.
+
+```bash
+curl -X GET http://localhost:8080/get-languages
+```
+
+```json
+{
+    "status": 200,
+    "data": [
+        { "id": "python", "name": "Python" },
+        { "id": "java", "name": "Java" },
+        { "id": "javascript", "name": "JavaScript" },
+        { "id": "bash", "name": "Bash" },
+        { "id": "ruby", "name": "Ruby" },
+        { "id": "go", "name": "Go" },
+        { "id": "php", "name": "PHP" }
+    ]
+}
+
+```

docs/rest-api.md

@@ -54,6 +54,9 @@
     },
     "/parse": {
       "target": "http://localhost:8080"
+    },
+    "/get-languages": {
+      "target": "http://localhost:8080"
     }
   }
 }

frontend/package.json

@@ -45,6 +45,7 @@ class App extends Component {
       sql: '',
       results: new Map(),
       schema: undefined,
+      languages: [],
       history: [],
       lastResult: null,
 
@@ -238,7 +239,7 @@ FROM ( SELECT MONTH(committer_when) as month,
     this.setState({
       showModal: true,
       modalTitle: 'Source code',
-      modalContent: <CodeViewer code={code} />
+      modalContent: <CodeViewer code={code} languages={this.state.languages} />
     });
   }
 
@@ -257,9 +258,20 @@ FROM ( SELECT MONTH(committer_when) as month,
     });
   }
 
+  loadLanguages() {
+    api
+      .getLanguages()
+      .then(languages => this.setState({ languages }))
+      .catch(err =>
+        // we don't have UI for this error
+        console.error(`Can't get list of languages from bblfsh: ${err}`)
+      );
+  }
+
   componentDidMount() {
     this.setState(loadStateFromStorage());
     this.loadSchema();
+    this.loadLanguages();
     this.handleExampleClick(this.exampleQueries[0].sql);
   }
 

frontend/src/App.js

@@ -141,10 +141,15 @@ function parseCode(language, content) {
   });
 }
 
+function getLanguages() {
+  return apiCall(`/get-languages`).then(res => res.data);
+}
+
 export default {
   query,
   schema,
   queryExport,
   detectLang,
-  parseCode
+  parseCode,
+  getLanguages
 };

frontend/src/api.js

@@ -5,18 +5,8 @@ import UASTViewer, { Editor, withUASTEditor } from 'uast-viewer';
 import api from '../api';
 import './CodeViewer.less';
 
-const avaliableLangs = [
-  'Java',
-  'Go',
-  'Python',
-  'JavaScript',
-  'Php',
-  'Ruby',
-  'Typescript',
-  'Bash'
-];
-
 function EditorPane({
+  languages,
   language,
   showUast,
   handleLangChange,
@@ -28,9 +18,9 @@ function EditorPane({
       Language:{' '}
       <select value={language} onChange={handleLangChange}>
         <option value="">Select language</option>
-        {avaliableLangs.map(lang => (
-          <option key={lang} value={lang.toLowerCase()}>
-            {lang}
+        {languages.map(lang => (
+          <option key={lang.id} value={lang.id}>
+            {lang.name}
           </option>
         ))}
       </select>
@@ -48,6 +38,12 @@ function EditorPane({
 }
 
 EditorPane.propTypes = {
+  languages: PropTypes.arrayOf(
+    PropTypes.shape({
+      id: PropTypes.string.isRequired,
+      name: PropTypes.string.isRequired
+    })
+  ),
   language: PropTypes.string,
   showUast: PropTypes.bool,
   handleLangChange: PropTypes.func.isRequired,
@@ -56,6 +52,7 @@ EditorPane.propTypes = {
 };
 
 function EditorUASTSpitPane({
+  languages,
   editorProps,
   uastViewerProps,
   showUast,
@@ -65,6 +62,7 @@ function EditorUASTSpitPane({
   return (
     <SplitPane split="vertical" defaultSize={250} minSize={175}>
       <EditorPane
+        languages={languages}
         language={editorProps.languageMode}
         showUast={showUast}
         handleLangChange={handleLangChange}
@@ -77,6 +75,7 @@ function EditorUASTSpitPane({
 }
 
 EditorUASTSpitPane.propTypes = {
+  languages: EditorPane.propTypes.languages,
   editorProps: PropTypes.object,
   uastViewerProps: PropTypes.object,
   showUast: PropTypes.bool,
@@ -166,6 +165,7 @@ class CodeViewer extends Component {
       return (
         <div className="code-viewer">
           <EditorWithUAST
+            languages={this.props.languages}
             code={this.props.code}
             languageMode={language}
             showUast={showUast}
@@ -187,6 +187,7 @@ class CodeViewer extends Component {
 
     return (
       <EditorPane
+        languages={this.props.languages}
         language={language}
         showUast={showUast}
         handleLangChange={this.handleLangChange}
@@ -198,7 +199,8 @@ class CodeViewer extends Component {
 }
 
 CodeViewer.propTypes = {
-  code: PropTypes.string.isRequired
+  code: PropTypes.string.isRequired,
+  languages: EditorPane.propTypes.languages
 };
 
 export default CodeViewer;

frontend/src/components/CodeViewer.js

@@ -2,9 +2,9 @@ package handler
 
 import (
 	"encoding/json"
-	"errors"
 	"io/ioutil"
 	"net/http"
+	"strings"
 
 	bblfsh "gopkg.in/bblfsh/client-go.v2"
 	"gopkg.in/bblfsh/client-go.v2/tools"
@@ -60,7 +60,7 @@ func Parse(bbblfshServerURL string) RequestProcessFunc {
 		}
 
 		if resp.Status != protocol.Ok {
-			return nil, errors.New("bblfsh returend not OK response")
+			return nil, serializer.NewHTTPError(http.StatusBadRequest, strings.Join(resp.Errors, "\n"))
 		}
 
 		if resp.UAST != nil && req.Filter != "" {
@@ -85,3 +85,20 @@ func Filter() RequestProcessFunc {
 		return nil, serializer.NewHTTPError(http.StatusNotImplemented, http.StatusText(http.StatusNotImplemented))
 	}
 }
+
+// GetLanguages returns a list of supported languages by bblfsh
+func GetLanguages(bbblfshServerURL string) RequestProcessFunc {
+	return func(r *http.Request) (*serializer.Response, error) {
+		cli, err := bblfsh.NewClient(bbblfshServerURL)
+		if err != nil {
+			return nil, err
+		}
+
+		resp, err := cli.NewSupportedLanguagesRequest().Do()
+		if err != nil {
+			return nil, err
+		}
+
+		return serializer.NewLanguagesResponse(service.DriverManifestsToLangs(resp.Languages)), nil
+	}
+}

server/handler/uast.go

@@ -55,5 +55,5 @@ func (suite *UASTSuite) TestError() {
 	res := httptest.NewRecorder()
 	suite.handler.ServeHTTP(res, req)
 
-	suite.Equal(http.StatusInternalServerError, res.Code)
+	suite.Equal(http.StatusBadRequest, res.Code)
 }

server/handler/uast_integration_test.go

@@ -43,6 +43,7 @@ func Router(
 	r.Post("/parse", handler.APIHandlerFunc(handler.Parse(bbblfshServerURL)))
 	r.Post("/filter", handler.APIHandlerFunc(handler.Filter()))
 	r.Post("/detect-lang", handler.APIHandlerFunc(handler.DetectLanguage()))
+	r.Get("/get-languages", handler.APIHandlerFunc(handler.GetLanguages(bbblfshServerURL)))
 
 	r.Get("/version", handler.APIHandlerFunc(handler.Version(version)))
 

server/router.go

@@ -131,3 +131,8 @@ func NewDetectLangResponse(lang string, langType enry.Type) *Response {
 		Type     int    `json:"type"`
 	}{lang, int(langType)}, nil)
 }
+
+// NewLanguagesResponse returns Response with a list of languages
+func NewLanguagesResponse(langs []service.Language) *Response {
+	return newResponse(langs, nil)
+}

server/serializer/serializers.go

@@ -73,3 +73,21 @@ func (n *Node) MarshalJSON() ([]byte, error) {
 
 	return json.Marshal(node)
 }
+
+type Language struct {
+	ID   string `json:"id"`
+	Name string `json:"name"`
+}
+
+func DriverManifestsToLangs(drivers []protocol.DriverManifest) []Language {
+	result := make([]Language, len(drivers))
+
+	for i, driver := range drivers {
+		result[i] = Language{
+			ID:   driver.Language,
+			Name: driver.Name,
+		}
+	}
+
+	return result
+}