[Feature] Changelog / Edit History (#13069)

* Initial app scaffolding

* Skeleton for AuditLogTable

* Add UI table

* Add audit history panel to admin center

* Add auditing for models in the 'company' app

* Gate API access of user staff status

* Display item history in UI

* Track 'attachment' history

* Track 'parameter' changes

* Audit support for "common" models

* Track changed for "build" models

* Track history for "order" models:

- PurchaseOrder
- SalesOrder
- SalesOrderShipment
- ReturnOrder

Also track changes against LineItem and ExtraLineItem objects

* Register custom admin class

* Support Part history

* BomItem changes

* Fix for BulkCreateMixin

* Tweak unit tests

* Use Viewset

* Adjust error code behavior

* Setting to keep summary entries

* Refactor helper for middlewares

* Tweak unit tests

* Fixes for ModelInformationDict

* Track pricing changes

* Add model type filter for auditlog table

* Specify filter field type

* Hide HistoryPanel if auding is disabled

* add docs

* Add "--summary" option to export_records task

* Playwright tests

* Track task responsible for data changes

* Updated unit tests

* record changes to global settings

* Update docs

* Ensure values are stringified

* Fix for globalsetting

* Patch unit test

* Tweak playwright tests

* playwright test fix

* use main branch for demo data

* Update CHANGELOG
This commit is contained in:
Oliver authored and GitHub committed 2026-10-25 12:36:13 +11:00
1 parent cdb3b1ecf7
commit c475e9bfcf
91 files changed
+7753 -102

No files matched your search

+1
View File
@@ -253,6 +253,7 @@ export enum ApiEndpoints {
// Miscellaneous API endpoints
attachment_list = 'attachment/',
audit_log_list = 'audit/',
instance_info = 'instance-info/',
error_report_list = 'error-report/',
project_code_list = 'project-code/',
@@ -83,7 +83,6 @@ export const ModelInformationDict: ModelDict = {
parttesttemplate: {
label: () => t`Part Test Template`,
label_multiple: () => t`Part Test Templates`,
url_detail: '/parttesttemplate/:pk/',
api_endpoint: ApiEndpoints.part_test_template_list,
icon: 'test'
},
@@ -170,7 +169,6 @@ export const ModelInformationDict: ModelDict = {
label: () => t`Build Line`,
label_multiple: () => t`Build Lines`,
url_overview: '/build/line',
url_detail: '/build/line/:pk/',
api_endpoint: ApiEndpoints.build_line_list,
icon: 'build_order'
},
@@ -191,7 +189,6 @@ export const ModelInformationDict: ModelDict = {
projectcode: {
label: () => t`Project Code`,
label_multiple: () => t`Project Codes`,
url_detail: '/project-code/:pk/',
api_endpoint: ApiEndpoints.project_code_list,
icon: 'list_details'
},
@@ -270,21 +267,18 @@ export const ModelInformationDict: ModelDict = {
address: {
label: () => t`Address`,
label_multiple: () => t`Addresses`,
url_detail: '/address/:pk/',
api_endpoint: ApiEndpoints.address_list,
icon: 'address'
},
contact: {
label: () => t`Contact`,
label_multiple: () => t`Contacts`,
url_detail: '/contact/:pk/',
api_endpoint: ApiEndpoints.contact_list,
icon: 'group'
},
owner: {
label: () => t`Owner`,
label_multiple: () => t`Owners`,
url_detail: '/owner/:pk/',
api_endpoint: ApiEndpoints.owner_list,
icon: 'group'
},
@@ -307,7 +301,6 @@ export const ModelInformationDict: ModelDict = {
label: () => t`Import Session`,
label_multiple: () => t`Import Sessions`,
url_overview: '/settings/admin/import',
url_detail: '/import/:pk/',
api_endpoint: ApiEndpoints.import_session_list,
icon: 'import'
},
@@ -0,0 +1,60 @@
import { t } from '@lingui/core/macro';
import { Skeleton } from '@mantine/core';
import { IconHistory } from '@tabler/icons-react';
import { useMemo } from 'react';
import type { ModelType } from '@lib/enums/ModelType';
import type { PanelType } from '@lib/types/Panel';
import {
useGlobalSettingsState,
useUserSettingsState
} from '../../states/SettingsStates';
import { useUserState } from '../../states/UserState';
import { AuditLogTable } from '../../tables/general/AuditLogTable';
/**
* Determine whether the history panel should be displayed on detail pages:
* - Only available to staff users
* - Must be enabled via the 'DISPLAY_HISTORY_TAB' user setting
*/
export function useShowHistoryPanel(): boolean {
const user = useUserState();
const userSettings = useUserSettingsState();
const globalSettings = useGlobalSettingsState();
return useMemo(
() =>
user.isStaff() &&
globalSettings.isSet('AUDIT_LOG_ENABLED') &&
userSettings.isSet('DISPLAY_HISTORY_TAB', false),
[user, userSettings, globalSettings]
);
}
/**
* Panel displaying the audit log (change history) for a model instance.
* Only add this panel to detail pages for models which are audited,
* and pass the result of useShowHistoryPanel() as 'visible'.
*/
export default function HistoryPanel({
model_type,
model_id,
visible
}: {
model_type: ModelType;
model_id: number | undefined;
visible: boolean;
}): PanelType {
return {
name: 'history',
label: t`History`,
icon: <IconHistory />,
hidden: !visible,
content:
visible && model_type && model_id ? (
<AuditLogTable modelType={model_type} modelId={model_id} />
) : (
<Skeleton />
)
};
}
+3 -1
View File
@@ -15,13 +15,15 @@ type UseFilterProps = {
params?: any;
accessor?: string;
transform: (item: any) => TableFilterChoice;
// Set to false to skip fetching the filter choices (default = true)
enabled?: boolean;
};
export function useFilters(props: UseFilterProps) {
const api = useApi();
const query = useQuery({
enabled: true,
enabled: props.enabled ?? true,
gcTime: 500,
queryKey: [props.url, props.method, props.params],
queryFn: async () => {
@@ -0,0 +1,51 @@
import { t } from '@lingui/core/macro';
import { Accordion, Alert, Stack } from '@mantine/core';
import { IconInfoCircle } from '@tabler/icons-react';
import { StylishText } from '@lib/components/StylishText';
import { GlobalSettingList } from '../../../../components/settings/SettingList';
import { useGlobalSettingsState } from '../../../../states/SettingsStates';
import { AuditLogTable } from '../../../../tables/general/AuditLogTable';
export default function AuditLogManagementPanel() {
const globalSettings = useGlobalSettingsState();
return (
<Stack gap='xs'>
{!globalSettings.isSet('AUDIT_LOG_ENABLED', true) && (
<Alert
color='yellow'
icon={<IconInfoCircle />}
title={t`Audit Log Disabled`}
>
{t`Changes are not currently being recorded in the audit log`}
</Alert>
)}
<Accordion multiple defaultValue={['auditlog']}>
<Accordion.Item value='auditlog'>
<Accordion.Control>
<StylishText size='lg'>{t`Audit Log`}</StylishText>
</Accordion.Control>
<Accordion.Panel>
<AuditLogTable />
</Accordion.Panel>
</Accordion.Item>
<Accordion.Item value='settings'>
<Accordion.Control>
<StylishText size='lg'>{t`Audit Log Settings`}</StylishText>
</Accordion.Control>
<Accordion.Panel>
<GlobalSettingList
keys={[
'AUDIT_LOG_ENABLED',
'AUDIT_LOG_DELETE_OLD_ENTRIES',
'AUDIT_LOG_DELETE_DAYS',
'AUDIT_LOG_DELETE_KEEP_SUMMARY'
]}
/>
</Accordion.Panel>
</Accordion.Item>
</Accordion>
</Stack>
);
}
@@ -11,6 +11,7 @@ import {
IconExclamationCircle,
IconFileCode,
IconFileDownload,
IconFileSearch,
IconFileUpload,
IconHome,
IconList,
@@ -82,6 +83,10 @@ const IdentityManagementPanel = Loadable(
lazy(() => import('./IdentityManagementPanel'))
);
const AuditLogManagementPanel = Loadable(
lazy(() => import('./AuditLogManagementPanel'))
);
const ErrorReportTable = Loadable(
lazy(() => import('../../../../tables/settings/ErrorTable'))
);
@@ -178,6 +183,12 @@ export default function AdminCenter() {
icon: <IconExclamationCircle />,
content: <ErrorReportTable />
},
{
name: 'audit-log',
label: t`Audit Log`,
icon: <IconFileSearch />,
content: <AuditLogManagementPanel />
},
{
name: 'companies',
label: t`Companies`,
@@ -312,6 +323,7 @@ export default function AdminCenter() {
'barcode-history',
'background',
'errors',
'audit-log',
'companies',
'currencies',
'email'
@@ -62,6 +62,7 @@ export default function UserSettings() {
'DATE_DISPLAY_FORMAT',
'FORMS_CLOSE_USING_ESCAPE',
'DISPLAY_STOCKTAKE_TAB',
'DISPLAY_HISTORY_TAB',
'ENABLE_LAST_BREADCRUMB',
'NAVIGATION_TREE_PINNED',
'SHOW_EXTRA_MODEL_INFO',
+12 -1
View File
@@ -38,6 +38,9 @@ import {
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
@@ -237,6 +240,8 @@ export default function BuildDetail() {
modelId: build?.pk
});
const showHistory = useShowHistoryPanel();
const buildPanels: PanelType[] = useMemo(() => {
return [
{
@@ -375,6 +380,11 @@ export default function BuildDetail() {
model_type: ModelType.build,
model_id: build.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.build,
model_id: build.pk,
visible: showHistory
})
];
}, [
@@ -388,7 +398,8 @@ export default function BuildDetail() {
showChildBuilds,
buildLineQuery.isFetching,
buildLineQuery.isLoading,
buildLineData
buildLineData,
showHistory
]);
const editBuildOrderFields = useBuildOrderFields({
@@ -31,6 +31,9 @@ import type { Breadcrumb } from '../../components/nav/BreadcrumbList';
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
@@ -96,6 +99,8 @@ export default function CompanyDetail(props: Readonly<CompanyDetailProps>) {
/>
);
const showHistory = useShowHistoryPanel();
const companyPanels: PanelType[] = useMemo(() => {
return [
{
@@ -211,9 +216,14 @@ export default function CompanyDetail(props: Readonly<CompanyDetailProps>) {
model_type: ModelType.company,
model_id: company.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.company,
model_id: company.pk,
visible: showHistory
})
];
}, [id, company, user, instanceInfo]);
}, [id, company, user, instanceInfo, showHistory]);
const editCompany = useEditApiFormModal({
url: ApiEndpoints.company_list,
@@ -23,6 +23,9 @@ import {
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
@@ -64,6 +67,8 @@ export default function ManufacturerPartDetail() {
modelId: manufacturerPart?.pk
});
const showHistory = useShowHistoryPanel();
const panels: PanelType[] = useMemo(() => {
return [
{
@@ -120,9 +125,14 @@ export default function ManufacturerPartDetail() {
model_type: ModelType.manufacturerpart,
model_id: manufacturerPart?.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.manufacturerpart,
model_id: manufacturerPart?.pk,
visible: showHistory
})
];
}, [user, manufacturerPart, instanceInfo]);
}, [user, manufacturerPart, instanceInfo, showHistory]);
const editManufacturerPartFields = useManufacturerPartFields();
@@ -27,6 +27,9 @@ import {
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
@@ -72,6 +75,8 @@ export default function SupplierPartDetail() {
modelId: supplierPart?.pk
});
const showHistory = useShowHistoryPanel();
const panels: PanelType[] = useMemo(() => {
return [
{
@@ -137,9 +142,14 @@ export default function SupplierPartDetail() {
model_type: ModelType.supplierpart,
model_id: supplierPart?.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.supplierpart,
model_id: supplierPart?.pk,
visible: showHistory
})
];
}, [supplierPart, instanceInfo]);
}, [supplierPart, instanceInfo, showHistory]);
const supplierPartActions = useMemo(() => {
return [
+13 -2
View File
@@ -30,6 +30,9 @@ import { ApiIcon } from '../../components/items/ApiIcon';
import InstanceDetail from '../../components/nav/InstanceDetail';
import NavigationTree from '../../components/nav/NavigationTree';
import { PageDetail } from '../../components/nav/PageDetail';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
import SegmentedControlPanel from '../../components/panels/SegmentedControlPanel';
@@ -198,6 +201,8 @@ export default function CategoryDetail() {
defaultValue: 'table'
});
const showHistory = useShowHistoryPanel();
const panels: PanelType[] = useMemo(
() => [
{
@@ -269,9 +274,15 @@ export default function CategoryDetail() {
icon: <IconListCheck />,
hidden: !id || !category.pk,
content: <PartCategoryTemplateTable categoryId={category?.pk} />
}
},
HistoryPanel({
model_type: ModelType.partcategory,
model_id: category?.pk,
// Not shown for the top-level (root) category view
visible: showHistory && !!id && !!category?.pk
})
],
[category, id, partsView, instanceInfo]
[category, id, partsView, instanceInfo, showHistory]
);
const breadcrumbs = useMemo(
+12 -1
View File
@@ -64,6 +64,9 @@ import InstanceDetail from '../../components/nav/InstanceDetail';
import NavigationTree from '../../components/nav/NavigationTree';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import { RenderPart } from '../../components/render/Part';
@@ -284,6 +287,8 @@ export default function PartDetail() {
}, [enableRevisionSelection, part, partRevisionOptions]);
// Part data panels (recalculate when part data changes)
const showHistory = useShowHistoryPanel();
const partPanels: PanelType[] = useMemo(() => {
return [
{
@@ -518,6 +523,11 @@ export default function PartDetail() {
model_type: ModelType.part,
model_id: part?.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.part,
model_id: part?.pk,
visible: showHistory
})
];
}, [
@@ -529,7 +539,8 @@ export default function PartDetail() {
bomInformation,
revisionSelector,
refreshInstance,
instanceInfo
instanceInfo,
showHistory
]);
const breadcrumbs = useMemo(() => {
@@ -24,6 +24,9 @@ import {
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
@@ -133,6 +136,8 @@ export default function PurchaseOrderDetail() {
modelType: ModelType.purchaseorder
});
const showHistory = useShowHistoryPanel();
const orderPanels: PanelType[] = useMemo(() => {
return [
{
@@ -223,9 +228,14 @@ export default function PurchaseOrderDetail() {
!globalSettings.isSet('PURCHASEORDER_EDIT_COMPLETED_ORDERS')
? false
: undefined
}),
HistoryPanel({
model_type: ModelType.purchaseorder,
model_id: order.pk,
visible: showHistory
})
];
}, [order, id, user, instanceInfo]);
}, [order, id, user, instanceInfo, showHistory]);
const issueOrder = useCreateApiFormModal({
url: apiUrl(ApiEndpoints.purchase_order_issue, order.pk),
@@ -24,6 +24,9 @@ import {
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
@@ -97,6 +100,8 @@ export default function ReturnOrderDetail() {
);
}, [order, globalSettings]);
const showHistory = useShowHistoryPanel();
const orderPanels: PanelType[] = useMemo(() => {
return [
{
@@ -168,9 +173,14 @@ export default function ReturnOrderDetail() {
model_type: ModelType.returnorder,
model_id: order.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.returnorder,
model_id: order.pk,
visible: showHistory
})
];
}, [order, id, user, instanceInfo]);
}, [order, id, user, instanceInfo, showHistory]);
const orderBadges: ReactNode[] = useMemo(() => {
return instanceQuery.isLoading
@@ -30,6 +30,9 @@ import {
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
@@ -135,6 +138,8 @@ export default function SalesOrderDetail() {
modelType: ModelType.salesorder
});
const showHistory = useShowHistoryPanel();
const orderPanels: PanelType[] = useMemo(() => {
return [
{
@@ -247,9 +252,14 @@ export default function SalesOrderDetail() {
!globalSettings.isSet('SALESORDER_EDIT_COMPLETED_ORDERS')
? false
: undefined
}),
HistoryPanel({
model_type: ModelType.salesorder,
model_id: order.pk,
visible: showHistory
})
];
}, [order, id, user, soStatus, instanceInfo]);
}, [order, id, user, soStatus, instanceInfo, showHistory]);
const issueOrder = useCreateApiFormModal({
url: apiUrl(ApiEndpoints.sales_order_issue, order.pk),
@@ -27,6 +27,9 @@ import {
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
@@ -74,6 +77,8 @@ export default function SalesOrderShipmentDetail() {
const isPending = useMemo(() => !shipment.shipment_date, [shipment]);
const isChecked = useMemo(() => !!shipment.checked_by, [shipment]);
const showHistory = useShowHistoryPanel();
const shipmentPanels: PanelType[] = useMemo(() => {
return [
{
@@ -116,9 +121,14 @@ export default function SalesOrderShipmentDetail() {
model_type: ModelType.salesordershipment,
model_id: shipment.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.salesordershipment,
model_id: shipment.pk,
visible: showHistory
})
];
}, [isPending, shipment, instanceInfo]);
}, [isPending, shipment, instanceInfo, showHistory]);
const editShipmentFields = useSalesOrderShipmentFields({
pending: isPending,
@@ -27,6 +27,9 @@ import {
import InstanceDetail from '../../components/nav/InstanceDetail';
import { PageDetail } from '../../components/nav/PageDetail';
import AttachmentPanel from '../../components/panels/AttachmentPanel';
import HistoryPanel, {
useShowHistoryPanel
} from '../../components/panels/HistoryPanel';
import NotesPanel from '../../components/panels/NotesPanel';
import { PanelGroup } from '../../components/panels/PanelGroup';
import ParametersPanel from '../../components/panels/ParametersPanel';
@@ -99,6 +102,8 @@ export default function TransferOrderDetail() {
<TransferOrderDetailsPanel instance={order} />
);
const showHistory = useShowHistoryPanel();
const orderPanels: PanelType[] = useMemo(() => {
return [
{
@@ -192,9 +197,14 @@ export default function TransferOrderDetail() {
model_type: ModelType.transferorder,
model_id: order.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.transferorder,
model_id: order.pk,
visible: showHistory
})
];
}, [order, id, user, instanceInfo]);
}, [order, id, user, instanceInfo, showHistory]);
const orderBadges: ReactNode[] = useMemo(() => {
return instanceQuery.isLoading
@@ -0,0 +1,569 @@
import { t } from '@lingui/core/macro';
import { Badge, Group, Paper, Stack, Table, Text } from '@mantine/core';
import { IconArrowRight } from '@tabler/icons-react';
import type { DataTableRowExpansionProps } from 'mantine-datatable';
import { type ReactNode, useMemo } from 'react';
import { type NavigateFunction, useNavigate } from 'react-router-dom';
import { ApiEndpoints } from '@lib/enums/ApiEndpoints';
import { ModelInformationDict } from '@lib/enums/ModelInformation';
import type { ModelType } from '@lib/enums/ModelType';
import { apiUrl } from '@lib/functions/Api';
import { formatDecimal } from '@lib/functions/Formatting';
import { getDetailUrl } from '@lib/functions/Navigation';
import useTable from '@lib/hooks/UseTable';
import type { TableFilter } from '@lib/types/Filters';
import type { TableColumn } from '@lib/types/Tables';
import { RenderInlineModel } from '../../components/render/Instance';
import { RenderUser } from '../../components/render/User';
import { DateColumn } from '../../components/tables/ColumnRenderers';
import {
MaxDateFilter,
MinDateFilter,
UserFilter
} from '../../components/tables/Filter';
import { InvenTreeTable } from '../../components/tables/InvenTreeTable';
import { useFilters } from '../../hooks/UseFilter';
import { useUserState } from '../../states/UserState';
// Action codes, as defined by django-auditlog
enum AuditAction {
CREATE = 0,
UPDATE = 1,
DELETE = 2,
ACCESS = 3
}
// A single field change, as returned by the 'changes_detail' API field
type AuditChange = {
field: string;
label: string;
type: 'value' | 'fk' | 'm2m';
old?: any;
new?: any;
old_display?: string | null;
new_display?: string | null;
model_type?: string | null;
operation?: string | null;
objects?: string[] | null;
numeric?: boolean;
};
// Maximum number of changes rendered inline (the remainder are shown when the row is expanded)
const MAX_INLINE_CHANGES = 3;
// Maximum length of a single rendered value
const MAX_VALUE_LENGTH = 100;
/**
* Convert a server-side model label ('app_label.model') to a frontend ModelType (if known)
*/
function resolveModelType(label?: string | null): ModelType | undefined {
const name = label?.split('.').pop();
if (name && name in ModelInformationDict) {
return name as ModelType;
}
return undefined;
}
function actionLabel(action: AuditAction): string {
switch (action) {
case AuditAction.CREATE:
return t`Created`;
case AuditAction.UPDATE:
return t`Updated`;
case AuditAction.DELETE:
return t`Deleted`;
default:
return t`Accessed`;
}
}
function actionColor(action: AuditAction): string {
switch (action) {
case AuditAction.CREATE:
return 'green';
case AuditAction.UPDATE:
return 'blue';
case AuditAction.DELETE:
return 'red';
default:
return 'gray';
}
}
/**
* Render a single recorded value (old or new) for a field change
*/
function AuditValue({
value,
display,
modelType,
numeric,
navigate
}: Readonly<{
value: any;
display?: string | null;
modelType?: string | null;
numeric?: boolean;
navigate: NavigateFunction;
}>): ReactNode {
if (value === null || value === undefined || value === '') {
return (
<Text size='sm' c='dimmed' fs='italic'>
{t`None`}
</Text>
);
}
let text: string;
if (display) {
text = display;
} else if (numeric && Number.isFinite(Number(value))) {
// Numeric values (decimals are recorded as strings, e.g. '10.00000')
text = String(formatDecimal(Number(value)));
} else if (typeof value === 'boolean') {
text = value ? t`Yes` : t`No`;
} else if (typeof value === 'object') {
text = JSON.stringify(value);
} else {
text = String(value);
}
if (text.length > MAX_VALUE_LENGTH) {
text = `${text.slice(0, MAX_VALUE_LENGTH)}...`;
}
// Link to related objects (only if the server resolved a display value)
const relatedType = resolveModelType(modelType);
if (display && relatedType) {
return (
<RenderInlineModel
primary={text}
url={getDetailUrl(relatedType, value)}
navigate={navigate}
/>
);
}
return <Text size='sm'>{text}</Text>;
}
/**
* Render a single field change
*/
function AuditChangeItem({
change,
action,
navigate
}: Readonly<{
change: AuditChange;
action: AuditAction;
navigate: NavigateFunction;
}>): ReactNode {
if (change.type === 'm2m') {
const added = change.operation === 'add';
return (
<Group gap='xs' wrap='nowrap'>
<Text size='sm' fw={500}>
{change.label}:
</Text>
<Badge size='xs' color={added ? 'green' : 'red'}>
{added ? t`Added` : t`Removed`}
</Badge>
<Text size='sm'>
{change.objects ? change.objects.join(', ') : t`Hidden`}
</Text>
</Group>
);
}
const newValue = (
<AuditValue
value={change.new}
display={change.new_display}
modelType={change.model_type}
numeric={change.numeric}
navigate={navigate}
/>
);
return (
<Group gap='xs' wrap='nowrap'>
<Text size='sm' fw={500}>
{change.label}:
</Text>
{action == AuditAction.UPDATE && (
<>
<AuditValue
value={change.old}
display={change.old_display}
modelType={change.model_type}
numeric={change.numeric}
navigate={navigate}
/>
<IconArrowRight size={14} />
</>
)}
{newValue}
</Group>
);
}
/**
* Return the list of changes to display for an audit entry
*/
function getChanges(record: any): AuditChange[] {
const changes: AuditChange[] = record?.changes_detail ?? [];
if (record?.action == AuditAction.CREATE) {
// For new objects, empty fields are not interesting
return changes.filter(
(change) =>
change.type == 'm2m' ||
!(change.new === null || change.new === undefined || change.new === '')
);
}
return changes;
}
/**
* Render a summary of the changes for an audit entry
*/
function AuditChangesSummary({
record,
navigate
}: Readonly<{
record: any;
navigate: NavigateFunction;
}>): ReactNode {
if (record.action == AuditAction.DELETE) {
return (
<Text size='sm' c='dimmed' fs='italic'>
{t`Object was deleted`}
</Text>
);
}
const changes = getChanges(record);
if (changes.length == 0) {
return (
<Text size='sm' c='dimmed' fs='italic'>
{t`No changes recorded`}
</Text>
);
}
return (
<Stack gap={2}>
{changes.slice(0, MAX_INLINE_CHANGES).map((change) => (
<AuditChangeItem
key={change.field}
change={change}
action={record.action}
navigate={navigate}
/>
))}
{changes.length > MAX_INLINE_CHANGES && (
<Text size='xs' c='dimmed'>
{t`+ ${changes.length - MAX_INLINE_CHANGES} more (expand row to view)`}
</Text>
)}
</Stack>
);
}
/**
* Render a table of all changes for an audit entry (shown when a row is expanded)
*/
function AuditChangesDetail({
record,
navigate
}: Readonly<{
record: any;
navigate: NavigateFunction;
}>): ReactNode {
const changes = getChanges(record);
const showOld = record.action != AuditAction.CREATE;
const showNew = record.action != AuditAction.DELETE;
return (
<Paper p='xs' withBorder>
<Table striped withColumnBorders>
<Table.Thead>
<Table.Tr>
<Table.Th>{t`Field`}</Table.Th>
{showOld && <Table.Th>{t`Old Value`}</Table.Th>}
{showNew && <Table.Th>{t`New Value`}</Table.Th>}
</Table.Tr>
</Table.Thead>
<Table.Tbody>
{changes.map((change) => (
<Table.Tr key={change.field}>
<Table.Td>
<Text size='sm' fw={500}>
{change.label}
</Text>
</Table.Td>
{change.type == 'm2m' ? (
<Table.Td colSpan={showOld && showNew ? 2 : 1}>
<AuditChangeItem
change={change}
action={record.action}
navigate={navigate}
/>
</Table.Td>
) : (
<>
{showOld && (
<Table.Td>
<AuditValue
value={change.old}
display={change.old_display}
modelType={change.model_type}
numeric={change.numeric}
navigate={navigate}
/>
</Table.Td>
)}
{showNew && (
<Table.Td>
<AuditValue
value={change.new}
display={change.new_display}
modelType={change.model_type}
numeric={change.numeric}
navigate={navigate}
/>
</Table.Td>
)}
</>
)}
</Table.Tr>
))}
</Table.Tbody>
</Table>
</Paper>
);
}
/**
* Table for displaying audit log (change history) entries.
*
* - When modelType and modelId are provided, displays the history of a single object
* (including changes to its child objects, unless includeChildren is false)
* - When only modelType is provided, displays the history of all objects of that type
* - Otherwise, displays all audit log entries visible to the user
*/
export function AuditLogTable({
modelType,
modelId,
includeChildren
}: Readonly<{
modelType?: ModelType;
modelId?: number | string;
includeChildren?: boolean;
}>): ReactNode {
const navigate = useNavigate();
const user = useUserState();
const table = useTable(modelType ? `audit-log-${modelType}` : 'audit-log');
const singleObject = modelType !== undefined && modelId !== undefined;
// Model type choices are provided via the OPTIONS metadata for the list endpoint
const modelTypeFilters = useFilters({
url: apiUrl(ApiEndpoints.audit_log_list),
method: 'OPTIONS',
accessor: 'data.filters.model_type.choices',
transform: (item: any) => ({
value: item.value,
label: item.display_name
}),
// Not required if the table is restricted to a particular model type
enabled: !modelType
});
const tableFilters: TableFilter[] = useMemo(() => {
const filters: TableFilter[] = [
{
name: 'action',
label: t`Action`,
description: t`Filter by action type`,
type: 'choice',
choices: [
{ value: `${AuditAction.CREATE}`, label: t`Created` },
{ value: `${AuditAction.UPDATE}`, label: t`Updated` },
{ value: `${AuditAction.DELETE}`, label: t`Deleted` }
]
},
UserFilter({
name: 'actor',
label: t`User`,
description: t`Filter by the user who made the change`
}),
MinDateFilter(),
MaxDateFilter()
];
if (!modelType) {
filters.push({
name: 'model_type',
label: t`Model Type`,
description: t`Filter by the type of item which was changed`,
type: 'choice',
choices: modelTypeFilters.choices
});
}
if (singleObject && includeChildren === undefined) {
filters.push({
name: 'include_children',
label: t`Include Related`,
description: t`Include changes to related items (e.g. line items)`,
type: 'boolean'
});
}
return filters;
}, [singleObject, includeChildren, modelType, modelTypeFilters.choices]);
const tableColumns: TableColumn[] = useMemo(() => {
return [
DateColumn({
accessor: 'timestamp',
title: t`Date`,
switchable: false,
extra: { showTime: true }
}),
{
accessor: 'action',
title: t`Action`,
sortable: true,
switchable: false,
render: (record: any) => (
<Badge color={actionColor(record.action)} variant='light'>
{actionLabel(record.action)}
</Badge>
)
},
{
accessor: 'object_repr',
title: t`Item`,
sortable: false,
switchable: true,
render: (record: any) => {
const objectType = resolveModelType(record.model_type);
const typeLabel = objectType
? ModelInformationDict[objectType].label()
: (record.model_label ?? record.model_type);
// Deleted objects no longer have a detail page
const url =
objectType && record.action != AuditAction.DELETE
? getDetailUrl(objectType, record.object_pk)
: undefined;
return (
<Stack gap={0}>
<RenderInlineModel
primary={record.object_repr}
url={url}
navigate={navigate}
/>
<Text size='xs' c='dimmed'>
{typeLabel}
</Text>
</Stack>
);
}
},
{
accessor: 'changes',
title: t`Changes`,
sortable: false,
switchable: false,
render: (record: any) => (
<AuditChangesSummary record={record} navigate={navigate} />
)
},
{
accessor: 'actor',
title: t`User`,
sortable: true,
switchable: true,
render: (record: any) => {
if (record.actor_detail) {
return RenderUser({ instance: record.actor_detail });
}
// The user account has since been deleted
if (record.actor_username) {
return (
<Text size='sm' c='dimmed'>
{t`${record.actor_username} (deleted)`}
</Text>
);
}
if (record.additional_data?.source) {
return (
<Text size='sm' c='dimmed' fs='italic'>
{record.additional_data.source}
</Text>
);
}
return <Text size='sm' c='dimmed' fs='italic'>{t`System`}</Text>;
}
},
{
accessor: 'remote_addr',
title: t`IP Address`,
sortable: false,
switchable: true,
defaultVisible: false,
// Only returned by the API for staff users
hidden: !user.isStaff()
}
];
}, [navigate, user]);
const rowExpansion: DataTableRowExpansionProps<any> = useMemo(() => {
return {
allowMultiple: true,
expandable: ({ record }: { record: any }) =>
record.action != AuditAction.DELETE && getChanges(record).length > 0,
content: ({ record }: { record: any }) => (
<AuditChangesDetail record={record} navigate={navigate} />
)
};
}, [navigate]);
return (
<InvenTreeTable
tableState={table}
url={apiUrl(ApiEndpoints.audit_log_list)}
columns={tableColumns}
props={{
params: {
model_type: modelType,
model_id: modelId,
include_children: includeChildren,
changes_detail: true,
actor_detail: true
},
tableFilters: tableFilters,
rowExpansion: rowExpansion,
noRecordsText: t`No history found`
}}
/>
);
}
+12
View File
@@ -141,6 +141,18 @@ export const activateCalendarView = async (page: Page) => {
await page.waitForLoadState('networkidle');
};
export const tableSearch = async (page: Page, query: string) => {
await page.getByLabel('table-search-input').fill(query);
await page.waitForTimeout(300);
await page.waitForLoadState('networkidle');
};
export const clearTableSearch = async (page: Page) => {
await page.getByLabel('table-search-input').clear();
await page.waitForTimeout(300);
await page.waitForLoadState('networkidle');
};
/**
* Perform a 'global search' on the provided page, for the provided query text
*/
+5 -3
View File
@@ -3,6 +3,7 @@ import { test } from '../baseFixtures.ts';
import {
activateCalendarView,
clearTableFilters,
clearTableSearch,
clickOnRowMenu,
getRowFromCell,
loadTab,
@@ -12,6 +13,7 @@ import {
showCalendarView,
showParametricView,
showTableView,
tableSearch,
waitForDataOutput
} from '../helpers.ts';
import { doCachedLogin } from '../login.ts';
@@ -275,7 +277,7 @@ test('Build Order - Build Outputs', async ({ browser }) => {
await clearTableFilters(page);
// We have now loaded the "Build Order" table. Check for some expected texts
await page.getByRole('textbox', { name: 'table-search-input' }).fill('1');
await tableSearch(page, '1');
await page.getByText('On Hold').first().waitFor();
await page.getByText('Pending').first().waitFor();
@@ -757,11 +759,11 @@ test('Build Order - Filters', async ({ browser }) => {
// Toggle 'Outstanding' filter
await setTableChoiceFilter(page, 'Outstanding', 'Yes');
await page.getByRole('textbox', { name: 'table-search-input' }).fill('1');
await tableSearch(page, '1');
await page.getByRole('cell', { name: 'BO0017' }).waitFor();
await clearTableFilters(page);
await page.getByRole('textbox', { name: 'table-search-input' }).fill('');
await clearTableSearch(page);
await setTableChoiceFilter(page, 'Outstanding', 'No');
await page.getByText(/1 - \d+ \/ \d+/).waitFor();
+3 -2
View File
@@ -13,7 +13,8 @@ import {
openDetailAction,
setTableChoiceFilter,
showParametricView,
showTableView
showTableView,
tableSearch
} from '../helpers';
import { adminuser } from '../defaults';
@@ -406,7 +407,7 @@ test('Parts - BOM Nesting', async ({ browser }) => {
await expect(page.getByText('MAX232IDR')).toHaveCount(0);
// Searching reloads the table, which discards sub-assembly rows
await page.getByLabel('table-search-input').fill('Doohickey');
await tableSearch(page, 'Doohickey');
await expect(page.getByText('M3x10 Torx')).toHaveCount(0);
await expect(
page.getByRole('button', { name: 'nested-row-collapse' })
@@ -16,6 +16,7 @@ import {
showCalendarView,
showParametricView,
showTableView,
tableSearch,
waitForDataOutput
} from '../helpers.ts';
import { doCachedLogin } from '../login.ts';
@@ -53,9 +54,7 @@ test('Purchasing - Index', async ({ browser }) => {
// Check for expected values
await clearTableFilters(page);
await page
.getByRole('textbox', { name: 'table-search-input' })
.fill('R_100K_0402');
await tableSearch(page, 'R_100K_0402');
await page.getByText('R_100K_0402_1%').first().waitFor();
await page.getByRole('cell', { name: 'RR05P100KDTR-ND' }).first().waitFor();
@@ -155,9 +154,7 @@ test('Purchasing - Manufacturer Parts', async ({ browser }) => {
url: 'purchasing/index/manufacturer-parts'
});
await page
.getByRole('textbox', { name: 'table-search-input' })
.fill('CPF0402B100KE1');
await tableSearch(page, 'CPF0402B100KE1');
await page.getByText('R_100K_0402_1%').first().waitFor();
await page.getByRole('cell', { name: 'CPF0402B100KE1' }).waitFor();
@@ -609,9 +606,7 @@ test('Purchase Orders - Receive Items', async ({ browser }) => {
await loadTab(page, 'Received Stock');
await clearTableFilters(page);
await page
.getByRole('textbox', { name: 'table-search-input' })
.fill('my-batch-code');
await tableSearch(page, 'my-batch-code');
await page.getByRole('cell', { name: 'my-batch-code' }).first().waitFor();
});
@@ -669,9 +664,7 @@ test('Purchase Orders - Custom Location', async ({ browser }) => {
await loadTab(page, 'Received Stock');
await clearTableFilters(page);
await page
.getByRole('textbox', { name: 'table-search-input' })
.fill('po-custom-location-test');
await tableSearch(page, 'po-custom-location-test');
const receivedRow = page
.getByRole('row')
+100
View File
@@ -0,0 +1,100 @@
import type { Page } from '@playwright/test';
import { expect, test } from './baseFixtures.js';
import { adminuser, allaccessuser, stevenuser } from './defaults.js';
import {
clearTableSearch,
loadTab,
navigate,
setTableChoiceFilter,
tableSearch
} from './helpers.js';
import { doCachedLogin } from './login.js';
/**
* Tests for the audit log (change history) functionality.
*
* Note: These tests rely on the audit log entries provided in the demo dataset
*/
// Return the "History" tab on a detail page (if present)
const historyTab = (page: Page) =>
page
.getByLabel(/panel-tabs-/)
.getByRole('tab', { name: 'History', exact: true });
test('Audit - Admin Center', async ({ browser }) => {
const page = await doCachedLogin(browser, {
user: adminuser,
url: 'settings/admin/audit-log'
});
await page.getByRole('button', { name: 'Audit Log', exact: true }).waitFor();
// Historical records are displayed
await tableSearch(page, 'red round table');
await page.getByRole('cell', { name: 'BOM Item' }).first().waitFor();
await tableSearch(page, 'PO0020');
await page.getByRole('cell', { name: 'Purchase Order' }).first().waitFor();
await page.getByText('UPDATED').first().waitFor();
// Filter by model type
await clearTableSearch(page);
await setTableChoiceFilter(page, 'Model Type', 'Build Order');
await page.getByRole('cell', { name: 'Build Order' }).first().waitFor();
await expect(page.getByRole('cell', { name: 'BOM Item' })).toHaveCount(0);
// Audit log settings
await page.getByRole('button', { name: 'Audit Log Settings' }).click();
await page.getByText('Enable Audit Log').waitFor();
await page.getByText('Delete Old Audit Log Entries').waitFor();
await page.getByText('Audit Log Deletion Interval').waitFor();
await page.getByText('Retain Audit Log Summary').waitFor();
});
test('Audit - Detail Pages', async ({ browser }) => {
// Part (includes BOM item changes)
const page = await doCachedLogin(browser, {
user: adminuser,
url: 'part/111/details'
});
await loadTab(page, 'History', true);
await page
.getByRole('cell', { name: /to make TB2 \| Test Board 2/ })
.first()
.waitFor();
await page.getByText('Setup Quantity:').first().waitFor();
// Purchase order (includes line item changes)
await navigate(page, 'purchasing/purchase-order/9/detail');
await loadTab(page, 'History', true);
await page.getByRole('cell', { name: 'PO0009 - PCBWOY' }).first().waitFor();
await page.getByText('Purchase Order Extra Line').first().waitFor();
await page.getByText('Supplier Reference:').first().waitFor();
});
test('Audit - Hidden', async ({ browser }) => {
// Staff user, but the 'DISPLAY_HISTORY_TAB' setting is not enabled
const page = await doCachedLogin(browser, {
user: stevenuser,
url: 'part/111/details'
});
await page.getByRole('tab', { name: 'Part Details' }).waitFor();
await expect(historyTab(page)).toHaveCount(0);
// Non-staff user
const page2 = await doCachedLogin(browser, {
user: allaccessuser,
url: 'part/111/details'
});
await page2.getByRole('tab', { name: 'Part Details' }).waitFor();
await expect(historyTab(page2)).toHaveCount(0);
await navigate(page2, 'purchasing/purchase-order/9/detail');
await page2.getByRole('tab', { name: 'Order Details' }).waitFor();
await expect(historyTab(page2)).toHaveCount(0);
});
@@ -6,12 +6,18 @@ import { test } from './baseFixtures';
import { adminuser, readeruser } from './defaults';
import { clickOnRowMenu, loadTab } from './helpers';
import { doCachedLogin } from './login';
import { setSettingState } from './settings';
/**
* Test the "admin" account
* - This is a superuser account, so should have *all* permissions available
*/
test('Permissions - Admin', async ({ browser }) => {
await setSettingState({
setting: 'INVENTREE_SHOW_SUPERUSER_BANNER',
value: true
});
// Login, and start on the "admin" page
const page = await doCachedLogin(browser, {
user: adminuser,
+4 -3
View File
@@ -6,7 +6,8 @@ import {
clickOnRowMenu,
loadTab,
navigate,
setTableChoiceFilter
setTableChoiceFilter,
tableSearch
} from './helpers.js';
import { doCachedLogin } from './login.js';
import { setPluginState, setSettingState } from './settings.js';
@@ -26,7 +27,7 @@ test('Plugins - Settings', async ({ browser }) => {
// Navigate and select the plugin
await navigate(page, 'settings/admin/plugin/');
await clearTableFilters(page);
await page.getByLabel('table-search-input').fill('integration');
await tableSearch(page, 'integration');
await page.waitForTimeout(250);
await page.waitForLoadState('networkidle');
@@ -305,7 +306,7 @@ test('Plugins - Creator', async ({ browser }) => {
// View a custom table
await page.getByRole('button', { name: 'Custom Table Example' }).click();
await page.getByRole('textbox', { name: 'table-search-input' }).fill('red');
await tableSearch(page, 'red');
await page.waitForLoadState('networkidle');
await page.getByRole('cell', { name: 'Red Square Table' }).first().waitFor();
});
+2 -3
View File
@@ -5,6 +5,7 @@ import {
activateTableView,
loadTab,
navigate,
tableSearch,
waitForDataOutput
} from './helpers.js';
import { doCachedLogin } from './login.js';
@@ -243,9 +244,7 @@ test('Printing - Broken Template', async ({ browser }) => {
// Next, check error message from the template editor preview
await navigate(page, 'settings/admin/reports');
await page
.getByRole('textbox', { name: 'table-search-input' })
.fill('broken');
await tableSearch(page, 'broken');
await page.getByRole('cell', { name: 'Broken Sales Order Report' }).click();
await page.getByLabel('split-button-preview-options-action').click();
+11 -9
View File
@@ -2,7 +2,13 @@ import type { Page } from '@playwright/test';
import { createApi } from './api.js';
import { expect, test } from './baseFixtures.js';
import { adminuser, allaccessuser, stevenuser } from './defaults.js';
import { getRowFromCell, loadTab, navigate } from './helpers.js';
import {
clearTableSearch,
getRowFromCell,
loadTab,
navigate,
tableSearch
} from './helpers.js';
import { doCachedLogin } from './login.js';
import { setPluginState, setSettingState } from './settings.js';
@@ -417,10 +423,8 @@ test('Settings - Admin - Barcode History', async ({ browser }) => {
await page.waitForTimeout(500);
const checkBarcode = async (barcode: string) => {
await page.getByRole('textbox', { name: 'table-search-input' }).clear();
await page
.getByRole('textbox', { name: 'table-search-input' })
.fill(barcode);
await clearTableSearch(page);
await tableSearch(page, barcode);
await page.waitForLoadState('networkidle');
await page.getByText(barcode).first().waitFor();
};
@@ -441,16 +445,14 @@ test('Settings - Admin - Parameter', async ({ browser }) => {
await loadTab(page, 'Selection Lists');
// Check for expected entry
await page
.getByRole('textbox', { name: 'table-search-input' })
.fill('Animals');
await tableSearch(page, 'Animals');
await page.getByRole('cell', { name: 'Animals', exact: true }).waitFor();
await page.getByText('Various animals and descriptions thereof').waitFor();
await page.waitForLoadState('networkidle');
await page.waitForTimeout(250);
await page.getByRole('textbox', { name: 'table-search-input' }).fill('some');
await tableSearch(page, 'some');
await page.waitForTimeout(500);
await page.waitForLoadState('networkidle');