Merge pull request #383 from haskell-distributed/monorepo-structure

Monorepo structure and cleanup

Author: LaurentRDC

.github/workflows/cabal.yml

@@ -0,0 +1,60 @@
+name: Continuous integration
+
+on:
+  push:
+    paths-ignore:
+      - 'website/*/**'
+      - 'README.md'
+  pull_request:
+
+jobs:
+  continuous-integration:
+    strategy:
+      fail-fast: false
+      matrix:
+        ghc-version:
+          - "8.10.7"
+          - "9.0.2"
+          - "9.2.8"
+          - "9.4.5"
+          - "9.6.4"
+          - "9.8.2"
+          - "9.10.1"
+        operating-system:
+          - "ubuntu-latest"
+
+    runs-on: ${{ matrix.operating-system }}
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install cabal/ghc
+      uses: haskell-actions/setup@v2
+      id: setup-haskell
+      with:
+        ghc-version: ${{ matrix.ghc-version }}
+        cabal-version: '3.12.1.0'
+    
+    - name: Generate freeze file
+      run: |
+        cabal configure --enable-tests --test-show-details=direct
+        cabal freeze --minimize-conflict-set
+    
+    - name: Cache cabal work
+      uses: actions/cache@v4
+      with:
+        path: |
+          dist-newstyle
+          ${{ steps.setup-haskell.outputs.cabal-store }}
+        # We are using the hash of 'cabal.project.local' so that different levels
+        # of optimizations are cached separately
+        key: ${{ runner.os }}-${{ hashFiles('cabal.project', 'cabal.project.local') }}-cabal-install
+
+    - name: Build dependencies only
+      run: cabal build all --only-dependencies
+    
+    - name: Build all packages
+      run: cabal build all
+        
+    - name: Run all tests
+      run: cabal test all

.github/workflows/distributed-process-ci.yml

@@ -1,6 +1,27 @@
-dist/
-dist-newstyle/
-.cabal-sandbox
+dist
+dist-*
+cabal-dev
+*.o
+*.hi
+*.hie
+*.chi
+*.chs.h
+*.dyn_o
+*.dyn_hi
+.hpc
+.hsenv
+.cabal-sandbox/
 cabal.sandbox.config
-.stack*
-stack.yaml.lock
+*.prof
+*.aux
+*.hp
+*.eventlog
+.stack-work/
+cabal.project.local
+cabal.project.local~
+.HTF/
+.ghc.environment.*
+.*.swo
+.*.swp
+_site
+.DS_Store

.gitignore

