Merge pull request #197 from github/proto-rework

Protoc rework

Author: tclem

Dockerfile

@@ -1,3 +1,18 @@
+# Put protoc and twirp tooling in its own image
+FROM golang:1.12-stretch AS protoc
+RUN apt-get update && apt-get install -y unzip
+ENV PROTOBUF_VERSION=3.7.1
+RUN wget "https://github.com/protocolbuffers/protobuf/releases/download/v3.7.1/protoc-$PROTOBUF_VERSION-linux-x86_64.zip" && \
+    unzip "protoc-$PROTOBUF_VERSION-linux-x86_64.zip" -d "/protobuf"
+
+RUN go get github.com/golang/protobuf/proto && \
+    go get github.com/twitchtv/protogen/typemap && \
+    go get github.com/tclem/twirp-haskell/pkg/gen/haskell && \
+    go get github.com/tclem/twirp-haskell/protoc-gen-haskell
+
+ENTRYPOINT ["/protobuf/bin/protoc", "-I/protobuf", "-I=/go/src/github.com/tclem/twirp-haskell"]
+
+# Build semantic
 FROM haskell:8.6 as build
 WORKDIR /build
 

proto/semantic/api/v1/code_analysis.proto renamed to proto/semantic.proto

@@ -1,23 +1,11 @@
 syntax = "proto3";
 
