Merge pull request #1520 from demergent-labs/1517_inspect_message

Test: Added InspectMessageMethodArb

.github/workflows/test.yml

@@ -162,6 +162,7 @@ jobs:
                     "property_tests/tests/canister_methods/http_request",
                     "property_tests/tests/canister_methods/http_request_update",
                     "property_tests/tests/canister_methods/init",
+                    "property_tests/tests/canister_methods/inspect_message",
                     "property_tests/tests/canister_methods/post_upgrade",
                     "property_tests/tests/canister_methods/pre_upgrade",
                     "property_tests/tests/canister_methods/query",

dfx/index.ts

@@ -38,9 +38,23 @@ export async function createAnonymousAgent() {
     }
 }
 
+/**
+ * Returns an agent authenticated with the identity with the given name.
+ *
+ * Generates a new identity with the given name if shouldGenerateIdentity and
+ * the identity doesn't already exist.
+ *
+ * @param identityName
+ * @returns
+ */
 export async function createAuthenticatedAgent(
-    identityName: string
+    identityName: string,
+    shouldGenerateIdentity: boolean = false
 ): Promise<HttpAgent> {
+    if (shouldGenerateIdentity && !identityExists(identityName)) {
+        generateIdentity(identityName);
+    }
+
     const agent = new HttpAgent({
         host: getAgentHost(),
         identity: getSecp256k1KeyIdentity(identityName)
@@ -53,6 +67,34 @@ export async function createAuthenticatedAgent(
     return agent;
 }
 
+/**
+ * Returns an agent authenticated with the identity with the given name.
+ *
+ * Generates a new identity with the given name if shouldGenerateIdentity and
+ * the identity doesn't already exist.
+ *
+ * IMPORTANT: In order to be synchronous this call will not fetch the root key.
+ * If you are not on mainnet you will need to fetch the root key separately.
+ *
+ * @param identityName
+ * @returns
+ */
+export function createAuthenticatedAgentSync(
+    identityName: string,
+    shouldGenerateIdentity: boolean = false
+): HttpAgent {
+    if (shouldGenerateIdentity && !identityExists(identityName)) {
+        generateIdentity(identityName);
+    }
+
+    const agent = new HttpAgent({
+        host: getAgentHost(),
+        identity: getSecp256k1KeyIdentity(identityName)
+    });
+
+    return agent;
+}
+
 export function whoami(): string {
     return execSync(`dfx identity whoami`).toString().trim();
 }

property_tests/arbitraries/canister_arb.ts

@@ -4,6 +4,7 @@ import { Test } from '../../test';
 import { CliStringVisitor } from '../visitors/cli-string-visitor';
 import { CorrespondingJSType } from './candid/corresponding_js_type';
 import { InitMethod } from './canister_methods/init_method_arb';
+import { InspectMessageMethod } from './canister_methods/inspect_message_method_arb';
 import { PostUpgradeMethod } from './canister_methods/post_upgrade_arb';
 import { PreUpgradeMethod } from './canister_methods/pre_upgrade_method_arb';
 import { QueryMethod } from './canister_methods/query_method_arb';
@@ -24,14 +25,16 @@ export type CanisterMethod<
     | UpdateMethod
     | InitMethod<ParamAgentArgumentValue, ParamAgentResponseValue>
     | PostUpgradeMethod<ParamAgentArgumentValue, ParamAgentResponseValue>
-    | PreUpgradeMethod;
+    | PreUpgradeMethod
+    | InspectMessageMethod;
 
 export type CanisterConfig<
     ParamAgentArgumentValue extends CorrespondingJSType = undefined,
     ParamAgentResponseValue = undefined
 > = {
     globalDeclarations?: string[];
     initMethod?: InitMethod<ParamAgentArgumentValue, ParamAgentResponseValue>;
+    inspectMessageMethod?: InspectMessageMethod;
     postUpgradeMethod?: PostUpgradeMethod<
         ParamAgentArgumentValue,
         ParamAgentResponseValue
@@ -56,6 +59,9 @@ export function CanisterArb<
             ParamAgentResponseValue
         >[] = [
             ...(config.initMethod ? [config.initMethod] : []),
+            ...(config.inspectMessageMethod
+                ? [config.inspectMessageMethod]
+                : []),
             ...(config.postUpgradeMethod ? [config.postUpgradeMethod] : []),
             ...(config.preUpgradeMethod ? [config.preUpgradeMethod] : []),
             ...(config.queryMethods ?? []),

property_tests/arbitraries/canister_methods/inspect_message_method_arb.ts

@@ -0,0 +1,74 @@
+import fc from 'fast-check';
+
+import { Test } from '../../../test';
+import { VoidArb } from '../candid/primitive/void';
+import { UniqueIdentifierArb } from '../unique_identifier_arb';
+import {
+    BodyGenerator,
+    CallbackLocation,
+    CallbackLocationArb,
+    generateCallback,
+    TestsGenerator
+} from '.';
+
+export type InspectMessageMethod = {
+    imports: Set<string>;
+    globalDeclarations: string[];
+    sourceCode: string;
+    tests: Test[][];
+};
+
+export function InspectMessageMethodArb(constraints: {
+    generateBody: BodyGenerator;
+    generateTests: TestsGenerator;
+    callbackLocation?: CallbackLocation;
+}) {
+    return fc
+        .tuple(
+            UniqueIdentifierArb('canisterProperties'),
+            VoidArb(),
+            CallbackLocationArb,
+            UniqueIdentifierArb('globalNames')
+        )
+        .map(
+            ([
+                functionName,
+                returnType,
+                defaultCallbackLocation,
+                callbackName
+            ]): InspectMessageMethod => {
+                const callbackLocation =
+                    constraints.callbackLocation ?? defaultCallbackLocation;
+
+                const imports = new Set(['inspectMessage', 'ic']);
+
+                const callback = generateCallback(
+                    [],
+                    returnType,
+                    constraints.generateBody,
+                    callbackLocation,
+                    callbackName
+                );
+
+                const globalDeclarations =
+                    callbackLocation === 'STANDALONE' ? [callback] : [];
+
+                const sourceCode = `${functionName}: inspectMessage(${
+                    callbackLocation === 'STANDALONE' ? callbackName : callback
+                })`;
+
+                const tests = constraints.generateTests(
+                    functionName,
+                    [],
+                    returnType
+                );
+
+                return {
+                    imports,
+                    globalDeclarations,
+                    sourceCode,
+                    tests
+                };
+            }
+        );
+}

property_tests/get_actor.ts

@@ -1,6 +1,8 @@
+import { Agent, HttpAgent } from '@dfinity/agent';
+
 import { getCanisterId } from '../dfx';
 
-export function getActor(parentDir: string) {
+export function getActor(parentDir: string, agent?: Agent) {
     const resolvedPathIndex = require.resolve(
         `${parentDir}/dfx_generated/canister/index.js`
     );
@@ -13,10 +15,13 @@ export function getActor(parentDir: string) {
 
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     const { createActor } = require(`${parentDir}/dfx_generated/canister`);
+
     return createActor(getCanisterId('canister'), {
-        agentOptions: {
-            host: 'http://127.0.0.1:8000',
-            verifyQuerySignatures: false // TODO Major issue: https://forum.dfinity.org/t/agent-js-0-20-0-is-released-replica-signed-query-edition/24743/16?u=lastmjs
-        }
+        agent:
+            agent ??
+            new HttpAgent({
+                host: 'http://127.0.0.1:8000',
+                verifyQuerySignatures: false // TODO Major issue: https://forum.dfinity.org/t/agent-js-0-20-0-is-released-replica-signed-query-edition/24743/16?u=lastmjs
+            })
     });
 }

property_tests/tests/canister_methods/inspect_message/dfx.json

@@ -0,0 +1,16 @@
+{
+    "canisters": {
+        "canister": {
+            "type": "custom",
+            "main": "src/index.ts",
+            "candid": "src/index.did",
+            "build": "npx azle canister",
+            "wasm": ".azle/canister/canister.wasm",
+            "gzip": true,
+            "declarations": {
+                "output": "test/dfx_generated/canister",
+                "node_compatibility": true
+            }
+        }
+    }
+}