feat: ✨ finish the implementation of activity logs

This commit is contained in:
Alexis Gousseau 2025-09-25 15:01:27 +02:00
parent 23eee78fc1
commit a17af28e35
No known key found for this signature in database
GPG key ID: 4A614CB3DBBA2406
19 changed files with 1087 additions and 382 deletions

View file

@ -63,8 +63,8 @@ class PageConfigController extends Controller
return Inertia::render('PageConfigs/Index', [
'pageConfigModels' => CommonResource::collection($pageConfigModels),
'search' => $search,
'searchFields' => $searchFields,
'search' => $search,
'searchFields' => $searchFields,
]);
}

View file

@ -55,6 +55,9 @@ class HandleInertiaRequests extends Middleware
'auth' => [
'user' => $request->user(),
'policies' => [
'activityLogs' => [
'viewAny' => Gate::allows('viewAny', User::class),
],
'users' => [
'viewAny' => Gate::allows('viewAny', User::class),
'create' => Gate::allows('create', User::class),

View file

@ -20,9 +20,8 @@
"mcamara/laravel-localization": "^2.3.0",
"spatie/laravel-translatable": "^6.11",
"tightenco/ziggy": "^2.5",
"uwil/laravel-activity-logs": "^3.0",
"uwil/laravel-backend": "^3.0",
"uwil/laravel-common": "^4.0"
"uwil/laravel-common": "^4.1.1"
},
"require-dev": {
"fakerphp/faker": "^1.23",

1015
composer.lock generated

File diff suppressed because it is too large Load diff

17
lang/en/activity-logs.php Normal file
View file

@ -0,0 +1,17 @@
<?php
return [
"user_in_console" => "User in console",
"user_anonym" => "Anonymous user",
"user_deleted" => "Deleted user",
"access_model" => "Access data of the :model",
"event_not_match" => "No event matches",
"get_data_message" => "Data created on:",
"no_changes" => "No changes recorded",
"attributes" => [
"modifications" => "modifications",
"event" => "event",
"model_class" => "targeted model",
"user_id" => "action author",
],
];

View file

@ -2,8 +2,9 @@
return [
"classes" => [
"user" => "user",
"user" => "user",
"dynamic-page" => "dynamic page|dynamic pages",
"page-config" => "page configuration|page configurations",
]
"page-config" => "page configuration|page configurations",
"activity-log" => "activity log",
],
];

17
lang/fr/activity-logs.php Normal file
View file

@ -0,0 +1,17 @@
<?php
return [
"user_in_console" => "Utilisateur dans la console",
"user_anonym" => "Utilisateur anonyme",
"user_deleted" => "Utilisateur supprimé",
"access_model" => "Accéder aux données :model",
"event_not_match" => "Aucun évènement ne correspond",
"get_data_message" => "Données créées le:",
"no_changes" => "Aucun changement enregistré",
"attributes" => [
"modifications" => "modifications",
"event" => "évènement",
"model_class" => "modèle ciblé",
"user_id" => "auteur de l'action",
],
];

View file

@ -2,8 +2,9 @@
return [
"classes" => [
"user" => "utilisateur",
"user" => "utilisateur",
"dynamic-page" => "page dynamique|pages dynamiques",
"page-config" => "configuration de page|configurations de page",
]
"page-config" => "configuration de page|configurations de page",
"activity-log" => "journal d'activité",
],
];

View file

@ -141,6 +141,7 @@ export default function SimpleWysiwyg({
{wordCounter && <WordCounter value={content.replace(/<[^>]*>/g, "")} />}
<div className="my-1.5">
<RichTextEditor
// Force re-render.
key={version}
output="html"
content={content}

View file

@ -10,6 +10,7 @@ import {
Telescope,
StickyNote,
Cog,
History,
} from "lucide-react";
import { route } from "ziggy-js";
// * Components shadcn
@ -160,6 +161,12 @@ export default function AppSidebar() {
show: authPolicies.users.viewAny,
actions: (model: string) => filterActions({ model }),
},
{
title: str(useTrans("models.classes.activity-log")).ucFirst().plural().value(),
model: "activity-logs",
icon: History,
show: authPolicies.activityLogs.viewAny,
},
{
title: useTrans("back.telescope"),
link: route("telescope"),

View file

@ -64,7 +64,8 @@ export default function DataTable<TData, TValue>({
: flexRender(
header.column.columnDef.header,
header.getContext(),
)}
)
}
</TableHead>
);
})}

View file

