strukto-ai--mirage/python/mirage/core/databricks_volume/readdir.py

# ========= Copyright 2026 @ Strukto.AI All Rights Reserved. =========
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ========= Copyright 2026 @ Strukto.AI All Rights Reserved. =========

import asyncio
import logging

from mirage.accessor.databricks_volume import DatabricksVolumeAccessor
from mirage.cache.index import IndexCacheStore, IndexEntry
from mirage.core.databricks_volume.errors import is_not_found
from mirage.core.databricks_volume.path import backend_path, virtual_path
from mirage.core.databricks_volume.stat import modified_to_iso
from mirage.types import PathSpec
from mirage.utils.errors import enoent
from mirage.utils.key_prefix import mount_prefix_of

logger = logging.getLogger(__name__)
SCOPE_ERROR = 10_000


def _list_directory_sync(
    accessor: DatabricksVolumeAccessor,
    remote_path: str,
) -> list[object]:
    return list(accessor.files.list_directory_contents(remote_path))


async def readdir(
    accessor: DatabricksVolumeAccessor,
    path: PathSpec,
    index: IndexCacheStore,
) -> list[str]:
    if isinstance(path, str):
        path = PathSpec(virtual=path,
                        directory=path,
                        resource_path=path.strip("/"))
    list_path = path.dir if path.pattern else path
    virtual_key = list_path.virtual.rstrip("/") or "/"
    listing = await index.list_dir(virtual_key)
    if listing.entries is not None:
        return listing.entries
    remote_path = backend_path(accessor.config, list_path)
    try:
        entries = await asyncio.to_thread(
            _list_directory_sync,
            accessor,
            remote_path,
        )
    except Exception as exc:
        if is_not_found(exc):
            raise enoent(list_path) from exc
        raise
    pairs = sorted(
        (virtual_path(accessor.config, entry.path,
                      mount_prefix_of(path.virtual, path.resource_path)),
         entry) for entry in entries)
    names = [name for name, _ in pairs]
    if len(names) > SCOPE_ERROR:
        logger.warning(
            "databricks_volume readdir: %s returned %d entries (limit %d)",
            virtual_key,
            len(names),
            SCOPE_ERROR,
        )
    index_entries = []
    for full_path, entry in pairs:
        name = full_path.rstrip("/").rsplit("/", 1)[-1]
        resource_type = "folder" if getattr(entry, "is_directory",
                                            False) else "file"
        remote_time = modified_to_iso(getattr(entry, "last_modified", None))
        index_entries.append((name,
                              IndexEntry(
                                  id=full_path,
                                  name=name,
                                  resource_type=resource_type,
                                  size=getattr(entry, "file_size", None),
                                  remote_time=remote_time or "",
                              )))
    await index.set_dir(virtual_key, index_entries)
    return names