test_notification_service.py 117 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945
  1. """Unit tests for NotificationService.
  2. Tests event-based notifications and toggle behavior.
  3. """
  4. import json
  5. from unittest.mock import AsyncMock, MagicMock, patch
  6. import pytest
  7. from backend.app.models.notification import NotificationProvider
  8. from backend.app.services.notification_service import NotificationService
  9. class TestNotificationService:
  10. """Tests for NotificationService class."""
  11. @pytest.fixture
  12. def service(self):
  13. """Create a fresh NotificationService instance."""
  14. return NotificationService()
  15. @pytest.fixture
  16. def mock_provider(self):
  17. """Create a mock notification provider."""
  18. provider = MagicMock()
  19. provider.id = 1
  20. provider.name = "Test Provider"
  21. provider.provider_type = "webhook"
  22. provider.enabled = True
  23. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  24. provider.on_print_start = True
  25. provider.on_print_complete = True
  26. provider.on_print_failed = True
  27. provider.on_print_stopped = False
  28. provider.on_print_progress = False
  29. provider.on_printer_offline = False
  30. provider.on_printer_error = False
  31. provider.on_filament_low = False
  32. provider.on_maintenance_due = False
  33. provider.on_ams_humidity_high = False
  34. provider.on_ams_temperature_high = False
  35. provider.quiet_hours_enabled = False
  36. provider.quiet_hours_start = None
  37. provider.quiet_hours_end = None
  38. provider.daily_digest_enabled = False
  39. provider.daily_digest_time = None
  40. provider.printer_id = None
  41. return provider
  42. @pytest.fixture
  43. def mock_db(self):
  44. """Create a mock database session."""
  45. db = AsyncMock()
  46. db.commit = AsyncMock()
  47. return db
  48. # ========================================================================
  49. # Tests for on_print_start
  50. # ========================================================================
  51. @pytest.mark.asyncio
  52. async def test_on_print_start_sends_notification(self, service, mock_provider, mock_db):
  53. """Verify notification is sent when print starts."""
  54. with (
  55. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  56. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  57. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  58. ):
  59. mock_get.return_value = [mock_provider]
  60. mock_build.return_value = ("Print Started", "Test Printer: test.3mf")
  61. await service.on_print_start(
  62. printer_id=1,
  63. printer_name="Test Printer",
  64. data={"filename": "test.3mf", "subtask_name": "test"},
  65. db=mock_db,
  66. )
  67. mock_get.assert_called_once()
  68. mock_send.assert_called_once()
  69. @pytest.mark.asyncio
  70. async def test_on_print_start_skipped_when_no_providers(self, service, mock_db):
  71. """Verify no error when no providers are configured for event."""
  72. with (
  73. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  74. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  75. ):
  76. mock_get.return_value = []
  77. await service.on_print_start(
  78. printer_id=1,
  79. printer_name="Test Printer",
  80. data={},
  81. db=mock_db,
  82. )
  83. mock_send.assert_not_called()
  84. @pytest.mark.asyncio
  85. async def test_billing_charge_failure_uses_provider_event(self, service, mock_provider, mock_db):
  86. """A failed charge is routed to providers that enabled the billing event."""
  87. with (
  88. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  89. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  90. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  91. ):
  92. mock_get.return_value = [mock_provider]
  93. mock_build.return_value = ("Billing Charge Failed", "The reservation was retained")
  94. await service.on_billing_charge_failed(
  95. printer_id=7,
  96. printer_name="Printer B",
  97. filename="paid-job.3mf",
  98. archive_id=42,
  99. error="unique constraint",
  100. db=mock_db,
  101. )
  102. mock_get.assert_awaited_once_with(mock_db, "on_billing_charge_failed", 7)
  103. mock_build.assert_awaited_once_with(
  104. mock_db,
  105. "billing_charge_failed",
  106. {
  107. "printer": "Printer B",
  108. "filename": "paid-job",
  109. "archive_id": "42",
  110. "error": "unique constraint",
  111. },
  112. )
  113. assert mock_send.await_args.args[4:7] == ("billing_charge_failed", 7, "Printer B")
  114. assert mock_send.await_args.kwargs["force_immediate"] is True
  115. # ========================================================================
  116. # Tests for on_print_complete (status routing)
  117. # ========================================================================
  118. @pytest.mark.asyncio
  119. async def test_on_print_complete_routes_completed_status(self, service, mock_provider, mock_db):
  120. """Verify completed status uses on_print_complete field."""
  121. with (
  122. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  123. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  124. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  125. ):
  126. mock_get.return_value = [mock_provider]
  127. mock_build.return_value = ("Test", "Test")
  128. await service.on_print_complete(
  129. printer_id=1,
  130. printer_name="Test",
  131. status="completed",
  132. data={},
  133. db=mock_db,
  134. )
  135. # Verify the correct event field was queried
  136. call_args = mock_get.call_args
  137. assert call_args[0][1] == "on_print_complete"
  138. @pytest.mark.asyncio
  139. async def test_on_print_complete_routes_failed_status(self, service, mock_provider, mock_db):
  140. """Verify failed status uses on_print_failed field."""
  141. with (
  142. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  143. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  144. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  145. ):
  146. mock_get.return_value = [mock_provider]
  147. mock_build.return_value = ("Test", "Test")
  148. await service.on_print_complete(
  149. printer_id=1,
  150. printer_name="Test",
  151. status="failed",
  152. data={},
  153. db=mock_db,
  154. )
  155. call_args = mock_get.call_args
  156. assert call_args[0][1] == "on_print_failed"
  157. @pytest.mark.asyncio
  158. async def test_on_print_complete_routes_stopped_status(self, service, mock_provider, mock_db):
  159. """Verify stopped status uses on_print_stopped field."""
  160. with (
  161. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  162. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  163. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  164. ):
  165. mock_get.return_value = [mock_provider]
  166. mock_build.return_value = ("Test", "Test")
  167. await service.on_print_complete(
  168. printer_id=1,
  169. printer_name="Test",
  170. status="stopped",
  171. data={},
  172. db=mock_db,
  173. )
  174. call_args = mock_get.call_args
  175. assert call_args[0][1] == "on_print_stopped"
  176. @pytest.mark.asyncio
  177. async def test_on_print_complete_routes_aborted_status(self, service, mock_provider, mock_db):
  178. """Verify aborted status uses on_print_stopped field."""
  179. with (
  180. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  181. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  182. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  183. ):
  184. mock_get.return_value = [mock_provider]
  185. mock_build.return_value = ("Test", "Test")
  186. await service.on_print_complete(
  187. printer_id=1,
  188. printer_name="Test",
  189. status="aborted",
  190. data={},
  191. db=mock_db,
  192. )
  193. call_args = mock_get.call_args
  194. assert call_args[0][1] == "on_print_stopped"
  195. # ========================================================================
  196. # Tests for provider filtering
  197. # ========================================================================
  198. @pytest.mark.asyncio
  199. async def test_disabled_provider_not_returned(self, service, mock_provider, mock_db):
  200. """CRITICAL: Verify disabled providers don't receive notifications."""
  201. mock_provider.enabled = False
  202. # The actual filtering happens in _get_providers_for_event
  203. # which queries only enabled providers
  204. with patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get:
  205. # Simulate the query filtering out disabled providers
  206. mock_get.return_value = []
  207. result = await service._get_providers_for_event(mock_db, "on_print_start", printer_id=1)
  208. assert len(result) == 0
  209. @pytest.mark.asyncio
  210. async def test_provider_filtered_by_printer_id(self, service, mock_provider, mock_db):
  211. """Verify providers can be filtered by specific printer."""
  212. mock_provider.printer_id = 2 # Linked to printer 2
  213. with patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get:
  214. # When querying for printer 1, provider linked to printer 2 is excluded
  215. mock_get.return_value = []
  216. result = await service._get_providers_for_event(mock_db, "on_print_start", printer_id=1)
  217. assert len(result) == 0
  218. # ========================================================================
  219. # Tests for quiet hours
  220. # ========================================================================
  221. def test_is_in_quiet_hours_during_quiet_period(self, service, mock_provider):
  222. """Verify notifications are blocked during quiet hours."""
  223. mock_provider.quiet_hours_enabled = True
  224. mock_provider.quiet_hours_start = "22:00"
  225. mock_provider.quiet_hours_end = "07:00"
  226. with patch("backend.app.services.notification_service.datetime") as mock_datetime:
  227. # Test during quiet hours (23:00)
  228. mock_now = MagicMock()
  229. mock_now.hour = 23
  230. mock_now.minute = 0
  231. mock_datetime.now.return_value = mock_now
  232. result = service._is_in_quiet_hours(mock_provider)
  233. assert result is True
  234. def test_is_in_quiet_hours_outside_quiet_period(self, service, mock_provider):
  235. """Verify notifications are allowed outside quiet hours."""
  236. mock_provider.quiet_hours_enabled = True
  237. mock_provider.quiet_hours_start = "22:00"
  238. mock_provider.quiet_hours_end = "07:00"
  239. with patch("backend.app.services.notification_service.datetime") as mock_datetime:
  240. # Test outside quiet hours (12:00)
  241. mock_now = MagicMock()
  242. mock_now.hour = 12
  243. mock_now.minute = 0
  244. mock_datetime.now.return_value = mock_now
  245. result = service._is_in_quiet_hours(mock_provider)
  246. assert result is False
  247. def test_is_in_quiet_hours_disabled(self, service, mock_provider):
  248. """Verify quiet hours check returns False when disabled."""
  249. mock_provider.quiet_hours_enabled = False
  250. result = service._is_in_quiet_hours(mock_provider)
  251. assert result is False
  252. def test_is_in_quiet_hours_early_morning(self, service, mock_provider):
  253. """Verify quiet hours work across midnight (early morning)."""
  254. mock_provider.quiet_hours_enabled = True
  255. mock_provider.quiet_hours_start = "22:00"
  256. mock_provider.quiet_hours_end = "07:00"
  257. with patch("backend.app.services.notification_service.datetime") as mock_datetime:
  258. # Test early morning (03:00) - should be in quiet hours
  259. mock_now = MagicMock()
  260. mock_now.hour = 3
  261. mock_now.minute = 0
  262. mock_datetime.now.return_value = mock_now
  263. result = service._is_in_quiet_hours(mock_provider)
  264. assert result is True
  265. # ========================================================================
  266. # Tests for AMS alarms
  267. # ========================================================================
  268. @pytest.mark.asyncio
  269. async def test_on_ams_humidity_high_sends_notification(self, service, mock_provider, mock_db):
  270. """Verify AMS humidity alarm sends notification."""
  271. mock_provider.on_ams_humidity_high = True
  272. with (
  273. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  274. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  275. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  276. ):
  277. mock_get.return_value = [mock_provider]
  278. mock_build.return_value = ("AMS Humidity Alert", "High humidity detected")
  279. await service.on_ams_humidity_high(
  280. printer_id=1,
  281. printer_name="Test Printer",
  282. ams_label="AMS-A",
  283. humidity=75.0,
  284. threshold=60.0,
  285. db=mock_db,
  286. )
  287. mock_send.assert_called_once()
  288. # Verify force_immediate is True for alarms
  289. call_kwargs = mock_send.call_args[1]
  290. assert call_kwargs.get("force_immediate") is True
  291. @pytest.mark.asyncio
  292. async def test_on_ams_temperature_high_sends_notification(self, service, mock_provider, mock_db):
  293. """Verify AMS temperature alarm sends notification."""
  294. mock_provider.on_ams_temperature_high = True
  295. with (
  296. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  297. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  298. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  299. ):
  300. mock_get.return_value = [mock_provider]
  301. mock_build.return_value = ("AMS Temperature Alert", "High temp detected")
  302. await service.on_ams_temperature_high(
  303. printer_id=1,
  304. printer_name="Test Printer",
  305. ams_label="AMS-A",
  306. temperature=40.0,
  307. threshold=35.0,
  308. db=mock_db,
  309. )
  310. mock_send.assert_called_once()
  311. # Verify force_immediate is True for alarms
  312. call_kwargs = mock_send.call_args[1]
  313. assert call_kwargs.get("force_immediate") is True
  314. @pytest.mark.asyncio
  315. async def test_ams_alarm_skipped_when_toggle_disabled(self, service, mock_provider, mock_db):
  316. """CRITICAL: Verify AMS alarms respect toggle setting."""
  317. mock_provider.on_ams_humidity_high = False
  318. with (
  319. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  320. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  321. ):
  322. # Provider with toggle disabled won't be returned
  323. mock_get.return_value = []
  324. await service.on_ams_humidity_high(
  325. printer_id=1,
  326. printer_name="Test",
  327. ams_label="AMS-A",
  328. humidity=75.0,
  329. threshold=60.0,
  330. db=mock_db,
  331. )
  332. mock_send.assert_not_called()
  333. # ========================================================================
  334. # Tests for daily digest
  335. # ========================================================================
  336. @pytest.mark.asyncio
  337. async def test_daily_digest_queues_notification(self, service, mock_provider, mock_db):
  338. """Verify notifications are queued when digest mode is enabled."""
  339. mock_provider.daily_digest_enabled = True
  340. mock_provider.daily_digest_time = "09:00"
  341. with (
  342. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  343. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  344. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  345. ):
  346. mock_get.return_value = [mock_provider]
  347. mock_build.return_value = ("Test", "Test")
  348. await service.on_print_complete(
  349. printer_id=1,
  350. printer_name="Test",
  351. status="completed",
  352. data={},
  353. db=mock_db,
  354. )
  355. # When digest is enabled, _send_to_providers should still be called
  356. # but internally it will queue instead of send immediately
  357. mock_send.assert_called_once()
  358. @pytest.mark.asyncio
  359. async def test_force_immediate_bypasses_digest(self, service, mock_provider, mock_db):
  360. """Verify force_immediate=True bypasses digest mode."""
  361. mock_provider.daily_digest_enabled = True
  362. mock_provider.on_ams_humidity_high = True
  363. with (
  364. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  365. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  366. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  367. ):
  368. mock_get.return_value = [mock_provider]
  369. mock_build.return_value = ("Alert", "Alert message")
  370. await service.on_ams_humidity_high(
  371. printer_id=1,
  372. printer_name="Test",
  373. ams_label="AMS-A",
  374. humidity=75.0,
  375. threshold=60.0,
  376. db=mock_db,
  377. )
  378. # Verify force_immediate is passed
  379. call_kwargs = mock_send.call_args[1]
  380. assert call_kwargs.get("force_immediate") is True
  381. class TestDigestModeAlwaysSendsImmediately:
  382. """CRITICAL: Tests that notifications always send immediately regardless of digest setting."""
  383. @pytest.fixture
  384. def service(self):
  385. return NotificationService()
  386. @pytest.mark.asyncio
  387. async def test_notification_sends_immediately_even_with_digest_enabled(self, service):
  388. """CRITICAL: All notifications must be sent immediately, digest is just a summary."""
  389. # Create a mock provider with digest enabled
  390. mock_provider = MagicMock()
  391. mock_provider.id = 1
  392. mock_provider.name = "Test Provider"
  393. mock_provider.provider_type = "ntfy"
  394. mock_provider.enabled = True
  395. mock_provider.daily_digest_enabled = True # Digest enabled
  396. mock_provider.daily_digest_time = "23:59"
  397. mock_provider.config = '{"server": "https://ntfy.sh", "topic": "test"}'
  398. mock_db = AsyncMock()
  399. # Mock the _send_to_provider method
  400. with (
  401. patch.object(service, "_send_to_provider", new_callable=AsyncMock) as mock_send,
  402. patch.object(service, "_queue_for_digest", new_callable=AsyncMock) as mock_queue,
  403. patch.object(service, "_update_provider_status", new_callable=AsyncMock),
  404. patch.object(service, "_log_notification", new_callable=AsyncMock),
  405. ):
  406. mock_send.return_value = (True, None)
  407. await service._send_to_providers(
  408. providers=[mock_provider],
  409. title="Print Started",
  410. message="Your print has started",
  411. db=mock_db,
  412. event_type="print_start",
  413. )
  414. # CRITICAL: _send_to_provider MUST be called (immediate send)
  415. mock_send.assert_called_once()
  416. # Digest queue should also be called (for daily summary)
  417. mock_queue.assert_called_once()
  418. @pytest.mark.asyncio
  419. async def test_notification_sends_without_digest_queue_when_disabled(self, service):
  420. """When digest is disabled, notification sends but no digest queue."""
  421. mock_provider = MagicMock()
  422. mock_provider.id = 1
  423. mock_provider.name = "Test Provider"
  424. mock_provider.provider_type = "ntfy"
  425. mock_provider.enabled = True
  426. mock_provider.daily_digest_enabled = False # Digest disabled
  427. mock_provider.daily_digest_time = None
  428. mock_provider.config = '{"server": "https://ntfy.sh", "topic": "test"}'
  429. mock_db = AsyncMock()
  430. with (
  431. patch.object(service, "_send_to_provider", new_callable=AsyncMock) as mock_send,
  432. patch.object(service, "_queue_for_digest", new_callable=AsyncMock) as mock_queue,
  433. patch.object(service, "_update_provider_status", new_callable=AsyncMock),
  434. patch.object(service, "_log_notification", new_callable=AsyncMock),
  435. ):
  436. mock_send.return_value = (True, None)
  437. await service._send_to_providers(
  438. providers=[mock_provider],
  439. title="Print Started",
  440. message="Your print has started",
  441. db=mock_db,
  442. event_type="print_start",
  443. )
  444. # Notification must still be sent immediately
  445. mock_send.assert_called_once()
  446. # Digest queue should NOT be called when digest is disabled
  447. mock_queue.assert_not_called()
  448. class TestNotificationProviderTypes:
  449. """Tests for different notification provider types."""
  450. @pytest.fixture
  451. def service(self):
  452. return NotificationService()
  453. @pytest.mark.asyncio
  454. async def test_webhook_provider_sends_request(self, service):
  455. """Verify webhook provider sends HTTP request."""
  456. config = {
  457. "webhook_url": "http://test.local/webhook",
  458. "field_title": "title",
  459. "field_message": "message",
  460. }
  461. # Create a mock response
  462. mock_response = MagicMock()
  463. mock_response.status_code = 200
  464. # Mock the _get_client method
  465. mock_client = AsyncMock()
  466. mock_client.post = AsyncMock(return_value=mock_response)
  467. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  468. mock_get_client.return_value = mock_client
  469. success, message = await service._send_webhook(config, "Test Title", "Test Message")
  470. assert success is True
  471. mock_client.post.assert_called_once()
  472. @pytest.mark.asyncio
  473. async def test_webhook_handles_failure(self, service):
  474. """Verify webhook gracefully handles HTTP errors."""
  475. config = {
  476. "webhook_url": "http://test.local/webhook",
  477. }
  478. with patch("httpx.AsyncClient") as mock_client_class:
  479. mock_instance = AsyncMock()
  480. mock_instance.post.side_effect = Exception("Connection failed")
  481. mock_client_class.return_value.__aenter__ = AsyncMock(return_value=mock_instance)
  482. mock_client_class.return_value.__aexit__ = AsyncMock()
  483. success, message = await service._send_webhook(config, "Test", "Test")
  484. assert success is False
  485. assert "Connection failed" in message or "error" in message.lower()
  486. @pytest.mark.asyncio
  487. async def test_webhook_slack_format_sends_text_only(self, service):
  488. """Verify Slack/Mattermost format sends only text field."""
  489. config = {
  490. "webhook_url": "http://mattermost.local/hooks/abc123",
  491. "payload_format": "slack",
  492. }
  493. mock_response = MagicMock()
  494. mock_response.status_code = 200
  495. mock_client = AsyncMock()
  496. mock_client.post = AsyncMock(return_value=mock_response)
  497. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  498. mock_get_client.return_value = mock_client
  499. success, message = await service._send_webhook(config, "Test Title", "Test Message")
  500. assert success is True
  501. mock_client.post.assert_called_once()
  502. # Verify payload format is Slack-compatible
  503. call_args = mock_client.post.call_args
  504. payload = call_args.kwargs.get("json") or call_args[1].get("json")
  505. assert "text" in payload
  506. assert "*Test Title*" in payload["text"]
  507. assert "Test Message" in payload["text"]
  508. # Should NOT have generic fields
  509. assert "timestamp" not in payload
  510. assert "source" not in payload
  511. @pytest.mark.asyncio
  512. async def test_webhook_generic_format_includes_image(self, service):
  513. """Verify generic webhook includes base64-encoded image when provided."""
  514. config = {
  515. "webhook_url": "http://test.local/webhook",
  516. "field_title": "title",
  517. "field_message": "message",
  518. }
  519. mock_response = MagicMock()
  520. mock_response.status_code = 200
  521. mock_client = AsyncMock()
  522. mock_client.post = AsyncMock(return_value=mock_response)
  523. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  524. mock_get_client.return_value = mock_client
  525. image_bytes = b"\xff\xd8\xff\xe0fake-jpeg-data"
  526. success, message = await service._send_webhook(config, "Test Title", "Test Message", image_data=image_bytes)
  527. assert success is True
  528. call_args = mock_client.post.call_args
  529. payload = call_args.kwargs.get("json") or call_args[1].get("json")
  530. assert "image" in payload
  531. import base64
  532. assert payload["image"] == base64.b64encode(image_bytes).decode("ascii")
  533. @pytest.mark.asyncio
  534. async def test_webhook_generic_format_no_image_when_none(self, service):
  535. """Verify generic webhook omits image field when no image_data provided."""
  536. config = {
  537. "webhook_url": "http://test.local/webhook",
  538. "field_title": "title",
  539. "field_message": "message",
  540. }
  541. mock_response = MagicMock()
  542. mock_response.status_code = 200
  543. mock_client = AsyncMock()
  544. mock_client.post = AsyncMock(return_value=mock_response)
  545. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  546. mock_get_client.return_value = mock_client
  547. success, message = await service._send_webhook(config, "Test Title", "Test Message")
  548. assert success is True
  549. call_args = mock_client.post.call_args
  550. payload = call_args.kwargs.get("json") or call_args[1].get("json")
  551. assert "image" not in payload
  552. @pytest.mark.asyncio
  553. async def test_webhook_slack_format_excludes_image(self, service):
  554. """Verify Slack format does not include image even when provided."""
  555. config = {
  556. "webhook_url": "http://mattermost.local/hooks/abc123",
  557. "payload_format": "slack",
  558. }
  559. mock_response = MagicMock()
  560. mock_response.status_code = 200
  561. mock_client = AsyncMock()
  562. mock_client.post = AsyncMock(return_value=mock_response)
  563. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  564. mock_get_client.return_value = mock_client
  565. success, message = await service._send_webhook(
  566. config, "Test Title", "Test Message", image_data=b"fake-image"
  567. )
  568. assert success is True
  569. call_args = mock_client.post.call_args
  570. payload = call_args.kwargs.get("json") or call_args[1].get("json")
  571. assert "image" not in payload
  572. class TestDiscordProvider:
  573. """Discord webhook URL host validation (#1363)."""
  574. @pytest.fixture
  575. def service(self):
  576. return NotificationService()
  577. @pytest.mark.asyncio
  578. async def test_discord_accepts_discord_com_url(self, service):
  579. config = {"webhook_url": "https://discord.com/api/webhooks/123/abc"}
  580. mock_response = MagicMock()
  581. mock_response.status_code = 204
  582. mock_client = AsyncMock()
  583. mock_client.post = AsyncMock(return_value=mock_response)
  584. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  585. mock_get_client.return_value = mock_client
  586. success, _ = await service._send_discord(config, "Title", "Body")
  587. assert success is True
  588. mock_client.post.assert_called_once()
  589. @pytest.mark.asyncio
  590. async def test_discord_accepts_legacy_discordapp_com_url(self, service):
  591. """Discord's 'Copy Webhook URL' button emits discordapp.com URLs (#1363)."""
  592. config = {"webhook_url": "https://discordapp.com/api/webhooks/123/abc"}
  593. mock_response = MagicMock()
  594. mock_response.status_code = 204
  595. mock_client = AsyncMock()
  596. mock_client.post = AsyncMock(return_value=mock_response)
  597. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  598. mock_get_client.return_value = mock_client
  599. success, _ = await service._send_discord(config, "Title", "Body")
  600. assert success is True
  601. mock_client.post.assert_called_once()
  602. @pytest.mark.asyncio
  603. async def test_discord_rejects_non_discord_host(self, service):
  604. config = {"webhook_url": "https://evil.example.com/api/webhooks/123/abc"}
  605. success, message = await service._send_discord(config, "Title", "Body")
  606. assert success is False
  607. assert "Invalid Discord webhook URL" in message
  608. @pytest.mark.asyncio
  609. async def test_discord_rejects_empty_url(self, service):
  610. success, message = await service._send_discord({"webhook_url": ""}, "Title", "Body")
  611. assert success is False
  612. assert "required" in message.lower()
  613. class TestNtfyPriority:
  614. """Per-event ntfy Priority header (#990).
  615. The map is stored under the provider's toggle columns ("on_print_failed"),
  616. which is what the dialog builds its rows from, but every sender is called
  617. with the bare event name ("print_failed"). These tests use the bare form on
  618. purpose: the feature shipped broken because they used to pass the prefixed
  619. name straight into ``_send_ntfy``, the one spelling production never
  620. produces, so the lookup hit here and missed everywhere else (issue #3139).
  621. """
  622. @pytest.fixture
  623. def service(self):
  624. return NotificationService()
  625. @staticmethod
  626. def _mock_client(service):
  627. """Patch _get_client and return the mock client + 200 response."""
  628. mock_response = MagicMock()
  629. mock_response.status_code = 200
  630. mock_client = AsyncMock()
  631. mock_client.post = AsyncMock(return_value=mock_response)
  632. mock_client.put = AsyncMock(return_value=mock_response)
  633. return mock_client
  634. @pytest.mark.asyncio
  635. async def test_priority_header_set_for_mapped_event(self, service):
  636. """Mapped event → ntfy Priority header carries the configured value."""
  637. config = {
  638. "topic": "bambuddy",
  639. "event_priorities": {"on_print_failed": 5, "on_print_complete": 2},
  640. }
  641. mock_client = self._mock_client(service)
  642. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get:
  643. mock_get.return_value = mock_client
  644. success, _ = await service._send_ntfy(config, "Title", "Body", event_type="print_failed")
  645. assert success is True
  646. headers = mock_client.post.call_args.kwargs["headers"]
  647. assert headers.get("Priority") == "5"
  648. @pytest.mark.asyncio
  649. async def test_priority_header_set_for_bare_key(self, service):
  650. """A map keyed by the bare event name resolves too, so a config written
  651. by hand (or by any future caller that drops the prefix) still works."""
  652. config = {"topic": "bambuddy", "event_priorities": {"print_failed": 4}}
  653. mock_client = self._mock_client(service)
  654. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get:
  655. mock_get.return_value = mock_client
  656. await service._send_ntfy(config, "Title", "Body", event_type="print_failed")
  657. headers = mock_client.post.call_args.kwargs["headers"]
  658. assert headers.get("Priority") == "4"
  659. @pytest.mark.asyncio
  660. async def test_priority_header_omitted_for_unmapped_event(self, service):
  661. """Unmapped event → no Priority header so ntfy uses its server default."""
  662. config = {
  663. "topic": "bambuddy",
  664. "event_priorities": {"on_print_failed": 5},
  665. }
  666. mock_client = self._mock_client(service)
  667. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get:
  668. mock_get.return_value = mock_client
  669. await service._send_ntfy(config, "Title", "Body", event_type="print_complete")
  670. headers = mock_client.post.call_args.kwargs["headers"]
  671. assert "Priority" not in headers
  672. @pytest.mark.asyncio
  673. async def test_priority_header_omitted_when_no_priorities_set(self, service):
  674. """Existing setups (no event_priorities key) keep current behaviour."""
  675. config = {"topic": "bambuddy"}
  676. mock_client = self._mock_client(service)
  677. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get:
  678. mock_get.return_value = mock_client
  679. await service._send_ntfy(config, "Title", "Body", event_type="print_failed")
  680. headers = mock_client.post.call_args.kwargs["headers"]
  681. assert "Priority" not in headers
  682. @pytest.mark.asyncio
  683. async def test_priority_header_omitted_when_event_type_missing(self, service):
  684. """Test sends (no event_type) must not emit a Priority header."""
  685. config = {
  686. "topic": "bambuddy",
  687. "event_priorities": {"on_print_failed": 5},
  688. }
  689. mock_client = self._mock_client(service)
  690. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get:
  691. mock_get.return_value = mock_client
  692. await service._send_ntfy(config, "Title", "Body")
  693. headers = mock_client.post.call_args.kwargs["headers"]
  694. assert "Priority" not in headers
  695. @pytest.mark.asyncio
  696. async def test_priority_out_of_range_is_ignored(self, service):
  697. """Values outside 1-5 (or non-numeric) are dropped, not clamped."""
  698. for bad in (0, 6, 99, -1, "not-a-number", None):
  699. config = {
  700. "topic": "bambuddy",
  701. "event_priorities": {"on_print_failed": bad},
  702. }
  703. mock_client = self._mock_client(service)
  704. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get:
  705. mock_get.return_value = mock_client
  706. await service._send_ntfy(config, "Title", "Body", event_type="print_failed")
  707. headers = mock_client.post.call_args.kwargs["headers"]
  708. assert "Priority" not in headers, f"unexpected header for bad value {bad!r}"
  709. @pytest.mark.asyncio
  710. async def test_priority_header_set_on_attachment_path(self, service):
  711. """Image-attachment path (PUT) must also carry the Priority header."""
  712. config = {
  713. "topic": "bambuddy",
  714. "event_priorities": {"on_first_layer_complete": 4},
  715. }
  716. mock_client = self._mock_client(service)
  717. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get:
  718. mock_get.return_value = mock_client
  719. await service._send_ntfy(
  720. config,
  721. "Title",
  722. "Body",
  723. image_data=b"\xff\xd8\xff\xe0fake-jpeg",
  724. event_type="first_layer_complete",
  725. )
  726. headers = mock_client.put.call_args.kwargs["headers"]
  727. assert headers.get("Priority") == "4"
  728. @pytest.mark.asyncio
  729. async def test_priority_reaches_ntfy_from_a_real_event(self, service):
  730. """The wiring, end to end: a finished print, a provider configured the
  731. way the dialog writes it, and the header on the request that leaves.
  732. Everything above calls ``_send_ntfy`` directly, so none of it can see a
  733. caller passing a key shape the lookup does not understand -- which is
  734. exactly how #3139 shipped green.
  735. """
  736. provider = NotificationProvider(
  737. id=1,
  738. name="ntfy",
  739. provider_type="ntfy",
  740. enabled=True,
  741. config=json.dumps({"topic": "bambuddy", "event_priorities": {"on_print_complete": 5}}),
  742. quiet_hours_enabled=False,
  743. daily_digest_enabled=False,
  744. )
  745. mock_client = self._mock_client(service)
  746. mock_db = AsyncMock()
  747. with (
  748. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get,
  749. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_providers,
  750. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_template,
  751. patch.object(service, "_update_provider_status", new_callable=AsyncMock),
  752. patch.object(service, "_log_notification", new_callable=AsyncMock),
  753. ):
  754. mock_get.return_value = mock_client
  755. mock_providers.return_value = [provider]
  756. mock_template.return_value = ("Print complete", "Benchy finished")
  757. await service.on_print_complete(1, "X1C", "completed", {"filename": "benchy.3mf"}, mock_db)
  758. mock_client.post.assert_called_once()
  759. headers = mock_client.post.call_args.kwargs["headers"]
  760. assert headers.get("Priority") == "5"
  761. class TestHomeAssistantProvider:
  762. """Tests for Home Assistant notification provider."""
  763. @pytest.fixture
  764. def service(self):
  765. return NotificationService()
  766. @pytest.mark.asyncio
  767. async def test_send_homeassistant_success(self, service):
  768. """Verify HA provider sends persistent notification to correct endpoint."""
  769. mock_response = MagicMock()
  770. mock_response.status_code = 200
  771. mock_client = AsyncMock()
  772. mock_client.post = AsyncMock(return_value=mock_response)
  773. mock_db = AsyncMock()
  774. with (
  775. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client,
  776. patch(
  777. "backend.app.api.routes.settings.get_homeassistant_settings",
  778. new_callable=AsyncMock,
  779. ) as mock_ha_settings,
  780. ):
  781. mock_get_client.return_value = mock_client
  782. mock_ha_settings.return_value = {
  783. "ha_url": "http://ha.local:8123",
  784. "ha_token": "test-token-123",
  785. "ha_enabled": True,
  786. }
  787. success, message = await service._send_homeassistant({}, "Test Title", "Test Message", db=mock_db)
  788. assert success is True
  789. mock_client.post.assert_called_once()
  790. call_args = mock_client.post.call_args
  791. assert call_args[0][0] == "http://ha.local:8123/api/services/persistent_notification/create"
  792. payload = call_args.kwargs.get("json") or call_args[1].get("json")
  793. assert payload["title"] == "Test Title"
  794. assert payload["message"] == "Test Message"
  795. @pytest.mark.asyncio
  796. async def test_send_homeassistant_custom_data_merged(self, service):
  797. """Custom service-data (#1441) is forwarded as HA's nested "data" object
  798. so mobile-app push options (priority, ttl, channel, ...) reach the
  799. notify service."""
  800. mock_response = MagicMock()
  801. mock_response.status_code = 200
  802. mock_client = AsyncMock()
  803. mock_client.post = AsyncMock(return_value=mock_response)
  804. mock_db = AsyncMock()
  805. with (
  806. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client,
  807. patch(
  808. "backend.app.api.routes.settings.get_homeassistant_settings",
  809. new_callable=AsyncMock,
  810. ) as mock_ha_settings,
  811. ):
  812. mock_get_client.return_value = mock_client
  813. mock_ha_settings.return_value = {
  814. "ha_url": "http://ha.local:8123",
  815. "ha_token": "test-token-123",
  816. "ha_enabled": True,
  817. }
  818. config = {
  819. "service": "notify.mobile_app_myphone",
  820. "data": '{"priority": "high", "ttl": 0, "channel": "3D Printing"}',
  821. }
  822. success, _ = await service._send_homeassistant(config, "Title", "Body", db=mock_db)
  823. assert success is True
  824. call_args = mock_client.post.call_args
  825. assert call_args[0][0] == "http://ha.local:8123/api/services/notify/mobile_app_myphone"
  826. payload = call_args.kwargs.get("json") or call_args[1].get("json")
  827. assert payload["data"] == {"priority": "high", "ttl": 0, "channel": "3D Printing"}
  828. # ttl must survive as a number, not a string — that's why the
  829. # field is JSON rather than key=value lines.
  830. assert payload["data"]["ttl"] == 0
  831. @pytest.mark.asyncio
  832. async def test_send_homeassistant_custom_data_keeps_nested_structures(self, service):
  833. """Nested objects and lists reach the notify service unaltered (#1441).
  834. The three tests around this one all use flat scalars, which is also all
  835. the placeholder and the wiki showed — so a user asking whether action
  836. buttons work had nothing telling them the field is a verbatim
  837. pass-through rather than a key/value list. ``actions`` is the case they
  838. asked about: a list of objects, the shape an HA automation writes under
  839. ``data.actions``. Nothing between the textarea and the POST inspects the
  840. parsed value beyond "is it an object", so this asserts the whole
  841. structure rather than a key at a time.
  842. """
  843. mock_response = MagicMock()
  844. mock_response.status_code = 200
  845. mock_client = AsyncMock()
  846. mock_client.post = AsyncMock(return_value=mock_response)
  847. mock_db = AsyncMock()
  848. with (
  849. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client,
  850. patch(
  851. "backend.app.api.routes.settings.get_homeassistant_settings",
  852. new_callable=AsyncMock,
  853. ) as mock_ha_settings,
  854. ):
  855. mock_get_client.return_value = mock_client
  856. mock_ha_settings.return_value = {
  857. "ha_url": "http://ha.local:8123",
  858. "ha_token": "test-token-123",
  859. "ha_enabled": True,
  860. }
  861. actions = [
  862. {"action": "SNOOZE_PRINT_FINISHED", "title": "Snooze 20 min"},
  863. {"action": "BED_COOL_NOTIFY_ON", "title": "Notify on Bed Cool"},
  864. ]
  865. config = {
  866. "service": "notify.mobile_app_myphone",
  867. "data": json.dumps({"ttl": 0, "priority": "high", "group": "3D Printer", "actions": actions}),
  868. }
  869. success, _ = await service._send_homeassistant(config, "Print Finished", "Print is finished", db=mock_db)
  870. assert success is True
  871. payload = mock_client.post.call_args.kwargs.get("json") or mock_client.post.call_args[1].get("json")
  872. assert payload["data"] == {
  873. "ttl": 0,
  874. "priority": "high",
  875. "group": "3D Printer",
  876. "actions": actions,
  877. }
  878. # Spelled out separately: a flattening or scalar-only filter would
  879. # still leave the three sibling keys correct, so the equality above
  880. # is not on its own evidence that the list survived.
  881. assert payload["data"]["actions"] == actions
  882. @pytest.mark.asyncio
  883. async def test_send_homeassistant_without_data_omits_key(self, service):
  884. """Without configured data the payload carries no "data" key — the
  885. default persistent_notification.create schema rejects unknown keys."""
  886. mock_response = MagicMock()
  887. mock_response.status_code = 200
  888. mock_client = AsyncMock()
  889. mock_client.post = AsyncMock(return_value=mock_response)
  890. mock_db = AsyncMock()
  891. with (
  892. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client,
  893. patch(
  894. "backend.app.api.routes.settings.get_homeassistant_settings",
  895. new_callable=AsyncMock,
  896. ) as mock_ha_settings,
  897. ):
  898. mock_get_client.return_value = mock_client
  899. mock_ha_settings.return_value = {
  900. "ha_url": "http://ha.local:8123",
  901. "ha_token": "test-token-123",
  902. "ha_enabled": True,
  903. }
  904. success, _ = await service._send_homeassistant({}, "Title", "Body", db=mock_db)
  905. assert success is True
  906. payload = mock_client.post.call_args.kwargs.get("json") or mock_client.post.call_args[1].get("json")
  907. assert "data" not in payload
  908. @pytest.mark.asyncio
  909. async def test_send_homeassistant_invalid_data_rejected(self, service):
  910. """Malformed JSON and non-object JSON in the data field fail loudly
  911. instead of sending a half-built payload."""
  912. mock_db = AsyncMock()
  913. with (
  914. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client,
  915. patch(
  916. "backend.app.api.routes.settings.get_homeassistant_settings",
  917. new_callable=AsyncMock,
  918. ) as mock_ha_settings,
  919. ):
  920. mock_client = AsyncMock()
  921. mock_get_client.return_value = mock_client
  922. mock_ha_settings.return_value = {
  923. "ha_url": "http://ha.local:8123",
  924. "ha_token": "test-token-123",
  925. "ha_enabled": True,
  926. }
  927. success, message = await service._send_homeassistant(
  928. {"data": "{priority: high}"}, "Title", "Body", db=mock_db
  929. )
  930. assert success is False
  931. assert "Invalid JSON" in message
  932. success, message = await service._send_homeassistant({"data": '["a", "b"]'}, "Title", "Body", db=mock_db)
  933. assert success is False
  934. assert "JSON object" in message
  935. mock_client.post.assert_not_called()
  936. @pytest.mark.asyncio
  937. async def test_send_homeassistant_no_db_no_env(self, service):
  938. """Verify HA provider fails gracefully without DB or env vars."""
  939. with patch.dict("os.environ", {}, clear=True):
  940. success, message = await service._send_homeassistant({}, "Test", "Test", db=None)
  941. assert success is False
  942. assert "not configured" in message.lower()
  943. @pytest.mark.asyncio
  944. async def test_send_homeassistant_auth_failure(self, service):
  945. """Verify HA provider reports auth failure."""
  946. mock_response = MagicMock()
  947. mock_response.status_code = 401
  948. mock_client = AsyncMock()
  949. mock_client.post = AsyncMock(return_value=mock_response)
  950. mock_db = AsyncMock()
  951. with (
  952. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client,
  953. patch(
  954. "backend.app.api.routes.settings.get_homeassistant_settings",
  955. new_callable=AsyncMock,
  956. ) as mock_ha_settings,
  957. ):
  958. mock_get_client.return_value = mock_client
  959. mock_ha_settings.return_value = {
  960. "ha_url": "http://ha.local:8123",
  961. "ha_token": "bad-token",
  962. "ha_enabled": True,
  963. }
  964. success, message = await service._send_homeassistant({}, "Test", "Test", db=mock_db)
  965. assert success is False
  966. assert "authentication" in message.lower()
  967. @pytest.mark.asyncio
  968. async def test_send_homeassistant_env_fallback(self, service):
  969. """Verify HA provider falls back to env vars when no DB session."""
  970. mock_response = MagicMock()
  971. mock_response.status_code = 200
  972. mock_client = AsyncMock()
  973. mock_client.post = AsyncMock(return_value=mock_response)
  974. with (
  975. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client,
  976. patch.dict("os.environ", {"HA_URL": "http://env-ha:8123", "HA_TOKEN": "env-token"}),
  977. ):
  978. mock_get_client.return_value = mock_client
  979. success, message = await service._send_homeassistant({}, "Test", "Test", db=None)
  980. assert success is True
  981. call_args = mock_client.post.call_args
  982. assert "env-ha:8123" in call_args[0][0]
  983. @pytest.mark.asyncio
  984. async def test_send_homeassistant_empty_config_accepted(self, service):
  985. """Verify HA provider works with empty config dict (no fields needed)."""
  986. mock_response = MagicMock()
  987. mock_response.status_code = 200
  988. mock_client = AsyncMock()
  989. mock_client.post = AsyncMock(return_value=mock_response)
  990. mock_db = AsyncMock()
  991. with (
  992. patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client,
  993. patch(
  994. "backend.app.api.routes.settings.get_homeassistant_settings",
  995. new_callable=AsyncMock,
  996. ) as mock_ha_settings,
  997. ):
  998. mock_get_client.return_value = mock_client
  999. mock_ha_settings.return_value = {
  1000. "ha_url": "http://ha.local:8123",
  1001. "ha_token": "token",
  1002. "ha_enabled": True,
  1003. }
  1004. success, _ = await service._send_homeassistant({}, "Title", "Body", db=mock_db)
  1005. assert success is True
  1006. @pytest.mark.asyncio
  1007. async def test_send_to_provider_dispatches_homeassistant(self, service):
  1008. """Verify _send_to_provider dispatches to _send_homeassistant."""
  1009. provider = MagicMock()
  1010. provider.provider_type = "homeassistant"
  1011. provider.config = "{}"
  1012. provider.quiet_hours_enabled = False
  1013. with patch.object(service, "_send_homeassistant", new_callable=AsyncMock) as mock_send:
  1014. mock_send.return_value = (True, "OK")
  1015. success, _ = await service._send_to_provider(provider, "Title", "Message", db=AsyncMock())
  1016. assert success is True
  1017. mock_send.assert_called_once()
  1018. class TestBarkProvider:
  1019. """Bark (iOS push) provider (#1495)."""
  1020. @pytest.fixture
  1021. def service(self):
  1022. return NotificationService()
  1023. def _client_returning(self, status_code: int, json_body=None, text: str = ""):
  1024. mock_response = MagicMock()
  1025. mock_response.status_code = status_code
  1026. mock_response.text = text
  1027. if json_body is not None:
  1028. mock_response.json = MagicMock(return_value=json_body)
  1029. else:
  1030. mock_response.json = MagicMock(side_effect=ValueError("not json"))
  1031. mock_client = AsyncMock()
  1032. mock_client.post = AsyncMock(return_value=mock_response)
  1033. return mock_client
  1034. @pytest.mark.asyncio
  1035. async def test_send_bark_success_default_server(self, service):
  1036. """Minimal config posts to the official relay with device_key/title/body."""
  1037. mock_client = self._client_returning(200, {"code": 200, "message": "success"})
  1038. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  1039. mock_get_client.return_value = mock_client
  1040. success, _ = await service._send_bark({"device_key": "abc123"}, "Title", "Body")
  1041. assert success is True
  1042. call_args = mock_client.post.call_args
  1043. assert call_args[0][0] == "https://api.day.app/push"
  1044. payload = call_args.kwargs.get("json")
  1045. assert payload == {"device_key": "abc123", "title": "Title", "body": "Body"}
  1046. @pytest.mark.asyncio
  1047. async def test_send_bark_options_and_custom_server(self, service):
  1048. """group/sound/level are forwarded; an unknown level is dropped rather
  1049. than sent; a self-hosted server URL (with trailing slash) is used."""
  1050. mock_client = self._client_returning(200, {"code": 200})
  1051. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  1052. mock_get_client.return_value = mock_client
  1053. config = {
  1054. "device_key": "abc123",
  1055. "server": "https://bark.example.com/",
  1056. "group": "Bambuddy",
  1057. "sound": "minuet",
  1058. "level": "timeSensitive",
  1059. }
  1060. success, _ = await service._send_bark(config, "Title", "Body")
  1061. assert success is True
  1062. call_args = mock_client.post.call_args
  1063. assert call_args[0][0] == "https://bark.example.com/push"
  1064. payload = call_args.kwargs.get("json")
  1065. assert payload["group"] == "Bambuddy"
  1066. assert payload["sound"] == "minuet"
  1067. assert payload["level"] == "timeSensitive"
  1068. mock_client.post.reset_mock()
  1069. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  1070. mock_get_client.return_value = mock_client
  1071. await service._send_bark({"device_key": "abc123", "level": "shouty"}, "Title", "Body")
  1072. assert "level" not in mock_client.post.call_args.kwargs.get("json")
  1073. @pytest.mark.asyncio
  1074. async def test_send_bark_missing_device_key(self, service):
  1075. mock_client = self._client_returning(200, {"code": 200})
  1076. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  1077. mock_get_client.return_value = mock_client
  1078. success, message = await service._send_bark({}, "Title", "Body")
  1079. assert success is False
  1080. assert "Device key" in message
  1081. mock_client.post.assert_not_called()
  1082. @pytest.mark.asyncio
  1083. async def test_send_bark_error_in_200_body(self, service, caplog):
  1084. """bark-server can wrap a failure in HTTP 200; the body code must win.
  1085. Only the numeric code is returned — the server is caller-supplied
  1086. (bark is self-hostable), so its free-text message is the same read
  1087. channel the HTTP-failure path closes. The text goes to the debug log.
  1088. """
  1089. mock_client = self._client_returning(200, {"code": 400, "message": "device token invalid"})
  1090. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  1091. mock_get_client.return_value = mock_client
  1092. with caplog.at_level("DEBUG", logger="backend.app.services.notification_service"):
  1093. success, message = await service._send_bark({"device_key": "bad"}, "Title", "Body")
  1094. assert success is False
  1095. assert "Bark error 400" in message
  1096. assert "device token invalid" not in message
  1097. assert "device token invalid" in caplog.text
  1098. @pytest.mark.asyncio
  1099. async def test_send_bark_http_error(self, service):
  1100. mock_client = self._client_returning(400, None, text="failed to get device token")
  1101. with patch.object(service, "_get_client", new_callable=AsyncMock) as mock_get_client:
  1102. mock_get_client.return_value = mock_client
  1103. success, message = await service._send_bark({"device_key": "bad"}, "Title", "Body")
  1104. assert success is False
  1105. assert "HTTP 400" in message
  1106. @pytest.mark.asyncio
  1107. async def test_send_to_provider_dispatches_bark(self, service):
  1108. provider = MagicMock()
  1109. provider.provider_type = "bark"
  1110. provider.config = json.dumps({"device_key": "abc123"})
  1111. provider.quiet_hours_enabled = False
  1112. with patch.object(service, "_send_bark", new_callable=AsyncMock) as mock_send:
  1113. mock_send.return_value = (True, "OK")
  1114. success, _ = await service._send_to_provider(provider, "Title", "Message", db=AsyncMock())
  1115. assert success is True
  1116. mock_send.assert_called_once()
  1117. class TestNotificationVariableFallbacks:
  1118. """Tests for notification variable fallback values."""
  1119. @pytest.fixture
  1120. def service(self):
  1121. return NotificationService()
  1122. def test_format_duration_with_valid_seconds(self, service):
  1123. """Verify duration formats correctly with valid input."""
  1124. result = service._format_duration(3661) # 1h 1m 1s
  1125. assert "1h" in result
  1126. def test_format_duration_with_none_returns_unknown(self, service):
  1127. """CRITICAL: Verify None duration returns 'Unknown' fallback."""
  1128. result = service._format_duration(None)
  1129. assert result == "Unknown"
  1130. def test_format_duration_with_zero(self, service):
  1131. """Verify zero duration formats correctly."""
  1132. result = service._format_duration(0)
  1133. # Should return some valid string, not "Unknown"
  1134. assert result is not None
  1135. assert isinstance(result, str)
  1136. def test_format_duration_hours_and_minutes(self, service):
  1137. """Verify duration formats hours and minutes."""
  1138. result = service._format_duration(5400) # 1h 30m
  1139. assert "1h" in result
  1140. assert "30m" in result
  1141. def test_format_duration_minutes_only(self, service):
  1142. """Verify duration formats minutes only when < 1 hour."""
  1143. result = service._format_duration(1800) # 30m
  1144. assert "30m" in result or "30" in result
  1145. @pytest.mark.asyncio
  1146. async def test_print_complete_fallback_values(self, service):
  1147. """CRITICAL: Verify fallback values when archive_data is missing."""
  1148. mock_db = AsyncMock()
  1149. with (
  1150. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1151. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1152. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  1153. ):
  1154. mock_get.return_value = [] # No providers, just testing variable setup
  1155. mock_build.return_value = ("Test", "Test")
  1156. await service.on_print_complete(
  1157. printer_id=1,
  1158. printer_name="Test",
  1159. status="completed",
  1160. data={"subtask_name": "test_print"},
  1161. db=mock_db,
  1162. archive_data=None, # No archive data - should use fallbacks
  1163. )
  1164. # Test passes if no exception is raised with missing archive_data
  1165. @pytest.mark.asyncio
  1166. async def test_print_complete_with_archive_data(self, service):
  1167. """Verify archive data values are used when provided."""
  1168. mock_db = AsyncMock()
  1169. captured_variables = {}
  1170. async def capture_build(db, event_type, variables):
  1171. captured_variables.update(variables)
  1172. return ("Test", "Test")
  1173. with (
  1174. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1175. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1176. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1177. ):
  1178. mock_get.return_value = []
  1179. await service.on_print_complete(
  1180. printer_id=1,
  1181. printer_name="Test",
  1182. status="completed",
  1183. data={"subtask_name": "test_print"},
  1184. db=mock_db,
  1185. archive_data={
  1186. "print_time_seconds": 3600,
  1187. "actual_filament_grams": 50.5,
  1188. },
  1189. )
  1190. # When archive data is provided, duration should not be "Unknown"
  1191. if captured_variables.get("duration"):
  1192. assert captured_variables["duration"] != "Unknown"
  1193. @pytest.mark.asyncio
  1194. async def test_duration_prefers_actual_time_seconds_over_slicer_estimate(self, service):
  1195. """#1198: completion notification duration must reflect *actual* elapsed
  1196. time from started_at/completed_at, not the slicer's pre-print estimate.
  1197. Pre-fix the duration variable read from `print_time_seconds` (slicer
  1198. estimate parsed from the 3MF at archive creation), so a print cancelled
  1199. 2 minutes into a 3-hour estimate would notify "duration: 3h"."""
  1200. mock_db = AsyncMock()
  1201. mock_provider = MagicMock()
  1202. mock_provider.id = 1
  1203. captured_variables: dict = {}
  1204. async def capture_build(db, event_type, variables):
  1205. captured_variables.update(variables)
  1206. return ("Test", "Test")
  1207. with (
  1208. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1209. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1210. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1211. ):
  1212. mock_get.return_value = [mock_provider]
  1213. await service.on_print_complete(
  1214. printer_id=1,
  1215. printer_name="Test",
  1216. status="cancelled",
  1217. data={"subtask_name": "test_print"},
  1218. db=mock_db,
  1219. archive_data={
  1220. "print_time_seconds": 10800, # 3h slicer estimate
  1221. "actual_time_seconds": 120, # 2m actual elapsed
  1222. },
  1223. )
  1224. # 2 minutes — not 3 hours — even though the slicer estimate is in the dict.
  1225. assert "2m" in captured_variables["duration"]
  1226. assert "3h" not in captured_variables["duration"]
  1227. @pytest.mark.asyncio
  1228. async def test_duration_falls_back_to_slicer_estimate_when_actual_time_missing(self, service):
  1229. """#1198: when actual_time_seconds is absent (e.g. timestamps weren't
  1230. recorded for some reason), the duration variable falls back to
  1231. print_time_seconds rather than rendering 'Unknown'. Preserves
  1232. backwards-compat for any code path that didn't compute actual elapsed."""
  1233. mock_db = AsyncMock()
  1234. mock_provider = MagicMock()
  1235. mock_provider.id = 1
  1236. captured_variables: dict = {}
  1237. async def capture_build(db, event_type, variables):
  1238. captured_variables.update(variables)
  1239. return ("Test", "Test")
  1240. with (
  1241. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1242. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1243. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1244. ):
  1245. mock_get.return_value = [mock_provider]
  1246. await service.on_print_complete(
  1247. printer_id=1,
  1248. printer_name="Test",
  1249. status="completed",
  1250. data={"subtask_name": "test_print"},
  1251. db=mock_db,
  1252. archive_data={
  1253. "print_time_seconds": 3600, # 1h slicer estimate, no actual
  1254. "actual_time_seconds": None,
  1255. },
  1256. )
  1257. assert captured_variables["duration"] != "Unknown"
  1258. assert "1h" in captured_variables["duration"]
  1259. @pytest.mark.asyncio
  1260. async def test_duration_unknown_when_both_time_fields_missing(self, service):
  1261. """#1198: with neither actual nor estimated time available the duration
  1262. variable surfaces the existing 'Unknown' fallback."""
  1263. mock_db = AsyncMock()
  1264. mock_provider = MagicMock()
  1265. mock_provider.id = 1
  1266. captured_variables: dict = {}
  1267. async def capture_build(db, event_type, variables):
  1268. captured_variables.update(variables)
  1269. return ("Test", "Test")
  1270. with (
  1271. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1272. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1273. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1274. ):
  1275. mock_get.return_value = [mock_provider]
  1276. await service.on_print_complete(
  1277. printer_id=1,
  1278. printer_name="Test",
  1279. status="completed",
  1280. data={"subtask_name": "test_print"},
  1281. db=mock_db,
  1282. archive_data={
  1283. "print_time_seconds": None,
  1284. "actual_time_seconds": None,
  1285. },
  1286. )
  1287. assert captured_variables["duration"] == "Unknown"
  1288. @pytest.mark.asyncio
  1289. async def test_print_complete_with_finish_photo_url(self, service):
  1290. """Verify finish_photo_url is passed through from archive_data."""
  1291. mock_db = AsyncMock()
  1292. mock_provider = MagicMock()
  1293. mock_provider.id = 1
  1294. captured_variables = {}
  1295. async def capture_build(db, event_type, variables):
  1296. captured_variables.update(variables)
  1297. return ("Test", "Test")
  1298. with (
  1299. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1300. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1301. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1302. ):
  1303. mock_get.return_value = [mock_provider]
  1304. await service.on_print_complete(
  1305. printer_id=1,
  1306. printer_name="Test",
  1307. status="completed",
  1308. data={"subtask_name": "test_print"},
  1309. db=mock_db,
  1310. archive_data={
  1311. "print_time_seconds": 3600,
  1312. "actual_filament_grams": 50.5,
  1313. "finish_photo_url": "http://localhost:8000/api/v1/archives/1/photos/finish_test.jpg",
  1314. },
  1315. )
  1316. # finish_photo_url should be passed through to template variables
  1317. assert (
  1318. captured_variables.get("finish_photo_url")
  1319. == "http://localhost:8000/api/v1/archives/1/photos/finish_test.jpg"
  1320. )
  1321. @pytest.mark.asyncio
  1322. async def test_print_start_estimated_time_fallback(self, service):
  1323. """Verify estimated time shows 'Unknown' when not available."""
  1324. mock_db = AsyncMock()
  1325. mock_provider = MagicMock()
  1326. mock_provider.id = 1
  1327. captured_variables = {}
  1328. async def capture_build(db, event_type, variables):
  1329. captured_variables.update(variables)
  1330. return ("Test", "Test")
  1331. with (
  1332. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1333. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1334. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1335. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  1336. ):
  1337. # Need at least one provider to trigger message building
  1338. mock_get.return_value = [mock_provider]
  1339. await service.on_print_start(
  1340. printer_id=1,
  1341. printer_name="Test",
  1342. data={
  1343. "subtask_name": "test",
  1344. # No estimated_time or mc_remaining_time
  1345. },
  1346. db=mock_db,
  1347. )
  1348. # When no time data, should show "Unknown"
  1349. assert captured_variables.get("estimated_time") == "Unknown"
  1350. @pytest.mark.asyncio
  1351. async def test_print_progress_remaining_time_fallback(self, service):
  1352. """Verify remaining time shows 'Unknown' when not available."""
  1353. mock_db = AsyncMock()
  1354. mock_provider = MagicMock()
  1355. mock_provider.id = 1
  1356. captured_variables = {}
  1357. async def capture_build(db, event_type, variables):
  1358. captured_variables.update(variables)
  1359. return ("Test", "Test")
  1360. with (
  1361. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1362. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1363. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1364. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  1365. ):
  1366. # Need at least one provider to trigger message building
  1367. mock_get.return_value = [mock_provider]
  1368. await service.on_print_progress(
  1369. printer_id=1,
  1370. printer_name="Test",
  1371. progress=50,
  1372. remaining_time=None, # No remaining time
  1373. filename="test.3mf",
  1374. db=mock_db,
  1375. )
  1376. # When no remaining time, should show "Unknown"
  1377. assert captured_variables.get("remaining_time") == "Unknown"
  1378. @pytest.mark.asyncio
  1379. async def test_filename_fallback_to_unknown(self, service):
  1380. """Verify filename defaults to 'Unknown' when not provided."""
  1381. mock_db = AsyncMock()
  1382. mock_provider = MagicMock()
  1383. mock_provider.id = 1
  1384. captured_variables = {}
  1385. async def capture_build(db, event_type, variables):
  1386. captured_variables.update(variables)
  1387. return ("Test", "Test")
  1388. with (
  1389. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1390. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1391. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1392. ):
  1393. # Need at least one provider to trigger message building
  1394. mock_get.return_value = [mock_provider]
  1395. await service.on_print_complete(
  1396. printer_id=1,
  1397. printer_name="Test",
  1398. status="completed",
  1399. data={}, # No subtask_name or filename
  1400. db=mock_db,
  1401. )
  1402. # Filename should default to something (either "Unknown" or cleaned empty)
  1403. assert "filename" in captured_variables
  1404. @pytest.mark.asyncio
  1405. async def test_print_start_uses_archive_print_time_seconds(self, service):
  1406. """Verify print_time_seconds from archive_data is used for estimated_time."""
  1407. mock_db = AsyncMock()
  1408. mock_provider = MagicMock()
  1409. mock_provider.id = 1
  1410. captured_variables = {}
  1411. async def capture_build(db, event_type, variables):
  1412. captured_variables.update(variables)
  1413. return ("Test", "Test")
  1414. with (
  1415. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1416. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1417. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1418. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  1419. ):
  1420. mock_get.return_value = [mock_provider]
  1421. # Pass archive_data with print_time_seconds (7200 seconds = 2 hours)
  1422. await service.on_print_start(
  1423. printer_id=1,
  1424. printer_name="Test",
  1425. data={"subtask_name": "test"},
  1426. db=mock_db,
  1427. archive_data={"print_time_seconds": 7200},
  1428. )
  1429. # Should use archive's print_time_seconds: 7200 seconds = 2h 0m
  1430. assert captured_variables.get("estimated_time") == "2h 0m"
  1431. @pytest.mark.asyncio
  1432. async def test_print_start_archive_data_overrides_mqtt(self, service):
  1433. """Verify archive_data takes priority over MQTT remaining_time."""
  1434. mock_db = AsyncMock()
  1435. mock_provider = MagicMock()
  1436. mock_provider.id = 1
  1437. captured_variables = {}
  1438. async def capture_build(db, event_type, variables):
  1439. captured_variables.update(variables)
  1440. return ("Test", "Test")
  1441. with (
  1442. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1443. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1444. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1445. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  1446. ):
  1447. mock_get.return_value = [mock_provider]
  1448. # Both archive_data and MQTT remaining_time provided
  1449. # Archive says 2 hours, MQTT says 30 minutes (wrong at start)
  1450. await service.on_print_start(
  1451. printer_id=1,
  1452. printer_name="Test",
  1453. data={
  1454. "subtask_name": "test",
  1455. "remaining_time": 1800, # 30 minutes from MQTT
  1456. },
  1457. db=mock_db,
  1458. archive_data={"print_time_seconds": 7200}, # 2 hours from 3MF
  1459. )
  1460. # Should use archive's print_time_seconds (more reliable)
  1461. assert captured_variables.get("estimated_time") == "2h 0m"
  1462. @pytest.mark.asyncio
  1463. async def test_print_start_falls_back_to_mqtt_when_no_archive(self, service):
  1464. """Verify MQTT remaining_time is used when archive_data not provided."""
  1465. mock_db = AsyncMock()
  1466. mock_provider = MagicMock()
  1467. mock_provider.id = 1
  1468. captured_variables = {}
  1469. async def capture_build(db, event_type, variables):
  1470. captured_variables.update(variables)
  1471. return ("Test", "Test")
  1472. with (
  1473. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1474. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1475. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1476. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  1477. ):
  1478. mock_get.return_value = [mock_provider]
  1479. # Only MQTT remaining_time provided (1800 seconds = 30 minutes)
  1480. await service.on_print_start(
  1481. printer_id=1,
  1482. printer_name="Test",
  1483. data={
  1484. "subtask_name": "test",
  1485. "remaining_time": 1800,
  1486. },
  1487. db=mock_db,
  1488. # No archive_data
  1489. )
  1490. # Should use MQTT remaining_time
  1491. assert captured_variables.get("estimated_time") == "30m"
  1492. @pytest.mark.asyncio
  1493. async def test_print_start_eta_calculated_from_estimated_time(self, service):
  1494. """Verify ETA is calculated as wall-clock time from estimated_time."""
  1495. mock_db = AsyncMock()
  1496. mock_provider = MagicMock()
  1497. mock_provider.id = 1
  1498. captured_variables = {}
  1499. async def capture_build(db, event_type, variables):
  1500. captured_variables.update(variables)
  1501. return ("Test", "Test")
  1502. with (
  1503. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1504. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1505. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1506. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  1507. ):
  1508. mock_get.return_value = [mock_provider]
  1509. await service.on_print_start(
  1510. printer_id=1,
  1511. printer_name="Test",
  1512. data={"subtask_name": "test"},
  1513. db=mock_db,
  1514. archive_data={"print_time_seconds": 3600}, # 1 hour
  1515. )
  1516. # ETA should be a time string in HH:MM format
  1517. eta = captured_variables.get("eta")
  1518. assert eta is not None
  1519. assert eta != "Unknown"
  1520. assert ":" in eta # HH:MM format
  1521. @pytest.mark.asyncio
  1522. async def test_print_start_eta_unknown_when_no_time(self, service):
  1523. """Verify ETA shows 'Unknown' when no time data available."""
  1524. mock_db = AsyncMock()
  1525. mock_provider = MagicMock()
  1526. mock_provider.id = 1
  1527. captured_variables = {}
  1528. async def capture_build(db, event_type, variables):
  1529. captured_variables.update(variables)
  1530. return ("Test", "Test")
  1531. with (
  1532. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1533. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1534. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1535. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value=None),
  1536. ):
  1537. mock_get.return_value = [mock_provider]
  1538. await service.on_print_start(
  1539. printer_id=1,
  1540. printer_name="Test",
  1541. data={"subtask_name": "test"},
  1542. db=mock_db,
  1543. )
  1544. assert captured_variables.get("eta") == "Unknown"
  1545. @pytest.mark.asyncio
  1546. async def test_print_start_eta_respects_12h_format(self, service):
  1547. """Verify ETA uses 12-hour format when time_format is '12h'."""
  1548. mock_db = AsyncMock()
  1549. mock_provider = MagicMock()
  1550. mock_provider.id = 1
  1551. captured_variables = {}
  1552. async def capture_build(db, event_type, variables):
  1553. captured_variables.update(variables)
  1554. return ("Test", "Test")
  1555. with (
  1556. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1557. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1558. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1559. patch("backend.app.api.routes.settings.get_setting", new_callable=AsyncMock, return_value="12h"),
  1560. ):
  1561. mock_get.return_value = [mock_provider]
  1562. await service.on_print_start(
  1563. printer_id=1,
  1564. printer_name="Test",
  1565. data={"subtask_name": "test"},
  1566. db=mock_db,
  1567. archive_data={"print_time_seconds": 3600},
  1568. )
  1569. eta = captured_variables.get("eta")
  1570. assert eta is not None
  1571. # 12h format should contain AM or PM
  1572. assert "AM" in eta or "PM" in eta
  1573. class TestNotificationTemplates:
  1574. """Tests for notification message template rendering."""
  1575. @pytest.fixture
  1576. def service(self):
  1577. return NotificationService()
  1578. @pytest.mark.asyncio
  1579. async def test_template_renders_variables(self, service):
  1580. """Verify template variables are replaced correctly."""
  1581. template_title = "Print {progress}% Complete"
  1582. template_body = "{printer}: {filename}\nRemaining: {remaining_time}"
  1583. variables = {
  1584. "printer": "Test Printer",
  1585. "filename": "test.3mf",
  1586. "progress": "50",
  1587. "remaining_time": "1h 30m",
  1588. }
  1589. title = template_title.format(**variables)
  1590. body = template_body.format(**variables)
  1591. assert title == "Print 50% Complete"
  1592. assert "Test Printer" in body
  1593. assert "test.3mf" in body
  1594. assert "1h 30m" in body
  1595. @pytest.mark.asyncio
  1596. async def test_template_handles_missing_variables(self, service):
  1597. """Verify missing template variables don't cause crashes."""
  1598. template = "{printer}: {unknown_var}"
  1599. variables = {"printer": "Test"}
  1600. # Should handle gracefully - either leave placeholder or skip
  1601. try:
  1602. result = template.format_map({**variables, "unknown_var": "{unknown_var}"})
  1603. assert "Test" in result
  1604. except KeyError:
  1605. pytest.fail("Template should handle missing variables gracefully")
  1606. class TestPrinterErrorNotifications:
  1607. """Tests for HMS error (printer error) notifications."""
  1608. @pytest.fixture
  1609. def service(self):
  1610. return NotificationService()
  1611. @pytest.fixture
  1612. def mock_provider(self):
  1613. """Create a mock notification provider with error notifications enabled."""
  1614. provider = MagicMock()
  1615. provider.id = 1
  1616. provider.name = "Test Provider"
  1617. provider.provider_type = "webhook"
  1618. provider.enabled = True
  1619. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  1620. provider.on_printer_error = True # Enable error notifications
  1621. provider.quiet_hours_enabled = False
  1622. provider.daily_digest_enabled = False
  1623. provider.printer_id = None
  1624. return provider
  1625. @pytest.fixture
  1626. def mock_db(self):
  1627. """Create a mock database session."""
  1628. db = AsyncMock()
  1629. db.commit = AsyncMock()
  1630. return db
  1631. @pytest.mark.asyncio
  1632. async def test_on_printer_error_sends_notification(self, service, mock_provider, mock_db):
  1633. """Verify HMS error notification is sent when triggered."""
  1634. with (
  1635. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1636. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1637. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  1638. ):
  1639. mock_get.return_value = [mock_provider]
  1640. mock_build.return_value = ("Printer Error", "AMS/Filament Error: 0700_8010")
  1641. await service.on_printer_error(
  1642. printer_id=1,
  1643. printer_name="Test Printer",
  1644. error_type="AMS/Filament Error",
  1645. db=mock_db,
  1646. error_detail="Error code: 0700_8010",
  1647. )
  1648. mock_get.assert_called_once()
  1649. mock_send.assert_called_once()
  1650. @pytest.mark.asyncio
  1651. async def test_on_printer_error_skipped_when_disabled(self, service, mock_provider, mock_db):
  1652. """CRITICAL: Verify error notifications respect toggle setting."""
  1653. mock_provider.on_printer_error = False
  1654. with (
  1655. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1656. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1657. ):
  1658. # Provider with toggle disabled won't be returned
  1659. mock_get.return_value = []
  1660. await service.on_printer_error(
  1661. printer_id=1,
  1662. printer_name="Test",
  1663. error_type="AMS Error",
  1664. db=mock_db,
  1665. error_detail="Test error",
  1666. )
  1667. mock_send.assert_not_called()
  1668. @pytest.mark.asyncio
  1669. async def test_on_printer_error_includes_error_detail(self, service, mock_provider, mock_db):
  1670. """Verify error details are passed to template variables."""
  1671. captured_variables = {}
  1672. async def capture_build(db, event_type, variables):
  1673. captured_variables.update(variables)
  1674. return ("Test", "Test")
  1675. with (
  1676. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1677. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1678. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1679. ):
  1680. mock_get.return_value = [mock_provider]
  1681. await service.on_printer_error(
  1682. printer_id=1,
  1683. printer_name="X1 Carbon",
  1684. error_type="AMS/Filament Error",
  1685. db=mock_db,
  1686. error_detail="Error code: 0700_8010",
  1687. )
  1688. assert captured_variables["printer"] == "X1 Carbon"
  1689. assert captured_variables["error_type"] == "AMS/Filament Error"
  1690. assert captured_variables["error_detail"] == "Error code: 0700_8010"
  1691. @pytest.mark.asyncio
  1692. async def test_on_printer_error_fallback_when_no_detail(self, service, mock_provider, mock_db):
  1693. """Verify fallback message when error_detail is None."""
  1694. captured_variables = {}
  1695. async def capture_build(db, event_type, variables):
  1696. captured_variables.update(variables)
  1697. return ("Test", "Test")
  1698. with (
  1699. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1700. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1701. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1702. ):
  1703. mock_get.return_value = [mock_provider]
  1704. await service.on_printer_error(
  1705. printer_id=1,
  1706. printer_name="Test Printer",
  1707. error_type="Unknown Error",
  1708. db=mock_db,
  1709. error_detail=None, # No detail provided
  1710. )
  1711. assert captured_variables["error_detail"] == "No details available"
  1712. class TestAIFailureDetectionNotifications:
  1713. """Tests for the AI failure-detection event (#1794 — split out of on_printer_error).
  1714. Pins that Obico failure-detection dispatches go through the dedicated
  1715. on_ai_failure_detection event field, not the multiplexed printer-error
  1716. field. Mirrors the printer-error coverage above so a regression on either
  1717. surface fails its own case.
  1718. """
  1719. @pytest.fixture
  1720. def service(self):
  1721. return NotificationService()
  1722. @pytest.fixture
  1723. def mock_provider(self):
  1724. provider = MagicMock()
  1725. provider.id = 1
  1726. provider.name = "Test Provider"
  1727. provider.provider_type = "webhook"
  1728. provider.enabled = True
  1729. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  1730. provider.on_ai_failure_detection = True
  1731. provider.on_printer_error = False # disabled — the regression guard
  1732. provider.quiet_hours_enabled = False
  1733. provider.daily_digest_enabled = False
  1734. provider.printer_id = None
  1735. return provider
  1736. @pytest.fixture
  1737. def mock_db(self):
  1738. db = AsyncMock()
  1739. db.commit = AsyncMock()
  1740. return db
  1741. @pytest.mark.asyncio
  1742. async def test_dispatch_uses_ai_failure_detection_event_not_printer_error(self, service, mock_provider, mock_db):
  1743. """Regression guard: provider subscribed only to AI alerts must receive
  1744. the Obico notification."""
  1745. captured_event = []
  1746. async def capture(db, event_field, printer_id):
  1747. captured_event.append(event_field)
  1748. return [mock_provider]
  1749. with (
  1750. patch.object(service, "_get_providers_for_event", side_effect=capture),
  1751. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1752. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  1753. ):
  1754. mock_build.return_value = ("Possible Print Failure Detected", "details")
  1755. await service.on_ai_failure_detection(
  1756. printer_id=1,
  1757. printer_name="X1 Carbon",
  1758. task_name="benchy.3mf",
  1759. confidence=0.87,
  1760. action="notify",
  1761. db=mock_db,
  1762. )
  1763. assert captured_event == ["on_ai_failure_detection"]
  1764. mock_send.assert_called_once()
  1765. @pytest.mark.asyncio
  1766. async def test_skipped_when_only_printer_error_is_enabled(self, service, mock_provider, mock_db):
  1767. """Pre-#1794 behaviour MUST NOT survive: a provider with only the
  1768. legacy on_printer_error toggle should NOT receive AI notifications now."""
  1769. mock_provider.on_ai_failure_detection = False
  1770. mock_provider.on_printer_error = True
  1771. with (
  1772. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1773. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1774. ):
  1775. mock_get.return_value = [] # the event-field filter excludes the provider
  1776. await service.on_ai_failure_detection(
  1777. printer_id=1,
  1778. printer_name="X1 Carbon",
  1779. task_name="benchy.3mf",
  1780. confidence=0.87,
  1781. action="notify",
  1782. db=mock_db,
  1783. )
  1784. mock_send.assert_not_called()
  1785. @pytest.mark.asyncio
  1786. async def test_variables_include_task_name_confidence_action(self, service, mock_provider, mock_db):
  1787. captured_variables = {}
  1788. async def capture_build(db, event_type, variables):
  1789. captured_variables.update(variables)
  1790. return ("Test", "Test")
  1791. with (
  1792. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1793. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1794. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1795. ):
  1796. mock_get.return_value = [mock_provider]
  1797. await service.on_ai_failure_detection(
  1798. printer_id=1,
  1799. printer_name="X1 Carbon",
  1800. task_name="benchy.3mf",
  1801. confidence=0.873,
  1802. action="pause_and_off",
  1803. db=mock_db,
  1804. )
  1805. assert captured_variables["printer"] == "X1 Carbon"
  1806. assert captured_variables["task_name"] == "benchy.3mf"
  1807. assert captured_variables["confidence"] == "0.87" # 2-decimal format
  1808. assert captured_variables["action"] == "pause_and_off"
  1809. @pytest.mark.asyncio
  1810. async def test_task_name_fallback_when_unknown(self, service, mock_provider, mock_db):
  1811. captured_variables = {}
  1812. async def capture_build(db, event_type, variables):
  1813. captured_variables.update(variables)
  1814. return ("Test", "Test")
  1815. with (
  1816. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1817. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1818. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1819. ):
  1820. mock_get.return_value = [mock_provider]
  1821. await service.on_ai_failure_detection(
  1822. printer_id=1,
  1823. printer_name="Test",
  1824. task_name="", # empty
  1825. confidence=0.5,
  1826. action="notify",
  1827. db=mock_db,
  1828. )
  1829. assert captured_variables["task_name"] == "current job"
  1830. class TestPlateNotEmptyNotifications:
  1831. """Tests for plate not empty (build plate detection) notifications."""
  1832. @pytest.fixture
  1833. def service(self):
  1834. return NotificationService()
  1835. @pytest.fixture
  1836. def mock_provider(self):
  1837. """Create a mock notification provider with plate detection enabled."""
  1838. provider = MagicMock()
  1839. provider.id = 1
  1840. provider.name = "Test Provider"
  1841. provider.provider_type = "webhook"
  1842. provider.enabled = True
  1843. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  1844. provider.on_plate_not_empty = True
  1845. provider.quiet_hours_enabled = False
  1846. provider.daily_digest_enabled = False
  1847. provider.printer_id = None
  1848. return provider
  1849. @pytest.fixture
  1850. def mock_db(self):
  1851. """Create a mock database session."""
  1852. db = AsyncMock()
  1853. db.commit = AsyncMock()
  1854. return db
  1855. @pytest.mark.asyncio
  1856. async def test_on_plate_not_empty_sends_notification(self, service, mock_provider, mock_db):
  1857. """Verify plate not empty notification is sent when triggered."""
  1858. with (
  1859. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1860. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1861. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  1862. ):
  1863. mock_get.return_value = [mock_provider]
  1864. mock_build.return_value = ("Plate Not Empty", "Objects detected on build plate")
  1865. await service.on_plate_not_empty(
  1866. printer_id=1,
  1867. printer_name="Test Printer",
  1868. db=mock_db,
  1869. difference_percent=5.2,
  1870. )
  1871. mock_get.assert_called_once()
  1872. mock_send.assert_called_once()
  1873. # Verify force_immediate is True (critical alert)
  1874. call_kwargs = mock_send.call_args[1]
  1875. assert call_kwargs.get("force_immediate") is True
  1876. @pytest.mark.asyncio
  1877. async def test_on_plate_not_empty_skipped_when_disabled(self, service, mock_provider, mock_db):
  1878. """Verify notification is skipped when toggle is disabled."""
  1879. mock_provider.on_plate_not_empty = False
  1880. with (
  1881. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1882. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1883. ):
  1884. mock_get.return_value = []
  1885. await service.on_plate_not_empty(
  1886. printer_id=1,
  1887. printer_name="Test",
  1888. db=mock_db,
  1889. )
  1890. mock_send.assert_not_called()
  1891. @pytest.mark.asyncio
  1892. async def test_on_plate_not_empty_includes_difference_percent(self, service, mock_provider, mock_db):
  1893. """Verify difference percentage is passed to template variables."""
  1894. captured_variables = {}
  1895. async def capture_build(db, event_type, variables):
  1896. captured_variables.update(variables)
  1897. return ("Test", "Test")
  1898. with (
  1899. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1900. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1901. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1902. ):
  1903. mock_get.return_value = [mock_provider]
  1904. await service.on_plate_not_empty(
  1905. printer_id=1,
  1906. printer_name="X1 Carbon",
  1907. db=mock_db,
  1908. difference_percent=3.5,
  1909. )
  1910. assert captured_variables["printer"] == "X1 Carbon"
  1911. assert captured_variables["difference_percent"] == "3.5"
  1912. class TestBedCooledNotifications:
  1913. """Tests for bed cooled (after print) notifications."""
  1914. @pytest.fixture
  1915. def service(self):
  1916. return NotificationService()
  1917. @pytest.fixture
  1918. def mock_provider(self):
  1919. """Create a mock notification provider with bed cooled enabled."""
  1920. provider = MagicMock()
  1921. provider.id = 1
  1922. provider.name = "Test Provider"
  1923. provider.provider_type = "webhook"
  1924. provider.enabled = True
  1925. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  1926. provider.on_bed_cooled = True
  1927. provider.quiet_hours_enabled = False
  1928. provider.daily_digest_enabled = False
  1929. provider.printer_id = None
  1930. return provider
  1931. @pytest.fixture
  1932. def mock_db(self):
  1933. """Create a mock database session."""
  1934. db = AsyncMock()
  1935. db.commit = AsyncMock()
  1936. return db
  1937. @pytest.mark.asyncio
  1938. async def test_on_bed_cooled_sends_notification(self, service, mock_provider, mock_db):
  1939. """Verify bed cooled notification is sent when triggered."""
  1940. with (
  1941. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1942. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1943. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  1944. ):
  1945. mock_get.return_value = [mock_provider]
  1946. mock_build.return_value = ("Bed Cooled", "Test Printer: Bed cooled to 30°C")
  1947. await service.on_bed_cooled(
  1948. printer_id=1,
  1949. printer_name="Test Printer",
  1950. bed_temp=30.0,
  1951. threshold=35.0,
  1952. filename="benchy.3mf",
  1953. db=mock_db,
  1954. )
  1955. mock_get.assert_called_once()
  1956. mock_send.assert_called_once()
  1957. @pytest.mark.asyncio
  1958. async def test_on_bed_cooled_skipped_when_no_providers(self, service, mock_db):
  1959. """Verify notification is skipped when no providers have bed cooled enabled."""
  1960. with (
  1961. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1962. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  1963. ):
  1964. mock_get.return_value = []
  1965. await service.on_bed_cooled(
  1966. printer_id=1,
  1967. printer_name="Test Printer",
  1968. bed_temp=30.0,
  1969. threshold=35.0,
  1970. filename="benchy.3mf",
  1971. db=mock_db,
  1972. )
  1973. mock_send.assert_not_called()
  1974. @pytest.mark.asyncio
  1975. async def test_on_bed_cooled_includes_correct_variables(self, service, mock_provider, mock_db):
  1976. """Verify bed temp, threshold, and filename are passed to template variables."""
  1977. captured_variables = {}
  1978. async def capture_build(db, event_type, variables):
  1979. captured_variables.update(variables)
  1980. return ("Test", "Test")
  1981. with (
  1982. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  1983. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  1984. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  1985. ):
  1986. mock_get.return_value = [mock_provider]
  1987. await service.on_bed_cooled(
  1988. printer_id=1,
  1989. printer_name="X1 Carbon",
  1990. bed_temp=28.7,
  1991. threshold=35.0,
  1992. filename="benchy.gcode.3mf",
  1993. db=mock_db,
  1994. )
  1995. assert captured_variables["printer"] == "X1 Carbon"
  1996. assert captured_variables["bed_temp"] == "29"
  1997. assert captured_variables["threshold"] == "35"
  1998. assert captured_variables["filename"] == "benchy"
  1999. @pytest.mark.asyncio
  2000. async def test_on_bed_cooled_handles_none_filename(self, service, mock_provider, mock_db):
  2001. """Verify None filename is handled gracefully."""
  2002. captured_variables = {}
  2003. async def capture_build(db, event_type, variables):
  2004. captured_variables.update(variables)
  2005. return ("Test", "Test")
  2006. with (
  2007. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  2008. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  2009. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  2010. ):
  2011. mock_get.return_value = [mock_provider]
  2012. await service.on_bed_cooled(
  2013. printer_id=1,
  2014. printer_name="Test Printer",
  2015. bed_temp=30.0,
  2016. threshold=35.0,
  2017. filename=None,
  2018. db=mock_db,
  2019. )
  2020. assert captured_variables["filename"] == "Unknown"
  2021. class TestFirstLayerCompleteNotifications:
  2022. """Tests for first layer complete notifications."""
  2023. @pytest.fixture
  2024. def service(self):
  2025. return NotificationService()
  2026. @pytest.fixture
  2027. def mock_provider(self):
  2028. """Create a mock notification provider with first layer complete enabled."""
  2029. provider = MagicMock()
  2030. provider.id = 1
  2031. provider.name = "Test Provider"
  2032. provider.provider_type = "webhook"
  2033. provider.enabled = True
  2034. provider.config = json.dumps({"webhook_url": "http://test.local/webhook"})
  2035. provider.on_first_layer_complete = True
  2036. provider.quiet_hours_enabled = False
  2037. provider.daily_digest_enabled = False
  2038. provider.printer_id = None
  2039. return provider
  2040. @pytest.fixture
  2041. def mock_db(self):
  2042. """Create a mock database session."""
  2043. db = AsyncMock()
  2044. db.commit = AsyncMock()
  2045. return db
  2046. @pytest.mark.asyncio
  2047. async def test_on_first_layer_complete_sends_notification(self, service, mock_provider, mock_db):
  2048. """Verify first layer complete notification is sent when triggered."""
  2049. with (
  2050. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  2051. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  2052. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  2053. ):
  2054. mock_get.return_value = [mock_provider]
  2055. mock_build.return_value = ("First Layer Complete", "Test Printer: benchy.3mf")
  2056. await service.on_first_layer_complete(
  2057. printer_id=1,
  2058. printer_name="Test Printer",
  2059. filename="benchy.3mf",
  2060. total_layers=50,
  2061. db=mock_db,
  2062. )
  2063. mock_get.assert_called_once()
  2064. mock_send.assert_called_once()
  2065. @pytest.mark.asyncio
  2066. async def test_on_first_layer_complete_skipped_when_no_providers(self, service, mock_db):
  2067. """Verify notification is skipped when no providers have first layer complete enabled."""
  2068. with (
  2069. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  2070. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  2071. ):
  2072. mock_get.return_value = []
  2073. await service.on_first_layer_complete(
  2074. printer_id=1,
  2075. printer_name="Test Printer",
  2076. filename="benchy.3mf",
  2077. total_layers=50,
  2078. db=mock_db,
  2079. )
  2080. mock_send.assert_not_called()
  2081. @pytest.mark.asyncio
  2082. async def test_on_first_layer_complete_includes_correct_variables(self, service, mock_provider, mock_db):
  2083. """Verify printer name, filename, and total_layers are passed to template variables."""
  2084. captured_variables = {}
  2085. async def capture_build(db, event_type, variables):
  2086. captured_variables.update(variables)
  2087. return ("Test", "Test")
  2088. with (
  2089. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  2090. patch.object(service, "_send_to_providers", new_callable=AsyncMock),
  2091. patch.object(service, "_build_message_from_template", side_effect=capture_build),
  2092. ):
  2093. mock_get.return_value = [mock_provider]
  2094. await service.on_first_layer_complete(
  2095. printer_id=1,
  2096. printer_name="X1 Carbon",
  2097. filename="benchy.gcode.3mf",
  2098. total_layers=120,
  2099. db=mock_db,
  2100. )
  2101. assert captured_variables["printer"] == "X1 Carbon"
  2102. assert captured_variables["filename"] == "benchy"
  2103. assert captured_variables["total_layers"] == "120"
  2104. @pytest.mark.asyncio
  2105. async def test_on_first_layer_complete_passes_image_data(self, service, mock_provider, mock_db):
  2106. """Verify image_data is passed through to _send_to_providers."""
  2107. with (
  2108. patch.object(service, "_get_providers_for_event", new_callable=AsyncMock) as mock_get,
  2109. patch.object(service, "_send_to_providers", new_callable=AsyncMock) as mock_send,
  2110. patch.object(service, "_build_message_from_template", new_callable=AsyncMock) as mock_build,
  2111. ):
  2112. mock_get.return_value = [mock_provider]
  2113. mock_build.return_value = ("First Layer Complete", "Test message")
  2114. fake_image = b"\x89PNG\r\n\x1a\nfakeimage"
  2115. await service.on_first_layer_complete(
  2116. printer_id=1,
  2117. printer_name="Test Printer",
  2118. filename="benchy.3mf",
  2119. total_layers=50,
  2120. db=mock_db,
  2121. image_data=fake_image,
  2122. )
  2123. mock_send.assert_called_once()
  2124. call_kwargs = mock_send.call_args
  2125. assert call_kwargs.kwargs.get("image_data") == fake_image
  2126. class TestNtfyOutbound:
  2127. """Regression for #1534 — UA hygiene and Cloudflare-challenge detection."""
  2128. @pytest.fixture
  2129. def service(self):
  2130. return NotificationService()
  2131. @pytest.mark.asyncio
  2132. async def test_notification_client_sets_honest_user_agent(self, service):
  2133. """Default httpx UA leaks `python-httpx/<version>` — every other
  2134. outbound client in the codebase identifies as Bambuddy. The
  2135. notification client must too."""
  2136. client = await service._get_client()
  2137. try:
  2138. assert client.headers.get("user-agent") == "Bambuddy/1.0 (+https://github.com/maziggy/bambuddy)"
  2139. finally:
  2140. await service.close()
  2141. @pytest.mark.asyncio
  2142. async def test_ntfy_cloudflare_challenge_returns_actionable_error(self, service):
  2143. """When ntfy is fronted by Cloudflare and CF returns its JS
  2144. challenge, the user must see a message that points at the actual
  2145. fix (CF security skip), not the raw HTML."""
  2146. import httpx
  2147. challenge_html = (
  2148. '<!DOCTYPE html><html lang="en-US"><head><title>Just a moment...</title>'
  2149. '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">'
  2150. )
  2151. mock_response = httpx.Response(
  2152. 403,
  2153. content=challenge_html.encode(),
  2154. headers={"server": "cloudflare", "content-type": "text/html; charset=UTF-8"},
  2155. )
  2156. mock_client = AsyncMock()
  2157. mock_client.post = AsyncMock(return_value=mock_response)
  2158. with patch.object(service, "_get_client", AsyncMock(return_value=mock_client)):
  2159. ok, detail = await service._send_ntfy(
  2160. {"server": "https://ntfy.example", "topic": "alerts", "auth_token": "tk_xxx"},
  2161. title="t",
  2162. message="m",
  2163. )
  2164. assert ok is False
  2165. assert "Cloudflare" in detail
  2166. assert "security-skip" in detail or "Bot Fight Mode" in detail
  2167. # The raw HTML must not be the dominant content shown to the user.
  2168. assert "<!DOCTYPE" not in detail
  2169. @pytest.mark.asyncio
  2170. async def test_ntfy_normal_403_is_not_misread_as_a_cloudflare_challenge(self, service, caplog):
  2171. """A non-Cloudflare 403 (e.g. ntfy auth fail) must report the real
  2172. status rather than the Cloudflare-challenge advice — we only intercept
  2173. the challenge shape.
  2174. The origin's body is no longer returned to the API caller: the ntfy
  2175. server URL is caller-supplied, so echoing it made this an SSRF read
  2176. primitive. It goes to the debug log instead.
  2177. """
  2178. import httpx
  2179. mock_response = httpx.Response(
  2180. 403,
  2181. content=b"forbidden: invalid auth token",
  2182. headers={"content-type": "text/plain"},
  2183. )
  2184. mock_client = AsyncMock()
  2185. mock_client.post = AsyncMock(return_value=mock_response)
  2186. with (
  2187. patch.object(service, "_get_client", AsyncMock(return_value=mock_client)),
  2188. caplog.at_level("DEBUG", logger="backend.app.services.notification_service"),
  2189. ):
  2190. ok, detail = await service._send_ntfy(
  2191. {"server": "https://ntfy.sh", "topic": "alerts", "auth_token": "bad"},
  2192. title="t",
  2193. message="m",
  2194. )
  2195. assert ok is False
  2196. assert "Cloudflare" not in detail
  2197. assert detail.startswith("HTTP 403")
  2198. assert "invalid auth token" not in detail
  2199. assert "invalid auth token" in caplog.text
  2200. @pytest.mark.asyncio
  2201. async def test_ntfy_origin_error_through_cloudflare_is_not_misclassified(self, service, caplog):
  2202. """Cloudflare adds Server: cloudflare to EVERY proxied response,
  2203. including legitimate origin errors. A real 401 "wrong token"
  2204. from an ntfy server that happens to sit behind Cloudflare must
  2205. still be reported as the origin's status — we must not flip
  2206. every CF-fronted 4xx into a "your Cloudflare is blocking" message.
  2207. As above, the origin body reaches the debug log rather than the caller.
  2208. """
  2209. import httpx
  2210. mock_response = httpx.Response(
  2211. 401,
  2212. content=b'{"code":40101,"http":401,"error":"unauthorized"}',
  2213. headers={
  2214. "server": "cloudflare",
  2215. "cf-ray": "abc123-FRA",
  2216. "content-type": "application/json",
  2217. # No cf-mitigated — CF just proxied the origin response.
  2218. },
  2219. )
  2220. mock_client = AsyncMock()
  2221. mock_client.post = AsyncMock(return_value=mock_response)
  2222. with (
  2223. patch.object(service, "_get_client", AsyncMock(return_value=mock_client)),
  2224. caplog.at_level("DEBUG", logger="backend.app.services.notification_service"),
  2225. ):
  2226. ok, detail = await service._send_ntfy(
  2227. {"server": "https://ntfy.example", "topic": "alerts", "auth_token": "wrong"},
  2228. title="t",
  2229. message="m",
  2230. )
  2231. assert ok is False
  2232. assert "Cloudflare" not in detail
  2233. assert detail.startswith("HTTP 401")
  2234. assert "unauthorized" not in detail
  2235. assert "unauthorized" in caplog.text
  2236. @pytest.mark.asyncio
  2237. async def test_ntfy_cloudflare_cf_mitigated_header_alone_triggers(self, service):
  2238. """The cf-mitigated header on its own is enough — that's the
  2239. canonical CF "I actively blocked this" signal, even if the
  2240. response body shape changes between CF challenge generations."""
  2241. import httpx
  2242. mock_response = httpx.Response(
  2243. 403,
  2244. content=b"<html>some future CF block page</html>",
  2245. headers={
  2246. "server": "cloudflare",
  2247. "cf-mitigated": "challenge",
  2248. "content-type": "text/html",
  2249. },
  2250. )
  2251. mock_client = AsyncMock()
  2252. mock_client.post = AsyncMock(return_value=mock_response)
  2253. with patch.object(service, "_get_client", AsyncMock(return_value=mock_client)):
  2254. ok, detail = await service._send_ntfy(
  2255. {"server": "https://ntfy.example", "topic": "alerts"},
  2256. title="t",
  2257. message="m",
  2258. )
  2259. assert ok is False
  2260. assert "Cloudflare" in detail
  2261. class TestEmailProvider:
  2262. """Tests for SMTP email provider, including #1792 finish-photo inline embed.
  2263. Embed is opt-in via the template: only when the user's template referenced
  2264. ``{finish_photo_url}`` (so the URL appears in the rendered body) AND the
  2265. photo bytes are available does ``_send_email`` build the multipart/related
  2266. shape. Otherwise it stays single-part text — no surprise inline image.
  2267. """
  2268. PHOTO_URL = "https://printer.local/api/v1/archives/42/photos/finish.jpg"
  2269. @pytest.fixture
  2270. def service(self):
  2271. return NotificationService()
  2272. @pytest.fixture
  2273. def smtp_config(self):
  2274. return {
  2275. "smtp_server": "smtp.example.com",
  2276. "smtp_port": "587",
  2277. "username": "alice",
  2278. "password": "secret",
  2279. "from_email": "bambuddy@example.com",
  2280. "to_email": "alice@example.com",
  2281. "security": "starttls",
  2282. "auth_enabled": "true",
  2283. }
  2284. @staticmethod
  2285. def _fake_smtp_class(captured: dict):
  2286. class FakeSMTP:
  2287. # timeout matches the real smtplib.SMTP/SMTP_SSL signature — the
  2288. # service passes an explicit timeout so a wedged relay can't hang
  2289. # the send (#2572).
  2290. def __init__(self, host, port, timeout=None):
  2291. captured["host"] = host
  2292. captured["port"] = port
  2293. captured["timeout"] = timeout
  2294. def starttls(self):
  2295. captured["starttls"] = True
  2296. def login(self, u, p):
  2297. captured["login"] = (u, p)
  2298. def sendmail(self, frm, to, body):
  2299. captured["from"] = frm
  2300. captured["to"] = to
  2301. captured["raw"] = body
  2302. def quit(self):
  2303. captured["quit"] = True
  2304. return FakeSMTP
  2305. @pytest.mark.asyncio
  2306. async def test_email_without_image_or_url_stays_text_only(self, service, smtp_config):
  2307. """No image_data and no URL in body → original single-part text shape."""
  2308. captured: dict = {}
  2309. with patch("backend.app.services.notification_service.smtplib.SMTP", self._fake_smtp_class(captured)):
  2310. ok, _ = await service._send_email(smtp_config, "Print Failed", "Reason: unknown")
  2311. assert ok is True
  2312. assert "image/jpeg" not in captured["raw"]
  2313. assert "multipart/related" not in captured["raw"]
  2314. assert "cid:bambuddy-finish-photo" not in captured["raw"]
  2315. assert "Reason: unknown" in captured["raw"]
  2316. @pytest.mark.asyncio
  2317. async def test_email_image_without_template_reference_stays_text_only(self, service, smtp_config):
  2318. """image_data present but template didn't include {finish_photo_url} → no embed.
  2319. Pins the template-driven contract: a user whose body is just
  2320. "Print failed. Reason: unknown" does NOT get a surprise inline image
  2321. stapled to the bottom, even though the photo bytes are available
  2322. upstream from the archive.
  2323. """
  2324. captured: dict = {}
  2325. with patch("backend.app.services.notification_service.smtplib.SMTP", self._fake_smtp_class(captured)):
  2326. ok, _ = await service._send_email(
  2327. smtp_config,
  2328. "Print Failed",
  2329. "Reason: unknown",
  2330. image_data=b"\xff\xd8\xff\xe0jpeg",
  2331. finish_photo_url=self.PHOTO_URL,
  2332. )
  2333. assert ok is True
  2334. raw = captured["raw"]
  2335. assert "image/jpeg" not in raw
  2336. assert "multipart/related" not in raw
  2337. assert "cid:bambuddy-finish-photo" not in raw
  2338. @pytest.mark.asyncio
  2339. async def test_email_inlines_when_template_uses_finish_photo_url(self, service, smtp_config):
  2340. """URL in body + image_data present → multipart/related + cid embed; HTML swaps URL for <img>."""
  2341. captured: dict = {}
  2342. body = f"Print failed. Reason: unknown\n\nSnapshot: {self.PHOTO_URL}"
  2343. with patch("backend.app.services.notification_service.smtplib.SMTP", self._fake_smtp_class(captured)):
  2344. ok, _ = await service._send_email(
  2345. smtp_config,
  2346. "Print Failed",
  2347. body,
  2348. image_data=b"\xff\xd8\xff\xe0fake-jpeg-bytes",
  2349. finish_photo_url=self.PHOTO_URL,
  2350. )
  2351. assert ok is True
  2352. raw = captured["raw"]
  2353. # multipart/related shape with both alt parts and an image part
  2354. assert "multipart/related" in raw
  2355. assert "multipart/alternative" in raw
  2356. assert "text/plain" in raw
  2357. assert "text/html" in raw
  2358. assert "image/jpeg" in raw
  2359. # HTML references the exact cid the Content-ID header registers
  2360. assert "Content-ID: <bambuddy-finish-photo>" in raw
  2361. assert 'src="cid:bambuddy-finish-photo"' in raw
  2362. # Inline disposition so renders embedded, not as download attachment
  2363. assert 'Content-Disposition: inline; filename="finish-photo.jpg"' in raw
  2364. # Plain-text body keeps the URL so non-HTML clients still get a clickable link
  2365. assert self.PHOTO_URL in raw
  2366. @pytest.mark.asyncio
  2367. async def test_email_image_data_without_url_arg_stays_text_only(self, service, smtp_config):
  2368. """image_data passed but finish_photo_url=None → defence-in-depth, no embed.
  2369. Even if a future caller forgets to thread the URL through but does pass
  2370. the bytes, the conservative default is no embed (avoids attaching an
  2371. unreferenced image to an unrelated event type).
  2372. """
  2373. captured: dict = {}
  2374. with patch("backend.app.services.notification_service.smtplib.SMTP", self._fake_smtp_class(captured)):
  2375. ok, _ = await service._send_email(
  2376. smtp_config,
  2377. "Print Failed",
  2378. f"Snapshot: {self.PHOTO_URL}",
  2379. image_data=b"\xff\xd8\xff\xe0jpeg",
  2380. finish_photo_url=None,
  2381. )
  2382. assert ok is True
  2383. assert "image/jpeg" not in captured["raw"]
  2384. assert "multipart/related" not in captured["raw"]
  2385. @pytest.mark.asyncio
  2386. async def test_email_html_body_escapes_user_content(self, service, smtp_config):
  2387. """Template-rendered body must not be injected raw into the HTML part."""
  2388. captured: dict = {}
  2389. body = f"Filename: <script>alert(1)</script>\nLine 2\nSnapshot: {self.PHOTO_URL}"
  2390. with patch("backend.app.services.notification_service.smtplib.SMTP", self._fake_smtp_class(captured)):
  2391. ok, _ = await service._send_email(
  2392. smtp_config,
  2393. "Print Failed",
  2394. body,
  2395. image_data=b"\xff\xd8\xff\xe0jpeg",
  2396. finish_photo_url=self.PHOTO_URL,
  2397. )
  2398. assert ok is True
  2399. raw = captured["raw"]
  2400. # Raw HTML must NOT round-trip into the HTML part — verify escaped form is present.
  2401. assert "&lt;script&gt;alert(1)&lt;/script&gt;" in raw
  2402. # Newlines in the body become <br> in HTML
  2403. assert "Line 2" in raw
  2404. assert "<br>" in raw
  2405. @pytest.mark.asyncio
  2406. async def test_email_html_swaps_url_for_img_tag(self, service, smtp_config):
  2407. """In the HTML part, the URL substring is replaced with the <img cid:...> tag.
  2408. Plain text keeps the URL; HTML clients see the inline image where the
  2409. URL was. The URL must NOT appear inside an <a href> wrapping the image
  2410. — we replace the URL outright with the img tag (renderers don't need
  2411. the URL twice in the HTML part when the image is already inline).
  2412. """
  2413. captured: dict = {}
  2414. body = f"See: {self.PHOTO_URL} for the snapshot."
  2415. with patch("backend.app.services.notification_service.smtplib.SMTP", self._fake_smtp_class(captured)):
  2416. ok, _ = await service._send_email(
  2417. smtp_config,
  2418. "Print Failed",
  2419. body,
  2420. image_data=b"\xff\xd8\xff\xe0jpeg",
  2421. finish_photo_url=self.PHOTO_URL,
  2422. )
  2423. assert ok is True
  2424. raw = captured["raw"]
  2425. # The <img> tag appears in the HTML part
  2426. assert 'src="cid:bambuddy-finish-photo"' in raw
  2427. # The escaped URL is the marker we replaced — the HTML part should not
  2428. # contain BOTH the escaped URL AND the cid img (we swapped, not duplicated).
  2429. # The plain-text part still has the URL; check it's there at least once.
  2430. assert self.PHOTO_URL in raw