karrio-server-core 2025.5rc31__py3-none-any.whl → 2026.1.1__py3-none-any.whl

karrio/server/providers/migrations/0091_migrate_legacy_zones_surcharges.py

@@ -0,0 +1,154 @@
+# Generated by Django - Migrate legacy zones/surcharges to shared format and remove legacy fields
+
+from django.db import migrations, models
+
+
+def migrate_legacy_to_shared_format(apps, schema_editor):
+    """
+    Migrate legacy per-service zones and surcharges to the new shared format.
+
+    Legacy format:
+    - ServiceLevel.zones: [{'label': 'Zone 1', 'rate': 10.0, 'country_codes': [...], ...}]
+    - ServiceLevel.surcharges: [{'name': 'Fuel', 'amount': 5.0, 'surcharge_type': 'percentage'}]
+
+    New format:
+    - RateSheet.zones: [{'id': 'zone_1', 'label': 'Zone 1', 'country_codes': [...]}]
+    - RateSheet.surcharges: [{'id': 'surch_1', 'name': 'Fuel', 'amount': 5.0, ...}]
+    - RateSheet.service_rates: [{'service_id': 'svc_1', 'zone_id': 'zone_1', 'rate': 10.0}]
+    - ServiceLevel.zone_ids: ['zone_1', 'zone_2']
+    - ServiceLevel.surcharge_ids: ['surch_1']
+    """
+    RateSheet = apps.get_model('providers', 'RateSheet')
+
+    for rate_sheet in RateSheet.objects.all():
+        # Skip if already migrated (has zones or service_rates)
+        if rate_sheet.zones or rate_sheet.service_rates:
+            continue
+
+        all_zones = {}
+        all_surcharges = {}
+        service_rates = []
+        zone_counter = 1
+        surcharge_counter = 1
+
+        # Process each service in the rate sheet
+        for service in rate_sheet.services.all():
+            legacy_zones = service.zones or []
+            legacy_surcharges = service.surcharges or []
+
+            service_zone_ids = []
+            service_surcharge_ids = []
+
+            # Process zones
+            for zone_data in legacy_zones:
+                # Create zone signature for deduplication
+                # Use `or []` to handle None values
+                cities = zone_data.get('cities') or []
+                postal_codes = zone_data.get('postal_codes') or []
+                country_codes = zone_data.get('country_codes') or []
+
+                zone_signature = {
+                    'label': zone_data.get('label') or f'Zone {zone_counter}',
+                    'cities': sorted(cities),
+                    'postal_codes': sorted(postal_codes),
+                    'country_codes': sorted(country_codes),
+                }
+                sig_key = str(zone_signature)
+
+                if sig_key not in all_zones:
+                    zone_id = f"zone_{zone_counter}"
+                    all_zones[sig_key] = {
+                        'id': zone_id,
+                        'label': zone_signature['label'],
+                        'cities': cities,
+                        'postal_codes': postal_codes,
+                        'country_codes': country_codes,
+                        'transit_days': zone_data.get('transit_days'),
+                        'transit_time': zone_data.get('transit_time'),
+                        'radius': zone_data.get('radius'),
+                        'latitude': zone_data.get('latitude'),
+                        'longitude': zone_data.get('longitude'),
+                    }
+                    zone_counter += 1
+
+                zone_id = all_zones[sig_key]['id']
+                service_zone_ids.append(zone_id)
+
+                # Create service rate record
+                service_rates.append({
+                    'service_id': service.id,
+                    'zone_id': zone_id,
+                    'rate': zone_data.get('rate', 0),
+                    'cost': zone_data.get('cost'),
+                    'min_weight': zone_data.get('min_weight'),
+                    'max_weight': zone_data.get('max_weight'),
+                    'transit_days': zone_data.get('transit_days'),
+                    'transit_time': zone_data.get('transit_time'),
+                })
+
+            # Process surcharges
+            for surcharge_data in legacy_surcharges:
+                # Create surcharge signature for deduplication
+                surcharge_signature = {
+                    'name': surcharge_data.get('name', f'Surcharge {surcharge_counter}'),
+                    'amount': surcharge_data.get('amount', 0),
+                    'surcharge_type': surcharge_data.get('surcharge_type', 'fixed'),
+                }
+                sig_key = str(surcharge_signature)
+
+                if sig_key not in all_surcharges:
+                    surcharge_id = f"surch_{surcharge_counter}"
+                    all_surcharges[sig_key] = {
+                        'id': surcharge_id,
+                        'name': surcharge_signature['name'],
+                        'amount': surcharge_signature['amount'],
+                        'surcharge_type': surcharge_signature['surcharge_type'],
+                        'cost': surcharge_data.get('cost'),
+                        'active': surcharge_data.get('active', True),
+                    }
+                    surcharge_counter += 1
+
+                surcharge_id = all_surcharges[sig_key]['id']
+                service_surcharge_ids.append(surcharge_id)
+
+            # Update service with zone_ids and surcharge_ids
+            service.zone_ids = list(set(service_zone_ids))  # Deduplicate
+            service.surcharge_ids = list(set(service_surcharge_ids))  # Deduplicate
+            service.save(update_fields=['zone_ids', 'surcharge_ids'])
+
+        # Save shared zones and surcharges to rate sheet
+        if all_zones or service_rates:
+            rate_sheet.zones = list(all_zones.values())
+            rate_sheet.service_rates = service_rates
+            rate_sheet.surcharges = list(all_surcharges.values())
+            rate_sheet.save(update_fields=['zones', 'service_rates', 'surcharges'])
+
+
+def reverse_migration(apps, schema_editor):
+    """
+    Reverse migration is a no-op since we're not deleting the legacy data,
+    just adding new fields. The legacy fields will be removed in a separate migration.
+    """
+    pass
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('providers', '0090_ratesheet_surcharges_servicelevel_zone_surcharge_ids'),
+    ]
+
+    operations = [
+        # First, migrate the data
+        migrations.RunPython(migrate_legacy_to_shared_format, reverse_migration),
+
+        # Then remove the legacy fields from ServiceLevel
+        migrations.RemoveField(
+            model_name='servicelevel',
+            name='zones',
+        ),
+        migrations.RemoveField(
+            model_name='servicelevel',
+            name='surcharges',
+        ),
+    ]

