Route overrides

This is the official documentation of the forestadmin-agent-django and forestadmin-agent-flask Python agents.

Route overrides ↗ allowed customizing the behavior of the routes exposed by the agent.

This very low-level feature was used to implement many use cases:

• Attach handlers to events in the UI

• Customize filtering, search and sort behaviors

• Other advanced use cases.

Because our new agent API is higher-level, the protocol used to communicate between the agent and the application can no longer be manipulated.

Code cheatsheet

What was the route override used for?	How to migrate it?
Add custom permissions	Use .add_hook and throw forbidden errors
Add validation to fields	Use .add_field_validation instead
Add validation to whole records	Use .add_hook and throw validation errors
Run code on UI events	Use .add_hook to perform custom logic
Change the search behavior	Use .replace_search to implement your custom search logic
Change the filtering behavior of fields	Use .replace_field_operator
Change the sort behavior of fields	Use .replace_field_sorting
Other use case	If you are stuck or think that this guide can be improved, please expose your use case in the community forums ↗ and we will be happy to help you

Examples

Add custom permissions

Custom permissions would better be implemented by using the Roles ↗ feature from the UI.

Before

• Define a new route into your urls.py file:

• Add a new method in your controller.

from django.http import  HttpResponse
from django.views import generic

from app.models import Book

class BooksView(generic.ListView):
    def delete(self, request, pk, *args, **kwargs):
        Book.objects.filter(id=pk).delete()

        return HttpResponse(status=204)

After

from forestadmin.datasource_toolkit.decorators.hook.context.delete import (
    HookBeforeDeleteContext
)

def before_delete_hook(context: HookBeforeDeleteContext):
    is_allowed = True  # Your logic here

    if is_allowed is False:
        context.throw_forbidden_error(
            "This collection is protected, you cannot remove from it."
        )

agent.customize_collection('Book').add_hook('Before', 'Delete', before_delete_hook)

Add validation to fields

Before

• Define a new route into your urls.py file.

• Add a new method to your controller.

import re

from django.http import  HttpResponse
from django_forest.resources.views.detail import DetailView
from django_forest.resources.views.list import ListView

from app.models import Book

class CompanyView(ListView):
    def post(self, request, pk, *args, **kwargs):
        patch = self.get_body(request.body)["data"]["attributes"]

        if "name" in patch and re.search(r'^Forest', patch["name"]):
            return self.error_response(
                "All company names should begin with 'Forest'."
            )

        return super().post(request, pk, *args, **kwargs)

class CompanyDetailView(DetailView):
    def put(self, request, pk):
        patch = self.get_body(request.body)["data"]["attributes"]

        if "name" in patch and re.search(r'^Forest', patch["name"]):
            return self.error_response(
                "All company names should begin with 'Forest'."
            )

        return super().put(request, pk)

After

agent.customize_collection('companies').add_field_validation(
    'name', 'match', r'^Forest'
)

Run code on UI events

Before

• Define a new route into your urls.py file:

• Add a new method to your controller.

from django_forest.resources.views.list import ListView

class CustomerView(ListView):
    def post(self, request, pk, *args, **kwargs):
        try:
            superagent.post('https://my-company/create-card').set(
                'X-API-Key', '**********'
            ).end()
        finally:
            return super().post(request, pk, *args, **kwargs)

After

from forestadmin.datasource_toolkit.decorators.hook.context.create import (
    HookBeforeCreateContext
)

def before_create_hook(context: HookBeforeCreateContext):
    superagent.post('https://my-company/create-card').set(
        'X-API-Key', '***********'
    ).end()

agent.customize_collection('customers').add_hook(
    'Before', 'Create', before_create_hook
)