ELM – The full journey

A couple of years ago, I went on a journey to learn Elm. By far, this is one of my favorite front end language (not a framework). This follows the functional programming paradigm, and please, before you give up, take a look at it. I build the whole blog series as a means for me to learn in small steps. The journey was worth the time.

  1. Starting out with Elm
  2. Gradual Learning
  3. Basic Architecture
  4. Anatomy of Elm
  5. Hello World
  6. Setting up a dev environment
  7. Let’s talk about model
  8. Let’s talk about update
  9. Finally the view
  10. Unit testing
  11. Input fields
  12. Basic debugging
  13. Working with backend services
  14. Functional programming
  15. Simple project
  16. Step 1 – displaying a single opening credit
  17. Step 2 – displaying a lit
  18. Step 3 – Navigating the pages
  19. Step 4 – Navigating pages – update
  20. Step 5 – Navigating pages – view

Approaching leadership with an agile mindset

It’s been a while I blogged about anything. Been busy with our digital initiative and, after that focusing on delivery. I was reading a tweet from Scot about why he was blogging, and it is for him more than others. I realized it is very true. So that is what lead to this blog.

So far, I have been blogging about technology, and for the next few blogs, I am going to blog about leadership and what I am learning day today.

Today I want to talk about how leaders collect information from their direct reports and how to be on top of ever moving roadmaps and deliverables. Also, what is important for you is important to them and vice versa.

One of the approaches I am trying out with my direct reports is daily standup in regular agile standup. This is a short meeting, and it follows the standard agile standup model. It goes like

  • What have you done today?
  • What are you planning on doing tomorrow?
  • Any blockers

One of the main reasons for me to do this to see if my priorities align with theirs and vice versa. In this model, no more weekly one-hour leadership meeting or their requests or important message is not buried in the ever-growing inbox. I started this practice recently, and so far, I found it very useful. In this meeting, I also give my update to the teams to know what I am doing daily, and they could give me feedback right away.  This also allows this transparency to everyone what everyone in the leadership is working on.

Other than those three above, I ask two additional pieces of information

  • production deployment
  • Any incidents

Since this is shared in a group setting, everyone knows what releases are happening, and if anyone is impacted by any incidents and shares any information.

If you all have any comments or suggestions to improve this, let me know. I am always interested in learning and improving.

#elmlang – Navigating the pages – part 3 View

So far, we have seen the Model and Update part of the navigation application. In this blog, we complete the whole project by connecting the final missing piece View.  First, let’s look at the output.

The first two lines on the screen are the two links—one to ‘All-Time Best’ and another to ‘Login.’ By default, ‘All-Time Best’ is set as Home, and if we pass any routes other than ‘Login,’ all routes will be routed to ‘All-Time Best.’ On page load, the page will look like the following; It loads ‘All-Time Best’ view.

image

When you click ‘Login,’ it will display the following.

image

In this example, if you notice, we have two sections, one is the top section, which contains hyperlinks to navigate, and then the view right below it to show the page’s content. For simplicity, we call the top section as header and the second part as the body. So view will contain the header and body.

view: Model –> Html Msg

view model =

div []

[ header

. body model

]

Like all the Elm applications, the view takes the model as input and generates the Html to generate messages. The model has two functions: header and the second one is body, which takes the model as a parameter.

Let’s review the header function first.

header: Html Msg

header =

div []

