]jWzdZddlZddlmZmZddlmZejeZ GddejZ y)z FSM Base Model for Label Studio. This module contains only FsmHistoryStateModel - the base class that models inherit from to get FSM integration. State model definitions are in state_models.py to avoid registration issues in LSE. N)AnyDict)modelsceZdZdZGddZfdZefdZfdZde e e ffdZ dd e d edefd Zde e effd Zde fd ZfdZde d e d e e e ffdZxZS)FsmHistoryStateModela FSM History State Model - Base class for models that participate in FSM state tracking. This class provides explicit FSM integration through model lifecycle hooks, replacing the implicit signal-based approach with predictable, testable behavior. Key features: - Intercepts save operations to trigger FSM transitions - Tracks field changes for transition logic - Maintains CurrentContext for user/org tracking - Provides explicit transition determination - Fails gracefully - FSM errors don't break saves Usage: class Task(FsmHistoryStateModel): # ... model fields ... def _determine_fsm_transition(self) -> Optional[str]: if self._state.adding: # Creating new instance return 'task_created' changed = self._get_changed_fields() if 'is_labeled' in changed and changed['is_labeled'][1]: return 'task_labeled' return None def _get_fsm_transition_data(self) -> Dict[str, Any]: return { 'project_id': self.project_id, 'overlap': self.overlap } ceZdZdZy)FsmHistoryStateModel.MetaTN)__name__ __module__ __qualname__abstractA/root/env/lib/python3.12/site-packages/label_studio/fsm/models.pyMetar 9srrc2t||i|i|_y)N)super__init___original_values)selfargskwargs __class__s rrzFsmHistoryStateModel.__init__<s $)&)!#rc^t||||}tt|||_|S)a Override from_db to store raw DB values for lazy capture. Django calls this method instead of __init__ when loading models from the database. PERFORMANCE: We store the raw field values here without processing them. This avoids accessing any ForeignKey fields (which would trigger queries). We only process these values into _original_values in save() when we actually need them for change detection. )rfrom_dbdictzipr)clsdb field_namesvaluesinstancers rrzFsmHistoryStateModel.from_dbBs07?2{F;$([&)A$B!rct||}t|dk\rIt|dtr6|dj }|j dd|d|d|f|ddzS|S)a" Override serialization to exclude internal FSM tracking fields. Django's serialization uses pickle which calls __reduce_ex__. We exclude FSM tracking fields since they're only needed for runtime change detection, not for serialization/restoration. rNr)r __reduce_ex__len isinstancercopypop)rprotocol reductionstaters rr'z"FsmHistoryStateModel.__reduce_ex__TsvG)(3  y>Q :ilD#AaL%%'E II($ /aL)A,612F Frreturncft|dr |jsiSi}|jjD]{}|j|jvr|j r |j r5|j|j}t||jd}||k7sk||f||j<}|S)a Get fields that changed since the last load/save. Returns: Dict mapping field names to (old_value, new_value) tuples Note: For ForeignKey fields, old_value will be the PK, new_value will be the object Example: changed = self._get_changed_fields() if 'is_labeled' in changed: old_val, new_val = changed['is_labeled'] if not old_val and new_val: # Task became labeled pass rN)hasattrr_metafieldsattname is_relation many_to_manygetattr)rchangedfield old_value new_values r_get_changed_fieldsz(FsmHistoryStateModel._get_changed_fieldsjs$t/08M8MIZZ&& @E}}D$9$99  U%7%7--emm list: # Get default transitions transitions = super()._determine_fsm_transitions(is_creating, changed_fields) # Add custom logic if self.some_complex_condition(): transitions.append('custom_transition') return transitions r)transition_registryNprojectz!FSM: Determining transitions for ) entity_idr=r>changed_fields_detailextraF_triggers_on_createT_triggers_on_update_trigger_fields)TransitionContextr&oldnewr=r>)BaseTransitionshould_executeorganization_id)entity current_usercurrent_state_object current_state target_staterPzFSM: Transition z! filtered out by should_execute()) entity_typerBtransition_namez'FSM: Error checking should_execute for : )rVrBrWerror) fsm.registryr@r2 model_name_stateaddingr<loggerdebugpklistkeysget_transitions_for_entityitemsr7fsm.transitionsrIrNtypeget_target_staterO Exceptionstrappend)rr=r>r@ entity_nameregistered_transitionstransitions_to_executerWtransition_classrOtrigger_fieldsr9rIkvformatted_changed_fieldstemp_transitionrNshould_execute_methodbase_should_executeminimal_contextrUcontextes r_determine_fsm_transitionsz/FsmHistoryStateModel._determine_fsm_transitionss@ 5jj++   ++,,K  !#.RD4L4L4NN ) #K LL3K=A!%#.&*>+>+>+@&A-;   "5!O!OP[!\%I!#1G1M1M1Oc ? -O-"Nw'79NPUV!%!W-=?TVZ%[!()9;Lb!Q&&*N"0" N2-1N!" FB[iZnZnZp/qRVRSUV1Q4!3M0M/q,/q'7$/@X'O ?,3D4IK[]a,b)*1.BRTX*Y'-1FJ]1]+<#')-15*.)-,3D:KT,R +(7'G'G'X #4#')-15*.)5,3D:KT,R # /==gF-2N"LL"2?2CCd e3>157F'")*&--o>Gc ?J&%I0rh! LLA/ARRTUVTWX+6)-/>%(V ! s+H H 6B Dict[str, Any]: return { 'project_id': self.project_id, 'completed_by_id': self.completed_by_id, 'annotation_count': self.annotations.count() } r)rs r_get_fsm_transition_dataz-FsmHistoryStateModel._get_fsm_transition_data6s $ rcJt|ddryddlm}|jS)a[ Check if FSM processing should be executed. Returns False if: - Feature flag is disabled (cached at request level) - Manually disabled via set_fsm_disabled() (for tests/bulk operations) - Explicitly skipped via instance attribute Returns: True if FSM should execute, False otherwise PERFORMANCE: Uses cached FSM enabled state from CurrentContext that was set once per request when user was initialized. This is a simple boolean check instead of repeated feature flag lookups and user authentication checks. _skip_fsmFrCurrentContext)r7core.current_requestris_fsm_enabled)rrs r_should_execute_fsmz(FsmHistoryStateModel._should_execute_fsmJs'" 4e , 8,,..rc ddlm}|jd|j}|jj }|rin|j }t | |i|}i|_ |jjD]I}|jr |jrt||jd|j|j<K| xr|j!} t"j%d|j&j(d|j*d|d| |j&j(|j*|| d  |s| r |j-|| } t"j%d |j&j(d|j*d | |j&j(|j*| |d | D]} |j/| || |S|S#t0$rw} t"j3d| d|j&j(d|j*d|j&j(|j*| t5| |ddYd} ~ d} ~ wwxYw#t0$rt} t"j3d|j&j(d|j*d|j&j(|j*t5| |ddYd} ~ |Sd} ~ wwxYw)a Override save to trigger FSM transitions based on model changes. This method: 1. Captures the current state (creating vs updating) 2. Performs the actual database save 3. Determines if an FSM transition is needed 4. Executes the transition if needed 5. Gracefully handles FSM errors without breaking the save Args: *args: Positional arguments passed to super().save() **kwargs: Keyword arguments passed to super().save() Special kwarg: skip_fsm=True to bypass FSM processing Returns: Whatever super().save() returns rr~skip_fsmNzFSM check for  z : skip_fsm=z, should_execute=)rVrBrrOrDrMzFSM transitions determined for rX)rVrB transitionsr=)rWr=r>zFSM transition z failed for zfsm.transition_failed_on_save)eventrVrBrWrYr=T)rEexc_infoz$FSM transition discovery failed for zfsm.transition_discovery_failed)rrVrBrYr=)rrr+is_fsm_disabledr\r]r<rsaverr2r3r5r6r7r4rr^r_rr r`ry_execute_fsm_transitionrhrYri)rrrrrr=r>resultr9rOrrWrxrs rrzFsmHistoryStateModel.saveds& 8::j.*H*H*JKkk((  +0H0H0Jt.v. !#ZZ&& VE  U%7%73:4PT3UD ! !%-- 0 V &D$*B*B*D T^^445Qtwwi{8*Tefteu v#~~66!WW$"0   N+ "==+ft=u  5dnn6M6M5NaPTPWPWyXZ[fZgh'+~~'>'>%)WW'2'2 (3O44,;es5B v 9%  -o->l4>>KbKbJccdeieleldmn)H/3~~/F/F-1WW3B),Q/: #&*%     :4>>;R;R:SSTUYU\U\T]^!B'+~~'>'>%)WW!$Q'2 "    sEA9I GI  I&A-II II K)A)KKrWc ddlm}ddlm}|}|j }|j }|j } | j||jD cic]\} } | | d| ddc} } dtjd|jjd|jj|j|||r |jnd |d   |j||| || tjd |jjd|jj|j||r |jnd |d y cc} } w#t $rwxYw)aq Execute an FSM transition. This method handles the actual transition execution, including: - Getting current context (user, org_id) - Preparing transition data - Calling the state manager Args: transition_name: Name of the registered transition to execute is_creating: Whether this is a new model creation changed_fields: Dict of changed fields (field_name -> (old, new)) Note: This is only called after _should_execute_fsm() returns True, so CurrentContext should be available with a valid user. rr~)get_state_managerr&rJrMzExecuting FSM transition for zfsm.transition_executingN)rrVrBrWr=user_idrPrD)rQrWtransition_datauserrPz)FSM transition executed successfully for zfsm.transition_success)rrVrBrWrrP)rrfsm.state_managerrget_userget_organization_idr{updaterdr^inforr r`idexecute_transitionrh) rrWr=r>rr StateManagerrorg_idrrprqs rrz,FsmHistoryStateModel._execute_fsm_transitionst$ 87(* &&(335779 *M[MaMaMc"dTQ1ad1Q4&@#@"d    +DNN,C,C+D E3#~~66!WW#2*&*477#)     + + / / & ,  KK;DNN>#:#:!%'6*.twwD'-   7#eL   s#E &A7E$$ E/)NN)r r r __doc__rr classmethodrr'rritupler<boolrraryrr{rrr __classcell__)rs@rrrs D# ",$T#u*%5$Ld&dd&SWd&cgd&L$sCx.(/T/4dLJsJJ_cdgindn_oJrr) rloggingtypingrr django.dbr getLoggerr r^Modelrrrrrs9   8 $~6<<~r