Add log capture functionality to all interactions (#170)

Author: jribbink

.changeset/moody-moose-work.md

@@ -0,0 +1,5 @@
+---
+"@onflow/flow-js-testing": minor
+---
+
+Emulator logs are now captured when calling `executeScript`, `sendTransaction`, `deployContract`, and `deployContractByName`. They part of the tuple returned by these functions (i.e. `[result, error, logs]`) and are provided as an array of strings.

dev-test/deploy.test.js

@@ -36,6 +36,12 @@ describe("interactions - sendTransaction", () => {
     expect(address).toBe(serviceAccount)
   })
 
+  test("deploy basic contract - captures logs", async () => {
+    const name = "HelloWorld"
+    const [, , logs] = await shallPass(deployContractByName({name}))
+    expect(logs).toEqual(["contract added to account"])
+  })
+
   test("deploy basic contract - to service account, short notation", async () => {
     const name = "HelloWorld"
     await deployContractByName(name)

dev-test/interaction.test.js

@@ -63,6 +63,21 @@ describe("interactions - sendTransaction", () => {
     })
   })
 
+  test("sendTransaction - shall capture logs", async () => {
+    const [, , logs] = await shallPass(async () => {
+      const code = `
+        transaction{
+          prepare(signer: AuthAccount){
+            log("hello world")
+          }
+        }
+      `
+      return sendTransaction({code})
+    })
+
+    expect(logs).toEqual(["hello world"])
+  })
+
   test("sendTransaction - shall pass with signer address", async () => {
     const Alice = await getAccountAddress("Alice")
 
@@ -277,7 +292,7 @@ describe("interactions - executeScript", () => {
     return emulator.stop()
   })
 
-  test("executeScript - shall throw  when no code and name provided", async () => {
+  test("executeScript - shall throw when no code and name provided", async () => {
     shallThrow(async () => {
       return executeScript({})
     })
@@ -301,6 +316,23 @@ describe("interactions - executeScript", () => {
     })
   })
 
+  test("executeScript - shall capture logs", async () => {
+    const [, , logs] = await shallResolve(async () => {
+      const code = `
+        pub fun main(){
+          log("hello from cadence")
+          log("this second log has been captured!")
+        }
+      `
+      return executeScript({code})
+    })
+
+    expect(logs).toEqual([
+      "hello from cadence",
+      "this second log has been captured!",
+    ])
+  })
+
   test("executeScript - shall pass with short notation", async () => {
     const [result, err] = await shallResolve(executeScript("log-message"))
     expect(err).toBe(null)

docs/api.md

@@ -925,14 +925,25 @@ describe("interactions - sendTransaction", () => {
     const signers = [Alice]
     const args = ["Hello, Cadence"]
 
-    const [txResult, error] = await shallRevert(
+    // Catch any cadence error
+    let [txResult, error] = await shallRevert(
       sendTransaction({
         code,
         signers,
         args,
       })
     )
 
+    // Catch only specific panic message
+    let [txResult, error] = await shallRevert(
+      sendTransaction({
+        code,
+        signers,
+        args,
+      }),
+      "You shall not pass!"
+    )
+
     // Transaction result will hold status, events and error message
     console.log({txResult}, {error})
   })
@@ -1053,8 +1064,8 @@ const main = async () => {
   `
   const args = ["Hello, from Cadence"]
 
-  const [result, error] = await executeScript({code, args})
-  console.log({result}, {error})
+  const [result, error, logs] = await executeScript({code, args})
+  console.log({result}, {error}, {logs})
 
   // Stop emulator instance
   await emulator.stop()
@@ -1099,8 +1110,8 @@ const main = async () => {
   const args = ["Hello, from Cadence"]
 
   // We assume there is a file `scripts/log-message.cdc` under base path
-  const [result, error] = await executeScript("log-message", args)
-  console.log({result}, {error})
+  const [result, error, logs] = await executeScript("log-message", args)
+  console.log({result}, {error}, {logs})
 
   await emulator.stop()
 }
@@ -1171,8 +1182,8 @@ const main = async () => {
   const Alice = await getAccountAddress("Alice")
   const signers = [Alice]
 
-  const [result, error] = await sendTransaction({code, args, signers})
-  console.log({result}, {error})
+  const [result, error, logs] = await sendTransaction({code, args, signers})
+  console.log({result}, {error}, {logs})
 
   // Stop emulator instance
   await emulator.stop()
@@ -1214,10 +1225,10 @@ const main = async () => {
   // Define arguments we want to pass
   const args = ["Hello, Cadence"]
 
-  const [result, error] = await shallPass(
+  const [result, error, logs] = await shallPass(
     sendTransaction("log-message", [], args)
   )
-  console.log({result}, {error})
+  console.log({result}, {error}, {logs})
 
   // Stop the emulator instance
   await emulator.stop()

docs/execute-scripts.md

@@ -59,8 +59,8 @@ const main = async () => {
   `
   const args = ["Hello, from Cadence"]
 
-  const [result, error] = await executeScript({code, args})
-  console.log({result}, {error})
+  const [result, error, logs] = await executeScript({code, args})
+  console.log({result}, {error}, {logs})
 
   // Stop emulator instance
   await emulator.stop()
@@ -105,8 +105,8 @@ const main = async () => {
   const args = ["Hello, from Cadence"]
 
   // We assume there is a file `scripts/log-message.cdc` under base path
-  const [result, error] = await executeScript("log-message", args)
-  console.log({result}, {error})
+  const [result, error, logs] = await executeScript("log-message", args)
+  console.log({result}, {error}, {logs})
 
   await emulator.stop()
 }

docs/send-transactions.md

@@ -108,10 +108,10 @@ const main = async () => {
   // Define arguments we want to pass
   const args = ["Hello, Cadence"]
 
-  const [result, error] = await shallPass(
+  const [result, error, logs] = await shallPass(
     sendTransaction("log-message", [], args)
   )
-  console.log({result}, {error})
+  console.log({result}, {error}, {logs})
 
   // Stop the emulator instance
   await emulator.stop()

examples/08-execute-script.test.js

@@ -39,10 +39,28 @@ test("execute script", async () => {
   ]
   const name = "log-args"
 
-  const [fromCode] = await shallResolve(executeScript({code, args}))
-  const [fromFile] = await shallResolve(executeScript({name, args}))
+  const [fromCode, , logsFromCode] = await shallResolve(
+    executeScript({code, args})
+  )
+  const [fromFile, , logsFromFile] = await shallResolve(
+    executeScript({name, args})
+  )
+
+  // Expect logs to be as expected
+  const expectedLogs = [
+    "1337",
+    "true",
+    "Hello, Cadence",
+    "1.33700000",
+    "[1, 3, 3, 7]",
+    '{"name": "Cadence", "status": "active"}',
+  ]
+  expect(logsFromCode).toEqual(expectedLogs)
+  expect(logsFromFile).toEqual(expectedLogs)
+
   expect(fromCode).toBe(fromFile)
   expect(fromCode).toBe("42")
+  expect(fromFile).toBe("42")
 
   // "executeScript" also supports short form, accepting name of the file in "scripts folder
   // and array of arguments

examples/09-send-transaction.test.js

@@ -39,10 +39,19 @@ test("send transaction", async () => {
     sendTransaction({code, signers, args})
   )
   // 2. Providing "name" field to read Cadence template from file in "./transaction" folder
-  const [txFileResult] = await shallPass(sendTransaction({name, signers, args}))
+  const [txFileResult, , fileLogs] = await shallPass(
+    sendTransaction({name, signers, args})
+  )
 
   // 3. Providing name of the file in short form (name, signers, args)
-  const [txShortResult] = await shallPass(sendTransaction(name, signers, args))
+  const [txShortResult, , inlineLogs] = await shallPass(
+    sendTransaction(name, signers, args)
+  )
+
+  // Expect logs to be as expected
+  const expectedLogs = ["Hello from Cadence", Alice.toString(), Bob.toString()]
+  expect(fileLogs).toEqual(expectedLogs)
+  expect(inlineLogs).toEqual(expectedLogs)
 
   // Check that all transaction results are the same
   expect(txFileResult).toEqual(txInlineResult)