@ -0,0 +1,145 @@
// * Packages
import { FileText, User } from "lucide-react";
import { route } from "ziggy-js";
// * Components shadcn
import { Badge } from "@/components/ui/badge";
// * Other
import AuthenticatedLayout from "@/back/Layouts/AuthenticatedLayout";
import DataTable from "@/back/Components/Table/DataTable";
import DataTableSearch from "@/back/Components/Table/DataTableSearch";
import DataTableFilterButton from "@/back/Components/Table/DataTableFilterButton";
import BtnOptionnalLinkWithTooltip from "@/back/Components/BtnOptionnalLinkWithTooltip";
import { Views } from "@/lib/utils";
import { ActivityLogModel, Resource } from "@/back/types/global";
import str from "@/hooks/use-string";
import useTrans from "@/hooks/use-translations";
import { useFormatedDate } from "@/hooks/use-formated-value";
type ActivityLogsIndexProps = {
activitylogModels: Resource;
search: string;
searchFields: string;
activityLogsEventEnum: Record<
string,
{ value: number; name: string; label: string; tailwindclass: string }
>;
};
export default function Index({
activitylogModels,
search,
searchFields,
activityLogsEventEnum,
}: ActivityLogsIndexProps) {
const actionModels = [Views.VISUALIZATION];
const columns = [
{
accessorKey: "event",
header: ({ column }: { column: { id: string } }) => (
<DataTableFilterButton
label={str(useTrans(`activity-logs.attributes.${column.id}`)).ucFirst().value()}
field={column.id}
/>
),
cell: ({ row }: { row: { original: ActivityLogModel; getValue: Function } }) => {
const currentEvent = Object.values(
activityLogsEventEnum
).filter((index) => index.value === row.getValue("event"));
const bgClass = `bg-${currentEvent[0].tailwindclass}`;
const hoverClass = `hover:bg-${currentEvent[0].tailwindclass}/90`;
const textClass = `text-${currentEvent[0].tailwindclass}-foreground`;
return currentEvent[0] ? (
<Badge className={`${textClass} ${bgClass} ${hoverClass}`}>
{str(useTrans(currentEvent[0].label)).ucFirst().value()}
</Badge>
) : (
useTrans("activity-logs.event_not_match")
);
},
},
{
accessorKey: "user_id",
header: ({ column }: { column: { id: string } }) => (
<DataTableFilterButton
label={str(useTrans(`activity-logs.attributes.${column.id}`)).ucFirst().value()}
field={column.id}
/>
),
cell: ({ row }: { row: { original: ActivityLogModel; getValue: Function } }) => {
if (row.original.user)
return (
<BtnOptionnalLinkWithTooltip
link={route("back.users.show", { user: row.original.user_id })}
content={<>
<User />
{`${row.original.user.first_name} ${row.original.user.last_name}`}
</>}
tooltipContent={<p>{useTrans("activity-logs.access_model", { params: { model: useTrans('models.classes.user') }})}</p>}
size="sm"
/>
);
else if (row.original.is_console)
return useTrans("activity-logs.user_in_console");
else if (row.original.is_anonymous)
return useTrans("activity-logs.user_anonym");
else return useTrans("activity-logs.user_deleted");
},
},
{
accessorKey: "model_class",
header: ({ column }: { column: { id: string } }) => (
<DataTableFilterButton
label={str(useTrans(`activity-logs.attributes.${column.id}`)).ucFirst().value()}
field={column.id}
/>
),
cell: ({ row }: { row: { getValue: Function, original: ActivityLogModel } }) => {
const modelSplit = row.getValue("model_class").split("\\");
const modelName = modelSplit[modelSplit.length - 1];
const model = str(modelName).kebabCase().value();
return row.original.event !== activityLogsEventEnum.deleted.value ? (
<BtnOptionnalLinkWithTooltip
link={route(`back.${str(model).plural().value()}.show`, row.original.model_id)}
content={<>
<FileText />
{row.getValue("model_class")}
</>}
tooltipContent={<p>{useTrans("activity-logs.access_model", { params: { model: useTrans(`activity-logs.attributes.model_class`) } })}</p>}
size="sm"
/>
) : <code>{row.getValue("model_class")}</code>
},
},
{
accessorKey: "created_at",
header: ({ column }: { column: { id: string } }) => (
<DataTableFilterButton
label={str(useTrans(`validation.attributes.${column.id}`)).ucFirst().value()}
field={column.id}
/>
),
cell: ({ row }: { row: { getValue: Function } }) => (
<Badge variant="secondary">
{useFormatedDate(row.getValue("created_at"))}
</Badge>
),
},
];
return (
<AuthenticatedLayout
title={str(useTrans("models.classes.activity-log")).ucFirst().plural().value()}
>
<DataTableSearch
modelRoute="activity-logs"
searchText={search}
searchFields={searchFields}
/>
<DataTable
columns={columns}
modelRoute="activity-logs"
modelsPaginate={activitylogModels}
actions={actionModels}
/>
</AuthenticatedLayout>
);
}

