Вирішення помилок маппінгу Devise з версіонуванням API в Rails

Коли ви використовуєте Devise для аутентифікації в Rails API з версіонуванням, ви можете зіткнутися з наступною помилкою, особливо після того, як ви додали версіонування до вашого API, використовуючи кастомний контролер:

AbstractController::ActionNotFound (Не вдалося знайти Devise мапінг для шляху "/api/v1/users/[email protected]".  
Це може статися з двох причин:  

1) Ви забули обгорнути ваш маршрут у блок scope. Наприклад:  
devise_scope :user do  
 get "/some/route" => "some_devise_controller"  
end  
2) Ви тестуєте контролер Devise, обминаючи роутер.  
У такому разі ви можете явно вказати Devise, який мапінг використовувати:  
@request.env["devise.mapping"] = Devise.mappings[:user]  
):

Ця проблема виникає, тому що Devise не може знайти правильний мапінг для запитуваного маршруту, особливо при роботі з версіонуванням API. Ось як можна вирішити проблему.

Розуміння проблеми

Помилка зазвичай виникає з однієї з таких причин:

1.
Маршрут не налаштований у межах scope: Devise очікує, що маршрут буде явно визначений всередині блоку devise_scope, щоб правильно встановити мапінг для моделі користувача.
2.
Оминання маршрутизатора: Коли ви тестуєте контролер Devise без маршрутизації через Rails router, мапінг має бути явно встановлений в контролері.

При використанні версій API, наявність неймспейсів може ускладнити вирішення маршрутів, тому важливо переконатися, що мапінг узгоджений з очікуваним неймспейсом і структурою контролера.

Дуже легко припустити, що це буде рішенням проблеми, як вказано в помилці під час тестування кінцевої точки за допомогою команди curl:

curl -X GET "http://localhost:3000/api/v1/users/[email protected]"

З припущенням, що наступні зміни можуть вирішити проблему:

devise_scope :user do  
 get 'users/exists', to: 'users/registrations#exists'  
 end

Але при роботі з Devise та неймспейсами в Rails, особливо при версіонуванні API, стандартна логіка мапінгу не працює автоматично для кастомних маршрутів, таких як users/exists.
Цю проблему можна вирішити лише за допомогою devise_scope, оскільки Devise вимагає явного мапінгу на ресурс (наприклад, User ) для кастомних маршрутів. Ось чому і як це рішення працює:

Рішення: Використання devise_scope з неймспейсами

Правильне використання devise_scope забезпечує, що Devise мапує запити до відповідної моделі користувача та контролера в зазначеному неймспейсі.

Щоб виправити цю проблему, переконайтеся, що ваш файл routes.rb містить правильну декларацію devise_scope в бажаному неймспейсі. devisescope :apiv1_user замість devise_scope :user do

Оновлений файл routes.rb

Rails.application.routes.draw do  
 mount Rswag::Ui::Engine => '/api-docs'  
 mount Rswag::Api::Engine => '/api-docs'  
..... # інші маршрути  

 devise_scope :api_v1_user do  
 get 'users/exists', to: 'users/registrations#exists'  
 end

Чому це працює:

1.
devise_scope: Блок devise_scope забезпечує правильне мапування для моделі user, що робить маршрут users/exists доступним в неймспейсі api/v1.
2. Посилання на контролер: Забезпечує, щоб маршрут вів до правильного контролера та дії, наприклад, users/registrations#exists.
3.
Сумісність з неймспейсами: Розміщення devise_scope всередині namespace :api do забезпечує правильну роботу маршруту з версіонуванням API.

Наступний крок — додати дію exists в контролер

У контролері Api::V1::Users::RegistrationsController додайте дію exists, щоб перевіряти наявність email:

Код контролера

class Api::V1::Users::RegistrationsController < Devise::RegistrationsController  
 skip_before_action :authenticate_user!, only: [:exists]  

def exists  
 email = params[:email]  
 if email.blank?  
 render json: { error: 'Email обов\'язковий' }, status: :bad_request  
 else  
 exists = User.exists?(email: email)  
 render json: { exists: exists }  
 end  
 end  
end

Тестування ендпоінта

Після того, як маршрут і контролер будуть налаштовані правильно, протестуйте ендпоінт за допомогою curl або будь-якого HTTP-клієнта:

Тестування з curl

curl -X GET "http://localhost:3000/api/v1/users/[email protected]"

Очікувана відповідь: Якщо email користувача існує:

{  
 "exists": true  
}

Тестування з Axios у React

Якщо ви викликаєте цей ендпоінт з фронтенду на React, переконайтеся, що ваш API-запит відповідає оновленому маршруту:

import axios from 'axios';  

export const checkEmailExists = async (email) => {  
 try {  
 const response = await axios.get('http://localhost:3000/api/v1/users/exists', {  
 params: { email },  
 });  
 return response.data.exists;  
 } catch (error) {  
 console.error('Помилка при перевірці email:', error);  
 return false;  
 }  
};

Висновок

Правильне визначення devise_scope та забезпечення того, щоб маршрут відповідав вашій структурі версіонування API, дозволить уникнути помилок AbstractController::ActionNotFound і безперешкодно інтегрувати Devise у ваш Rails API.
Цей підхід забезпечує сумісність між Devise та версіонуванням API, роблячи вашу логіку автентифікації надійною та підтримуваною.

Дякую за прочитане. Залиште "клап" або коментар з вашим рішенням цієї проблеми, щоб ми могли навчатися один у одного.

Щасливого кодування.

Перекладено з: Solving Devise Mapping Errors with API Versioning in Rails