[Refactor] Stock tracking audit (#13101)

* Add "event_type" and "notes" support to AuditLog model

* Register history entries for stock items

* record stock edited events as normal updates

* Remove legacy tracking entry generation code

* Updated unit tests for all stock event types

* remove legacy endpoints

* remove legacy tables from UI

* Updated docs

* Data migration

* Remove old models

* Update docs

* Updated playwright tests

* Fix broken links

* Update CHANGELOG.md

* Cache CID value

* Fix migration tests

* Increase query threshold for unit test

* Fix bug and add regression test

* mark migration as one-way

* flush events in the correct order

* improve prefetch

* Adjust row rendering
This commit is contained in:
Oliver authored and GitHub committed 2026-10-27 15:14:15 +11:00
1 parent 2ee5764b3b
commit c4280c2a03
64 files changed
+3869 -2150

No files matched your search

-1
View File
@@ -145,7 +145,6 @@ export enum ApiEndpoints {
// Stock item API endpoints
stock_item_list = 'stock/',
stock_tracking_list = 'stock/track/',
stock_test_result_list = 'stock/test/',
stock_transfer = 'stock/transfer/',
stock_remove = 'stock/remove/',
+1 -1
View File
@@ -151,7 +151,7 @@ export const ModelInformationDict: ModelDict = {
stockhistory: {
label: () => t`Stock History`,
label_multiple: () => t`Stock Histories`,
api_endpoint: ApiEndpoints.stock_tracking_list,
api_endpoint: ApiEndpoints.audit_log_list,
icon: 'history'
},
build: {
@@ -9,25 +9,24 @@ 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
* - The audit log must be enabled
* - Must be enabled via the 'DISPLAY_HISTORY_TAB' user setting
*
* Note: The displayed entries are filtered by the permissions of the user
*/
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]
[userSettings, globalSettings]
);
}
-1
View File
@@ -342,7 +342,6 @@ export function useStockFields({
originalId: duplicateStockItem.pk,
extraFields: {
copy_notes: { value: true },
copy_history: { value: false },
copy_tests: {
value: false,
hidden: !duplicateStockItem?.part_detail?.testable
@@ -297,13 +297,6 @@ export default function SystemSettings() {
'STOCKTAKE_DELETE_DAYS'
]}
/>
<GlobalSettingList
heading={t`Stock Tracking`}
keys={[
'STOCK_TRACKING_DELETE_OLD_ENTRIES',
'STOCK_TRACKING_DELETE_DAYS'
]}
/>
<GlobalSettingList
heading={t`Transfer Orders`}
keys={[
@@ -32,7 +32,6 @@ import {
useEditApiFormModal
} from '../../hooks/UseForm';
import { useUserState } from '../../states/UserState';
import { StockTrackingTable } from '../../tables/stock/StockTrackingTable';
/*
* Render a tooltip for the chart, with correct date information
@@ -294,14 +293,6 @@ export default function PartStockHistoryDetail({
}: Readonly<{ partId: number }>) {
return (
<Accordion multiple defaultValue={['stocktake']}>
<Accordion.Item value='tracking'>
<Accordion.Control>
<StylishText size='lg'>{t`Stock Tracking`}</StylishText>
</Accordion.Control>
<Accordion.Panel>
<StockTrackingTable partId={partId} />
</Accordion.Panel>
</Accordion.Item>
<Accordion.Item value='stocktake'>
<Accordion.Control>
<StylishText size='lg'>{t`Stocktake Entries`}</StylishText>
+11 -12
View File
@@ -5,7 +5,6 @@ import {
IconBookmark,
IconBoxPadding,
IconChecklist,
IconHistory,
IconInfoCircle,
IconPackages,
IconShoppingCart,
@@ -41,6 +40,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 LocateItemButton from '../../components/plugins/LocateItemButton';
@@ -69,7 +71,6 @@ import SalesOrderAllocationTable from '../../tables/sales/SalesOrderAllocationTa
import InstalledItemsTable from '../../tables/stock/InstalledItemsTable';
import { StockItemTable } from '../../tables/stock/StockItemTable';
import StockItemTestResultTable from '../../tables/stock/StockItemTestResultTable';
import { StockTrackingTable } from '../../tables/stock/StockTrackingTable';
import TransferOrderAllocationTable from '../../tables/stock/TransferOrderAllocationTable';
import { StockDetailsPanel } from './StockDetailsPanel';
@@ -182,6 +183,8 @@ export default function StockDetail() {
return stockitem?.part_detail?.assembly;
}, [trackedBomItemQuery, stockitem]);
const showHistory = useShowHistoryPanel();
const stockPanels: PanelType[] = useMemo(() => {
return [
{
@@ -197,16 +200,6 @@ export default function StockDetail() {
/>
)
},
{
name: 'tracking',
label: t`Stock Tracking`,
icon: <IconHistory />,
content: stockitem.pk ? (
<StockTrackingTable itemId={stockitem.pk} />
) : (
<Skeleton />
)
},
{
name: 'allocations',
label: t`Allocations`,
@@ -320,9 +313,15 @@ export default function StockDetail() {
model_type: ModelType.stockitem,
model_id: stockitem.pk,
note_count: instanceInfo.note_count
}),
HistoryPanel({
model_type: ModelType.stockitem,
model_id: stockitem.pk,
visible: showHistory
})
];
}, [
showHistory,
showSalesAllocations,
showBuildAllocations,
showInstalledItems,
@@ -233,6 +233,86 @@ function getChanges(record: any): AuditChange[] {
return changes;
}
/**
* Return a human readable label for an event delta key (e.g. 'sales_order' -> 'Sales order')
*/
function deltaLabel(key: string): string {
// Labels for commonly used delta keys (e.g. stock tracking events)
const labels: Record<string, string> = {
added: t`Added`,
build_order: t`Build Order`,
buildorder: t`Build Order`,
customer: t`Customer`,
location: t`Location`,
part: t`Part`,
purchaseorder: t`Purchase Order`,
quantity: t`Quantity`,
removed: t`Removed`,
returnorder: t`Return Order`,
salesorder: t`Sales Order`,
stockitem: t`Stock Item`,
transferorder: t`Transfer Order`
};
if (key in labels) {
return labels[key];
}
const label = key.replaceAll('_', ' ');
return label.charAt(0).toUpperCase() + label.slice(1);
}
/**
* Render the deltas and notes recorded against a named event (if any)
*/
function AuditEventDetails({
record,
navigate
}: Readonly<{
record: any;
navigate: NavigateFunction;
}>): ReactNode {
const deltas: [string, any][] = Object.entries(record.deltas ?? {});
if (deltas.length == 0 && !record.notes) {
return null;
}
return (
<Stack gap={2}>
{deltas.map(([key, value]) => {
// A reference to another object: {model_type, pk, str}
const isReference =
value !== null && typeof value === 'object' && 'model_type' in value;
return (
<Group key={key} gap='xs' wrap='nowrap'>
<Text size='sm' fw={500}>
{deltaLabel(key)}:
</Text>
{isReference && !value.str ? (
<Text size='sm' c='dimmed' fs='italic'>{t`Hidden`}</Text>
) : (
<AuditValue
value={isReference ? value.pk : value}
display={isReference ? value.str : undefined}
modelType={isReference ? value.model_type : undefined}
numeric={typeof value === 'number'}
navigate={navigate}
/>
)}
</Group>
);
})}
{record.notes && (
<Text size='sm' fs='italic'>
{record.notes}
</Text>
)}
</Stack>
);
}
/**
* Render a summary of the changes for an audit entry
*/
@@ -243,17 +323,30 @@ function AuditChangesSummary({
record: any;
navigate: NavigateFunction;
}>): ReactNode {
const eventDetails = (
<AuditEventDetails record={record} navigate={navigate} />
);
if (record.action == AuditAction.DELETE) {
// A named event may be recorded against the deletion (e.g. stock depleted to zero)
return (
<Text size='sm' c='dimmed' fs='italic'>
{t`Object was deleted`}
</Text>
<Stack gap={2}>
{eventDetails}
<Text size='sm' c='dimmed' fs='italic'>
{t`Object was deleted`}
</Text>
</Stack>
);
}
const changes = getChanges(record);
if (changes.length == 0) {
// A named event may be recorded without any field changes
if (record.event_type !== null && record.event_type !== undefined) {
return eventDetails;
}
return (
<Text size='sm' c='dimmed' fs='italic'>
{t`No changes recorded`}
@@ -263,6 +356,7 @@ function AuditChangesSummary({
return (
<Stack gap={2}>
{eventDetails}
{changes.slice(0, MAX_INLINE_CHANGES).map((change) => (
<AuditChangeItem
key={change.field}
@@ -450,7 +544,7 @@ export function AuditLogTable({
switchable: false,
render: (record: any) => (
<Badge color={actionColor(record.action)} variant='light'>
{actionLabel(record.action)}
{record.event_label ?? actionLabel(record.action)}
</Badge>
)
},
@@ -1,317 +0,0 @@
import { t } from '@lingui/core/macro';
import { Table, Text } from '@mantine/core';
import { type ReactNode, useCallback, useMemo } from 'react';
import { useNavigate } from 'react-router-dom';
import { ApiEndpoints } from '@lib/enums/ApiEndpoints';
import { ModelType } from '@lib/enums/ModelType';
import { apiUrl } from '@lib/functions/Api';
import { formatDecimal } from '@lib/functions/Formatting';
import useTable from '@lib/hooks/UseTable';
import type { TableFilter } from '@lib/types/Filters';
import type { TableColumn } from '@lib/types/Tables';
import { RenderBuildOrder } from '../../components/render/Build';
import { RenderCompany } from '../../components/render/Company';
import {
RenderPurchaseOrder,
RenderReturnOrder,
RenderSalesOrder,
RenderTransferOrder
} from '../../components/render/Order';
import { RenderPart } from '../../components/render/Part';
import { StatusRenderer } from '../../components/render/StatusRenderer';
import {
RenderStockItem,
RenderStockLocation
} from '../../components/render/Stock';
import { RenderUser } from '../../components/render/User';
import {
DateColumn,
DescriptionColumn,
IPNColumn,
PartColumn,
StockColumn
} from '../../components/tables/ColumnRenderers';
import {
IncludeVariantsFilter,
MaxDateFilter,
MinDateFilter,
UserFilter
} from '../../components/tables/Filter';
import { InvenTreeTable } from '../../components/tables/InvenTreeTable';
type StockTrackingEntry = {
label: string;
key: string;
details: ReactNode;
};
export function StockTrackingTable({
itemId,
partId
}: Readonly<{
itemId?: number;
partId?: number;
}>) {
const navigate = useNavigate();
const table = useTable(partId ? 'part_stock_tracking' : 'stock_tracking');
// Render "details" for a stock tracking record
const renderDetails = useCallback(
(record: any) => {
const deltas: any = record?.deltas ?? {};
const entries: StockTrackingEntry[] = [
{
label: t`Stock Item`,
key: 'stockitem',
details:
deltas.stockitem_detail &&
RenderStockItem({ instance: deltas.stockitem_detail, link: true })
},
{
label: t`Stock Item`,
key: 'item',
details:
deltas.item_detail &&
RenderStockItem({
instance: deltas.item_detail,
link: true
})
},
{
label: t`Status`,
key: 'status',
details:
deltas.status &&
StatusRenderer({
status: deltas.status,
type: ModelType.stockitem,
fallbackStatus: deltas.status_logical
})
},
{
label: t`Old Status`,
key: 'old_status',
details:
deltas.old_status &&
StatusRenderer({
status: deltas.old_status,
type: ModelType.stockitem,
fallbackStatus: deltas.old_status_logical
})
},
{
label: t`Quantity`,
key: 'quantity',
details: formatDecimal(deltas.quantity)
},
{
label: t`Added`,
key: 'added',
details: deltas.added
},
{
label: t`Removed`,
key: 'removed',
details: deltas.removed
},
{
label: t`Part`,
key: 'part',
details:
deltas.part_detail &&
RenderPart({
instance: deltas.part_detail,
link: true,
navigate: navigate
})
},
{
label: t`Location`,
key: 'location',
details:
deltas.location_detail &&
RenderStockLocation({
instance: deltas.location_detail,
link: true,
navigate: navigate
})
},
{
label: t`Build Order`,
key: 'buildorder',
details:
deltas.buildorder_detail &&
RenderBuildOrder({
instance: deltas.buildorder_detail,
link: true,
navigate: navigate
})
},
{
label: t`Purchase Order`,
key: 'purchaseorder',
details:
deltas.purchaseorder_detail &&
RenderPurchaseOrder({
instance: deltas.purchaseorder_detail,
link: true,
navigate: navigate
})
},
{
label: t`Sales Order`,
key: 'salesorder',
details:
deltas.salesorder_detail &&
RenderSalesOrder({
instance: deltas.salesorder_detail,
link: true,
navigate: navigate
})
},
{
label: t`Return Order`,
key: 'returnorder',
details:
deltas.returnorder_detail &&
RenderReturnOrder({
instance: deltas.returnorder_detail,
link: true,
navigate: navigate
})
},
{
label: t`Transfer Order`,
key: 'transferorder',
details:
deltas.transferorder_detail &&
RenderTransferOrder({
instance: deltas.transferorder_detail,
link: true,
navigate: navigate
})
},
{
label: t`Customer`,
key: 'customer',
details:
deltas.customer_detail &&
RenderCompany({
instance: deltas.customer_detail,
link: true,
navigate: navigate
})
}
];
return (
<Table striped>
<Table.Tbody>
{entries.map(
(entry) =>
entry.details && (
<Table.Tr key={entry.key}>
<Table.Td>
<Text>{entry.label}</Text>
</Table.Td>
<Table.Td>{entry.details}</Table.Td>
</Table.Tr>
)
)}
</Table.Tbody>
</Table>
);
},
[navigate]
);
const filters: TableFilter[] = useMemo(() => {
return [
MinDateFilter(),
MaxDateFilter(),
IncludeVariantsFilter(),
UserFilter({
name: 'user',
label: t`User`,
description: t`Filter by user`
})
];
}, []);
const tableColumns: TableColumn[] = useMemo(() => {
return [
DateColumn({
switchable: false
}),
PartColumn({
title: t`Part`,
part: 'part_detail',
switchable: true,
hidden: !partId
}),
IPNColumn({
defaultVisible: false,
hidden: !partId
}),
StockColumn({
title: t`Stock Item`,
accessor: 'item_detail',
nullMessage: (
<Text size='sm' c='red'>{t`Stock item no longer exists`}</Text>
),
sortable: false,
switchable: false,
hidden: !partId
}),
DescriptionColumn({
accessor: 'label'
}),
{
accessor: 'details',
title: t`Details`,
switchable: false,
render: renderDetails
},
{
accessor: 'notes',
title: t`Notes`,
sortable: false,
switchable: true
},
{
accessor: 'user',
title: t`User`,
render: (record: any) => {
if (!record.user_detail) {
return <Text size='sm' fs='italic'>{t`No user information`}</Text>;
}
return RenderUser({ instance: record.user_detail });
}
}
];
}, []);
return (
<InvenTreeTable
tableState={table}
url={apiUrl(ApiEndpoints.stock_tracking_list)}
columns={tableColumns}
props={{
params: {
item: itemId,
part: partId,
part_detail: partId ? true : undefined,
item_detail: partId ? true : undefined,
user_detail: true
},
enableDownload: true,
tableFilters: filters,
modelType: partId ? ModelType.stockitem : undefined,
modelField: 'item'
}}
/>
);
}
+55 -37
View File
@@ -1,5 +1,5 @@
import { expect, test } from '../baseFixtures.js';
import { stevenuser } from '../defaults.js';
import { adminuser, stevenuser } from '../defaults.js';
import {
clearTableFilters,
clickButtonIfVisible,
@@ -30,7 +30,6 @@ test('Stock - Basic Tests', async ({ browser }) => {
await navigate(page, 'stock/item/1194/details');
await page.getByText('D.123 | Doohickey').waitFor();
await page.getByText('Batch Code: BX-123-2024-2-7').waitFor();
await loadTab(page, 'Stock Tracking');
await loadTab(page, 'Test Results');
await page.getByText('395c6d5586e5fb656901d047be27e1f7').waitFor();
await loadTab(page, 'Installed Items');
@@ -47,12 +46,6 @@ test('Stock - Basic Tests', async ({ browser }) => {
// Automatically navigate through to the newly created stock item
await page.getByText('Quantity: 987').first().waitFor();
await loadTab(page, 'Stock Tracking');
await page
.getByRole('cell', { name: 'Stock item created' })
.first()
.waitFor();
await page.getByRole('cell', { name: 'allaccess Ally Access' }).waitFor();
});
test('Stock - Location Tree', async ({ browser }) => {
@@ -508,24 +501,59 @@ test('Stock - Return Items', async ({ browser }) => {
await page.getByText('This field is required.').first().waitFor();
});
test('Stock - Tracking', async ({ browser }) => {
const page = await doCachedLogin(browser, { url: 'stock/item/176/details' });
test('Stock - History (Stock Item)', async ({ browser }) => {
// Note: The 'admin' user has the "Show Change History" setting enabled
const page = await doCachedLogin(browser, {
user: adminuser,
url: 'stock/item/193/history'
});
await page.getByText('widget.purple | Purple Widget').first().waitFor();
// Stock tracking events are displayed in the "History" tab
await page.getByText('Installed into assembly').first().waitFor();
await page.getByText('Assigned serial number').first().waitFor();
await page.getByText('Stock item created').first().waitFor();
// Event deltas link to the related stock item
await page.getByText('Widget Board (assembled) #159').first().waitFor();
});
test('Stock - History (Part)', async ({ browser }) => {
// Note: The 'admin' user has the "Show Change History" setting enabled
const page = await doCachedLogin(browser, {
user: adminuser,
url: 'part/76/history'
});
await page.getByText('widget.purple | Purple Widget').first().waitFor();
// The history of the part includes stock tracking events for its stock items
await page.getByText('Shipped against Sales Order').first().waitFor();
await page.getByText('Customer D').first().waitFor();
await page.getByText('SO0009').first().waitFor();
await page.getByText('Installed into assembly').first().waitFor();
await page.getByText('Purple Widget #35').first().waitFor();
// ...as well as changes to the part itself (e.g. parameters)
await page.getByText('Color: Purple').first().waitFor();
});
test('Stock - History', async ({ browser }) => {
// Note: The 'admin' user has the "Show Change History" setting enabled
const page = await doCachedLogin(browser, {
user: adminuser,
url: 'stock/item/176/details'
});
await page.getByRole('link', { name: 'Widget Assembly # 2' }).waitFor();
// Navigate to the "stock tracking" tab
await loadTab(page, 'Stock Tracking');
await page.getByText('Factory/Office Block/Room').first().waitFor();
await page.getByRole('link', { name: 'Widget Assembly' }).waitFor();
await page.getByRole('cell', { name: 'Installed into assembly' }).waitFor();
/* Add some more stock items and tracking information:
/* Add some more stock items and history information:
* - Duplicate this stock item
* - Give it a unique serial number
* - Ensure the tracking information is duplicated correctly
* - Ensure the creation of the new item is recorded
* - Delete the new stock item
* - Ensure that the tracking information is retained against the base part
* - Ensure that the history is retained against the base part
*/
// Duplicate the stock item
@@ -540,13 +568,10 @@ test('Stock - Tracking', async ({ browser }) => {
.fill('9876');
await page.getByRole('button', { name: 'Submit' }).click();
// Check stock tracking information is correct
// Check that the creation of the new item is recorded
await page.getByText('Serial Number: 9876').first().waitFor();
await loadTab(page, 'Stock Tracking');
await page
.getByRole('cell', { name: 'Stock item created' })
.first()
.waitFor();
await loadTab(page, 'History', true);
await page.getByText('Stock item created').first().waitFor();
// Delete this stock item
await page
@@ -557,17 +582,10 @@ test('Stock - Tracking', async ({ browser }) => {
.click();
await page.getByRole('button', { name: 'Delete' }).click();
// Check stock tracking for base part
await loadTab(page, 'Stock History');
await page.getByRole('button', { name: 'Stock Tracking' }).click();
await page.getByText('Stock item no longer exists').first().waitFor();
await page
.getByRole('cell', { name: 'Thumbnail Blue Widget' })
.first()
.waitFor();
await page.getByText('# 162').first().waitFor();
// The history of the deleted item is retained against the base part
await loadTab(page, 'History', true);
await page.getByText('Object was deleted').first().waitFor();
await page.getByText('Stock item created').first().waitFor();
});
test('Stock - Location', async ({ browser }) => {