@@ -1 +1,57 @@
-See https://github.com/haskell-distributed/cloud-haskell/blob/master/CONTRIBUTING.md.
+# Cloud Haskell contributor guidelines
+
+## Building
+
+After cloning, you should be able to build all packages in this repository like so:
+
+```
+$ cabal build all
+```
+
+You can also build a specific package like so:
+
+```
+cabal build <some-package>
+```
+
+You can have more control over the behavior of `cabal` by configuring, first. For example, if you want to disable optimizations for faster compilation:
+
+```
+$ cabal configure --disable-optimization
+$ cabal build all
+```
+
+The allowed arguments for `cabal configure` are [documented here](https://cabal.readthedocs.io/en/stable/cabal-project-description-file.html#global-configuration-options).
+
+Tests for all packages can be run with:
+
+```
+$ cabal test all
+```
+
+or again, you can test a specific package `<some-package>` using:
+
+```
+$ cabal test <some-package>
+```
+
+### Building with specific dependencies
+
+Often, we want to build a package with a specific version of a dependency, for testing or debugging purposes. In this case, recall that you can always constrain cabal using the `--constraint` flag. For example, if I want to build `distributed-process-async` with `async==2.2.5`:
+
+```
+$ cabal build distributed-process-async --constraint="async==2.2.5"
+```
+
+## Contributing changes upstream
+
+To contribute changes, you first need a fork. First, fork the `distributed-process` repository following the [instructions here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo).
+
+Then publish branches:
+
+```
+$ cabal test all        # Check that everything works before proceeding.
+$ git push --set-upstream <username> <branch-name>
+```
+
+Then you can [create a pull-request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to contribute changes back to `distributed-process`.

CONTRIBUTING.md

@@ -0,0 +1,4 @@
+packages: packages/*/**.cabal
+
+package distributed-process-tests
+  flags: +tcp

cabal.project

@@ -0,0 +1,21 @@
+2024-03-25  David Simmons-Duffin <[email protected]> 0.2.7
+
+* Bump dependencies to build with ghc-9.8.
+
+2018-06-14  Alexander Vershilov <[email protected]> 0.2.6
+
+* Update dependency bounds
+* Export all documented functions (Issue #9)
+
+2016-02-16  Facundo Domínguez <[email protected]>  0.2.3
+
+* Update dependency bounds.
+
+# HEAD
+
+* Added initial GenServer module
+* Added Timer Module
+* Moved time functions into Time.hs
+* Added Async API
+* Added GenProcess API (subsumes lower level GenServer API)
+

distributed-process-tests/CONTRIBUTING.md

@@ -0,0 +1,30 @@
+Copyright Tim Watson, 2012-2013.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of the author nor the names of other
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

distributed-process-tests/README.md

@@ -0,0 +1,22 @@
+MAJOR TODOs (in no particular order)
+
+- implement Observable for Mailbox
+- implement PCopy / pcopy :: PCopy a -> Process () and precv :: Process (Maybe (PCopy a))
+- provide InputChannel for PCopy data, i.e.:
+
+data InputChannel a = ReadChan (ReceivePort a) | ReadSTM (STM a)
+
+read (ReadChan rp)  = expectChan rp
+read (ReadSTM  stm) = liftIO $ atomically stm
+
+offer 
+
+- implement RoundRobinRouter, ContentBasedRouter
+- finish off ResourcePool
+- double check we're using NFSerializable where possible/necessary
+
+- implement LocalRegistry (?)
+- possibly rationalise Registry with LocalRegistry (?)
+- Health checks for services
+- Service Monitoring
+

distributed-process-tests/Setup.hs

@@ -0,0 +1,87 @@
+cabal-version:  3.0
+name:           distributed-process-async
+version:        0.2.7
+build-type:     Simple
+license:        BSD-3-Clause
+license-file:   LICENCE
+stability:      experimental
+Copyright:      Tim Watson 2012 - 2016
+Author:         Tim Watson
+maintainer:     The Distributed Haskell team
+Homepage:       http://github.com/haskell-distributed/distributed-process-async
+Bug-Reports:    http://github.com/haskell-distributed/distributed-process-async/issues
+synopsis:       Cloud Haskell Async API
+description:    This package provides a higher-level interface over Processes, in which an Async a is a
+                concurrent, possibly distributed Process that will eventually deliver a value of type a.
+                The package provides ways to create Async computations, wait for their results, and cancel them.
+category:       Control
+tested-with:   GHC==8.10.7 GHC==9.0.2 GHC==9.2.8 GHC==9.4.5 GHC==9.6.4 GHC==9.8.2 GHC==9.10.1
+
+source-repository head
+  type:      git
+  location:  https://github.com/haskell-distributed/distributed-process-async
+
+common warnings
+    ghc-options: -Wall
+                 -Wcompat
+                 -Widentities
+                 -Wincomplete-uni-patterns
+                 -Wincomplete-record-updates
+                 -Wredundant-constraints
+                 -fhide-source-paths
+                 -Wpartial-fields
+
+library
+  import:          warnings
+  build-depends:
+                   base >= 4.14 && < 5,
+                   data-accessor >= 0.2.2.3,
+                   distributed-process >= 0.6.1 && < 0.8,
+                   exceptions >= 0.10 && < 1.0,
+                   binary >= 0.8 && < 0.9,
+                   deepseq >= 1.4 && < 1.6,
+                   mtl,
+                   containers >= 0.6 && < 0.8,
+                   hashable >= 1.2.0.5 && < 1.6,
+                   unordered-containers >= 0.2.3.0 && < 0.3,
+                   fingertree < 0.2,
+                   stm >= 2.4 && < 2.6,
+                   time >= 1.9,
+                   transformers
+  default-extensions:      CPP
+                   InstanceSigs
+  hs-source-dirs:   src
+  default-language: Haskell2010
+  exposed-modules:
+                   Control.Distributed.Process.Async
+  other-modules:
+                   Control.Distributed.Process.Async.Internal.Types
+
+test-suite AsyncTests
+  import:          warnings
+  type:            exitcode-stdio-1.0
+  x-uses-tf:       true
+  build-depends:
+                   base >= 4.14 && < 5,
+                   ansi-terminal >= 0.5 && < 0.9,
+                   distributed-process,
+                   distributed-process-async,
+                   distributed-process-systest >= 0.2.0,
+                   exceptions >= 0.10 && < 1.0,
+                   network >= 2.5 && < 3.3,
+                   network-transport >= 0.4 && < 0.6,
+                   network-transport-tcp >= 0.6 && < 0.9,
+                   binary >= 0.8 && < 0.9,
+                   deepseq >= 1.4 && < 1.6,
+                   -- HUnit >= 1.2 && < 2,
+                   stm >= 2.3 && < 2.6,
+                   test-framework >= 0.6 && < 0.9,
+                   test-framework-hunit,
+                   rematch >= 0.2.0.0,
+                   transformers
+  hs-source-dirs:
+                   tests
+  default-language: Haskell2010
+  ghc-options:     -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
+  default-extensions:      CPP
+  main-is:         TestAsync.hs

packages/distributed-process-async/CHANGELOG.md

@@ -0,0 +1,3 @@
+#!/bin/sh
+cabal clean
+cabal configure --enable-library-profiling --enable-executable-profiling