babase

426class AccountV2Handle:
427    """Handle for interacting with a V2 account.
428
429    This class supports the 'with' statement, which is how it is
430    used with some operations such as cloud messaging.
431    """
432
433    accountid: str
434    tag: str
435    workspacename: str | None
436    workspaceid: str | None
437    logins: dict[LoginType, LoginInfo]
438
439    def __enter__(self) -> None:
440        """Support for "with" statement.
441
442        This allows cloud messages to be sent on our behalf.
443        """
444
445    def __exit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> Any:
446        """Support for "with" statement.
447
448        This allows cloud messages to be sent on our behalf.
449        """

 26class AccountV2Subsystem:
 27    """Subsystem for modern account handling in the app.
 28
 29    Category: **App Classes**
 30
 31    Access the single shared instance of this class at 'ba.app.plus.accounts'.
 32    """
 33
 34    def __init__(self) -> None:
 35        from babase._login import LoginAdapterGPGS, LoginAdapterGameCenter
 36
 37        # Whether or not everything related to an initial login
 38        # (or lack thereof) has completed. This includes things like
 39        # workspace syncing. Completion of this is what flips the app
 40        # into 'running' state.
 41        self._initial_sign_in_completed = False
 42
 43        self._kicked_off_workspace_load = False
 44
 45        self.login_adapters: dict[LoginType, LoginAdapter] = {}
 46
 47        self._implicit_signed_in_adapter: LoginAdapter | None = None
 48        self._implicit_state_changed = False
 49        self._can_do_auto_sign_in = True
 50
 51        adapter: LoginAdapter
 52        if _babase.using_google_play_game_services():
 53            adapter = LoginAdapterGPGS()
 54            self.login_adapters[adapter.login_type] = adapter
 55        if _babase.using_game_center():
 56            adapter = LoginAdapterGameCenter()
 57            self.login_adapters[adapter.login_type] = adapter
 58
 59    def on_app_loading(self) -> None:
 60        """Should be called at standard on_app_loading time."""
 61
 62        for adapter in self.login_adapters.values():
 63            adapter.on_app_loading()
 64
 65    def have_primary_credentials(self) -> bool:
 66        """Are credentials currently set for the primary app account?
 67
 68        Note that this does not mean these credentials are currently valid;
 69        only that they exist. If/when credentials are validated, the 'primary'
 70        account handle will be set.
 71        """
 72        raise NotImplementedError('This should be overridden.')
 73
 74    @property
 75    def primary(self) -> AccountV2Handle | None:
 76        """The primary account for the app, or None if not logged in."""
 77        return self.do_get_primary()
 78
 79    def on_primary_account_changed(
 80        self, account: AccountV2Handle | None
 81    ) -> None:
 82        """Callback run after the primary account changes.
 83
 84        Will be called with None on log-outs and when new credentials
 85        are set but have not yet been verified.
 86        """
 87        assert _babase.in_logic_thread()
 88
 89        # Currently don't do anything special on sign-outs.
 90        if account is None:
 91            return
 92
 93        # If this new account has a workspace, update it and ask to be
 94        # informed when that process completes.
 95        if account.workspaceid is not None:
 96            assert account.workspacename is not None
 97            if (
 98                not self._initial_sign_in_completed
 99                and not self._kicked_off_workspace_load
100            ):
101                self._kicked_off_workspace_load = True
102                _babase.app.workspaces.set_active_workspace(
103                    account=account,
104                    workspaceid=account.workspaceid,
105                    workspacename=account.workspacename,
106                    on_completed=self._on_set_active_workspace_completed,
107                )
108            else:
109                # Don't activate workspaces if we've already told the game
110                # that initial-log-in is done or if we've already kicked
111                # off a workspace load.
112                _babase.screenmessage(
113                    f'\'{account.workspacename}\''
114                    f' will be activated at next app launch.',
115                    color=(1, 1, 0),
116                )
117                _babase.getsimplesound('error').play()
118            return
119
120        # Ok; no workspace to worry about; carry on.
121        if not self._initial_sign_in_completed:
122            self._initial_sign_in_completed = True
123            _babase.app.on_initial_sign_in_complete()
124
125    def on_active_logins_changed(self, logins: dict[LoginType, str]) -> None:
126        """Should be called when logins for the active account change."""
127
128        for adapter in self.login_adapters.values():
129            adapter.set_active_logins(logins)
130
131    def on_implicit_sign_in(
132        self, login_type: LoginType, login_id: str, display_name: str
133    ) -> None:
134        """An implicit sign-in happened (called by native layer)."""
135        from babase._login import LoginAdapter
136
137        assert _babase.in_logic_thread()
138
139        with _babase.ContextRef.empty():
140            self.login_adapters[login_type].set_implicit_login_state(
141                LoginAdapter.ImplicitLoginState(
142                    login_id=login_id, display_name=display_name
143                )
144            )
145
146    def on_implicit_sign_out(self, login_type: LoginType) -> None:
147        """An implicit sign-out happened (called by native layer)."""
148        assert _babase.in_logic_thread()
149        with _babase.ContextRef.empty():
150            self.login_adapters[login_type].set_implicit_login_state(None)
151
152    def on_no_initial_primary_account(self) -> None:
153        """Callback run if the app has no primary account after launch.
154
155        Either this callback or on_primary_account_changed will be called
156        within a few seconds of app launch; the app can move forward
157        with the startup sequence at that point.
158        """
159        if not self._initial_sign_in_completed:
160            self._initial_sign_in_completed = True
161            _babase.app.on_initial_sign_in_complete()
162
163    @staticmethod
164    def _hashstr(val: str) -> str:
165        md5 = hashlib.md5()
166        md5.update(val.encode())
167        return md5.hexdigest()
168
169    def on_implicit_login_state_changed(
170        self,
171        login_type: LoginType,
172        state: LoginAdapter.ImplicitLoginState | None,
173    ) -> None:
174        """Called when implicit login state changes.
175
176        Login systems that tend to sign themselves in/out in the
177        background are considered implicit. We may choose to honor or
178        ignore their states, allowing the user to opt for other login
179        types even if the default implicit one can't be explicitly
180        logged out or otherwise controlled.
181        """
182        from babase._language import Lstr
183
184        assert _babase.in_logic_thread()
185
186        cfg = _babase.app.config
187        cfgkey = 'ImplicitLoginStates'
188        cfgdict = _babase.app.config.setdefault(cfgkey, {})
189
190        # Store which (if any) adapter is currently implicitly signed
191        # in. Making the assumption there will only ever be one implicit
192        # adapter at a time; may need to revisit this logic if that
193        # changes.
194        prev_state = cfgdict.get(login_type.value)
195        if state is None:
196            self._implicit_signed_in_adapter = None
197            new_state = cfgdict[login_type.value] = None
198        else:
199            self._implicit_signed_in_adapter = self.login_adapters[login_type]
200            new_state = cfgdict[login_type.value] = self._hashstr(
201                state.login_id
202            )
203
204            # Special case: if the user is already signed in but not
205            # with this implicit login, let them know that the 'Welcome
206            # back FOO' they likely just saw is not actually accurate.
207            if (
208                self.primary is not None
209                and not self.login_adapters[login_type].is_back_end_active()
210            ):
211                service_str: Lstr | None
212                if login_type is LoginType.GPGS:
213                    service_str = Lstr(resource='googlePlayText')
214                elif login_type is LoginType.GAME_CENTER:
215                    # Note: Apparently Game Center is just called 'Game
216                    # Center' in all languages. Can revisit if not true.
217                    # https://developer.apple.com/forums/thread/725779
218                    service_str = Lstr(value='Game Center')
219                elif login_type is LoginType.EMAIL:
220                    # Not possible; just here for exhaustive coverage.
221                    service_str = None
222                else:
223                    assert_never(login_type)
224                if service_str is not None:
225                    _babase.apptimer(
226                        2.0,
227                        partial(
228                            _babase.screenmessage,
229                            Lstr(
230                                resource='notUsingAccountText',
231                                subs=[
232                                    ('${ACCOUNT}', state.display_name),
233                                    ('${SERVICE}', service_str),
234                                ],
235                            ),
236                            (1, 0.5, 0),
237                        ),
238                    )
239
240        cfg.commit()
241
242        # We want to respond any time the implicit state changes;
243        # generally this means the user has explicitly signed in/out or
244        # switched accounts within that back-end.
245        if prev_state != new_state:
246            if DEBUG_LOG:
247                logging.debug(
248                    'AccountV2: Implicit state changed (%s -> %s);'
249                    ' will update app sign-in state accordingly.',
250                    prev_state,
251                    new_state,
252                )
253            self._implicit_state_changed = True
254
255        # We may want to auto-sign-in based on this new state.
256        self._update_auto_sign_in()
257
258    def on_cloud_connectivity_changed(self, connected: bool) -> None:
259        """Should be called with cloud connectivity changes."""
260        del connected  # Unused.
261        assert _babase.in_logic_thread()
262
263        # We may want to auto-sign-in based on this new state.
264        self._update_auto_sign_in()
265
266    def do_get_primary(self) -> AccountV2Handle | None:
267        """Internal - should be overridden by subclass."""
268        raise NotImplementedError('This should be overridden.')
269
270    def set_primary_credentials(self, credentials: str | None) -> None:
271        """Set credentials for the primary app account."""
272        raise NotImplementedError('This should be overridden.')
273
274    def _update_auto_sign_in(self) -> None:
275        plus = _babase.app.plus
276        assert plus is not None
277
278        # If implicit state has changed, try to respond.
279        if self._implicit_state_changed:
280            if self._implicit_signed_in_adapter is None:
281                # If implicit back-end has signed out, we follow suit
282                # immediately; no need to wait for network connectivity.
283                if DEBUG_LOG:
284                    logging.debug(
285                        'AccountV2: Signing out as result'
286                        ' of implicit state change...',
287                    )
288                plus.accounts.set_primary_credentials(None)
289                self._implicit_state_changed = False
290
291                # Once we've made a move here we don't want to
292                # do any more automatic stuff.
293                self._can_do_auto_sign_in = False
294
295            else:
296                # Ok; we've got a new implicit state. If we've got
297                # connectivity, let's attempt to sign in with it.
298                # Consider this an 'explicit' sign in because the
299                # implicit-login state change presumably was triggered
300                # by some user action (signing in, signing out, or
301                # switching accounts via the back-end). NOTE: should
302                # test case where we don't have connectivity here.
303                if plus.cloud.is_connected():
304                    if DEBUG_LOG:
305                        logging.debug(
306                            'AccountV2: Signing in as result'
307                            ' of implicit state change...',
308                        )
309                    self._implicit_signed_in_adapter.sign_in(
310                        self._on_explicit_sign_in_completed,
311                        description='implicit state change',
312                    )
313                    self._implicit_state_changed = False
314
315                    # Once we've made a move here we don't want to
316                    # do any more automatic stuff.
317                    self._can_do_auto_sign_in = False
318
319        if not self._can_do_auto_sign_in:
320            return
321
322        # If we're not currently signed in, we have connectivity, and
323        # we have an available implicit login, auto-sign-in with it once.
324        # The implicit-state-change logic above should keep things
325        # mostly in-sync, but that might not always be the case due to
326        # connectivity or other issues. We prefer to keep people signed
327        # in as a rule, even if there are corner cases where this might
328        # not be what they want (A user signing out and then restarting
329        # may be auto-signed back in).
330        connected = plus.cloud.is_connected()
331        signed_in_v1 = plus.get_v1_account_state() == 'signed_in'
332        signed_in_v2 = plus.accounts.have_primary_credentials()
333        if (
334            connected
335            and not signed_in_v1
336            and not signed_in_v2
337            and self._implicit_signed_in_adapter is not None
338        ):
339            if DEBUG_LOG:
340                logging.debug(
341                    'AccountV2: Signing in due to on-launch-auto-sign-in...',
342                )
343            self._can_do_auto_sign_in = False  # Only ATTEMPT once
344            self._implicit_signed_in_adapter.sign_in(
345                self._on_implicit_sign_in_completed, description='auto-sign-in'
346            )
347
348    def _on_explicit_sign_in_completed(
349        self,
350        adapter: LoginAdapter,
351        result: LoginAdapter.SignInResult | Exception,
352    ) -> None:
353        """A sign-in has completed that the user asked for explicitly."""
354        from babase._language import Lstr
355
356        del adapter  # Unused.
357
358        plus = _babase.app.plus
359        assert plus is not None
360
361        # Make some noise on errors since the user knows a
362        # sign-in attempt is happening in this case (the 'explicit' part).
363        if isinstance(result, Exception):
364            # We expect the occasional communication errors;
365            # Log a full exception for anything else though.
366            if not isinstance(result, CommunicationError):
367                logging.warning(
368                    'Error on explicit accountv2 sign in attempt.',
369                    exc_info=result,
370                )
371
372            # For now just show 'error'. Should do better than this.
373            _babase.screenmessage(
374                Lstr(resource='internal.signInErrorText'),
375                color=(1, 0, 0),
376            )
377            _babase.getsimplesound('error').play()
378
379            # Also I suppose we should sign them out in this case since
380            # it could be misleading to be still signed in with the old
381            # account.
382            plus.accounts.set_primary_credentials(None)
383            return
384
385        plus.accounts.set_primary_credentials(result.credentials)
386
387    def _on_implicit_sign_in_completed(
388        self,
389        adapter: LoginAdapter,
390        result: LoginAdapter.SignInResult | Exception,
391    ) -> None:
392        """A sign-in has completed that the user didn't ask for explicitly."""
393        plus = _babase.app.plus
394        assert plus is not None
395
396        del adapter  # Unused.
397
398        # Log errors but don't inform the user; they're not aware of this
399        # attempt and ignorance is bliss.
400        if isinstance(result, Exception):
401            # We expect the occasional communication errors;
402            # Log a full exception for anything else though.
403            if not isinstance(result, CommunicationError):
404                logging.warning(
405                    'Error on implicit accountv2 sign in attempt.',
406                    exc_info=result,
407                )
408            return
409
410        # If we're still connected and still not signed in,
411        # plug in the credentials we got. We want to be extra cautious
412        # in case the user has since explicitly signed in since we
413        # kicked off.
414        connected = plus.cloud.is_connected()
415        signed_in_v1 = plus.get_v1_account_state() == 'signed_in'
416        signed_in_v2 = plus.accounts.have_primary_credentials()
417        if connected and not signed_in_v1 and not signed_in_v2:
418            plus.accounts.set_primary_credentials(result.credentials)
419
420    def _on_set_active_workspace_completed(self) -> None:
421        if not self._initial_sign_in_completed:
422            self._initial_sign_in_completed = True
423            _babase.app.on_initial_sign_in_complete()