View file

@ -0,0 +1,157 @@
// * Packages
import { ArrowLeft, User } from "lucide-react";
import { usePage } from "@inertiajs/react";
import { route } from "ziggy-js";
// * Components shadcn
import { Badge } from "@/components/ui/badge";
// * Other
import AuthenticatedLayout from "@/back/Layouts/AuthenticatedLayout";
import DetailsTable from "@/back/Components/Table/DetailsTable";
import ModelActions from "@/back/Components/ModelActions";
import BtnOptionnalLinkWithTooltip from "@/back/Components/BtnOptionnalLinkWithTooltip";
import { ActivityLogModel, AuthProp, SingleResource } from "@/back/types/global";
import str from "@/hooks/use-string";
import { useFormatedDate } from "@/hooks/use-formated-value";
import useTrans from "@/hooks/use-translations";
type ActivityLogsShowProps = {
data: SingleResource;
activityLogsEventEnum: Record<
string,
{ value: number; name: string; label: string; tailwindclass: string }
>;
};
export default function Show({
data,
activityLogsEventEnum,
}: ActivityLogsShowProps) {
const { auth } = usePage().props as unknown as {
auth: AuthProp;
};
const viewAny = auth.policies.activityLogs.viewAny;
const activityLogModel = data.data as ActivityLogModel;
const columns = [
{
accessorKey: "event",
header: str(useTrans("activity-logs.attributes.event")).ucFirst().value(),
cell: ({ value }: { value: number }) => {
if (value) {
const currentEvent = Object.values(activityLogsEventEnum).filter((index) => index.value === value);
const bgClass = `bg-${currentEvent[0].tailwindclass}`;
const hoverClass = `hover:bg-${currentEvent[0].tailwindclass}/90`;
const textClass = `text-${currentEvent[0].tailwindclass}-foreground`;
return currentEvent[0] ? (
<Badge className={`${textClass} ${bgClass} ${hoverClass}`}>
{str(useTrans(currentEvent[0].label)).ucFirst().value()}
</Badge>
) : useTrans("activity-logs.event_not_match");
} else {
(
<span className="text-sm italic text-muted-foreground">
{useTrans("back.table_not_known")}
</span>
)
}
},
},
{
accessorKey: "user_id",
header: str(useTrans("activity-logs.attributes.user_id")).ucFirst().value(),
cell: ({ value }: { value: number }) => {
if (value && activityLogModel.user)
return (
<BtnOptionnalLinkWithTooltip
link={route("back.users.show", { user: value })}
content={<>
<User />
{`${activityLogModel.user.first_name} ${activityLogModel.user.last_name}`}
</>}
tooltipContent={<p>{useTrans("activity-logs.access_model", { params: { model: useTrans('models.classes.user') }})}</p>}
size="sm"
/>
);
else if (activityLogModel.is_console)
return useTrans("activity-logs.user_in_console");
else if (activityLogModel.is_anonymous)
return useTrans("activity-logs.user_anonym");
else return useTrans("activity-logs.user_deleted");
},
},
{
accessorKey: "model_class",
header: str(useTrans("activity-logs.attributes.model_class")).ucFirst().value(),
cell: ({ value }: { value: string }) => {
const modelSplit = value.split("\\");
const modelName = modelSplit[modelSplit.length - 1];
const model = str(modelName).kebabCase().plural().value();
return activityLogModel.event !== activityLogsEventEnum.deleted.value ? (
<BtnOptionnalLinkWithTooltip
link={route(`back.${model}.show`, activityLogModel.model_id)}
content={<>
<User />
{value}
</>}
tooltipContent={<p>{useTrans("activity-logs.access_model", { params: { model: useTrans('activity-logs.attributes.model_class') } })}</p>}
size="sm"
/>
) : <code>{value}</code>
},
},
{
accessorKey: "modifications",
header: str(useTrans("activity-logs.attributes.modifications")).ucFirst().value(),
cell: ({ value }: { value: Object }) => {
return value && Object.entries(value).length ? (
<ul className="list-disc ps-4">
{
Object.entries(value).map((value, index) => {
return (<li key={index}>{value[0]} <span className="text-muted-foreground">({value[1]})</span></li>);
})
}
</ul>
) : (
<span className="text-sm italic text-muted-foreground">
{useTrans("activity-logs.no_changes")}
</span>
)
},
},
{
accessorKey: "created_at",
header: str(useTrans("validation.attributes.created_at")).ucFirst().value(),
cell: ({ value }: { value: string }) => (
<Badge variant="secondary">{useFormatedDate(value)}</Badge>
),
},
];
const beforeNode = () => {
return viewAny && (
<div className="flex justify-end items-center gap-x-1.5">
<BtnOptionnalLinkWithTooltip
link={route("back.activity-logs.index")}
content={<ArrowLeft />}
tooltipContent={<p>{useTrans("back.crud_back_to_list")}</p>}
/>
</div>
);
};
return (
<AuthenticatedLayout
title={useTrans("crud.helpers.visualization_model", {
params: { model: useTrans("models.classes.activity-log") }
})}
beforeNode={beforeNode()}
>
<ModelActions
modelRoute="activity-logs"
model={activityLogModel}
modelUpdatedAt={activityLogModel.created_at.toString()}
message={useTrans("activity-logs.get_data_message")}
/>
<DetailsTable columns={columns} model={activityLogModel} forceRenderValue={true} />
</AuthenticatedLayout>
);
}

