The Daml smart contract language
Go to file
Moritz Kiefer 3554596f9a Wait for all gRPC requests to finish before shutting down gRPC (#2551)
This fixes all flakiness in `damlc test` that I was able to
reproduce. Previously, I got it to fail in about 10% of the cases
whereas now I have successfully run tests 200 times under load without
issues.

There were two issues at play here:

1. We run scenarios in separate threads to be able to kill the running
Shake session quickly even if a scenario has an infinite loop or
something like that (there is a timeout but it’s quite long). This
could result in one of those left-over threads trying to issue a
request while we are already trying to shut down.

To fix that, we wait for the concurrency semaphore to be empty before
shutting down.

2. Just waiting for scenario executions is not quite sufficient as
`runAction` does not wait for all rules to finish (we could just use
runActionSync in `damlc test` but I’d rather make this work
properly). While we do wait for all scenario executions to finish
there is one gRPC request in offInterest that we do not wait for:
gcCtxs.

To fix this, I’ve now routed all gRPC requests through the semaphore
which means that we will also wait for these requests to finish (or
prevent them from spawning).

This makes more sense anyway as scenario executions are mostly fairly
cheap requests while things like setting up the context are expensive
so we want to limit their concurrency.

We should make the concurrency limit configurable but I’ll leave that
for a separate PR.
2019-08-15 09:39:30 +00:00
.github Include change management checkbox in PR template (#2318) 2019-07-31 17:36:00 +02:00
.vscode open-sourcing daml 2019-04-04 09:33:38 +01:00
3rdparty Update generic templates (#2547) 2019-08-14 16:28:35 -04:00
bazel_tools Add an option to build Haskell code with DWARF debug info (#2504) 2019-08-13 20:00:14 +02:00
build-scripts update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
ci update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
compiler Wait for all gRPC requests to finish before shutting down gRPC (#2551) 2019-08-15 09:39:30 +00:00
daml-assistant update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
daml-lf daml-lf: fix spec (#2550) 2019-08-15 08:07:49 +00:00
dev-env update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
docs Wait for all gRPC requests to finish before shutting down gRPC (#2551) 2019-08-15 09:39:30 +00:00
extractor update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
ghc-lib update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
hazel update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
infra update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
language-support Mark tests that use Haskell gRPC bindings as flaky (#2521) 2019-08-13 20:38:51 +02:00
ledger update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
ledger-api update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
ledger-service Releasing //ledger-service/http-json module and its dependencies (#2543) 2019-08-14 17:19:31 +00:00
libs-haskell Make the detail level of damlc inspect configurable (#2498) 2019-08-14 07:54:20 +00:00
navigator update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
nix Add an option to build Haskell code with DWARF debug info (#2504) 2019-08-13 20:00:14 +02:00
notices-gen update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
oss-compliance update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
release Releasing //ledger-service/http-json module and its dependencies (#2543) 2019-08-14 17:19:31 +00:00
replacements update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
rules_daml update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
scala-protoc-plugins update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
templates update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
.bazelignore open-sourcing daml 2019-04-04 09:33:38 +01:00
.bazelrc Update rules haskell (#2509) 2019-08-13 16:46:31 +02:00
.dadew Fix curl on Windows (#1925) 2019-06-28 08:02:05 +00:00
.dockerignore open-sourcing daml 2019-04-04 09:33:38 +01:00
.envrc open-sourcing daml 2019-04-04 09:33:38 +01:00
.gitattributes Follow up with .gitattributes on #1762 (#1770) 2019-06-19 15:29:13 +00:00
.gitignore Move all damlc tests to compiler/damlc/tests (#2057) 2019-07-09 13:38:58 +02:00
.hie-bios Add a damlc doctest command and test the standard library (#2157) 2019-07-16 15:51:01 +02:00
.hlint.yaml improve haskell module hierarchy to be more consistent (#2319) 2019-07-29 15:55:55 +01:00
.mergify.yml Rename automerge-dangerous-but-faster to automerge (#1605) 2019-06-12 08:37:07 -04:00
.scalafmt.conf open-sourcing daml 2019-04-04 09:33:38 +01:00
.watchmanconfig open-sourcing daml 2019-04-04 09:33:38 +01:00
azure-cron.yml Revert "add old releases to hubspot (#2290)" (#2308) 2019-07-29 08:16:33 +00:00
azure-pipelines.yml macOS: cache the bazel repo cache (#2420) 2019-08-07 11:04:49 +01:00
BAZEL-bash.md add Bazel bash help (#2223) 2019-07-19 15:31:45 +00:00
BAZEL-haskell.md Update rules haskell (#2509) 2019-08-13 16:46:31 +02:00
BAZEL-JVM.md open-sourcing daml 2019-04-04 09:33:38 +01:00
BAZEL.md Turn the damlc module hierarchy into something a bit more sane (#2061) 2019-07-09 15:10:40 +02:00
BUILD Update rules haskell (#2509) 2019-08-13 16:46:31 +02:00
build.ps1 windows: root build (#1894) 2019-06-28 12:55:31 +02:00
build.sh update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
CHANGELOG Move unreleased user-facing features to its own file (#1762) 2019-06-19 16:32:03 +02:00
CODE_OF_CONDUCT.md open-sourcing daml 2019-04-04 09:33:38 +01:00
CODEOWNERS New Ledger API test tool (#2282) 2019-08-09 17:00:37 +02:00
CONTRIBUTING.md Minor Docs fixes (#2277) 2019-07-25 16:02:42 +02:00
COPY update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
dependencies.yaml JWT HMAC256 Authorization (#2389) 2019-08-07 16:26:26 +00:00
deps.bzl update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
dotfiles open-sourcing daml 2019-04-04 09:33:38 +01:00
fmt.sh update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
LICENSE Include Digital Asset Copyright in LICENSE file (#1022) 2019-05-08 14:35:21 -04:00
NOTICES open-sourcing daml 2019-04-04 09:33:38 +01:00
package.json Update to bazel-0.27 (#1957) 2019-07-05 14:04:47 +00:00
README.md Minor Docs fixes (#2277) 2019-07-25 16:02:42 +02:00
scalafmt.sh update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
SECURITY.md Create SECURITY.md (#1357) 2019-05-31 08:58:21 +01:00
tsconfig.json open-sourcing daml 2019-04-04 09:33:38 +01:00
unreleased.rst Wait for all gRPC requests to finish before shutting down gRPC (#2551) 2019-08-15 09:39:30 +00:00
Upgrading.md Switch to nixpkgs-unstable (#1921) 2019-06-27 18:47:42 +02:00
util.bzl update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
VERSION Release 0.13.19 (#2525) 2019-08-14 08:53:04 +00:00
WORKSPACE Update generic templates (#2547) 2019-08-14 16:28:35 -04:00
yarn.lock Bump lodash from 4.17.11 to 4.17.14 (#2099) 2019-07-11 01:35:41 +00:00

DAML logo

Download License Build

Copyright 2019 Digital Asset (Switzerland) GmbH and/or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0

Welcome to the DAML repository!

This repository hosts all code for the DAML smart contract language and SDK, originally created by Digital Asset. DAML is an open-source smart contract language for building future-proof distributed applications on a safe, privacy-aware runtime. The DAML SDK is a set of tools to help you develop applications based on DAML.

Using DAML

To download DAML, follow the installation instructions. Once installed, to try it out, follow the quickstart guide.

If you have questions about how to use DAML or how to build DAML-based solutions, please ask them on StackOverflow using the daml tag.

Contributing to DAML

We warmly welcome contributions. If you are looking for ideas on how to contribute, please browse our issues. To build and test DAML:

1. Clone this repository

git clone git@github.com:digital-asset/daml.git
cd daml

2. Set up the development dependencies

Our builds require various development dependencies (e.g. Java, Bazel, Python), provided by a tool called dev-env.

Linux and Mac

On Linux and Mac dev-env can be installed with:

  1. Install Nix by running: bash <(curl https://nixos.org/nix/install)
  2. Enter dev-env by running: eval "$(dev-env/bin/dade assist)"

If you don't want to enter dev-env manually each time using eval "$(dev-env/bin/dade assist)", you can also install direnv. This repo already provides a .envrc file, with an option to add more in a .envrc.private file.

Windows

On Windows you need to enable long file paths by running the following command in an admin powershell:

Set-ItemProperty -Path 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name LongPathsEnabled -Type DWord -Value 1

Then start dev-env from PowerShell with:

.\dev-env\windows\bin\dadew.ps1 install
.\dev-env\windows\bin\dadew.ps1 sync
.\dev-env\windows\bin\dadew.ps1 enable

In all new PowerShell processes started, you need to repeat the enable step.

3. First build and test

We have a single script to build most targets and run the tests. On Linux and Mac run ./build.sh. On Windows run .\build.ps1. Note that these scripts may take over an hour the first time.

To just build do bazel build //..., and to just test do bazel test //.... To read more about Bazel and how to use it, see the Bazel site.

On Mac if building is causing trouble complaining about missing nix packages, you can try first running nix-build -A tools -A cached nix repeatedly until it completes without error.

4. Installing a local copy

On Linux and Mac run daml-sdk-head which installs a version of the SDK with version number 0.0.0. Set the version: field in any DAML project to 0.0.0 and it will use the locally installed one.

On Windows:

bazel build //release:sdk-release-tarball
tar -vxf .\bazel-genfiles\release\sdk-release-tarball.tar.gz
cd sdk-*
daml\daml.exe install . --activate

That should tell you what to put in the path, something along the lines of C:\Users\admin\AppData\Roaming\daml\bin. Note that the Windows build is not yet fully functional.

Caching: build speed and disk space considerations

Bazel has a lot of nice properties, but they come at the cost of frequently rebuilding "the world". To make that bearable, we make extensive use of caching. Most artifacts should be cached in our CDN, which is configured in .bazelrc in this project.

However, even then, you may end up spending a lot of time (and bandwidth!) downloading artifacts from the CDN. To alleviate that, by default, our build will create a subfolder .bazel-cache in this project and keep an on-disk cache. This can take about 10GB at the time of writing.

To disable the disk cache, remove the following lines:

build:linux --disk_cache=.bazel-cache
build:darwin --disk_cache=.bazel-cache

from the .bazelrc file.

If you work with multiple copies of this repository, you can point all of them to the same disk cache by overwriting these configs in either a .bazelrc.local file in each copy, or a ~/.bazelrc file in your home directory.

Haskell profiling builds

To build Haskell executables with profiling enabled, pass -c dbg to Bazel, e.g. bazel build -c dbg damlc. If you want to build the whole SDK with profiling enabled use daml-sdk-head --profiling.