From 70ab60ce7cc9e367d5832364be07369a28e30e3b Mon Sep 17 00:00:00 2001
From: Tyler Goodlet <jgbt@protonmail.com>
Date: Wed, 3 Apr 2024 09:45:03 -0400
Subject: [PATCH] Flip default codec to our `Msg`-spec

Yes, this is "the switch" and will likely cause the test suite to bail
until a few more fixes some in.

Tweaked a couple `.msg` pkg exports:
- remove `__spec__` (used by modules) and change it to `__msg_types:
  lists[Msg]` as well as add a new `__msg_spec__: TypeAlias`, being the
  default `Any` paramed spec.
- tweak the naming of `msg.types` lists of runtime vs payload msgs to:
  `._runtime_msgs` and `._payload_msgs`.
- just build `__msg_types__` out of the above 2 lists.
---
 tractor/msg/__init__.py | 12 ++++++--
 tractor/msg/_codec.py   |  4 +--
 tractor/msg/types.py    | 61 +++++++++++++++++++++++------------------
 3 files changed, 47 insertions(+), 30 deletions(-)

diff --git a/tractor/msg/__init__.py b/tractor/msg/__init__.py
index d8f3747..fe965e0 100644
--- a/tractor/msg/__init__.py
+++ b/tractor/msg/__init__.py
@@ -18,6 +18,10 @@
 Built-in messaging patterns, types, APIs and helpers.
 
 '''
+from typing import (
+    Union,
+    TypeAlias,
+)
 from .ptr import (
     NamespacePath as NamespacePath,
 )
@@ -50,6 +54,10 @@ from .types import (
 
     Error as Error,
 
-    # full msg spec set
-    __spec__ as __spec__,
+    # full msg class set from above as list
+    __msg_types__ as __msg_types__,
 )
+# TODO: use new type declaration syntax for msg-type-spec
+# https://docs.python.org/3/library/typing.html#type-aliases
+# https://docs.python.org/3/reference/simple_stmts.html#type
+__msg_spec__: TypeAlias = Union[*__msg_types__]
diff --git a/tractor/msg/_codec.py b/tractor/msg/_codec.py
index 32a58a5..56f24d6 100644
--- a/tractor/msg/_codec.py
+++ b/tractor/msg/_codec.py
@@ -438,8 +438,8 @@ _ctxvar_MsgCodec: MsgCodec = RunVar(
     'msgspec_codec',
 
     # TODO: move this to our new `Msg`-spec!
-    default=_def_msgspec_codec,
-    # default=_def_tractor_codec,
+    # default=_def_msgspec_codec,
+    default=_def_tractor_codec,
 )
 
 
diff --git a/tractor/msg/types.py b/tractor/msg/types.py
index a81473d..b246cb6 100644
--- a/tractor/msg/types.py
+++ b/tractor/msg/types.py
@@ -26,7 +26,7 @@ from __future__ import annotations
 import types
 from typing import (
     Any,
-    Callable,
+    # Callable,
     Generic,
     Literal,
     Type,
@@ -340,50 +340,54 @@ class Error(
 # class Overrun(Msg):
 #     cid: str
 
+_runtime_msgs: list[Msg] = [
 
-# built-in SC shuttle protocol msg type set in
-# approx order of the IPC txn-state spaces.
-__spec__: list[Msg] = [
-
-    # identity handshake
+    # identity handshake on first IPC `Channel` contact.
     Aid,
 
-    # spawn specification from parent
+    # parent-to-child spawn specification passed as 2nd msg after
+    # handshake ONLY after child connects back to parent.
     SpawnSpec,
 
     # inter-actor RPC initiation
-    Start,
-    StartAck,
+    Start,  # schedule remote task-as-func
+    StartAck,  # ack the schedule request
 
-    # no-outcome-yet IAC (inter-actor-communication)
-    Started,
-    Yield,
+    # emission from `MsgStream.aclose()`
     Stop,
 
-    # termination outcomes
-    Return,
+    # box remote errors, normally subtypes
+    # of `RemoteActorError`.
     Error,
 ]
 
-_runtime_spec_msgs: list[Msg] = [
-    Aid,
-    SpawnSpec,
-    Start,
-    StartAck,
-    Stop,
-    Error,
-]
-_payload_spec_msgs: list[Msg] = [
+# the no-outcome-yet IAC (inter-actor-communication) sub-set which
+# can be `Msg.pld` payload field type-limited by application code
+# using `apply_codec()` and `limit_msg_spec()`.
+_payload_msgs: list[Msg] = [
+    # first <value> from `Context.started(<value>)`
     Started,
+
+    # any <value> sent via `MsgStream.send(<value>)`
     Yield,
+
+    # the final value returned from a `@context` decorated
+    # IPC endpoint.
     Return,
 ]
 
+# built-in SC shuttle protocol msg type set in
+# approx order of the IPC txn-state spaces.
+__msg_types__: list[Msg] = (
+    _runtime_msgs
+    +
+    _payload_msgs
+)
+
 
 def mk_msg_spec(
     payload_type_union: Union[Type] = Any,
 
-    # boxing_msg_set: list[Msg] = _payload_spec_msgs,
     spec_build_method: Literal[
         'indexed_generics',  # works
         'defstruct',
@@ -424,12 +428,12 @@ def mk_msg_spec(
     defs_msg_types: list[Msg] = []
     nc_msg_types: list[Msg] = []
 
-    for msgtype in __spec__:
+    for msgtype in __msg_types__:
 
         # for the NON-payload (user api) type specify-able
         # msgs types, we simply aggregate the def as is
         # for inclusion in the output type `Union`.
-        if msgtype not in _payload_spec_msgs:
+        if msgtype not in _payload_msgs:
             ipc_msg_types.append(msgtype)
             continue
 
@@ -535,6 +539,11 @@ def mk_msg_spec(
 
 # TODO: make something similar to this inside `._codec` such that
 # user can just pass a type table of some sort?
+# -[ ] we would need to decode all msgs to `pretty_struct.Struct`
+#   and then call `.to_dict()` on them?
+# -[ ] we're going to need to re-impl all the stuff changed in the
+# runtime port such that it can handle dicts or `Msg`s?
+#
 # def mk_dict_msg_codec_hooks() -> tuple[Callable, Callable]:
 #     '''
 #     Deliver a `enc_hook()`/`dec_hook()` pair which does