89class ActivityNotFoundError(NotFoundError):
90    """Exception raised when an expected bascenev1.Activity does not exist.
91
92    Category: **Exception Classes**
93    """

82class ActorNotFoundError(NotFoundError):
83    """Exception raised when an expected actor does not exist.
84
85    Category: **Exception Classes**
86    """

  49class App:
  50    """A class for high level app functionality and state.
  51
  52    Category: **App Classes**
  53
  54    Use babase.app to access the single shared instance of this class.
  55
  56    Note that properties not documented here should be considered internal
  57    and subject to change without warning.
  58    """
  59
  60    # pylint: disable=too-many-public-methods
  61
  62    # A few things defined as non-optional values but not actually
  63    # available until the app starts.
  64    plugins: PluginSubsystem
  65    lang: LanguageSubsystem
  66    health_monitor: AppHealthMonitor
  67
  68    # How long we allow shutdown tasks to run before killing them.
  69    # Currently the entire app hard-exits if shutdown takes 10 seconds,
  70    # so we need to keep it under that.
  71    SHUTDOWN_TASK_TIMEOUT_SECONDS = 5
  72
  73    class State(Enum):
  74        """High level state the app can be in."""
  75
  76        # The app has not yet begun starting and should not be used in
  77        # any way.
  78        NOT_STARTED = 0
  79
  80        # The native layer is spinning up its machinery (screens,
  81        # renderers, etc.). Nothing should happen in the Python layer
  82        # until this completes.
  83        NATIVE_BOOTSTRAPPING = 1
  84
  85        # Python app subsystems are being inited but should not yet
  86        # interact or do any work.
  87        INITING = 2
  88
  89        # Python app subsystems are inited and interacting, but the app
  90        # has not yet embarked on a high level course of action. It is
  91        # doing initial account logins, workspace & asset downloads,
  92        # etc.
  93        LOADING = 3
  94
  95        # All pieces are in place and the app is now doing its thing.
  96        RUNNING = 4
  97
  98        # Used on platforms such as mobile where the app basically needs
  99        # to shut down while backgrounded. In this state, all event
 100        # loops are suspended and all graphics and audio must cease
 101        # completely. Be aware that the suspended state can be entered
 102        # from any other state including NATIVE_BOOTSTRAPPING and
 103        # SHUTTING_DOWN.
 104        SUSPENDED = 5
 105
 106        # The app is shutting down. This process may involve sending
 107        # network messages or other things that can take up to a few
 108        # seconds, so ideally graphics and audio should remain
 109        # functional (with fades or spinners or whatever to show
 110        # something is happening).
 111        SHUTTING_DOWN = 6
 112
 113        # The app has completed shutdown. Any code running here should
 114        # be basically immediate.
 115        SHUTDOWN_COMPLETE = 7
 116
 117    class DefaultAppModeSelector(AppModeSelector):
 118        """Decides which AppModes to use to handle AppIntents.
 119
 120        This default version is generated by the project updater based
 121        on the 'default_app_modes' value in the projectconfig.
 122
 123        It is also possible to modify app mode selection behavior by
 124        setting app.mode_selector to an instance of a custom
 125        AppModeSelector subclass. This is a good way to go if you are
 126        modifying app behavior dynamically via a plugin instead of
 127        statically in a spinoff project.
 128        """
 129
 130        @override
 131        def app_mode_for_intent(
 132            self, intent: AppIntent
 133        ) -> type[AppMode] | None:
 134            # pylint: disable=cyclic-import
 135
 136            # __DEFAULT_APP_MODE_SELECTION_BEGIN__
 137            # This section generated by batools.appmodule; do not edit.
 138
 139            # Ask our default app modes to handle it.
 140            # (generated from 'default_app_modes' in projectconfig).
 141            import bascenev1
 142            import babase
 143
 144            for appmode in [
 145                bascenev1.SceneV1AppMode,
 146                babase.EmptyAppMode,
 147            ]:
 148                if appmode.can_handle_intent(intent):
 149                    return appmode
 150
 151            return None
 152
 153            # __DEFAULT_APP_MODE_SELECTION_END__
 154
 155    def __init__(self) -> None:
 156        """(internal)
 157
 158        Do not instantiate this class. You can access the single shared
 159        instance of it through various high level packages: 'babase.app',
 160        'bascenev1.app', 'bauiv1.app', etc.
 161        """
 162
 163        # Hack for docs-generation: we can be imported with dummy modules
 164        # instead of our actual binary ones, but we don't function.
 165        if os.environ.get('BA_RUNNING_WITH_DUMMY_MODULES') == '1':
 166            return
 167
 168        self.env: babase.Env = _babase.Env()
 169        self.state = self.State.NOT_STARTED
 170
 171        # Default executor which can be used for misc background
 172        # processing. It should also be passed to any additional asyncio
 173        # loops we create so that everything shares the same single set
 174        # of worker threads.
 175        self.threadpool = ThreadPoolExecutor(
 176            thread_name_prefix='baworker',
 177            initializer=self._thread_pool_thread_init,
 178        )
 179
 180        self.meta = MetadataSubsystem()
 181        self.net = NetworkSubsystem()
 182        self.workspaces = WorkspaceSubsystem()
 183        self.components = AppComponentSubsystem()
 184        self.stringedit = StringEditSubsystem()
 185        self.devconsole = DevConsoleSubsystem()
 186
 187        # This is incremented any time the app is backgrounded or
 188        # foregrounded; can be a simple way to determine if network data
 189        # should be refreshed/etc.
 190        self.fg_state = 0
 191
 192        self._subsystems: list[AppSubsystem] = []
 193        self._native_bootstrapping_completed = False
 194        self._init_completed = False
 195        self._meta_scan_completed = False
 196        self._native_start_called = False
 197        self._native_suspended = False
 198        self._native_shutdown_called = False
 199        self._native_shutdown_complete_called = False
 200        self._initial_sign_in_completed = False
 201        self._called_on_initing = False
 202        self._called_on_loading = False
 203        self._called_on_running = False
 204        self._subsystem_registration_ended = False
 205        self._pending_apply_app_config = False
 206        self._asyncio_loop: asyncio.AbstractEventLoop | None = None
 207        self._asyncio_tasks: set[asyncio.Task] = set()
 208        self._asyncio_timer: babase.AppTimer | None = None
 209        self._config: babase.AppConfig | None = None
 210        self._pending_intent: AppIntent | None = None
 211        self._intent: AppIntent | None = None
 212        self._mode: AppMode | None = None
 213        self._mode_selector: babase.AppModeSelector | None = None
 214        self._shutdown_task: asyncio.Task[None] | None = None
 215        self._shutdown_tasks: list[Coroutine[None, None, None]] = [
 216            self._wait_for_shutdown_suppressions(),
 217            self._fade_and_shutdown_graphics(),
 218            self._fade_and_shutdown_audio(),
 219        ]
 220        self._pool_thread_count = 0
 221
 222        # We hold a lock while lazy-loading our subsystem properties so
 223        # we don't spin up any subsystem more than once, but the lock is
 224        # recursive so that the subsystems can instantiate other
 225        # subsystems.
 226        self._subsystem_property_lock = RLock()
 227        self._subsystem_property_data: dict[str, AppSubsystem | bool] = {}
 228
 229    def postinit(self) -> None:
 230        """Called after we've been inited and assigned to babase.app.
 231
 232        Anything that accesses babase.app as part of its init process
 233        must go here instead of __init__.
 234        """
 235
 236        # Hack for docs-generation: We can be imported with dummy
 237        # modules instead of our actual binary ones, but we don't
 238        # function.
 239        if os.environ.get('BA_RUNNING_WITH_DUMMY_MODULES') == '1':
 240            return
 241
 242        self.lang = LanguageSubsystem()
 243        self.plugins = PluginSubsystem()
 244
 245    @property
 246    def active(self) -> bool:
 247        """Whether the app is currently front and center.
 248
 249        This will be False when the app is hidden, other activities
 250        are covering it, etc. (depending on the platform).
 251        """
 252        return _babase.app_is_active()
 253
 254    @property
 255    def asyncio_loop(self) -> asyncio.AbstractEventLoop:
 256        """The logic thread's asyncio event loop.
 257
 258        This allow async tasks to be run in the logic thread.
 259
 260        Generally you should call App.create_async_task() to schedule
 261        async code to run instead of using this directly. That will
 262        handle retaining the task and logging errors automatically.
 263        Only schedule tasks onto asyncio_loop yourself when you intend
 264        to hold on to the returned task and await its results. Releasing
 265        the task reference can lead to subtle bugs such as unreported
 266        errors and garbage-collected tasks disappearing before their
 267        work is done.
 268
 269        Note that, at this time, the asyncio loop is encapsulated
 270        and explicitly stepped by the engine's logic thread loop and
 271        thus things like asyncio.get_running_loop() will unintuitively
 272        *not* return this loop from most places in the logic thread;
 273        only from within a task explicitly created in this loop.
 274        Hopefully this situation will be improved in the future with a
 275        unified event loop.
 276        """
 277        assert _babase.in_logic_thread()
 278        assert self._asyncio_loop is not None
 279        return self._asyncio_loop
 280
 281    def create_async_task(
 282        self, coro: Coroutine[Any, Any, T], *, name: str | None = None
 283    ) -> None:
 284        """Create a fully managed async task.
 285
 286        This will automatically retain and release a reference to the task
 287        and log any exceptions that occur in it. If you need to await a task
 288        or otherwise need more control, schedule a task directly using
 289        App.asyncio_loop.
 290        """
 291        assert _babase.in_logic_thread()
 292
 293        # Hold a strong reference to the task until it is done.
 294        # Otherwise it is possible for it to be garbage collected and
 295        # disappear midway if the caller does not hold on to the
 296        # returned task, which seems like a great way to introduce
 297        # hard-to-track bugs.
 298        task = self.asyncio_loop.create_task(coro, name=name)
 299        self._asyncio_tasks.add(task)
 300        task.add_done_callback(self._on_task_done)
 301
 302    def _on_task_done(self, task: asyncio.Task) -> None:
 303        # Report any errors that occurred.
 304        try:
 305            exc = task.exception()
 306            if exc is not None:
 307                logging.error(
 308                    "Error in async task '%s'.", task.get_name(), exc_info=exc
 309                )
 310        except Exception:
 311            logging.exception('Error reporting async task error.')
 312
 313        self._asyncio_tasks.remove(task)
 314
 315    @property
 316    def config(self) -> babase.AppConfig:
 317        """The babase.AppConfig instance representing the app's config state."""
 318        assert self._config is not None
 319        return self._config
 320
 321    @property
 322    def mode_selector(self) -> babase.AppModeSelector:
 323        """Controls which app-modes are used for handling given intents.
 324
 325        Plugins can override this to change high level app behavior and
 326        spinoff projects can change the default implementation for the
 327        same effect.
 328        """
 329        if self._mode_selector is None:
 330            raise RuntimeError(
 331                'mode_selector cannot be used until the app reaches'
 332                ' the running state.'
 333            )
 334        return self._mode_selector
 335
 336    @mode_selector.setter
 337    def mode_selector(self, selector: babase.AppModeSelector) -> None:
 338        self._mode_selector = selector
 339
 340    def _get_subsystem_property(
 341        self, ssname: str, create_call: Callable[[], AppSubsystem | None]
 342    ) -> AppSubsystem | None:
 343
 344        # Quick-out: if a subsystem is present, just return it; no
 345        # locking necessary.
 346        val = self._subsystem_property_data.get(ssname)
 347        if val is not None:
 348            if val is False:
 349                # False means subsystem is confirmed as unavailable.
 350                return None
 351            if val is not True:
 352                # A subsystem has been set. Return it.
 353                return val
 354
 355        # Anything else (no val present or val True) requires locking.
 356        with self._subsystem_property_lock:
 357            val = self._subsystem_property_data.get(ssname)
 358            if val is not None:
 359                if val is False:
 360                    # False means confirmed as not present.
 361                    return None
 362                if val is True:
 363                    # True means this property is already being loaded,
 364                    # and the fact that we're holding the lock means
 365                    # we're doing the loading, so this is a dependency
 366                    # loop. Not good.
 367                    raise RuntimeError(
 368                        f'Subsystem dependency loop detected for {ssname}'
 369                    )
 370                # Must be an instantiated subsystem. Noice.
 371                return val
 372
 373            # Ok, there's nothing here for it. Instantiate and set it
 374            # while we hold the lock. Set a placeholder value of True
 375            # while we load so we can error if something we're loading
 376            # tries to recursively load us.
 377            self._subsystem_property_data[ssname] = True
 378
 379            # Do our one attempt to create the singleton.
 380            val = create_call()
 381            self._subsystem_property_data[ssname] = (
 382                False if val is None else val
 383            )
 384
 385        return val
 386
 387    # __FEATURESET_APP_SUBSYSTEM_PROPERTIES_BEGIN__
 388    # This section generated by batools.appmodule; do not edit.
 389
 390    @property
 391    def classic(self) -> ClassicSubsystem | None:
 392        """Our classic subsystem (if available)."""
 393        return self._get_subsystem_property(
 394            'classic', self._create_classic_subsystem
 395        )  # type: ignore
 396
 397    @staticmethod
 398    def _create_classic_subsystem() -> ClassicSubsystem | None:
 399        # pylint: disable=cyclic-import
 400        try:
 401            from baclassic import ClassicSubsystem
 402
 403            return ClassicSubsystem()
 404        except ImportError:
 405            return None
 406        except Exception:
 407            logging.exception('Error importing baclassic.')
 408            return None
 409
 410    @property
 411    def plus(self) -> PlusSubsystem | None:
 412        """Our plus subsystem (if available)."""
 413        return self._get_subsystem_property(
 414            'plus', self._create_plus_subsystem
 415        )  # type: ignore
 416
 417    @staticmethod
 418    def _create_plus_subsystem() -> PlusSubsystem | None:
 419        # pylint: disable=cyclic-import
 420        try:
 421            from baplus import PlusSubsystem
 422
 423            return PlusSubsystem()
 424        except ImportError:
 425            return None
 426        except Exception:
 427            logging.exception('Error importing baplus.')
 428            return None
 429
 430    @property
 431    def ui_v1(self) -> UIV1Subsystem:
 432        """Our ui_v1 subsystem (always available)."""
 433        return self._get_subsystem_property(
 434            'ui_v1', self._create_ui_v1_subsystem
 435        )  # type: ignore
 436
 437    @staticmethod
 438    def _create_ui_v1_subsystem() -> UIV1Subsystem:
 439        # pylint: disable=cyclic-import
 440
 441        from bauiv1 import UIV1Subsystem
 442
 443        return UIV1Subsystem()
 444
 445    # __FEATURESET_APP_SUBSYSTEM_PROPERTIES_END__
 446
 447    def register_subsystem(self, subsystem: AppSubsystem) -> None:
 448        """Called by the AppSubsystem class. Do not use directly."""
 449
 450        # We only allow registering new subsystems if we've not yet
 451        # reached the 'running' state. This ensures that all subsystems
 452        # receive a consistent set of callbacks starting with
 453        # on_app_running().
 454
 455        if self._subsystem_registration_ended:
 456            raise RuntimeError(
 457                'Subsystems can no longer be registered at this point.'
 458            )
 459        self._subsystems.append(subsystem)
 460
 461    def add_shutdown_task(self, coro: Coroutine[None, None, None]) -> None:
 462        """Add a task to be run on app shutdown.
 463
 464        Note that shutdown tasks will be canceled after
 465        App.SHUTDOWN_TASK_TIMEOUT_SECONDS if they are still running.
 466        """
 467        if (
 468            self.state is self.State.SHUTTING_DOWN
 469            or self.state is self.State.SHUTDOWN_COMPLETE
 470        ):
 471            stname = self.state.name
 472            raise RuntimeError(
 473                f'Cannot add shutdown tasks with current state {stname}.'
 474            )
 475        self._shutdown_tasks.append(coro)
 476
 477    def run(self) -> None:
 478        """Run the app to completion.
 479
 480        Note that this only works on builds where Ballistica manages
 481        its own event loop.
 482        """
 483        _babase.run_app()
 484
 485    def threadpool_submit_no_wait(self, call: Callable[[], Any]) -> None:
 486        """Submit a call to the app threadpool where result is not needed.
 487
 488        Normally, doing work in a thread-pool involves creating a future
 489        and waiting for its result, which is an important step because it
 490        propagates any Exceptions raised by the submitted work. When the
 491        result in not important, however, this call can be used. The app
 492        will log any exceptions that occur.
 493        """
 494        fut = self.threadpool.submit(call)
 495        fut.add_done_callback(self._threadpool_no_wait_done)
 496
 497    def set_intent(self, intent: AppIntent) -> None:
 498        """Set the intent for the app.
 499
 500        Intent defines what the app is trying to do at a given time.
 501        This call is asynchronous; the intent switch will happen in the
 502        logic thread in the near future. If set_intent is called
 503        repeatedly before the change takes place, the final intent to be
 504        set will be used.
 505        """
 506
 507        # Mark this one as pending. We do this synchronously so that the
 508        # last one marked actually takes effect if there is overlap
 509        # (doing this in the bg thread could result in race conditions).
 510        self._pending_intent = intent
 511
 512        # Do the actual work of calcing our app-mode/etc. in a bg thread
 513        # since it may block for a moment to load modules/etc.
 514        self.threadpool_submit_no_wait(partial(self._set_intent, intent))
 515
 516    def push_apply_app_config(self) -> None:
 517        """Internal. Use app.config.apply() to apply app config changes."""
 518        # To be safe, let's run this by itself in the event loop.
 519        # This avoids potential trouble if this gets called mid-draw or
 520        # something like that.
 521        self._pending_apply_app_config = True
 522        _babase.pushcall(self._apply_app_config, raw=True)
 523
 524    def on_native_start(self) -> None:
 525        """Called by the native layer when the app is being started."""
 526        assert _babase.in_logic_thread()
 527        assert not self._native_start_called
 528        self._native_start_called = True
 529        self._update_state()
 530
 531    def on_native_bootstrapping_complete(self) -> None:
 532        """Called by the native layer once its ready to rock."""
 533        assert _babase.in_logic_thread()
 534        assert not self._native_bootstrapping_completed
 535        self._native_bootstrapping_completed = True
 536        self._update_state()
 537
 538    def on_native_suspend(self) -> None:
 539        """Called by the native layer when the app is suspended."""
 540        assert _babase.in_logic_thread()
 541        assert not self._native_suspended  # Should avoid redundant calls.
 542        self._native_suspended = True
 543        self._update_state()
 544
 545    def on_native_unsuspend(self) -> None:
 546        """Called by the native layer when the app suspension ends."""
 547        assert _babase.in_logic_thread()
 548        assert self._native_suspended  # Should avoid redundant calls.
 549        self._native_suspended = False
 550        self._update_state()
 551
 552    def on_native_shutdown(self) -> None:
 553        """Called by the native layer when the app starts shutting down."""
 554        assert _babase.in_logic_thread()
 555        self._native_shutdown_called = True
 556        self._update_state()
 557
 558    def on_native_shutdown_complete(self) -> None:
 559        """Called by the native layer when the app is done shutting down."""
 560        assert _babase.in_logic_thread()
 561        self._native_shutdown_complete_called = True
 562        self._update_state()
 563
 564    def on_native_active_changed(self) -> None:
 565        """Called by the native layer when the app active state changes."""
 566        assert _babase.in_logic_thread()
 567        if self._mode is not None:
 568            self._mode.on_app_active_changed()
 569
 570    def read_config(self) -> None:
 571        """(internal)"""
 572        from babase._appconfig import read_app_config
 573
 574        self._config = read_app_config()
 575
 576    def handle_deep_link(self, url: str) -> None:
 577        """Handle a deep link URL."""
 578        from babase._language import Lstr
 579
 580        assert _babase.in_logic_thread()
 581
 582        appname = _babase.appname()
 583        if url.startswith(f'{appname}://code/'):
 584            code = url.replace(f'{appname}://code/', '')
 585            if self.classic is not None:
 586                self.classic.accounts.add_pending_promo_code(code)
 587        else:
 588            try:
 589                _babase.screenmessage(
 590                    Lstr(resource='errorText'), color=(1, 0, 0)
 591                )
 592                _babase.getsimplesound('error').play()
 593            except ImportError:
 594                pass
 595
 596    def on_initial_sign_in_complete(self) -> None:
 597        """Called when initial sign-in (or lack thereof) completes.
 598
 599        This normally gets called by the plus subsystem. The
 600        initial-sign-in process may include tasks such as syncing
 601        account workspaces or other data so it may take a substantial
 602        amount of time.
 603        """
 604        assert _babase.in_logic_thread()
 605        assert not self._initial_sign_in_completed
 606
 607        # Tell meta it can start scanning extra stuff that just showed
 608        # up (namely account workspaces).
 609        self.meta.start_extra_scan()
 610
 611        self._initial_sign_in_completed = True
 612        self._update_state()
 613
 614    def _set_intent(self, intent: AppIntent) -> None:
 615        # This should be happening in a bg thread.
 616        assert not _babase.in_logic_thread()
 617        try:
 618            # Ask the selector what app-mode to use for this intent.
 619            if self.mode_selector is None:
 620                raise RuntimeError('No AppModeSelector set.')
 621            modetype = self.mode_selector.app_mode_for_intent(intent)
 622
 623            # NOTE: Since intents are somewhat high level things, should
 624            # we do some universal thing like a screenmessage saying
 625            # 'The app cannot handle that request' on failure?
 626
 627            if modetype is None:
 628                raise RuntimeError(
 629                    f'No app-mode found to handle app-intent'
 630                    f' type {type(intent)}.'
 631                )
 632
 633            # Make sure the app-mode the selector gave us *actually*
 634            # supports the intent.
 635            if not modetype.can_handle_intent(intent):
 636                raise RuntimeError(
 637                    f'Intent {intent} cannot be handled by AppMode type'
 638                    f' {modetype} (selector {self.mode_selector}'
 639                    f' incorrectly thinks that it can be).'
 640                )
 641
 642            # Ok; seems legit. Now instantiate the mode if necessary and
 643            # kick back to the logic thread to apply.
 644            mode = modetype()
 645            _babase.pushcall(
 646                partial(self._apply_intent, intent, mode),
 647                from_other_thread=True,
 648            )
 649        except Exception:
 650            logging.exception('Error setting app intent to %s.', intent)
 651            _babase.pushcall(
 652                partial(self._display_set_intent_error, intent),
 653                from_other_thread=True,
 654            )
 655
 656    def _apply_intent(self, intent: AppIntent, mode: AppMode) -> None:
 657        assert _babase.in_logic_thread()
 658
 659        # ONLY apply this intent if it is still the most recent one
 660        # submitted.
 661        if intent is not self._pending_intent:
 662            return
 663
 664        # If the app-mode for this intent is different than the active
 665        # one, switch.
 666        if type(mode) is not type(self._mode):
 667            if self._mode is None:
 668                is_initial_mode = True
 669            else:
 670                is_initial_mode = False
 671                try:
 672                    self._mode.on_deactivate()
 673                except Exception:
 674                    logging.exception(
 675                        'Error deactivating app-mode %s.', self._mode
 676                    )
 677            self._mode = mode
 678            try:
 679                mode.on_activate()
 680            except Exception:
 681                # Hmm; what should we do in this case?...
 682                logging.exception('Error activating app-mode %s.', mode)
 683
 684            # Let the world know when we first have an app-mode; certain
 685            # app stuff such as input processing can proceed at that
 686            # point.
 687            if is_initial_mode:
 688                _babase.on_initial_app_mode_set()
 689
 690        try:
 691            mode.handle_intent(intent)
 692        except Exception:
 693            logging.exception(
 694                'Error handling intent %s in app-mode %s.', intent, mode
 695            )
 696
 697    def _display_set_intent_error(self, intent: AppIntent) -> None:
 698        """Show the *user* something went wrong setting an intent."""
 699        from babase._language import Lstr
 700
 701        del intent
 702        _babase.screenmessage(Lstr(resource='errorText'), color=(1, 0, 0))
 703        _babase.getsimplesound('error').play()
 704
 705    def _on_initing(self) -> None:
 706        """Called when the app enters the initing state.
 707
 708        Here we can put together subsystems and other pieces for the
 709        app, but most things should not be doing any work yet.
 710        """
 711        # pylint: disable=cyclic-import
 712        from babase import _asyncio
 713        from babase import _appconfig
 714        from babase._apputils import AppHealthMonitor
 715        from babase import _env
 716
 717        assert _babase.in_logic_thread()
 718
 719        _env.on_app_state_initing()
 720
 721        self._asyncio_loop = _asyncio.setup_asyncio()
 722        self.health_monitor = AppHealthMonitor()
 723
 724        # __FEATURESET_APP_SUBSYSTEM_CREATE_BEGIN__
 725        # This section generated by batools.appmodule; do not edit.
 726
 727        # Poke these attrs to create all our subsystems.
 728        _ = self.plus
 729        _ = self.classic
 730        _ = self.ui_v1
 731
 732        # __FEATURESET_APP_SUBSYSTEM_CREATE_END__
 733
 734        # We're a pretty short-lived state. This should flip us to
 735        # 'loading'.
 736        self._init_completed = True
 737        self._update_state()
 738
 739    def _on_loading(self) -> None:
 740        """Called when we enter the loading state.
 741
 742        At this point, all built-in pieces of the app should be in place
 743        and can start talking to each other and doing work. Though at a
 744        high level, the goal of the app at this point is only to sign in
 745        to initial accounts, download workspaces, and otherwise prepare
 746        itself to really 'run'.
 747        """
 748        assert _babase.in_logic_thread()
 749
 750        # Get meta-system scanning built-in stuff in the bg.
 751        self.meta.start_scan(scan_complete_cb=self._on_meta_scan_complete)
 752
 753        # Inform all app subsystems in the same order they were inited.
 754        # Operate on a copy here because subsystems can still be added
 755        # at this point.
 756        for subsystem in self._subsystems.copy():
 757            try:
 758                subsystem.on_app_loading()
 759            except Exception:
 760                logging.exception(
 761                    'Error in on_app_loading for subsystem %s.', subsystem
 762                )
 763
 764        # Normally plus tells us when initial sign-in is done. If plus
 765        # is not present, however, we just do it ourself so we can
 766        # proceed on to the running state.
 767        if self.plus is None:
 768            _babase.pushcall(self.on_initial_sign_in_complete)
 769
 770    def _on_meta_scan_complete(self) -> None:
 771        """Called when meta-scan is done doing its thing."""
 772        assert _babase.in_logic_thread()
 773
 774        # Now that we know what's out there, build our final plugin set.
 775        self.plugins.on_meta_scan_complete()
 776
 777        assert not self._meta_scan_completed
 778        self._meta_scan_completed = True
 779        self._update_state()
 780
 781    def _on_running(self) -> None:
 782        """Called when we enter the running state.
 783
 784        At this point, all workspaces, initial accounts, etc. are in place
 785        and we can actually get started doing whatever we're gonna do.
 786        """
 787        assert _babase.in_logic_thread()
 788
 789        # Let our native layer know.
 790        _babase.on_app_running()
 791
 792        # Set a default app-mode-selector if none has been set yet
 793        # by a plugin or whatnot.
 794        if self._mode_selector is None:
 795            self._mode_selector = self.DefaultAppModeSelector()
 796
 797        # Inform all app subsystems in the same order they were
 798        # registered. Operate on a copy here because subsystems can
 799        # still be added at this point.
 800        #
 801        # NOTE: Do we need to allow registering still at this point? If
 802        # something gets registered here, it won't have its
 803        # on_app_running callback called. Hmm; I suppose that's the only
 804        # way that plugins can register subsystems though.
 805        for subsystem in self._subsystems.copy():
 806            try:
 807                subsystem.on_app_running()
 808            except Exception:
 809                logging.exception(
 810                    'Error in on_app_running for subsystem %s.', subsystem
 811                )
 812
 813        # Cut off new subsystem additions at this point.
 814        self._subsystem_registration_ended = True
 815
 816        # If 'exec' code was provided to the app, always kick that off
 817        # here as an intent.
 818        exec_cmd = _babase.exec_arg()
 819        if exec_cmd is not None:
 820            self.set_intent(AppIntentExec(exec_cmd))
 821        elif self._pending_intent is None:
 822            # Otherwise tell the app to do its default thing *only* if a
 823            # plugin hasn't already told it to do something.
 824            self.set_intent(AppIntentDefault())
 825
 826    def _apply_app_config(self) -> None:
 827        assert _babase.in_logic_thread()
 828
 829        _babase.lifecyclelog('apply-app-config')
 830
 831        # If multiple apply calls have been made, only actually apply
 832        # once.
 833        if not self._pending_apply_app_config:
 834            return
 835
 836        _pending_apply_app_config = False
 837
 838        # Inform all app subsystems in the same order they were inited.
 839        # Operate on a copy here because subsystems may still be able to
 840        # be added at this point.
 841        for subsystem in self._subsystems.copy():
 842            try:
 843                subsystem.do_apply_app_config()
 844            except Exception:
 845                logging.exception(
 846                    'Error in do_apply_app_config for subsystem %s.', subsystem
 847                )
 848
 849        # Let the native layer do its thing.
 850        _babase.do_apply_app_config()
 851
 852    def _update_state(self) -> None:
 853        # pylint: disable=too-many-branches
 854        assert _babase.in_logic_thread()
 855
 856        # Shutdown-complete trumps absolutely all.
 857        if self._native_shutdown_complete_called:
 858            if self.state is not self.State.SHUTDOWN_COMPLETE:
 859                self.state = self.State.SHUTDOWN_COMPLETE
 860                _babase.lifecyclelog('app state shutdown complete')
 861                self._on_shutdown_complete()
 862
 863        # Shutdown trumps all. Though we can't start shutting down until
 864        # init is completed since we need our asyncio stuff to exist for
 865        # the shutdown process.
 866        elif self._native_shutdown_called and self._init_completed:
 867            # Entering shutdown state:
 868            if self.state is not self.State.SHUTTING_DOWN:
 869                self.state = self.State.SHUTTING_DOWN
 870                _babase.lifecyclelog('app state shutting down')
 871                self._on_shutting_down()
 872
 873        elif self._native_suspended:
 874            # Entering suspended state:
 875            if self.state is not self.State.SUSPENDED:
 876                self.state = self.State.SUSPENDED
 877                self._on_suspend()
 878        else:
 879            # Leaving suspended state:
 880            if self.state is self.State.SUSPENDED:
 881                self._on_unsuspend()
 882
 883            # Entering or returning to running state
 884            if self._initial_sign_in_completed and self._meta_scan_completed:
 885                if self.state != self.State.RUNNING:
 886                    self.state = self.State.RUNNING
 887                    _babase.lifecyclelog('app state running')
 888                    if not self._called_on_running:
 889                        self._called_on_running = True
 890                        self._on_running()
 891            # Entering or returning to loading state:
 892            elif self._init_completed:
 893                if self.state is not self.State.LOADING:
 894                    self.state = self.State.LOADING
 895                    _babase.lifecyclelog('app state loading')
 896                    if not self._called_on_loading:
 897                        self._called_on_loading = True
 898                        self._on_loading()
 899
 900            # Entering or returning to initing state:
 901            elif self._native_bootstrapping_completed:
 902                if self.state is not self.State.INITING:
 903                    self.state = self.State.INITING
 904                    _babase.lifecyclelog('app state initing')
 905                    if not self._called_on_initing:
 906                        self._called_on_initing = True
 907                        self._on_initing()
 908
 909            # Entering or returning to native bootstrapping:
 910            elif self._native_start_called:
 911                if self.state is not self.State.NATIVE_BOOTSTRAPPING:
 912                    self.state = self.State.NATIVE_BOOTSTRAPPING
 913                    _babase.lifecyclelog('app state native bootstrapping')
 914            else:
 915                # Only logical possibility left is NOT_STARTED, in which
 916                # case we should not be getting called.
 917                logging.warning(
 918                    'App._update_state called while in %s state;'
 919                    ' should not happen.',
 920                    self.state.value,
 921                    stack_info=True,
 922                )
 923
 924    async def _shutdown(self) -> None:
 925        import asyncio
 926
 927        _babase.lock_all_input()
 928        try:
 929            async with asyncio.TaskGroup() as task_group:
 930                for task_coro in self._shutdown_tasks:
 931                    # Note: Mypy currently complains if we don't take
 932                    # this return value, but we don't actually need to.
 933                    # https://github.com/python/mypy/issues/15036
 934                    _ = task_group.create_task(
 935                        self._run_shutdown_task(task_coro)
 936                    )
 937        except* Exception:
 938            logging.exception('Unexpected error(s) in shutdown.')
 939
 940        # Note: ideally we should run this directly here, but currently
 941        # it does some legacy stuff which blocks, so running it here
 942        # gives us asyncio task-took-too-long warnings. If we can
 943        # convert those to nice graceful async tasks we should revert
 944        # this to a direct call.
 945        _babase.pushcall(_babase.complete_shutdown)
 946
 947    async def _run_shutdown_task(
 948        self, coro: Coroutine[None, None, None]
 949    ) -> None:
 950        """Run a shutdown task; report errors and abort if taking too long."""
 951        import asyncio
 952
 953        task = asyncio.create_task(coro)
 954        try:
 955            await asyncio.wait_for(task, self.SHUTDOWN_TASK_TIMEOUT_SECONDS)
 956        except Exception:
 957            logging.exception('Error in shutdown task (%s).', coro)
 958
 959    def _on_suspend(self) -> None:
 960        """Called when the app goes to a suspended state."""
 961        assert _babase.in_logic_thread()
 962
 963        # Suspend all app subsystems in the opposite order they were inited.
 964        for subsystem in reversed(self._subsystems):
 965            try:
 966                subsystem.on_app_suspend()
 967            except Exception:
 968                logging.exception(
 969                    'Error in on_app_suspend for subsystem %s.', subsystem
 970                )
 971
 972    def _on_unsuspend(self) -> None:
 973        """Called when unsuspending."""
 974        assert _babase.in_logic_thread()
 975        self.fg_state += 1
 976
 977        # Unsuspend all app subsystems in the same order they were inited.
 978        for subsystem in self._subsystems:
 979            try:
 980                subsystem.on_app_unsuspend()
 981            except Exception:
 982                logging.exception(
 983                    'Error in on_app_unsuspend for subsystem %s.', subsystem
 984                )
 985
 986    def _on_shutting_down(self) -> None:
 987        """(internal)"""
 988        assert _babase.in_logic_thread()
 989
 990        # Inform app subsystems that we're shutting down in the opposite
 991        # order they were inited.
 992        for subsystem in reversed(self._subsystems):
 993            try:
 994                subsystem.on_app_shutdown()
 995            except Exception:
 996                logging.exception(
 997                    'Error in on_app_shutdown for subsystem %s.', subsystem
 998                )
 999
