Define enums for optimization levels

docs/dfx-json-schema.json

@@ -419,9 +419,10 @@
         "optimize": {
           "title": "Optimize Canister WASM",
           "description": "Invoke wasm level optimizations after building the Canister. Optimization level can be set to \"cycles\" to optimize for cycle usage, \"size\" to optimize for binary size, or any of \"O4, O3, O2, O1, O0, Oz, Os\". Disabled by default.",
-          "type": [
-            "string",
-            "null"
+          "allOf": [
+            {
+              "$ref": "#/definitions/WasmOptLevel"
+            }
           ]
         }
       }

src/dfx-core/src/config/model/dfinity.rs

@@ -75,6 +75,31 @@ pub struct ConfigCanistersCanisterRemote {
     pub id: BTreeMap<String, Principal>,
 }
 
+#[derive(Copy, Clone, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
+pub enum WasmOptLevel {
+    // Defaults to O3
+    #[serde(rename = "cycles")]
+    Cycles,
+    // Defaults to Oz
+    #[serde(rename = "size")]
+    Size,
+    // Specific performance levels
+    O4,
+    O3,
+    O2,
+    O1,
+    O0,
+    // Specific size levels
+    Oz,
+    Os,
+}
+
+impl std::fmt::Display for WasmOptLevel {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        std::fmt::Debug::fmt(self, f)
+    }
+}
+
 #[derive(Copy, Clone, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
 #[serde(rename_all = "lowercase")]
 pub enum MetadataVisibility {
@@ -198,7 +223,8 @@ pub struct ConfigCanistersCanister {
     /// # Optimize Canister WASM
     /// Invoke wasm level optimizations after building the Canister. Optimization level can be set to \"cycles\" to optimize for cycle usage, \"size\" to optimize for binary size, or any of \"O4, O3, O2, O1, O0, Oz, Os\". Disabled by default.
     /// Disabled by default.
-    pub optimize: Option<String>,
+    #[serde(default)]
+    pub optimize: Option<WasmOptLevel>,
 
     /// # Metadata
     /// Defines metadata sections to set in the canister .wasm

src/dfx/src/lib/builders/mod.rs

@@ -4,7 +4,7 @@ use crate::lib::environment::Environment;
 use crate::lib::error::DfxResult;
 use crate::lib::models::canister::CanisterPool;
 use crate::util::check_candid_file;
-use dfx_core::config::model::dfinity::{Config, Profile};
+use dfx_core::config::model::dfinity::{Config, Profile, WasmOptLevel};
 use dfx_core::network::provider::get_network_context;
 use dfx_core::util;
 
@@ -492,16 +492,16 @@ fn shrink_wasm(wasm_path: impl AsRef<Path>) -> DfxResult {
 }
 
 #[context("Failed to optimize wasm at {}.", &wasm_path.as_ref().display())]
-fn optimize_wasm(wasm_path: impl AsRef<Path>, level: &str) -> DfxResult {
+fn optimize_wasm(wasm_path: impl AsRef<Path>, level: &WasmOptLevel) -> DfxResult {
     let wasm_path = wasm_path.as_ref();
     let wasm = std::fs::read(wasm_path).context("Could not read the WASM module.")?;
     let mut module =
         ic_wasm::utils::parse_wasm(&wasm, true).context("Could not parse the WASM module.")?;
     match level {
-        // O3 empirically gives best cycle savings
-        "cycles" => ic_wasm::shrink::shrink_with_wasm_opt(&mut module, "O3"),
-        "size" => ic_wasm::shrink::shrink_with_wasm_opt(&mut module, "Oz"),
-        _ => ic_wasm::shrink::shrink_with_wasm_opt(&mut module, level),
+        // O3 and Oz empirically give best cycle savings and code size savings respectively
+        WasmOptLevel::Cycles => ic_wasm::shrink::shrink_with_wasm_opt(&mut module, "O3"),
+        WasmOptLevel::Size => ic_wasm::shrink::shrink_with_wasm_opt(&mut module, "Oz"),
+        _ => ic_wasm::shrink::shrink_with_wasm_opt(&mut module, &level.to_string()),
     }
     .context("Could not optimize the WASM module.")?;
 

src/dfx/src/lib/canister_info.rs

@@ -5,6 +5,7 @@ use crate::lib::canister_info::motoko::MotokoCanisterInfo;
 use crate::lib::error::DfxResult;
 use dfx_core::config::model::dfinity::{
     CanisterDeclarationsConfig, CanisterMetadataSection, CanisterTypeProperties, Config,
+    WasmOptLevel,
 };
 use dfx_core::network::provider::get_network_context;
 use dfx_core::util;
@@ -52,7 +53,7 @@ pub struct CanisterInfo {
     post_install: Vec<String>,
     main: Option<PathBuf>,
     shrink: Option<bool>,
-    optimize: Option<String>,
+    optimize: Option<WasmOptLevel>,
     metadata: CanisterMetadataConfig,
     pull_ready: bool,
     pull_dependencies: Vec<(String, CanisterId)>,
@@ -231,7 +232,7 @@ impl CanisterInfo {
         self.shrink
     }
 
-    pub fn get_optimize(&self) -> &Option<String> {
+    pub fn get_optimize(&self) -> &Option<WasmOptLevel> {
         &self.optimize
     }