Cómo diseñé una aplicación React de una sola página

Con estructuras de datos, componentes e integración con Redux

Recientemente construí una aplicación de una sola página que interactúa con un servidor de API JSON backend. Elegí usar React para profundizar mi comprensión de los fundamentos de React y cómo cada herramienta puede ayudar a construir una interfaz escalable.

La pila de esta aplicación consta de:

  • Frontend con React / Redux
  • Un servidor backend JSON API con Sinatra, integrado con Postgres para la persistencia de la base de datos
  • Un cliente de API que obtiene datos de la API de OMDb, escrito en Ruby

Para esta publicación, asumiremos que tenemos el backend completado. Así que centrémonos en cómo se toman las decisiones de diseño en la interfaz.

Nota al margen: Las decisiones que se presentan aquí son solo para referencia y pueden variar según las necesidades de su aplicación. Aquí se utiliza un ejemplo de la aplicación OMDb Movie Tracker para demostración.

La aplicación

La aplicación consta de un formulario de entrada de búsqueda. Un usuario puede ingresar un título de película para devolver un resultado de película de OMDb. El usuario también puede guardar una película con una calificación y un comentario breve en una lista de favoritos.

Para ver la aplicación final, haga clic aquí. Para ver el código fuente, haga clic aquí.

Cuando un usuario busca una película en la página de inicio, se ve así:

En aras de la simplicidad, solo nos centraremos en diseñar las características principales de la aplicación en este artículo. También puede pasar a la Parte II: Reduxde la serie.

Estructura de datos

La definición de estructuras de datos adecuadas debería ser uno de los aspectos más importantes del diseño de una aplicación. Esto debería ser el primer paso, ya que determina no solo cómo la interfaz debe representar los elementos, sino también cómo el servidor API debe devolver las respuestas JSON.

Para esta aplicación, necesitaremos dos datos principales para representar correctamente nuestra interfaz de usuario: un resultado de una sola película y una lista de películas favoritas .

Objeto de resultado de película

El resultado de una sola película contendrá información como el título, el año, la descripción y la imagen del póster. Con esto, necesitamos definir un objeto que pueda almacenar estos atributos:

{ "title": "Star Wars: Episode IV - A New Hope", "year": "1977", "plot": "Luke Skywalker joins forces with a Jedi Knight...", "poster": "//m.media-amazon.com/path/to/poster.jpg", "imdbID": "tt0076759"}

La posterpropiedad es simplemente una URL a la imagen del póster que se mostrará en los resultados. Si no hay ningún póster disponible para esa película, será "N / A", que mostraremos un marcador de posición. También necesitaremos un imdbIDatributo para identificar de forma única cada película. Esto es útil para determinar si el resultado de una película ya existe o no en la lista de favoritos. Exploraremos más adelante cómo funciona.

Lista de favoritos

La lista de favoritos contendrá todas las películas guardadas como favoritas. La lista se verá así:

[ { title: "Star Wars", year: "1977", ..., rating: 4 }, { title: "Avatar", year: "2009", ..., rating: 5 }]

Tenga en cuenta que necesitaremos buscar una película específica de la lista, y la complejidad de tiempo para este enfoque es O (N) . Si bien funciona bien para conjuntos de datos más pequeños, imagine tener que buscar una película en una lista de favoritos que crece indefinidamente.

Con esto en mente, elegí ir con una tabla hash con claves imdbIDy valores como objetos de película favoritos:

{ tt0076759: { title: "Star Wars: Episode IV - A New Hope", year: "1977", plot: "...", poster: "...", rating: "4", comment: "May the force be with you!", }, tt0499549: { title: "Avatar", year: "2009", plot: "...", poster: "...", rating: "5", comment: "Favorite movie!", }}

Con esto, podemos buscar una película en la lista de favoritos en O (1) tiempo por su imdbID.

Nota: la complejidad del tiempo de ejecución probablemente no importe en la mayoría de los casos, ya que los conjuntos de datos suelen ser pequeños en el lado del cliente. También vamos a realizar el corte y la copia (también operaciones O (N)) en Redux de todos modos. Pero como ingeniero, es bueno estar al tanto de las posibles optimizaciones que podemos realizar.

Componentes

Los componentes están en el corazón de React. Necesitaremos determinar cuáles interactuarán con la tienda Redux y cuáles son solo para presentación. También podemos reutilizar algunos de los componentes de presentación. Nuestra jerarquía de componentes se verá así:

Pagina principal

Designamos nuestro componente de aplicación en el nivel superior. Cuando se visita la ruta raíz, necesita representar el SearchContainer . También necesita mostrar mensajes flash al usuario y manejar el enrutamiento del lado del cliente.

El SearchContainer recuperará el resultado película de nuestra tienda de Redux, proporcionando información como accesorios a MovieItem para la representación. También enviará una acción de búsqueda cuando un usuario envíe una búsqueda en SearchInputForm . Más sobre Redux más adelante.

Formulario Agregar a favoritos

Cuando el usuario hace clic en el botón "Agregar a favoritos", mostraremos el AddFavoriteForm , un componente controlado.

