karrio-server-core 2025.5rc1__py3-none-any.whl

karrio/server/tracing/migrations/0004_tracingrecord_carrier_account_idx.py

@@ -0,0 +1,24 @@
+# Generated by Django 4.1.3 on 2022-12-10 16:20
+
+from django.db import migrations, models
+import django.db.models.fields.json
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("tracing", "0003_auto_20221105_0317"),
+    ]
+
+    operations = [
+        migrations.AddIndex(
+            model_name="tracingrecord",
+            index=models.Index(
+                django.db.models.fields.json.KeyTextTransform(
+                    "carrier_account_id", "meta"
+                ),
+                condition=models.Q(("meta__carrier_account_id__isnull", False)),
+                name="carrier_account_idx",
+            ),
+        ),
+    ]

karrio/server/tracing/migrations/0005_optimise_tracingrecord_request_log_idx.py

@@ -0,0 +1,25 @@
+# Generated by Django 4.2.8 on 2023-12-21 04:13
+
+from django.db import migrations, models
+import django.db.models.fields.json
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("tracing", "0004_tracingrecord_carrier_account_idx"),
+    ]
+
+    operations = [
+        migrations.RemoveIndex(
+            model_name="tracingrecord",
+            name="request_log_idx",
+        ),
+        migrations.AddIndex(
+            model_name="tracingrecord",
+            index=models.Index(
+                django.db.models.fields.json.KeyTransform("request_log_id", "meta"),
+                condition=models.Q(("meta__request_log_id__isnull", False)),
+                name="request_log_idx",
+            ),
+        ),
+    ]

karrio/server/tracing/migrations/0006_alter_tracingrecord_options_and_more.py

@@ -0,0 +1,49 @@
+# Generated by Django 4.2.8 on 2023-12-27 19:41
+
+from django.db import migrations, models
+import django.db.models.fields.json
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("tracing", "0005_optimise_tracingrecord_request_log_idx"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="tracingrecord",
+            options={
+                "ordering": ["-timestamp"],
+                "verbose_name": "Tracing Record",
+                "verbose_name_plural": "Tracing Records",
+            },
+        ),
+        migrations.AddIndex(
+            model_name="tracingrecord",
+            index=models.Index(
+                django.db.models.fields.json.KeyTextTransform(
+                    "workflow_action_id", "meta"
+                ),
+                condition=models.Q(("meta__workflow_action_id__isnull", False)),
+                name="workflow_action_idx",
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="tracingrecord",
+            index=models.Index(
+                django.db.models.fields.json.KeyTextTransform(
+                    "workflow_event_id", "meta"
+                ),
+                condition=models.Q(("meta__workflow_event_id__isnull", False)),
+                name="workflow_event_idx",
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="tracingrecord",
+            index=models.Index(
+                django.db.models.fields.json.KeyTextTransform("workflow_id", "meta"),
+                condition=models.Q(("meta__workflow_id__isnull", False)),
+                name="workflow_idx",
+            ),
+        ),
+    ]

karrio/server/tracing/models.py

@@ -0,0 +1,80 @@
+from functools import partial
+from django.conf import settings
+from django.db import models
+from django.db.models.fields import json
+
+from karrio.core.utils import identity
+from karrio.server.core.models import OwnedEntity, uuid
+
+
+class TracingRecord(OwnedEntity):
+    HIDDEN_PROPS = (*(("org",) if settings.MULTI_ORGANIZATIONS else tuple()),)
+
+    class Meta:
+        db_table = "tracing-record"
+        verbose_name = "Tracing Record"
+        verbose_name_plural = "Tracing Records"
+        ordering = ["-timestamp"]
+        indexes = [
+            models.Index(
+                json.KeyTextTransform("object_id", "meta"),
+                condition=models.Q(meta__object_id__isnull=False),
+                name="trace_object_idx",
+            ),
+            models.Index(
+                json.KeyTransform("request_log_id", "meta"),
+                condition=models.Q(meta__request_log_id__isnull=False),
+                name="request_log_idx",
+            ),
+            models.Index(
+                json.KeyTextTransform("carrier_account_id", "meta"),
+                condition=models.Q(meta__carrier_account_id__isnull=False),
+                name="carrier_account_idx",
+            ),
+            models.Index(
+                json.KeyTextTransform("workflow_action_id", "meta"),
+                condition=models.Q(meta__workflow_action_id__isnull=False),
+                name="workflow_action_idx",
+            ),
+            models.Index(
+                json.KeyTextTransform("workflow_event_id", "meta"),
+                condition=models.Q(meta__workflow_event_id__isnull=False),
+                name="workflow_event_idx",
+            ),
+            models.Index(
+                json.KeyTextTransform("workflow_id", "meta"),
+                condition=models.Q(meta__workflow_id__isnull=False),
+                name="workflow_idx",
+            ),
+        ]
+
+    id = models.CharField(
+        max_length=50,
+        primary_key=True,
+        default=partial(uuid, prefix="trace_"),
+        editable=False,
+    )
+    created_by = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        blank=True,
+        null=True,
+        on_delete=models.CASCADE,
+        editable=False,
+    )
+    key = models.CharField(max_length=50)
+    record = models.JSONField(
+        default=partial(identity, value={}),
+        help_text="Record data",
+    )
+    timestamp = models.FloatField()
+    meta = models.JSONField(
+        blank=True,
+        null=True,
+        default=partial(identity, value={}),
+        help_text="Readonly Context metadata use for filtering and premission check",
+    )
+    test_mode = models.BooleanField(null=False)
+
+    @property
+    def object_type(self):
+        return "tracking_record"

