Audit log (#899)

* Check if the backend supports auditlog info

* Change from stockhistory to auditlog

- Removes support for legacy stockhistory tracking
- Now uses AuditLog

* Update release notes
This commit is contained in:
Oliver authored and GitHub committed 2026-10-26 20:05:38 +11:00
1 parent 3a228dfc1f
commit edd7fafb6d
24 files changed
+488 -214

No files matched your search

+3
View File
@@ -2,8 +2,11 @@
---
- Supports new multi-note API for model instances
- Supports read-only audit log for historical changes
- Removes legacy StockItemTracking functionality (replaced by audit log)
- Implement rendering for HTML note content
- Adds support for separate "pricing" permission set
- Updated translations
## 0.25.2 - September 2026
---
+5 -4
View File
@@ -359,6 +359,11 @@ class InvenTreeAPI {
bool get canViewPricing =>
!supportsPricingRole || checkRole("pricing", "view");
// Does the server support the "AuditLog" model?
// Ref: https://github.com/inventree/InvenTree/pull/13069
// Ref: https://github.com/inventree/InvenTree/pull/13101
bool get supportsAuditLog => apiVersion >= 566;
// Cached list of plugins (refreshed when we connect to the server)
List<InvenTreePlugin> _plugins = [];
@@ -1951,8 +1956,6 @@ class InvenTreeAPI {
}
// Accessors methods for various status code classes
InvenTreeStatusCode get StockHistoryStatus =>
_get_status_class("stock/track/status/");
InvenTreeStatusCode get StockStatus => _get_status_class("stock/status/");
InvenTreeStatusCode get PurchaseOrderStatus =>
_get_status_class("order/po/status/");
@@ -1963,7 +1966,6 @@ class InvenTreeAPI {
_get_status_class("build/status/");
void clearStatusCodeData() {
StockHistoryStatus.data.clear();
StockStatus.data.clear();
PurchaseOrderStatus.data.clear();
SalesOrderStatus.data.clear();
@@ -1971,7 +1973,6 @@ class InvenTreeAPI {
}
Future<void> fetchStatusCodeData({bool forceReload = true}) async {
StockHistoryStatus.load(forceReload: forceReload);
StockStatus.load(forceReload: forceReload);
PurchaseOrderStatus.load(forceReload: forceReload);
SalesOrderStatus.load(forceReload: forceReload);
+116
View File
@@ -0,0 +1,116 @@
import "package:inventree/inventree/model.dart";
/*
* Class representing a single "audit log" (history) entry.
*
* Audit log entries record the change history of a given model instance,
* and are read-only via the API.
*
* Entries are filtered by the server, based on the permissions of the user.
*
* Ref: https://github.com/inventree/InvenTree/pull/13069
* Ref: https://github.com/inventree/InvenTree/pull/13101
*/
class InvenTreeAuditLogEntry extends InvenTreeModel {
InvenTreeAuditLogEntry() : super();
InvenTreeAuditLogEntry.fromJson(Map<String, dynamic> json)
: super.fromJson(json);
@override
InvenTreeAuditLogEntry createFromJson(Map<String, dynamic> json) =>
InvenTreeAuditLogEntry.fromJson(json);
@override
String get URL => "audit/";
// Audit log "action" values
static const int ACTION_CREATE = 0;
static const int ACTION_UPDATE = 1;
static const int ACTION_DELETE = 2;
static const int ACTION_ACCESS = 3;
@override
Map<String, String> defaultFilters() {
// By default, order by decreasing date, and include field change details
return {"ordering": "-timestamp", "changes_detail": "true"};
}
DateTime? get timestamp => getDate("timestamp");
String get timestampString => getDateString("timestamp");
int get action => getInt("action");
String get actionLabel => getString("action_label");
// Named event (e.g. a stock adjustment) associated with this entry (if any)
String get eventLabel => getString("event_label");
// Title for this entry - the named event, if available
String get label => eventLabel.isNotEmpty ? eventLabel : actionLabel;
String get username => getString("actor_username");
// The model type of the audited instance (e.g. "order.purchaseorder")
String get modelType => getString("model_type");
String get modelLabel => getString("model_label");
String get objectRepr => getString("object_repr");
// Return a list of the individual field changes recorded against this entry
List<Map<String, dynamic>> get changes {
List<Map<String, dynamic>> results = [];
dynamic detail = jsondata["changes_detail"];
if (detail is List) {
for (var row in detail) {
if (row is Map<String, dynamic>) {
results.add(row);
}
}
}
return results;
}
// Return a human-readable summary of each field change
List<String> get changeSummary {
List<String> lines = [];
for (var change in changes) {
String label = (change["label"] ?? change["field"] ?? "").toString();
if (change["type"] == "m2m") {
List<dynamic> objects = (change["objects"] ?? []) as List<dynamic>;
String operation = (change["operation"] ?? "").toString();
lines.add("${label}: ${operation} ${objects.join(", ")}".trim());
continue;
}
String oldValue = _displayValue(change, "old");
String newValue = _displayValue(change, "new");
if (oldValue.isEmpty) {
lines.add("${label}: ${newValue}");
} else {
lines.add("${label}: ${oldValue} → ${newValue}");
}
}
return lines;
}
// Return the display value for the "old" or "new" value of a change
String _displayValue(Map<String, dynamic> change, String key) {
dynamic value = change["${key}_display"] ?? change[key];
if (value == null || value.toString() == "None") {
return "";
}
return value.toString();
}
}
-54
View File
@@ -69,58 +69,6 @@ class InvenTreeStockItemTestResult extends InvenTreeModel {
}
}
class InvenTreeStockItemHistory extends InvenTreeModel {
InvenTreeStockItemHistory() : super();
InvenTreeStockItemHistory.fromJson(Map<String, dynamic> json)
: super.fromJson(json);
@override
InvenTreeModel createFromJson(Map<String, dynamic> json) =>
InvenTreeStockItemHistory.fromJson(json);
@override
String get URL => "stock/track/";
@override
Map<String, String> defaultFilters() {
// By default, order by decreasing date
return {"ordering": "-date", "user_detail": "true"};
}
DateTime? get date => getDate("date");
String get dateString => getDateString("date");
String get label => getString("label");
// Return the "deltas" associated with this historical object
Map<String, dynamic> get deltas => getMap("deltas");
// Return the quantity string for this historical object
String get quantityString {
var _deltas = deltas;
if (_deltas.containsKey("quantity")) {
double q = double.tryParse(_deltas["quantity"].toString()) ?? 0;
return simpleNumberString(q);
} else {
return "";
}
}
int? get user => getValue("user") as int?;
String get userString {
if (user != null) {
return getString("username", subKey: "user_detail");
} else {
return "";
}
}
}
/*
* Class representing a StockItem database instance
*/
@@ -283,8 +231,6 @@ class InvenTreeStockItem extends InvenTreeModel {
int get purchaseOrderId => getInt("purchase_order");
int get trackingItemCount => getInt("tracking_items", backup: 0);
bool get isBuilding => getBool("is_building");
int get salesOrderId => getInt("sales_order");
+3 -6
View File
@@ -659,6 +659,9 @@
"description": "history"
},
"historyDetail": "Display change history (audit log) information",
"@historyDetail": {},
"hold": "Hold",
"@hold": {},
@@ -1689,12 +1692,6 @@
"stockItemDeleteSuccess": "Stock item deleted",
"@stockItemDeleteSuccess": {},
"stockItemHistory": "Stock History",
"@stockItemHistory": {},
"stockItemHistoryDetail": "Display historical stock tracking information",
"@stockItemHistoryDetail": {},
"stockItemTransferred": "Stock item transferred",
"@stockItemTransferred": {},
+1 -1
View File
@@ -130,6 +130,7 @@ const List<ManagedSetting> MANAGED_SETTINGS = [
ManagedSetting(INV_SOUNDS_BARCODE, ManagedSettingType.boolean),
ManagedSetting(INV_SOUNDS_SERVER, ManagedSettingType.boolean),
ManagedSetting(INV_SHOW_PK, ManagedSettingType.boolean),
ManagedSetting(INV_SHOW_HISTORY, ManagedSettingType.boolean),
// Home Screen settings
ManagedSetting(INV_HOME_SHOW_SUBSCRIBED, ManagedSettingType.boolean),
@@ -166,7 +167,6 @@ const List<ManagedSetting> MANAGED_SETTINGS = [
ManagedSetting(INV_PART_SHOW_REQUIREMENTS, ManagedSettingType.boolean),
// Stock settings
ManagedSetting(INV_STOCK_SHOW_HISTORY, ManagedSettingType.boolean),
ManagedSetting(INV_STOCK_SHOW_TESTS, ManagedSettingType.boolean),
ManagedSetting(INV_STOCK_CONFIRM_SCAN, ManagedSettingType.boolean),
+1 -1
View File
@@ -19,6 +19,7 @@ const String INV_HOME_SHOW_TRANSFER = "homeShowTransfer";
const String INV_SCREEN_ORIENTATION = "appScreenOrientation";
const String INV_SHOW_PK = "showPk";
const String INV_SHOW_HISTORY = "showHistory";
// Available screen orientation values
const int SCREEN_ORIENTATION_SYSTEM = 0;
@@ -40,7 +41,6 @@ const String INV_PART_SHOW_PRICING = "partShowPricing";
const String INV_PART_SHOW_REQUIREMENTS = "partShowRequirements";
// Stock settings
const String INV_STOCK_SHOW_HISTORY = "stockShowHistory";
const String INV_STOCK_SHOW_TESTS = "stockShowTests";
const String INV_STOCK_CONFIRM_SCAN = "stockConfirmScan";
+19
View File
@@ -36,6 +36,7 @@ class _InvenTreeAppSettingsState extends State<InvenTreeAppSettingsWidget> {
bool enableLabelPrinting = true;
bool darkMode = false;
bool showPk = false;
bool showHistory = false;
int screenOrientation = SCREEN_ORIENTATION_SYSTEM;
@@ -77,6 +78,10 @@ class _InvenTreeAppSettingsState extends State<InvenTreeAppSettingsWidget> {
as bool;
showPk =
await InvenTreeSettingsManager().getValue(INV_SHOW_PK, false) as bool;
showHistory = await InvenTreeSettingsManager().getBool(
INV_SHOW_HISTORY,
false,
);
darkMode = AdaptiveTheme.of(context).mode.isDark;
@@ -211,6 +216,20 @@ class _InvenTreeAppSettingsState extends State<InvenTreeAppSettingsWidget> {
},
),
),
ListTile(
title: Text(L10().history),
subtitle: Text(L10().historyDetail),
leading: Icon(TablerIcons.history),
trailing: Switch(
value: showHistory,
onChanged: (bool value) {
InvenTreeSettingsManager().setValue(INV_SHOW_HISTORY, value);
setState(() {
showHistory = value;
});
},
),
),
GestureDetector(
child: ListTile(
title: Text(L10().orientation),
-22
View File
@@ -11,7 +11,6 @@ class InvenTreeStockSettingsWidget extends StatefulWidget {
class _InvenTreeStockSettingsState extends State<InvenTreeStockSettingsWidget> {
_InvenTreeStockSettingsState();
bool stockShowHistory = false;
bool stockShowTests = false;
bool stockConfirmScan = false;
@@ -22,10 +21,6 @@ class _InvenTreeStockSettingsState extends State<InvenTreeStockSettingsWidget> {
}
Future<void> loadSettings() async {
stockShowHistory = await InvenTreeSettingsManager().getBool(
INV_STOCK_SHOW_HISTORY,
false,
);
stockShowTests = await InvenTreeSettingsManager().getBool(
INV_STOCK_SHOW_TESTS,
true,
@@ -47,23 +42,6 @@ class _InvenTreeStockSettingsState extends State<InvenTreeStockSettingsWidget> {
body: Container(
child: ListView(
children: [
ListTile(
title: Text(L10().stockItemHistory),
subtitle: Text(L10().stockItemHistoryDetail),
leading: Icon(TablerIcons.history),
trailing: Switch(
value: stockShowHistory,
onChanged: (bool value) {
InvenTreeSettingsManager().setValue(
INV_STOCK_SHOW_HISTORY,
value,
);
setState(() {
stockShowHistory = value;
});
},
),
),
ListTile(
title: Text(L10().testResults),
subtitle: Text(L10().testResultsDetail),
+11
View File
@@ -14,6 +14,7 @@ import "package:inventree/widget/attachment_widget.dart";
import "package:inventree/widget/dialogs.dart";
import "package:inventree/widget/link_icon.dart";
import "package:inventree/widget/notes_list_widget.dart";
import "package:inventree/widget/history_widget.dart";
import "package:inventree/widget/refreshable_state.dart";
import "package:inventree/widget/build/build_line_list.dart";
import "package:inventree/widget/build/build_item_list.dart";
@@ -556,6 +557,16 @@ class _BuildOrderDetailState extends RefreshableState<BuildOrderDetailWidget> {
ShowNotesItem(context, widget.order, InvenTreeBuildOrder.MODEL_TYPE),
);
if (showHistory) {
tiles.add(
ShowHistoryItem(
context,
InvenTreeBuildOrder.MODEL_TYPE,
widget.order.pk,
),
);
}
// Attachments tile
ListTile? attachmentTile = ShowAttachmentsItem(
context,
+11
View File
@@ -14,6 +14,7 @@ import "package:inventree/inventree/sales_order.dart";
import "package:inventree/widget/attachment_widget.dart";
import "package:inventree/widget/link_icon.dart";
import "package:inventree/widget/notes_list_widget.dart";
import "package:inventree/widget/history_widget.dart";
import "package:inventree/widget/order/purchase_order_list.dart";
import "package:inventree/widget/order/sales_order_list.dart";
import "package:inventree/widget/parameter_widget.dart";
@@ -405,6 +406,16 @@ class _CompanyDetailState extends RefreshableState<CompanyDetailWidget> {
ShowNotesItem(context, widget.company, InvenTreeCompany.MODEL_TYPE),
);
if (showHistory) {
tiles.add(
ShowHistoryItem(
context,
InvenTreeCompany.MODEL_TYPE,
widget.company.pk,
),
);
}
ListTile? parameterTile = ShowParametersItem(
context,
InvenTreeCompany.MODEL_TYPE,
@@ -12,6 +12,7 @@ import "package:inventree/inventree/company.dart";
import "package:inventree/inventree/part.dart";
import "package:inventree/widget/attachment_widget.dart";
import "package:inventree/widget/parameter_widget.dart";
import "package:inventree/widget/history_widget.dart";
import "package:inventree/widget/refreshable_state.dart";
import "package:inventree/widget/snacks.dart";
@@ -207,6 +208,16 @@ class _ManufacturerPartDisplayState
);
}
if (showHistory) {
tiles.add(
ShowHistoryItem(
context,
InvenTreeManufacturerPart.MODEL_TYPE,
widget.manufacturerPart.pk,
),
);
}
ListTile? parameterTile = ShowParametersItem(
context,
InvenTreeManufacturerPart.MODEL_TYPE,
@@ -15,6 +15,7 @@ import "package:inventree/barcode/barcode.dart";
import "package:inventree/inventree/part.dart";
import "package:inventree/inventree/company.dart";
import "package:inventree/widget/parameter_widget.dart";
import "package:inventree/widget/history_widget.dart";
import "package:inventree/widget/progress.dart";
import "package:inventree/widget/refreshable_state.dart";
@@ -339,6 +340,16 @@ class _SupplierPartDisplayState
);
}
if (showHistory) {
tiles.add(
ShowHistoryItem(
context,
InvenTreeSupplierPart.MODEL_TYPE,
widget.supplierPart.pk,
),
);
}
ListTile? parameterTile = ShowParametersItem(
context,
InvenTreeSupplierPart.MODEL_TYPE,
+155
View File
@@ -0,0 +1,155 @@
import "package:flutter/material.dart";
import "package:flutter_tabler_icons/flutter_tabler_icons.dart";
import "package:inventree/app_colors.dart";
import "package:inventree/inventree/audit_log.dart";
import "package:inventree/inventree/model.dart";
import "package:inventree/l10.dart";
import "package:inventree/widget/link_icon.dart";
import "package:inventree/widget/paginator.dart";
import "package:inventree/widget/refreshable_state.dart";
/*
* A read-only widget for displaying the history (audit log)
* for a given model instance.
*
* Ref: https://github.com/inventree/InvenTree/pull/13069
*/
class HistoryWidget extends StatefulWidget {
const HistoryWidget(this.modelType, this.modelId, {Key? key})
: super(key: key);
final String modelType;
final int modelId;
@override
_HistoryWidgetState createState() => _HistoryWidgetState();
}
class _HistoryWidgetState extends RefreshableState<HistoryWidget> {
_HistoryWidgetState();
@override
String getAppBarTitle() => L10().history;
@override
Widget getBody(BuildContext context) {
Map<String, String> filters = {
"model_type": widget.modelType,
"model_id": widget.modelId.toString(),
};
return PaginatedHistoryList(widget.modelType, filters);
}
}
/*
* Widget which displays a paginated list of history entries
*/
class PaginatedHistoryList extends PaginatedSearchWidget {
const PaginatedHistoryList(this.modelType, Map<String, String> filters)
: super(filters: filters);
final String modelType;
@override
String get searchTitle => L10().history;
@override
_PaginatedHistoryState createState() => _PaginatedHistoryState();
}
/*
* State class for the paginated history list
*/
class _PaginatedHistoryState
extends PaginatedSearchState<PaginatedHistoryList> {
_PaginatedHistoryState() : super();
@override
String get prefix => "history_";
@override
Map<String, String> get orderingOptions => {};
@override
Map<String, Map<String, dynamic>> get filterOptions => {};
@override
Future<InvenTreePageResponse?> requestPage(
int limit,
int offset,
Map<String, String> params,
) async {
final page = await InvenTreeAuditLogEntry().listPaginated(
limit,
offset,
filters: params,
);
return page;
}
IconData _actionIcon(InvenTreeAuditLogEntry entry) {
switch (entry.action) {
case InvenTreeAuditLogEntry.ACTION_CREATE:
return TablerIcons.circle_plus;
case InvenTreeAuditLogEntry.ACTION_DELETE:
return TablerIcons.trash;
default:
return TablerIcons.edit;
}
}
@override
Widget buildItem(BuildContext context, InvenTreeModel model) {
InvenTreeAuditLogEntry entry = model as InvenTreeAuditLogEntry;
List<String> lines = [];
// Entries may also be provided for "child" objects (e.g. line items)
if (entry.modelType.split(".").last != widget.modelType) {
lines.add("${entry.modelLabel}: ${entry.objectRepr}");
}
if (entry.notes.isNotEmpty) {
lines.add(entry.notes);
}
lines.addAll(entry.changeSummary);
return ListTile(
leading: Icon(_actionIcon(entry)),
title: Text(entry.label),
subtitle: lines.isNotEmpty ? Text(lines.join("\n")) : null,
trailing: Column(
mainAxisAlignment: MainAxisAlignment.center,
crossAxisAlignment: CrossAxisAlignment.end,
children: [
Text(entry.timestampString),
if (entry.username.isNotEmpty) Text(entry.username),
],
),
);
}
}
/*
* Return a ListTile which navigates to the history for the given model instance
*/
ListTile ShowHistoryItem(BuildContext context, String modelType, int modelId) {
return ListTile(
title: Text(L10().history),
leading: Icon(TablerIcons.history, color: COLOR_ACTION),
trailing: LinkIcon(),
onTap: () {
Navigator.push(
context,
MaterialPageRoute(
builder: (context) => HistoryWidget(modelType, modelId),
),
);
},
);
}
@@ -23,6 +23,7 @@ import "package:inventree/widget/order/po_line_list.dart";
import "package:inventree/widget/attachment_widget.dart";
import "package:inventree/widget/notes_list_widget.dart";
import "package:inventree/widget/history_widget.dart";
import "package:inventree/widget/parameter_widget.dart";
import "package:inventree/widget/progress.dart";
import "package:inventree/widget/refreshable_state.dart";
@@ -570,6 +571,16 @@ class _PurchaseOrderDetailState
ShowNotesItem(context, widget.order, InvenTreePurchaseOrder.MODEL_TYPE),
);
if (showHistory) {
tiles.add(
ShowHistoryItem(
context,
InvenTreePurchaseOrder.MODEL_TYPE,
widget.order.pk,
),
);
}
ListTile? parameterTile = ShowParametersItem(
context,
InvenTreePurchaseOrder.MODEL_TYPE,
+11
View File
@@ -21,6 +21,7 @@ import "package:inventree/app_colors.dart";
import "package:inventree/widget/attachment_widget.dart";
import "package:inventree/widget/dialogs.dart";
import "package:inventree/widget/notes_list_widget.dart";
import "package:inventree/widget/history_widget.dart";
import "package:inventree/widget/snacks.dart";
import "package:inventree/widget/progress.dart";
@@ -495,6 +496,16 @@ class _SalesOrderDetailState extends RefreshableState<SalesOrderDetailWidget> {
ShowNotesItem(context, widget.order, InvenTreeSalesOrder.MODEL_TYPE),
);
if (showHistory) {
tiles.add(
ShowHistoryItem(
context,
InvenTreeSalesOrder.MODEL_TYPE,
widget.order.pk,
),
);
}
ListTile? parameterTile = ShowParametersItem(
context,
InvenTreeSalesOrder.MODEL_TYPE,
+11
View File
@@ -15,6 +15,7 @@ import "package:inventree/preferences.dart";
import "package:inventree/widget/attachment_widget.dart";
import "package:inventree/widget/link_icon.dart";
import "package:inventree/widget/notes_list_widget.dart";
import "package:inventree/widget/history_widget.dart";
import "package:inventree/widget/order/so_allocation_list.dart";
import "package:inventree/widget/refreshable_state.dart";
import "package:inventree/widget/snacks.dart";
@@ -343,6 +344,16 @@ class _SOShipmentDetailWidgetState
),
);
if (showHistory) {
tiles.add(
ShowHistoryItem(
context,
InvenTreeSalesOrderShipment.MODEL_TYPE,
widget.shipment.pk,
),
);
}
ListTile? attachmentTile = ShowAttachmentsItem(
context,
InvenTreeSalesOrderShipment.MODEL_TYPE,
@@ -13,6 +13,7 @@ import "package:inventree/inventree/transfer_order.dart";
import "package:inventree/widget/dialogs.dart";
import "package:inventree/widget/link_icon.dart";
import "package:inventree/widget/notes_list_widget.dart";
import "package:inventree/widget/history_widget.dart";
import "package:inventree/widget/order/transfer_order_line_list.dart";
import "package:inventree/widget/progress.dart";
import "package:inventree/widget/refreshable_state.dart";
@@ -409,6 +410,16 @@ class _TransferOrderDetailState
ShowNotesItem(context, widget.order, InvenTreeTransferOrder.MODEL_TYPE),
);
if (showHistory) {
tiles.add(
ShowHistoryItem(
context,
InvenTreeTransferOrder.MODEL_TYPE,
widget.order.pk,
),
);
}
return tiles;
}
+7
View File
@@ -14,6 +14,7 @@ import "package:inventree/widget/part/part_list.dart";
import "package:inventree/widget/progress.dart";
import "package:inventree/widget/snacks.dart";
import "package:inventree/widget/refreshable_state.dart";
import "package:inventree/widget/history_widget.dart";
class CategoryDisplayWidget extends StatefulWidget {
const CategoryDisplayWidget(this.category, {Key? key}) : super(key: key);
@@ -204,6 +205,12 @@ class _CategoryDisplayState extends RefreshableState<CategoryDisplayWidget> {
List<Widget> tiles = <Widget>[
getCategoryDescriptionCard(),
if (showPk && widget.category != null) pkTile(widget.category!.pk),
if (showHistory && widget.category != null)
ShowHistoryItem(
context,
InvenTreePartCategory.MODEL_TYPE,
widget.category!.pk,
),
Expanded(
child: PaginatedPartCategoryList(filters, title: L10().subcategories),
flex: 10,
+5
View File
@@ -22,6 +22,7 @@ import "package:inventree/widget/parameter_widget.dart";
import "package:inventree/widget/part/bom_list.dart";
import "package:inventree/widget/part/part_list.dart";
import "package:inventree/widget/notes_list_widget.dart";
import "package:inventree/widget/history_widget.dart";
import "package:inventree/widget/part/part_pricing.dart";
import "package:inventree/widget/progress.dart";
import "package:inventree/widget/part/category_display.dart";
@@ -727,6 +728,10 @@ class _PartDisplayState extends RefreshableState<PartDetailWidget> {
// Notes field
tiles.add(ShowNotesItem(context, part, InvenTreePart.MODEL_TYPE));
if (showHistory) {
tiles.add(ShowHistoryItem(context, InvenTreePart.MODEL_TYPE, part.pk));
}
ListTile? parameterTile = ShowParametersItem(
context,
InvenTreePart.MODEL_TYPE,
+7
View File
@@ -210,6 +210,10 @@ abstract class RefreshableState<T extends StatefulWidget> extends State<T>
// Whether to display the "pk" (primary key / ID) value of the loaded model
bool showPk = false;
// Whether to display the "history" (audit log) for the loaded model
// Requires both the app setting, and server support for the audit log
bool showHistory = false;
// Helper function to return API instance
InvenTreeAPI get api => InvenTreeAPI();
@@ -251,6 +255,9 @@ abstract class RefreshableState<T extends StatefulWidget> extends State<T>
});
showPk = await InvenTreeSettingsManager().getBool(INV_SHOW_PK, false);
showHistory =
api.supportsAuditLog &&
await InvenTreeSettingsManager().getBool(INV_SHOW_HISTORY, false);
await request(context);
+7 -25
View File
@@ -25,9 +25,9 @@ import "package:inventree/widget/link_icon.dart";
import "package:inventree/widget/progress.dart";
import "package:inventree/widget/refreshable_state.dart";
import "package:inventree/widget/snacks.dart";
import "package:inventree/widget/stock/stock_item_history.dart";
import "package:inventree/widget/stock/stock_item_test_results.dart";
import "package:inventree/widget/notes_list_widget.dart";
import "package:inventree/widget/history_widget.dart";
class StockDetailWidget extends StatefulWidget {
const StockDetailWidget(this.item, {Key? key}) : super(key: key);
@@ -44,7 +44,6 @@ class _StockItemDisplayState extends RefreshableState<StockDetailWidget> {
@override
String getAppBarTitle() => L10().stockItem;
bool stockShowHistory = false;
bool stockShowTests = true;
bool expiryEnabled = false;
@@ -205,9 +204,6 @@ class _StockItemDisplayState extends RefreshableState<StockDetailWidget> {
@override
Future<void> request(BuildContext context) async {
await api.StockStatus.load();
stockShowHistory =
await InvenTreeSettingsManager().getValue(INV_STOCK_SHOW_HISTORY, false)
as bool;
stockShowTests =
await InvenTreeSettingsManager().getValue(INV_STOCK_SHOW_TESTS, true)
as bool;
@@ -818,31 +814,17 @@ class _StockItemDisplayState extends RefreshableState<StockDetailWidget> {
// TODO - Is this stock item linked to a PurchaseOrder?
if (stockShowHistory && widget.item.trackingItemCount > 0) {
tiles.add(
ListTile(
title: Text(L10().history),
leading: Icon(TablerIcons.history, color: COLOR_ACTION),
trailing: LinkIcon(text: "${widget.item.trackingItemCount}"),
onTap: () {
Navigator.push(
context,
MaterialPageRoute(
builder: (context) => StockItemHistoryWidget(widget.item),
),
).then((ctx) {
refresh(context);
});
},
),
);
}
// Notes field
tiles.add(
ShowNotesItem(context, widget.item, InvenTreeStockItem.MODEL_TYPE),
);
if (showHistory) {
tiles.add(
ShowHistoryItem(context, InvenTreeStockItem.MODEL_TYPE, widget.item.pk),
);
}
ListTile? attachmentTile = ShowAttachmentsItem(
context,
InvenTreeStockItem.MODEL_TYPE,
-101
View File
@@ -1,101 +0,0 @@
import "package:flutter/material.dart";
import "package:inventree/api.dart";
import "package:inventree/l10.dart";
import "package:inventree/inventree/stock.dart";
import "package:inventree/inventree/model.dart";
import "package:inventree/widget/paginator.dart";
import "package:inventree/widget/refreshable_state.dart";
class StockItemHistoryWidget extends StatefulWidget {
const StockItemHistoryWidget(this.item, {Key? key}) : super(key: key);
final InvenTreeStockItem item;
@override
_StockItemHistoryDisplayState createState() =>
_StockItemHistoryDisplayState(item);
}
class _StockItemHistoryDisplayState
extends RefreshableState<StockItemHistoryWidget> {
_StockItemHistoryDisplayState(this.item);
final InvenTreeStockItem item;
@override
String getAppBarTitle() => L10().stockItemHistory;
@override
List<Widget> appBarActions(BuildContext context) => [];
@override
Widget getBody(BuildContext context) {
Map<String, String> filters = {"item": widget.item.pk.toString()};
return PaginatedStockHistoryList(filters);
}
}
/*
* Widget which displays a paginated stock history list
*/
class PaginatedStockHistoryList extends PaginatedSearchWidget {
const PaginatedStockHistoryList(Map<String, String> filters)
: super(filters: filters);
@override
String get searchTitle => L10().stockItemHistory;
@override
_PaginatedStockHistoryState createState() => _PaginatedStockHistoryState();
}
/*
* State class for the paginated stock history list
*/
class _PaginatedStockHistoryState
extends PaginatedSearchState<PaginatedStockHistoryList> {
_PaginatedStockHistoryState() : super();
@override
String get prefix => "stock_history";
@override
Map<String, String> get orderingOptions => {};
@override
Map<String, Map<String, dynamic>> get filterOptions => {
// TODO: Add filter options
};
@override
Future<InvenTreePageResponse?> requestPage(
int limit,
int offset,
Map<String, String> params,
) async {
await InvenTreeAPI().StockHistoryStatus.load();
final page = await InvenTreeStockItemHistory().listPaginated(
limit,
offset,
filters: params,
);
return page;
}
@override
Widget buildItem(BuildContext context, InvenTreeModel model) {
InvenTreeStockItemHistory entry = model as InvenTreeStockItemHistory;
return ListTile(
leading: Text(entry.dateString),
trailing: entry.userString.isNotEmpty ? Text(entry.userString) : null,
title: Text(entry.label),
subtitle: entry.notes.isNotEmpty ? Text(entry.notes) : null,
);
}
}
+71
View File
@@ -0,0 +1,71 @@
/*
* Unit tests for the InvenTreeAuditLogEntry model
*/
import "package:flutter_test/flutter_test.dart";
import "package:inventree/inventree/audit_log.dart";
void main() {
group("Audit Log:", () {
test("Label", () async {
var entry = InvenTreeAuditLogEntry.fromJson({
"action": 1,
"action_label": "Update",
"event_label": null,
});
expect(entry.label, equals("Update"));
entry = InvenTreeAuditLogEntry.fromJson({
"action": 1,
"action_label": "Update",
"event_label": "Stock counted",
});
expect(entry.label, equals("Stock counted"));
});
test("Change Summary", () async {
var entry = InvenTreeAuditLogEntry.fromJson({
"changes_detail": [
{"field": "quantity", "label": "Quantity", "old": "5", "new": "10"},
{
"field": "status",
"label": "Status",
"old": 10,
"new": 50,
"old_display": "OK",
"new_display": "Attention",
},
{"field": "name", "label": "Name", "old": null, "new": "Widget"},
{"field": "notes", "label": "Notes", "old": "None", "new": "abc"},
{
"field": "tags",
"label": "Tags",
"type": "m2m",
"operation": "add",
"objects": ["red", "blue"],
},
],
});
expect(
entry.changeSummary,
equals([
"Quantity: 5 → 10",
"Status: OK → Attention",
"Name: Widget",
"Notes: abc",
"Tags: add red, blue",
]),
);
});
test("No Changes", () async {
var entry = InvenTreeAuditLogEntry.fromJson({});
expect(entry.changes, isEmpty);
expect(entry.changeSummary, isEmpty);
});
});
}