Need help with a plugin

[alamsarwar]

I'm very new to InvenTree and trying to create a plugin following various docs but not getting expected filtered response. My plugin code is like (with help from Gemini)

import structlog
from django.utils.translation import gettext_lazy as _

# Use the base class only
from plugin.plugin import InvenTreePlugin

logger = structlog.get_logger('inventree')

class MyQueryInterceptorPlugin(InvenTreePlugin):
    NAME = 'Query Interceptor'
    SLUG = 'query-interceptor'
    TITLE = _('Query Interceptor')
    DESCRIPTION = _('Filters query results based on metadata key:value')
    VERSION = '1.y.0'
    AUTHOR = _('Some one')
    
    # 1. Force the registry to see this as a Queryset plugin
    FILTER_API = True
    
    # This tells InvenTree 1.1.x to treat this as a queryset mixin
    def mixins(self):
        return ['queryset']

    def filter_queryset(self, queryset, request, view):
        from django.db.models import Q
        
        # LOG THIS IMMEDIATELY - If you don't see this in 'pm2 logs', the method isn't being called
        logger.warning(f"!!! INTERCEPTOR EXECUTION: {view.__class__.__name__} !!!")
        
        try:
            org_id_raw = request.query_params.get("organization_id", None)
            if not org_id_raw:
                return queryset

            # 2. Check for metadata support
            if not hasattr(queryset.model, 'metadata'):
                return queryset

            # 3. Handle Integer vs String (Postgres JSONField is strict)
            try:
                org_id_int = int(org_id_raw)
            except (ValueError, TypeError):
                org_id_int = None

            # 4. Use the "Contains" operator - most reliable for JSON blobs
            # This matches {"organization_id": 23} or {"organization_id": "23"}
            if org_id_int is not None:
                query = Q(metadata__contains={'organization_id': org_id_int}) | \
                        Q(metadata__contains={'organization_id': str(org_id_raw)})
            else:
                query = Q(metadata__contains={'organization_id': str(org_id_raw)})

            filtered = queryset.filter(query)
            logger.warning(f"[ORG FILTER] Applied. Results found: {filtered.count()}")
            return filtered

        except Exception as e:
            logger.error(f"[ORG FILTER ERROR] {e}")
            return queryset

Any help in this regard will be highly appreciated

[matmair]

You AI hallucinated a non existent mixin class and functionality. Nice waist of time for everyone involved.

If you want help state your problem, goals, considerations; not known to be broken AI slop

[alamsarwar]

Thanks, for your prompt response. Good to know that the mess up was done by AI.
My objective here is, I want my plugin to intercept api get requests to check if organization_id param is there the response should filtered based entitity's metadata eg. /api/parts/?organization_id=5 should only return those parts having organization_id with value 5 in their metadat. By the way I'm using Inventree 1.1.6 and here is my plugin.registry json

{
        "pk": 90,
        "key": "query-interceptor",
        "name": "Ouery Interceptor",
        "package_name": null,
        "active": true,
        "meta": {
            "slug": "query-interceptor",
            "human_name": "Ouery Interceptor",
            "description": "Filters query results based on metadata key:value",
            "author": "Some one",
            "pub_date": "",
            "version": "1.y.0",
            "website": null,
            "license": null,
            "package_path": "/path/to/rest_api_interceptor/interceptor.py",
            "settings_url": "/web/settings/admin/plugin/90/"
        },
        "mixins": {
            "base": {
                "key": "base",
                "human_name": "base"
            }
        },
        "is_builtin": false,
        "is_sample": false,
        "is_installed": true,
        "is_package": false,
        "is_mandatory": true
    }

[SchrodingersGat]

This will require some major changes to the core source code. Currently the plugins framework cannot intercept API calls in this manner. There are no plans to make these changes as it would likely result in a significant performance hit unless very carefully implemented.

You can however implement your own API endpoints and then, do whatever you like.

[SchrodingersGat]

Please refer to (and read) the documentation at least:

• https://docs.inventree.org/en/latest/plugins/
• https://docs.inventree.org/en/latest/plugins/develop/
• https://docs.inventree.org/en/latest/plugins/creator/