Design a Recursive File-Search API

Question

Design a recursive API for searching files within a directory and its subdirectories, handling various edge cases.

Codemia · Accepted Answer

To design a recursive file-search API, we need to define the input parameters and expected outputs. The API should accept a directory path and a filename to search for. The expected outputs include error messages for invalid inputs and results indicating whether the file was found.

The API will use a recursive function to traverse the directory tree. It will check each file and subdirectory in the given directory. If a file matches the search criteria, it will return the file path. If the directory is invalid or empty, appropriate error messages will be returned.

The recursive function will check if the current path is a directory. If it is null or not a directory, it will return 'The current search location is not a folder.' If the directory is empty, it will return 'No files found: [filename].' For each file, it will compare the name with the search term, and if it finds a match, it will return the path. If the search completes without finding the file, it will return 'No files found: [filename].'

While recursion is a straightforward approach, it may lead to stack overflow for very deep directory structures. An iterative approach using a stack or queue could be more efficient for large file systems. Additionally, caching results or implementing a breadth-first search could improve performance.

Here is a simple implementation in Python:

```python
import os

def recursive_file_search(directory, filename):
    if directory is None or not os.path.isdir(directory):
        return 'The current search location is not a folder.'
    if not os.listdir(directory):
        return f'No files found: {filename}'
    
    for root, dirs, files in os.walk(directory):
        if filename in files:
            return os.path.join(root, filename)
    return f'No files found: {filename}'
```
This code checks the directory's validity, lists its contents, and performs a search using os.walk to traverse subdirectories.

Design a Recursive File-Search API

Amazon

What the Interviewer Expects

Key Topics to Cover

How to Approach This

Possible Follow-up Questions

Sharpen Your Skills on Codemia

Sample Answer

Requirements

High-Level Design

Submit Your Answer

Amazon Software Engineer Interview Guide

Related Questions

Design a scalable Search System

Design a Video Streaming for Rippling

Design a Load Balancing Service

Design a Image Processing Service

Build a high-throughput Image Processing Pipeline