health & ready endpoints return StatusCodeRecordResult

Author: icppWorld

icpp_llama2/native/main.cpp

@@ -202,13 +202,16 @@ int main() {
 
   // -----------------------------------------------------------------------------
   // The canister health & readiness checks
-  // '()' -> '(true)'
-  mockIC.run_test("health", health, "4449444c0000", "4449444c00017e01",
+  // '()' -> '(variant { Ok = 200 : nat16 })'
+  mockIC.run_test("health", health, "4449444c0000",
+                  "4449444c026c019aa1b2f90c7a6b01bc8a0100010100c800",
                   silent_on_trap, anonymous_principal);
 
-  // '()' -> '(false)'
-  mockIC.run_test("ready", ready, "4449444c0000", "4449444c00017e00",
-                  silent_on_trap, anonymous_principal);
+  // '()' -> '(variant { Err = record { Other = "Model not yet uploaded or initialize endpoint not yet called"} })'
+  mockIC.run_test(
+      "ready", ready, "4449444c0000",
+      "4449444c026b01b0ad8fcd0c716b01c5fed20100010100003c4d6f64656c206e6f74207965742075706c6f61646564206f7220696e697469616c697a6520656e64706f696e74206e6f74207965742063616c6c6564",
+      silent_on_trap, anonymous_principal);
 
   // -----------------------------------------------------------------------------
 

icpp_llama2/requirements.txt

@@ -1,3 +1,4 @@
 -r scripts/requirements.txt
 icpp-pro==3.13.0
 ic-py==1.0.1
+requests

icpp_llama2/scripts/nft_init.py

@@ -58,7 +58,7 @@ def main() -> int:
     # check health (liveness)
     print("--\nChecking liveness of canister (did we deploy it!)")
     response = canister_llama2.health()
-    if response == [True]:
+    if "Ok" in response[0].keys():
         print("Ok!")
     else:
         print("Not OK, response is:")

icpp_llama2/scripts/nft_metadata.py

@@ -49,7 +49,7 @@ def main() -> int:
     # check health (liveness)
     print("--\nChecking liveness of canister (did we deploy it!)")
     response = canister_llama2.health()
-    if response == [True]:
+    if "Ok" in response[0].keys():
         print("Ok!")
     else:
         print("Not OK, response is:")

icpp_llama2/scripts/nft_mint.py

@@ -59,7 +59,7 @@ def main() -> int:
     # check health (liveness)
     print("--\nChecking liveness of canister (did we deploy it!)")
     response = canister_llama2.health()
-    if response == [True]:
+    if "Ok" in response[0].keys():
         print("Ok!")
     else:
         print("Not OK, response is:")
@@ -69,7 +69,7 @@ def main() -> int:
     # check readiness for inference
     print("--\nChecking if the canister is ready for inference.")
     response = canister_llama2.ready()
-    if response[0] is True:
+    if "Ok" in response[0].keys():
         if DEBUG_VERBOSE >= 2:
             print("OK!")
     else:

icpp_llama2/scripts/nft_update_story.py

@@ -59,7 +59,7 @@ def main() -> int:
     # check health (liveness)
     print("--\nChecking liveness of canister (did we deploy it!)")
     response = canister_llama2.health()
-    if response == [True]:
+    if "Ok" in response[0].keys():
         print("Ok!")
     else:
         print("Not OK, response is:")
@@ -69,7 +69,7 @@ def main() -> int:
     # check readiness for inference
     print("--\nChecking if the canister is ready for inference.")
     response = canister_llama2.ready()
-    if response[0] is True:
+    if "Ok" in response[0].keys():
         if DEBUG_VERBOSE >= 2:
             print("OK!")
     else:

icpp_llama2/scripts/requirements.txt

@@ -13,4 +13,5 @@ pylint==2.13.9
 matplotlib
 fastparquet
 openpyxl
-seaborn
+seaborn
+requests

icpp_llama2/scripts/upload.py

@@ -75,7 +75,7 @@ def main() -> int:
     # check health (liveness)
     print("--\nChecking liveness of canister (did we deploy it!)")
     response = canister_llama2.health()
-    if response == [True]:
+    if "Ok" in response[0].keys():
         print("Ok!")
     else:
         print("Not OK, response is:")
@@ -204,7 +204,7 @@ def main() -> int:
     # check readiness for inference
     print("--\nChecking if the canister is ready for inference.")
     response = canister_llama2.ready()
-    if response[0] is True:
+    if "Ok" in response[0].keys():
         if DEBUG_VERBOSE >= 2:
             print("OK!")
     else:

icpp_llama2/src/canister.cpp

@@ -132,13 +132,43 @@ void canister_init() {
 void health() {
   IC_API ic_api(CanisterQuery{std::string(__func__)}, false);
   IC_API::debug_print("llama2 is healthy!");
-  ic_api.to_wire(CandidTypeBool{true});
+
+  CandidTypeRecord status_code_record;
+  status_code_record.append("status_code",
+                            CandidTypeNat16{Http::StatusCode::OK});
+  ic_api.to_wire(CandidTypeVariant{"Ok", status_code_record});
 }
 
 // readiness endpoint (ready for inference & NFT Collection initialized
 void ready() {
   IC_API ic_api(CanisterQuery{std::string(__func__)}, false);
-  bool ready = ready_for_inference && p_nft_collection &&
-               p_nft_collection->initialized && is_canister_mode_set();
-  ic_api.to_wire(CandidTypeBool{ready});
+
+  if (!ready_for_inference) {
+    std::string error_msg =
+        "Model not yet uploaded or initialize endpoint not yet called";
+    ic_api.to_wire(CandidTypeVariant{
+        "Err", CandidTypeVariant{"Other", CandidTypeText{error_msg}}});
+    return;
+  }
+
+  if (!is_canister_mode_set()) {
+    std::string error_msg = "canister_mode is not yet set";
+    ic_api.to_wire(CandidTypeVariant{
+        "Err", CandidTypeVariant{"Other", CandidTypeText{error_msg}}});
+    return;
+  }
+
+  if (is_canister_mode_nft_ordinal()) {
+    if (!(p_nft_collection && p_nft_collection->initialized)) {
+      std::string error_msg =
+          "canister_mode=nft_ordinal, but nft_collection is not initialized";
+      ic_api.to_wire(CandidTypeVariant{
+          "Err", CandidTypeVariant{"Other", CandidTypeText{error_msg}}});
+      return;
+    }
+  }
+  CandidTypeRecord status_code_record;
+  status_code_record.append("status_code",
+                            CandidTypeNat16{Http::StatusCode::OK});
+  ic_api.to_wire(CandidTypeVariant{"Ok", status_code_record});
 }

icpp_llama2/src/llama2.did

@@ -177,8 +177,8 @@ service : {
   // canister endpoints
   canister_init : () -> ();
   set_canister_mode : (text) -> (CanisterModeRecordResult);
-  health : () -> (bool) query;
-  ready : () -> (bool) query;
+  health : () -> (StatusCodeRecordResult) query;
+  ready : () -> (StatusCodeRecordResult) query;
 
   // LLM initialization endpoints
   reset_model : () -> (StatusCodeRecordResult);

icpp_llama2/test/test_apis.py

@@ -31,7 +31,7 @@ def test__health(identity_anonymous: dict[str, str], network: str) -> None:
         network=network,
         timeout_seconds=10,
     )
-    expected_response = "(true)"
+    expected_response = "(variant { Ok = record { status_code = 200 : nat16;} })"
     assert response == expected_response
 
 
@@ -44,7 +44,7 @@ def test__ready(identity_anonymous: dict[str, str], network: str) -> None:
         network=network,
         timeout_seconds=10,
     )
-    expected_response = "(true)"
+    expected_response = "(variant { Ok = record { status_code = 200 : nat16;} })"
     assert response == expected_response