fix: index settings inherited, not mappings

aaxelb · aaxelb · commit d7e0483972a5 · 2026-04-16T08:58:29.000-04:00
diff --git a/elasticsearch_metrics/imps/elastic8.py b/elasticsearch_metrics/imps/elastic8.py
@@ -120,6 +120,32 @@ def __new__(mcls, name, bases, attrs):  # noqa: B902
             )
         return _cls
 
+    @classmethod
+    def construct_index(cls, opts, bases):
+        """
+        Override IndexMeta.construct_index so a new Index is created for each class
+        and Index.settings, Index.analyzers, and Index.using are inherited
+        (but not Index.name or Index.aliases)
+        """
+        _base_index_configs = collections.ChainMap(
+            *(base._index.to_dict() for base in bases if hasattr(base, "_index"))
+        )
+        _index_opts = opts or type("Index", (), {})
+        if not hasattr(_index_opts, "settings") and (
+            _inherited_settings := _base_index_configs.get("settings")
+        ):
+            _index_opts.settings = _inherited_settings
+        if not hasattr(_index_opts, "analyzers") and (
+            _inherited_analyzers := _base_index_configs.get("analyzers")
+        ):
+            _index_opts.analyzers = _inherited_analyzers
+        if not hasattr(_index_opts, "using"):
+            _inherited_using = _base_index_configs.get("using")
+            if _inherited_using and (_inherited_using != "default"):
+                _index_opts.using = _inherited_using
+        assert _index_opts is not None  # guarantee separate index per class
+        return super().construct_index(_index_opts, bases)
+
     def _get_meta_attr(self, attr_name: str, default: typing.Any = None) -> typing.Any:
         _meta = getattr(self, "Meta", None)
         return getattr(_meta, attr_name, default)
