Sync with contract & more tests (phase 1)

[byeongsu-hong]

related #103 #18 #106 close #104 close #105

개선사항

• contracts 삭제
  • contracts를 삭제하고, 기존에 있던 bind generator를 외부 모듈로 분리했음.
  • contracts도 외부 모듈로 분리하였습니다. (airbloc/contracts, frostornge/solgen)
    • solgen
      • mockgen script를 추가해서 generate된 코드의 interface에 대한 mock을 자동으로 만들 수 있도록 했습니다.
        • 이게 좀 이상한 것 같은데, 혹시 다른 방법 알고 있으면 알려 주세요...
      • bind 내부의 structure를 IContract와 IManager로 나누어 추상화했습니다.
        • 원래는 사람이 이런짓을 하면 욕먹는게 당연한데, template으로 generate해주니까 너무 좋네여
        • IContract는 순수한 컨트랙트가 지원하는 함수들을 모두 넣은 인터페이스이고. (blockchain.client를 여기서 사용.)
        • IManager는 트랜잭션 객체가 아니라 컨트랙트에 정의된 값 그대로 리턴이 되게 정의된 함수들의 인터페이스입니다.
          • exchange.GetOffer(offerId types.ID) (types.Transcation, error) {} ← 이게 IContract
          • exchange.GetOffer(offerId types.ID) (types.Offer, error) {} ← IManager가 감싼거
        • 특이점은 모든 컴포넌트들은 filterer를 그래도 받아와 사용합니다. (event filter/parse/watch)
      • contract struct에 txHash와 createdAt과 같은 추가적인 정보를 넣었습니다.
      • 커스텀 타입을 정의해서 사용할 수 있게 되었습니다.
      • 지금 tuple을 custom struct로 바꾸는 과정에서 에러가 발생해서 해결중에 있습니다.
      • 나중에 더 발전시켜서 klaytn bind generator도 대응 가능할것 같은데, 어떻게 생각하는지 궁금합니당.
• adapter
  • 새롭게 제작된 contract의 bind로 adapter를 업데이트했습니다.
  • 바깥에 있던 모든 manager들을 adapter안에 포함시켰습니다.
  • 왜냐하면 bind로 생성된 interface를 공유하기 때문에 구현체를 같은 패키지 안에 넣는건 당연하다고 생각했습니다.
  • 지금까지 mocking으로 수월하게 api의 테스트를 짜게 될 수 있었던 가장 큰 이유는 interface기반의 작업이 있었기 때문이라고 생각합니다.
  • 따라서 관련 struct 구현체들은 전부 export 할 수 없도록 했습니다. 구현체를 직접 사용하게 될 경우 그것이 깨져서 테스트를 할 수 없게 되기 때문입니다.
• grpc-rest를 사용하지 않고 gin기반 http 서버를 사용합니다.
  • gin으로 라우팅을 하고, 그걸 http server에 물려서 바로 listen합니다.
  • listener 구조가 조금 바뀌어서 withErrorListener함수를 걷어내고 서로 다른 고루틴으로 돌립니다.
• provider/api
  • provider의 api를 모조리 restful하게 만들었습니다.
    • 기존에 있던 grpc api를 다 걷어냈습니다.
    • GET/DELETE는 query, POST/PUT/PATCH는 json을 사용했는데 form을 사용하는게 좋을지 궁금합니다.
    • 이 api들 모두 adapter에 있는 IManager를 사용합니다.
  • provider의 api들에 대한 테스트 추가
    • api에서 마저 실제 구조체가 아니라 인터페이스를 받아 사용하는 지경에 다다랐습니다.
    • 그래서 solgen에 자동 mock 생성 스크립트를 추가하고 이렇게 생성된 mock들로 테스트를 진행했습니다.
    • 거기에 gin.CreateTestContext로 만든 custom context에 리퀘스트 정보를 담아서 보내니까 너무 편했습니다.
  • api handler들의 visibility 수정
    • 모든 구현 method들의 visibility를 export 할 수 없도록 수정했습니다.
    • grpc를 사용했을때는 protobuf service interface의 조건을 만족하기 위해서 exported method를 사용했지만.
    • http(gin)을 사용해서 handler만 등록해주는 방식으로 바뀜과 동시에 바깥에서 사용될 가능성이 사라졌습니다.
    • 또한 위에서 설명한 이유도 있습니다. 테스트는 같은 패키지 안에 넣어 공개되지 않은 함수들도 테스트 할 수 있도록 했습니다.
    • export 되지 않는 함수들을 모두 다 수정하게 되었습니다.
• shared/types
  • 컨트랙트에 맞는 타입들을 추가했습니다. ex) Offer, Apps, Account... (feat. solgen)
  • 기존 struct{bundleId string, userId string, rowId string}이였던 DataID를 [20]byte로 바꾸고 나눌 수 있는 Id들은 getter로 뺐습니다.
    • 이 구조 개선으로 exchange에서 사용되던 dataId bytes[20]을types.DataID로 치환할 수 있게 되었습니다.
  • TBD

남은것들

1. e2e테스트가 남아있습니다. (pnc/ud test disabled)
2. adapter를 조금 더 개선해야합니다. (타입 문제가 자주 발생함) (solgen에서 개선 작업중)
3. test를 더 개선해야합니다.
4. data registry에 대한 고려가 없습니다.
5. merkle tree integration에 대한 고려가 없습니다.
6. consumer/controller 부분에 대한 개발이 남아있습니다.
7. warehouse에 대한 개발이 남아있습니다.
8. 전반적인 type모델 개선이 남아있습니다.
9. p2p에 대한 개선이 남아있습니다.