proto3 standard compatibility improvements

proto3-suite.cabal

@@ -34,7 +34,6 @@ library
                        Proto3.Suite.JSONPB
                        Proto3.Suite.Tutorial
                        Proto3.Suite.Types
-
                        Proto3.Suite.DotProto.Internal
                        Proto3.Suite.DotProto.Generate.Swagger
                        Proto3.Suite.JSONPB.Class

shell.nix

@@ -1 +1,10 @@
-(import ./release.nix {}).proto3-suite.env
+let fetchNixpkgs = import ./nix/fetchNixpkgs.nix;
+    nixpkgs = fetchNixpkgs {
+      rev = "fdfd5ab05444c38a006cb107d7d1ee8cb0b15719";
+      sha256 = "17hsjpjahl0hff3z2khrcwxygjyyrav2pia3qqlli0sgywfrgf95";
+    };
+    pkgs = import nixpkgs {};
+in
+  ((import ./release.nix {}).proto3-suite.env).overrideAttrs (super: rec {
+    buildInputs = super.buildInputs ++ [pkgs.wget pkgs.cacert];
+  })

src/Proto3/Suite/DotProto/AST.hs

@@ -342,6 +342,7 @@ data DotProtoMessagePart
   | DotProtoMessageOneOf DotProtoIdentifier [DotProtoField]
   | DotProtoMessageDefinition DotProtoDefinition
   | DotProtoMessageReserved   [DotProtoReservedField]
+  | DotProtoMessageOption DotProtoOption
   deriving (Show, Eq)
 
 instance Arbitrary DotProtoMessagePart where

src/Proto3/Suite/DotProto/Generate/Swagger.hs

@@ -83,7 +83,11 @@ instance {-# OVERLAPPING #-} (ToJSONKey k, ToSchema k) => ToSchema (OverrideToSc
           declareNamedSchema (Proxy :: Proxy [(k, (OverrideToSchema ByteString))])
     where
       schema_ = mempty
+#if MIN_VERSION_swagger2(2,4,0)
         & type_ ?~ SwaggerObject
+#else
+        & type_ .~ SwaggerObject
+#endif
         & additionalProperties ?~ AdditionalPropertiesSchema (Inline byteSchema)
 
 {-| This is a convenience function that uses type inference to select the

src/Proto3/Suite/DotProto/Parsing.hs

@@ -103,12 +103,10 @@ singleIdentifier = Single <$> token identifierName
 identifier :: ProtoParser DotProtoIdentifier
 identifier = token _identifier
 
--- [note] message and enum types are defined by the proto3 spec to have an optional leading period (messageType and enumType in the spec)
---        what this indicates is, as far as i can tell, not documented, and i haven't found this syntax used in practice
---        it's ommitted but can be fairly easily added if there is in fact a use for it
-
--- [update] the leading dot denotes that the identifier path starts in global scope
---          i still haven't seen a use case for this but i can add it upon request
+-- Parses a full identifier, consuming trailing space.
+-- The leading dot denotes that the identifier path starts in global scope.
+globalIdentifier :: ProtoParser DotProtoIdentifier
+globalIdentifier = token $ string "." >> _identifier
 
 -- Parses a nested identifier, consuming trailing space.
 nestedIdentifier :: ProtoParser DotProtoIdentifier
@@ -162,7 +160,7 @@ primType = try (symbol "double"   $> Double)
        <|> try (symbol "string"   $> String)
        <|> try (symbol "bytes"    $> Bytes)
        <|> try (symbol "bool"     $> Bool)
-       <|> Named <$> identifier
+       <|> Named <$> (identifier <|> globalIdentifier)
 
 --------------------------------------------------------------------------------
 -- top-level parser and version annotation
@@ -256,7 +254,7 @@ rpcOptions = braces $ many topOption
 
 rpcClause :: ProtoParser (DotProtoIdentifier, Streaming)
 rpcClause = do
-  let sid ctx = (,ctx) <$> identifier
+  let sid ctx = (,ctx) <$> (identifier <|> globalIdentifier)
   -- NB: Distinguish "stream stream.foo" from "stream.foo"
   try (symbol "stream" *> sid Streaming) <|> sid NonStreaming
 
@@ -296,6 +294,7 @@ messagePart = try (DotProtoMessageDefinition <$> enum)
           <|> try (DotProtoMessageDefinition <$> message)
           <|> try messageOneOf
           <|> try (DotProtoMessageField      <$> messageField)
+          <|> try (DotProtoMessageOption     <$> topOption)
 
 messageType :: ProtoParser DotProtoType
 messageType = try mapType <|> try repType <|> (Prim <$> primType)

src/Proto3/Suite/DotProto/Rendering.hs

@@ -129,6 +129,8 @@ prettyPrintProtoDefinition opts = defn where
     <+> (PP.hcat . PP.punctuate (PP.text ", ") $ pPrint <$> reservations)
     <>  PP.text ";"
   msgPart msgName (DotProtoMessageOneOf name fields)     = vbraces (PP.text "oneof" <+> pPrint name) (PP.vcat $ field msgName <$> fields)
+  msgPart _       (DotProtoMessageOption opt)
+    = PP.text "option" <+> pPrint opt <> PP.text ";"
 
   field :: DotProtoIdentifier -> DotProtoField -> PP.Doc
   field msgName (DotProtoField number mtype name options comments)

test-files/leading_dot/data.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+package LeadingDot.Rpc.Data;
+
+message Request {
+  uint32 hello = 1;
+}
+
+message Response {
+  uint32 world = 1;
+}