Merge pull request #302 from nyaruka/flow_revision

Flow revision number

Author: rowanseymour

docs/docs.md

@@ -254,6 +254,7 @@ properties which can be accessed:
 
  * `uuid` the UUID of the flow
  * `name` the name of the flow
+ * `revision` the revision number of the flow
 
 Examples:
 
@@ -262,7 +263,7 @@ Examples:
 @run.flow → Registration
 @child.flow → Collect Age
 @run.flow.uuid → 50c3706e-fedb-42c0-8eab-dda3335714b7
-@(json(run.flow)) → {"name":"Registration","uuid":"50c3706e-fedb-42c0-8eab-dda3335714b7"}
+@(json(run.flow)) → {"name":"Registration","revision":123,"uuid":"50c3706e-fedb-42c0-8eab-dda3335714b7"}
 ```
 
 <a name="context:group"></a>

docs/index.html

@@ -363,12 +363,13 @@ <h2 id="flow">Flow</h2>
 <ul>
 <li><code>uuid</code> the UUID of the flow</li>
 <li><code>name</code> the name of the flow</li>
+<li><code>revision</code> the revision number of the flow</li>
 </ul>
 <p>Examples:</p>
 <div class="sourceCode" id="cb10"><pre class="sourceCode objectivec"><code class="sourceCode objectivec"><a class="sourceLine" id="cb10-1" data-line-number="1">@run.flow → Registration</a>
 <a class="sourceLine" id="cb10-2" data-line-number="2">@child.flow → Collect Age</a>
 <a class="sourceLine" id="cb10-3" data-line-number="3">@run.flow.uuid → 50c3706e-fedb-42c0-8eab-dda3335714b7</a>
-<a class="sourceLine" id="cb10-4" data-line-number="4">@(json(run.flow)) → {<span class="st">&quot;name&quot;</span>:<span class="st">&quot;Registration&quot;</span>,<span class="st">&quot;uuid&quot;</span>:<span class="st">&quot;50c3706e-fedb-42c0-8eab-dda3335714b7&quot;</span>}</a></code></pre></div>
+<a class="sourceLine" id="cb10-4" data-line-number="4">@(json(run.flow)) → {<span class="st">&quot;name&quot;</span>:<span class="st">&quot;Registration&quot;</span>,<span class="st">&quot;revision&quot;</span>:<span class="dv">123</span>,<span class="st">&quot;uuid&quot;</span>:<span class="st">&quot;50c3706e-fedb-42c0-8eab-dda3335714b7&quot;</span>}</a></code></pre></div>
 <p><a name="context:group"></a></p>
 <h2 id="group">Group</h2>
 <p>Represents a grouping of contacts. It can be static (contacts are added and removed manually through <a href="#action:add_contact_groups">actions</a>) or dynamic (contacts are added automatically by a query). It renders as its name in a template, and has the following properties which can be accessed:</p>

flows/definition/flow.go

@@ -12,6 +12,7 @@ import (
 type flow struct {
 	uuid               flows.FlowUUID
 	name               string
+	revision           int
 	language           utils.Language
 	expireAfterMinutes int
 
@@ -26,10 +27,11 @@ type flow struct {
 
 type FlowObj = flow
 
-func NewFlow(uuid flows.FlowUUID, name string, language utils.Language, expireAfterMinutes int, localization flows.Localization, nodes []flows.Node, ui map[string]interface{}) (flows.Flow, error) {
+func NewFlow(uuid flows.FlowUUID, name string, revision int, language utils.Language, expireAfterMinutes int, localization flows.Localization, nodes []flows.Node, ui map[string]interface{}) (flows.Flow, error) {
 	f := &flow{
 		uuid:               uuid,
 		name:               name,
+		revision:           revision,
 		language:           language,
 		expireAfterMinutes: expireAfterMinutes,
 		localization:       localization,
@@ -63,6 +65,7 @@ func NewFlow(uuid flows.FlowUUID, name string, language utils.Language, expireAf
 
 func (f *flow) UUID() flows.FlowUUID                   { return f.uuid }
 func (f *flow) Name() string                           { return f.name }
+func (f *flow) Revision() int                          { return f.revision }
 func (f *flow) Language() utils.Language               { return f.language }
 func (f *flow) ExpireAfterMinutes() int                { return f.expireAfterMinutes }
 func (f *flow) Nodes() []flows.Node                    { return f.nodes }
@@ -107,6 +110,8 @@ func (f *flow) Resolve(env utils.Environment, key string) types.XValue {
 		return types.NewXText(string(f.UUID()))
 	case "name":
 		return types.NewXText(f.name)
+	case "revision":
+		return types.NewXNumberFromInt(f.revision)
 	}
 
 	return types.NewXResolveError(f, key)
@@ -122,7 +127,7 @@ func (f *flow) Reduce(env utils.Environment) types.XPrimitive {
 
 // ToXJSON is called when this type is passed to @(json(...))
 func (f *flow) ToXJSON(env utils.Environment) types.XText {
-	return types.ResolveKeys(env, f, "uuid", "name").ToXJSON(env)
+	return types.ResolveKeys(env, f, "uuid", "name", "revision").ToXJSON(env)
 }
 
 var _ flows.Flow = (*flow)(nil)
@@ -151,6 +156,7 @@ func (f *flow) buildNodeMap() error {
 type flowEnvelope struct {
 	UUID               flows.FlowUUID `json:"uuid"               validate:"required,uuid4"`
 	Name               string         `json:"name"               validate:"required"`
+	Revision           int            `json:"revision"`
 	Language           utils.Language `json:"language"`
 	ExpireAfterMinutes int            `json:"expire_after_minutes"`
 	Localization       localization   `json:"localization"`
@@ -173,7 +179,7 @@ func ReadFlow(data json.RawMessage) (flows.Flow, error) {
 		nodes[n] = envelope.Nodes[n]
 	}
 
-	return NewFlow(envelope.UUID, envelope.Name, envelope.Language, envelope.ExpireAfterMinutes, envelope.Localization, nodes, nil)
+	return NewFlow(envelope.UUID, envelope.Name, envelope.Revision, envelope.Language, envelope.ExpireAfterMinutes, envelope.Localization, nodes, nil)
 }
 
 // MarshalJSON marshals this flow into JSON
@@ -182,6 +188,7 @@ func (f *flow) MarshalJSON() ([]byte, error) {
 		flowEnvelope: flowEnvelope{
 			UUID:               f.uuid,
 			Name:               f.name,
+			Revision:           f.revision,
 			Language:           f.language,
 			ExpireAfterMinutes: f.expireAfterMinutes,
 		},

flows/interfaces.go

@@ -136,13 +136,14 @@ type SessionAssets interface {
 //
 //  * `uuid` the UUID of the flow
 //  * `name` the name of the flow
+//  * `revision` the revision number of the flow
 //
 // Examples:
 //
 //   @run.flow -> Registration
 //   @child.flow -> Collect Age
 //   @run.flow.uuid -> 50c3706e-fedb-42c0-8eab-dda3335714b7
-//   @(json(run.flow)) -> {"name":"Registration","uuid":"50c3706e-fedb-42c0-8eab-dda3335714b7"}
+//   @(json(run.flow)) -> {"name":"Registration","revision":123,"uuid":"50c3706e-fedb-42c0-8eab-dda3335714b7"}
 //
 // @context flow
 type Flow interface {
@@ -151,6 +152,7 @@ type Flow interface {
 
 	UUID() FlowUUID
 	Name() string
+	Revision() int
 	Language() utils.Language
 	ExpireAfterMinutes() int
 	Localization() Localization

legacy/definition.go

@@ -32,10 +32,9 @@ func (s *decimalString) UnmarshalJSON(data []byte) error {
 	return nil
 }
 
-// TODO need to match what we generate at https://github.com/nyaruka/rapidpro/blob/master/temba/api/models.py#L217
 var legacyWebhookBody = `{
 	"contact": {"uuid": "@contact.uuid", "name": "@contact.name", "urn": @(json(if(default(run.input.urn, default(contact.urns.0, null)), text(default(run.input.urn, default(contact.urns.0, null))), null)))},
-	"flow": {"uuid": "@run.flow.uuid", "name": "@run.flow.name"},
+	"flow": @(json(run.flow)),
 	"path": @(json(run.path)),
 	"results": @(json(run.results)),
 	"run": {"uuid": "@run.uuid", "created_on": "@run.created_on"},
@@ -75,10 +74,11 @@ func (n *Note) Migrate() Sticky {
 
 // Metadata is the metadata section of a legacy flow
 type Metadata struct {
-	UUID    flows.FlowUUID `json:"uuid" validate:"required,uuid4"`
-	Name    string         `json:"name"`
-	Expires int            `json:"expires"`
-	Notes   []Note         `json:"notes,omitempty"`
+	UUID     flows.FlowUUID `json:"uuid" validate:"required,uuid4"`
+	Name     string         `json:"name"`
+	Revision int            `json:"revision"`
+	Expires  int            `json:"expires"`
+	Notes    []Note         `json:"notes,omitempty"`
 }
 
 type Rule struct {
@@ -1048,6 +1048,7 @@ func (f *Flow) Migrate(includeUI bool) (flows.Flow, error) {
 	return definition.NewFlow(
 		f.Metadata.UUID,
 		f.Metadata.Name,
+		f.Metadata.Revision,
 		f.BaseLanguage,
 		f.Metadata.Expires,
 		localization,

legacy/testdata/actions.json

@@ -91,7 +91,7 @@
                 "Content-Type": "application/json",
                 "User-Agent": "rapidpro"
             },
-            "body": "{\n\t\"contact\": {\"uuid\": \"@contact.uuid\", \"name\": \"@contact.name\", \"urn\": @(json(if(default(run.input.urn, default(contact.urns.0, null)), text(default(run.input.urn, default(contact.urns.0, null))), null)))},\n\t\"flow\": {\"uuid\": \"@run.flow.uuid\", \"name\": \"@run.flow.name\"},\n\t\"path\": @(json(run.path)),\n\t\"results\": @(json(run.results)),\n\t\"run\": {\"uuid\": \"@run.uuid\", \"created_on\": \"@run.created_on\"},\n\t\"input\": @(json(run.input)),\n\t\"channel\": @(json(if(run.input, run.input.channel, null)))\n}"
+            "body": "{\n\t\"contact\": {\"uuid\": \"@contact.uuid\", \"name\": \"@contact.name\", \"urn\": @(json(if(default(run.input.urn, default(contact.urns.0, null)), text(default(run.input.urn, default(contact.urns.0, null))), null)))},\n\t\"flow\": @(json(run.flow)),\n\t\"path\": @(json(run.path)),\n\t\"results\": @(json(run.results)),\n\t\"run\": {\"uuid\": \"@run.uuid\", \"created_on\": \"@run.created_on\"},\n\t\"input\": @(json(run.input)),\n\t\"channel\": @(json(if(run.input, run.input.channel, null)))\n}"
         },
         "expected_localization": {}
     },

legacy/testdata/flows.json

@@ -4,6 +4,7 @@
             "metadata": {
                 "uuid": "76f0a02f-3b75-4b86-9064-e9195e1b3a02",
                 "name": "Simple",
+                "revision": 123,
                 "notes": [
                     {
                         "y": 22.3435, 
@@ -41,6 +42,7 @@
         "expected": {
             "uuid": "76f0a02f-3b75-4b86-9064-e9195e1b3a02",
             "name": "Simple",
+            "revision": 123,
             "language": "eng",
             "expire_after_minutes": 0,
             "localization": {

legacy/testdata/rulesets.json

@@ -471,7 +471,7 @@
                         "Content-Type": "application/json",
                         "User-Agent": "RapidPro"
                     },
-                    "body": "{\n\t\"contact\": {\"uuid\": \"@contact.uuid\", \"name\": \"@contact.name\", \"urn\": @(json(if(default(run.input.urn, default(contact.urns.0, null)), text(default(run.input.urn, default(contact.urns.0, null))), null)))},\n\t\"flow\": {\"uuid\": \"@run.flow.uuid\", \"name\": \"@run.flow.name\"},\n\t\"path\": @(json(run.path)),\n\t\"results\": @(json(run.results)),\n\t\"run\": {\"uuid\": \"@run.uuid\", \"created_on\": \"@run.created_on\"},\n\t\"input\": @(json(run.input)),\n\t\"channel\": @(json(if(run.input, run.input.channel, null)))\n}"
+                    "body": "{\n\t\"contact\": {\"uuid\": \"@contact.uuid\", \"name\": \"@contact.name\", \"urn\": @(json(if(default(run.input.urn, default(contact.urns.0, null)), text(default(run.input.urn, default(contact.urns.0, null))), null)))},\n\t\"flow\": @(json(run.flow)),\n\t\"path\": @(json(run.path)),\n\t\"results\": @(json(run.results)),\n\t\"run\": {\"uuid\": \"@run.uuid\", \"created_on\": \"@run.created_on\"},\n\t\"input\": @(json(run.input)),\n\t\"channel\": @(json(if(run.input, run.input.channel, null)))\n}"
                 }
             ],
             "router": {

test/session.go

@@ -48,6 +48,7 @@ var sessionAssets = `[
         "content": {
             "uuid": "50c3706e-fedb-42c0-8eab-dda3335714b7",
             "name": "Registration",
+            "revision": 123,
             "nodes": [
                 {
                     "uuid": "72a1f5df-49f9-45df-94c9-d86f7ea064e5",