test_usage_tracker.py 40 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037
  1. """Unit tests for the filament usage tracker.
  2. Tests 3MF-primary tracking (Path 1) and AMS remain% delta fallback
  3. (Path 2) for spools not covered by 3MF data.
  4. """
  5. from datetime import datetime, timezone
  6. from unittest.mock import AsyncMock, MagicMock, patch
  7. import pytest
  8. from backend.app.services.usage_tracker import (
  9. PrintSession,
  10. _active_sessions,
  11. _archive_colors_from_spools,
  12. _spool_color_to_hex,
  13. _track_from_3mf,
  14. on_print_complete,
  15. on_print_start,
  16. )
  17. async def _charge_in_memory(_db, spool, grams):
  18. """The fake session has no database for the tracker's UPDATE: add the
  19. grams to the mock spool, which is what these tests check. The statement
  20. itself is tested against a real database in test_usage_tracker_charge_race."""
  21. spool.weight_used = (spool.weight_used or 0) + grams
  22. spool.last_used = datetime.now(timezone.utc)
  23. return True
  24. @pytest.fixture(autouse=True)
  25. def _charge_spools_in_memory():
  26. with patch("backend.app.services.usage_tracker._charge_spool", _charge_in_memory):
  27. yield
  28. def _make_spool(*, id=1, label_weight=1000, weight_used=0, tag_uid=None, tray_uuid=None, rgba=None):
  29. """Create a mock Spool object."""
  30. spool = MagicMock()
  31. spool.id = id
  32. spool.label_weight = label_weight
  33. spool.weight_used = weight_used
  34. spool.tag_uid = tag_uid
  35. spool.tray_uuid = tray_uuid
  36. spool.last_used = None
  37. spool.cost_per_kg = None
  38. spool.material = "PLA"
  39. spool.rgba = rgba
  40. return spool
  41. def _make_assignment(*, spool_id=1, printer_id=1, ams_id=0, tray_id=0, created_at=None):
  42. """Create a mock SpoolAssignment object."""
  43. assignment = MagicMock()
  44. assignment.spool_id = spool_id
  45. assignment.printer_id = printer_id
  46. assignment.ams_id = ams_id
  47. assignment.tray_id = tray_id
  48. assignment.created_at = created_at or datetime.now(timezone.utc)
  49. return assignment
  50. def _make_printer_state(ams_data, progress=0, layer_num=0, tray_now=255):
  51. """Create a mock printer state with AMS data."""
  52. state = MagicMock()
  53. state.raw_data = {"ams": ams_data}
  54. state.progress = progress
  55. state.layer_num = layer_num
  56. state.tray_now = tray_now
  57. return state
  58. def _make_printer_manager(state=None):
  59. """Create a mock printer manager."""
  60. pm = MagicMock()
  61. pm.get_status.return_value = state
  62. return pm
  63. class TestOnPrintStart:
  64. """Tests for on_print_start — capturing AMS remain%."""
  65. @pytest.fixture(autouse=True)
  66. def _clear_sessions(self):
  67. _active_sessions.clear()
  68. yield
  69. _active_sessions.clear()
  70. @pytest.mark.asyncio
  71. async def test_creates_session_with_valid_remain(self):
  72. """Session created with remain% data for trays reporting 0-100."""
  73. ams_data = [{"id": 0, "tray": [{"id": 0, "remain": 80}]}]
  74. pm = _make_printer_manager(_make_printer_state(ams_data))
  75. await on_print_start(1, {"subtask_name": "test_print"}, pm)
  76. assert 1 in _active_sessions
  77. session = _active_sessions[1]
  78. assert session.print_name == "test_print"
  79. assert session.tray_remain_start == {(0, 0): 80}
  80. @pytest.mark.asyncio
  81. async def test_creates_session_even_without_valid_remain(self):
  82. """Session still created when remain=-1 (for 3MF fallback path)."""
  83. ams_data = [{"id": 0, "tray": [{"id": 0, "remain": -1}]}]
  84. pm = _make_printer_manager(_make_printer_state(ams_data))
  85. await on_print_start(1, {"subtask_name": "test_print"}, pm)
  86. assert 1 in _active_sessions
  87. session = _active_sessions[1]
  88. assert session.tray_remain_start == {} # Empty, no valid remain
  89. @pytest.mark.asyncio
  90. async def test_skips_without_ams_data(self):
  91. """No session created when no AMS data available."""
  92. state = MagicMock()
  93. state.raw_data = {"ams": []}
  94. pm = _make_printer_manager(state)
  95. await on_print_start(1, {"subtask_name": "test"}, pm)
  96. assert 1 not in _active_sessions
  97. class TestOnPrintCompleteAMSDelta:
  98. """Tests for Path 1: AMS remain% delta tracking."""
  99. @pytest.fixture(autouse=True)
  100. def _clear_sessions(self):
  101. _active_sessions.clear()
  102. yield
  103. _active_sessions.clear()
  104. @pytest.fixture(autouse=True)
  105. def _mock_get_setting(self):
  106. with patch(
  107. "backend.app.api.routes.settings.get_setting",
  108. new_callable=AsyncMock,
  109. return_value=None,
  110. ):
  111. yield
  112. @pytest.mark.asyncio
  113. async def test_computes_delta_and_updates_spool(self):
  114. """Spool weight_used updated by remain% delta * label_weight."""
  115. # Set up session with start remain = 80%
  116. _active_sessions[1] = PrintSession(
  117. printer_id=1,
  118. print_name="test",
  119. started_at=datetime.now(timezone.utc),
  120. tray_remain_start={(0, 0): 80},
  121. )
  122. # Current remain = 70% → 10% consumed → 100g on 1000g spool
  123. ams_data = [{"id": 0, "tray": [{"id": 0, "remain": 70}]}]
  124. pm = _make_printer_manager(_make_printer_state(ams_data))
  125. spool = _make_spool(label_weight=1000, weight_used=50)
  126. assignment = _make_assignment()
  127. db = AsyncMock()
  128. # First 2 executes → _find_3mf_by_filename (library + archive search, uses scalars().all()),
  129. # then assignment, then spool for the AMS fallback path
  130. db.execute = AsyncMock(
  131. side_effect=[
  132. MagicMock(), # _find_3mf_by_filename: library search
  133. MagicMock(), # _find_3mf_by_filename: archive search
  134. MagicMock(scalar_one_or_none=MagicMock(return_value=assignment)),
  135. MagicMock(scalar_one_or_none=MagicMock(return_value=spool)),
  136. ]
  137. )
  138. results = await on_print_complete(1, {"status": "completed"}, pm, db)
  139. assert len(results) == 1
  140. assert results[0]["weight_used"] == 100.0
  141. assert results[0]["percent_used"] == 10
  142. # weight_used should be old (50) + delta (100)
  143. assert spool.weight_used == 150.0
  144. db.commit.assert_called_once()
  145. @pytest.mark.asyncio
  146. async def test_skips_negative_delta(self):
  147. """No tracking when remain increased (spool refilled)."""
  148. _active_sessions[1] = PrintSession(
  149. printer_id=1,
  150. print_name="test",
  151. started_at=datetime.now(timezone.utc),
  152. tray_remain_start={(0, 0): 50},
  153. )
  154. # Remain went UP: 50 → 80 (refilled)
  155. ams_data = [{"id": 0, "tray": [{"id": 0, "remain": 80}]}]
  156. pm = _make_printer_manager(_make_printer_state(ams_data))
  157. db = AsyncMock()
  158. results = await on_print_complete(1, {"status": "completed"}, pm, db)
  159. assert results == []
  160. db.commit.assert_not_called()
  161. @pytest.mark.asyncio
  162. async def test_an_unloaded_tray_at_start_does_not_exclude_every_slot(self):
  163. """tray_now reads 255 at rest -- its initial value, and what an
  164. unparseable reading falls back to. Mapped as a tray id that is (255, 1),
  165. so taking it as evidence of which slots the print used would exclude
  166. every real one and charge nothing (#1820)."""
  167. _active_sessions[1] = PrintSession(
  168. printer_id=1,
  169. print_name="test",
  170. started_at=datetime.now(timezone.utc),
  171. tray_remain_start={(0, 0): 80},
  172. tray_now_at_start=255,
  173. )
  174. ams_data = [{"id": 0, "tray": [{"id": 0, "remain": 70}]}]
  175. pm = _make_printer_manager(_make_printer_state(ams_data))
  176. spool = _make_spool(label_weight=1000, weight_used=0)
  177. db = AsyncMock()
  178. db.execute = AsyncMock(
  179. side_effect=[
  180. MagicMock(), # _find_3mf_by_filename: library search
  181. MagicMock(), # _find_3mf_by_filename: archive search
  182. MagicMock(scalar_one_or_none=MagicMock(return_value=_make_assignment())),
  183. MagicMock(scalar_one_or_none=MagicMock(return_value=spool)),
  184. ]
  185. )
  186. results = await on_print_complete(1, {"status": "completed"}, pm, db)
  187. assert len(results) == 1
  188. assert results[0]["weight_used"] == 100.0
  189. @pytest.mark.asyncio
  190. async def test_a_delta_that_charges_nothing_says_so(self, caplog):
  191. """Charging nothing has to be distinguishable from having nothing to
  192. charge (#1820). A fresh spool reads 100% for its first tens of grams
  193. and the AMS estimate drifts upward on its own, so this fires on real
  194. prints, not only on refills -- and used to fire in complete silence."""
  195. import logging
  196. _active_sessions[1] = PrintSession(
  197. printer_id=1,
  198. print_name="test",
  199. started_at=datetime.now(timezone.utc),
  200. tray_remain_start={(0, 0): 100},
  201. )
  202. ams_data = [{"id": 0, "tray": [{"id": 0, "remain": 100}]}]
  203. pm = _make_printer_manager(_make_printer_state(ams_data))
  204. db = AsyncMock()
  205. with caplog.at_level(logging.INFO, logger="backend.app.services.usage_tracker"):
  206. results = await on_print_complete(1, {"status": "completed"}, pm, db)
  207. assert results == []
  208. assert "did not fall" in caplog.text
  209. assert "100% -> 100%" in caplog.text
  210. @pytest.mark.asyncio
  211. async def test_no_session_falls_through_to_3mf(self):
  212. """When no session exists, AMS delta path skipped (3MF may still run)."""
  213. pm = _make_printer_manager()
  214. db = AsyncMock()
  215. results = await on_print_complete(1, {"status": "completed"}, pm, db)
  216. assert results == []
  217. @pytest.mark.asyncio
  218. async def test_skips_fallback_for_trays_outside_print_mapping(self):
  219. """#1269: swapping a spool in an UNUSED slot mid-print must NOT charge the old spool.
  220. Reproduces maugsburger's report: single-color print on AMS0-T3
  221. (ams_mapping=[3]). User swaps spools in T1 and T2 during the print —
  222. those slots report remain=0 at completion (new spool with no tag).
  223. The fallback must skip T1 and T2 because they were never in the
  224. print's tray mapping or runtime tray_change_log.
  225. """
  226. _active_sessions[1] = PrintSession(
  227. printer_id=1,
  228. print_name="splitter",
  229. started_at=datetime.now(timezone.utc),
  230. tray_remain_start={(0, 1): 100, (0, 2): 17, (0, 3): 100},
  231. tray_now_at_start=3,
  232. ams_mapping=[3],
  233. )
  234. # User swapped T1 and T2 mid-print → both report remain=0 now.
  235. # T3 was actually used but it's also at 0 now. Without the fix the
  236. # fallback would charge the originally-assigned spools at T1 and T2.
  237. ams_data = [
  238. {
  239. "id": 0,
  240. "tray": [
  241. {"id": 1, "remain": 0},
  242. {"id": 2, "remain": 0},
  243. {"id": 3, "remain": 0},
  244. ],
  245. }
  246. ]
  247. state = _make_printer_state(ams_data, tray_now=3)
  248. state.tray_change_log = [(3, 0)] # only T3 was loaded during the print
  249. pm = _make_printer_manager(state)
  250. # Only T3 should reach the spool lookup; T1 and T2 must be filtered
  251. # out before any DB query is issued for them.
  252. t3_spool = _make_spool(id=8, label_weight=1000, weight_used=0)
  253. t3_assignment = _make_assignment(spool_id=8, ams_id=0, tray_id=3)
  254. db = AsyncMock()
  255. db.execute = AsyncMock(
  256. side_effect=[
  257. MagicMock(), # _find_3mf_by_filename: library search
  258. MagicMock(), # _find_3mf_by_filename: archive search
  259. MagicMock(scalar_one_or_none=MagicMock(return_value=t3_assignment)),
  260. MagicMock(scalar_one_or_none=MagicMock(return_value=t3_spool)),
  261. ]
  262. )
  263. results = await on_print_complete(1, {"status": "completed"}, pm, db)
  264. # Only T3 should be charged. T1 (spool 27 in the report) and T2
  265. # (spool 24) must NOT appear in the results.
  266. assert len(results) == 1
  267. assert results[0]["ams_id"] == 0
  268. assert results[0]["tray_id"] == 3
  269. class TestTrackFrom3MF:
  270. """Tests for Path 2: 3MF per-filament fallback tracking."""
  271. @pytest.mark.asyncio
  272. async def test_updates_non_bl_spool_from_3mf(self):
  273. """Non-BL spool gets weight_used from 3MF used_g for completed print."""
  274. spool = _make_spool(id=5, label_weight=1000, weight_used=100)
  275. assignment = _make_assignment(spool_id=5)
  276. archive = MagicMock()
  277. archive.file_path = "archives/test.3mf"
  278. db = AsyncMock()
  279. # archive, queue_item(None), assignment, spool
  280. db.execute = AsyncMock(
  281. side_effect=[
  282. MagicMock(scalar_one_or_none=MagicMock(return_value=archive)),
  283. MagicMock(scalar_one_or_none=MagicMock(return_value=None)),
  284. MagicMock(scalar_one_or_none=MagicMock(return_value=assignment)),
  285. MagicMock(scalar_one_or_none=MagicMock(return_value=spool)),
  286. ]
  287. )
  288. pm = _make_printer_manager(_make_printer_state([], tray_now=0))
  289. filament_usage = [{"slot_id": 1, "used_g": 25.5, "type": "PLA", "color": "#FF0000"}]
  290. with (
  291. patch("backend.app.core.config.settings") as mock_settings,
  292. patch("backend.app.utils.threemf_tools.extract_filament_usage_from_3mf", return_value=filament_usage),
  293. ):
  294. mock_path = MagicMock()
  295. mock_path.exists.return_value = True
  296. mock_settings.base_dir.__truediv__ = MagicMock(return_value=mock_path)
  297. results = await _track_from_3mf(
  298. printer_id=1,
  299. archive_id=10,
  300. status="completed",
  301. print_name="test_print",
  302. handled_trays=set(),
  303. printer_manager=pm,
  304. db=db,
  305. )
  306. assert len(results) == 1
  307. assert results[0]["spool_id"] == 5
  308. assert results[0]["weight_used"] == 25.5
  309. # weight_used = old (100) + 3MF (25.5)
  310. assert spool.weight_used == 125.5
  311. @pytest.mark.asyncio
  312. async def test_scales_by_progress_for_failed_print(self):
  313. """Failed print scales 3MF estimate by progress percentage."""
  314. spool = _make_spool(id=1, label_weight=1000, weight_used=0)
  315. assignment = _make_assignment()
  316. archive = MagicMock()
  317. archive.file_path = "archives/test.3mf"
  318. db = AsyncMock()
  319. # archive, queue_item(None), assignment, spool
  320. db.execute = AsyncMock(
  321. side_effect=[
  322. MagicMock(scalar_one_or_none=MagicMock(return_value=archive)),
  323. MagicMock(scalar_one_or_none=MagicMock(return_value=None)),
  324. MagicMock(scalar_one_or_none=MagicMock(return_value=assignment)),
  325. MagicMock(scalar_one_or_none=MagicMock(return_value=spool)),
  326. ]
  327. )
  328. # Print failed at 50% progress → 50g consumed from 100g estimate
  329. pm = _make_printer_manager(_make_printer_state([], progress=50, tray_now=0))
  330. filament_usage = [{"slot_id": 1, "used_g": 100.0, "type": "PLA", "color": ""}]
  331. with (
  332. patch("backend.app.core.config.settings") as mock_settings,
  333. patch("backend.app.utils.threemf_tools.extract_filament_usage_from_3mf", return_value=filament_usage),
  334. ):
  335. mock_path = MagicMock()
  336. mock_path.exists.return_value = True
  337. mock_settings.base_dir.__truediv__ = MagicMock(return_value=mock_path)
  338. results = await _track_from_3mf(
  339. printer_id=1,
  340. archive_id=10,
  341. status="failed",
  342. print_name="test",
  343. handled_trays=set(),
  344. printer_manager=pm,
  345. db=db,
  346. )
  347. assert len(results) == 1
  348. assert results[0]["weight_used"] == 50.0
  349. assert spool.weight_used == 50.0
  350. @pytest.mark.asyncio
  351. async def test_tracks_bl_spools_via_3mf(self):
  352. """BL spools (with tag_uid) ARE now tracked via 3MF (unified tracking)."""
  353. spool = _make_spool(tag_uid="ABCD1234", tray_uuid="A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4")
  354. assignment = _make_assignment()
  355. archive = MagicMock()
  356. archive.file_path = "archives/test.3mf"
  357. db = AsyncMock()
  358. # archive, queue_item(None), assignment, spool
  359. db.execute = AsyncMock(
  360. side_effect=[
  361. MagicMock(scalar_one_or_none=MagicMock(return_value=archive)),
  362. MagicMock(scalar_one_or_none=MagicMock(return_value=None)),
  363. MagicMock(scalar_one_or_none=MagicMock(return_value=assignment)),
  364. MagicMock(scalar_one_or_none=MagicMock(return_value=spool)),
  365. ]
  366. )
  367. pm = _make_printer_manager(_make_printer_state([], tray_now=0))
  368. filament_usage = [{"slot_id": 1, "used_g": 50.0, "type": "PLA", "color": ""}]
  369. with (
  370. patch("backend.app.core.config.settings") as mock_settings,
  371. patch("backend.app.utils.threemf_tools.extract_filament_usage_from_3mf", return_value=filament_usage),
  372. ):
  373. mock_path = MagicMock()
  374. mock_path.exists.return_value = True
  375. mock_settings.base_dir.__truediv__ = MagicMock(return_value=mock_path)
  376. results = await _track_from_3mf(
  377. printer_id=1,
  378. archive_id=10,
  379. status="completed",
  380. print_name="test",
  381. handled_trays=set(),
  382. printer_manager=pm,
  383. db=db,
  384. )
  385. assert len(results) == 1
  386. assert results[0]["spool_id"] == 1
  387. assert results[0]["weight_used"] == 50.0
  388. @pytest.mark.asyncio
  389. async def test_skips_already_handled_trays(self):
  390. """Trays handled by AMS remain% delta are not double-tracked via 3MF."""
  391. archive = MagicMock()
  392. archive.file_path = "archives/test.3mf"
  393. db = AsyncMock()
  394. # archive, queue_item(None)
  395. db.execute = AsyncMock(
  396. side_effect=[
  397. MagicMock(scalar_one_or_none=MagicMock(return_value=archive)),
  398. MagicMock(scalar_one_or_none=MagicMock(return_value=None)),
  399. ]
  400. )
  401. pm = _make_printer_manager(_make_printer_state([], tray_now=0))
  402. filament_usage = [{"slot_id": 1, "used_g": 50.0, "type": "PLA", "color": ""}]
  403. with (
  404. patch("backend.app.core.config.settings") as mock_settings,
  405. patch("backend.app.utils.threemf_tools.extract_filament_usage_from_3mf", return_value=filament_usage),
  406. ):
  407. mock_path = MagicMock()
  408. mock_path.exists.return_value = True
  409. mock_settings.base_dir.__truediv__ = MagicMock(return_value=mock_path)
  410. results = await _track_from_3mf(
  411. printer_id=1,
  412. archive_id=10,
  413. status="completed",
  414. print_name="test",
  415. handled_trays={(0, 0)}, # slot_id=1 → ams_id=0, tray_id=0
  416. printer_manager=pm,
  417. db=db,
  418. )
  419. assert results == []
  420. @pytest.mark.asyncio
  421. async def test_slot_to_tray_mapping(self):
  422. """3MF slot_id maps correctly to (ams_id, tray_id) via tray_now."""
  423. # tray_now=4 → ams_id=1, tray_id=0 (single filament uses tray_now)
  424. spool = _make_spool(id=9)
  425. assignment = _make_assignment(spool_id=9, ams_id=1, tray_id=0)
  426. archive = MagicMock()
  427. archive.file_path = "archives/test.3mf"
  428. db = AsyncMock()
  429. # archive, queue_item(None), assignment, spool
  430. db.execute = AsyncMock(
  431. side_effect=[
  432. MagicMock(scalar_one_or_none=MagicMock(return_value=archive)),
  433. MagicMock(scalar_one_or_none=MagicMock(return_value=None)),
  434. MagicMock(scalar_one_or_none=MagicMock(return_value=assignment)),
  435. MagicMock(scalar_one_or_none=MagicMock(return_value=spool)),
  436. ]
  437. )
  438. pm = _make_printer_manager(_make_printer_state([], tray_now=4))
  439. filament_usage = [{"slot_id": 5, "used_g": 30.0, "type": "PETG", "color": ""}]
  440. with (
  441. patch("backend.app.core.config.settings") as mock_settings,
  442. patch("backend.app.utils.threemf_tools.extract_filament_usage_from_3mf", return_value=filament_usage),
  443. ):
  444. mock_path = MagicMock()
  445. mock_path.exists.return_value = True
  446. mock_settings.base_dir.__truediv__ = MagicMock(return_value=mock_path)
  447. results = await _track_from_3mf(
  448. printer_id=1,
  449. archive_id=10,
  450. status="completed",
  451. print_name="test",
  452. handled_trays=set(),
  453. printer_manager=pm,
  454. db=db,
  455. )
  456. assert len(results) == 1
  457. assert results[0]["ams_id"] == 1
  458. assert results[0]["tray_id"] == 0
  459. class TestSpoolAssignmentSnapshot:
  460. """Tests for spool assignment snapshotting at print start (#459).
  461. When a spool runs empty mid-print, on_ams_change deletes the SpoolAssignment.
  462. The snapshot captured at print start ensures usage is still attributed correctly.
  463. """
  464. @pytest.fixture(autouse=True)
  465. def _clear_sessions(self):
  466. _active_sessions.clear()
  467. yield
  468. _active_sessions.clear()
  469. @pytest.fixture(autouse=True)
  470. def _mock_get_setting(self):
  471. with patch(
  472. "backend.app.api.routes.settings.get_setting",
  473. new_callable=AsyncMock,
  474. return_value=None,
  475. ):
  476. yield
  477. @pytest.mark.asyncio
  478. async def test_on_print_start_snapshots_assignments_with_db(self):
  479. """on_print_start captures spool assignments when db is provided."""
  480. ams_data = [{"id": 0, "tray": [{"id": 0, "remain": 80}, {"id": 1, "remain": 60}]}]
  481. pm = _make_printer_manager(_make_printer_state(ams_data, tray_now=0))
  482. assignment_0 = _make_assignment(spool_id=10, printer_id=1, ams_id=0, tray_id=0)
  483. assignment_1 = _make_assignment(spool_id=20, printer_id=1, ams_id=0, tray_id=1)
  484. db = AsyncMock()
  485. scalars_mock = MagicMock()
  486. scalars_mock.all.return_value = [assignment_0, assignment_1]
  487. result_mock = MagicMock()
  488. result_mock.scalars.return_value = scalars_mock
  489. db.execute = AsyncMock(return_value=result_mock)
  490. await on_print_start(1, {"subtask_name": "Benchy"}, pm, db=db)
  491. session = _active_sessions[1]
  492. assert session.spool_assignments == {(0, 0): 10, (0, 1): 20}
  493. @pytest.mark.asyncio
  494. async def test_on_print_start_empty_snapshot_without_db(self):
  495. """on_print_start creates empty snapshot when no db provided."""
  496. ams_data = [{"id": 0, "tray": [{"id": 0, "remain": 80}]}]
  497. pm = _make_printer_manager(_make_printer_state(ams_data, tray_now=0))
  498. await on_print_start(1, {"subtask_name": "Benchy"}, pm)
  499. session = _active_sessions[1]
  500. assert session.spool_assignments == {}
  501. @pytest.mark.asyncio
  502. async def test_3mf_uses_snapshot_instead_of_live_query(self):
  503. """_track_from_3mf uses snapshot spool_id without querying SpoolAssignment."""
  504. spool = _make_spool(id=42, label_weight=1000)
  505. archive = MagicMock()
  506. archive.file_path = "archives/test.3mf"
  507. # db: archive, queue_item(None), spool — NO assignment query needed
  508. db = AsyncMock()
  509. db.execute = AsyncMock(
  510. side_effect=[
  511. MagicMock(scalar_one_or_none=MagicMock(return_value=archive)),
  512. MagicMock(scalar_one_or_none=MagicMock(return_value=None)),
  513. MagicMock(scalar_one_or_none=MagicMock(return_value=spool)),
  514. ]
  515. )
  516. pm = _make_printer_manager(_make_printer_state([], tray_now=0))
  517. filament_usage = [{"slot_id": 1, "used_g": 15.0, "type": "PLA", "color": "#FF0000"}]
  518. with (
  519. patch("backend.app.core.config.settings") as mock_settings,
  520. patch("backend.app.utils.threemf_tools.extract_filament_usage_from_3mf", return_value=filament_usage),
  521. ):
  522. mock_path = MagicMock()
  523. mock_path.exists.return_value = True
  524. mock_settings.base_dir.__truediv__ = MagicMock(return_value=mock_path)
  525. results = await _track_from_3mf(
  526. printer_id=1,
  527. archive_id=10,
  528. status="completed",
  529. print_name="Test",
  530. handled_trays=set(),
  531. printer_manager=pm,
  532. db=db,
  533. spool_assignments={(0, 0): 42},
  534. )
  535. assert len(results) == 1
  536. assert results[0]["spool_id"] == 42
  537. assert results[0]["weight_used"] == 15.0
  538. @pytest.mark.asyncio
  539. async def test_3mf_falls_back_to_live_query_without_snapshot(self):
  540. """_track_from_3mf queries SpoolAssignment when no snapshot exists."""
  541. spool = _make_spool(id=5, label_weight=1000)
  542. assignment = _make_assignment(spool_id=5)
  543. archive = MagicMock()
  544. archive.file_path = "archives/test.3mf"
  545. # db: archive, queue_item(None), assignment, spool
  546. db = AsyncMock()
  547. db.execute = AsyncMock(
  548. side_effect=[
  549. MagicMock(scalar_one_or_none=MagicMock(return_value=archive)),
  550. MagicMock(scalar_one_or_none=MagicMock(return_value=None)),
  551. MagicMock(scalar_one_or_none=MagicMock(return_value=assignment)),
  552. MagicMock(scalar_one_or_none=MagicMock(return_value=spool)),
  553. ]
  554. )
  555. pm = _make_printer_manager(_make_printer_state([], tray_now=0))
  556. filament_usage = [{"slot_id": 1, "used_g": 10.0, "type": "PLA", "color": "#FF0000"}]
  557. with (
  558. patch("backend.app.core.config.settings") as mock_settings,
  559. patch("backend.app.utils.threemf_tools.extract_filament_usage_from_3mf", return_value=filament_usage),
  560. ):
  561. mock_path = MagicMock()
  562. mock_path.exists.return_value = True
  563. mock_settings.base_dir.__truediv__ = MagicMock(return_value=mock_path)
  564. results = await _track_from_3mf(
  565. printer_id=1,
  566. archive_id=10,
  567. status="completed",
  568. print_name="Test",
  569. handled_trays=set(),
  570. printer_manager=pm,
  571. db=db,
  572. spool_assignments=None,
  573. )
  574. assert len(results) == 1
  575. assert results[0]["spool_id"] == 5
  576. @pytest.mark.asyncio
  577. async def test_ams_delta_uses_snapshot_over_live_query(self):
  578. """AMS remain% fallback uses snapshot spool_id instead of live query."""
  579. spool = _make_spool(id=77, label_weight=1000)
  580. _active_sessions[1] = PrintSession(
  581. printer_id=1,
  582. print_name="Benchy",
  583. started_at=datetime.now(timezone.utc),
  584. tray_remain_start={(0, 0): 80},
  585. spool_assignments={(0, 0): 77},
  586. )
  587. # Current remain = 70% → 10% delta → 100g
  588. ams_data = [{"id": 0, "tray": [{"id": 0, "remain": 70}]}]
  589. pm = _make_printer_manager(_make_printer_state(ams_data))
  590. # First 2 executes → _find_3mf_by_filename (library + archive search),
  591. # then live assignment check (returns None), then spool lookup by snapshot spool_id
  592. db = AsyncMock()
  593. db.execute = AsyncMock(
  594. side_effect=[
  595. MagicMock(), # _find_3mf_by_filename: library search
  596. MagicMock(), # _find_3mf_by_filename: archive search
  597. MagicMock(scalar_one_or_none=MagicMock(return_value=None)), # live assignment
  598. MagicMock(scalar_one_or_none=MagicMock(return_value=spool)),
  599. ]
  600. )
  601. results = await on_print_complete(
  602. printer_id=1,
  603. data={"status": "completed"},
  604. printer_manager=pm,
  605. db=db,
  606. archive_id=None,
  607. )
  608. assert len(results) == 1
  609. assert results[0]["spool_id"] == 77
  610. assert results[0]["weight_used"] == 100.0
  611. @pytest.mark.asyncio
  612. async def test_ams_delta_falls_back_to_live_query_without_snapshot(self):
  613. """AMS remain% fallback queries SpoolAssignment when snapshot is empty."""
  614. spool = _make_spool(id=33, label_weight=1000)
  615. assignment = _make_assignment(spool_id=33)
  616. _active_sessions[1] = PrintSession(
  617. printer_id=1,
  618. print_name="Benchy",
  619. started_at=datetime.now(timezone.utc),
  620. tray_remain_start={(0, 0): 80},
  621. spool_assignments={}, # Empty snapshot (pre-upgrade session)
  622. )
  623. ams_data = [{"id": 0, "tray": [{"id": 0, "remain": 70}]}]
  624. pm = _make_printer_manager(_make_printer_state(ams_data))
  625. # First 2 executes → _find_3mf_by_filename (library + archive search),
  626. # then assignment and spool for the AMS fallback path
  627. db = AsyncMock()
  628. db.execute = AsyncMock(
  629. side_effect=[
  630. MagicMock(), # _find_3mf_by_filename: library search
  631. MagicMock(), # _find_3mf_by_filename: archive search
  632. MagicMock(scalar_one_or_none=MagicMock(return_value=assignment)),
  633. MagicMock(scalar_one_or_none=MagicMock(return_value=spool)),
  634. ]
  635. )
  636. results = await on_print_complete(
  637. printer_id=1,
  638. data={"status": "completed"},
  639. printer_manager=pm,
  640. db=db,
  641. archive_id=None,
  642. )
  643. assert len(results) == 1
  644. assert results[0]["spool_id"] == 33
  645. @pytest.mark.asyncio
  646. async def test_snapshot_survives_mid_print_unlink(self):
  647. """Core bug scenario: snapshot provides spool_id after mid-print unlink.
  648. Simulates the #459 scenario: spool runs empty mid-print, on_ams_change
  649. deletes the SpoolAssignment, but the snapshot from print start still
  650. has the spool_id so usage is correctly attributed at print completion.
  651. """
  652. spool = _make_spool(id=8, label_weight=1000, weight_used=50)
  653. archive = MagicMock()
  654. archive.file_path = "archives/big_print.3mf"
  655. # Explicit numeric so the #1344 top-up branch doesn't trip a
  656. # MagicMock-vs-float comparison.
  657. archive.filament_used_grams = 14.2
  658. # Session was created at print start WITH snapshot
  659. _active_sessions[1] = PrintSession(
  660. printer_id=1,
  661. print_name="Big Print",
  662. started_at=datetime.now(timezone.utc),
  663. tray_remain_start={(0, 0): 90},
  664. spool_assignments={(0, 0): 8}, # Snapshot from print start
  665. )
  666. pm = _make_printer_manager(
  667. _make_printer_state(
  668. [{"id": 0, "tray": [{"id": 0, "remain": 75}]}],
  669. tray_now=0,
  670. )
  671. )
  672. filament_usage = [{"slot_id": 1, "used_g": 14.2, "type": "PLA", "color": "#FF0000"}]
  673. # db: archive, queue_item(None), live assignment(None), spool,
  674. # then cost aggregation queries
  675. # NOTE: No assignment in db — it was deleted by on_ams_change mid-print!
  676. db = AsyncMock()
  677. db.execute = AsyncMock(
  678. side_effect=[
  679. MagicMock(scalar_one_or_none=MagicMock(return_value=archive)),
  680. MagicMock(scalar_one_or_none=MagicMock(return_value=None)),
  681. MagicMock(scalar_one_or_none=MagicMock(return_value=None)),
  682. MagicMock(scalar_one_or_none=MagicMock(return_value=spool)),
  683. # Cost-update block re-selects the archive to mutate cost.
  684. MagicMock(scalar_one_or_none=MagicMock(return_value=archive)),
  685. # Priced at the default rate, so it asks whether this is the
  686. # archive's first run before storing the cost.
  687. MagicMock(scalar=MagicMock(return_value=0)),
  688. ]
  689. )
  690. with (
  691. patch("backend.app.core.config.settings") as mock_settings,
  692. patch("backend.app.utils.threemf_tools.extract_filament_usage_from_3mf", return_value=filament_usage),
  693. ):
  694. mock_path = MagicMock()
  695. mock_path.exists.return_value = True
  696. mock_settings.base_dir.__truediv__ = MagicMock(return_value=mock_path)
  697. results = await on_print_complete(
  698. printer_id=1,
  699. data={"status": "completed"},
  700. printer_manager=pm,
  701. db=db,
  702. archive_id=100,
  703. )
  704. # Usage should be tracked despite assignment being deleted mid-print
  705. assert len(results) >= 1
  706. assert results[0]["spool_id"] == 8
  707. assert results[0]["weight_used"] == 14.2
  708. # Spool weight should be updated: 50 + 14.2 = 64.2
  709. assert spool.weight_used == 64.2
  710. class TestSpoolColorToHex:
  711. """`_spool_color_to_hex` normalises Spool.rgba (RRGGBBAA, no #) to #RRGGBB."""
  712. def test_strips_alpha_and_adds_hash(self):
  713. assert _spool_color_to_hex("000000FF") == "#000000"
  714. assert _spool_color_to_hex("EC984CFF") == "#EC984C"
  715. def test_uppercases(self):
  716. assert _spool_color_to_hex("ec984cff") == "#EC984C"
  717. def test_accepts_six_char_value(self):
  718. """A value with no alpha is still valid."""
  719. assert _spool_color_to_hex("161616") == "#161616"
  720. def test_tolerates_leading_hash(self):
  721. assert _spool_color_to_hex("#000000FF") == "#000000"
  722. def test_none_and_too_short_return_none(self):
  723. """Missing / malformed colour falls back to the 3MF value."""
  724. assert _spool_color_to_hex(None) is None
  725. assert _spool_color_to_hex("") is None
  726. assert _spool_color_to_hex("FFF") is None
  727. class TestArchiveColorsFromSpools:
  728. """`_archive_colors_from_spools` rebuilds an archive's filament_color from
  729. the inventory spools that fed the print (#1494). All-or-nothing: a partial
  730. match returns None so the 3MF colour is left intact."""
  731. def test_single_slot_matched(self):
  732. """The #1494 case: one used slot, matched to a #000000 spool."""
  733. usage = [{"slot_id": 1, "used_g": 15.9, "color": "#161616"}]
  734. results = [{"slot_id": 1, "color": "#000000"}]
  735. assert _archive_colors_from_spools(usage, results) == ["#000000"]
  736. def test_multi_slot_all_matched_keeps_slot_order(self):
  737. usage = [
  738. {"slot_id": 1, "used_g": 10.0, "color": "#111111"},
  739. {"slot_id": 2, "used_g": 20.0, "color": "#222222"},
  740. ]
  741. # results deliberately out of slot order — output must be slot-ordered
  742. results = [
  743. {"slot_id": 2, "color": "#00FF00"},
  744. {"slot_id": 1, "color": "#FF0000"},
  745. ]
  746. assert _archive_colors_from_spools(usage, results) == ["#FF0000", "#00FF00"]
  747. def test_duplicate_colors_deduplicated(self):
  748. """Two slots of the same spool colour collapse to one entry, as the
  749. 3MF-derived path also de-duplicates."""
  750. usage = [
  751. {"slot_id": 1, "used_g": 10.0, "color": "#111111"},
  752. {"slot_id": 2, "used_g": 20.0, "color": "#222222"},
  753. ]
  754. results = [
  755. {"slot_id": 1, "color": "#000000"},
  756. {"slot_id": 2, "color": "#000000"},
  757. ]
  758. assert _archive_colors_from_spools(usage, results) == ["#000000"]
  759. def test_partial_match_returns_none(self):
  760. """Slot 2 was used but never matched to a spool — leave the 3MF colour
  761. untouched rather than dropping slot 2 from the archive."""
  762. usage = [
  763. {"slot_id": 1, "used_g": 10.0, "color": "#111111"},
  764. {"slot_id": 2, "used_g": 20.0, "color": "#222222"},
  765. ]
  766. results = [{"slot_id": 1, "color": "#000000"}]
  767. assert _archive_colors_from_spools(usage, results) is None
  768. def test_matched_spool_without_color_returns_none(self):
  769. """A spool with no rgba (color None) does not count as matched."""
  770. usage = [{"slot_id": 1, "used_g": 15.0, "color": "#161616"}]
  771. results = [{"slot_id": 1, "color": None}]
  772. assert _archive_colors_from_spools(usage, results) is None
  773. def test_unused_slot_not_required(self):
  774. """A slot with zero usage need not be matched."""
  775. usage = [
  776. {"slot_id": 1, "used_g": 15.0, "color": "#161616"},
  777. {"slot_id": 2, "used_g": 0.0, "color": "#888888"},
  778. ]
  779. results = [{"slot_id": 1, "color": "#000000"}]
  780. assert _archive_colors_from_spools(usage, results) == ["#000000"]
  781. def test_no_used_slots_returns_none(self):
  782. assert _archive_colors_from_spools([], []) is None
  783. def test_ams_fallback_results_excluded(self):
  784. """AMS remain%-delta fallback results carry slot_id=None and must not
  785. satisfy the match for a real 3MF slot."""
  786. usage = [{"slot_id": 1, "used_g": 15.0, "color": "#161616"}]
  787. results = [{"slot_id": None, "color": "#000000"}]
  788. assert _archive_colors_from_spools(usage, results) is None
  789. class TestArchiveFilamentColorRewrite:
  790. """`_track_from_3mf` overwrites the archive's filament_color with the
  791. matched inventory spool colour at print completion (#1494)."""
  792. @pytest.mark.asyncio
  793. async def test_archive_color_adopts_spool_color(self):
  794. """A print from a #000000 inventory spool whose 3MF says #161616 ends
  795. up with the archive showing the spool's #000000."""
  796. spool = _make_spool(id=5, label_weight=1000, weight_used=100, rgba="000000FF")
  797. assignment = _make_assignment(spool_id=5)
  798. archive = MagicMock()
  799. archive.file_path = "archives/test.3mf"
  800. archive.filament_color = "#161616" # what archive.py set from the 3MF
  801. db = AsyncMock()
  802. db.execute = AsyncMock(
  803. side_effect=[
  804. MagicMock(scalar_one_or_none=MagicMock(return_value=archive)),
  805. MagicMock(scalar_one_or_none=MagicMock(return_value=None)),
  806. MagicMock(scalar_one_or_none=MagicMock(return_value=assignment)),
  807. MagicMock(scalar_one_or_none=MagicMock(return_value=spool)),
  808. ]
  809. )
  810. pm = _make_printer_manager(_make_printer_state([], tray_now=0))
  811. filament_usage = [{"slot_id": 1, "used_g": 25.5, "type": "PETG", "color": "#161616"}]
  812. with (
  813. patch("backend.app.core.config.settings") as mock_settings,
  814. patch("backend.app.utils.threemf_tools.extract_filament_usage_from_3mf", return_value=filament_usage),
  815. ):
  816. mock_path = MagicMock()
  817. mock_path.exists.return_value = True
  818. mock_settings.base_dir.__truediv__ = MagicMock(return_value=mock_path)
  819. results = await _track_from_3mf(
  820. printer_id=1,
  821. archive_id=10,
  822. status="completed",
  823. print_name="test_print",
  824. handled_trays=set(),
  825. printer_manager=pm,
  826. db=db,
  827. )
  828. assert len(results) == 1
  829. assert results[0]["color"] == "#000000"
  830. assert results[0]["slot_id"] == 1
  831. # The archive colour was rewritten from the slicer's #161616 to the
  832. # inventory spool's #000000.
  833. assert archive.filament_color == "#000000"
  834. @pytest.mark.asyncio
  835. async def test_archive_color_untouched_when_spool_has_no_color(self):
  836. """A spool with no rgba leaves the 3MF colour in place."""
  837. spool = _make_spool(id=5, label_weight=1000, weight_used=100, rgba=None)
  838. assignment = _make_assignment(spool_id=5)
  839. archive = MagicMock()
  840. archive.file_path = "archives/test.3mf"
  841. archive.filament_color = "#161616"
  842. db = AsyncMock()
  843. db.execute = AsyncMock(
  844. side_effect=[
  845. MagicMock(scalar_one_or_none=MagicMock(return_value=archive)),
  846. MagicMock(scalar_one_or_none=MagicMock(return_value=None)),
  847. MagicMock(scalar_one_or_none=MagicMock(return_value=assignment)),
  848. MagicMock(scalar_one_or_none=MagicMock(return_value=spool)),
  849. ]
  850. )
  851. pm = _make_printer_manager(_make_printer_state([], tray_now=0))
  852. filament_usage = [{"slot_id": 1, "used_g": 25.5, "type": "PETG", "color": "#161616"}]
  853. with (
  854. patch("backend.app.core.config.settings") as mock_settings,
  855. patch("backend.app.utils.threemf_tools.extract_filament_usage_from_3mf", return_value=filament_usage),
  856. ):
  857. mock_path = MagicMock()
  858. mock_path.exists.return_value = True
  859. mock_settings.base_dir.__truediv__ = MagicMock(return_value=mock_path)
  860. await _track_from_3mf(
  861. printer_id=1,
  862. archive_id=10,
  863. status="completed",
  864. print_name="test_print",
  865. handled_trays=set(),
  866. printer_manager=pm,
  867. db=db,
  868. )
  869. assert archive.filament_color == "#161616"