-package semantic.api.v1;
-
-option java_package = "com.github.semantic.api.v1";
-
-// Semantic's CodeAnalysis service provides endpoints for parsing, analyzing,
-// and comparing source code.
-service CodeAnalysis {
-  // Check health & status of the service.
-  rpc Ping (PingRequest) returns (PingResponse);
-  // Calculate c-tags like symbols for blobs.
-  rpc ParseTreeSymbols (ParseTreeRequest) returns (ParseTreeSymbolResponse);
-  // Parse trees in adjacency graph representation.
-  rpc ParseTreeGraph (ParseTreeRequest) returns (ParseTreeGraphResponse);
-  // Calculate table of contents style diff summaries.
-  rpc DiffTreeTOC (DiffTreeRequest) returns (DiffTreeTOCResponse);
-  // Tree diffs in adjacency graph representation.
-  rpc DiffTreeGraph (DiffTreeRequest) returns (DiffTreeGraphResponse);
-}
+import "pkg/gen/haskell/haskell.proto";
+
+package github.semantic;
+
+option (haskell.haskell_package) = "Semantic.Proto";
+option ruby_package = "Semantic::Proto";
 
 message PingRequest {
   string service = 1;

script/protoc

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+#/ Usage: script/protoc
+#/
+#/ Generate code from .proto files
+
+set -ex
+cd "$(dirname "$0")/.."
+
+docker build -t semantic-protoc --target protoc .
+
+PARENT_DIR=$(dirname $(pwd))
+
+export PROJECT="github.com/github/semantic"
+
+# Generate Haskell for semantic's protobuf types
+docker run --rm --user $(id -u):$(id -g) -v $(pwd):/go/src/$PROJECT -w /go/src/$PROJECT \
+    semantic-protoc \
+    --proto_path=proto --haskell_out=src/Semantic/Proto \
+    semantic.proto

semantic.cabal

@@ -249,7 +249,7 @@ library
                      , Semantic.Api.Symbols
                      , Semantic.Api.Terms
                      , Semantic.Api.TOCSummaries
-                     , Semantic.Api.V1.CodeAnalysisPB
+                     , Semantic.Proto.SemanticPB
                      , Semantic.AST
                      , Semantic.CLI
                      , Semantic.Config

src/Data/Graph.hs

@@ -23,7 +23,7 @@ import qualified Algebra.Graph.ToGraph as Class
 import           Control.Effect.State
 import           Data.Aeson
 import qualified Data.Set as Set
-import Semantic.Api.V1.CodeAnalysisPB
+import           Semantic.Proto.SemanticPB
 
 -- | An algebraic graph with 'Ord', 'Semigroup', and 'Monoid' instances.
 newtype Graph vertex = Graph { unGraph :: G.Graph vertex }

src/Rendering/Graph.hs

@@ -20,7 +20,7 @@ import Data.String (IsString (..))
 import Data.Term
 import Prologue
 import Semantic.Api.Bridge
-import Semantic.Api.V1.CodeAnalysisPB
+import Semantic.Proto.SemanticPB
 
 import qualified Data.Text as T
 

src/Semantic/Api.hs

@@ -11,4 +11,4 @@ import Semantic.Api.Diffs as DiffsAPI
 import Semantic.Api.Symbols as SymbolsAPI
 import Semantic.Api.Terms as TermsAPI
 import Semantic.Api.TOCSummaries as TOCSummariesAPI
-import Semantic.Api.V1.CodeAnalysisPB as Types
+import Semantic.Proto.SemanticPB as Types

src/Semantic/Api/Bridge.hs

@@ -12,7 +12,7 @@ import           Data.Source (fromText, toText)
 import qualified Data.Span as Data
 import qualified Data.Text as T
 import qualified Semantic.Api.LegacyTypes as Legacy
-import qualified Semantic.Api.V1.CodeAnalysisPB as API
+import qualified Semantic.Proto.SemanticPB as API
 
 -- | An @APIBridge x y@ instance describes an isomorphism between @x@ and @y@.
 -- This is suitable for types such as 'Pos' which are representationally equivalent

src/Semantic/Api/Diffs.hs

@@ -34,7 +34,7 @@ import           Rendering.Graph
 import           Rendering.JSON hiding (JSON)
 import qualified Rendering.JSON
 import           Semantic.Api.Bridge
-import           Semantic.Api.V1.CodeAnalysisPB hiding (Blob, BlobPair)
+import           Semantic.Proto.SemanticPB hiding (Blob, BlobPair)
 import           Semantic.Task as Task
 import           Semantic.Telemetry as Stat
 import           Serializing.Format hiding (JSON)

src/Semantic/Api/Symbols.hs

@@ -23,7 +23,7 @@ import           Prologue
 import           Semantic.Api.Bridge
 import qualified Semantic.Api.LegacyTypes as Legacy
 import           Semantic.Api.Terms (ParseEffects, doParse)
-import           Semantic.Api.V1.CodeAnalysisPB hiding (Blob)
+import           Semantic.Proto.SemanticPB hiding (Blob)
 import           Semantic.Task
 import           Serializing.Format
 import           Tags.Taggable

src/Semantic/Api/TOCSummaries.hs

@@ -15,7 +15,7 @@ import qualified Data.Vector as V
 import           Rendering.TOC
 import           Semantic.Api.Diffs
 import           Semantic.Api.Bridge
-import           Semantic.Api.V1.CodeAnalysisPB hiding (Blob, BlobPair)
+import           Semantic.Proto.SemanticPB hiding (Blob, BlobPair)
 import           Semantic.Task as Task
 import           Serializing.Format
 

src/Semantic/Api/Terms.hs

@@ -37,7 +37,7 @@ import           Rendering.Graph
 import           Rendering.JSON hiding (JSON)
 import qualified Rendering.JSON
 import           Semantic.Api.Bridge
-import           Semantic.Api.V1.CodeAnalysisPB hiding (Blob)
+import           Semantic.Proto.SemanticPB hiding (Blob)
 import           Semantic.Task
 import           Serializing.Format hiding (JSON)
 import qualified Serializing.Format as Format

src/Semantic/Api/V1/CodeAnalysisPB.hs renamed to src/Semantic/Proto/SemanticPB.hs

@@ -1,7 +1,7 @@
 -- Code generated by protoc-gen-haskell 0.1.0, DO NOT EDIT.
 {-# LANGUAGE DerivingVia, DeriveAnyClass, DuplicateRecordFields, PatternSynonyms #-}
 {-# OPTIONS_GHC -Wno-unused-imports -Wno-missing-export-lists #-}
-module Semantic.Api.V1.CodeAnalysisPB where
+module Semantic.Proto.SemanticPB where
 
 import           Control.DeepSeq
 import           Control.Monad (msum)