beanie_init fails on index key pair validation

[astrochun]

Hello,

I recently have been updating my software to support pydantic 2+ (Yes, I realized I'm slow). Everything seem to be working fine but then I was unable to support my local database.

I received the following error:

╭─────────────────────────────── Traceback (most recent call last) ────────────────────────────────╮
│                                                                                                  │
│ /Users/chun/codes/PPPL/pppl-elink2411-metadata/./scripts/make_csv_metadata:83 in <module>        │
│                                                                                                  │
│    80 │                                                                                          │
│    81 │   mongo_client = None                                                                    │
│    82 │   try:                                                                                   │
│ ❱  83 │   │   mongo_client = databases.PumaMongo()                                               │
│    84 │   except ServerSelectionTimeoutError:                                                    │
│    85 │   │   log.warning("[bold red]MongoDB not active")                                        │
│    86 │   │   pass                                                                               │
│ /Users/chun/codes/PPPL/pppl-elink2411-metadata/puma_metadata/databases.py:75 in __init__         │
│                                                                                                  │
│    72 │   │                                                                                      │
│    73 │   │   self.pram_db = self.client["pram"]                                                 │
│    74 │   │   self.pacm_db = self.client["pacm"]                                                 │
│ ❱  75 │   │   self.beanie_init()                                                                 │
│    76 │   │   log.debug("[bold dark_green]✔ PumaMongo set!")                                     │
│    77 │   │                                                                                      │
│    78 │   │   self.create_document = create_document                                             │
│                                                                                                  │
│ /Users/chun/codes/PPPL/pppl-elink2411-metadata/puma_metadata/databases.py:86 in beanie_init      │
│                                                                                                  │
│    83 │   def beanie_init(self):                                                                 │
│    84 │   │   """Initialize beanie ODM"""                                                        │
│    85 │   │   loop = get_loop()                                                                  │
│ ❱  86 │   │   loop.run_until_complete(beanie_init(self.address))                                 │
│    87 │                                                                                          │
│    88 │   def add_elink_data(self, data: dict):  # pragma: no cover                              │
│    89 │   │   """Add E-Link document to E-Link data collection"""                                │
│                                                                                                  │
│ /Users/chun/.conda/envs/py310/lib/python3.10/asyncio/base_events.py:641 in run_until_complete    │
│                                                                                                  │
│    638 │   │   if not future.done():                                                             │
│    639 │   │   │   raise RuntimeError('Event loop stopped before Future completed.')             │
│    640 │   │                                                                                     │
│ ❱  641 │   │   return future.result()                                                            │
│    642 │                                                                                         │
│    643 │   def stop(self):                                                                       │
│    644 │   │   """Stop running the event loop.                                                   │
│                                                                                                  │
│ /Users/chun/codes/PPPL/pppl-elink2411-metadata/puma_metadata/databases.py:215 in beanie_init     │
│                                                                                                  │
│   212 │   │   await init_beanie(                                                                 │
│   213 │   │   │   database=client.pacm, document_models=[Alert, KPI, PACMSummary, PEMP]          │
│   214 │   │   )                                                                                  │
│ ❱ 215 │   │   await init_beanie(database=client.pram, document_models=[Crossref, WOS])           │
│   216 │   except OperationFailure:  # pragma: no cover                                           │
│   217 │   │   msg = "Server does not seem active/alive or incorrect login!"                      │
│   218 │   │   log.warning(f"[bold red]{msg}")                                                    │
│                                                                                                  │
│ /Users/chun/codes/PPPL/pppl-elink2411-metadata/venv/lib/python3.10/site-packages/beanie/odm/util │
│ s/init.py:750 in init_beanie                                                                     │
│                                                                                                  │
│   747 │   :return: None                                                                          │
│   748 │   """                                                                                    │
│   749 │                                                                                          │
│ ❱ 750 │   await Initializer(                                                                     │
│   751 │   │   database=database,                                                                 │
│   752 │   │   connection_string=connection_string,                                               │
│   753 │   │   document_models=document_models,                                                   │
│                                                                                                  │
│ /Users/chun/codes/PPPL/pppl-elink2411-metadata/venv/lib/python3.10/site-packages/beanie/odm/util │
│ s/init.py:128 in __await__                                                                       │
│                                                                                                  │
│   125 │                                                                                          │
│   126 │   def __await__(self):                                                                   │
│   127 │   │   for model in self.document_models:                                                 │
│ ❱ 128 │   │   │   yield from self.init_class(model).__await__()                                  │
│   129 │                                                                                          │
│   130 │   # General                                                                              │
│   131 │   def fill_docs_registry(self):                                                          │
│                                                                                                  │
│ /Users/chun/codes/PPPL/pppl-elink2411-metadata/venv/lib/python3.10/site-packages/beanie/odm/util │
│ s/init.py:713 in init_class                                                                      │
│                                                                                                  │
│   710 │   │   self.check_deprecations(cls)                                                       │
│   711 │   │                                                                                      │
│   712 │   │   if issubclass(cls, Document):                                                      │
│ ❱ 713 │   │   │   await self.init_document(cls)                                                  │
│   714 │   │                                                                                      │
│   715 │   │   if issubclass(cls, View):                                                          │
│   716 │   │   │   await self.init_view(cls)                                                      │
│                                                                                                  │
│ /Users/chun/codes/PPPL/pppl-elink2411-metadata/venv/lib/python3.10/site-packages/beanie/odm/util │
│ s/init.py:577 in init_document                                                                   │
│                                                                                                  │
│   574 │   │   │   │   cls._inheritance_inited = True                                             │
│   575 │   │   │                                                                                  │
│   576 │   │   │   await self.init_document_collection(cls)                                       │
│ ❱ 577 │   │   │   await self.init_indexes(cls, self.allow_index_dropping)                        │
│   578 │   │   │   self.init_document_fields(cls)                                                 │
│   579 │   │   │   self.init_cache(cls)                                                           │
│   580 │   │   │   self.init_actions(cls)                                                         │
│                                                                                                  │
│ /Users/chun/codes/PPPL/pppl-elink2411-metadata/venv/lib/python3.10/site-packages/beanie/odm/util │
│ s/init.py:469 in init_indexes                                                                    │
│                                                                                                  │
│   466 │   │                                                                                      │
│   467 │   │   index_information = await collection.index_information()                           │
│   468 │   │                                                                                      │
│ ❱ 469 │   │   old_indexes = IndexModelField.from_motor_index_information(                        │
│   470 │   │   │   index_information                                                              │
│   471 │   │   )                                                                                  │
│   472 │   │   new_indexes = []                                                                   │
│                                                                                                  │
│ /Users/chun/codes/PPPL/pppl-elink2411-metadata/venv/lib/python3.10/site-packages/beanie/odm/fiel │
│ ds.py:546 in from_motor_index_information                                                        │
│                                                                                                  │
│   543 │   │   │                                                                                  │
│   544 │   │   │   options = {k: v for k, v in details.items() if k != "key"}                     │
│   545 │   │   │   index_model = IndexModelField(                                                 │
│ ❱ 546 │   │   │   │   IndexModel(fields, name=name, **options)                                   │
│   547 │   │   │   )                                                                              │
│   548 │   │   │   result.append(index_model)                                                     │
│   549 │   │   return result                                                                      │
│                                                                                                  │
│ /Users/chun/codes/PPPL/pppl-elink2411-metadata/venv/lib/python3.10/site-packages/pymongo/operati │
│ ons.py:572 in __init__                                                                           │
│                                                                                                  │
│   569 │   │   keys = _index_list(keys)                                                           │
│   570 │   │   if kwargs.get("name") is None:                                                     │
│   571 │   │   │   kwargs["name"] = _gen_index_name(keys)                                         │
│ ❱ 572 │   │   kwargs["key"] = _index_document(keys)                                              │
│   573 │   │   collation = validate_collation_or_none(kwargs.pop("collation", None))              │
│   574 │   │   self.__document = kwargs                                                           │
│   575 │   │   if collation is not None:                                                          │
│                                                                                                  │
│ /Users/chun/codes/PPPL/pppl-elink2411-metadata/venv/lib/python3.10/site-packages/pymongo/helpers │
│ .py:169 in _index_document                                                                       │
│                                                                                                  │
│   166 │   │   │   if isinstance(item, str):                                                      │
│   167 │   │   │   │   item = (item, ASCENDING)  # noqa: PLW2901                                  │
│   168 │   │   │   key, value = item                                                              │
│ ❱ 169 │   │   │   _validate_index_key_pair(key, value)                                           │
│   170 │   │   │   index[key] = value                                                             │
│   171 │   return index                                                                           │
│   172                                                                                            │
│                                                                                                  │
│ /Users/chun/codes/PPPL/pppl-elink2411-metadata/venv/lib/python3.10/site-packages/pymongo/helpers │
│ .py:178 in _validate_index_key_pair                                                              │
│                                                                                                  │
│   175 │   if not isinstance(key, str):                                                           │
│   176 │   │   raise TypeError("first item in each key pair must be an instance of str")          │
│   177 │   if not isinstance(value, (str, int, abc.Mapping)):                                     │
│ ❱ 178 │   │   raise TypeError(                                                                   │
│   179 │   │   │   "second item in each key pair must be 1, -1, "                                 │
│   180 │   │   │   "'2d', or another valid MongoDB index specifier."                              │
│   181 │   │   )                                                                                  │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯

The code works perfectly find with a MongoDB test database server on mongo.com with MongoDB version of 7.0.3.

I updated pymongo to v4.8.0, motor to v3.5.1, and beanie to v1.26.0.

It could be that the version of the mongo daemon that I'm running locally is too outdated, but the documentation for pymongo suggests that v5.0.3 is supported. Using mongo CLI, I had no issue accessing the database so this might simply be stupid compatibility issue.

Any thoughts? I was thinking of updating my mongo client first, but worry this might break things.