karrio/server/tracing/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

karrio/server/tracing/utils.py

@@ -0,0 +1,112 @@
+import logging
+
+import karrio.lib as lib
+import karrio.server.conf as conf
+import karrio.server.core.utils as utils
+import karrio.server.tracing.models as models
+import karrio.server.serializers as serializers
+
+logger = logging.getLogger(__name__)
+
+
+@utils.error_wrapper
+def save_tracing_records(context, tracer: lib.Tracer = None, schema: str = None):
+    if conf.settings.PERSIST_SDK_TRACING is False:
+        return
+
+    tracer = tracer or getattr(context, "tracer", lib.Tracer())
+
+    # Process Karrio SDK tracing records to persist records of interest.
+    @utils.async_wrapper
+    @utils.tenant_aware
+    def persist_records(**kwarg):
+        actor = getattr(context, "user", None)
+        if len(tracer.records) == 0 or getattr(actor, "id", None) is None:
+            return
+
+        try:
+            records = []
+            exists = lib.identity(
+                models.TracingRecord.access_by(context)
+                .filter(
+                    meta__request_log_id__isnull=False,
+                    meta__request_log_id=tracer.context.get("request_log_id"),
+                )
+                .exists()
+            )
+
+            if exists:
+                return
+
+            for record in tracer.records:
+                connection: dict = record.metadata.get("connection")
+
+                records.append(
+                    models.TracingRecord(
+                        key=record.key,
+                        record=record.data,
+                        timestamp=record.timestamp,
+                        created_by_id=getattr(actor, "id", None),
+                        test_mode=connection.get("test_mode", False),
+                        meta=lib.to_dict(
+                            {
+                                "tracer_id": tracer.id,
+                                "object_id": tracer.context.get("object_id"),
+                                "carrier_account_id": connection.get("id"),
+                                "carrier_id": connection.get("carrier_id"),
+                                "carrier_name": connection.get("carrier_name"),
+                                "request_log_id": tracer.context.get("request_log_id"),
+                            }
+                        ),
+                    )
+                )
+
+            saved_records = models.TracingRecord.objects.bulk_create(records)
+
+            if getattr(context, "org", None) is not None:
+                serializers.bulk_link_org(saved_records, context)
+
+            logger.info("successfully saved tracing records...")
+        except Exception as e:
+            logger.error(e, exc_info=False)
+
+    persist_records(schema=schema)
+
+
+@utils.error_wrapper
+def bulk_save_tracing_records(tracer: lib.Tracer, context=None):
+    if conf.settings.PERSIST_SDK_TRACING is False:
+        return
+
+    if len(tracer.records) == 0 or context is None:
+        return
+
+    records = []
+
+    for record in tracer.records:
+        logger.debug([f"record: {record.key}", record.metadata])
+        records.append(
+            models.TracingRecord(
+                key=record.key,
+                record=record.data,
+                timestamp=record.timestamp,
+                test_mode=getattr(context, "test_mode", False),
+                created_by_id=getattr(context.user, "id", None),
+                meta=lib.to_dict({"tracer_id": tracer.id, **(record.metadata or {})}),
+            )
+        )
+
+    saved_records = models.TracingRecord.objects.bulk_create(records)
+
+    if getattr(context, "org", None) is not None:
+        serializers.bulk_link_org(saved_records, context)
+
+    logger.info("> tracing records saved...")
+
+
+def set_tracing_context(**kwargs):
+
+    from karrio.server.core import middleware
+
+    request = middleware.SessionContext.get_current_request()
+    request.tracer.add_context(kwargs)

