mu-kafka (empty) → 0.3.0.0
raw patch · 7 files changed
+473/−0 lines, 7 filesdep +avrodep +basedep +bytestringsetup-changed
Dependencies added: avro, base, bytestring, conduit, hw-kafka-client, hw-kafka-conduit, mu-avro, mu-schema, resourcet
Files
- LICENSE +202/−0
- README.md +3/−0
- Setup.hs +2/−0
- mu-kafka.cabal +42/−0
- src/Mu/Kafka/Consumer.hs +87/−0
- src/Mu/Kafka/Internal.hs +29/−0
- src/Mu/Kafka/Producer.hs +108/−0
+ LICENSE view
@@ -0,0 +1,202 @@++ Apache License+ Version 2.0, January 2004+ http://www.apache.org/licenses/++ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++ 1. Definitions.++ "License" shall mean the terms and conditions for use, reproduction,+ and distribution as defined by Sections 1 through 9 of this document.++ "Licensor" shall mean the copyright owner or entity authorized by+ the copyright owner that is granting the License.++ "Legal Entity" shall mean the union of the acting entity and all+ other entities that control, are controlled by, or are under common+ control with that entity. For the purposes of this definition,+ "control" means (i) the power, direct or indirect, to cause the+ direction or management of such entity, whether by contract or+ otherwise, or (ii) ownership of fifty percent (50%) or more of the+ outstanding shares, or (iii) beneficial ownership of such entity.++ "You" (or "Your") shall mean an individual or Legal Entity+ exercising permissions granted by this License.++ "Source" form shall mean the preferred form for making modifications,+ including but not limited to software source code, documentation+ source, and configuration files.++ "Object" form shall mean any form resulting from mechanical+ transformation or translation of a Source form, including but+ not limited to compiled object code, generated documentation,+ and conversions to other media types.++ "Work" shall mean the work of authorship, whether in Source or+ Object form, made available under the License, as indicated by a+ copyright notice that is included in or attached to the work+ (an example is provided in the Appendix below).++ "Derivative Works" shall mean any work, whether in Source or Object+ form, that is based on (or derived from) the Work and for which the+ editorial revisions, annotations, elaborations, or other modifications+ represent, as a whole, an original work of authorship. For the purposes+ of this License, Derivative Works shall not include works that remain+ separable from, or merely link (or bind by name) to the interfaces of,+ the Work and Derivative Works thereof.++ "Contribution" shall mean any work of authorship, including+ the original version of the Work and any modifications or additions+ to that Work or Derivative Works thereof, that is intentionally+ submitted to Licensor for inclusion in the Work by the copyright owner+ or by an individual or Legal Entity authorized to submit on behalf of+ the copyright owner. For the purposes of this definition, "submitted"+ means any form of electronic, verbal, or written communication sent+ to the Licensor or its representatives, including but not limited to+ communication on electronic mailing lists, source code control systems,+ and issue tracking systems that are managed by, or on behalf of, the+ Licensor for the purpose of discussing and improving the Work, but+ excluding communication that is conspicuously marked or otherwise+ designated in writing by the copyright owner as "Not a Contribution."++ "Contributor" shall mean Licensor and any individual or Legal Entity+ on behalf of whom a Contribution has been received by Licensor and+ subsequently incorporated within the Work.++ 2. Grant of Copyright License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ copyright license to reproduce, prepare Derivative Works of,+ publicly display, publicly perform, sublicense, and distribute the+ Work and such Derivative Works in Source or Object form.++ 3. Grant of Patent License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ (except as stated in this section) patent license to make, have made,+ use, offer to sell, sell, import, and otherwise transfer the Work,+ where such license applies only to those patent claims licensable+ by such Contributor that are necessarily infringed by their+ Contribution(s) alone or by combination of their Contribution(s)+ with the Work to which such Contribution(s) was submitted. If You+ institute patent litigation against any entity (including a+ cross-claim or counterclaim in a lawsuit) alleging that the Work+ or a Contribution incorporated within the Work constitutes direct+ or contributory patent infringement, then any patent licenses+ granted to You under this License for that Work shall terminate+ as of the date such litigation is filed.++ 4. Redistribution. You may reproduce and distribute copies of the+ Work or Derivative Works thereof in any medium, with or without+ modifications, and in Source or Object form, provided that You+ meet the following conditions:++ (a) You must give any other recipients of the Work or+ Derivative Works a copy of this License; and++ (b) You must cause any modified files to carry prominent notices+ stating that You changed the files; and++ (c) You must retain, in the Source form of any Derivative Works+ that You distribute, all copyright, patent, trademark, and+ attribution notices from the Source form of the Work,+ excluding those notices that do not pertain to any part of+ the Derivative Works; and++ (d) If the Work includes a "NOTICE" text file as part of its+ distribution, then any Derivative Works that You distribute must+ include a readable copy of the attribution notices contained+ within such NOTICE file, excluding those notices that do not+ pertain to any part of the Derivative Works, in at least one+ of the following places: within a NOTICE text file distributed+ as part of the Derivative Works; within the Source form or+ documentation, if provided along with the Derivative Works; or,+ within a display generated by the Derivative Works, if and+ wherever such third-party notices normally appear. The contents+ of the NOTICE file are for informational purposes only and+ do not modify the License. You may add Your own attribution+ notices within Derivative Works that You distribute, alongside+ or as an addendum to the NOTICE text from the Work, provided+ that such additional attribution notices cannot be construed+ as modifying the License.++ You may add Your own copyright statement to Your modifications and+ may provide additional or different license terms and conditions+ for use, reproduction, or distribution of Your modifications, or+ for any such Derivative Works as a whole, provided Your use,+ reproduction, and distribution of the Work otherwise complies with+ the conditions stated in this License.++ 5. Submission of Contributions. Unless You explicitly state otherwise,+ any Contribution intentionally submitted for inclusion in the Work+ by You to the Licensor shall be under the terms and conditions of+ this License, without any additional terms or conditions.+ Notwithstanding the above, nothing herein shall supersede or modify+ the terms of any separate license agreement you may have executed+ with Licensor regarding such Contributions.++ 6. Trademarks. This License does not grant permission to use the trade+ names, trademarks, service marks, or product names of the Licensor,+ except as required for reasonable and customary use in describing the+ origin of the Work and reproducing the content of the NOTICE file.++ 7. Disclaimer of Warranty. Unless required by applicable law or+ agreed to in writing, Licensor provides the Work (and each+ Contributor provides its Contributions) on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+ implied, including, without limitation, any warranties or conditions+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+ PARTICULAR PURPOSE. You are solely responsible for determining the+ appropriateness of using or redistributing the Work and assume any+ risks associated with Your exercise of permissions under this License.++ 8. Limitation of Liability. In no event and under no legal theory,+ whether in tort (including negligence), contract, or otherwise,+ unless required by applicable law (such as deliberate and grossly+ negligent acts) or agreed to in writing, shall any Contributor be+ liable to You for damages, including any direct, indirect, special,+ incidental, or consequential damages of any character arising as a+ result of this License or out of the use or inability to use the+ Work (including but not limited to damages for loss of goodwill,+ work stoppage, computer failure or malfunction, or any and all+ other commercial damages or losses), even if such Contributor+ has been advised of the possibility of such damages.++ 9. Accepting Warranty or Additional Liability. While redistributing+ the Work or Derivative Works thereof, You may choose to offer,+ and charge a fee for, acceptance of support, warranty, indemnity,+ or other liability obligations and/or rights consistent with this+ License. However, in accepting such obligations, You may act only+ on Your own behalf and on Your sole responsibility, not on behalf+ of any other Contributor, and only if You agree to indemnify,+ defend, and hold each Contributor harmless for any liability+ incurred by, or claims asserted against, such Contributor by reason+ of your accepting any such warranty or additional liability.++ END OF TERMS AND CONDITIONS++ APPENDIX: How to apply the Apache License to your work.++ To apply the Apache License to your work, attach the following+ boilerplate notice, with the fields enclosed by brackets "[]"+ replaced with your own identifying information. (Don't include+ the brackets!) The text should be enclosed in the appropriate+ comment syntax for the file format. We also recommend that a+ file or class name and description of purpose be included on the+ same "printed page" as the copyright notice for easier+ identification within third-party archives.++ Copyright © 2019-2020 47 Degrees. <http://47deg.com>++ Licensed under the Apache License, Version 2.0 (the "License");+ you may not use this file except in compliance with the License.+ You may obtain a copy of the License at++ http://www.apache.org/licenses/LICENSE-2.0++ Unless required by applicable law or agreed to in writing, software+ distributed under the License is distributed on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ See the License for the specific language governing permissions and+ limitations under the License.
+ README.md view
@@ -0,0 +1,3 @@+# mu-kafka++This are some utilities to integrate easily with Kafka while using Mu.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ mu-kafka.cabal view
@@ -0,0 +1,42 @@+name: mu-kafka+version: 0.3.0.0+synopsis: Utilities for interoperation between Mu and Kafka+description:+ This package provides simple interoperation between Mu and Kafka using @hw-kafka-client@++homepage: https://github.com/higherkindness/mu-haskell+license: Apache-2.0+license-file: LICENSE+author: Alejandro Serrano, Flavio Corpa+maintainer: alejandro.serrano@47deg.com+copyright: Copyright © 2020 <http://47deg.com 47 Degrees>+category: Network+build-type: Simple+cabal-version: >=1.10+extra-source-files: README.md+bug-reports: https://github.com/higherkindness/mu-haskell/issues++source-repository head+ type: git+ location: https://github.com/higherkindness/mu-haskell++library+ exposed-modules:+ Mu.Kafka.Consumer+ Mu.Kafka.Producer++ other-modules: Mu.Kafka.Internal+ hs-source-dirs: src+ default-language: Haskell2010+ build-depends:+ avro >=0.5+ , base >=4.7 && <5+ , bytestring+ , conduit+ , hw-kafka-client+ , hw-kafka-conduit+ , mu-avro >=0.3.0+ , mu-schema >=0.3.0+ , resourcet++ ghc-options: -Wall
+ src/Mu/Kafka/Consumer.hs view
@@ -0,0 +1,87 @@+{-# language FlexibleContexts #-}+{-# language TypeFamilies #-}+{-# language TypeOperators #-}+{-|+Description : Kafka consumers as streams of Mu terms++This module allows you to receive values from+a Kafka topic, and treat then as Mu terms, or+your Haskell types if a conversion exists.++This module is a wrapper over 'Kafka.Conduit.Source'+from the (awesome) package @hw-kafka-client@.+-}+module Mu.Kafka.Consumer (+ kafkaSource+, kafkaSourceNoClose+, kafkaSourceAutoClose+, module X+) where++import Conduit (mapC)+import Control.Monad.IO.Class+import Control.Monad.Trans.Resource+import qualified Data.Avro as A+import Data.ByteString+import Data.Conduit+import Mu.Schema++import qualified Kafka.Conduit.Source as S++import Kafka.Conduit.Combinators as X+import Kafka.Consumer as X++import Mu.Kafka.Internal++fromCR+ :: ( FromSchema sch sty t+ , A.FromAvro (WithSchema sch sty t)+ , A.HasAvroSchema (WithSchema sch sty t) )+ => Proxy sch+ -> ConsumerRecord (Maybe ByteString) (Maybe ByteString)+ -> ConsumerRecord (Maybe ByteString) (Maybe t)+fromCR proxy (ConsumerRecord t p o ts k v)+ = ConsumerRecord t p o ts k (v >>= fromBS proxy)++-- | Creates a kafka producer for given properties and returns a `Source`.+--+-- This method of creating a `Source` represents a simple case+-- and does not provide access to `KafkaProducer`. For more complex scenarious+-- 'kafkaSinkNoClose' or 'kafkaSinkAutoClose' can be used.+kafkaSource+ :: ( MonadResource m+ , FromSchema sch sty t+ , A.FromAvro (WithSchema sch sty t)+ , A.HasAvroSchema (WithSchema sch sty t) )+ => Proxy sch+ -> ConsumerProperties -> Subscription -> Timeout+ -> ConduitT () (Either KafkaError (ConsumerRecord (Maybe ByteString) (Maybe t))) m ()+kafkaSource proxy props sub ts =+ S.kafkaSource props sub ts .| mapC (fmap (fromCR proxy))++-- | Create a `Source` for a given `KafkaConsumer`.+-- The consumer will NOT be closed automatically when the `Source` is closed.+kafkaSourceNoClose+ :: ( MonadIO m+ , FromSchema sch sty t+ , A.FromAvro (WithSchema sch sty t)+ , A.HasAvroSchema (WithSchema sch sty t) )+ => Proxy sch+ -> KafkaConsumer -> Timeout+ -> ConduitT () (Either KafkaError (ConsumerRecord (Maybe ByteString) (Maybe t))) m ()+kafkaSourceNoClose proxy c t+ = S.kafkaSourceNoClose c t .| mapC (fmap (fromCR proxy))+++-- | Create a `Source` for a given `KafkaConsumer`.+-- The consumer will be closed automatically when the `Source` is closed.+kafkaSourceAutoClose+ :: ( MonadResource m+ , FromSchema sch sty t+ , A.FromAvro (WithSchema sch sty t)+ , A.HasAvroSchema (WithSchema sch sty t) )+ => Proxy sch+ -> KafkaConsumer -> Timeout+ -> ConduitT () (Either KafkaError (ConsumerRecord (Maybe ByteString) (Maybe t))) m ()+kafkaSourceAutoClose proxy c t+ = S.kafkaSourceAutoClose c t .| mapC (fmap (fromCR proxy))
+ src/Mu/Kafka/Internal.hs view
@@ -0,0 +1,29 @@+{-# language FlexibleContexts #-}+{-# language ScopedTypeVariables #-}+{-# language TypeApplications #-}+{-# language TypeFamilies #-}+{-# language TypeOperators #-}+module Mu.Kafka.Internal where++import qualified Data.Avro as A+import Data.ByteString+import Data.ByteString.Lazy (fromStrict, toStrict)++import Mu.Schema++toBS :: forall sch sty t.+ ( ToSchema sch sty t+ , A.HasAvroSchema (WithSchema sch sty t)+ , A.ToAvro (WithSchema sch sty t) )+ => Proxy sch -> t -> ByteString+toBS _ = toStrict . A.encodeValue . WithSchema @_ @_ @sch @sty @t++fromBS :: forall sch sty t.+ ( FromSchema sch sty t+ , A.FromAvro (WithSchema sch sty t)+ , A.HasAvroSchema (WithSchema sch sty t) )+ => Proxy sch -> ByteString -> Maybe t+fromBS _ x = unWithSchema @_ @_ @sch @sty @t <$> resultToMaybe (A.decodeValue (fromStrict x))+ where+ resultToMaybe (Left _) = Nothing+ resultToMaybe (Right y) = Just y
+ src/Mu/Kafka/Producer.hs view
@@ -0,0 +1,108 @@+{-# language DeriveGeneric #-}+{-# language FlexibleContexts #-}+{-# language TypeFamilies #-}+{-# language TypeOperators #-}+{-|+Description : streams of Mu terms as Kafka producers++This module allows you to open a "sink" to Kafka.+Every value you sent to the sink will be sent over+to the corresponding Kafka instance.++This module is a wrapper over 'Kafka.Conduit.Sink'+from the (awesome) package @hw-kafka-client@.+-}+module Mu.Kafka.Producer (+ ProducerRecord'(..)+, kafkaSink+, kafkaSinkAutoClose+, kafkaSinkNoClose+, kafkaBatchSinkNoClose+, module X+) where++import Conduit (mapC)+import Control.Monad.IO.Class+import Control.Monad.Trans.Resource+import qualified Data.Avro as A+import Data.ByteString+import Data.Conduit+import Data.Typeable+import GHC.Generics+import Mu.Schema++import qualified Kafka.Conduit.Sink as S+import Kafka.Producer (ProducerRecord (..))++import Kafka.Conduit.Combinators as X+import Kafka.Consumer as X (KafkaConsumer)+import Kafka.Producer as X (KafkaError, KafkaProducer, ProducePartition,+ ProducerProperties, TopicName)++import Mu.Kafka.Internal++data ProducerRecord' k v = ProducerRecord'+ { prTopic :: !TopicName+ , prPartition :: !ProducePartition+ , prKey :: Maybe k+ , prValue :: Maybe v+ } deriving (Eq, Show, Typeable, Generic)++toPR+ :: ( ToSchema sch sty t+ , A.ToAvro (WithSchema sch sty t)+ , A.HasAvroSchema (WithSchema sch sty t) )+ => Proxy sch -> ProducerRecord' ByteString t -> ProducerRecord+toPR proxy (ProducerRecord' t p k v)+ = ProducerRecord t p k (toBS proxy <$> v)++-- | Creates a kafka producer for given properties and returns a Sink.+--+-- This method of creating a Sink represents a simple case+-- and does not provide access to `KafkaProducer`. For more complex scenarious+-- 'kafkaSinkAutoClose' or 'kafkaSinkNoClose' can be used.+kafkaSink+ :: ( MonadResource m+ , ToSchema sch sty t+ , A.ToAvro (WithSchema sch sty t)+ , A.HasAvroSchema (WithSchema sch sty t) )+ => Proxy sch -> X.ProducerProperties+ -> ConduitT (ProducerRecord' ByteString t) Void m (Maybe KafkaError)+kafkaSink proxy prod+ = mapC (toPR proxy) .| S.kafkaSink prod++-- | Creates a Sink for a given `KafkaProducer`.+-- The producer will be closed when the Sink is closed.+kafkaSinkAutoClose+ :: ( MonadResource m+ , ToSchema sch sty t+ , A.ToAvro (WithSchema sch sty t)+ , A.HasAvroSchema (WithSchema sch sty t) )+ => Proxy sch -> KafkaProducer+ -> ConduitT (ProducerRecord' ByteString t) Void m (Maybe X.KafkaError)+kafkaSinkAutoClose proxy prod+ = mapC (toPR proxy) .| S.kafkaSinkAutoClose prod++-- | Creates a Sink for a given `KafkaProducer`.+-- The producer will NOT be closed automatically.+kafkaSinkNoClose+ :: ( MonadIO m+ , ToSchema sch sty t+ , A.ToAvro (WithSchema sch sty t)+ , A.HasAvroSchema (WithSchema sch sty t) )+ => Proxy sch -> KafkaProducer+ -> ConduitT (ProducerRecord' ByteString t) Void m (Maybe X.KafkaError)+kafkaSinkNoClose proxy prod+ = mapC (toPR proxy) .| S.kafkaSinkNoClose prod++-- | Creates a batching Sink for a given `KafkaProducer`.+-- The producer will NOT be closed automatically.+kafkaBatchSinkNoClose+ :: ( MonadIO m+ , ToSchema sch sty t+ , A.ToAvro (WithSchema sch sty t)+ , A.HasAvroSchema (WithSchema sch sty t) )+ => Proxy sch -> KafkaProducer+ -> ConduitT [ProducerRecord' ByteString t] Void m [(ProducerRecord, KafkaError)]+kafkaBatchSinkNoClose proxy prod+ = mapC (fmap (toPR proxy)) .| S.kafkaBatchSinkNoClose prod