@@ -189,6 +215,7 @@ def record(
             to use to save, or `False` to skip saving (e.g. for use in a bulk operation)
         all other kwargs passed thru to the class constructor
         """
+        assert not cls.is_abstract
         _instance = cls(**kwargs)
         if using is not False:
             _instance.save(using=using)
@@ -241,6 +268,7 @@ def save(
         - populate document id based on UNIQUE_TOGETHER_FIELDS
         - send pre_save/post_save signals
         """
+        assert not self.__class__.is_abstract
         self.require_been_setup(using=using)  # prevent automapped indexes
         self._populate_unique_id()
         signals.pre_save.send(self.__class__, instance=self, using=using, index=index)
@@ -276,31 +304,34 @@ def __new__(mcls, name, bases, attrs):  # noqa: B902
         """
         extend _DjelmeRecordMetaclass.__new__ to set index name by app label and type name
         """
-        _index = attrs.get("Index")
-        if not _index:
-            _index = type("Index", (), {})
-            attrs["Index"] = _index
-        if not getattr(_index, "name", None):
-            _app_label = find_app_label_for_module(attrs["__module__"])
-            _index.name = f"{_app_label.lower()}_{name.lower()}"
-        return super().__new__(mcls, name, bases, attrs)
+        _cls = super().__new__(mcls, name, bases, attrs)
+        if not _cls.is_abstract:
+            # set `_index._name`, if not already specified
+            _index_name = _cls._index._name
+            if not _index_name or (_index_name in ("*", "default")):
+                _app_label = find_app_label_for_module(attrs["__module__"])
+                _index_name = f"{_app_label.lower()}_{_cls.__name__.lower()}"
+            _prefix = _cls.get_index_name_prefix()
+            if not _index_name.startswith(_prefix):
+                _index_name = f"{_prefix}{_index_name}"
+            _cls._index._name = _index_name
+            # set `_index._using`, so `_index` can be used normally
+            _backend = djelme_registry.get_backend_for_recordtype(_cls)
+            _cls._index._using = _backend._elastic8dsl_connection_name
+        return _cls
 
 
 class SimpleRecord(BaseDjelmeRecord, metaclass=_SimpleRecordMetaclass):
-    def __init_subclass__(cls, **kwargs):
-        super().__init_subclass__(**kwargs)
-        if not cls.is_abstract:
-            _prefix = cls.get_index_name_prefix()
-            _name = cls._index._name
-            if not _name.startswith(_prefix):
-                cls._index._name = f"{_prefix}{_name}"
+    class Meta:
+        abstract = True
 
     @classmethod
     def djelme_index_name(cls) -> str:
         """the index name for this record type
 
         for ProtoDjelmeRecord
         """
+        assert not cls.is_abstract
         return cls._index._name
 
     @classmethod
@@ -311,6 +342,7 @@ def check_djelme_setup(cls, using: str | None = None) -> None:
         :raise: IndexOutOfSyncError if mappings are out of sync.
         :return: if index exists and mappings are in sync.
         """
+        assert not cls.is_abstract
         _client = cls._get_connection(using)
         _index_name = cls.djelme_index_name()
         try:
@@ -330,10 +362,13 @@ def check_djelme_setup(cls, using: str | None = None) -> None:
 
     @classmethod
     def do_teardown(cls, es_client):
+        assert not cls.is_abstract
         cls._index.delete(using=es_client, ignore_unavailable=True)
 
-    class Meta:
-        abstract = True
+    @classmethod
+    def refresh(cls, using: str | None = None) -> None:
+        assert not cls.is_abstract
+        cls._index.refresh(using=using)
 
 
 class TimeseriesRecord(BaseDjelmeRecord):
@@ -366,6 +401,7 @@ def search(
     ) -> esdsl.Search[
         "typing.Self"
     ]:  # typing.Self added in py 3.11 -- str annotation until 3.10 eol
+        assert not cls.is_abstract
         return super().search(
             using=using,
             index=(index or cls.format_timeseries_index_pattern()),
@@ -389,7 +425,8 @@ def search_timeseries_range(
         return cls.search(index=_index_pattern).filter(_timeseries_q)
 
     @classmethod
-    def refresh_timeseries_indexes(cls, using: str | None = None) -> None:
+    def refresh(cls, using: str | None = None) -> None:
+        assert not cls.is_abstract
         cls._get_connection(using).indices.refresh(
             index=cls.format_timeseries_index_pattern()
         )
@@ -408,6 +445,7 @@ def each_timeseries_index(
 
     @classmethod
     def do_teardown(cls, es8_client: Elastic8Client) -> None:
+        assert not cls.is_abstract
         _indexname_wildcard = cls.format_timeseries_index_pattern()
         _indices = es8_client.indices.get(index=_indexname_wildcard, features=",")
         for _index_name in _indices.keys():
@@ -420,6 +458,7 @@ def do_teardown(cls, es8_client: Elastic8Client) -> None:
 
     @classmethod
     def get_timeseries_template(cls) -> esdsl.ComposableIndexTemplate:
+        assert not cls.is_abstract
         return cls._index.as_composable_template(
             template_name=cls.get_timeseries_template_name(),
             pattern=cls.format_timeseries_index_pattern(),
diff --git a/elasticsearch_metrics/tests/dummy8app/metrics.py b/elasticsearch_metrics/tests/dummy8app/metrics.py
@@ -10,9 +10,6 @@
 class Dummy8Event(djelme.EventRecord):
     intensity: int
 
-    class Index:
-        using = "my_elastic8_events"
-
 
 class Monthly8Event(djelme.EventRecord):
     intenzity: int
@@ -22,9 +19,6 @@ class Meta:
         timeseries_recordtype_name = "eventlog"
         timedepth = 2
 
-    class Index:
-        using = "my_elastic8_events"
-
 
 class ThingHappened(djelme.EventRecord):
     thing_id: str = ""
@@ -36,7 +30,6 @@ class ThingHappened(djelme.EventRecord):
 
     class Index:
         settings = {"refresh_interval": "-1"}
-        using = "my_elastic8_events"
 
     class Meta:
         timeseries_recordtype_name = "happen"
@@ -50,9 +43,6 @@ class ThingHappeningsReport(djelme.CyclicRecord):
     thing_id: str
     happen_count: int
 
-    class Index:
-        using = "my_elastic8_reports"
-
     class Meta:
         index_name_prefix = "blarg_"
         timedepth = 2  # monthly timeseries indexes
@@ -62,6 +52,3 @@ class SimpleKV(djelme.SimpleRecord):
     UNIQUE_TOGETHER_FIELDS = ("key",)
     key: str
     val: int
-
-    class Index:
-        using = "my_elastic8_reports"
diff --git a/elasticsearch_metrics/tests/settings.py b/elasticsearch_metrics/tests/settings.py
@@ -19,12 +19,7 @@
             "hosts": os.environ.get("ELASTICSEARCH6_URL", ""),
         },
     },
-    "my_elastic8_events": {
-        "elasticsearch_metrics.imps.elastic8": {
-            "hosts": os.environ.get("ELASTICSEARCH8_URL", ""),
-        },
-    },
-    "my_elastic8_reports": {
+    "my_elastic8": {
         "elasticsearch_metrics.imps.elastic8": {
             "hosts": os.environ.get("ELASTICSEARCH8_URL", ""),
         },
diff --git a/elasticsearch_metrics/tests/test_imps_elastic8.py b/elasticsearch_metrics/tests/test_imps_elastic8.py
@@ -30,7 +30,7 @@
 
 
 def _es8_client(
-    backend_name: str = "my_elastic8_events",
+    backend_name: str = "my_elastic8",
 ) -> elasticsearch8.Elasticsearch:
     _backend = djelme_registry.get_backend(backend_name)
     assert isinstance(_backend, djelme.DjelmeElastic8Backend)
@@ -224,9 +224,6 @@ def test_get_index_template_default_template_name(self):
 
     def test_get_index_template_uses_app_label_in_class_meta(self):
         class MyRecord(djelme.TimeseriesRecord):
-            class Index:
-                using = "my_elastic8_events"
-
             class Meta:
                 app_label = "myapp"
 
@@ -248,7 +245,6 @@ class MyBaseRecord(djelme.TimeseriesRecord):
 
             class Index:
                 settings = {"number_of_shards": 2}
-                using = "my_elastic8_events"
 
             class Meta:
                 abstract = True
@@ -263,9 +259,6 @@ class Meta:
 
     def test_source_may_be_enabled(self):
         class MyRecord(djelme.TimeseriesRecord):
-            class Index:
-                using = "my_elastic8_events"
-
             class Meta:
                 app_label = "dummy8app"
                 timeseries_recordtype_name = "myrecord"
@@ -475,7 +468,7 @@ def setUp(self):
         Dummy8Event.record(timestamp=dt.datetime(1235, 5, 6), intensity=111)
         Dummy8Event.record(timestamp=dt.datetime(2345, 6, 9), intensity=11)
         Dummy8Event.record(timestamp=dt.datetime(2345, 7, 9), intensity=13)
-        Dummy8Event.refresh_timeseries_indexes()
+        Dummy8Event.refresh()
 
     def test_indexes(self):
         _index_names = {
@@ -537,7 +530,7 @@ def setUp(self):
         Monthly8Event.record(timestamp=dt.datetime(1235, 5, 6), intenzity=111)
         Monthly8Event.record(timestamp=dt.datetime(2345, 6, 9), intenzity=11)
         Monthly8Event.record(timestamp=dt.datetime(2345, 7, 9), intenzity=13)
-        Monthly8Event.refresh_timeseries_indexes()
+        Monthly8Event.refresh()
 
     def test_indexes(self):
         _index_names = {
@@ -598,7 +591,7 @@ def setUp(self):
         ThingHappened.record(timestamp=dt.datetime(1235, 5, 6), thing_id="e")
         ThingHappened.record(timestamp=dt.datetime(2345, 6, 9), thing_id="f")
         ThingHappened.record(timestamp=dt.datetime(2345, 7, 9), thing_id="g")
-        ThingHappened.refresh_timeseries_indexes()
+        ThingHappened.refresh()
 
     def test_indexes(self):
         _index_names = {
@@ -671,7 +664,7 @@ def setUp(self):
         ThingHappeningsReport.record(
             cycle_coverage="2000.2", thing_id="c", happen_count=7
         )
-        ThingHappeningsReport.refresh_timeseries_indexes()
+        ThingHappeningsReport.refresh()
 
     def test_indexes(self):
         _index_names = {
@@ -718,7 +711,7 @@ def setUp(self):
         super().setUp()
         SimpleKV.record(key="hello", val=2)
         SimpleKV.record(key="goodbye", val=-2)
-        SimpleKV._index.refresh()
+        SimpleKV.refresh()
 
     def test_search(self):
         (_hello,) = SimpleKV.search().query({"term": {"key": "hello"}}).execute()