[ h3 []

[ a [ href “#alltimebest” ] [ text “All Time Best “ ]

, a [ href “#login” ] [ text “ Login” ]

]

]

The header function takes no parameter but generates Html. This function creates two hyperlinks (a tag). The only thing we need to pay attention to is the first parameter to href function. This string must match the strings in the update function.

case (hash) of
“#alltimebest” ->
AllTimeBest

“#login” ->
Login

Next, let’s define the body function.

body:Model –> Html Msg

body model =

case (model.page) of

AllTimeBest –>

alltimebest model

Login –>

login model

As you can imagine, we need to make sure we display an appropriate body based on the page requested. We did not display anything during the update function—all we did to change the page to the appropriate page in the model. Based on the page information in the model, we need to make sure we need to render appropriate content.

Based on the output we saw earlier, the all-time best and login function has nothing but a text to show page change happened. The function definitions of the pages are below.

alltimebest: Model –> Html Msg

alltimebest model =

h1 [] [ text “All Time Best” ]

login: Model –> Html Msg

login model =

h1 [] [ text “Login “]

Events leading up to view are

  • When someone wants to change a page, they click on the hyperlink
  • when the hyperlink is clicked, elm generates a navigation message (UrlChange)
  • The message triggers the update function
  • In the update function based on the change request, we create a new model with the page type requested
  • On completion of the model change, the view function is called
  • the view will turn around and call the body function with the current model
  • In body function, we check the model’s page type. If the page type is AllTimeBest then we call the ‘alltimebest’ function to create Html otherwise, we call Login

In summary, navigation is straightforward and simple in Elm. The things we need to know are

  • Use Navigation.program to connect Model, Update, and View
  • Have Model with the field which can hold the current page
  • In an update, handle Urlchange event with location parameter to change the Model
  • In view, use the Model’s current page to render the page in question

#elmlang – Navigating the pages – part 2 Update

In our previous blog, we looked at the application’s model side when building a SPA with navigation. In this blog, we will look at the update.

To summarize, the model changes, when building a SPA with navigations, are

  • The model needs to know the current page.
  • Instead of representing the page as a string, in Elm explicitly state the page by union type.
  • Setup initial page that we need to load during application startup

In an  update, there are two things we need to do

  • Define all the events our application is going to support
  • Define the actions when the events occur

Defining events:

We moved away from the beginner program in our navigation program, and now we are using Navigation.program. As mentioned in the previous blog, this function has all the beginner program’s goodies and more. When we use Navigation.program, one of the things it does when there is a URL change will trigger an event called UrlChange with location details. Since we removed all the noise in the application, UrlChange is the only interesting event. So let’s define the events.

type Msg

= UrlChange Navigation.Location

Whenever a user clicks a hyperlink in a program that triggers a URL change, the Navigation function will trigger the UrlChange event with all the information regarding the new URL and its attributes. Everything regarding how to fire the event is all wrapped up in the Navigation package.

Define actions:

When a user clicks a hyperlink to a new page, on clicking a hyperlink, the navigation function will create an event called UrlChange with the new location the user wants to go to. Anytime a new event is fired, our update function will be called first, and there we need to satisfy the user request. The update is where we act on the URL change request. Let’s take a moment to talk about what are the things we would need to display a new page

  • in Elm architecture; one will not call the rendered page directly
  • In Elm architecture, you modify the model which will trigger rendering a page
  • In the update, all we need to do is identify the page user intends to go and modify the current page with page user’s requested page

update : Msg -> Model -> ( Model, Cmd Msg )
update msg model =
case msg of
UrlChange location –>
({ model | page = (findpage location.hash) },  Cmd.none )

As usual, we are updating the model with the appropriate value in the update. When someone clicks on the hyperlink, the clicked hyperlink string will be available in the location.hash, we will use that to identify the page user wants to navigate to. Identifying the page user wants to navigate is encapsulated in the findpage function as shown below

findpage: String –> Page

findpage hash =

case (hash) of

“#alltimebest” –>

AllTimeBest

“#login” –>

Login

– ->

AllTimeBest

This is a straightforward function, which takes URL location as an input string and returns the page union type.

In summary, when using Navigation.Program,

  • one clicks a navigation link, elm will trigger UrlChange event with the URL link user clicked
  • when an event is fired, elm will call the programs update function
  • in the update, the function identifies the page user wants to navigate to and update the model with the page name
  • when a model is updated rendering page will be triggered by calling view

In the next blog, we will see how to modify the view to handle page navigation

#elmlang – Navigating the pages – part 1 Model

So far, we could create a simple elm application that can display a hardcoded list of best opening credits. As you can imagine, when building non-trivial applications, we will end up with multiple views, and based on user requests, we may need to swap the body with proper views. In the olden days, every page was recreated and redrawn, and in the new SPA world, only the portion of the DOM elements are swapped out with proper views.

In the SPA, you can think of a page with a header, body, and footer. Whenever a user clicks some header options, the body will be swapped out with appropriate views.

In Elm, we solve this with navigation and routing. Everything I learned on navigation and routing came from the following three awesome links.

Instead of adding navigation to the existing project, we will tackle navigation without any noise. So for our project, we are planning to have the following user selections

  • All-time best
  • Personal best
  • Trending now
  • About
  • Login

As the user selects any one of the options above, we will show an appropriate view.

To make this exercise simple and easy to follow, we will focus on just two of the five actions above,

  • All-time best
  • Login

To get this one going, we need to add another elm-package called ‘Navigation.’

elm package install elm-lang/navigation

Next, instead of using the beginner program as the lynchpin to connect model, view, and update, we will use Navigation.program.

So why are we using the Navigation.program instead of the beginner program? As the name suggests, this package wraps a lot of navigation-related activities and makes our development easy. For starters

  1. Navigation.program is wrapped on top of the Html.beginnerprogram (HTML.program), so all the things we learned to love are still there and more.
  2. Navigation notifies us every time there is a URL change.
  3. It also allows us to change the navigation.
  4. It provides us with a rich set of information to know what changed during URL change.

Like all our previous applications, we will start with the model. For the time being, ignore our application aspect of it but focus on the navigation aspect. While we are navigating between pages, what is the one thing that we care about? We need to know which page we are in. So we need to capture that as a field in our model. Good start, we know our model has one field, and it holds the current page name possibly. So what type should it be? Traditional thinking would make us define it to be String. But remember, we are in Elm, and we want to be as explicit as possible. In that case, instead of defining it as a string, we could define it to be a union type of all known pages. So, let’s start by defining all the known pages.

type Page =

    AllTimeBest

  | Login

So we defined a union type that defines all the possible pages we are going to support. With that, our model should be something like the following.

type alias Model =

   { page : Page

   }

We defined the model, and the next step is defining the initial state of the application.

initstate: Model

initstate =

   { page = AllTimeBest

  }

So far, nothing new. That is all for the model part; next, we will see the update part.

You can find the full source code the example here is https://github.com/ksunair/bestopeningcredits/blob/master/simplenav.elm

#Elmlang – Displaying a list

In the last blog, we continued our project to display a single best opening credit with a simple model. In this blog, we will see how do we go about displaying a list of opening credits.

Let’s start with the model. In the previous example, what we had was just one record with title and URL. Now to show a collection, we need to create a list of records. Let’s see how we would define the list of records.

type alias Model = List

{  title: String

, url: String

}

All we did in this definition compared to the previous one was to add ‘List’ in the definition. Even though this definition is all and good, there will be times where you will need to pass just a single record between functions, like displaying one record. So we need to split the definition to represent a record and list of records. With that refactoring, the definition would look like this.

type alias Model = List

Record

type alias Record =

{  title: String

, url : String

}

Here we defined a single record definition as record and then created a Model, a list of records.

Next, we modify the initial data to hold more than one best opening credits. So I added True Detective season 2 opening credits.

initData : Model
initData =
[ { title = “Game of Thrones”
, url = https://www.youtube.com/embed/s7L2PVdrb_8
}
, { title = “True Detective Season 2”
, url = https://www.youtube.com/embed/GJJfe1k9CeE
}
]

There will be no change to update function as there are no user interactions yet.

The view is going to be interesting. So far, all the controls we have created are all just single controls that never displayed anything that is a collection.  How do we go about doing this?

Let’s look at the view from the previous blog.

view : Model -> Html Msg
view model =
div []
[ h1 [] [ text initData.title ]
, iframe [ width 420, height 315, src initData.url ] []

]

The above view function takes Model and creates the view for Elm to render. Now that we modified the Model to List, we need to modify the definition to be Record instead of Model to display a single record.

view : Record-> Html Msg
view record=
div []
[ h1 [] [ text record.title ]
, iframe [ width 420, height 315, src record.url ] []

]

This can not be the view, because view needs to generate all the records to display, so let’s change the name of the view to a different name to represent what it does, displaying a single record.

displayLine : Record -> Html Msg
displayLine record =
div []
[ h1 [] [ text record.title ]
, iframe [ width 420, height 315, src record.url ] []
]

Now we need to modify the view to call this function for every record in the list, that is it. In Elm, there is no iteration or loop; instead, we will call the map function.

view : Model -> Html Msg
view model =
div []
(List.map displayLine model)

Let’s look at the view definition closer. View definition states that it takes Model (which is a list of records) and generates the HTML view for Elm to render. The view function definition has just one function call that is div. As stated in the previous blog, view function takes two arguments. The first set of arguments are the function attributes, and the second set of arguments is a list of children.  In the above definition, the second parameter is (List.map displayLine model), what does it mean?

Let’s look at the definition from left to right. There are three words in the statement. ‘List.map,’ ‘displayLine,’ and ‘model.’  We know the last two, ‘displayLine,’ which takes a record and displays the record’s title and url. The last parameter is ‘model,’ which is a list of records. So it looks like we are calling List.map function, with two parameters.

List.map’s first argument is a function that takes a list as a parameter and produces a list as a result.

If you look at our call, listen to displayLine for every record in the model, and generate a one-line display for the given record. List.map function always returns a list. Like all HTML function calls, Div function expects the second argument to be a list of children, and List.map returns the list of displayLine.

If you run the application, you should see a result similar to the following.

image

You can find the latest  code @ https://github.com/ksunair/bestopeningcredits

Let’s work on displaying single best opening credit – Elm

Continuing our project to display the best opening credits, let’s jump in start displaying hardcoded single best opening credit.

Before we start coding, let’s refresh quickly on the anatomy of Elm architecture. In Elm application, you have three separate parts, each doing its one task and one task only. The three components are

  • Model: This defines the datastore, and it also defines the initial state of an application.
  • Update: This section defines all the actions/events application supports and what do with the state of the application.
  • View: This defines the view of the application based on the state of the application.

Elm architecture is a straightforward one. In Elm, all the application state is maintained separately in the model.  On application start, Elm runtime will render the view using the initial state of the model. In the view, we define what all the events a user will be able to initiate are. When a user initiates an action or triggers an event, Elm run time will call the update function and pass in the incoming event/message and current state of the model. The update will act on the current state based on the event and create a new state, the new state of the application will then trigger view to render a new view with the updated state of the data.

Now with basics under our belt, let’s write a code that displays single best opening credits.

Like all the applications, let’s create a model first. There are always two questions we need to ask when defining a model (there are more, but for creating a trivial application, two is enough)

1. What is the definition of the model? What fields do we need? For this simple application, all we need is ‘title’ and a link youtube video of the opening credit

type alias Model =
{ title : String
, url : String
}

2. Now we know what data definition is, let’s create the initial data we want to display.

initData : Model

initData =
{ title = “Game of Thrones”
, url = https://www.youtube.com/embed/s7L2PVdrb_8
}

I want to call out two things: first, the idea of using a comma at the beginning of the line instead of the end. When we look at it seems a good coding practice, it is more than that in Elm. Since Elm is a functional programming language, the way a function is called will be different if you miss a comma.

The type definition is that even though Elm can infer the types, I would strongly recommend being explicit in your code and declaring the types. It helps for future code refactoring and maintenance.

Next Update. Since this is a trivial application with no user interaction, we will define a dummy update function. Again we will continue to ask the same two questions.

  1. What are the events we are expecting?

type Msg
= DoNothing

This is a dummy event to satisfy the beginnerProgram function,

2. What to do when an update function is called?

update : Msg -> Model -> Model
update msg model =
initData

Since there are no events to start with, we are not acting on any events.

Finally, the view. In the view, we are displaying just one record. The title will be bold and then link to the youtube video.

view : Model -> Html Msg
view model =
div []
[ h1 [] [ text initData.title ]
, iframe [ width 420, height 315, src initData.url ] []

]

Our view has the main ‘div’ with two children, one is h1, and another one is an iframe.

h1 does not have any attributes but has a child text which displays the title.

iframe has attributes of height, width, and the URL source.

That is it,

the final component which connects all together is the main

main =
beginnerProgram { model = initData, view = view, update = update }

run the elm reactor which will start the localhost:80 and selecting Main.elm will produce the following result

image

Starting Opening Credit Project in Elm & Horizon

Finally, I found some time to start the project. I am doing this project in a way to learn Elm.  To do full end-to-end development focusing on front end development, I wanted some lightweight back-end service. Initially, I was thinking of doing it with nodejs, but I realized there is a better one, especially for rapid development. Horizon is meant for that. I do not know much about it yet. I am planning to use this project to learn both of them.

Created the baseline for the project at https://github.com/ksunair/bestopeningcredits

For this project, I am using the Atom editor.  I am using the following packages

git-plus – to better integrate with Git

elm-format

language-elm – Syntax highlighting and auto-completion

linter-elm-make – Lint Elm

The main objectives of these projects are

  1. User should be able to login to the site using social media logins
  2. Each user should be able to nominate any of their favorite opening credits
  3. Every user gets to vote for their top 10
  4. Show all-time top 10 based on all user votes
  5. Show last week, month top 10

With this project, I intend to look at the following

  • Creating modules to separate the concerns
  • Create unit tests
  • Make HTTP calls
  • Manage routing and navigation

The base project is set up, and next blog we will see how we can create a simple page to allow users to nominate the opening credits.

Elm is pure functional programming language

While preparing for my presentation on ‘Introduction to Elm,’ I tried to prove Elm is a truly functional program by showing this below.

add: Int –> Int –> Int

add x y =

x + y

In the above example, the add function is pure; add function always creates the same output for a given input. So calling Add 2 3 will always return 5. It does not have anything of global scope or side effects. So if I were to introduce a global variable, Elm would go through a compiler error. I was expecting the following code to produce a compiler error.

num: Int

num = 10

add: Int –> Int –> Int

add x y =

num + x + y

Elm did not complain, and it worked. So if I were to pass, add 2 3,  and the result will be15. So in my mind, because the function depends on the outside variable num and someone can change num from outside, the add function is not pure, and thus Elm is not a functional programming language.

So I posted the question in Elm Slack Channel, and @mfeineis answered, “Elm is pure, and num is immutable,” then it hit me. I assumed few things as a normal imperative programmer would. The num is a variable and can be changed easily, but num is not a variable in functional programming, and there is no variable in Elm. So you can’t change the value of num. With that knowledge, if you were to look at the function, the function name is incorrect, it should reflect the function’s proper intention and be ‘addnumwithxandy.’

@jessta reply summed up the answer “ `num` and `10` are interchangeable because Elm is ‘referentially transparent.’ There’s no difference between a value and a variable containing that value.”

For the people, I owe an explanation. Hopefully, this blog helps, and for those helped me on the slack channel, big thanks.