Actualizamos constantemente su estado cada vez que un usuario cambia la calificación o el texto de entrada en el área de texto del comentario. Esto es útil para la validación al enviar el formulario.

El RatingForm es responsable de hacer que las estrellas amarillas cuando el usuario hace clic en ellos. También informa el valor de calificación actual a AddFavoriteForm .

Ficha Favoritos

Cuando un usuario hace clic en la pestaña "Favoritos", la aplicación muestra FavoritesContainer .

El FavoritesContainer es responsable de recuperar la lista de favoritos de la tienda de Redux. También distribuye acciones cuando un usuario cambia una calificación o hace clic en el botón "Eliminar".

Our MovieItem and FavoritesInfo are simply presentational components that receive props from FavoritesContainer.

We’ll reuse the RatingForm component here. When a user clicks on a star in the RatingForm, the FavoritesContainer receives the rating value and dispatches an update rating action to the Redux store.

Redux Store

Our Redux store will include reducers that handle the search and favorites actions. Additionally, we’ll need to include a status reducer to track state changes when a user initiates an action. We’ll explore more on the status reducer later.

//store.js
import { createStore, combineReducers, applyMiddleware } from 'redux';import thunk from "redux-thunk";
import search from './reducers/searchReducer';import favorites from './reducers/favoritesReducer';import status from './reducers/statusReducer';
export default createStore( combineReducers({ search, favorites, status }), {}, applyMiddleware(thunk))

We’ll also apply the Redux Thunk middleware right away. We’ll go more into detail on that later. Now, let’s figure out how we manage the state changes when a user submits a search.

Search Reducer

When a user performs a search action, we want to update the store with a new search result via searchReducer. We can then render our components accordingly. The general flow of events looks like this:

We’ll treat “Get search result” as a black box for now. We’ll explore how that works later with Redux Thunk. Now, let’s implement the reducer function.

//searchReducer.js
const initialState = { "title": "", "year": "", "plot": "", "poster": "", "imdbID": "",}
export default (state = initialState, action) => { if (action.type === 'SEARCH_SUCCESS') { state = action.result; } return state;}

The initialState will represent the data structure defined earlier as a single movie result object. In the reducer function, we handle the action where a search is successful. If the action is triggered, we simply reassign the state to the new movie result object.

//searchActions.jsexport const searchSuccess = (result) => ({ type: 'SEARCH_SUCCESS', result});

We define an action called searchSuccess that takes in a single argument, the movie result object, and returns an action object of type “SEARCH_SUCCESS”. We will dispatch this action upon a successful search API call.

Redux Thunk: Search

Let’s explore how the “Get search result” from earlier works. First, we need to make a remote API call to our backend API server. When the request receives a successful JSON response, we’ll dispatch the searchSuccess action along with the payload to searchReducer.

Knowing that we’ll need to dispatch after an asynchronous call completes, we’ll make use of Redux Thunk. Thunk comes into play for making multiple dispatches or delaying a dispatch. With Thunk, our updated flow of events looks like this:

For this, we define a function that takes in a single argument title and serves as the initial search action. Thisfunction is responsible for fetching the search result and dispatching a searchSuccess action:

//searchActions.jsimport apiClient from '../apiClient';
...
export function search(title) { return (dispatch) => { apiClient.query(title) .then(response => { dispatch(searchSuccess(response.data)) }); }}

We’ve set up our API client beforehand, and you can read more about how I set up the API client here. The apiClient.query method simply performs an AJAX GET request to our backend server and returns a Promise with the response data.

We can then connect this function as an action dispatch to our SearchContainer component:

//SearchContainer.js
import React from 'react';import { connect } from 'react-redux';import { search } from '../actions/searchActions';
...
const mapStateToProps = (state) => ( { result: state.search, });
const mapDispatchToProps = (dispatch) => ( { search(title) { dispatch(search(title)) }, });
export default connect(mapStateToProps, mapDispatchToProps)(SearchContainer);

When a search request succeeds, our SearchContainer component will render the movie result:

Handling Other Search Statuses

Now we have our search action working properly and connected to our SearchContainer component, we’d like to handle other cases other than a successful search.

Search request pending

When a user submits a search, we’ll display a loading animation to indicate that the search request is pending:

Search request succeeds

If the search fails, we’ll display an appropriate error message to the user. This is useful to provide some context. A search failure could happen in cases where a movie title is not available, or our server is experiencing issues communicating with the OMDb API.

To handle different search statuses, we’ll need a way to store and update the current status along with any error messages.

Status Reducer

The statusReducer is responsible for tracking state changes whenever a user performs an action. The current state of an action can be represented by one of the three “statuses”:

  • Pending (when a user first initiates the action)
  • Success (when a request returns a successful response)
  • Error (when a request returns an error response)

With these statuses in place, we can render different UIs based on the current status of a given action type. In this case, we’ll focus on tracking the status of the search action.

We’ll start by implementing the statusReducer. For the initial state, we need to track the current search status and any errors:

// statusReducer.jsconst initialState = { search: '', // status of the current search searchError: '', // error message when a search fails}