karrio/server/providers/models/carrier.py

@@ -3,6 +3,7 @@ import functools
 import django.conf as conf
 import django.forms as forms
 import django.db.models as models
+from django.db.models import Q, OuterRef, Subquery, Case, When, IntegerField
 
 import karrio.lib as lib
 import karrio.sdk as karrio
@@ -21,37 +22,88 @@ DIMENSION_UNITS = [(c.name, c.name) for c in units.DimensionUnit]
 CAPABILITIES_CHOICES = [(c, c) for c in units.CarrierCapabilities.get_capabilities()]
 
 
+class CarrierQuerySet(models.QuerySet):
+    def resolve_config_for(self, context):
+        from karrio.server.providers.models.config import CarrierConfig
+
+        if context is None:
+            return self
+
+        user = getattr(context, "user", None)
+        org = getattr(context, "org", None)
+
+        if isinstance(context, dict):
+            user = user or context.get("user")
+            org = org or context.get("org")
+
+        # 1. Define what "My Config" looks like (User or Org specific)
+        my_config_filter = Q()
+        if org:
+            my_config_filter = Q(org=org)
+        elif user and getattr(user, "is_authenticated", False):
+            my_config_filter = Q(created_by=user)
+
+        # 2. Define what "System Default" looks like
+        system_default_filter = Q(created_by__is_staff=True)
+        if hasattr(CarrierConfig, "org"):
+            system_default_filter &= Q(org__isnull=True)
+
+        # 3. Build the Subquery - only use priority if we have a user/org filter
+        config_filter = (
+            my_config_filter | system_default_filter
+            if my_config_filter
+            else system_default_filter
+        )
+
+        config_query = CarrierConfig.objects.filter(carrier=OuterRef("pk")).filter(
+            config_filter
+        )
+
+        if my_config_filter:
+            # Prioritize user/org config over system default
+            config_query = config_query.annotate(
+                priority=Case(
+                    When(my_config_filter, then=0),
+                    default=1,
+                    output_field=IntegerField(),
+                )
+            ).order_by("priority")
+
+        # 4. Annotate the queryset
+        return self.annotate(
+            _computed_config=Subquery(config_query.values("config")[:1])
+        )
+
+
 class Manager(models.Manager):
     def get_queryset(self):
         return (
-            super()
-            .get_queryset()
+            CarrierQuerySet(self.model, using=self._db)
             .select_related(
                 "created_by",
+                "rate_sheet",
                 *(("link",) if conf.settings.MULTI_ORGANIZATIONS else tuple()),
             )
+            .prefetch_related(
+                "active_users",
+                *(("org",) if conf.settings.MULTI_ORGANIZATIONS else tuple()),
+            )
         )
 
+    def resolve_config_for(self, context):
+        return self.get_queryset().resolve_config_for(context)
+
 
 class CarrierManager(Manager):
     def get_queryset(self):
