Error in generated Haskell file from latest `compile-proto-file` binary

Question

Error in generated Haskell file from latest `compile-proto-file` binary

nwaywood opened this issue 5 years ago · comments

I just finished doing the Arithmetic tutorial here https://github.com/awakesecurity/gRPC-haskell/blob/master/examples/tutorial/TUTORIAL.md

When I run it using the Arithmetic.hs file that was provided in the repo everything works perfectly.

However when I try and run it using a freshly generated Arithmetic.hs file from compile-proto-file, it fails to compile with the following error:

grpc-haskell> [1 of 2] Compiling Arithmetic
grpc-haskell>
grpc-haskell> /Users/nick/code/src/github.com/awakesecurity/gRPC-haskell/examples/tutorial/Arithmetic.hs:161:66: error:
grpc-haskell>     • Couldn't match expected type ‘Hs.Maybe
grpc-haskell>                                       (HsJSONPB.SwaggerType
grpc-haskell>                                          'swagger2-2.4:Data.Swagger.Internal.SwaggerKindSchema)’
grpc-haskell>                   with actual type ‘HsJSONPB.SwaggerType
grpc-haskell>                                       'swagger2-2.4:Data.Swagger.Internal.SwaggerKindSchema’
grpc-haskell>     • In the ‘_paramSchemaType’ field of a record
grpc-haskell>       In the ‘_schemaParamSchema’ field of a record
grpc-haskell>       In the ‘_namedSchemaSchema’ field of a record
grpc-haskell>     |
grpc-haskell> 161 |                                                                  HsJSONPB.SwaggerObject},
grpc-haskell>     |                                                                  ^^^^^^^^^^^^^^^^^^^^^^
grpc-haskell>
grpc-haskell> /Users/nick/code/src/github.com/awakesecurity/gRPC-haskell/examples/tutorial/Arithmetic.hs:216:66: error:
grpc-haskell>     • Couldn't match expected type ‘Hs.Maybe
grpc-haskell>                                       (HsJSONPB.SwaggerType
grpc-haskell>                                          'swagger2-2.4:Data.Swagger.Internal.SwaggerKindSchema)’
grpc-haskell>                   with actual type ‘HsJSONPB.SwaggerType
grpc-haskell>                                       'swagger2-2.4:Data.Swagger.Internal.SwaggerKindSchema’
grpc-haskell>     • In the ‘_paramSchemaType’ field of a record
grpc-haskell>       In the ‘_schemaParamSchema’ field of a record
grpc-haskell>       In the ‘_namedSchemaSchema’ field of a record
grpc-haskell>     |
grpc-haskell> 216 |                                                                  HsJSONPB.SwaggerObject},
grpc-haskell>     |                                                                  ^^^^^^^^^^^^^^^^^^^^^^
grpc-haskell>

If I manually edit the generated Arithmetic.hs file and change lines 161 and 216 from

HsJSONPB.SwaggerObject},

to

Hs.Just HsJSONPB.SwaggerObject},

It works again.

Gabriella Gonzalez · Answer 1 · Tue Feb 11 2020 02:16:19 GMT+0800 (China Standard Time)

@nwaywood: What version of proto3-suite are you using to obtain the compile-proto-file executable? The reason I ask is that I just attempted to update the Arithmetic.hs example from a recent proto3-suite revision and did not run into the problem that you described.

The only issue I found was a missing deepseq dependency which I have a pull request up to fix:

awakesecurity/gRPC-haskell#102

Nick Waywood · Answer 2 · Tue Feb 11 2020 06:57:52 GMT+0800 (China Standard Time)

I am on this commit 3f6dd6f

Gabriella Gonzalez · Answer 3 · Wed Feb 12 2020 00:44:32 GMT+0800 (China Standard Time)

@nwaywood: Hmmm, that's weird because I believe that I'm using that same revision, too. Could you attach the generated Arithmetic.hs that you got? I'll also double-check the version of compile-proto-file that I'm using

Nick Waywood · Answer 4 · Wed Feb 12 2020 07:28:37 GMT+0800 (China Standard Time)

Arithmetic.txt

Here is the Arithmetic file that is generated by running the command

compile-proto-file --proto arithmetic.proto --out .

from the tutorial directory (apologies for the file extension being .txt, I had to rename it from .hs to .txt for github to let me upload it).

Deepak Kapiswe · Answer 5 · Wed Apr 01 2020 21:01:49 GMT+0800 (China Standard Time)

@Gabriel439 I'm also getting a very similar error, I'm currently using the latest patch on master

