simple-module-feature-flags 0.0.37__tar.gz → 0.0.38__tar.gz

{simple_module_feature_flags-0.0.37 → simple_module_feature_flags-0.0.38}/.gitignore

@@ -7,8 +7,6 @@ build/
 .venv/
 *.egg
 
-# UV
-uv.lock
 
 # Node
 node_modules/
@@ -65,3 +63,4 @@ host/client_app/.playwright-cli/*
 .qa/
 .verify/
 /openapi.json
+qa-shots/

{simple_module_feature_flags-0.0.37 → simple_module_feature_flags-0.0.38}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: simple_module_feature_flags
-Version: 0.0.37
+Version: 0.0.38
 Summary: Simple feature-flag module with per-tenant overrides and a consumer API for simple_module
 Project-URL: Homepage, https://github.com/antosubash/simple_module_python
 Project-URL: Repository, https://github.com/antosubash/simple_module_python
@@ -21,9 +21,9 @@ Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Typing :: Typed
 Requires-Python: >=3.12
-Requires-Dist: simple-module-core==0.0.37
-Requires-Dist: simple-module-db==0.0.37
-Requires-Dist: simple-module-hosting==0.0.37
+Requires-Dist: simple-module-core==0.0.38
+Requires-Dist: simple-module-db==0.0.38
+Requires-Dist: simple-module-hosting==0.0.38
 Description-Content-Type: text/markdown
 
 # simple_module_feature_flags
@@ -61,7 +61,7 @@ Gate a route using the registry dependency:
 ```python
 from fastapi import APIRouter, HTTPException
 
-from feature_flags.deps import FeatureFlagRegistryDep  # type: ignore[import-not-found]
+from feature_flags.deps import FeatureFlagRegistryDep
 
 router = APIRouter()
 

{simple_module_feature_flags-0.0.37 → simple_module_feature_flags-0.0.38}/README.md

@@ -33,7 +33,7 @@ Gate a route using the registry dependency:
 ```python
 from fastapi import APIRouter, HTTPException
 
-from feature_flags.deps import FeatureFlagRegistryDep  # type: ignore[import-not-found]
+from feature_flags.deps import FeatureFlagRegistryDep
 
 router = APIRouter()
 

{simple_module_feature_flags-0.0.37 → simple_module_feature_flags-0.0.38}/feature_flags/contracts/schemas.py

@@ -11,7 +11,7 @@ from sqlmodel import Field, SQLModel
 class FeatureFlagOverrideOut(SQLModel):
     """Stored override row as returned by the service/API."""
 
-    model_config = ConfigDict(from_attributes=True)
+    model_config = ConfigDict(from_attributes=True)  # ty: ignore[invalid-assignment]
 
     id: int
     scope: str

{simple_module_feature_flags-0.0.37 → simple_module_feature_flags-0.0.38}/feature_flags/endpoints/views.py

@@ -9,6 +9,7 @@ frontend doesn't need separate routes per scope.
 from __future__ import annotations
 
 from fastapi import APIRouter, Depends, Request
+from simple_module_hosting.i18n_deps import TranslatorDep
 from simple_module_hosting.inertia_deps import InertiaDep
 from simple_module_hosting.permissions import RequiresPermission
 from simple_module_inertia import InertiaResponse
@@ -75,9 +76,10 @@ async def browse(
     inertia: InertiaDep,
     service: FeatureFlagServiceDep,
     registry: FeatureFlagRegistryDep,
+    translator: TranslatorDep,
     tenant_id: str | None = None,
 ) -> InertiaResponse:
-    flags = await service.list_flags(registry, tenant_id=tenant_id)
+    flags = await service.list_flags(registry, tenant_id=tenant_id, translate=translator.t)
     tenants = await service.list_tenants_with_overrides()
     return await inertia.render(
         PAGE_BROWSE,

simple_module_feature_flags-0.0.38/feature_flags/locales/de.json

@@ -0,0 +1,56 @@
+{
+  "browse": {
+    "title": "Funktionsschalter",
+    "description": "Laufzeitschalter. Eine Organisationsüberschreibung hat Vorrang vor dem Systemwert.",
+    "empty_title": "Keine Funktionsschalter registriert",
+    "empty_description": "Module deklarieren Schalter über register_feature_flags(). Installieren Sie eines, um sie hier zu sehen.",
+    "scope_label": "Geltungsbereich",
+    "viewing_system": "Systemweite Schalter — gelten für jede Organisation, sofern sie nicht überschrieben werden.",
+    "viewing_tenant": "Überschreibungen für Organisation {tenant_id} — nicht gesetzte Schalter verwenden den Systemwert.",
+    "view_history": "Änderungsverlauf anzeigen →",
+    "audit_note": "Jede Umschaltung wird mit Akteur und vorherigem Wert im Änderungsprotokoll erfasst.",
+    "tenant_id_label": "Organisations-ID",
+    "tenant_id_placeholder": "z. B. acme",
+    "scope_system": "System",
+    "scope_custom": "Andere…",
+    "go": "Anzeigen",
+    "cancel": "Abbrechen"
+  },
+  "table": {
+    "name": "Name",
+    "description": "Beschreibung",
+    "system": "System",
+    "effective": "Wirksam",
+    "actions": "Aktionen",
+    "on": "ein",
+    "off": "aus",
+    "enabled": "Aktiviert",
+    "disabled": "Deaktiviert",
+    "overridden": "Überschreibung",
+    "following_default": "Standardwert gilt",
+    "following_system": "Systemwert gilt",
+    "clear_override": "Überschreibung entfernen"
+  },
+  "confirm": {
+    "enable_title": "„{name}“ aktivieren?",
+    "disable_title": "„{name}“ deaktivieren?",
+    "scope_system": "Dies ändert den Wert sofort für jede Organisation.",
+    "scope_tenant": "Dies setzt eine Überschreibung nur für die Organisation „{tenant_id}“. Andere Organisationen verwenden weiterhin den Systemwert.",
+    "enable_action": "Aktivieren",
+    "disable_action": "Deaktivieren",
+    "cancel": "Abbrechen"
+  },
+  "toasts": {
+    "enabled": "„{name}“ aktiviert",
+    "disabled": "„{name}“ deaktiviert",
+    "cleared": "Überschreibung für „{name}“ entfernt",
+    "toggle_failed": "Funktionsschalter konnte nicht aktualisiert werden"
+  },
+  "audit": {
+    "override": "Funktionsschalterüberschreibung"
+  },
+  "nav": {
+    "feature_flags": "Funktionsschalter"
+  },
+  "permission_group": "Feature-Flags"
+}

{simple_module_feature_flags-0.0.37 → simple_module_feature_flags-0.0.38}/feature_flags/locales/en.json

@@ -51,5 +51,6 @@
   },
   "nav": {
     "feature_flags": "Feature flags"
-  }
+  },
+  "permission_group": "Feature flags"
 }

{simple_module_feature_flags-0.0.37 → simple_module_feature_flags-0.0.38}/feature_flags/module.py

@@ -103,14 +103,11 @@ class FeatureFlagsModule(ModuleBase):
         from feature_flags.models import FeatureFlagOverride
 
         registry.register(
-            AuditLink(
-                # Class name, not __tablename__ — see AuditLink.entity_type.
-                # The table name travels alongside as the audit log's type tag.
-                entity_type=FeatureFlagOverride.__name__,
+            AuditLink.for_model(
+                FeatureFlagOverride,
                 url_template=f"{MENU_URL}?{QP_OVERRIDE}={{id}}",
                 label=AUDIT_LINK_LABEL,
                 label_key=AUDIT_LINK_LABEL_KEY,
-                table_name=FeatureFlagOverride.__tablename__,
                 label_resolver=_resolve_override_labels,
             )
         )
@@ -122,6 +119,7 @@ class FeatureFlagsModule(ModuleBase):
                 PERM_FEATURE_FLAGS_VIEW,
                 PERM_FEATURE_FLAGS_MANAGE,
             ],
+            label_key="feature_flags.permission_group",
         )
 
     def locale_dirs(self) -> dict[str, Path]:

{simple_module_feature_flags-0.0.37 → simple_module_feature_flags-0.0.38}/feature_flags/pages/Browse.tsx

@@ -1,4 +1,4 @@
-import { Head, router, usePage } from '@inertiajs/react';
+import { Head, router } from '@inertiajs/react';
 import { keys, useT } from '@simple-module-py/i18n';
 import { PageShell } from '@simple-module-py/ui/components/PageShell';
 import { usePermissions } from '@simple-module-py/ui/hooks/use-permissions';
@@ -32,9 +32,7 @@ function actionUrl(name: string, action: 'toggle' | 'clear', tenantId: string |
   return tenantId ? `${base}?tenant_id=${encodeURIComponent(tenantId)}` : base;
 }
 
-function Browse() {
-  const { flags, tenant_id, tenants, audit_log_url } = usePage<{ props: Props }>()
-    .props as unknown as Props;
+function Browse({ flags, tenant_id, tenants, audit_log_url }: Props) {
   const { t } = useT();
   const { can } = usePermissions();
   const canManage = can('feature_flags.manage');

{simple_module_feature_flags-0.0.37 → simple_module_feature_flags-0.0.38}/feature_flags/service.py

@@ -7,6 +7,8 @@ mirrors mutations into the registry.
 
 from __future__ import annotations
 
+from collections.abc import Callable
+
 from simple_module_core.feature_flags import FeatureFlagDefinition, FeatureFlagRegistry
 from sqlalchemy import select
 from sqlalchemy.ext.asyncio import AsyncSession
@@ -21,16 +23,25 @@ def _registry_tenant_id(scope: str, scope_id: str) -> str | None:
     return scope_id if scope == SCOPE_TENANT else None
 
 
+def _description(flag: FeatureFlagDefinition, translate: Callable[[str], str] | None) -> str:
+    # Translator.t() echoes an unknown key back; keep the literal in that case.
+    if not flag.description_key or translate is None:
+        return flag.description
+    translated = translate(flag.description_key)
+    return flag.description if translated == flag.description_key else translated
+
+
 def _build_view(
     flag: FeatureFlagDefinition,
     *,
     enabled: bool,
     overridden: bool,
     system_enabled: bool | None = None,
+    translate: Callable[[str], str] | None = None,
 ) -> FeatureFlagView:
     return FeatureFlagView(
         name=flag.name,
-        description=flag.description,
+        description=_description(flag, translate),
         default_enabled=flag.default_enabled,
         enabled=enabled,
         overridden=overridden,
@@ -73,7 +84,10 @@ class FeatureFlagService:
         return list(result.scalars())
 
     async def list_flags(
-        self, registry: FeatureFlagRegistry, tenant_id: str | None = None
+        self,
+        registry: FeatureFlagRegistry,
+        tenant_id: str | None = None,
+        translate: Callable[[str], str] | None = None,
     ) -> list[FeatureFlagView]:
         """Join registered definitions with persisted overrides for admin display.
 
@@ -95,7 +109,12 @@ class FeatureFlagService:
             system_enabled = system_value if system_value is not None else flag.default_enabled
             if tenant_id is None:
                 views.append(
-                    _build_view(flag, enabled=system_enabled, overridden=system_value is not None)
+                    _build_view(
+                        flag,
+                        enabled=system_enabled,
+                        overridden=system_value is not None,
+                        translate=translate,
+                    )
                 )
                 continue
             tenant_value = registry.tenant_override(flag.name, tenant_id)
@@ -105,6 +124,7 @@ class FeatureFlagService:
                     enabled=tenant_value if tenant_value is not None else system_enabled,
                     overridden=tenant_value is not None,
                     system_enabled=system_enabled,
+                    translate=translate,
                 )
             )
         return views
@@ -131,9 +151,9 @@ class FeatureFlagService:
     async def _find(self, scope: str, scope_id: str, name: str) -> FeatureFlagOverride | None:
         result = await self.db.execute(
             select(FeatureFlagOverride).where(
-                FeatureFlagOverride.scope == scope,
-                FeatureFlagOverride.scope_id == scope_id,
-                FeatureFlagOverride.name == name,
+                FeatureFlagOverride.scope == scope,  # ty: ignore[invalid-argument-type]
+                FeatureFlagOverride.scope_id == scope_id,  # ty: ignore[invalid-argument-type]
+                FeatureFlagOverride.name == name,  # ty: ignore[invalid-argument-type]
             )
         )
         return result.scalar_one_or_none()

{simple_module_feature_flags-0.0.37 → simple_module_feature_flags-0.0.38}/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simple-module-py/feature_flags",
-  "version": "0.1.0",
+  "version": "0.0.38",
   "private": true,
   "description": "Frontend assets for the FeatureFlags module",
   "peerDependencies": {

{simple_module_feature_flags-0.0.37 → simple_module_feature_flags-0.0.38}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "simple_module_feature_flags"
-version = "0.0.37"
+version = "0.0.38"
 description = "Simple feature-flag module with per-tenant overrides and a consumer API for simple_module"
 readme = "README.md"
 license = "MIT"
@@ -21,9 +21,9 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "simple_module_core==0.0.37",
-    "simple_module_db==0.0.37",
-    "simple_module_hosting==0.0.37",
+    "simple_module_core==0.0.38",
+    "simple_module_db==0.0.38",
+    "simple_module_hosting==0.0.38",
 ]
 
 [project.entry-points.simple_module]

simple_module_feature_flags-0.0.38/tests/test_flag_description_i18n.py

@@ -0,0 +1,38 @@
+"""Feature flag descriptions are translated server-side (TEST-016)."""
+
+from __future__ import annotations
+
+from feature_flags.service import FeatureFlagService
+from simple_module_core.feature_flags import FeatureFlagDefinition, FeatureFlagRegistry
+from simple_module_core.i18n import Translator
+
+PUBLIC_UPLOADS = "file_storage.public_uploads"
+
+
+def _translator(app, locale: str) -> Translator:
+    registry = app.state.sm.i18n_registry
+    if locale not in registry.supported_locales:  # test hosts default to ["en"]
+        registry.supported_locales = [*registry.supported_locales, locale]
+        registry.load()
+    return Translator(registry, locale=locale, default_locale="en")
+
+
+async def _description(app, db_session, locale: str) -> str:
+    svc = FeatureFlagService(db_session)
+    views = await svc.list_flags(app.state.sm.feature_flags, translate=_translator(app, locale).t)
+    return next(v.description for v in views if v.name == PUBLIC_UPLOADS)
+
+
+async def test_description_follows_the_locale(app, db_session):
+    english = await _description(app, db_session, "en")
+    german = await _description(app, db_session, "de")
+    assert english == "Allow unauthenticated uploads (future)."
+    assert german != english
+    assert "Uploads" in german
+
+
+async def test_unresolved_key_keeps_the_literal(db_session):
+    reg = FeatureFlagRegistry()
+    reg.add(FeatureFlagDefinition(name="x", description="Literal", description_key="nope.key"))
+    views = await FeatureFlagService(db_session).list_flags(reg, translate=lambda k: k)
+    assert views[0].description == "Literal"

simple_module_feature_flags-0.0.38/tests-js/feature_flags_Browse.test.tsx

@@ -0,0 +1,195 @@
+import { configureI18n, keys } from '@simple-module-py/i18n';
+import { cleanup, fireEvent, render, screen, waitFor } from '@testing-library/react';
+import type { ComponentProps } from 'react';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+
+configureI18n({ locale: 'en', messages: {} });
+
+const state = vi.hoisted(() => ({ props: {} as Record<string, unknown> }));
+const post = vi.hoisted(() => vi.fn());
+const visit = vi.hoisted(() => vi.fn());
+
+vi.mock('@inertiajs/react', () => ({
+  Head: () => null,
+  Link: ({ children, href }: { children: React.ReactNode; href: string }) => (
+    <a href={href}>{children}</a>
+  ),
+  router: { post, visit },
+  usePage: () => ({ props: state.props }),
+}));
+vi.mock('sonner', () => ({ toast: { success: vi.fn(), error: vi.fn() } }));
+
+import { toast } from 'sonner';
+import Browse from '../feature_flags/pages/Browse';
+import type { FeatureFlag } from '../feature_flags/pages/types';
+
+const FLAGS: FeatureFlag[] = [
+  {
+    name: 'beta_search',
+    description: 'New search',
+    default_enabled: false,
+    enabled: false,
+    overridden: false,
+    system_enabled: null,
+  },
+  {
+    name: 'dark_mode',
+    description: 'Dark theme',
+    default_enabled: false,
+    enabled: true,
+    overridden: true,
+    system_enabled: null,
+  },
+];
+
+function setProps(over: Record<string, unknown> = {}, permissions = ['feature_flags.manage']) {
+  state.props = {
+    flags: FLAGS,
+    tenant_id: null,
+    tenants: ['acme'],
+    audit_log_url: null,
+    auth: { permissions },
+    ...over,
+  };
+}
+
+type PostOptions = { onSuccess: () => void; onError: () => void; preserveScroll: boolean };
+
+const confirm = keys.feature_flags.confirm;
+const table = keys.feature_flags.table;
+const browse = keys.feature_flags.browse;
+
+describe('feature_flags Browse', () => {
+  beforeEach(() => setProps());
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it('renders every flag with its description and override badge', () => {
+    render(<Browse {...(state.props as ComponentProps<typeof Browse>)} />);
+    expect(screen.getByText('beta_search')).toBeInTheDocument();
+    expect(screen.getByText('dark_mode')).toBeInTheDocument();
+    expect(screen.getByText('Dark theme')).toBeInTheDocument();
+    expect(screen.getAllByText(table.overridden)).toHaveLength(1);
+  });
+
+  it('shows the empty state when no module registers flags', () => {
+    setProps({ flags: [] });
+    render(<Browse {...(state.props as ComponentProps<typeof Browse>)} />);
+    expect(screen.getByText(browse.empty_title)).toBeInTheDocument();
+  });
+
+  it('links to the audit history only when an audit log is installed', () => {
+    const { unmount } = render(<Browse {...(state.props as ComponentProps<typeof Browse>)} />);
+    expect(screen.queryByText(browse.view_history)).toBeNull();
+    unmount();
+    setProps({ audit_log_url: '/admin/audit?x=1' });
+    render(<Browse {...(state.props as ComponentProps<typeof Browse>)} />);
+    expect(screen.getByText(browse.view_history)).toHaveAttribute('href', '/admin/audit?x=1');
+  });
+
+  it('makes the switches read-only without the manage permission', () => {
+    setProps({}, []);
+    render(<Browse {...(state.props as ComponentProps<typeof Browse>)} />);
+    expect(screen.getByRole('switch', { name: 'beta_search' })).toBeDisabled();
+    expect(screen.queryByText(table.clear_override)).toBeNull();
+  });
+
+  it('stages a toggle behind a confirm and writes nothing until confirmed', async () => {
+    render(<Browse {...(state.props as ComponentProps<typeof Browse>)} />);
+    fireEvent.click(screen.getByRole('switch', { name: 'beta_search' }));
+    expect(await screen.findByText(confirm.scope_system)).toBeInTheDocument();
+    expect(post).not.toHaveBeenCalled();
+  });
+
+  it('cancelling the confirm leaves the flag and the server untouched', async () => {
+    render(<Browse {...(state.props as ComponentProps<typeof Browse>)} />);
+    fireEvent.click(screen.getByRole('switch', { name: 'beta_search' }));
+    fireEvent.click(await screen.findByRole('button', { name: confirm.cancel }));
+    await waitFor(() => expect(screen.queryByText(confirm.scope_system)).toBeNull());
+    expect(post).not.toHaveBeenCalled();
+    expect(screen.getByRole('switch', { name: 'beta_search' })).not.toBeChecked();
+  });
+
+  it('enables a flag on confirm, posting enabled=true to the system scope', async () => {
+    render(<Browse {...(state.props as ComponentProps<typeof Browse>)} />);
+    fireEvent.click(screen.getByRole('switch', { name: 'beta_search' }));
+    fireEvent.click(await screen.findByRole('button', { name: confirm.enable_action }));
+
+    expect(post).toHaveBeenCalledTimes(1);
+    const [url, data, options] = post.mock.calls[0] as [string, unknown, PostOptions];
+    expect(url).toBe('/admin/feature-flags/beta_search/toggle');
+    expect(data).toEqual({ enabled: true });
+    expect(options.preserveScroll).toBe(true);
+    options.onSuccess();
+    expect(toast.success).toHaveBeenCalledWith(keys.feature_flags.toasts.enabled);
+  });
+
+  it('disables a flag on confirm and toasts a failure from the server', async () => {
+    render(<Browse {...(state.props as ComponentProps<typeof Browse>)} />);
+    fireEvent.click(screen.getByRole('switch', { name: 'dark_mode' }));
+    fireEvent.click(await screen.findByRole('button', { name: confirm.disable_action }));
+
+    const [, data, options] = post.mock.calls[0] as [string, unknown, PostOptions];
+    expect(data).toEqual({ enabled: false });
+    options.onSuccess();
+    expect(toast.success).toHaveBeenCalledWith(keys.feature_flags.toasts.disabled);
+    options.onError();
+    expect(toast.error).toHaveBeenCalledWith(keys.feature_flags.toasts.toggle_failed);
+  });
+
+  it('scopes the toggle URL and the confirm text to the viewed tenant', async () => {
+    setProps({ tenant_id: 'acme corp' });
+    render(<Browse {...(state.props as ComponentProps<typeof Browse>)} />);
+    fireEvent.click(screen.getByRole('switch', { name: 'beta_search' }));
+    expect(await screen.findByText(confirm.scope_tenant)).toBeInTheDocument();
+    fireEvent.click(screen.getByRole('button', { name: confirm.enable_action }));
+    expect(post.mock.calls[0][0]).toBe(
+      '/admin/feature-flags/beta_search/toggle?tenant_id=acme%20corp',
+    );
+  });
+
+  it('clears an override without a confirm and reports the result', () => {
+    render(<Browse {...(state.props as ComponentProps<typeof Browse>)} />);
+    fireEvent.click(screen.getAllByText(table.clear_override)[0]);
+    const [url, data, options] = post.mock.calls[0] as [string, unknown, PostOptions];
+    expect(url).toBe('/admin/feature-flags/dark_mode/clear');
+    expect(data).toEqual({});
+    options.onSuccess();
+    expect(toast.success).toHaveBeenCalledWith(keys.feature_flags.toasts.cleared);
+    options.onError();
+    expect(toast.error).toHaveBeenCalledWith(keys.feature_flags.toasts.toggle_failed);
+  });
+
+  it('explains which value a non-overridden flag follows', () => {
+    render(<Browse {...(state.props as ComponentProps<typeof Browse>)} />);
+    expect(screen.getAllByText(table.following_default).length).toBeGreaterThan(0);
+    cleanup();
+    setProps({ tenant_id: 'acme' });
+    render(<Browse {...(state.props as ComponentProps<typeof Browse>)} />);
+    expect(screen.getAllByText(table.following_system).length).toBeGreaterThan(0);
+  });
+
+  it('switches scope by visiting the tenant URL, or the system URL', () => {
+    render(<Browse {...(state.props as ComponentProps<typeof Browse>)} />);
+    fireEvent.click(screen.getByRole('radio', { name: 'acme' }));
+    expect(visit).toHaveBeenCalledWith('/admin/feature-flags/?tenant_id=acme');
+    cleanup();
+    setProps({ tenant_id: 'acme' });
+    render(<Browse {...(state.props as ComponentProps<typeof Browse>)} />);
+    fireEvent.click(screen.getByRole('radio', { name: browse.scope_system }));
+    expect(visit).toHaveBeenLastCalledWith('/admin/feature-flags/');
+  });
+
+  it('lets an operator name a tenant with no overrides yet', () => {
+    render(<Browse {...(state.props as ComponentProps<typeof Browse>)} />);
+    fireEvent.click(screen.getByRole('radio', { name: browse.scope_custom }));
+    const go = screen.getByRole('button', { name: browse.go });
+    expect(go).toBeDisabled();
+    fireEvent.change(screen.getByLabelText(browse.tenant_id_label), {
+      target: { value: '  new-co ' },
+    });
+    fireEvent.click(go);
+    expect(visit).toHaveBeenCalledWith('/admin/feature-flags/?tenant_id=new-co');
+  });
+});