A peer-to-peer stack for code collaboration
Remove 'Radicle.Internal.MachineBackend.Ipfs'
Thomas Scholtes27ad0ece164f
diff --git a/src/Radicle/Daemon/Ipfs.hs b/src/Radicle/Daemon/Ipfs.hsindex f6a2be6..4af866d 100644--- a/src/Radicle/Daemon/Ipfs.hs+++ b/src/Radicle/Daemon/Ipfs.hs@@ -4,12 +4,12 @@ module Radicle.Daemon.Ipfs, InputsApplied(..), SubmitInputs(..), writeIpfs- , Radicle.Daemon.Ipfs.publish+ , publish, ipnsPublish, machineInputsFrom, createMachine- , Ipfs.MachineEntryIndex, emptyMachineEntryIndex+ , MachineEntryIndex, TopicSubscription, initSubscription, subscribeOne@@ -25,13 +25,13 @@ import Control.Monad.Failimport Data.Aeson (decodeStrict, (.:), (.=))import qualified Data.Aeson as Aesonimport qualified Data.Aeson.Types as Aeson+import Data.IPLD.CIDimport qualified Data.Map.Strict as Map-import qualified Data.Sequence as Seq+import qualified Data.Text as Timport qualified Data.Unique as Uniqueimport System.Timeoutimport Radicle.Internal.Core-import qualified Radicle.Internal.MachineBackend.Ipfs as Ipfsimport Radicle.Internal.Parseimport Radicle.Internal.Prettyimport qualified Radicle.Internal.UUID as UUID@@ -102,13 +102,66 @@ data SubmitInputs = SubmitInputs, expressions :: [Value]}++-- | A node in the linked list of inputs of a machine.+--+-- Stored as an IPLD document with the IPFS DAG API. The document has+-- the following shape+-- @+-- {+-- "expressions": [+-- "(def foo :hey)",+-- "(get-value)"+-- ],+-- "previous": { "/": "QmA..." }+-- }+-- @+data MachineEntry = MachineEntry+ { entryExpressions :: [Value]+ , entryPrevious :: CID+ } deriving (Eq, Show, Read, Generic)++instance Aeson.FromJSON MachineEntry where+ parseJSON = Aeson.withObject "MachineEntry" $ \o -> do+ expressionCode <- o .: "expression"+ let src = "[ipfs]"+ entryExpressions <-+ case parseValues src expressionCode of+ Left err -> fail $ "failed to parse Radicle expression: " <> show err+ Right v -> pure v+ entryPrevious <- Ipfs.parseIpldLink =<< o .: "previous"+ pure MachineEntry {..}++instance Aeson.ToJSON MachineEntry where+ toJSON MachineEntry{..} =+ let code = T.intercalate "\n" $ map renderCompactPretty entryExpressions+ in Aeson.object+ [ "expression" .= code+ , "previous" .= Ipfs.ipldLink entryPrevious+ ]++-- | Identifies a 'MachineEntry' stored on IPFS. Wraps 'CID'.+newtype MachineEntryIndex = MachineEntryIndex CID+ deriving (Show, Eq)++instance Aeson.ToJSON MachineEntryIndex where+ toJSON (MachineEntryIndex cid) = Ipfs.ipldLink cid++instance Aeson.FromJSON MachineEntryIndex where+ parseJSON = fmap MachineEntryIndex . Ipfs.parseIpldLink++-- * Ipfs helpers-- | Write and pin some inputs to an IPFS machine.-- TODO: we might want to make this safer by taking the expected head-- MachineEntryIndex as an argument.-writeIpfs :: MachineId -> [Value] -> IO Ipfs.MachineEntryIndex-writeIpfs (MachineId id) vs = Ipfs.sendIpfs id (Seq.fromList vs)+writeIpfs :: MachineId -> [Value] -> IO MachineEntryIndex+writeIpfs (MachineId ipnsId) values = do+ Ipfs.NameResolveResponse cid <- Ipfs.nameResolve ipnsId+ Ipfs.DagPutResponse newEntryCid <- Ipfs.dagPut $ MachineEntry values cid+ Ipfs.namePublish ipnsId $ Ipfs.AddressIpfs newEntryCid+ pure $ MachineEntryIndex newEntryCidnewtype Topic = Topic { getTopic :: Text }@@ -129,9 +182,42 @@ subscribeForever id messageHandler = Ipfs.subscribe topic pubsubHandlerJust msg -> Right msgNothing -> Left (toS messageData)--- | Get and pin inputs of an IPFS machine from a certain index.-machineInputsFrom :: MachineId -> Maybe Ipfs.MachineEntryIndex -> IO (Ipfs.MachineEntryIndex, [Value])-machineInputsFrom = Ipfs.receiveIpfs . getMachineId+-- | Get inputs of an IPFS machine from least to most recent.+--+-- The returned 'Ipfs.MachineEntryIndex' is the index of the most+-- recent input.+--+-- If @maybeFrom@ is @Just index@ all inputs after (but not+-- including) @index@ are returned. Otherwise all inputs are returned.+machineInputsFrom :: MachineId -> Maybe MachineEntryIndex -> IO (MachineEntryIndex, [Value])+machineInputsFrom (MachineId ipnsId) maybeFrom = do+ let MachineEntryIndex fromCid = fromMaybe (MachineEntryIndex emptyMachineCid) maybeFrom+ Ipfs.NameResolveResponse cid <- Ipfs.nameResolve ipnsId+ blocks <- getBlocks cid fromCid+ pure $ (MachineEntryIndex cid, blocks)+ where+ getBlocks :: CID -> CID -> IO [Value]+ getBlocks cid fromCid = do+ if cid == fromCid || cid == emptyMachineCid+ then pure []+ else do+ let addr = Ipfs.AddressIpfs cid+ entry <- Ipfs.dagGet addr+ _ <- Ipfs.pinAdd addr+ rest <- getBlocks (entryPrevious entry) fromCid+ pure $ rest <> entryExpressions entry+++-- | If a machine points to this ID then its log is considered empty.+-- The first entry in a machine log also points to this entry.+--+-- This is the CID produced by the document @{"radicle": true}@.+emptyMachineCid :: CID+emptyMachineCid =+ case cidFromText "zdpuAyyGtvC37aeZid2zh7LAGKCbFTn9MzdqoPpbNQm3BCwWT" of+ Left e -> panic $ toS e+ Right cid -> cid+-- | Create an IPFS machine and return its ID.--@@ -141,13 +227,13 @@ createMachine :: IO MachineIdcreateMachine = douuid <- UUID.uuidIpfs.KeyGenResponse ipnsId <- Ipfs.keyGen uuid- Ipfs.namePublish ipnsId $ Ipfs.AddressIpfs Ipfs.emptyMachineCid+ Ipfs.namePublish ipnsId $ Ipfs.AddressIpfs emptyMachineCidpure $ MachineId ipnsId-- | Publish to IPNS a machine entry index for a machine. Should only be issued-- by the writer.-ipnsPublish :: MachineId -> Ipfs.MachineEntryIndex -> IO ()-ipnsPublish id (Ipfs.MachineEntryIndex cid) = Ipfs.namePublish (getMachineId id) $ Ipfs.AddressIpfs cid+ipnsPublish :: MachineId -> MachineEntryIndex -> IO ()+ipnsPublish id (MachineEntryIndex cid) = Ipfs.namePublish (getMachineId id) $ Ipfs.AddressIpfs cid-- * Topic subscriptions@@ -204,5 +290,5 @@ subscribeOne subscription t matchMessage = do(removeHandler subscription)(\_ -> readMVar msgVar)-emptyMachineEntryIndex :: Ipfs.MachineEntryIndex-emptyMachineEntryIndex = Ipfs.MachineEntryIndex Ipfs.emptyMachineCid+emptyMachineEntryIndex :: MachineEntryIndex+emptyMachineEntryIndex = MachineEntryIndex emptyMachineCiddiff --git a/src/Radicle/Internal/MachineBackend/Ipfs.hs b/src/Radicle/Internal/MachineBackend/Ipfs.hsdeleted file mode 100644index 69d614b..0000000--- a/src/Radicle/Internal/MachineBackend/Ipfs.hs+++ /dev/null@@ -1,102 +0,0 @@--- | This module implements an IPFS machine backend.------ Radicle Machines are identified by IPNS IDs. The IPNS ID of a--- machine points to a linked list of expressions encoded as content--- addressed IPLD documents and stored in IPFS’s DAG API. The nodes of--- linked lists are represented by 'MachineEntry'. The corresponding--- IPLD documents have the following shape.--- @--- {--- "expressions": [--- "(def foo :hey)",--- "(get-value)"--- ],--- "previous": { "/": "QmA..." }--- }--- @----module Radicle.Internal.MachineBackend.Ipfs where--import Protolude hiding (catch, try)--import Control.Monad.Fail-import Data.Aeson (FromJSON, ToJSON, (.:), (.=))-import qualified Data.Aeson as Aeson-import Data.IPLD.CID--import Radicle.Internal.Core-import Radicle.Internal.Parse-import Radicle.Internal.Pretty-import qualified Radicle.Ipfs as Ipfs--newtype MachineEntryIndex = MachineEntryIndex CID- deriving (Show, Eq)--instance Aeson.ToJSON MachineEntryIndex where- toJSON (MachineEntryIndex cid) = Ipfs.ipldLink cid--instance Aeson.FromJSON MachineEntryIndex where- parseJSON = fmap MachineEntryIndex . Ipfs.parseIpldLink---- | Write and pin a sequence of expressions to a machine.-sendIpfs :: Ipfs.IpnsId -> Seq Value -> IO MachineEntryIndex-sendIpfs ipnsId values = do- Ipfs.NameResolveResponse cid <- Ipfs.nameResolve ipnsId- Ipfs.DagPutResponse newEntryCid <- Ipfs.dagPut $ MachineEntry (toList values) cid- Ipfs.namePublish ipnsId $ Ipfs.AddressIpfs newEntryCid- pure $ MachineEntryIndex newEntryCid---- | Get a sequence of expressions from a machine, starting from an entry--- index. Pins the received expressions.-receiveIpfs :: Ipfs.IpnsId -> Maybe MachineEntryIndex -> IO (MachineEntryIndex, [Value])-receiveIpfs ipnsId maybeFrom = do- let MachineEntryIndex fromCid = fromMaybe (MachineEntryIndex emptyMachineCid) maybeFrom- Ipfs.NameResolveResponse cid <- Ipfs.nameResolve ipnsId- blocks <- getBlocks cid fromCid- pure $ (MachineEntryIndex cid, blocks)- where- getBlocks :: CID -> CID -> IO [Value]- getBlocks cid fromCid = do- if cid == fromCid || cid == emptyMachineCid- then pure []- else do- let addr = Ipfs.AddressIpfs cid- entry <- Ipfs.dagGet addr- _ <- Ipfs.pinAdd addr- rest <- getBlocks (entryPrevious entry) fromCid- pure $ rest <> entryExpressions entry---- | If a machine points to this ID then its log is considered empty.--- The first entry in a machine log also points to this entry.------ This is the CID produced by the document @{"radicle": true}@.-emptyMachineCid :: CID-emptyMachineCid =- case cidFromText "zdpuAyyGtvC37aeZid2zh7LAGKCbFTn9MzdqoPpbNQm3BCwWT" of- Left e -> panic $ toS e- Right cid -> cid---- | A node in the linked list of expressions of a machine.-data MachineEntry = MachineEntry- { entryExpressions :: [Value]- , entryPrevious :: CID- } deriving (Eq, Show, Read, Generic)--instance FromJSON MachineEntry where- parseJSON = Aeson.withObject "MachineEntry" $ \o -> do- expressionCodes <- o .: "expressions"- let src = "[ipfs]"- entryExpressions :: [Value] <-- case traverse (parse src) expressionCodes of- Left err -> fail $ "failed to parse Radicle expression: " <> show err- Right v -> pure v- entryPrevious <- Ipfs.parseIpldLink =<< o .: "previous"- pure MachineEntry {..}--instance ToJSON MachineEntry where- toJSON MachineEntry{..} =- let code = map renderCompactPretty entryExpressions- in Aeson.object- [ "expressions" .= code- , "previous" .= Ipfs.ipldLink entryPrevious- ]