karrio/server/user/admin.py

@@ -0,0 +1,96 @@
+from django.conf import settings
+from django.contrib import auth
+from django.contrib import admin
+from django.contrib.auth import admin as auth_admin
+from django.utils.translation import gettext_lazy as _
+
+from karrio.server.user.models import Token, Group
+
+User = auth.get_user_model()
+admin.site.unregister(auth.models.Group)
+
+
+class UserAdmin(auth_admin.UserAdmin):
+    add_form_template = None
+    fieldsets = (
+        (None, {"fields": ("email", "password")}),
+        (_("Personal info"), {"fields": ("full_name",)}),
+        (
+            _("Permissions"),
+            {
+                "fields": (
+                    "is_active",
+                    "is_staff",
+                    "is_superuser",
+                    "groups",
+                    "user_permissions",
+                ),
+            },
+        ),
+        (_("Important dates"), {"fields": ("last_login", "date_joined")}),
+    )
+    add_fieldsets = (
+        (
+            None,
+            {
+                "classes": ("wide",),
+                "fields": ("email", "password1", "password2"),
+            },
+        ),
+    )
+    list_display = (
+        "email",
+        "full_name",
+        "is_staff",
+        "is_active",
+        "date_joined",
+        "last_login",
+    )
+    list_filter = (
+        "is_staff",
+        "is_superuser",
+        "is_active",
+        "groups",
+        "last_login",
+        "date_joined",
+    )
+    search_fields = ("email", "full_name")
+    ordering = ("email",)
+
+
+class GroupAdmin(auth_admin.GroupAdmin):
+    pass
+
+
+class TokenAdmin(admin.ModelAdmin):
+    list_display = (
+        "key",
+        "user",
+        "label",
+        *(["organization"] if settings.MULTI_ORGANIZATIONS else []),
+        "test_mode",
+        "created",
+    )
+    fields = ("user", "label", "test_mode")
+    ordering = ("-created",)
+
+    def get_queryset(self, request):
+        query = super().get_queryset(request)
+        return query.filter(user=request.user)
+
+    if settings.MULTI_ORGANIZATIONS:
+        from karrio.server.orgs.admin import TokenLinkInline
+
+        inlines = [TokenLinkInline]
+
+        def get_form(self, request, obj, change, **kwargs):
+            form = super().get_form(request, obj, change, **kwargs)
+            form.base_fields["user"].queryset = User.objects.filter(
+                orgs_organization__users__id=request.user.id
+            ).distinct()
+            return form
+
+
+admin.site.register(User, UserAdmin)
+admin.site.register(Group, GroupAdmin)
+admin.site.register(Token, TokenAdmin)

karrio/server/user/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class UserConfig(AppConfig):
+    name = "karrio.server.user"
+    verbose_name = _("AUTHENTICATION AND AUTHORIZATION")

karrio/server/user/forms.py

@@ -0,0 +1,35 @@
+from django import forms
+from django.db import transaction
+from django.contrib.auth import get_user_model
+from django.contrib.auth.forms import UserCreationForm
+from django.utils.translation import gettext_lazy as _
+
+from karrio.server.conf import settings
+from karrio.server.user.utils import send_email
+
+
+class SignUpForm(UserCreationForm):
+    redirect_url = forms.URLField(required=True)
+
+    class Meta:
+        model = get_user_model()
+        fields = ("email", "full_name")
+
+    @transaction.atomic
+    def save(self, commit=True):
+        if settings.ALLOW_SIGNUP == False:
+            raise Exception(
+                "Signup is not allowed. "
+                "Please contact your administrator to create an account."
+            )
+
+        user = super().save(commit=commit)
+
+        if commit and settings.EMAIL_ENABLED:
+            user.is_active = False
+            send_email(user, self.cleaned_data["redirect_url"])
+
+        if commit and settings.ALLOW_ADMIN_APPROVED_SIGNUP:
+            user.is_active = False
+
+        return user

karrio/server/user/migrations/0001_initial.py

@@ -0,0 +1,41 @@
+# Generated by Django 3.1.2 on 2020-10-20 20:17
+
+from django.db import migrations, models
+import django.utils.timezone
+import karrio.server.user.models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('auth', '0012_alter_user_first_name_max_length'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='User',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('password', models.CharField(max_length=128, verbose_name='password')),
+                ('last_login', models.DateTimeField(blank=True, null=True, verbose_name='last login')),
+                ('is_superuser', models.BooleanField(default=False, help_text='Designates that this user has all permissions without explicitly assigning them.', verbose_name='superuser status')),
+                ('is_staff', models.BooleanField(default=False, help_text='Designates whether the user can log into this admin site.', verbose_name='staff status')),
+                ('is_active', models.BooleanField(default=True, help_text='Designates whether this user should be treated as active. Unselect this instead of deleting accounts.', verbose_name='active')),
+                ('date_joined', models.DateTimeField(default=django.utils.timezone.now, verbose_name='date joined')),
+                ('full_name', models.CharField(blank=True, max_length=150, verbose_name='full name')),
+                ('email', models.EmailField(max_length=254, unique=True, verbose_name='email address')),
+                ('groups', models.ManyToManyField(blank=True, help_text='The groups this user belongs to. A user will get all permissions granted to each of their groups.', related_name='user_set', related_query_name='user', to='auth.Group', verbose_name='groups')),
+                ('user_permissions', models.ManyToManyField(blank=True, help_text='Specific permissions for this user.', related_name='user_set', related_query_name='user', to='auth.Permission', verbose_name='user permissions')),
+            ],
+            options={
+                'verbose_name': 'user',
+                'verbose_name_plural': 'users',
+                'abstract': False,
+            },
+            managers=[
+                ('objects', karrio.server.user.models.UserManager()),
+            ],
+        ),
+    ]

karrio/server/user/migrations/0002_token.py

@@ -0,0 +1,29 @@
+# Generated by Django 3.2.3 on 2021-05-20 10:27
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+import karrio.server.core.models.base
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('user', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Token',
+            fields=[
+                ('key', models.CharField(max_length=40, primary_key=True, serialize=False, verbose_name='Key')),
+                ('created', models.DateTimeField(auto_now_add=True, verbose_name='Created')),
+                ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='tokens', to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'verbose_name': 'Token',
+                'verbose_name_plural': 'Tokens',
+            },
+            bases=(models.Model, karrio.server.core.models.base.ControlledAccessModel),
+        ),
+    ]

karrio/server/user/migrations/0003_token_test_mode.py

@@ -0,0 +1,20 @@
+# Generated by Django 3.2.13 on 2022-07-06 13:50
+
+from django.db import migrations, models
+import functools
+import karrio.server.core.models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('user', '0002_token'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='token',
+            name='test_mode',
+            field=models.BooleanField(default=functools.partial(karrio.server.core.models._identity, *(), **{'value': False})),
+        ),
+    ]

karrio/server/user/migrations/0004_group.py

@@ -0,0 +1,26 @@
+# Generated by Django 3.2.14 on 2022-09-01 18:44
+
+import django.contrib.auth.models
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('auth', '0012_alter_user_first_name_max_length'),
+        ('user', '0003_token_test_mode'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Group',
+            fields=[
+                ('group_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='auth.group')),
+            ],
+            bases=('auth.group',),
+            managers=[
+                ('objects', django.contrib.auth.models.GroupManager()),
+            ],
+        ),
+    ]

karrio/server/user/migrations/0005_token_label.py

@@ -0,0 +1,21 @@
+# Generated by Django 5.0 on 2023-12-08 05:41
+
+import django.utils.timezone
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("user", "0004_group"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="token",
+            name="label",
+            field=models.CharField(
+                default=django.utils.timezone.now, max_length=50, verbose_name="label"
+            ),
+            preserve_default=False,
+        ),
+    ]

karrio/server/user/migrations/0006_workspaceconfig.py

@@ -0,0 +1,63 @@
+# Generated by Django 4.2.10 on 2024-03-12 18:03
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+import functools
+import karrio.server.core.models
+import karrio.server.core.models.base
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("user", "0005_token_label"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="WorkspaceConfig",
+            fields=[
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                (
+                    "id",
+                    models.CharField(
+                        default=functools.partial(
+                            karrio.server.core.models.base.uuid,
+                            *(),
+                            **{"prefix": "wcfg_"}
+                        ),
+                        editable=False,
+                        max_length=50,
+                        primary_key=True,
+                        serialize=False,
+                    ),
+                ),
+                (
+                    "config",
+                    models.JSONField(
+                        default=functools.partial(
+                            karrio.server.core.models._identity, *(), **{"value": {}}
+                        )
+                    ),
+                ),
+                (
+                    "created_by",
+                    models.ForeignKey(
+                        blank=True,
+                        editable=False,
+                        null=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Workspace Config",
+                "verbose_name_plural": "Workspace Configs",
+                "db_table": "workspace-config",
+            },
+            bases=(karrio.server.core.models.base.ControlledAccessModel, models.Model),
+        ),
+    ]