note: As of npm 0.36.87, gem 0.34.52 and pypi 0.33.128 correlated sequences record distinct messages by default. That is, explicit testing of distinct messages is no longer needed. Use the distinct rule attribute to revert back to the old behavior. Please see documentation for more details.
durable_rules is a polyglot micro-framework for real-time, consistent and scalable coordination of events. With durable_rules you can track and analyze information about things that happen (events) by combining data from multiple sources to infer more complicated circumstances.
A full forward chaining implementation (A.K.A. Rete) is used to evaluate facts and massive streams of events in real time. A simple, yet powerful meta-linguistic abstraction lets you define simple and complex rulesets as well as control flow structures such as flowcharts, statecharts, nested statecharts and time driven flows.
The durable_rules core engine is implemented in C, which enables ultra fast rule evaluation as well as muti-language support. durable_rules relies on state of the art technologies: Node.js, Werkzeug, Sinatra are used to host rulesets written in JavaScript, Python and Ruby respectively. Inference state is cached using Redis. This allows for fault tolerant execution and scale-out without giving up performance.
durable_rules is cloud ready. It can easily be hosted and scaled in environments such as Amazon Web Services with EC2 instances and ElastiCache clusters. Or Heroku using web dynos and RedisLabs or RedisToGo.
Using your scripting language of choice, simply describe the event to match (antecedent) and the action to take (consequent). In this example the rule can be triggered by posting { "subject": "World" } to url http://localhost:5000/test/events.
Tip: once the test is running, from a terminal type:
curl -H "Content-type: application/json" -X POST -d '{"subject": "World"}' http://localhost:5000/test/events
var d = require('durable');
d.ruleset('test', function() {
// antecedent
whenAll: m.subject == 'World'
// consequent
run: console.log('Hello ' + m.subject)
});
d.runAll();from durable.lang import *
with ruleset('test'):
# antecedent
@when_all(m.subject == 'World')
def say_hello(c):
# consequent
print ('Hello {0}'.format(c.m.subject))
run_all()require "durable"
Durable.ruleset :test do
# antecedent
when_all (m.subject == "World") do
# consequent
puts "Hello #{m.subject}"
end
end
Durable.run_alldurable_rules super-power is the foward-chaining evaluation of rules. In other words, the repeated application of logical modus ponens to a set of facts or observed events to derive a conclusion. The example below shows a set of rules applied to a small knowledge base (set of facts).
var d = require('durable');
d.ruleset('animal', function() {
whenAll: {
first = m.predicate == 'eats' && m.object == 'flies'
m.predicate == 'lives' && m.object == 'water' && m.subject == first.subject
}
run: assert({ subject: first.subject, predicate: 'is', object: 'frog' })
whenAll: {
first = m.predicate == 'eats' && m.object == 'flies'
m.predicate == 'lives' && m.object == 'land' && m.subject == first.subject
}
run: assert({ subject: first.subject, predicate: 'is', object: 'chameleon' })
whenAll: m.predicate == 'eats' && m.object == 'worms'
run: assert({ subject: m.subject, predicate: 'is', object: 'bird' })
whenAll: m.predicate == 'is' && m.object == 'frog'
run: assert({ subject: m.subject, predicate: 'is', object: 'green' })
whenAll: m.predicate == 'is' && m.object == 'chameleon'
run: assert({ subject: m.subject, predicate: 'is', object: 'green' })
whenAll: m.predicate == 'is' && m.object == 'bird'
run: assert({ subject: m.subject, predicate: 'is', object: 'black' })
whenAll: +m.subject
run: console.log('fact: ' + m.subject + ' ' + m.predicate + ' ' + m.object)
whenStart: {
assert('animal', { subject: 'Kermit', predicate: 'eats', object: 'flies' });
assert('animal', { subject: 'Kermit', predicate: 'lives', object: 'water' });
assert('animal', { subject: 'Greedy', predicate: 'eats', object: 'flies' });
assert('animal', { subject: 'Greedy', predicate: 'lives', object: 'land' });
assert('animal', { subject: 'Tweety', predicate: 'eats', object: 'worms' });
}
});
d.runAll();from durable.lang import *
with ruleset('animal'):
@when_all(c.first << (m.predicate == 'eats') & (m.object == 'flies'),
(m.predicate == 'lives') & (m.object == 'water') & (m.subject == c.first.subject))
def frog(c):
c.assert_fact({ 'subject': c.first.subject, 'predicate': 'is', 'object': 'frog' })
@when_all(c.first << (m.predicate == 'eats') & (m.object == 'flies'),
(m.predicate == 'lives') & (m.object == 'land') & (m.subject == c.first.subject))
def chameleon(c):
c.assert_fact({ 'subject': c.first.subject, 'predicate': 'is', 'object': 'chameleon' })
@when_all((m.predicate == 'eats') & (m.object == 'worms'))
def bird(c):
c.assert_fact({ 'subject': c.m.subject, 'predicate': 'is', 'object': 'bird' })
@when_all((m.predicate == 'is') & (m.object == 'frog'))
def green(c):
c.assert_fact({ 'subject': c.m.subject, 'predicate': 'is', 'object': 'green' })
@when_all((m.predicate == 'is') & (m.object == 'chameleon'))
def grey(c):
c.assert_fact({ 'subject': c.m.subject, 'predicate': 'is', 'object': 'grey' })
@when_all((m.predicate == 'is') & (m.object == 'bird'))
def black(c):
c.assert_fact({ 'subject': c.m.subject, 'predicate': 'is', 'object': 'black' })
@when_all(+m.subject)
def output(c):
print('Fact: {0} {1} {2}'.format(c.m.subject, c.m.predicate, c.m.object))
@when_start
def start(host):
host.assert_fact('animal', { 'subject': 'Kermit', 'predicate': 'eats', 'object': 'flies' })
host.assert_fact('animal', { 'subject': 'Kermit', 'predicate': 'lives', 'object': 'water' })
host.assert_fact('animal', { 'subject': 'Greedy', 'predicate': 'eats', 'object': 'flies' })
host.assert_fact('animal', { 'subject': 'Greedy', 'predicate': 'lives', 'object': 'land' })
host.assert_fact('animal', { 'subject': 'Tweety', 'predicate': 'eats', 'object': 'worms' })
run_all()require "durable"
Durable.ruleset :animal do
when_all c.first = (m.predicate == "eats") & (m.object == "flies"),
(m.predicate == "lives") & (m.object == "water") & (m.subject == first.subject) do
assert :subject => first.subject, :predicate => "is", :object => "frog"
end
when_all c.first = (m.predicate == "eats") & (m.object == "flies"),
(m.predicate == "lives") & (m.object == "land") & (m.subject == first.subject) do
assert :subject => first.subject, :predicate => "is", :object => "chameleon"
end
when_all (m.predicate == "eats") & (m.object == "worms") do
assert :subject => m.subject, :predicate => "is", :object => "bird"
end
when_all (m.predicate == "is") & (m.object == "frog") do
assert :subject => m.subject, :predicate => "is", :object => "green"
end
when_all (m.predicate == "is") & (m.object == "chameleon") do
assert :subject => m.subject, :predicate => "is", :object => "green"
end
when_all (m.predicate == "is") & (m.object == "bird") do
assert :subject => m.subject, :predicate => "is", :object => "black"
end
when_all +m.subject do
puts "fact: #{m.subject} #{m.predicate} #{m.object}"
end
when_start do
assert :animal, { :subject => "Kermit", :predicate => "eats", :object => "flies" }
assert :animal, { :subject => "Kermit", :predicate => "lives", :object => "water" }
assert :animal, { :subject => "Greedy", :predicate => "eats", :object => "flies" }
assert :animal, { :subject => "Greedy", :predicate => "lives", :object => "land" }
assert :animal, { :subject => "Tweety", :predicate => "eats", :object => "worms" }
end
end
Durable.run_allThe combination of forward inference and durable_rules tolerance to failures on rule action dispatch, enables work coordination with data flow structures such as statecharts, nested states and flowcharts.
Tip: once the test is running, from a terminal type:
curl -H "Content-type: application/json" -X POST -d '{"subject": "approve", "amount": 100}' http://localhost:5000/expense/events
curl -H "Content-type: application/json" -X POST -d '{"subject": "approved"}' http://localhost:5000/expense/events
curl -H "Content-type: application/json" -X POST -d '{"subject": "approve", "amount": 100}' http://localhost:5000/expense/events/2
curl -H "Content-type: application/json" -X POST -d '{"subject": "denied"}' http://localhost:5000/expense/events/2
var d = require('durable');
d.statechart('expense', function() {
input: {
to: 'denied'
whenAll: m.subject == 'approve' && m.amount > 1000
run: console.log('expense denied')
to: 'pending'
whenAll: m.subject == 'approve' && m.amount <= 1000
run: console.log('requesting expense approval')
}
pending: {
to: 'approved'
whenAll: m.subject == 'approved'
run: console.log('expense approved')
to: 'denied'
whenAll: m.subject == 'denied'
run: console.log('expense denied')
}
denied: {}
approved: {}
});
d.runAll();from durable.lang import *
with statechart('expense'):
with state('input'):
@to('denied')
@when_all((m.subject == 'approve') & (m.amount > 1000))
def denied(c):
print ('expense denied')
@to('pending')
@when_all((m.subject == 'approve') & (m.amount <= 1000))
def request(c):
print ('requesting expense approval')
with state('pending'):
@to('approved')
@when_all(m.subject == 'approved')
def approved(c):
print ('expense approved')
@to('denied')
@when_all(m.subject == 'denied')
def denied(c):
print ('expense denied')
state('denied')
state('approved')
run_all()require "durable"
Durable.statechart :expense do
state :input do
to :denied, when_all((m.subject == "approve") & (m.amount > 1000)) do
puts "expense denied"
end
to :pending, when_all((m.subject == "approve") & (m.amount <= 1000)) do
puts "requesting expense approval"
end
end
state :pending do
to :approved, when_all(m.subject == "approved") do
puts "expense approved"
end
to :denied, when_all(m.subject == "denied") do
puts "expense denied"
end
end
state :approved
state :denied
end
Durable.run_alldurable_rules provides string pattern matching. Expressions are compiled down to a DFA, guaranteeing linear execution time in the order of single digit nano seconds per character (note: backtracking expressions are not supported).
Tip: once the test is running, from a terminal type:
curl -H "Content-type: application/json" -X POST -d '{"subject": "375678956789765"}' http://localhost:5000/test/events
curl -H "Content-type: application/json" -X POST -d '{"subject": "4345634566789888"}' http://localhost:5000/test/events
curl -H "Content-type: application/json" -X POST -d '{"subject": "2228345634567898"}' http://localhost:5000/test/events
var d = require('durable');
d.ruleset('test', function() {
whenAll: m.subject.matches('3[47][0-9]{13}')
run: console.log('Amex detected in ' + m.subject)
whenAll: m.subject.matches('4[0-9]{12}([0-9]{3})?')
run: console.log('Visa detected in ' + m.subject)
whenAll: m.subject.matches('(5[1-5][0-9]{2}|222[1-9]|22[3-9][0-9]|2[3-6][0-9]{2}|2720)[0-9]{12}')
run: console.log('Mastercard detected in ' + m.subject)
});
d.runAll();from durable.lang import *
with ruleset('test'):
@when_all(m.subject.matches('3[47][0-9]{13}'))
def amex(c):
print ('Amex detected {0}'.format(c.m.subject))
@when_all(m.subject.matches('4[0-9]{12}([0-9]{3})?'))
def visa(c):
print ('Visa detected {0}'.format(c.m.subject))
@when_all(m.subject.matches('(5[1-5][0-9]{2}|222[1-9]|22[3-9][0-9]|2[3-6][0-9]{2}|2720)[0-9]{12}'))
def mastercard(c):
print ('Mastercard detected {0}'.format(c.m.subject))
run_all()require "durable"
Durable.ruleset :test do
when_all m.subject.matches('3[47][0-9]{13}') do
puts "Amex detected in #{m.subject}"
end
when_all m.subject.matches('4[0-9]{12}([0-9]{3})?') do
puts "Visa detected in #{m.subject}"
end
when_all m.subject.matches('(5[1-5][0-9]{2}|222[1-9]|22[3-9][0-9]|2[3-6][0-9]{2}|2720)[0-9]{12}') do
puts "Mastercard detected in #{m.subject}"
end
end
Durable.run_alldurable_rules can also be used to solve traditional Production Business Rules problems. This example is an industry benchmark. Miss Manners has decided to throw a party. She wants to seat her guests such that adjacent people are of opposite sex and share at least one hobby.
Note how the benchmark flow structure is defined using a statechart to improve code readability without sacrificing performance nor altering the combinatorics required by the benchmark. For 128 guests, 438 facts, the execution time is less than 2 seconds in JavaScript and Python slightly above 2 seconds in Ruby. More details documented in this blog post.
IMac, 4GHz i7, 32GB 1600MHz DDR3, 1.12 TB Fusion Drive
Waltzdb is a constraint propagation problem for image recognition: given a set of lines in a 2D space, the system needs to interpret the 3D depth of the image. The first part of the algorithm consists of identifying four types of junctions, then labeling the junctions following Huffman-Clowes notation. Pairs of adjacent junctions constraint each other’s edge labeling. So, after choosing the labeling for an initial junction, the second part of the algorithm iterates through the graph, propagating the labeling constraints by removing inconsistent labels.
In this case too, the benchmark flow structure is defined using a statechart to improve code readability. The benchmark requirements are not altered. Execution time is around 3 seconds for the case of 4 regions and around 20 for the case of 50. More details documented in this blog post.
IMac, 4GHz i7, 32GB 1600MHz DDR3, 1.12 TB Fusion Drive
Reference Manual:
Blog: