<html>
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
</head>
<body bgcolor="#FFFFFF" text="#000000">
<p><br>
</p>
<br>
<div class="moz-cite-prefix">On 7/12/2016 2:27 PM, Warren Young
wrote:<br>
</div>
<blockquote
cite="mid:CFE67C97-A0AE-4F79-A67E-AFC78D81A5B6@etr-usa.com"
type="cite">
<pre wrap="">On Jul 12, 2016, at 1:41 PM, John J. McDermott, CPLP <a class="moz-txt-link-rfc2396E" href="mailto:jjm@jkintl.com"><jjm@jkintl.com></a> wrote:
</pre>
<blockquote type="cite">
<pre wrap="">
Let's say I have an app that can generate two kinds of output. It is a front-end to a database It can be used with a JSON interface or it can present HTML as a traditional web page.
</pre>
</blockquote>
<pre wrap="">
Perfectly fine so far.
</pre>
<blockquote type="cite">
<pre wrap="">I *could* add a /html element to the path to say "output as html" but it would seldom -- if ever -- be used. I *could* add a checkbox to the web form so it would return JSON but it is unlikely a normal person would want that.
</pre>
</blockquote>
<pre wrap="">
Do you know a strong functional programming language? I don’t mean FP in the way that JavaScript is a Scheme dialect and therefore FP, or even in the way that Perl is FP as laid out in Dominus’ “Higher-Order Perl.” I mean FP as in Haskell, the ML family, Erlang, etc.</pre>
</blockquote>
Yeah. I haven't found them valuable for "production" software, but I
have used them.
<blockquote
cite="mid:CFE67C97-A0AE-4F79-A67E-AFC78D81A5B6@etr-usa.com"
type="cite">
<pre wrap="">
These languages teach you the value of thinking of functions in the mathematical sense, which is that any function called with a given set of arguments should always return the same result. Another way of saying the same thing is that functions should not have side effects.</pre>
</blockquote>
I completely agree. I detest side-effects.
<blockquote
cite="mid:CFE67C97-A0AE-4F79-A67E-AFC78D81A5B6@etr-usa.com"
type="cite">
<pre wrap="">
It is impossible to avoid all side effects in any practical program not doing pure mathematics, but we can minimize and restrict the scope of these side effects by thinking hard about where the boundaries should be. Strong FP languages sensitize you to this way of thinking.
In the context of this debate, the principles of tightly-scoped side effects and referential transparency tell us that if you should not have a a Dancer route that returns HTML in one context and JSON in another. Either the route must differ somehow or the parameters must differ.</pre>
</blockquote>
Ohhh, I hate to call it a "debate". I'm trying to look at "best
practices", particularly focusing on ease-of-use in different
scenarios.<br>
<br>
I do not want one route to return different things in different
contexts, per se, so perhaps I was unclear. I want:<br>
<a class="moz-txt-link-abbreviated" href="http://www.mysite.com">www.mysite.com</a> to behave in a way that a user would expect a website
to behave: forms, nice view, etc.<br>
<a class="moz-txt-link-abbreviated" href="http://www.mysite.com/db/table1">www.mysite.com/db/table1</a> or whatever to behave in a manner a JSON
user would expect. I don't want different names. Are you suggesting
I need (ignoring the actual names) <a class="moz-txt-link-abbreviated" href="http://www.mysite.com">www.mysite.com</a> and
json.mysite.com?<br>
<blockquote
cite="mid:CFE67C97-A0AE-4F79-A67E-AFC78D81A5B6@etr-usa.com"
type="cite">
<pre wrap="">
My preference is to put all JSON-returning Dancer routes under /api, then make all other routes return HTML. (That’s a simplification. My current app also has /pdf for the routes that return dynamically-generated PDFs, for example.)</pre>
</blockquote>
This is what I suggested above, I think.
<blockquote
cite="mid:CFE67C97-A0AE-4F79-A67E-AFC78D81A5B6@etr-usa.com"
type="cite">
<pre wrap="">
Where the HTML-returning routes need data returned by the JSON API, either:
1. Call the internal JSON-returning route handler from the HTML route handler and use its data to construct the HTML; or
2. Call back into the API from the client side via JS and construct HTML from the returned JSON data there.
An example of alternative 1 is:
sub getSomeData { … used below … }
get '/foo' => { # because not under /api, returns HTML
# Do stuff here
# ...
# Okay, we’re ready to return our page
return template '/foo' => {
oneElement => getSomeData(param 'bar'),
anotherElement => $variableComputedAbove,
}
};
prefix '/api' => {
prefix '/some' => {
get '/data' => \&getSomeData
};
};
</pre>
</blockquote>
I have done this in real life.<br>
<blockquote
cite="mid:CFE67C97-A0AE-4F79-A67E-AFC78D81A5B6@etr-usa.com"
type="cite">
<pre wrap="">
Here we have two routes, one returning HTML and one returning JSON, the first of which is implemented in terms of the second. Because of Dancer's automatic serializers, getSomeData() can return a normal Perl data structure that can either be consumed directly by the template used in the HTML case or be serialized to JSON for consumption on the client side via JS code.
Note the use of code references here to allow the HTML route handler to call the JSON route handler.
You can read more about this style of development in a series of articles I wrote for the fizzled Dancer 2015 Advent Calendar:
<a class="moz-txt-link-freetext" href="https://goo.gl/u900Ii">https://goo.gl/u900Ii</a>
A lesser design principle is that, to the greatest extent practical, you should push most of the code into the JSON side to reduce code duplication. The HTML/JS client-side code can also consume JSON, but the JSON API has little use for HTML.</pre>
</blockquote>
Agreed/<br>
<blockquote
cite="mid:CFE67C97-A0AE-4F79-A67E-AFC78D81A5B6@etr-usa.com"
type="cite">
<pre wrap="">
To drag this back onto the topic of this particular thread, it is immaterial in my view whether the values passed to the Dancer route come from the URL’s query parameters, are defined as part of the route, or are passed in via a POST call in the request body. Parameters are parameters, and a properly-written Dancer route handler should return the same data regardless of the exact mechanism used to pass those parameters.</pre>
</blockquote>
Hmmm. I don't want the HTML page to have to be JSON. I want a more
conventional form use (although it could be JSON).<br>
--john<br>
<br>
<div class="moz-signature">-- <br>
John J. McDermott, CPLP<br>
Learning and Performance Consultant<br>
jjm at jkintl.com 575/737-8556<br>
Check out my <a href="http://cybersecurity.learningtree.com">
security blog posts</a><br>
Add an A for the Arts To STEM and get STEAM and a strong engine to
move forward. </div>
</body>
</html>