-        return (
-            super()
-            .get_queryset()
-            .prefetch_related(
-                *(("org",) if conf.settings.MULTI_ORGANIZATIONS else tuple()),
-            )
-            .filter(is_system=False)
-        )
+        return super().get_queryset().filter(is_system=False)
 
 
 class SystemCarrierManager(models.Manager):
     def get_queryset(self):
         return (
-            super()
-            .get_queryset()
+            CarrierQuerySet(self.model, using=self._db)
             .prefetch_related(
-                "configs",
                 *(("active_orgs",) if conf.settings.MULTI_ORGANIZATIONS else tuple()),
             )
             .select_related(
@@ -61,12 +113,17 @@ class SystemCarrierManager(models.Manager):
             .filter(is_system=True)
         )
 
+    def resolve_config_for(self, context):
+        return self.get_queryset().resolve_config_for(context)
+
 
 @core.register_model
 class Carrier(core.OwnedEntity):
     class Meta:
         ordering = ["test_mode", "-created_at"]
 
+    CONTEXT_RELATIONS = ["rate_sheet"]
+
     objects = Manager()
     user_carriers = CarrierManager()
     system_carriers = SystemCarrierManager()
@@ -138,6 +195,11 @@ class Carrier(core.OwnedEntity):
         on_delete=models.SET_NULL,
     )
 
+    @classmethod
+    def resolve_context_data(cls, queryset, context):
+        """Apply context-aware carrier config resolution."""
+        return queryset.resolve_config_for(context)
+
     def __str__(self):
         return self.carrier_id
 
@@ -160,19 +222,16 @@ class Carrier(core.OwnedEntity):
             if "custom_carrier_name" in self.credentials
             else lib.failsafe(lambda: self.carrier_code) or "generic"
         )
-        # return (
-        #     self.credentials.get("custom_carrier_name")
-        #     if "custom_carrier_name" in self.credentials
-        #     else lib.failsafe(lambda: self.carrier_code) or "generic"
-        # )
 
     @property
     def display_name(self):
         import karrio.references as references
 
-        return self.credentials.get("display_name") or references.REFERENCES[
-            "carriers"
-        ].get(self.ext) or "generic"
+        return (
+            self.credentials.get("display_name")
+            or references.REFERENCES["carriers"].get(self.ext)
+            or "generic"
+        )
 
     @property
     def carrier_config(self):
@@ -180,7 +239,16 @@ class Carrier(core.OwnedEntity):
 
     @property
     def config(self) -> dict:
-        return getattr(self.carrier_config, "config", {})
+        if hasattr(self, "_computed_config"):
+            annotated_config = self._computed_config
+            if annotated_config is not None:
+                return annotated_config
+            # If the annotation didn't resolve (eg. context missing), fall back to DB lookup.
+        resolved_config = getattr(self.carrier_config, "config", None)
+        if resolved_config is not None:
+            return resolved_config
+        # Return empty dict if no config is found - do NOT fallback to credentials
+        return {}
 
     @property
     def services(self) -> typing.Optional[typing.List[dict]]:
@@ -204,7 +272,14 @@ class Carrier(core.OwnedEntity):
 
         if any(self.services or []):
             _computed_data.update(
-                services=[forms.model_to_dict(s) for s in self.services]
+                services=[
+                    {
+                        **forms.model_to_dict(s),
+                        "zones": s.zones,  # Include computed zones property
+                        "surcharges": s.surcharges,  # Include computed surcharges property
+                    }
+                    for s in self.services
+                ]
             )
 
         # override the config with the system config
@@ -222,27 +297,24 @@ class Carrier(core.OwnedEntity):
     @property
     def gateway(self) -> gateway.Gateway:
         import karrio.server.core.middleware as middleware
+        import karrio.server.core.config as system_config
 
         _context = middleware.SessionContext.get_current_request()
         _tracer = getattr(_context, "tracer", lib.Tracer())
         _cache = lib.Cache(caching.cache)
+        _config = lib.SystemConfig(system_config.config)
 
         return karrio.gateway[self.ext].create(
             self.data.to_dict(),
             _tracer,
             _cache,
+            _config,
         )
 
     @staticmethod
     def resolve_config(
         carrier, is_user_config: bool = False, is_system_config: bool = False
     ):
-        """Resolve the config for a carrier.
-        Here are the rules:
-        - If the carrier is a system carrier, return the first config with no org
-        - If the carrier is an org carrier, return the first config from the org
-        - If the carrier is a user carrier, return the first config from the user
-        """
         import karrio.server.serializers as serializers
         import karrio.server.core.middleware as middleware
         from django.contrib.auth.models import AnonymousUser