proxyServer>     • Couldn't match expected type ‘Hs.Maybe
proxyServer>                                       (HsJSONPB.SwaggerType
proxyServer>                                          'swagger2-2.5:Data.Swagger.Internal.SwaggerKindSchema)’
proxyServer>                   with actual type ‘HsJSONPB.SwaggerType
proxyServer>                                       'swagger2-2.5:Data.Swagger.Internal.SwaggerKindSchema’
proxyServer>     • In the ‘_paramSchemaType’ field of a record
proxyServer>       In the ‘_schemaParamSchema’ field of a record
proxyServer>       In the ‘_namedSchemaSchema’ field of a record
proxyServer>       |
proxyServer> 17792 |                                                                  HsJSONPB.SwaggerObject},```

tim2CF · Answer 6 · Thu May 14 2020 00:55:48 GMT+0800 (China Standard Time)

I got the same error, tried to downgrade swagger to 2.3.1.1 and got different error

    * Impossible to have an instance HsJSONPB.ToSchema Hs.ByteString.
      Please, use a newtype wrapper around Hs.ByteString instead.
      Consider using byteSchema or binarySchema templates.
    * In the expression: HsJSONPB.declareSchemaRef
      In an equation for `declare_dest_custom_records':
          declare_dest_custom_records = HsJSONPB.declareSchemaRef
      In the expression:
        do let declare_dest = HsJSONPB.declareSchemaRef
           sendRequestDest <- declare_dest Proxy.Proxy
           let declare_dest_string = HsJSONPB.declareSchemaRef
           sendRequestDestString <- declare_dest_string Proxy.Proxy
           ....
     |
2417 |       let declare_dest_custom_records = HsJSONPB.declareSchemaRef
     |                                         ^^^^^^^^^^^^^^^^^^^^^^^^^

tim2CF · Answer 7 · Thu May 14 2020 02:10:54 GMT+0800 (China Standard Time)

@Gabriel439 I see some code in proto3-suite related to this bug (ToSchema instance of ByteString), but seems it's not working in my case. What do you think, how I can workaround it?

tim2CF · Answer 8 · Thu May 14 2020 02:46:46 GMT+0800 (China Standard Time)

I actually know which types are causing these errors, here is example
https://github.com/lightningnetwork/lnd/blob/1bd211a7228d2f13ecaf514f611738837c057d94/lnrpc/rpc.proto#L840

tim2CF · Answer 9 · Fri May 15 2020 17:57:05 GMT+0800 (China Standard Time)

Not sure it is right solution or not, but I worked it around with this orphan instance
https://github.com/coingaming/lnd-client/blob/d6971ae41da8c8112a65b805ba49106bcad3edf6/src/LndGrpc/Orphans.hs#L11-L12

Nick Waywood · Answer 10 · Tue Sep 01 2020 13:57:29 GMT+0800 (China Standard Time)

I just updated to the latest version of the compile-proto-file binary and can confirm that I now have the same issue as @tim2CF, his solution here solves it for me as well.

This is the only issue I am now having with the latest binary, the original issue is no longer happening :)

Gabriella Gonzalez · Answer 11 · Wed Sep 02 2020 06:09:33 GMT+0800 (China Standard Time)

Fix is up here: #140

Nick Waywood · Answer 12 · Thu Sep 03 2020 11:35:04 GMT+0800 (China Standard Time)

@Gabriel439 I just tried #140 and I am still getting the error described here

Nick Waywood · Answer 13 · Fri Sep 04 2020 07:39:41 GMT+0800 (China Standard Time)

In case some more detail may be useful for you...

This is the snippet of code that I need to add to one of the generated hs files in my project to make it work.

And as @tim2CF mentioned, I am assuming that the reason why I'm only having issues with that generated file and none of my other ones is because that source proto file contains a map type

Gabriella Gonzalez · Answer 14 · Sat Sep 05 2020 00:51:47 GMT+0800 (China Standard Time)

@nwaywood: I think I will need more detailed reproduction instructions, because I'm no longer able to reproduce the problem for the Arithmetic.hs file on master

Nick Waywood · Answer 15 · Mon Sep 07 2020 08:44:02 GMT+0800 (China Standard Time)

@Gabriel439 yes I don't think the issue will happen with the Arithmetic.hs file anymore since the issue seems to be with the map type (map documentation) and Arithmetic.proto contains no map types.

If you don't mind using my project, https://github.com/hyperledger-labs/fabric-chaincode-haskell, then reproduction is very easy.

git clone git@github.com:hyperledger-labs/fabric-chaincode-haskell.git
cd fabric-chaincode-haskell/protos
./generate.sh
cd ..
stack build

The stack build will fail on an error similar to the one @tim2CF described here. In the case of my project, it is failing due to this map type and I currently fix it manually by adding the code as described in my readme