Category: Dev
Part 4: Get Up and Running with #React and #TypeScript
The “Get Up and Running with React and TypeScript” series is made up of posts from chapters in my book “Hello React and TypeScript“. If you have questions, comments or corrections, please reach out to me in the comments or on Twitter @charleslbryant.
You can view the posts in this series on the Hello React and TypeScript category page.
Component Props and State
This sample gives an basic example of using props and state in your components.
Source Code
https://github.com/charleslbryant/hello-react-and-typescript/releases/tag/0.0.4
src/main.tsx
/// <reference path="../typings/tsd.d.ts" />
import * as React from 'react';
import * as DOM from 'react-dom';
import HelloWorld from './helloworld';
const root = document.getElementById('app');
class Main extends React.Component<any, any> {
constructor(props: any){
super(props);
}
public render() {
return (
<div>
<HelloWorld defaultName='World' />
</div>
);
}
}
DOM.render(<Main />, root);
The change to main.tsx is minor. Here is the one change.
return (
<div>
<HelloWorld defaultName='World' />
</div>
);
We are just passing defaultName to the HelloWorld component. This is doing exactly what you think it is, its setting the default value for who we are saying Hello to. Notice that this name is explicit in defining this input. It is a default value, the HelloWorld component can change this value and the assumption is that it may be changed.
Another thing to notice is the camelCasing.
All DOM properties and attributes (including event handlers) should be camelCased to be consistent with standard JavaScript style. https://facebook.github.io/react/docs/dom-differences.html
src/helloworld.tsx
/// <reference path="../typings/tsd.d.ts" />
import * as React from 'react';
export default class HelloWorld extends React.Component<any, any> {
constructor(props: any){
super(props);
this.state = { name: this.props.defaultName };
}
public render() {
return (
<div>
Hello { this.state.name }!
</div>
);
}
}
We made two changes to helloworld.tsx, but they are significant to the interactivity of our little application.
constructor(props: any){
super(props);
this.state = { name: this.props.defaultName };
}
In the constructor we are setting the initial state for this component. this.state is a plain JavaScript object. It is a mutable representation of the model for the view. this.state is expected to change over time as events occur in the component. In this sample we are initializing this.state with an object literal{ name: this.props.defaultName }.
this.props.defaultName was passed in from main.tsx. this.props is also a plain JavaScript object. The difference being it is an immutable representation data used by the component. this.props should not be changed and they are passed in by parent components. If you change props, they will be overwritten when the parent rerenders. Mutating props puts your component in an inconsisten state, so don’t do it.
return (
<div>Hello { this.state.name }!</div>
);
The next change is to the return value of the render method. We are using this.state.name to set the name dispayed in the UI.
In this sample we use this.props to initialize this.state. We know that we want to update the name of who we say hello to, so we are using a state object to represent the name. If we didn’t want to update name, we could use props directly. For example
return (
<div>Hello { this.props.name }!</div>
);
Using props like this is saying that we don’t expect this component to change the name. In fact, to make it explicit, we changed the name from defaultName to name. Also, main.txt would have to be changed from passing defaultName to name. Using props means we expect the parent to be in control of changing the value of props. Using state means we expect the component to be in control of its own state.
Pretty URLs in Aurelia
I went to a local MeetUp on Single Page Applications using Aurelia and TypeScript. As I sat there soaking up this sweet framework, I was wondering about the hashes (#) in the URL of the demo application. There is nothing wrong with hashes besides being an unfamiliar nuisance to the uninitiated user looking at the funny characters in the not so pretty URL. I still wanted to eradicate them.
Drama
Actually, there was a big fuss over URL hashes when Twitter and Facebook popularized their use and Google decided to index hashed URLs. There was a popular theme going on how hash bang breaks RFC 3986 and other “stop hacking my URLs” nonsense, but the hashes worked then and are still here today.
Solutions
HTML 5 offered up a solution to get rid of them, but older browsers aren’t HTML 5 compliant. Older browser these days is code word for IE9 and older.
Some benefits of not using hash routing are
- Future proofing SEO, Google deprecated hash URLs because of the HTML 5 standard.
- Isomorphic applications and server side rendering, hash only work with JavaScript in client side routing.
Yet, there is some weird comfort in knowing that I have the power to ditch the hash in my single page applications if I want to.
In some routing modules you get to choose between hash and pushstate routing. Hash routing uses window.location.hash. Pushstate uses the new History API in HTML 5, history.pushstate. I figured there has to be something similar in Aurelia, right?
Even though it will kill some IE browsers, I still want to know how to do pushstate in Aurelia, what if I don’t care about older browsers. After a little digging on the Aurelia GitHub repos, I found issue #16 and #225 on router and issue #21 on history-browser that seems to address this very thing. Now that I was so dirty after all of that digging, I also went the sensible developer route and just checked the documentation, it has a section on Configuring PushState. So, it seems setting pushState to true turns pushState on (duh) and I’m still not sure about what hashChange does.
I know this is bad form for a blog post, but I haven’t tried this. I am assuming that router can be configured by setting options for pushState and hashChange based on the research above.
So, I am posing this as something for me to try or for someone to help me set it right.
configureRouter(config) {
config.title = 'Hello World';
config.options.pushState = true;
config.options.hashChange = false;
...
}
There You Go
So, you seem to have options for Pretty URLs in Aurelia.
Part 3: Get Up and Running with #React and #TypeScript
The “Get Up and Running with React and TypeScript” series is made up of posts from chapters in my book “Hello React and TypeScript“. If you have questions, comments or corrections, please reach out to me in the comments or on Twitter @charleslbryant.
You can view the posts in this series on the Hello React and TypeScript category page.
Components in Separate Files
This sample demonstrates how to split your components into multiple files. It is still just the simple display Hello World, but now it is modular and reusable.
Source Code
https://github.com/charleslbryant/hello-react-and-typescript/releases/tag/0.0.3
The HTML is still exactly the same as sample #2.
src/main.tsx
We only have two changes to explore the main.tsx file.
/// <reference path="../typings/tsd.d.ts" />
import * as React from 'react';
import * as DOM from 'react-dom';
import HelloWorld from 'helloworld';//Add new import
const root = document.getElementById('app');
class Main extends React.Component<any, any> {
constructor(props: any){
super(props);
}
public render() {
return (
<HelloWorld />//Return our new HelloWorld component
);
}
}
DOM.render(<Main />, root);
Let’s look at the differences.
import HelloWorld from 'helloworld';
We added a new import to import the HelloWorld component.
return ( <HelloWorld /> );
Instead of returning the markup directly, we are returning the HelloWorld component and delegating the rendering of the markup to this new component. By having the markup in a separate component we can add <HelloWorld /> multiple times and only have to change it in one place. We have a single point of truth for what the markup for Hello World should be and we can reuse it.
To use external components they have to be in scope, which is why we imported it. Another point to make is that a React component needs to have only one root element. If we were to add more markup or components here, we would have to wrap it in a parent element.
Example:
return (
<div>
<HelloWorld />
<HelloWorld />
</div>
);
This would display “Hello World” twice. Notice how we started the component name with an uppercase letter, React expects components to start with uppercase and DOM elements to start with lowercase.
src/helloworld.tsx
/// <reference path="../typings/tsd.d.ts" />
import * as React from 'react';
export default class HelloWorld extends React.Component<any, any> {
constructor(props: any){
super(props);
}
public render() {
return (
<div>Hello World!</div>
);
}
}
If you paid attention to the previous sample you will notice that this is almost exactly like the old main.tsx. We copied main.tsx to a new file called helloworld.tsx. We gave the component class a new name and we deleted the import for DOM. We don’t need to import DOM because we don’t need to call anything from React.DOM.
That was pretty easy so I don’t think that we need to review this code.
Part 1 & 2: Get Up and Running with #React and #TypeScript
The “Get Up and Running with React and TypeScript” series is made up of posts from chapters in my book “Hello React and TypeScript“. If you have questions, comments or corrections, please reach out to me in the comments or on Twitter @charleslbryant.
You can view the posts in this series on the Hello React and TypeScript category page.
If you haven’t heard, I have been writing a little book called “Hello React and TypeScript“. Its a simple book that chronicles the steps I took to learn how to develop a React application using TypeScript and ES6.
I’m going to post some of the chapters here on my blog. This will provide an easy reference for me because the chapters are really a reorganization of notes that I took as I learned writing React with TypeScript/ES6. It is my hope that these posts may be helpful for someone looking to learn.
I will post the chapters, but I won’t keep them in sync with the book. If you want the latest and greatest, please check out the free book.
To start this series off we will look at the code samples. In this first post we will look at two chapters: Setting Up Samples and Component Basics. If you haven’t used React or TypeScript, I recommend you actually try out the code to get a better feel for React and TypeScript. You can reach out to me in the comments below or on Twitter @charleslbryant.
You can view the posts in this series on the Hello React and TypeScript category page.
Setting Up Samples
https://charleslbryant.gitbooks.io/hello-react-and-typescript/content/SettingUpSamples.html
Requirements
All of the code samples have a couple requirements
- npm package manager (Node 5.2.0 used in development)
- IE 10+ or similar modern browser that supports the History API
This first sample is the source for the basic development environment. This includes the packages and automation that will be used in the samples.
Note – to get the latest version of packages and automation you should clone the repository from root, https://github.com/charleslbryant/hello-react-and-typescript.git . We will make updates as we move along with new samples so version 0.0.1 is only a starting point.
Source Code
https://github.com/charleslbryant/hello-react-and-typescript/releases/tag/0.0.1
Installing
To install a sample you need to run npm to get the required dependencies. You should open a console at the root path of the sample directory and run
npm install
Then
tsd install
These commands will install the required npm packages and TypeScript Typings.
Run the Sample
To run the samples, open a console at the sample directory and run
gulp
This will kick off the default gulp task to run all the magic to compile TypeScript, bundle our dependencies and code into one bundle.js file, and move all of the files need to run the application to a dist folder, open the index.html page in a browser, and reload the site when changes are made to source files.
Basic React Component
https://charleslbryant.gitbooks.io/hello-react-and-typescript/content/Samples/ComponentBasic.html
This is a very basic example of a single React component. We could make it even simpler, but this example is still basic enough to start with.
Source Code
https://github.com/charleslbryant/hello-react-and-typescript/releases/tag/0.0.2
src/index.html
<!DOCTYPE html> <html lang="en"> <head> <title>Hello World</title> <link rel="stylesheet" href="css/bundle.css"/> </head> <body> <div id="app"></div> <script src="scripts/bundle.js"></script> </body> </html>
If you don’t understand this, I recommend that you find an introduction to HTML course online.
The important part of this file is
. We will tell React to inject its HTML output to this div.
src/main.tsx
/// <reference path="../typings/tsd.d.ts" />
import * as React from 'react';
import * as DOM from 'react-dom';
const root = document.getElementById('app');
class Main extends React.Component<any, any> {
constructor(props: any) {
super(props);
}
public render() {
return (
<div>Hello World</div>
;
);
}
}
DOM.render(<Main />, root);
If you know JavaScript, this may not look like your mama’s JavaScript. At the time I wrote this ES6 was only 6 months old and this sample is written with ES6. If you haven’t been following the exciting changes in JavaScript, a lot of the syntax may be new to you.
This is a JavaScript file with a .tsx extention. The .tsx extenstion let’s the TypeScript compiler know that this file needs to be compiled to JavaScript and contains React JSX. For the most part, this is just standard ES6 JavaScript. One of the good things about TypeScript is we can write our code with ES6/7 and compile it as ES5 or older JavaScript for older browsers.
Let’s break this code down line by line.
/// <reference path="../typings/tsd.d.ts" />
The very top of this file is a JavaScript comment. This is actually how we define references for TypeScript typing files. This let’s TypeScript know where to find the definitions for types used in the code. I am using a global definition file that points to all of the actual definitions. This reduces the number of references I need to list in my file to one.
import * as React from 'react'; import * as DOM from 'react-dom';
The import statements are new in JavaScript ES6. They define the modules that need to be imported so they can be used in the code.
const root = document.getElementById('app');
const is one of the new ES6 variable declaration that says that our variable is a constant or a read-only reference to a value. The root variable is set to the HTML element we want to output our React component to.
class Main extends React.Component<any, any> {
class is a new declaration for an un-hoisted, stict mode, function defined with prototype-based inheritance. That’s a lot of fancy words and if they mean nothing to you, its not important. Just knowing that class creates a JavaScript class is all you need to know or you can dig in athttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes.
Main is the name of the class.
extends says that the Main class will be created as a child of the React.Component<any, any>class.
React.Component<any, any> is a part of the TypeScript typing definition for React. This is saying that React.Component will allow the type any to be used for the components state and props objects (more on this later). any is a special TypeScript type that basically says allow any type to be used. If we wanted to restrict the props and state object to a specific type we would replace any with the type we are expecting. This looks like generics in C#.
constructor(props: any) {
super(props);
}
The contructor method is used to initialize the class. In our sample, we only call super(props) which calls the contructor method on our parent class React.Component passing any props that were passed into our constructor. We are using TypeScript to define the props as any type.
In additon to calling super we could also initialize the state of the component, bind events, and other tasks to get our component ready for use.
public render() {
return (
<div>Hello World</div>
);
}
Maybe the most important method in a React component is the render method. This is where the DOM for our component is defined. In our sample we are using JSX. We will talk about JSX later, just understand that it is like HTML and outputs JavaScript.
JSX is not a requirement. You could use plain JavaScript. We can rewrite this section of code as
public render() {
return (
React.createElement("div", null, "Hello World")
);
}
The render method returns the DOM for the component. After the return statement you put your JSX. In our sample, this is just a simple div that says Hello World. It is good practice to wrap your return expression in parenthesis.
DOM.render(<Main />, root);
Lastly, we call DOM.render and pass Main, the React component we just created, and root, the variable containing the element we want to output the component to.
That’s it, pretty simple and something we can easily build upon.
Event Sourcing: Stream Processign with Real-time Snapshots
I began writing this a long time ago after I viewed a talk on Event Sourcing by Greg Young. It was just a simple thought on maintaining the current snapshot of a projection of an event stream as events are generated. I eventually heard a talk called “Turning the database inside-out with Apache Samza” by Martin Kleppmann, http://www.confluent.io/blog/turning-the-database-inside-out-with-apache-samza/. The talk was awesome, as I mentioned in a previous post. It provided structure, understanding and coherence to the thoughts I had.
It still took a while to finish this post after seeing the talk (because I have too much going on), but I would probably still be stuck on this post for a long time if I hadn’t heard the talk and looked further into stream processing.
Event Sourcing
Event sourcing is the storing of a stream of facts that have occurred in a system. Facts are immutable. Once a fact is stored it can’t be changed or removed. Facts are captured as events.
An event is a representation of an action that occurred in the past. An event is usually an abstraction of some business intent and can have other properties or related data.
To get the state for a point in time we have to process all of the previous events to build up the state to the point in time.
State Projections
In our system we want to store events that happen in the system. We will use these events to figure out the current state of the system. When we need to know the current state of the system we calculate a left fold of the previous facts we have stored from the beginning of time to the last fact stored. We iterate over each fact, starting with the first one, calculating the change in state at each iteration. This produces a projection of the current transient state of the system. Projections of current state are transient because they don’t last long. As new facts are stored new projections have to be produced to get the new current state.
Projection Snapshots
Snapshots are sometimes shown in examples of event sourcing. Snapshots are a type of memoization used to help optimize rebuilding state. If we have to rebuild state from a large stream of facts, it can be cumbersome and slow. This is a problem when you want your system to be fast and responsive. So we take snapshots of a projection taken at various points in the stream so that we can begin rebuilding state from a snapshot instead of having to replay the entire stream. So, a snapshot is a cache of a projection of state at some point in time.
Snapshots in traditional event sourcing examples have a problem because the snapshot is a version of state for some version of a projection. A projection is a representation of state based on current understanding. When the understanding changes there are problems.
Snapshot Issues
Let’s say we have an application and we understand the state as a Contact object containing a name and address property. Let’s also say we have a couple facts that alter state. One fact is a new contact was created and is captured by a “Create Contact” event containing “Name” and “Address” data that is the name and address of a contact. Another fact is a contact changed their address and is captured by a “Change Contact Address” event containing “Address” data with the new address for a contact.
When a new contact is added a “Create Contact” event is stored. When a contact’s address is changed a “Change Contact Address” event is stored. To project the current state of a contact that has a “Create Contact” and “Change Contact Address” event stored, we first create a new Contact object, then get the first event, “Create Contact”, from the event store and update the Contact object from the event data. Then we get the “Change Contact Address’ event and update the Contact object with the new address from the event.
That was a lot of words, but very simple concept. We created a projection of state in the form of a Contact object and changed the state of the projection from stored events. What happens when we change the structure of the projection? Instead of a Contact object with Name and Address, we now have a Contact object with Name, Address1, Address2, City, State, and Zip. We now have a new version of the projection and previous snapshots made with other versions of the projection are invalid. To get a valid projection for the current state with the new projection we have to recalculate from the beginning of time.
Sometimes we don’t want the current state. What if we want to see state at some other point in time instead of the head of our event stream. We could optimized rebuilding a new projection by using some clever mapping to transform an old snapshot version to the new version of the projection. If there are many versions, we would have to make sure all supported versions are accounted for.
CQRS
We could use a CQRS architecture with event sourcing. Commands write events to the event store and queries read state from a projection snapshot. Queries would target a specific version of a projection. The application would be as consistent as the time it takes to take a new snapshot from the previous snapshot which was only one event earlier (fast).
Real-time Snapshots
A snapshot is like a cache of state and you know how difficult it is to invalidate state. If we instead create a real-time snapshot as facts are produced, we always have the current snapshot for a version of the projection. To maintain backwards compatibility we can have real-time snapshots for various versions of projections that we want to maintain. When we have a new version of a projection we start rebuilding state from the beginning of time. When the rebuilding has caught up with current state we start real-time snapshots. So, there will be a period of time where new versions of projections aren’t ready for consumption as they are being built. With real-time snapshots we don’t have to worry about running funky code to invalidate or rebuild state, just read the snapshot for the version of the projection that we want. When we don’t want to support a version of a projection, just take the endpoint that points to it offline. When we have a new version that is ready for consumption we bring a new endpoint online. When we want to upgrade or downgrade we just point to the endpoint we want.
Storage may be a concern if we are storing every snapshot of state. We could have a strategy to purge older snapshots. Deleting a snapshot is not a bad thing. We can always rebuild a projection from the event store. As long as we keep the events stored we can always create new projections or rebuild projections.
Conclusion
Well, this was just me trying to clean out a backlog of old posts and finishing some thoughts I had on real-time state snapshots from an event stream. If you want to read or see a much better examination of this subject visit “Turning the database inside-out with Apache Samza” by Martin Kleppmann, http://www.confluent.io/blog/turning-the-database-inside-out-with-apache-samza/. You can also check out implementations of the concepts with Apache Samza or something like it with Azure Steam Analytics.
Recent Talks with Big Effect on My Development
I have seen many, many development talks, actually an embarrassing amount. There have been many talks that have altered how I develop or think about development. Actually, since 2013, some talks have caused a major shift in how I think about full stack development, my mind has been in a major evolutionary cycle.
CQRS and Event Sourcing
My thought process about full stack development started down a new path when I attended Code on the Beach 2013. I watched a talk by Greg Young that included Event Sourcing, mind ignited.
Greg Young – Polyglot Data – Code on the Beach 2013
He actually followed this up at Code on the Beach 2014 with a talk on CQRS and Event Sourcing.
Reactive Functional Programming
Then I was introduced to React.js and I experience a fundamental paradigm shift in how I believed application UIs should be built and began exploring reactive functional programming. I watched a talk by Pete Hunt where he introduced the design decisions behind React, mind blown.
Pete Hunt – React, Rethinking Best Practices – JSConf Asia 2013
Stream Processing
Then my thoughts on how to manage data flow through my applications was significantly altered. I watched a talk by Martin Kleppmann that promoted subscribe/notify models and stream processing and I learned more about databases than any talk before it, mind reconfigured.
Martin Kleppmann – Turning the database inside-out with Apache Samza – Strange Loop 2014
Immutable Data Structures
Then my thoughts on immutable state was refined and I went in search of knowledge on immutable data structures and their uses. I watched a talk by Lee Bryon on immutable state, mind rebuilt.
Lee Bryon – Immutable Data in React – React.js Conf 2015
Conclusion
I have been doing paid application development since 2000. There was a lot burned into my mind in terms of development, but these talks where able to cut through the internal program of my mind to teach this old dog some new tricks. The funny thing is all of these talks are based on old concepts from computer science and our profession that I never had the opportunity of learning.
The point is, keep learning and don’t accept best practices as the only or best truth.
My New Book: “Hello React and TypeScript”
So, I have been doing a deep dive into React and TypeScript and found it a little difficult to find resources to help me. I could find plenty of great resources on React and TypeScript separately. Just exploring the documentation and many blogs and videos for the two is great. Yet, resources that explore writing React applications with TypeScript was either old, incomplete, or just didn’t work for me for one reason or another. I have to admit that I haven’t done a deep search in a while so that may have changed.
After some frustration and keyboard pounding, I decided to just consume as much as I can about both individually and just get a Hello World example working. With the basics done I went slowly all the way to a full blown application. Since I was keeping notes on that journey, why not share them?
I was going to share them in a few blog posts, but I have been trying to do a book on GitBook for a while and this topic seemed like a good fit. Also, I enjoy digging into React and TypeScript so this book is probably something I can commit to, not like my other sorry book attempts.
My little guide book isn’t complete and still very rough. It may not be completed any time soon with the rapid pace of change for JavaScript, TypeScript and React. Also, I am thinking about moving from Gulp/Browserify to WebPack. I have only completed a fraction of the samples I want to do… so much still to do. Even though I don’t think it is ready for prime time, it is a public open source book so why not share it, get feedback, and iterate.
You can get the free book from GitBook
https://charleslbryant.gitbooks.io/hello-react-and-typescript/content/index.html
The source code for the samples in the book are on GitHub
https://github.com/charleslbryant/hello-react-and-typescript
If you don’t like the book let me know. If you find something wrong, bad practice or advice, incoherent explanations… whatever, let me know. If you like it let me know too, I can always use an ego boost :). Now I just have to convince myself to do some videos and talks… public speaking, bah :{
Enjoy!
Online Computer Science Education
I have always had an inferiority complex as a software developer. I am self taught and I felt that I was missing a good base that people with a computer science degree have. I no longer feel as inferior as I use to because I have been doing this for 15 years and I am always able to hold my own. Yet, there are things that I don’t immediately understand that I think would be more clear if I had the grounding of a CS degree. But, I am not going to spend a bunch of money to do it and I don’t have the time to commit to school full time.
I am a Pluralsight junkie and YouTube computer science’y videos are my TV. There are many top notch CS schools that have released lecture videos to the public for free. Why can’t I organize these videos into a curriculum and get a virtual CS education. I am constantly watching videos anyway. Well I ran across two posts that suggest that very thing.
Free Online CS Education
The MIT Challenge chronicles Scott Young’s quest to get the equivalent of a 4 year CS education from MIT in 12 months. I am not that ambitious, but I appreciate his journey and he is very thoughtful in providing some help in actually getting through the challenge.
$200K for a computer science degree? Or these free online classes? is a post by Andrew Oliver where he puts forth a sample CS curriculum made up of Coursera videos. He thinks these videos would be as good as a CS degree. He says he hasn’t watched all of the videos, but based on the overview of the videos he says he would hire someone who went through them and did all the associated course work.
aGupieWare: Online Learning: A Bachelor’s Level Computer Science Program Curriculum is a good post that breaks down what’s involved in a CS degree program. They put forth a good list of online classes to choose from. They received a good amount of responses and based on feedback they posted an improved expanded list Online Learning: An Intensive Bachelor’s Level Computer Science Program Curriculum, Part II.
Conclusion
I can’t say that I would do all of these, it’s a lot, but I am going to take a more focused approach to getting a more structured CS education. I need to shore up my basic understanding of CS. If I am able to stick to it, I will post the courses I do, but don’t count on it.
If you don’t have a CS degree, you can still get a very good CS education. Even if you are a seasoned developer, if you haven’t received a formal education in CS, why not expand your understanding of our profession and take advantage of some of the excellent, free, online CS learning.
Liskov Substitution Principle (LSP) in TypeScript
Liskov Substitution Principle (LSP)
I was recently asked to name some of “Uncle Bob’s” SOLID OOP design principles. One of my answers was Liskov Substitution Principle. I was told it is the least given answer, I wonder why?
Liskov Substitution Principle (wikipedia)
“objects in a program should be replaceable with instances of their subtypes without altering the correctness of that program.”
TypeScript
If you are a serious developer that stays up to date with the profession, you know what TypeScript is by now. TypeScript is a superset of JavaScript that provides type checking based on the structure or shape of values at compile time and at design time if your IDE supports it. This structural type checking is sometimes referred to as duck typing. If it looks like and quacks like the type, its the type.
As I dive deeper into TypeScript I am looking for ways to keep my code SOLID. This is where the question that prompted this post surfaced. How do I maintain LSP in TypeScript?
LSP and TypeScript
When I subtype an object in JavaScript its not the same inheritance that we have in Java or C#. In JavaScript I can have function B stand in for A as long as function B has the same structure, which is different than static type checking. TypeScript provides syntactic sugar on top of JavaScript to enforce type constraints, but this doesn’t change the dynamic typing of JavaScript. In fact, I can write plain JavaScript in TypeScript so how does LSP apply when subtypes are a different animal in JavaScript as opposed to a statically typed OOP based language.
Then it hit me. The most important part of LSP (to me) is maintaining intent or semantics. It doesn’t matter if we are talking about strong typing or replacing ducks with swans, how we subtype isn’t as important as the behavior of the subtype with respect to the parent. Does the subtype pass our expectation q?
The principle asks us to reason about what makes the program correct. If you can replace a duck with a swan and the program holds its intent, LSP is not violated. Yet, if you can replace a Mallard duck with a Pekin duck in a method that only expects Mallards and maintains the proper behavior only with Mallards, when you use a Pekin duck in the method you have broken LSP. Pekin violates LSP for the expectation we have for Mallard even if Pekin is a structurally correct subtype of Mallard, using Pekin changes the behavior of the program. Now if we have a Gadwal duck that is also a structurally correct subtype of Mallard and using it I observed the same behavior as using a Mallard, LSP isn’t violated and I am safe to use a Gadwal duck in place of a Mallard.
Conclusion
I believe LSP has merit in TypeScript and any programming languages in general. I believe that violation of LSP goes beyond throwing a “not implemented exception” or hiding members of the parent class. For example, if you have an interface that defines a method that should only return even numbers, then you have an implementation of the interface method that allows returning of odd numbers, LSP is violated. Pay attention to subtype behavior with respect to expectations of behavior.
Respecting the LSP in a program helps increase flexibility, reduces coupling and makes reuse a good thing, but it also helps reduce bugs and increase the value of a program when you pay attention to behavioral intent.
What do you think, should we care about LSP in TypeScript?
Monitoring Change Tickets in Delivery Pipelines
DevOps sounds cool like some covert special operations IT combat team, but it is missing the boat in many implementations because it only focuses on the relationship between Dev and Ops and is usually only championed by Ops. The name alienates important contributors on the software delivery team. The team is responsible for software delivery including analysis, design, development, build, test, deploy, monitoring, and support. The entire team needs to be included in DevOps and needs visibility in to delivery pipelines from end-to-end. This is an unrelated rant, but this lead me to thinking about how a delivery team can monitor changes in delivery pipelines.
Monitor Change
I believe it is important that the entire team be able to monitor changes as they flow through delivery pipelines.. There are ticket management systems that help capture some of the various stages that a change goes through, but its mostly various project management related workflow stages and they have to be changed manually. I’d like a way to automatically monitor a change as if flows from change request all the way to production and monitor actions that take place outside of the ticket or project management system.
Normally, change is captured in some type of ticket maybe in a project management system or bug database (e.g. Jira, Bugzilla). We should be able to track various activities that take place as tickets make their way to production. We need a way trace various actions on a change request back to the change request ticket. I’d like a system where activities involved in getting a ticket to production automatically generate events that are related to ticket numbers and stored in a central repository.
If a ticket is created in Jira, a ticket created event is created. A developer logs time on a ticket, a time logged activity event is created that links back to the time log or maybe holds data from the time log for the ticket number.
When an automated build that includes the ticket happens, then a build stated activity event is created with the build data is triggered. As various jobs and tasks happen in the automated build a build changed activity event is triggered with log data for the activity. When the build completes a build finished activity event is triggered. There may be more than one ticket involved in a build so there would be multiple events with similar data captured, but hopefully changes are small and constrained to one or a few tickets… that’s the goal right, small batches failing fast and early.
We may want to capture the build events and include every ticket involved instead of relating the event directly to the ticket, not sure; I am brainstorming here. The point is I want full traceability across my software delivery pipelines from change request to production and I’d like these events stored in a distributed event store that I can project reports from. Does this already exists? Who knows, but I felt like thinking about it a little before I search for it.
Ticket Events
- Ticket Created Event
- Ticket Activity Event
- Ticket Completed Event
A ticket event will always include the ticket number and a date time stamp for the event, think Event Sourcing. Ticket created occurs after the ticket is created in the ticket system. Ticket completed occurs once the ticket is closed in the ticket system. The ticket activities are captured based on the activities that are configured in the event system.
Ticket Activity Events
A ticket activity is an action that occurs on a change request ticket as it makes its way to production. Ticket activities will have an event for started, changed, and finished. Ticket activity events can include relevant data associated with the event for the particular type of activity. There may be other statuses included in each of these ticket activity events. For example a finish event could include a status of error or failed to indicate that the activity finished but it had an error or failed.
- {Ticket Activity} Started
- {Ticket Activity} Changed
- {Ticket Activity} Finished
Deploy Started that has deploy log, Build Finished that has the build log, Test Changed that has new test results from an ongoing test run.
Maybe this is overkill? Maybe this should be simplified where we only need one activity event per activity and it includes data for started, changed, finished, and other statuses like error and fail. I guess it depends on if we want to stream activity event statuses or ship them in bulk when an activity completes; again I’m brainstorming.
Activities
Every ticket won’t have ticket activity events triggered for every activity that the system can capture. Tickets may not include every event that can occur on a ticket. Activity events are triggered on a ticket when the ticket matches the scope of the activity. Scope is determined by the delivery team.
Below are some of the types of activity events that I could see modeling for events on my project, but there can be different types depending on the team. So, ticket activity events have to be configurable. Every team has to be able to add and remove the types of ticket activity events they want to capture.
- Analysis
- Business Analysis
- Design Analysis
- User Experience
- Architecture
- Technical Analysis
- Development
- DBA
- Build
- Infrastructure
- Risk Analysis
- Quality
- Security
- Legal
- Design
- Development
- Build
- Test
- Unit
- Integration
- End-to-end
- Performance
- Scalability
- Load
- Stress
- …
- Deploy
- Monitor
- Maintain
Reporting and Dashboards
Once we have the events captured we can make various projections to create reports and dashboards to monitor and analyze our delivery pipelines. With the ticket event data we can also create reports at other scopes. Say we want to report on a particular sprint or project. With the ticket Id we should be able to gather this and relate other tickets in the same project or sprint. It would take some though as to whether we would want to capture project and sprint in the event data or leave this until the time when we make the actual projection, but with ticket Id we can expand our scope of understanding and traceability.
Conclusion
The main goal with this exploration into my thoughts on a possible application is to explore a way to monitor change as it flows through our delivery pipelines. We need a system that can capture the raw data for ticket create and completed events and all of the configured ticket activity events that occur in between. As I look for this app, I can refer to this to see if it meets what I envisioned or if there may be a need for this.