From 2a303e99097ba7e41d2b5ea8e90b24d7545d4399 Mon Sep 17 00:00:00 2001
From: Pejman Ghorbanzade <pejman@ghorbanzade.com>
Date: Sat, 30 Sep 2023 17:35:18 -0700
Subject: [PATCH] [cppcon23] update slides

---
 slides/cppcon23/pages/03_tooling.md | 93 ++++++++++++++++++++++++-----
 1 file changed, 79 insertions(+), 14 deletions(-)

diff --git a/slides/cppcon23/pages/03_tooling.md b/slides/cppcon23/pages/03_tooling.md
index 568e1ba..b646005 100644
--- a/slides/cppcon23/pages/03_tooling.md
+++ b/slides/cppcon23/pages/03_tooling.md
@@ -86,17 +86,29 @@ the system we are changing is old and legacy. Touca needs to support this
 use-case and support most versions of GCC, Clang, and MSVC with that same logic.
 
 To support older standard versions, the SDK has a few dependencies, listed here,
-so we don't provide single-header installation. Instead you can build and
+so we don't offer single-header installation. Instead you can build and
 install Touca with CMake and pull it as a dependency using FetchContent.
-We also have limited support Conan and Bazel.
+We also have limited support for Conan and Bazel.
 -->
 
 ---
 slide: Data Capturing API
 ---
 
-<div class="grid grid-cols-2 gap-2">
-  <div class="grid wsl-code-h-full">
+<div class="grid grid-cols-7 gap-2">
+  <div class="col-span-5 grid wsl-code-h-full">
+
+```cpp {|3-5}
+touca::workflow("students", [](const std::string& username) {
+  const auto& student = find_student(username);
+  touca::check("name", student.name);
+  touca::check("birth_date", student.dob);
+  touca::check("gpa", student.gpa);
+});
+```
+
+  </div>
+  <div v-click class="col-span-2 grid wsl-code-h-full">
 
 ```cpp
 struct Date {
@@ -107,16 +119,7 @@ struct Date {
 ```
 
   </div>
-  <div class="grid wsl-code-h-full">
-
-```cpp
-touca::check("name", student.name);
-touca::check("birth_date", student.dob);
-touca::check("gpa", student.gpa);
-```
-
-  </div>
-  <div class="col-span-2">
+  <div v-click class="col-span-7">
 
 ```cpp
 template <typename Char, typename Value>
@@ -129,11 +132,35 @@ void check(Char&& key, const Value& value) {
   </div>
 </div>
 
+<!--
+Now we learned what a simple test workflow looked like with Touca.
+Let's now focus on the main data capturing API function used in that sample
+test workflow: `touca::check`.
+
+(click)
+
+We want capturing of data points to be easy and developer friendly, so these
+functions provides out-of-the-box support for any primitive and standard data
+type and is designed to be extensible to support any custom user-defined type.
+
+(click)
+
+Take date of birth for example which could be defined as a Date object with
+the structure presented here.
+
+(click)
+
+We implement the high-level user-facing function as shown here, to perfect
+forward the type of the given value parameter to a class template serializer
+that enables template specialization for any custom type.
+-->
+
 ---
 slide: Data Capturing Internals
 ---
 
 <div class="space-y-2 wsl-code-p-sm">
+<div>
 
 ```cpp
 void touca::detail::check(const std::string& key, const data_point& value) {
@@ -141,6 +168,9 @@ void touca::detail::check(const std::string& key, const data_point& value) {
 }
 ```
 
+</div>
+<div v-click>
+
 ```cpp
 void Client::check(const std::string& key, const data_point& value) {
   if (has_last_testcase()) {
@@ -149,6 +179,9 @@ void Client::check(const std::string& key, const data_point& value) {
 }
 ```
 
+</div>
+<div v-click>
+
 ```cpp
 void Testcase::check(const std::string& key, const data_point& value) {
   _resultsMap.emplace(key, ResultEntry{value, ResultCategory::Check});
@@ -157,6 +190,38 @@ void Testcase::check(const std::string& key, const data_point& value) {
 ```
 
 </div>
+</div>
+
+<!--
+But before we focus on serialization, let's review a few key design decisions
+behind these data capturing functions:
+
+`touca::check` as well as all other data capturing functions, are designed to
+temporarily store a copy of any interesting data point and once the workflow
+is executed for a given test case, submit all captured data points to the
+Touca server.
+
+To satisfy this use-case, all Touca data capturing functions are stateful,
+and are implemented to hold captured data in a good old singleton.
+
+(click)
+
+As you may have noticed, touca:check is also a stand-alone function so we can
+call it from anywhere within our code, including from the implementation of
+our production code. This design enables tracking important data points that may
+not be exposed in the output of our software or accessible from its interface.
+
+But because capturing data points in production environments doesn't make sense,
+Touca data capturing functions are implemented to be default no-op unless they
+are called from the test framework or explicitly activated via calling the
+touca::configure function.
+
+(click)
+
+And the library has a mechanism to avoid submitting captured data points for
+test cases that have been submitted before, unless new data is captured
+for those data points.
+-->
 
 ---
 section: Data Serialization