View file

@ -28,7 +28,7 @@ import {
import str from "@/hooks/use-string";
import useTrans from "@/hooks/use-translations";
export default function Dashboard({
export default function Index({
dynamicPageModels,
search,
searchFields,

View file

@ -150,6 +150,7 @@ export default function Form({
*/
const mustBeNotified = () => {
return !route().current(`back.page-configs.create`)
&& model?.pages
&& model?.pages.length
&& data.config !== model?.config[locale]
};

View file

@ -25,7 +25,7 @@ import useTrans from "@/hooks/use-translations";
import { Row } from "@tanstack/react-table";
import { AlertCircle, Archive, ArrowLeft, Plus } from "lucide-react";
export default function Dashboard({
export default function Index({
pageConfigModels,
search,
searchFields,

View file

@ -22,7 +22,7 @@ import {
import str from "@/hooks/use-string";
import useTrans from "@/hooks/use-translations";
export default function Dashboard({
export default function Index({
userModels,
search,
searchFields,

View file

@ -72,6 +72,19 @@ type UserModel = {
updated_at: Date;
};
// Activity log type, with policies.
type ActivityLogModel = {
model_class: string;
modifications: string | null;
user: UserModel | null;
user_id: number | null;
is_anonymous: boolean;
is_console: boolean;
model_id: number;
event: number;
created_at: Date;
};
// Dynamic Page type, with policies.
type DynamicPageModel = {
policies: ModelPolicy;
@ -113,15 +126,21 @@ type PageConfigModel = {
pages: DynamicPageModel[];
};
// Model can be either a user model or another object.
// Default model, with policies.
type DefaultModel = {
policies: ModelPolicy;
id: number;
created_at: Date;
updated_at: Date;
};
// All models types.
type Model =
| {
policies: ModelPolicy;
id: number;
created_at: Date;
updated_at: Date;
}
| UserModel;
| DefaultModel
| UserModel
| PageConfigModel
| DynamicPageModel
| ActivityLogModel;
// Common policy type.
type CommonPolicy = {

View file

@ -22,19 +22,19 @@ Breadcrumbs::for('back.users.index', function (Generator $trail) {
});
Breadcrumbs::for('back.users.create', function (Generator $trail) {
$trail->parent('back.users.index');
$trail->push(Str::ucfirst(trans('crud.actions.creation')), route('back.users.create'));
$trail->push(Str::ucfirst(trans('crud.actions.create')), route('back.users.create'));
});
Breadcrumbs::for('back.users.edit', function (Generator $trail) {
$trail->parent('back.users.index');
$trail->push(Str::ucfirst(trans('crud.actions.edition')), route('back.users.edit', request()->user));
$trail->push(Str::ucfirst(trans('crud.actions.edit')), route('back.users.edit', request()->user));
});
Breadcrumbs::for('back.users.duplicate', function (Generator $trail) {
$trail->parent('back.users.index');
$trail->push(Str::ucfirst(trans('crud.actions.duplication')));
$trail->push(Str::ucfirst(trans('crud.actions.duplicate')));
});
Breadcrumbs::for('back.users.show', function (Generator $trail) {
$trail->parent('back.users.index');
$trail->push(Str::ucfirst(trans('crud.actions.visualization')), route('back.users.show', request()->user));
$trail->push(Str::ucfirst(trans('crud.actions.visualize')), route('back.users.show', request()->user));
});
// * DYNAMIC PAGES.
@ -47,27 +47,27 @@ Breadcrumbs::for('back.dynamic-pages.index', function (Generator $trail) {
});
Breadcrumbs::for('back.dynamic-pages.create', function (Generator $trail) {
$trail->parent('back.dynamic-pages.index');
$trail->push(Str::ucfirst(trans('crud.actions.creation')), route('back.dynamic-pages.create'));
$trail->push(Str::ucfirst(trans('crud.actions.create')), route('back.dynamic-pages.create'));
});
Breadcrumbs::for('back.dynamic-pages.edit', function (Generator $trail) {
$trail->parent('back.dynamic-pages.index');
$trail->push(Str::ucfirst(trans('crud.actions.edition')), route('back.dynamic-pages.edit', [
$trail->push(Str::ucfirst(trans('crud.actions.edit')), route('back.dynamic-pages.edit', [
'dynamic_page' => request()->dynamic_page
]));
});
Breadcrumbs::for('back.dynamic-pages.duplicate', function (Generator $trail) {
$trail->parent('back.dynamic-pages.index');
$trail->push(Str::ucfirst(trans('crud.actions.duplication')));
$trail->push(Str::ucfirst(trans('crud.actions.duplicate')));
});
Breadcrumbs::for('back.dynamic-pages.show', function (Generator $trail) {
$trail->parent('back.dynamic-pages.index');
$trail->push(Str::ucfirst(trans('crud.actions.visualization')), route('back.dynamic-pages.show', [
$trail->push(Str::ucfirst(trans('crud.actions.visualize')), route('back.dynamic-pages.show', [
'dynamic_page' => request()->dynamic_page
]));
});
Breadcrumbs::for('back.dynamic-pages.trash', function (Generator $trail) {
$trail->parent('back.dynamic-pages.index');
$trail->push(Str::ucfirst(trans('crud.actions.archivation')));
$trail->push(Str::ucfirst(trans('crud.actions.archive')));
});
// * PAGE CONFIGURATIONS.
@ -80,25 +80,38 @@ Breadcrumbs::for('back.page-configs.index', function (Generator $trail) {
});
Breadcrumbs::for('back.page-configs.create', function (Generator $trail) {
$trail->parent('back.page-configs.index');
$trail->push(Str::ucfirst(trans('crud.actions.creation')), route('back.page-configs.create'));
$trail->push(Str::ucfirst(trans('crud.actions.create')), route('back.page-configs.create'));
});
Breadcrumbs::for('back.page-configs.edit', function (Generator $trail) {
$trail->parent('back.page-configs.index');
$trail->push(Str::ucfirst(trans('crud.actions.edition')), route('back.page-configs.edit', [
$trail->push(Str::ucfirst(trans('crud.actions.edit')), route('back.page-configs.edit', [
'page_config' => request()->page_config
]));
});
Breadcrumbs::for('back.page-configs.duplicate', function (Generator $trail) {
$trail->parent('back.page-configs.index');
$trail->push(Str::ucfirst(trans('crud.actions.duplication')));
$trail->push(Str::ucfirst(trans('crud.actions.duplicate')));
});
Breadcrumbs::for('back.page-configs.show', function (Generator $trail) {
$trail->parent('back.page-configs.index');
$trail->push(Str::ucfirst(trans('crud.actions.visualization')), route('back.page-configs.show', [
$trail->push(Str::ucfirst(trans('crud.actions.visualize')), route('back.page-configs.show', [
'page_config' => request()->page_config
]));
});
Breadcrumbs::for('back.page-configs.trash', function (Generator $trail) {
$trail->parent('back.page-configs.index');
$trail->push(Str::ucfirst(trans('crud.actions.archivation')));
$trail->push(Str::ucfirst(trans('crud.actions.archive')));
});
// * ACTIVITY LOGS
Breadcrumbs::for('back.activity-logs.index', function (Generator $trail) {
$trail->parent('back.dashboard.index');
$trail->push(
Str::of(trans('models.classes.activity-log'))->ucfirst()->plural(),
route('back.activity-logs.index')
);
});
Breadcrumbs::for('back.activity-logs.show', function (Generator $trail) {
$trail->parent('back.activity-logs.index');
$trail->push(Str::ucfirst(trans('crud.actions.visualize')));
});