Next, we need to define the reducer function. Whenever our SearchContainer dispatches a “SEARCH_[STATUS]” action, we will update the store by replacing the search and searchError properties.

// statusReducer.js
...
export default (state = initialState, action) => { const actionHandlers = { 'SEARCH_REQUEST': { search: 'PENDING', searchError: '', }, 'SEARCH_SUCCESS': { search: 'SUCCESS', searchError: '', }, 'SEARCH_FAILURE': { search: 'ERROR', searchError: action.error, }, } const propsToUpdate = actionHandlers[action.type]; state = Object.assign({}, state, propsToUpdate); return state;}

We use an actionHandlers hash table here since we are only replacing the state’s properties. Furthermore, it improves readability more than using if/else or case statements.

With our statusReducer in place, we can render the UI based on different search statuses. We will update our flow of events to this:

We now have additional searchRequest and searchFailure actions available to dispatch to the store:

//searchActions.js
export const searchRequest = () => ({ type: 'SEARCH_REQUEST'});
export const searchFailure = (error) => ({ type: 'SEARCH_FAILURE', error});

To update our search action, we will dispatch searchRequest immediately and will dispatch searchSuccess or searchFailure based on the eventual success or failure of the Promise returned by Axios:

//searchActions.js
...
export function search(title) { return (dispatch) => { dispatch(searchRequest());
apiClient.query(title) .then(response => { dispatch(searchSuccess(response.data)) }) .catch(error => { dispatch(searchFailure(error.response.data)) }); }}

We can now connect the search status state to our SearchContainer, passing it as a prop. Whenever our store receives the state changes, our SearchContainer renders a loading animation, an error message, or the search result:

//SearchContainer.js
...(imports omitted)
const SearchContainer = (props) => (   props.search(title) } /> { (props.searchStatus === 'SUCCESS') ?  : null } { (props.searchStatus === 'PENDING') ?    : null } { (props.searchStatus === 'ERROR') ?  

{ props.searchError }

: null } );
const mapStateToProps = (state) => ( { searchStatus: state.status.search, searchError: state.status.searchError, result: state.search, });
...

Favorites Reducer

We’ll need to handle CRUD actions performed by a user on the favorites list. Recalling from our API endpoints earlier, we’d like to allow users to perform the following actions and update our store accordingly:

  • Save a movie into the favorites list
  • Retrieve all favorited movies
  • Update a favorite’s rating
  • Delete a movie from the favorites list

To ensure that the reducer function is pure, we simply copy the old state into a new object together with any new properties usingObject.assign. Note that we only handle actions with types of _SUCCESS:

//favoritesReducer.js
export default (state = {}, action) => { switch (action.type) { case 'SAVE_FAVORITE_SUCCESS': state = Object.assign({}, state, action.favorite); break;
case 'GET_FAVORITES_SUCCESS': state = action.favorites; break;
case 'UPDATE_RATING_SUCCESS': state = Object.assign({}, state, action.favorite); break;
case 'DELETE_FAVORITE_SUCCESS': state = Object.assign({}, state); delete state[action.imdbID]; break;
default: return state; } return state;}

We’ll leave the initialState as an empty object. The reason is that if our initialState contains placeholder movie items, our app will render them immediately before waiting for the actual favorites list response from our backend API server.

From now on, each of the favorites action will follow a general flow of events illustrated below. The pattern is similar to the search action in the previous section, except right now we’ll skip handling any “PENDING” status.

Save Favorites Action

Take the save favorites action for example. The function makes an API call to with our apiClient and dispatches either a saveFavoriteSuccess or a saveFavoriteFailure action, depending on whether or not we receive a successful response:

//favoritesActions.jsimport apiClient from '../apiClient';
export const saveFavoriteSuccess = (favorite) => ({ type: 'SAVE_FAVORITE_SUCCESS', favorite});
export const saveFavoriteFailure = (error) => ({ type: 'SAVE_FAVORITE_FAILURE', error});
export function save(movie) { return (dispatch) => { apiClient.saveFavorite(movie) .then(res => { dispatch(saveFavoriteSuccess(res.data)) }) .catch(err => { dispatch(saveFavoriteFailure(err.response.data)) }); }}

We can now connect the save favorite action to AddFavoriteForm through React Redux.

To read more about how I handled the flow to display flash messages, click here.

Conclusion

Designing the frontend of an application requires some forethought, even when using a popular JavaScript library such as React. By thinking about how the data structures, components, APIs, and state management work as a whole, we can better anticipate edge cases and effectively fix errors when they arise. By using certain design patterns such as controlled components, Redux, and handling AJAX workflow using Thunk, we can streamline managing the flow of providing UI feedback to user actions. Ultimately, how we approach the design will have an impact on usability, clarity, and future scalability.

References

Fullstack React: The Complete Guide to ReactJS and Friends

About me

I am a software engineer located in NYC and co-creator of SpaceCraft. I have experience in designing single-page applications, synchronizing state between multiple clients, and deploying scalable applications with Docker.

I am currently looking for my next full-time opportunity! Please get in touch if you think that I will be a good fit for your team.