1000        # Now kick off any async shutdown task(s).
1001        assert self._asyncio_loop is not None
1002        self._shutdown_task = self._asyncio_loop.create_task(self._shutdown())
1003
1004    def _on_shutdown_complete(self) -> None:
1005        """(internal)"""
1006        assert _babase.in_logic_thread()
1007
1008        # Inform app subsystems that we're done shutting down in the opposite
1009        # order they were inited.
1010        for subsystem in reversed(self._subsystems):
1011            try:
1012                subsystem.on_app_shutdown_complete()
1013            except Exception:
1014                logging.exception(
1015                    'Error in on_app_shutdown_complete for subsystem %s.',
1016                    subsystem,
1017                )
1018
1019    async def _wait_for_shutdown_suppressions(self) -> None:
1020        import asyncio
1021
1022        # Spin and wait for anything blocking shutdown to complete.
1023        starttime = _babase.apptime()
1024        _babase.lifecyclelog('shutdown-suppress wait begin')
1025        while _babase.shutdown_suppress_count() > 0:
1026            await asyncio.sleep(0.001)
1027        _babase.lifecyclelog('shutdown-suppress wait end')
1028        duration = _babase.apptime() - starttime
1029        if duration > 1.0:
1030            logging.warning(
1031                'Shutdown-suppressions lasted longer than ideal '
1032                '(%.2f seconds).',
1033                duration,
1034            )
1035
1036    async def _fade_and_shutdown_graphics(self) -> None:
1037        import asyncio
1038
1039        # Kick off a short fade and give it time to complete.
1040        _babase.lifecyclelog('fade-and-shutdown-graphics begin')
1041        _babase.fade_screen(False, time=0.15)
1042        await asyncio.sleep(0.15)
1043
1044        # Now tell the graphics system to go down and wait until
1045        # it has done so.
1046        _babase.graphics_shutdown_begin()
1047        while not _babase.graphics_shutdown_is_complete():
1048            await asyncio.sleep(0.01)
1049        _babase.lifecyclelog('fade-and-shutdown-graphics end')
1050
1051    async def _fade_and_shutdown_audio(self) -> None:
1052        import asyncio
1053
1054        # Tell the audio system to go down and give it a bit of
1055        # time to do so gracefully.
1056        _babase.lifecyclelog('fade-and-shutdown-audio begin')
1057        _babase.audio_shutdown_begin()
1058        await asyncio.sleep(0.15)
1059        while not _babase.audio_shutdown_is_complete():
1060            await asyncio.sleep(0.01)
1061        _babase.lifecyclelog('fade-and-shutdown-audio end')
1062
1063    def _threadpool_no_wait_done(self, fut: Future) -> None:
1064        try:
1065            fut.result()
1066        except Exception:
1067            logging.exception(
1068                'Error in work submitted via threadpool_submit_no_wait()'
1069            )
1070
1071    def _thread_pool_thread_init(self) -> None:
1072        # Help keep things clear in profiling tools/etc.
1073        self._pool_thread_count += 1
1074        _babase.set_thread_name(f'ballistica worker-{self._pool_thread_count}')