feat: rebuild only necessary canisters

CHANGELOG.md

@@ -2,6 +2,21 @@
 
 # UNRELEASED
 
+### feat: rebuild only necessary canisters
+
+Cache `get_imports()` (renamed to `add_imports()`) results.
+
+Read only those `--print-deps` dependencies that are necessary to read.
+
+Don't compile canisters for which all dependencies are elder than the `.wasm` file.
+This results in big compilation speedups.
+
+### feat: specify canisters not to deploy
+
+`"deploy": false` canister option makes it not to deploy, unless explicitly specified on the command line.
+
+### chore: Improve help text of `dfx identity new` to include which characters are valid in identity names
+
 # 0.20.2
 
 ### fix: `dfx canister delete` fails

docs/cli-reference/dfx-build.mdx

@@ -10,6 +10,8 @@ Note that you can only run this command from within the project directory struct
 
 The `dfx build` command looks for the source code to compile using the information you have configured under the `canisters` section in the `dfx.json` configuration file.
 
+For compilation speed reasons, `dfx build` (and `dfx deploy`) don't recompile canisters, all dependencies of which are elder than the existing Candid file (from the previous compilation). Moreover, the Candid (`.did`) file is updated only when strictly necessary (that is on public interface change). This makes dependent canisters not recompile when a dependency canister changes without interface change.
+
 ## Basic usage
 
 ``` bash

docs/cli-reference/dfx-deploy.mdx

@@ -4,7 +4,7 @@ import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
 
 <MarkdownChipRow labels={["Reference"]}/>
 
-Use the `dfx deploy` command to register, build, and deploy a dapp on the local canister execution environment, on the IC or on a specified testnet. By default, all canisters defined in the project `dfx.json` configuration file are deployed.
+Use the `dfx deploy` command to register, build, and deploy a dapp on the local canister execution environment, on the IC or on a specified testnet. By default, all canisters defined in the project `dfx.json` configuration file are deployed, except of the canisters with `"deploy": false` option.
 
 This command simplifies the developer workflow by enabling you to run one command instead of running the following commands as separate steps:
 

docs/dfx-json-schema.json

@@ -369,6 +369,12 @@
             "type": "string"
           }
         },
+        "deploy": {
+          "title": "Deploy",
+          "description": "`false` value means not to deploy this canister unless it's explicitly specified in the command line (supposed use: canister that are created by other canisters).",
+          "default": true,
+          "type": "boolean"
+        },
         "frontend": {
           "title": "Force Frontend URL",
           "description": "Mostly unused. If this value is not null, a frontend URL is displayed after deployment even if the canister type is not 'asset'.",

e2e/assets/add_dependency/a.mo

@@ -0,0 +1,5 @@
+import _ "canister:b"
+
+actor {
+    public shared func f() {};
+}

e2e/assets/add_dependency/b.mo

@@ -0,0 +1,3 @@
+actor {
+    public shared func g() {};
+}

e2e/assets/add_dependency/dfx.json

@@ -0,0 +1,14 @@
+{
+    "canisters": {
+        "a": {
+            "main": "a.mo",
+            "dependencies": ["c"]
+        },
+        "b": {
+            "main": "b.mo"
+        },
+        "c": {
+            "main": "b.mo"
+        }
+    }
+}

e2e/assets/add_dependency/dfx_corrected.json

@@ -0,0 +1,11 @@
+{
+    "canisters": {
+        "a": {
+            "main": "a.mo",
+            "dependencies": ["b"]
+        },
+        "b": {
+            "main": "b.mo"
+        }
+    }
+}

e2e/assets/broken_canister_dep/a.mo

@@ -0,0 +1,5 @@
+import _ "canister:b"
+
+actor {
+    public shared func f() {};
+}

e2e/assets/broken_canister_dep/dfx.json

@@ -0,0 +1,8 @@
+{
+    "canisters": {
+        "a": {
+            "type": "motoko",
+            "main": "a.mo"
+        }
+    }
+}

e2e/assets/make_like/README.txt

@@ -0,0 +1 @@
+Sources are put into src/ to check how it behaves with subdirectories.

e2e/assets/make_like/dfx.json

@@ -0,0 +1,19 @@
+{
+    "version": 1,
+    "canisters": {
+        "dependency": {
+            "main": "src/dependency.mo"
+        },
+        "dependent": {
+            "main": "src/dependent.mo",
+            "dependencies": [
+                "dependency"
+            ]
+        }
+    },
+    "networks": {
+        "local": {
+            "bind": "127.0.0.1:8000"
+        }
+    }
+}

e2e/assets/make_like/src/dependency.mo

@@ -0,0 +1,7 @@
+import L "lib";
+
+actor {
+    public shared func greet(name: Text) : async Text {
+        return "Hello, " # name # "!";
+    }
+}

e2e/assets/make_like/src/dependency_altered.mo

@@ -0,0 +1,10 @@
+import L "lib";
+
+actor {
+    public shared func greet(name: Text) : async Text {
+        return "Hello, " # name # "!";
+    };
+
+    public shared func anotherFunction() : async () {
+    };
+}

e2e/assets/make_like/src/dependent.mo

@@ -0,0 +1,8 @@
+import L "lib";
+import D "canister:dependency";
+
+actor {
+  public shared func greet(name : Text) : async Text {
+    return "Hello, " # name # "!";
+  };
+};

e2e/assets/make_like/src/lib.mo

@@ -0,0 +1 @@
+module {}

e2e/assets/wrong_ids/dfx.json

@@ -0,0 +1,8 @@
+{
+  "canisters": {
+    "pst": {
+      "main": "src/a.mo",
+      "type": "motoko"
+    }
+  }
+}

e2e/assets/wrong_ids/src/a.mo

@@ -0,0 +1 @@
+actor A {};

e2e/tests-dfx/add_dependency.bash

@@ -0,0 +1,28 @@
+#!/usr/bin/env bats
+
+load ../utils/_
+
+setup() {
+  standard_setup
+
+  install_asset add_dependency
+}
+
+teardown() {
+  dfx_stop
+
+  standard_teardown
+}
+
+# Check that attempt to compile before correcting dependencies does not break further compilation.
+@test "compiles after correcting a dependency" {
+  install_asset base
+
+  dfx_start
+
+  assert_command_fail dfx deploy
+
+  cp dfx_corrected.json dfx.json
+
+  assert_command dfx deploy
+}

e2e/tests-dfx/broken_canister_dep.bash

@@ -0,0 +1,23 @@
+#!/usr/bin/env bats
+
+load ../utils/_
+
+setup() {
+  standard_setup
+
+  install_asset broken_canister_dep
+}
+
+teardown() {
+  dfx_stop
+
+  standard_teardown
+}
+
+@test "crash on a broken canister dependency" {
+    dfx_start
+
+    assert_command_fail dfx deploy
+
+    assert_not_contains "panicked at"
+}