One place for hosting & domains

      Cómo agregar Sidekiq y Redis a una aplicación de Ruby on Rails


      Introducción

      Al desarrollar una aplicación de Ruby on Rails, es posible que encuentre tareas de aplicación que se deben realizar de forma asíncrona. El procesamiento de datos, el envío de correos electrónicos por lotes o la interacción con API externas son ejemplos de trabajo que se pueden realizar de forma asincrónica con tareas en segundo plano. Con tareas en segundo plano, puede mejorar el rendimiento de su aplicación descargando tareas que pueden demandar gran cantidad de tiempo a una cola de procesamiento en segundo plano y, así, liberar el ciclo de solicitud o respuesta original

      Sidekiq es uno de los marcos de tareas en segundo plano más utilizados que se pueden implementar en una aplicación de Rails. Cuenta con el respaldo de Redis, un sistema de almacenamiento de clave-valor en memoria, conocido por su flexibilidad y rendimiento. Sidekiq utiliza Redis como almacén de administración de tareas para procesar miles de tareas por segundo.

      En este tutorial, agregaremos Redis y Sidekiq a una aplicación de Rails existente. Crearemos un conjunto de clases y métodos de trabajadores de Sidekiq para gestionar lo siguiente:

      • Una carga en lote de información sobre tiburones en peligro a la base de datos de aplicación desde un archivo CSV en el repositorio del proyecto.
      • La eliminación de estos datos.

      Cuando haya terminado, tendrá una aplicación de muestra que utilizará trabajadores y tareas para procesar tareas de forma asíncrona. Esta será una buena base para añadir trabajadores y trabajos a su aplicación utilizando este tutorial como punto de partida.

      Requisitos previos

      Para este tutorial, necesitará lo siguiente:

      Paso 1: Clonar el proyecto e instalar dependencias

      Nuestro primer paso será clonar el repositorio de rails-bootstrap de la cuenta de GitHub comunitaria de DigitalOcean. En este repositorio se incluye el código de la configuración descrita en el artículo Cómo agregar Bootstrap a una aplicación de Ruby on Rails, en el que se explica la forma de añadir Bootstrap a un proyecto de Rails 5 existente.

      Clone el repositorio en un directorio llamado rails-sidekiq:

      • git clone https://github.com/do-community/rails-bootstrap.git rails-sidekiq

      Diríjase al directorio rails-sidekiq:

      Para trabajar con el código, primero deberá instalar las dependencias del proyecto que se enumeran en el Gemfile de este. También deberá añadir la gema sidekiq al proyecto para trabajar con Sidekiq y Redis.

      Abra el archivo de Gemfile del proyecto para editarlo con nano o su editor favorito:

      Añada la gema en cualquier punto de las dependencias del proyecto principal (encima de las dependencias de desarrollo):

      ~/rails-sidekiq/Gemfile

      . . .
      # Reduces boot times through caching; required in config/boot.rb
      gem 'bootsnap', '>= 1.1.0', require: false
      gem 'sidekiq', '~>6.0.0'
      
      group :development, :test do
      . . .
      

      Guarde y cierre el archivo cuando termine de añadir la gema.

      Utilice el siguiente comando para instalar las gemas:

      Veremos en el resultado que la gema de redis también se instala como requisito para sidekiq.

      Luego, instalará sus dependencias de Yarn. Debido a que este proyecto de Rails 5 se modificó para proporcionar recursos con webpack, Yarn ahora gestiona sus dependencias de JavaScript. Esto significa que es necesario instalar y verificar las dependencias que se enumeran en el archivo package.json del proyecto.

      Ejecute yarn install para instalar estas dependencias:

      Luego, ejecute las migraciones de su base de datos:

      Una vez que hayan terminado sus migraciones, puede probar la aplicación para asegurarse de que funcione como se espera. Inicie su servidor en el contexto de su paquete local con el siguiente comando si trabaja a nivel local:

      Si trabaja en un servidor de desarrollo, puede iniciar la aplicación con lo siguiente:

      • bundle exec rails s --binding=your_server_ip

      Diríjase a localhost:3000 o http://your_server_ip:3000. Visualizará la siguiente página de destino:

      Página de inicio de la aplicación

      Para crear un nuevo tiburón, haga clic en el botón Get Shark Info, que lo dirigirá a la ruta sharks/index:

      Ruta del índice de tiburones

      Para verificar que la aplicación funcione, podemos añadirle información de prueba. Haga clic en New Shark. Gracias a la configuración de autenticación del proyecto, se le solicitará un nombre de usuario (sammy) y una contraseña (tiburón).

      En la página New Shark, ingrese “Gran tiburón blanco” en el campo Name y “Terrorífico” en el campo Facts.

      Creación de un tiburón

      Haga clic en el botón Create Shark para crear el tiburón. Una vez que haya creado el tiburón, podrá detener el servidor con CTRL+C.

      Con esto, habrá instalado las dependencias necesarias para su proyecto y comprobado que funciona. Luego, puede realizar algunos cambios en la aplicación de Rails para trabajar con sus recursos relacionados con los tiburones en peligro.

      Paso 2: Generar un controlador para recursos relacionados con tiburones en peligro

      Para trabajar con nuestros recursos relacionados con tiburones en peligro, añadiremos un nuevo modelo a la aplicación y un controlador que regulará la manera en que se presente a los usuarios la información sobre tiburones en peligro. Nuestro objetivo final es permitir que los usuarios carguen un gran lote de información sobre tiburones en peligro, sin bloquear la función general de nuestra aplicación, y eliminen dicha información cuando ya no la necesiten.

      Primero, crearemos un modelo Endangered para nuestros tiburones en peligro. Incluiremos un campo de cadena a la tabla de nuestra base de datos para el nombre del tiburón y otro campo de cadena para las categorías de la Unión Internacional para la Conservación de la Naturaleza (UICN) que determinan el grado de riesgo en el que se encuentra cada tiburón.

      En última instancia, la estructura de nuestro modelo coincidirá con las columnas del archivo CSV que usaremos para crear nuestra carga en lote. Este archivo se encuentra en el directorio db y puede verificar su contenido con el siguiente comando:

      El archivo contiene una lista de 73 tiburones en peligro y sus situaciones según la IUCN: vu significa vulnerable, en significa en peligro y cr significa en peligro crítico.

      Nuestro modelo Endangered se correlacionará con estos datos, lo que nos permitirá crear nuevas instancias de Endangered desde este archivo CSV. Cree el modelo con el siguiente comando:

      • rails generate model Endangered name:string iucn:string

      Luego, genere un controlador Endangered con una acción index:

      • rails generate controller endangered index

      Esto nos proporcionará un punto de partida para crear la función de nuestra aplicación, aunque también tendremos que añadir métodos personalizados al archivo del controlador que Rails generó para nosotros.

      Abra el archivo ahora:

      • nano app/controllers/endangered_controller.rb

      Rails nos proporciona un esquema de borrador que podemos comenzar a completar.

      Primero, debemos determinar las rutas que necesitamos para trabajar con nuestros datos. Gracias al comando generate controller​​​​​​, contamos con un mé todo index para comenzar. Esto se correlacionará con una vista de index, en la que presentaremos a los usuarios la opción para cargar tiburones en peligro.

      Sin embargo, también nos convendrá tratar los casos en los que los usuarios ya hayan cargado tiburones; no necesitarán una opción de carga en este caso. De alguna forma, tendremos que evaluar la cantidad existente de casos de la clase Endangered, puesto que más de una indica que ya se produjo la carga del lote.

      Empecemos creando un método set_endangered private​​​ que tomará cada instancia de nuestra clase Endangered de la base de datos. Añada el siguiente código al archivo:

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      class EndangeredController < ApplicationController
        before_action :set_endangered, only: [:index, :data]
      
        def index
        end
      
        private
      
          def set_endangered
            @endangered = Endangered.all
          end
      
      end
      

      Tenga en cuenta que el filtro before_action garantizará que el valor de @endangered solo esté configurado para las rutas index y data, donde gestionaremos los datos de tiburones en peligro.

      Después, añada el siguiente código al método index a fin de determinar la ruta correcta para los usuarios que visitan esta parte de la aplicación:

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      class EndangeredController < ApplicationController
        before_action :set_endangered, only: [:index, :data]
      
        def index          
          if @endangered.length > 0
            redirect_to endangered_data_path
          else
            render 'index'
          end
        end
      . . .
      

      Si hay más de 0 instancias de nuestra clase Endangered, redirigiremos a los usuarios a la ruta data, donde podrán ver información sobre los tiburones que crearon. De lo contrario, verán la vista de index.

      Luego, debajo del método index, añada un método data, que se correlacionará con una vista de data:

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      . . .
        def index          
          if @endangered.length > 0
            redirect_to endangered_data_path
          else
            render 'index'
          end
        end
      
        def data
        end
      . . .
      

      A continuación, añadiremos un método para gestionar la carga de datos. Llamaremos a este método upload e invocará una clase y método de trabajador Sidekiq para realizar la carga de datos desde el archivo CSV. En el siguiente paso, crearemos la definición de esta clase de trabajador: AddEndangeredWorker.

      Por ahora, añada el siguiente código al archivo para invocar al trabajador Sidekiq y realizar la carga:

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      . . .
        def data
        end
      
        def upload
          csv_file = File.join Rails.root, 'db', 'sharks.csv'   
          AddEndangeredWorker.perform_async(csv_file)
          redirect_to endangered_data_path, notice: 'Endangered sharks have been uploaded!'
        end
      . . .
      

      Al invocar el método perform_async en la clase AddEndangeredWorker usando el archivo CSV como argumento, este código garantiza que los datos de tiburones y la tarea de carga se transfieran a Redis. Los trabajadores Sidekiq que configuraremos monitorean la cola de trabajo y responderán cuando surjan nuevos trabajo.

      Después de invocar perform_async, nuestro método upload​​​ aplica redireccionamiento a la ruta data, en la que los usuarios podrán ver los tiburones cargados.

      Luego, añadiremos un método destroy para destruir los datos. Añada el siguiente código que está debajo del método upload:

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      . . .
        def upload
          csv_file = File.join Rails.root, 'db', 'sharks.csv'   
          AddEndangeredWorker.perform_async(csv_file)
          redirect_to endangered_data_path, notice: 'Endangered sharks have been uploaded!'
        end
      
        def destroy
          RemoveEndangeredWorker.perform_async
          redirect_to root_path
        end
      . . .
      

      Al igual que nuestro método upload, nuestro método destroy incluye la invocación de perform_async en una clase RemoveEndangeredWorker: el otro trabajador Sidekiq que crearemos. Después de invocar este método, redirecciona a los usuarios a la ruta de la aplicación root.

      El archivo terminado tendrá este aspecto:

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      class EndangeredController < ApplicationController
        before_action :set_endangered, only: [:index, :data]
      
        def index          
          if @endangered.length > 0
            redirect_to endangered_data_path
          else
            render 'index'
          end
        end
      
        def data
        end
      
        def upload
          csv_file = File.join Rails.root, 'db', 'sharks.csv'   
          AddEndangeredWorker.perform_async(csv_file)
          redirect_to endangered_data_path, notice: 'Endangered sharks have been uploaded!'
        end
      
        def destroy
          RemoveEndangeredWorker.perform_async
          redirect_to root_path
        end
      
        private
      
          def set_endangered
            @endangered = Endangered.all
          end
      
      end
      

      Guarde y cierre el archivo cuando concluya la edición.

      Como paso final para afianzar las rutas de nuestra aplicación, modificaremos el código de config/routes.rb, el archivo en el que residen nuestras instrucciones de ruta.

      Abra el archivo ahora:

      El archivo actualmente tiene este aspecto:

      ~/rails-sidekiq/config/routes.rb

      Rails.application.routes.draw do
        get 'endangered/index'
        get 'home/index'
        resources :sharks do
                resources :posts
        end
        root 'home#index'
        # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
      end
      

      Será necesario actualizar el archivo para incluir las rutas que definimos en nuestro controlador: data, upload y destroy. Nuestra ruta data coincidirá con una solicitud GET para obtener los datos de tiburones, mientras que nuestras rutas upload y destroy se asignarán a las solicitudes POST que cargan y destruyen esos datos.

      Añada el siguiente código al archivo para definir estas rutas:

      ~/rails-sidekiq/config/routes.rb

      Rails.application.routes.draw do
        get 'endangered/index'
        get 'endangered/data', to: 'endangered#data'
        post 'endangered/upload', to: 'endangered#upload'
        post 'endangered/destroy', to: 'endangered#destroy'
        get 'home/index'
        resources :sharks do
                resources :posts
        end
        root 'home#index'
        # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
      end
      

      Guarde y cierre el archivo cuando concluya la edición.

      Con su modelo y controlador Endangered, ahora puede proceder a definir sus clases de trabajadores Sidekiq.

      Paso 3: Definir trabajadores Sidekiq

      Invocamos los métodos perform_async en nuestros trabajadores Sidekiq de nuestro controlador, pero aún debemos crear los trabajadores.

      Primero, cree un directorio workers para los trabajadores:

      Abra un archivo para el trabajador AddEndangeredWorker:

      • nano app/workers/add_endangered_worker.rb

      En este archivo, añadiremos el código que nos permitirá trabajar con los datos de nuestro archivo CSV. Primero, añada el código al archivo que creará la clase, incluya la biblioteca CSV Ruby y asegúrese que esta clase funcione como trabajador Sidekiq:

      ~/rails-sidekiq/app/workers/add_endangered_worker.rb

      class AddEndangeredWorker
        require 'csv'
        include Sidekiq::Worker
        sidekiq_options retry: false
      
      end
      

      También incluiremos la opción retry:false para garantizar que Sidekiq no vuelva a intentar realizar la carga ante una falla.

      Luego, añada el código para la función perform:

      ~/rails-sidekiq/app/workers/add_endangered_worker.rb

      class AddEndangeredWorker
        require 'csv'
        include Sidekiq::Worker
        sidekiq_options retry: false
      
        def perform(csv_file)
          CSV.foreach(csv_file, headers: true) do |shark|
          Endangered.create(name: shark[0], iucn: shark[1])
        end
       end
      
      end
      

      El método perform recibe los argumentos del método perform_async definido en el controlador, por lo que es importante que los valores de argumento estén nivelados. Aquí, pasamos en csv_file, la variable que definimos en el controlador y usamos el método foreach de la biblioteca CSV para leer los valores del archivo. Configurar headers:true para este bucle garantiza que se trate a la primera fila del archivo como a una fila de encabezados.

      Luego, el bloque luego lee los valores del archivo en las columnas que configuramos para nuestro modelo Endangered: name e iucn. Ejecutar este bucle creará instancias de Endangered para cada una de las entradas de nuestro archivo CSV.

      Una vez que finalice la edición, guarde y cierre el archivo.

      Luego, crearemos un trabajador para que elimine estos datos. Abra un archivo para la clase RemoveEndangeredWorker:

      • nano app/workers/remove_endangered_worker.rb

      Añada el código para definir la clase y para garantizar que utilice la biblioteca CSV y las funciones como un trabajador Sidekiq:

      ~/rails-sidekiq/app/workers/remove_endangered_worker.rb

      class RemoveEndangeredWorker
        include Sidekiq::Worker
        sidekiq_options retry: false
      
      end
      

      Luego, añada un método perform para gestionar la destrucción de los datos de tiburones en peligro:

      ~/rails-sidekiq/app/workers/remove_endangered_worker.rb

      class RemoveEndangeredWorker
        include Sidekiq::Worker
        sidekiq_options retry: false
      
        def perform
          Endangered.destroy_all
        end
      
      end
      

      El método perform invoca a destroy_all en la clase Endangered, que eliminará todas las instancias de esa clase de la base de datos.

      Guarde y cierre el archivo cuando concluya la edición.

      Una vez que sus trabajadores estén activos, podrá proceder a crear un diseño para sus vistas de endangered, así como plantillas para sus vistas de index y data, para que los usuarios puedan cargar y ver tiburones en peligro.

      Paso 4: Agregar diseños y plantillas de vistas

      Para que los usuarios disfruten de su propia información de tiburones en peligro, tendremos que abordar dos aspectos: el diseño de las vistas definidas en nuestro controlador endangered y las plantillas de vista de las vistas de index y data.

      Actualmente, nuestra aplicación utiliza un diseño integral, ubicado en app/views/layouts/application.html.erb, uno parcial de navegación y uno para las vistas de sharks. El diseño de la aplicación busca un bloque de contenido, que nos permite cargar diferentes diseños basados en la parte de la aplicación con la que nuestro usuario interactúa: para la página home​​​ index, este verá un diseño y para cualquier vista que se relacione con tiburones individuales verá otro.

      Podemos reutilizar el diseño de sharks para nuestras vistas de endangered, ya que este formato también funcionará para presentar datos de tiburones de forma masiva.

      Copie el archivo de diseño de sharks para crear un diseño de endangered:

      • cp app/views/layouts/sharks.html.erb app/views/layouts/endangered.html.erb

      Luego, trabajaremos en crear las plantillas de vista para nuestras vistas de index y data.

      Abra la plantilla index primero:

      • nano app/views/endangered/index.html.erb

      Elimine el código estándar y añada en su lugar el siguiente código, que proporcionará a los usuarios información general sobre las categorías en peligro y les dará la opción de cargar información sobre tiburones en peligro:

      ~/rails-sidekiq/app/views/endangered/index.html.erb

      <p id="notice"><%= notice %></p>
      
      <h1>Endangered Sharks</h1>
      
      <p>International Union for Conservation of Nature (ICUN) statuses: <b>vu:</b> Vulnerable, <b>en:</b> Endangered, <b>cr:</b> Critically Endangered </p>
      
      <br>
      
        <%= form_tag endangered_upload_path do %>
        <%= submit_tag "Import Endangered Sharks" %>
        <% end %>
      
        <br>
      
      <%= link_to 'New Shark', new_shark_path, :class => "btn btn-primary btn-sm" %> <%= link_to 'Home', home_index_path, :class => "btn btn-primary btn-sm" %>
      

      Un form_tag hace posible la carga de datos al apuntar una acción posterior a endangered_upload_path, la ruta que definimos para nuestras cargas. El botón de envío, creado con submit_tag, solicita a los usuarios a “Import Endangered Sharks”.

      Además de este código, incluimos información general sobre códigos de ICUN, para que los usuarios puedan interpretar los datos que verán.

      Guarde y cierre el archivo cuando concluya la edición.

      Luego, abra un archivo para la vista de data:

      • nano app/views/endangered/data.html.erb

      Añada el siguiente código, que agregará una tabla con los datos de tiburones en peligro:

      ~/rails-sidekiq/app/views/endangered/data.html.erb

      <p id="notice"><%= notice %></p>
      
      <h1>Endangered Sharks</h1>
      
      <p>International Union for Conservation of Nature (ICUN) statuses: <b>vu:</b> Vulnerable, <b>en:</b> Endangered, <b>cr:</b> Critically Endangered </p>
      
      <div class="table-responsive">
      <table class="table table-striped table-dark">
        <thead>
          <tr>
            <th>Name</th>
            <th>IUCN Status</th>
            <th colspan="3"></th>
          </tr>
        </thead>
      
        <tbody>
          <% @endangered.each do |shark| %>
            <tr>
              <td><%= shark.name %></td>
              <td><%= shark.iucn %></td>
            </tr>
          <% end %>
        </tbody>
      </table>
      </div>
      
      <br>
      
        <%= form_tag endangered_destroy_path do %>
        <%= submit_tag "Delete Endangered Sharks" %>
        <% end %>
      
        <br>
      
      <%= link_to 'New Shark', new_shark_path, :class => "btn btn-primary btn-sm" %> <%= link_to 'Home', home_index_path, :class => "btn btn-primary btn-sm" %>
      

      Este código incluye de nuevo los códigos de estado de la ICUN y una tabla de Bootstrap para los datos emitidos. Al recorrer nuestra variable @endangered, mostramos el nombre y la situación de cada tiburón según la ICUN en la tabla.

      Debajo de la tabla, tenemos otro conjunto de form_tags y submit_tags, que se publican a la ruta destroy ofreciendo a los usuarios la opción de "Delete Endangered Sharks”.

      Guarde y cierre el archivo cuando concluya la edición.

      La última modificación que aplicaremos a nuestras vistas se hará en la vista de index asociada con nuestro controlador home. Como podrá recordar, esta vista se configura como root de la aplicación en config/routes.rb.

      Abra este archivo para editarlo:

      • nano app/views/home/index.html.erb

      Encuentre la columna en la fila Sharks are ancient:

      ~/rails-sidekiq/app/views/home/index.html.erb

      . . .
              <div class="col-lg-6">
                  <h3>Sharks are ancient</h3>
                  <p>There is evidence to suggest that sharks lived up to 400 million years ago.
                  </p>
              </div>
          </div>
      </div>
      

      Añada el siguiente código al archivo:

      ~/rails-sidekiq/app/views/home/index.html.erb

      . . .
              <div class="col-lg-6">
                  <h3>Sharks are ancient and SOME are in danger</h3>
                  <p>There is evidence to suggest that sharks lived up to 400 million years ago. Without our help, some could disappear soon.</p>
                  <p><%= button_to 'Which Sharks Are in Danger?', endangered_index_path, :method => :get,  :class => "btn btn-primary btn-sm"%>
                  </p>
              </div>
          </div>
      </div>
      

      Incluimos un llamado a la acción para que los usuarios aprendan más sobre tiburones en peligro compartiendo, primero, un mensaje fuerte y, luego, añadiendo un asistente button_to que envía una solicitud GET a nuestra ruta index endangered y permite que los usuarios accedan a esa parte de la aplicación. Desde allí, podrán cargar y ver información de tiburones en peligro.

      Guarde y cierre el archivo cuando concluya la edición.

      Una vez que esté listo su código, estará preparado para iniciar la aplicación y cargar algunos tiburones.

      Paso 5: Iniciar Sidekiq y probar la aplicación

      Antes de iniciar la aplicación, necesitaremos ejecutar migraciones en nuestra base de datos e iniciar Sidekiq para habilitar nuestros trabajadores. Redis ya se debería estar ejecutando en el servidor, pero podemos verificarlo para estar seguros. Una vez que hagamos todo esto, estaremos listos para probar la aplicación.

      Primero, verifique que Redis esté en ejecución:

      Debería ver un resultado como el siguiente:

      Output

      ● redis-server.service - Advanced key-value store Loaded: loaded (/lib/systemd/system/redis-server.service; enabled; vendor preset: enabled) Active: active (running) since Tue 2019-11-12 20:37:13 UTC; 1 weeks 0 days ago

      Luego, ejecute las migraciones de su base de datos:

      Ahora puede iniciar Sidekiq en el contexto de su paquete de proyectos actual usando el comando bundle exec sidekiq:

      Verá un resultado como este, que indica que Sidekiq está listo para procesar tareas:

      Output

      m, `$b .ss, $$: .,d$ `$$P,d$P' .,md$P"' ,$$$$$b/md$$$P^' .d$$$$$$/$$$P' $$^' `"/$$$' ____ _ _ _ _ $: ,$$: / ___|(_) __| | ___| | _(_) __ _ `b :$$ ___ | |/ _` |/ _ |/ / |/ _` | $$: ___) | | (_| | __/ <| | (_| | $$ |____/|_|__,_|___|_|__|__, | .d$$ |_| 2019-11-19T21:43:00.540Z pid=17621 tid=gpiqiesdl INFO: Running in ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-linux] 2019-11-19T21:43:00.540Z pid=17621 tid=gpiqiesdl INFO: See LICENSE and the LGPL-3.0 for licensing details. 2019-11-19T21:43:00.540Z pid=17621 tid=gpiqiesdl INFO: Upgrade to Sidekiq Pro for more features and support: http://sidekiq.org 2019-11-19T21:43:00.540Z pid=17621 tid=gpiqiesdl INFO: Booting Sidekiq 6.0.3 with redis options {:id=>"Sidekiq-server-PID-17621", :url=>nil} 2019-11-19T21:43:00.543Z pid=17621 tid=gpiqiesdl INFO: Starting processing, hit Ctrl-C to stop

      Abra una segunda ventana de terminal, diríjase al directorio rails-sidekiq e inicie el servidor de aplicaciones.

      Si ejecuta la aplicación a nivel local, utilice el siguiente comando:

      Si trabaja con un servidor de desarrollo, ejecute lo siguiente:

      • bundle exec rails s --binding=your_server_ip

      Diríjase a localhost:3000 o a http://your_server_ip:3000 en el navegador. Visualizará la siguiente página de destino:

      Inicio de la aplicación de Sidekiq

      Haga clic en el botón** ¿Which Sharks Are In Danger?** . Debido a que no cargó ningún tiburón en peligro, esto lo dirigirá a la vista de endangered index:

      Vista del índice de tiburones en peligro

      Haga clic en Import Endangered Sharks para importar los tiburones. Verá un mensaje de estado que le indicará que los tiburones se importaron:

      Inicio de la importación

      También verá el comienzo de la importación. Actualice su página para ver la tabla entera:

      Actualización de tabla

      Gracias a Sidekiq, realizamos la carga del gran lote de tiburones en peligro sin cerrar el navegador ni interferir con otras funciones de la aplicación.

      Haga clic en el botón Home en la parte inferior de la página, que lo llevará de vuelta a la página principal de la aplicación:

      Inicio de la aplicación de Sidekiq

      Aquí, haga clic en Which Sharks Are in Danger? nuevamente. Esto lo llevará directamente a la vista de data, porque ya había cargado los tiburones.

      Para probar la función de eliminación, haga clic en el botón Delete Endangered Sharks que se encuentra debajo de la tabla. Una vez más, debería ser redireccionado a la página de inicio de la aplicación. Si have clic en Which Sharks Are in Danger? una última vez, lo llevará de regreso a la vista de index, en la que tendrá la opción de cargar tiburones de nuevo:

      Vista del índice de tiburones en peligro

      Su aplicación ahora se está ejecutando con los trabajadores de Sidekiq, que están listos para procesar trabajos y garantizar que los usuarios tengan una buena experiencia trabajando con su aplicación.

      Conclusión

      Ahora dispone de una aplicación Rails en funcionamiento con Sidekiq habilitado, que le permitirá descargar operaciones complejas a una cola de trabajo administrada por Sidekiq y respaldada por Redis. Esto le permitirá mejorar la velocidad y la funcionalidad de su sitio a medida que realice el desarrollo.

      Si desea obtener más información sobre Sidekiq, se recomienda comenzar consultando los docs.

      Para obtener más información sobre Redis, consulte nuestra biblioteca de recursos de Redis. También puede obtener más información sobre cómo ejecutar un clúster de Redis administrado en DigitalOcean consultando la documentación del producto.



      Source link

      Comment ajouter Sidekiq et Redis à une application Ruby on Rails


      Introduction

      Lors du développement d’une application Ruby on Rails, il se peut que certaines tâches d’application doivent être exécutées de manière asynchrone. Le traitement des données, l’envoi d’e-mails par lots ou l’interaction avec des API externes sont autant d’exemples de travaux qui peuvent être effectués de manière asynchrone avec des travaux en arrière-plan. L’utilisation de travaux en arrière-plan peut améliorer les performances de votre application en déchargeant des tâches potentiellement longues dans une file d’attente de traitement en arrière-plan, libérant ainsi le cycle original de requête/réponse.

      Sidekiq est l’un des frameworks de travail en arrière-plan les plus utilisés que vous pouvez implémenter dans une application Rails. Il est soutenu par Redis, un magasin clé-valeur en mémoire connu pour sa flexibilité et ses performances. Sidekiq utilise Redis comme un magasin de gestion de travaux pour traiter des milliers de travaux par seconde.

      Dans ce tutoriel, vous allez ajouter Redis et Sidekiq à une application Rails existante. Vous allez créer un ensemble de classes de travailleurs Sidekiq et de méthodes à manipuler :

      • Un téléchargement par lots d’informations sur les requins menacés dans la base de données de l’application à partir d’un fichier CSV dans le référentiel du projet.
      • La suppression de ces données.

      Lorsque vous aurez terminé, vous aurez une application de démonstration qui utilise les travailleurs et les travaux pour traiter les tâches de manière asynchrone. Ce sera une bonne base pour vous permettre d’ajouter des travailleurs et des travaux à votre propre application, en utilisant ce tutoriel comme point de départ.

      Conditions préalables

      Pour suivre ce tutoriel, vous aurez besoin de :

      Étape 1 – Clonage du projet et installation des dépendances

      Notre première étape consistera à cloner le référentiel rails-bootstrap à partir du compte GitHub de DigitalOcean Community. Ce référentiel comprend le code de la configuration décrite dans le tutoriel Comment ajouter Bootstrap à une application Ruby on Rails, qui explique comment ajouter Bootstrap à un projet Rails 5 existant.

      Clonez le référentiel dans un répertoire appelé rails-sidekiq :

      • git clone https://github.com/do-community/rails-bootstrap.git rails-sidekiq

      Naviguez vers le répertoire rails-sidekiq :

      Pour travailler avec le code, vous devrez d’abord installer les dépendances du projet, qui sont listées dans son Gemfile. Vous devrez également ajouter le gem sidekiq au projet pour travailler avec Sidekiq et Redis.

      Ouvrez le Gemfile du projet pour le modifier en utilisant nano ou votre éditeur préféré :

      Ajoutez le gem n’importe où dans les dépendances principales du projet (au-dessus des dépendances de développement) :

      ~/rails-sidekiq/Gemfile

      . . .
      # Reduces boot times through caching; required in config/boot.rb
      gem 'bootsnap', '>= 1.1.0', require: false
      gem 'sidekiq', '~>6.0.0'
      
      group :development, :test do
      . . .
      

      Enregistrez et fermez le fichier lorsque vous avez terminé d’ajouter le gem.

      Utilisez la commande suivante pour installer les gems :

      Vous verrez dans la sortie que le gem redis est également installé, cela étant exigé pour sidekiq.

      Ensuite, vous allez installer vos dépendances Yarn. Étant donné que ce projet Rails 5 a été modifié pour servir des ressources avec webpack, ses dépendances JavaScript sont maintenant gérées par Yarn. Cela signifie qu’il est nécessaire d’installer et de vérifier les dépendances listées dans le fichier package.json.

      Exécutez yarn install pour installer ces dépendances :

      Ensuite, exécutez vos migrations de base de données :

      Une fois vos migrations terminées, vous pouvez tester l’application pour vous assurer qu’elle fonctionne comme prévu. Démarrez votre serveur dans le contexte de votre bundle local avec la commande suivante si vous travaillez localement :

      Si vous travaillez sur un serveur de développement, vous pouvez démarrer l’application avec :

      • bundle exec rails s --binding=your_server_ip

      Naviguez vers localhost:3000 ou http://your_server_ip:3000. Vous verrez la page d’accueil suivante :

      Page d'accueil de l'application

      Pour créer un requin, cliquez sur le bouton Get Shark Info (Obtenir des informations sur les requins), qui vous amènera à la route sharks/index :

      Route sharks/index

      Pour vérifier que l’application fonctionne, nous pouvons y ajouter quelques informations de démonstration. Cliquez sur New Shark (Nouveau Requin). Un nom d’utilisateur (sammy) et un mot de passe (shark) vous seront demandés, grâce aux paramètres d’authentification du projet.

      Dans la page New Shark (Nouveau Requin), entrez « Great White » (Grand Blanc) dans le champ Name (Nom) et « Scary » (Effrayant) dans le champ Facts (Faits) :

      Créer un requin

      Cliquez sur le bouton Create Shark (Créer le requin) pour créer le requin. Une fois que vous voyez que votre requin a été créé, vous pouvez tuer le serveur avec CTRL+C.

      Vous avez désormais installé les dépendances nécessaires pour votre projet et testé sa fonctionnalité. Ensuite, vous pouvez apporter quelques modifications à l’application Rails pour travailler avec vos ressources concernant les requins menacés.

      Étape 2 – Génération d’un contrôleur pour les ressources concernant les requins menacés

      Pour travailler avec nos ressources sur les requins menacés, nous allons ajouter un nouveau modèle à l’application ainsi qu’un contrôleur qui contrôlera la manière dont les informations sur les requins menacés sont présentées aux utilisateurs. Notre objectif ultime est de permettre aux utilisateurs de télécharger vers le serveur un grand nombre d’informations sur les requins menacés sans bloquer la fonctionnalité générale de notre application, et de supprimer ces informations lorsqu’ils n’en ont plus besoin.

      D’abord, créons un modèle Endangered (Menacés) pour nos requins menacés. Nous allons inclure un champ de chaîne dans notre table de base de données pour le nom du requin, et un autre champ de chaîne pour les catégories de l’Union internationale pour la conservation de la nature (UICN) qui déterminent le degré de risque pour chaque requin.

      En fin de compte, la structure de notre modèle correspondra aux colonnes du fichier CSV que nous utiliserons pour créer notre téléchargement par lots. Ce fichier est situé dans le répertoire db, et vous pouvez vérifier son contenu avec la commande suivante :

      Le fichier contient une liste de 73 requins en voie de disparition et leurs statuts : vu pour vulnérables, en pour menacés et cr pour en voie de disparition.

      Notre modèle Endangered sera en corrélation avec ces données, ce qui nous permettra de créer de nouvelles instances Endangered à partir de ce fichier CSV. Créez le modèle avec la commande suivante :

      • rails generate model Endangered name:string iucn:string

      Ensuite, générez un contrôleur Endangered avec une action index :

      • rails generate controller endangered index

      Cela nous donnera un point de départ pour développer les fonctionnalités de notre application, mais nous devrons également ajouter des méthodes personnalisées au fichier de contrôleur que Rails a généré pour nous.

      Maintenant, ouvrez ce fichier :

      • nano app/controllers/endangered_controller.rb

      Rails nous a fourni un schéma de base que nous pouvons commencer à remplir.

      Tout d’abord, nous devons déterminer les routes nécessaires pour travailler avec nos données. Grâce à la commande generate controller, nous disposons d’une méthode index pour commencer. Cela correspondra à une vue index, où nous présenterons aux utilisateurs la possibilité de télécharger vers le serveur des requins menacés.

      Toutefois, nous voudrons également traiter les cas où les utilisateurs ont déjà téléchargé les requins et n’ont donc pas besoin d’une option de téléchargement. Nous devrons d’une manière ou d’une autre évaluer combien d’instances de la classe Endangered existent déjà, puisque plus d’une instance indique que le téléchargement par lots a déjà eu lieu.

      Commençons par créer une méthode set_endangered private qui récupérera chaque instance de notre classe Endangered dans la base de données. Ajoutez le code suivant au fichier :

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      class EndangeredController < ApplicationController
        before_action :set_endangered, only: [:index, :data]
      
        def index
        end
      
        private
      
          def set_endangered
            @endangered = Endangered.all
          end
      
      end
      

      Notez que le filtre before_action fera en sorte que la valeur de @endangered ne soit définie que pour les routes index et data, qui seront les endroits où nous traiterons les données sur les requins menacés.

      Ensuite, ajoutez le code suivant à la méthode index afin de déterminer le chemin correct pour les utilisateurs qui visitent cette partie de l’application :

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      class EndangeredController < ApplicationController
        before_action :set_endangered, only: [:index, :data]
      
        def index          
          if @endangered.length > 0
            redirect_to endangered_data_path
          else
            render 'index'
          end
        end
      . . .
      

      S’il y a plus de 0 instance de notre classe Endangered, nous redirigerons les utilisateurs vers la route data, où ils pourront consulter des informations sur les requins qu’ils ont créés. Sinon, ils verront la vue index.

      Ensuite, sous la méthode index, ajoutez une méthode data, qui correspondra à une vue data :

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      . . .
        def index          
          if @endangered.length > 0
            redirect_to endangered_data_path
          else
            render 'index'
          end
        end
      
        def data
        end
      . . .
      

      Ensuite, nous ajouterons une méthode pour gérer le téléchargement des données lui-même. Nous appellerons cette méthode upload, et elle fera appel à une classe de travailleurs Sidekiq et à une méthode pour effectuer le téléchargement des données à partir du fichier CSV. Nous allons créer la définition de cette classe de travailleurs, AddEndangeredWorker, dans la prochaine étape.

      Pour l’instant, ajoutez le code suivant au fichier pour appeler le travailleur Sidekiq afin d’effectuer le téléchargement :

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      . . .
        def data
        end
      
        def upload
          csv_file = File.join Rails.root, 'db', 'sharks.csv'   
          AddEndangeredWorker.perform_async(csv_file)
          redirect_to endangered_data_path, notice: 'Endangered sharks have been uploaded!'
        end
      . . .
      

      En appelant la méthode perform_async sur la classe AddEndangeredWorker et en utilisant le fichier CSV comme argument, ce code garantit que les données du requin et le travail de téléchargement sont transmis à Redis. Les travailleurs de Sidekiq que nous mettrons en place surveilleront la file d’attente des travaux et réagiront lorsque de nouveaux travaux se présenteront.

      Après avoir appelé perform_async, notre méthode upload redirige vers le chemin data, où les utilisateurs pourront voir les requins téléchargés.

      Ensuite, nous ajouterons une méthode destroy pour détruire les données. Ajoutez le code suivant sous la méthode upload :

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      . . .
        def upload
          csv_file = File.join Rails.root, 'db', 'sharks.csv'   
          AddEndangeredWorker.perform_async(csv_file)
          redirect_to endangered_data_path, notice: 'Endangered sharks have been uploaded!'
        end
      
        def destroy
          RemoveEndangeredWorker.perform_async
          redirect_to root_path
        end
      . . .
      

      Comme notre méthode upload, notre méthode destroy comprend un appel à perform_async sur une classe RemoveEndangeredWorker – l’autre travailleur Sidekiq que nous allons créer. Après avoir appelé cette méthode, elle redirige les utilisateurs vers le chemin root de l’application.

      Le fichier terminé ressemblera à ceci :

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      class EndangeredController < ApplicationController
        before_action :set_endangered, only: [:index, :data]
      
        def index          
          if @endangered.length > 0
            redirect_to endangered_data_path
          else
            render 'index'
          end
        end
      
        def data
        end
      
        def upload
          csv_file = File.join Rails.root, 'db', 'sharks.csv'   
          AddEndangeredWorker.perform_async(csv_file)
          redirect_to endangered_data_path, notice: 'Endangered sharks have been uploaded!'
        end
      
        def destroy
          RemoveEndangeredWorker.perform_async
          redirect_to root_path
        end
      
        private
      
          def set_endangered
            @endangered = Endangered.all
          end
      
      end
      

      Enregistrez et fermez le fichier lorsque vous avez terminé de le modifier.

      Pour terminer la consolidation des routes de notre application, nous allons modifier le code dans config/routes.rb, le fichier où se trouvent nos déclarations de routes.

      Maintenant, ouvrez ce fichier :

      Actuellement, le fichier ressemble à ceci :

      ~/rails-sidekiq/config/routes.rb

      Rails.application.routes.draw do
        get 'endangered/index'
        get 'home/index'
        resources :sharks do
                resources :posts
        end
        root 'home#index'
        # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
      end
      

      Nous devrons mettre à jour le fichier pour inclure les routes que nous avons définies dans notre contrôleur : data, upload et destroy. Notre route data correspondra à une requête GET pour récupérer les données sur les requins, tandis que nos itinéraires upload et destroy redirigeront vers des requêtes POST qui téléchargeront et détruiront ces données.

      Ajoutez le code suivant au fichier pour définir ces routes :

      ~/rails-sidekiq/config/routes.rb

      Rails.application.routes.draw do
        get 'endangered/index'
        get 'endangered/data', to: 'endangered#data'
        post 'endangered/upload', to: 'endangered#upload'
        post 'endangered/destroy', to: 'endangered#destroy'
        get 'home/index'
        resources :sharks do
                resources :posts
        end
        root 'home#index'
        # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
      end
      

      Enregistrez et fermez le fichier lorsque vous avez terminé de le modifier.

      Maintenant que vous avez mis en place votre modèle Endangered et votre contrôleur, vous pouvez passer à l’étape de définition des classes de travailleurs Sidekiq.

      Étape 3 – Définition des travailleurs Sidekiq

      Nous avons appelé des méthodes perform_async sur nos travailleurs Sidekiq dans notre contrôleur, mais nous devons encore créer les travailleurs eux-mêmes.

      Tout d’abord, créez un répertoire workers pour les travailleurs :

      Ouvrez un fichier pour le travailleur AddEndangeredWorker :

      • nano app/workers/add_endangered_worker.rb

      Dans ce fichier, nous ajouterons un code qui nous permettra de travailler avec les données dans notre fichier CSV. Premièrement, ajoutez du code au fichier qui créera la classe, incluez la bibliothèque CSV Ruby et assurez-vous que cette classe fonctionne comme un travailleur Sidekiq :

      ~/rails-sidekiq/app/workers/add_endangered_worker.rb

      class AddEndangeredWorker
        require 'csv'
        include Sidekiq::Worker
        sidekiq_options retry: false
      
      end
      

      Nous incluons également l’option retry: false pour nous assurer que Sidekiq ne réessaie pas de relancer le téléchargement si celui-ci échoue.

      Ensuite, ajoutez le code pour la fonction perform :

      ~/rails-sidekiq/app/workers/add_endangered_worker.rb

      class AddEndangeredWorker
        require 'csv'
        include Sidekiq::Worker
        sidekiq_options retry: false
      
        def perform(csv_file)
          CSV.foreach(csv_file, headers: true) do |shark|
          Endangered.create(name: shark[0], iucn: shark[1])
        end
       end
      
      end
      

      La méthode perform reçoit des arguments de la méthode perform_async définie dans le contrôleur, il est donc important que les valeurs d’argument correspondent. Ici, nous transmettons csv_file, la variable que nous avons définie dans le contrôleur, et nous utilisons la méthode foreach à partir de la bibliothèque CSV pour lire les valeurs dans le fichier. Définir headers:true pour cette boucle vous garantit que la première ligne du fichier sera traitée comme une ligne d’en-têtes.

      Le bloc lit ensuite les valeurs du fichier dans les colonnes que nous avons définies pour notre modèle Endangered : name et iucn. Exécuter cette boucle créera des instances Endangered pour chacune des entrées dans notre fichier CSV.

      Une fois que vous avez terminé de le modifier, enregistrez et fermez le fichier.

      Ensuite, nous allons créer un travailleur pour gérer la suppression de ces données. Ouvrez un fichier pour la classe RemoveEndangeredWorker :

      • nano app/workers/remove_endangered_worker.rb

      Ajoutez le code pour définir la classe, et pour vous assurer qu’il utilise la bibliothèque CSV et fonctionne comme un travailler Sidekiq :

      ~/rails-sidekiq/app/workers/remove_endangered_worker.rb

      class RemoveEndangeredWorker
        include Sidekiq::Worker
        sidekiq_options retry: false
      
      end
      

      Ensuite, ajoutez une méthode perform pour gérer la destruction des données sur les requins menacés :

      ~/rails-sidekiq/app/workers/remove_endangered_worker.rb

      class RemoveEndangeredWorker
        include Sidekiq::Worker
        sidekiq_options retry: false
      
        def perform
          Endangered.destroy_all
        end
      
      end
      

      La méthode perform appelle destroy_all sur la classe Endangered, elle supprimera toutes les instances de cette classe de la base de données.

      Enregistrez et fermez le fichier lorsque vous avez terminé de le modifier.

      Une fois vos travailleurs en place, vous pouvez passer à la création d’une mise en page pour vos vues endangered, et de modèles pour vos vues index et data, afin que les utilisateurs puissent télécharger et visualiser les requins menacés.

      Étape 4 – Ajout de mises en page et de modèles de vues

      Pour que les utilisateurs puissent profiter de leurs informations sur les requins menacés, nous devrons nous occuper de deux choses : la présentation des vues définies dans notre contrôleur endangered, et les modèles de vue pour les vues index et data.

      Actuellement, notre application utilise une mise en page pour l’ensemble de l’application, située à l’adresse app/views/layouts/application.html.erb, un fichier partiel pour la navigation et une mise en page pour les vues sharks. La mise en page de l’application vérifie la présence d’un bloc de contenu, ce qui nous permet de charger différentes mises en page en fonction de la partie de l’application à laquelle notre utilisateur s’intéresse : pour la page home index, il verra une mise en page, et pour toute vue relative à un requin en particulier, il en verra une autre.

      Nous pouvons réadapter la mise en page sharks à nos vues endangered, car ce format permettra également de présenter les données sur les requins en vrac.

      Copiez le fichier de configuration sharks pour créer une mise en page endangered :

      • cp app/views/layouts/sharks.html.erb app/views/layouts/endangered.html.erb

      Ensuite, nous allons travailler à créer les modèles de vue pour nos vues index et data.

      Ouvrez le modèle index en premier :

      • nano app/views/endangered/index.html.erb

      Supprimez le code standard et ajoutez à la place le code suivant, qui donnera aux utilisateurs des informations générales sur les catégories menacées et leur offrira la possibilité de télécharger des informations sur les requins menacés :

      ~/rails-sidekiq/app/views/endangered/index.html.erb

      <p id="notice"><%= notice %></p>
      
      <h1>Endangered Sharks</h1>
      
      <p>International Union for Conservation of Nature (ICUN) statuses: <b>vu:</b> Vulnerable, <b>en:</b> Endangered, <b>cr:</b> Critically Endangered </p>
      
      <br>
      
        <%= form_tag endangered_upload_path do %>
        <%= submit_tag "Import Endangered Sharks" %>
        <% end %>
      
        <br>
      
      <%= link_to 'New Shark', new_shark_path, :class => "btn btn-primary btn-sm" %> <%= link_to 'Home', home_index_path, :class => "btn btn-primary btn-sm" %>
      

      Un form_tag rend possible le téléchargement de données en pointant une action post sur endangered_upload_path – la route que nous avons définie pour nos téléchargements. Un bouton créé avec submit_tag invite les utilisateurs à "Import Endangered Sharks" (Importer les requins menacés).

      En plus de ce code, nous avons inclus quelques informations générales sur les codes ICUN, afin que les utilisateurs puissent interpréter les données qu’ils verront.

      Enregistrez et fermez le fichier lorsque vous avez terminé de le modifier.

      Ensuite, ouvrez un fichier pour la vue data :

      • nano app/views/endangered/data.html.erb

      Ajoutez le code suivant, qui ajoutera un tableau avec les données sur les requins menacés :

      ~/rails-sidekiq/app/views/endangered/data.html.erb

      <p id="notice"><%= notice %></p>
      
      <h1>Endangered Sharks</h1>
      
      <p>International Union for Conservation of Nature (ICUN) statuses: <b>vu:</b> Vulnerable, <b>en:</b> Endangered, <b>cr:</b> Critically Endangered </p>
      
      <div class="table-responsive">
      <table class="table table-striped table-dark">
        <thead>
          <tr>
            <th>Name</th>
            <th>IUCN Status</th>
            <th colspan="3"></th>
          </tr>
        </thead>
      
        <tbody>
          <% @endangered.each do |shark| %>
            <tr>
              <td><%= shark.name %></td>
              <td><%= shark.iucn %></td>
            </tr>
          <% end %>
        </tbody>
      </table>
      </div>
      
      <br>
      
        <%= form_tag endangered_destroy_path do %>
        <%= submit_tag "Delete Endangered Sharks" %>
        <% end %>
      
        <br>
      
      <%= link_to 'New Shark', new_shark_path, :class => "btn btn-primary btn-sm" %> <%= link_to 'Home', home_index_path, :class => "btn btn-primary btn-sm" %>
      

      Ce code comprend les codes de statut ICUN, une fois de plus, et un tableau Bootstrap pour les données produites. En bouclant notre variable @endangered, nous affichons le nom et le statut ICUN de chaque requin dans le tableau.

      Sous le tableau, nous avons un autre ensemble de form_tags et de submit_tags, qui s’affichent sur le chemin destroy en offrant aux utilisateurs la possibilité de "Delete Endangered Sharks" (Supprimer les requins menacés).

      Enregistrez et fermez le fichier lorsque vous avez terminé de le modifier.

      La dernière modification que nous apporterons à nos vues sera dans la vue index associée à notre contrôleur home. Vous vous souvenez peut-être que cette vue est définie comme la racine de l’application dans le fichier config/routes.rb.

      Ouvrez ce fichier pour le modifier :

      • nano app/views/home/index.html.erb

      Trouvez la colonne dans la ligne qui indique Sharks are ancient (les requins sont anciens) :

      ~/rails-sidekiq/app/views/home/index.html.erb

      . . .
              <div class="col-lg-6">
                  <h3>Sharks are ancient</h3>
                  <p>There is evidence to suggest that sharks lived up to 400 million years ago.
                  </p>
              </div>
          </div>
      </div>
      

      Ajoutez le code suivant au fichier :

      ~/rails-sidekiq/app/views/home/index.html.erb

      . . .
              <div class="col-lg-6">
                  <h3>Sharks are ancient and SOME are in danger</h3>
                  <p>There is evidence to suggest that sharks lived up to 400 million years ago. Without our help, some could disappear soon.</p>
                  <p><%= button_to 'Which Sharks Are in Danger?', endangered_index_path, :method => :get,  :class => "btn btn-primary btn-sm"%>
                  </p>
              </div>
          </div>
      </div>
      

      Nous avons inclus un appel à l’action pour que les utilisateurs en apprennent davantage sur les requins menacés, en partageant d’abord un message fort, puis en ajoutant un assistant button_to qui soumet une requête GET à notre route endangered index, donnant aux utilisateurs l’accès à cette partie de l’application. À partir de là, ils pourront télécharger et visualiser les informations sur les requins menacés.

      Enregistrez et fermez le fichier lorsque vous avez terminé de le modifier.

      Avec votre code en place, vous êtes prêt à démarrer l’application et à télécharger quelques requins vers le serveur !

      Étape 5 – Démarrage de Sidekiq et test de l’application

      Avant de démarrer l’application, nous devrons gérer les migrations sur notre base de données et démarrer Sidekiq pour activer nos travailleurs. Redis devrait déjà être en marche sur le serveur, mais nous pouvons vérifier pour en être sûr. Avec tout cela, nous serons prêts à tester l’application.

      D’abord, vérifiez que Redis fonctionne :

      Vous devriez voir une sortie similaire à la suivante :

      Output

      ● redis-server.service - Advanced key-value store Loaded: loaded (/lib/systemd/system/redis-server.service; enabled; vendor preset: enabled) Active: active (running) since Tue 2019-11-12 20:37:13 UTC; 1 weeks 0 days ago

      Ensuite, exécutez vos migrations de base de données :

      Vous pouvez maintenant démarrer Sidekiq dans le contexte de notre bundle de projet actuel en utilisant la commande bundle exec sidekiq :

      Vous verrez une sortie comme ceci, vous indiquant que Sidekiq est prêt à traiter les travaux :

      Output

      m, `$b .ss, $$: .,d$ `$$P,d$P' .,md$P"' ,$$$$$b/md$$$P^' .d$$$$$$/$$$P' $$^' `"/$$$' ____ _ _ _ _ $: ,$$: / ___|(_) __| | ___| | _(_) __ _ `b :$$ ___ | |/ _` |/ _ |/ / |/ _` | $$: ___) | | (_| | __/ <| | (_| | $$ |____/|_|__,_|___|_|__|__, | .d$$ |_| 2019-11-19T21:43:00.540Z pid=17621 tid=gpiqiesdl INFO: Running in ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-linux] 2019-11-19T21:43:00.540Z pid=17621 tid=gpiqiesdl INFO: See LICENSE and the LGPL-3.0 for licensing details. 2019-11-19T21:43:00.540Z pid=17621 tid=gpiqiesdl INFO: Upgrade to Sidekiq Pro for more features and support: http://sidekiq.org 2019-11-19T21:43:00.540Z pid=17621 tid=gpiqiesdl INFO: Booting Sidekiq 6.0.3 with redis options {:id=>"Sidekiq-server-PID-17621", :url=>nil} 2019-11-19T21:43:00.543Z pid=17621 tid=gpiqiesdl INFO: Starting processing, hit Ctrl-C to stop

      Ouvrez une deuxième fenêtre de terminal, naviguez vers le répertoire rails-sidekiq, et démarrez votre serveur d’application.

      Si vous exécutez l’application localement, utilisez la commande suivante :

      Si vous travaillez avec un serveur de développement, exécutez ce qui suit :

      • bundle exec rails s --binding=your_server_ip

      Naviguez vers localhost:3000 ou http://your_server_ip:3000 dans le navigateur. Vous verrez la page d’accueil suivante :

      Accueil Sidekiq App

      Cliquez sur le bouton Which Sharks Are in Danger?​​​​​​ (Quels sont les requins menacés ?) . Comme vous n’avez pas téléchargé de requin menacé, cela vous amènera à la vue endangered index :

      Vue Endangered Index

      Cliquez sur Import Endangered Sharks​​​ (​​Importer des requins menacés) pour importer les requins. Vous verrez un message vous indiquant que les requins ont été importés :

      Commencer l'importation

      Vous verrez également le début de l’importation. Rafraîchissez votre page pour voir le tableau complet :

      Rafraîchir le tableau

      Grâce à Sidekiq, notre important téléchargement par lots de requins menacés a réussi sans verrouiller le navigateur ni interférer avec les autres fonctionnalités de l’application.

      Cliquez sur le bouton Home (Accueil) en bas de la page, ce qui vous ramènera à la page principale de l’application :

      Accueil Sidekiq App

      De là, cliquez à nouveau sur Which Sharks Are in Danger? . Cela vous amènera maintenant directement à la vue data, puisque vous avez déjà téléchargé les requins.

      Pour tester la fonctionnalité de suppression, cliquez sur le bouton Delete Endangered Sharks (Supprimer les requins menacés) sous le tableau. Vous devriez être redirigé vers la page d’accueil de l’application une fois encore. Cliquez sur Which Sharks Are in Danger?​​​​​ une dernière fois vous renverra à la vue index, où vous aurez la possibilité de télécharger à nouveau des requins :

      Vue Endangered Index

      Votre application fonctionne maintenant avec les travailleurs Sidekiq en place, qui sont prêts à traiter les travaux et à s’assurer que les utilisateurs ont une bonne expérience en travaillant avec votre application.

      Conclusion

      Vous disposez désormais d’une application Rails fonctionnelle avec Sidekiq activé, ce qui vous permettra de décharger des opérations coûteuses dans une file d’attente de travail gérée par Sidekiq et soutenue par Redis. Cela vous permettra d’améliorer la vitesse et la fonctionnalité de votre site au fur et à mesure de son développement.

      Si vous souhaitez en savoir plus sur Sidekiq, les documents sont un bon point de départ.

      Pour en savoir plus sur Redis, consultez notre bibliothèque de ressources Redis. Vous pouvez également en savoir plus sur le fonctionnement d’un cluster Redis géré sur DigitalOcean en consultant la documentation du produit.



      Source link

      Добавление Sidekiq и Redis в приложение Ruby on Rails


      Введение

      При разработке приложения Ruby on Rails могут возникнуть такие задачи приложения, которые должны выполняться асинхронно. Обработка данных, массовая рассылка электронной почты, взаимодействие с внешними API и другие подобные задачи могут выполняться асинхронно в виде фоновых задач. Использование фоновых задач поможет повысить производительность вашего приложения за счет разгрузки потенциально ресурсоемких задач в фоновую очередь с освобождением первоначального цикла запрос/ответ.

      Sidekiq — одна из наиболее широко используемых инфраструктур фоновых задач, которые можно реализовать в приложении Rails. Она основана на системе хранения пар ключ-значение в оперативной памяти Redis, отличающейся гибкостью и высокой производительностью. Sidekiq использует Redis как хранилище для управления задачами, чтобы обрабатывать тысячи задач в секунду.

      В этом обучающем руководстве мы добавим Redis и Sidekiq в существующее приложение Rails. Мы создадим набор рабочих классов Sidekiq и методов для обработки:

      • Пакетная выгрузка информации о находящихся под угрозой вымирания акулах в базу данных приложения из файла CSV в репозитории проекта.
      • Удаление этих данных.

      После завершения работы мы получим демонстрационное приложение, использующее рабочих и задания для асинхронной обработки задач. Это обучающее руководство даст хорошую основу для добавления системы рабочих и заданий в ваше собственное приложение.

      Предварительные требования

      Для данного обучающего руководства вам потребуется следующее:

      • Локальный компьютер или сервер разработки под управлением Ubuntu 18.04. На используемом для разработки компьютере должен быть пользователь без привилегий root с административными привилегиями, а также брандмауэр, настроенный с помощью ufw. Указания по настройке можно найти в обучающем руководстве Начальная настройка сервера Ubuntu 18.04.
      • Node.js и npm, установленные на локальном компьютере или сервере разработки. В этом обучающем руководстве используются версии Node.js 10.17.0 и npm 6.11.3. Указания по установке Node.js и npm в Ubuntu 18.04 можно найти в разделе Установка с использованием PPA обучающего руководства Установка Node.js в Ubuntu 18.04.
      • Диспетчер пакетов Yarn, установленный на локальном компьютере или сервере разработки. Вы можете следовать указаниям по установке, приведенным в официальной документации.
      • Ruby, rbenv и Rails, установленные на локальном компьютере или сервере разработки в соответствии с указаниями шагов 1-4 обучающего руководства Установка Ruby on Rails с помощью rbenv в Ubuntu 18.04. В этом обучающем руководстве используются версии Ruby 2.5.1, rbenv 1.1.2 и Rails 5.2.3.
      • СУБД SQLite, установленная в соответствии с указаниями шага 1 обучающего руководства Создание приложения Ruby on Rails. В этом обучающем руководстве используется версия СУБД SQLite 3 3.22.0.
      • Система Redis, установленная в соответствии с указаниями шагов 1-3 обучающего руководства Установка и защита Redis в Ubuntu 18.04. В этом обучающем руководстве используется версия Redis 4.0.9.

      Шаг 1 — Клонирование проекта и установка зависимостей

      Нашим первым шагом будет клонирование репозитория rails-bootstrap из учетной записи DigitalOcean Community на GitHub. Этот репозиторий содержит код установки, описанный в обучающем руководстве Добавление Bootstrap в приложение Ruby on Rails, где объясняется процедура добавления Bootstrap в существующий проект Rails 5.

      Клонируйте репозиторий в директорию с именем rails-sidekiq:

      • git clone https://github.com/do-community/rails-bootstrap.git rails-sidekiq

      Перейдите в директорию rails-sidekiq:

      Для работы с кодом необходимо предварительно установить зависимости проекта, перечисленные в файле Gemfile. Также вам потребуется добавить в проект sidekiq gem для работы с Sidekiq и Redis.

      Откройте файл проекта Gemfile для редактирования, используя nano или другой предпочитаемый редактор:

      Добавьте зависимость в любое место в списке основных зависимостей проекта (над зависимостями разработки):

      ~/rails-sidekiq/Gemfile

      . . .
      # Reduces boot times through caching; required in config/boot.rb
      gem 'bootsnap', '>= 1.1.0', require: false
      gem 'sidekiq', '~>6.0.0'
      
      group :development, :test do
      . . .
      

      Сохраните и закройте файл после добавления зависимости.

      Используйте для установки зависимостей следующую команду:

      В результатах вы увидите, что зависимость redis также установлена как требование для sidekiq.

      Далее мы установим зависимости Yarn. Поскольку данный проект Rails 5 был модифицирован для обслуживания ресурсов с пакетом webpack, его зависимостями JavaScript теперь управляет Yarn. Это означает, что необходимо установить и проверить зависимости, указанные в файле проекта package.json.

      Используйте команду yarn install для установки этих зависимостей:

      Затем проведите миграцию базы данных:

      После завершения миграции вы можете протестировать приложение, чтобы убедиться, что оно работает ожидаемым образом. Запустите сервер в контексте локального пакета, используя следующую команду, если вы работаете на локальном компьютере:

      Если вы работаете на сервере разработки, вы можете запустить приложение с помощью следующей команды:

      • bundle exec rails s --binding=your_server_ip

      Перейдите на адрес localhost:3000 или http://your_server_ip:3000. Вы увидите следующую начальную страницу:

      Начальная страница приложения

      Чтобы создать новую акулу, нажмите кнопку Get Shark Info, после чего откроется путь sharks/index:

      Путь указателя акул

      Чтобы убедиться в работе приложения, добавим в него примеры данных. Нажмите New Shark. Вам будет предложено ввести имя пользователя (sammy) и пароль (shark) в связи с параметрами аутентификации проекта.

      На странице New Shark введите Great White в поле Name и Scary в поле Facts:

      Создание акулы

      Нажмите кнопку Create Shark для создания акулы. Когда акула будет создана, вы можете закрыть сервер, нажав CTRL+C.

      Вы установили необходимые зависимости для вашего проекта и протестировали его функционал. Теперь вы можете внести некоторые изменения в приложение Rails для работы с вашими ресурсами по находящимся под угрозой видам акул.

      Шаг 2 — Генерирование контроллера для ресурсов по находящимся под угрозой видам акул

      Чтобы работать с нашими ресурсами по находящимся под угрозой видам акул, мы добавим в приложение новую модель и контроллер, который будет определять, как информация по находящимся под угрозой видам акул будет выводиться пользователям. Наша конечная цель — дать пользователям возможность выгружать большие пакеты информации о находящихся под угрозой видах акул без блокировки функционала приложения и удалять эту информацию, когда она им больше не нужна.

      Прежде всего, мы создадим модель Endangered для наших находящихся под угрозой акул. Мы добавим в таблицу нашей базы данных поля строк для названий акул и категорий Международного союза охраны природы (МСОП), определяющих опасность для каждого из видов акул.

      Структура нашей модели будет соответствовать столбцам в файле CSV, который мы будем использовать для пакетной выгрузки данных. Этот файл находится в директории db, и вы можете проверить его содержимое с помощью следующей команды:

      Файл содержит список из 73 видов акул, находящихся под угрозой, и их статусов в МСОП: vu — опасность, en — угроза, cr — критическая угроза.

      Наша модель Endangered коррелирует с этими данными, позволяя создавать новые экземпляры Endangered из этого файла CSV. Создайте модель с помощью следующей команды:

      • rails generate model Endangered name:string iucn:string

      Сгенерируйте контроллер Endangered с помощью действия index:

      • rails generate controller endangered index

      Это даст нам исходную точку для создания функций нашего приложения, хотя нам понадобится добавить собственные методы в файл контроллера, сгенерированный для нас Rails.

      Откройте этот файл:

      • nano app/controllers/endangered_controller.rb

      Rails предоставляет нам каркас, который мы можем начать заполнять.

      Прежде всего нам нужно определить, какие маршруты нам потребуются для работы с нашими данными. Благодаря команде generate controller у нас имеется метод index, с которого мы можем начать. Он коррелирует с представлением index, где мы предоставим пользователям возможность выгрузки акул, находящихся под угрозой.

      Однако нам также нужны возможности и для случаев, когда пользователи уже выгрузили списки акул; в этом случае им не потребуется функция выгрузки. Нам потребуется какой-то способ, чтобы оценить количество уже существующих экземпляров класса Endangered, поскольку наличие нескольких экземпляров означает, что пакетная выгрузка уже выполнена.

      Для начала создадим частный метод set_endangered, который будет получать каждый экземпляр класса Endangered из базы данных. Добавьте в файл следующий код:

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      class EndangeredController < ApplicationController
        before_action :set_endangered, only: [:index, :data]
      
        def index
        end
      
        private
      
          def set_endangered
            @endangered = Endangered.all
          end
      
      end
      

      Обратите внимание, что фильтр before_action обеспечивает установку значения @endangered только для маршрутов index и data, где мы обрабатываем данные по находящимся под угрозой видам акул.

      Добавьте следующий код в метод index, чтобы определить правильный путь для пользователей, посещающих эту часть приложения:

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      class EndangeredController < ApplicationController
        before_action :set_endangered, only: [:index, :data]
      
        def index          
          if @endangered.length > 0
            redirect_to endangered_data_path
          else
            render 'index'
          end
        end
      . . .
      

      Если существует более 0 экземпляров нашего класса Endangered, мы перенаправляем пользователей на маршрут data, где они могут просматривать созданную ими информацию об акулах. В ином случае они перейдут к представлению index.

      Под методом index добавьте метод data, который будет коррелровать с представлением data:

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      . . .
        def index          
          if @endangered.length > 0
            redirect_to endangered_data_path
          else
            render 'index'
          end
        end
      
        def data
        end
      . . .
      

      Затем мы добавим метод для обработки самой процедуры выгрузки данных. Мы назовем этот метод upload. Он будет вызывать класс рабочего Sidekiq и метод для выполнения выгрузки данных из файла CSV. На следующем шаге мы создадим определение для этого рабочего класса AddEndangeredWorker.

      Пока что добавьте в файл следующий код для вызова рабочего Sidekiq, который будет выполнять выгрузку:

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      . . .
        def data
        end
      
        def upload
          csv_file = File.join Rails.root, 'db', 'sharks.csv'   
          AddEndangeredWorker.perform_async(csv_file)
          redirect_to endangered_data_path, notice: 'Endangered sharks have been uploaded!'
        end
      . . .
      

      Вызывая метод perform_async для класса AddEndangeredWorker с файлом CSV в качестве аргумента, этот код обеспечивает передачу в Redis данных об акулах и задания выгрузки. Заданные нами рабочие Sidekiq будут отслеживать очередь заданий и реагировать при появлении новых заданий.

      После вызова perform_async наш метод upload выполняет перенаправление на путь data, где пользователи смогут просматривать выгруженных акул.

      Далее мы добавим метод destroy для уничтожения данных. Добавьте следующий код после метода upload:

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      . . .
        def upload
          csv_file = File.join Rails.root, 'db', 'sharks.csv'   
          AddEndangeredWorker.perform_async(csv_file)
          redirect_to endangered_data_path, notice: 'Endangered sharks have been uploaded!'
        end
      
        def destroy
          RemoveEndangeredWorker.perform_async
          redirect_to root_path
        end
      . . .
      

      Как и метод upload, наш метод destroy включает вызов perform_async для класса RemoveEndangeredWorker, еще одного создаваемого нами рабочего Sidekiq. После вызова этот метод перенаправляет пользователей в корневую директорию приложения.

      Итоговый файл будет выглядеть примерно так:

      ~/rails-sidekiq/app/controllers/endangered_controller.rb

      class EndangeredController < ApplicationController
        before_action :set_endangered, only: [:index, :data]
      
        def index          
          if @endangered.length > 0
            redirect_to endangered_data_path
          else
            render 'index'
          end
        end
      
        def data
        end
      
        def upload
          csv_file = File.join Rails.root, 'db', 'sharks.csv'   
          AddEndangeredWorker.perform_async(csv_file)
          redirect_to endangered_data_path, notice: 'Endangered sharks have been uploaded!'
        end
      
        def destroy
          RemoveEndangeredWorker.perform_async
          redirect_to root_path
        end
      
        private
      
          def set_endangered
            @endangered = Endangered.all
          end
      
      end
      

      Сохраните и закройте файл после завершения редактирования.

      В заключение настройки маршрутов приложения мы изменим код в файле config/routes.rb, где хранятся декларации наших маршрутов.

      Откройте этот файл:

      Сейчас файл выглядит следующим образом:

      ~/rails-sidekiq/config/routes.rb

      Rails.application.routes.draw do
        get 'endangered/index'
        get 'home/index'
        resources :sharks do
                resources :posts
        end
        root 'home#index'
        # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
      end
      

      Нам нужно будет обновить файл, чтобы добавить в него определенные в нашем контроллере маршруты: data, upload и destroy. Маршрут data будет соответствовать запросу GET на получение данных об акулах, а маршруты upload и destroy будут соответствовать запросам POST на выгрузку и уничтожение этих данных.

      Добавьте в файл следующий код для определения этих маршрутов:

      ~/rails-sidekiq/config/routes.rb

      Rails.application.routes.draw do
        get 'endangered/index'
        get 'endangered/data', to: 'endangered#data'
        post 'endangered/upload', to: 'endangered#upload'
        post 'endangered/destroy', to: 'endangered#destroy'
        get 'home/index'
        resources :sharks do
                resources :posts
        end
        root 'home#index'
        # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
      end
      

      Сохраните и закройте файл после завершения редактирования.

      Теперь у нас есть модель Endangered и контроллер, и мы можем перейти к определению рабочих классов Sidekiq.

      Шаг 3 — Определение рабочих Sidekiq

      Мы вызываем методы perform_async для рабочих Sidekiq в нашем контроллере, однако нам все еще нужно создать самих рабочих.

      Для начала создайте для рабочих директорию workers:

      Откройте файл для рабочего AddEndangeredWorker:

      • nano app/workers/add_endangered_worker.rb

      В этом файле мы добавим код, который позволит нам работать с данными в нашем файле CSV. Вначале добавьте код в файл, который будет создавать класс, включите в него библиотеку Ruby CSV и убедитесь, что этот класс функционирует как рабочий Sidekiq:

      ~/rails-sidekiq/app/workers/add_endangered_worker.rb

      class AddEndangeredWorker
        require 'csv'
        include Sidekiq::Worker
        sidekiq_options retry: false
      
      end
      

      Также мы добавим опцию retry: false, чтобы Sidekiq не пытался повторить выгрузку в случае ошибки.

      Далее добавьте код для функции perform:

      ~/rails-sidekiq/app/workers/add_endangered_worker.rb

      class AddEndangeredWorker
        require 'csv'
        include Sidekiq::Worker
        sidekiq_options retry: false
      
        def perform(csv_file)
          CSV.foreach(csv_file, headers: true) do |shark|
          Endangered.create(name: shark[0], iucn: shark[1])
        end
       end
      
      end
      

      Метод perform получает аргументы от метода perform_async, определенного в контроллере, поэтому очень важно обеспечить согласованность значений аргументов. Здесь мы передаем файл csv_file и определенную в контроллере переменную, а также используем метод foreach из библиотеки CSV для чтения значений в файле. Установка headers: true для этого цикла обеспечивает обработку первой строки в файле как строки заголовков.

      Затем блок считывает значения из файла в столбцы, заданные для нашей модели Endangered: name и iucn. При выполнении этого цикла будут созданы экземпляры Endangered для каждой из записей в нашем файле CSV.

      После завершения редактирования сохраните и закройте файл.

      Далее мы создадим рабочего для обработки удаления этих данных. Откройте файл для класса RemoveEndangeredWorker:

      • nano app/workers/remove_endangered_worker.rb

      Добавьте код для определения класса и убедитесь, что он использует библиотеку CSV и функционирует как рабочий Sidekiq:

      ~/rails-sidekiq/app/workers/remove_endangered_worker.rb

      class RemoveEndangeredWorker
        include Sidekiq::Worker
        sidekiq_options retry: false
      
      end
      

      Затем добавьте метод perform для обработки уничтожения данных о находящихся под угрозой акулах:

      ~/rails-sidekiq/app/workers/remove_endangered_worker.rb

      class RemoveEndangeredWorker
        include Sidekiq::Worker
        sidekiq_options retry: false
      
        def perform
          Endangered.destroy_all
        end
      
      end
      

      Метод perform вызывает destroy_all для класса Endangered, в результате чего все экземпляры этого класса удаляются из базы данных.

      Сохраните и закройте файл после завершения редактирования.

      Мы настроили рабочих и теперь можем перейти к созданию макета для представлений endangered и шаблонов для представлений index и data, чтобы пользователи могли выгружать и просматривать находящихся под угрозой акул.

      Шаг 4 — Добавление макетов и шаблонов представлений

      Чтобы пользователи смогли использовать свою информацию о находящихся под угрозой акулах, нам нужно обеспечить две вещи: макет представлений, определенных в контроллере endangered, и шаблоны для представлений index и data.

      Сейчас наше приложение использует общий макет app/views/layouts/application.html.erb, элемент навигации и макет для представлений sharks. Макет приложения проверяет наличие блока контента, что позволяет загружать другие макеты в зависимости от того, с какой частью приложения взаимодействует пользователь: для главного указателя они увидят один макет, а для представлений отдельных акул — другой.

      Мы можем изменть назначение макета sharks для представлений endangered, поскольку этот формат также подойдет для вывода массива данных об акулах.

      Скопируйте файл макета sharks для создания макета endangered:

      • cp app/views/layouts/sharks.html.erb app/views/layouts/endangered.html.erb

      Далее мы создадим шаблоны для представлений index и data.

      Откройте шаблон index:

      • nano app/views/endangered/index.html.erb

      Удалите базовый код и добавьте вместо него следующий код, который будет выводить пользователям информацию о находящихся под угрозой видах и предоставлять им возможность выгрузки информации о находящихся под угрозой акулах:

      ~/rails-sidekiq/app/views/endangered/index.html.erb

      <p id="notice"><%= notice %></p>
      
      <h1>Endangered Sharks</h1>
      
      <p>International Union for Conservation of Nature (ICUN) statuses: <b>vu:</b> Vulnerable, <b>en:</b> Endangered, <b>cr:</b> Critically Endangered </p>
      
      <br>
      
        <%= form_tag endangered_upload_path do %>
        <%= submit_tag "Import Endangered Sharks" %>
        <% end %>
      
        <br>
      
      <%= link_to 'New Shark', new_shark_path, :class => "btn btn-primary btn-sm" %> <%= link_to 'Home', home_index_path, :class => "btn btn-primary btn-sm" %>
      

      Тег form_tag позволяет выгружать данные, указывая действие post для маршрута endangered_upload_path, заданного нами ранее для выгружаемых файлов. Кнопка отправки, созданная с помощью тега submit_tag, предлагает пользователям выполнить «Импорт находящихся под угрозой акул».

      В дополнение к этому коду мы указываем информацию о кодах МСОП, чтобы пользователи могли интерпретировать данные, которые они видят.

      Сохраните и закройте файл после завершения редактирования.

      Откройте файл для представления data:

      • nano app/views/endangered/data.html.erb

      Добавьте следующий код, который добавляет таблицу с данными о находящихся под угрозой видах акул:

      ~/rails-sidekiq/app/views/endangered/data.html.erb

      <p id="notice"><%= notice %></p>
      
      <h1>Endangered Sharks</h1>
      
      <p>International Union for Conservation of Nature (ICUN) statuses: <b>vu:</b> Vulnerable, <b>en:</b> Endangered, <b>cr:</b> Critically Endangered </p>
      
      <div class="table-responsive">
      <table class="table table-striped table-dark">
        <thead>
          <tr>
            <th>Name</th>
            <th>IUCN Status</th>
            <th colspan="3"></th>
          </tr>
        </thead>
      
        <tbody>
          <% @endangered.each do |shark| %>
            <tr>
              <td><%= shark.name %></td>
              <td><%= shark.iucn %></td>
            </tr>
          <% end %>
        </tbody>
      </table>
      </div>
      
      <br>
      
        <%= form_tag endangered_destroy_path do %>
        <%= submit_tag "Delete Endangered Sharks" %>
        <% end %>
      
        <br>
      
      <%= link_to 'New Shark', new_shark_path, :class => "btn btn-primary btn-sm" %> <%= link_to 'Home', home_index_path, :class => "btn btn-primary btn-sm" %>
      

      Этот код содержит коды состояния МСОП и таблицу Bootstrap для выводимых данных. Выполняя цикл с переменной @endangered, мы выведем в таблицу названия и статусы МСОП для всех акул.

      Под таблицей располагается еще один набор тегов form_tags и submit_tags, которые используют метод post для пути destroy, предлагая пользователям возможность «Удалить находящихся под угрозой акул».

      Сохраните и закройте файл после завершения редактирования.

      В заключение мы внесем изменение в представление index, связанное с нашим контроллером home. Возможно вы помните, что это представление было задано как корневое для приложения в config/routes.rb.

      Откройте этот файл для редактирования:

      • nano app/views/home/index.html.erb

      Найдите столбец в строке Sharks are ancient​​​:

      ~/rails-sidekiq/app/views/home/index.html.erb

      . . .
              <div class="col-lg-6">
                  <h3>Sharks are ancient</h3>
                  <p>There is evidence to suggest that sharks lived up to 400 million years ago.
                  </p>
              </div>
          </div>
      </div>
      

      Добавьте в файл следующий код:

      ~/rails-sidekiq/app/views/home/index.html.erb

      . . .
              <div class="col-lg-6">
                  <h3>Sharks are ancient and SOME are in danger</h3>
                  <p>There is evidence to suggest that sharks lived up to 400 million years ago. Without our help, some could disappear soon.</p>
                  <p><%= button_to 'Which Sharks Are in Danger?', endangered_index_path, :method => :get,  :class => "btn btn-primary btn-sm"%>
                  </p>
              </div>
          </div>
      </div>
      

      Мы добавили призыв к действию для пользователей, желающих узнать больше о находящихся под угрозой акулах. Вначале мы разместили привлекающее внимание сообщение, а затем добавили помощник button_to, который отправляет запрос GET на наш маршрут endangered index, предоставляя пользователям доступ к этой части приложения. Там они смогут выгружать и просматривать данные о находящихся под угрозой акулах.

      Сохраните и закройте файл после завершения редактирования.

      Мы разместили код и теперь можем запустить приложение и выгрузить несколько акул!

      Шаг 5 — Запуск Sidekiq и тестирование приложения

      Перед запуском приложения нам нужно провести миграцию базы данных и запустить Sidekiq для активации наших рабочих. Redis уже должен работать на сервере, но для точности можно это проверить. Когда мы выполним эти задачи, мы будем готовы начинать тестирование приложения.

      Проверьте работу Redis:

      Результат будет выглядеть следующим образом:

      Output

      ● redis-server.service - Advanced key-value store Loaded: loaded (/lib/systemd/system/redis-server.service; enabled; vendor preset: enabled) Active: active (running) since Tue 2019-11-12 20:37:13 UTC; 1 weeks 0 days ago

      Затем проведите миграцию базы данных:

      Теперь вы можете запустить Sidekiq в контексте текущего проекта с помощью команды bundle exec sidekiq:

      Вы увидите следующий вывод, указывающий, что Sidekiq готов к обработке заданий:

      Output

      m, `$b .ss, $$: .,d$ `$$P,d$P' .,md$P"' ,$$$$$b/md$$$P^' .d$$$$$$/$$$P' $$^' `"/$$$' ____ _ _ _ _ $: ,$$: / ___|(_) __| | ___| | _(_) __ _ `b :$$ ___ | |/ _` |/ _ |/ / |/ _` | $$: ___) | | (_| | __/ <| | (_| | $$ |____/|_|__,_|___|_|__|__, | .d$$ |_| 2019-11-19T21:43:00.540Z pid=17621 tid=gpiqiesdl INFO: Running in ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-linux] 2019-11-19T21:43:00.540Z pid=17621 tid=gpiqiesdl INFO: See LICENSE and the LGPL-3.0 for licensing details. 2019-11-19T21:43:00.540Z pid=17621 tid=gpiqiesdl INFO: Upgrade to Sidekiq Pro for more features and support: http://sidekiq.org 2019-11-19T21:43:00.540Z pid=17621 tid=gpiqiesdl INFO: Booting Sidekiq 6.0.3 with redis options {:id=>"Sidekiq-server-PID-17621", :url=>nil} 2019-11-19T21:43:00.543Z pid=17621 tid=gpiqiesdl INFO: Starting processing, hit Ctrl-C to stop

      Откройте второе окно терминала, перейдите в директорию rails-sidekiq и запустите свой сервер приложений.

      Если вы запускаете приложение на локальном компьютере, используйте следующую команду:

      Если вы работаете с сервером разработки, запустите следующую команду:

      • bundle exec rails s --binding=your_server_ip

      Откройте в браузере адрес localhost:3000 или http://your_server_ip:3000. Вы увидите следующую начальную страницу:

      Домашняя директория приложения Sidekiq

      Нажмите кнопку Which Sharks Are in Danger?. Поскольку вы еще не выгрузили акул, находящихся под угрозой вымирания, сейчас откроется экран endangered index:

      Экран Endangered Index

      Нажмите Import Endangered Sharks для импорта акул. Вы увидите сообщение о состоянии, где будет указано, что акулы были импортированы:

      Начало импорта

      Также вы увидите начало импорта. Обновите страницу, чтобы увидеть таблицу целиком:

      Обновление таблицы

      Благодаря Sidekiq пакетная выгрузка акул, находящихся под угрозой вымирания, была проведена успешно без блокировки браузера и без помех для работы других приложений.

      Нажмите кнопку Home внизу страницы, чтобы вернуться на главную страницу приложения:

      Домашняя директория приложения Sidekiq

      Далее нажмите Which Sharks Are in Danger? еще раз. Поскольку вы уже выгрузили акул, после этого откроется представление data.

      Для тестирования функции удаления нажмите кнопку Delete Endangered Sharks под таблицей. Вы снова должны быть перенаправлены на главную страницу приложения. При нажатии Which Sharks Are in Danger? вы вернетесь к представлению index, где сможете снова выгрузить акул:

      Экран Endangered Index

      Теперь ваше приложение работает с рабочими Sidekiq, которые готовы обрабатывать задания и обеспечивать высокое качество обслуживания для пользователей вашего приложения.

      Заключение

      Мы создали работающее приложение Rails с активированным Sidekiq, позволяющее разгружать ресурсоемкие операции в очередь заданий под управлением Sidekiq при поддержке Redis. Это позволит повысить скорость и функциональность разрабатываемого сайта.

      Если вы хотите узнать больше о Sidekiq, начните с документации.

      Дополнительную информацию о Redis можно найти в нашей библиотеке ресурсов по Redis. Дополнительную информацию о запуске управляемого кластера Redis в инфраструктуре DigitalOcean можно найти в документации по продукту.



      Source link