Merge pull request #1987 from demergent-labs/chunk_property_tests

Chunk property tests

.github/workflows/test.yml

@@ -257,6 +257,7 @@ jobs:
                     "tests/end_to_end/http_server/tfjs",
                     "tests/end_to_end/http_server/web_assembly",
                     "tests/property/ic_api/caller",
+                    "tests/property/ic_api/chunk",
                     "tests/property/ic_api/id",
                     "tests/property/ic_api/instruction_counter",
                     "tests/property/ic_api/is_controller",

src/lib/stable/ic_apis/chunk.ts

@@ -2,6 +2,17 @@ import { call } from './call';
 import { candidEncode } from './candid_encode';
 import { id } from './id';
 
+/**
+ * Resets the instruction limit when this function is called and awaited.
+ * To achieve this, a simple cross-canister call to the canister calling this function is executed.
+ *
+ * You should exercise the appropriate cautions similar to when executing other cross-canister calls, such as managing global mutable state across await points safely.
+ *
+ * Only works when called from:
+ * - update calls and their reply/reject callbacks ([U Ry Rt](https://internetcomputer.org/docs/current/references/ic-interface-spec#system-api-imports))
+ * - timers ([T](https://internetcomputer.org/docs/current/references/ic-interface-spec#system-api-imports))
+ * - heartbeats ([T](https://internetcomputer.org/docs/current/references/ic-interface-spec#system-api-imports))
+ */
 export async function chunk(): Promise<void> {
     if (globalThis._azleIc === undefined) {
         return undefined;

tests/property/ic_api/chunk/.gitignore

@@ -0,0 +1,4 @@
+.azle
+.dfx
+dfx_generated
+node_modules

tests/property/ic_api/chunk/dfx.json

@@ -0,0 +1,13 @@
+{
+    "canisters": {
+        "canister": {
+            "type": "azle",
+            "main": "src/index.ts",
+            "candid_gen": "automatic",
+            "declarations": {
+                "output": "test/dfx_generated/canister",
+                "node_compatibility": true
+            }
+        }
+    }
+}

tests/property/ic_api/chunk/jest.config.js

@@ -0,0 +1,12 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    bail: true,
+    testTimeout: 100_000_000,
+    transform: {
+        '^.+\\.ts$': ['ts-jest', { isolatedModules: true }],
+        '^.+\\.js$': 'ts-jest'
+    },
+    transformIgnorePatterns: ['/node_modules/(?!(azle)/)'] // Make sure azle is transformed
+};