From d951edad6155898f44fd660de916765c60568c1c Mon Sep 17 00:00:00 2001
From: Michael Shanks <mike@budibase.com>
Date: Fri, 11 Sep 2020 09:53:02 +0100
Subject: [PATCH] some comments

---
 packages/builder/src/builderStore/fetchBindableProperties.js | 2 ++
 packages/builder/src/builderStore/replaceBindings.js         | 4 ++--
 .../userInterface/EventsEditor/actions/SaveFields.svelte     | 2 ++
 .../components/userInterface/EventsEditor/actions/index.js   | 5 +++++
 packages/client/src/state/eventHandlers.js                   | 3 +++
 5 files changed, 14 insertions(+), 2 deletions(-)

diff --git a/packages/builder/src/builderStore/fetchBindableProperties.js b/packages/builder/src/builderStore/fetchBindableProperties.js
index 469c357212..65cc861c50 100644
--- a/packages/builder/src/builderStore/fetchBindableProperties.js
+++ b/packages/builder/src/builderStore/fetchBindableProperties.js
@@ -83,6 +83,8 @@ const contextToBindables = (models, walkResult) => context => {
     readableBinding: `${context.instance._instanceName}.${context.model.label}.${key}`,
   })
 
+  // see ModelViewSelect.svelte for the format of context.model
+  // ... this allows us to bind to Model scheams, or View schemas
   const model = models.find(m => m._id === context.model.modelId)
   const schema = context.model.isModel
     ? model.schema
diff --git a/packages/builder/src/builderStore/replaceBindings.js b/packages/builder/src/builderStore/replaceBindings.js
index 38cb67951d..ce2d5fe163 100644
--- a/packages/builder/src/builderStore/replaceBindings.js
+++ b/packages/builder/src/builderStore/replaceBindings.js
@@ -4,7 +4,7 @@ export function readableToRuntimeBinding(bindableProperties, textWithBindings) {
   // Find all instances of mustasche
   const boundValues = textWithBindings.match(CAPTURE_VAR_INSIDE_MUSTACHE)
 
-  // Replace with names:
+  // Replace readableBindings with runtimeBindings
   boundValues &&
     boundValues.forEach(boundValue => {
       const binding = bindableProperties.find(({ readableBinding }) => {
@@ -27,7 +27,7 @@ export function runtimeToReadableBinding(bindableProperties, textWithBindings) {
       textWithBindings.match(CAPTURE_VAR_INSIDE_MUSTACHE)) ||
     []
 
-  // Replace with names:
+  // Replace runtimeBindings with readableBindings:
   boundValues.forEach(v => {
     const binding = bindableProperties.find(({ runtimeBinding }) => {
       return v === `{{ ${runtimeBinding} }}`
diff --git a/packages/builder/src/components/userInterface/EventsEditor/actions/SaveFields.svelte b/packages/builder/src/components/userInterface/EventsEditor/actions/SaveFields.svelte
index d8870e6f18..230416fede 100644
--- a/packages/builder/src/components/userInterface/EventsEditor/actions/SaveFields.svelte
+++ b/packages/builder/src/components/userInterface/EventsEditor/actions/SaveFields.svelte
@@ -1,4 +1,5 @@
 <script>
+  // accepts an array of field names, and outputs an object of { FieldName: value }
   import { Select, Label, TextButton, Spacer } from "@budibase/bbui"
   import { store, backendUiStore } from "builderStore"
   import fetchBindableProperties from "builderStore/fetchBindableProperties"
@@ -51,6 +52,7 @@
 
   const rebuildParameters = () => {
     // rebuilds paramters.fields every time a field name or value is added
+    // as UI below is bound to "fields" array, but we need to output a { key: value }
     const newParameterFields = {}
     for (let field of fields) {
       if (field.name) {
diff --git a/packages/builder/src/components/userInterface/EventsEditor/actions/index.js b/packages/builder/src/components/userInterface/EventsEditor/actions/index.js
index d0aad61d8f..e1a85e307e 100644
--- a/packages/builder/src/components/userInterface/EventsEditor/actions/index.js
+++ b/packages/builder/src/components/userInterface/EventsEditor/actions/index.js
@@ -2,6 +2,11 @@ import NavigateTo from "./NavigateTo.svelte"
 import UpdateRecord from "./UpdateRecord.svelte"
 import CreateRecord from "./CreateRecord.svelte"
 
+// defines what actions are available, when adding a new one
+// the component is the setup panel for the action
+// NOTE that the "name" is used by the client library,
+// so if you want to change it, you must change it client lib too
+
 export default [
   {
     name: "Create Record",
diff --git a/packages/client/src/state/eventHandlers.js b/packages/client/src/state/eventHandlers.js
index 3679610fe2..05d8ef2fa3 100644
--- a/packages/client/src/state/eventHandlers.js
+++ b/packages/client/src/state/eventHandlers.js
@@ -14,6 +14,7 @@ export const eventHandlers = routeTo => {
   // when an event is called, this is what gets run
   const runEventActions = async (actions, state) => {
     if (!actions) return
+    // calls event handlers sequentially
     for (let action of actions) {
       const handler = handlers[action[EVENT_TYPE_MEMBER_NAME]]
       const parameters = createParameters(action.parameters, state)
@@ -26,6 +27,8 @@ export const eventHandlers = routeTo => {
   return runEventActions
 }
 
+// this will take a parameters obj, iterate all keys, and do a mustache render
+// for every string. It will work recursively if it encounnters an {}
 const createParameters = (parameterTemplateObj, state) => {
   const parameters = {}
   for (let key in parameterTemplateObj) {