How mft-labs/aepf_opensearch works
Project type and purpose
• This is an Elixir library (mix project) that implements an Ash Framework data layer backed by OpenSearch.
• Purpose: let Ash resources query and index data in OpenSearch by translating Ash queries into OpenSearch DSL and communicating over HTTP.
File structure
• Top‐level:
• lib/aepf_opensearch: main modules
• lib/aepf_opensearch/application.ex: OTP application/Supervisor
• lib/aepf_opensearch/client.ex: HTTP client module
• lib/aepf_opensearch/data_layer.ex: implements Ash.DataLayer behavior
• lib/aepf_opensearch/translator.ex: turns Ash queries into DSL
• lib/aepf_opensearch/query.ex: data structures for queries
• lib/mix/opensearch/init.ex: mix task “mix opensearch.init” (seeder scaffolding)
• Other files: configuration under config/, Mix project files (mix.exs, mix.lock), tests under test/.
README for additional insights
• Confirms: Ash DataLayer integration, custom query translator, HTTP client, seeder utility.
• Notes configuration keys (base_url, json_library).
a. Main components
1. Ash Resource (in consumer app)
2. AepfOpensearch.DataLayer (implements Ash.DataLayer behaviour)
3. Translator (AepfOpensearch.Translator)
4. Query Model (AepfOpensearch.Query)
5. OpenSearch Client (AepfOpensearch.Client)
6. OpenSearch Cluster / Index
7. Mix Seeder Task (mix opensearch.init)
b. Relationships & interactions
• The Ash Resource’s data_layer configuration points to DataLayer → DataLayer API calls (read, create, update, delete) enter.
• DataLayer converts abstract operation into an internal Query struct.
• Translator module transforms Query struct into OpenSearch DSL JSON.
• Client sends HTTP request (uses configured base_url + Jason for JSON) to the OpenSearch cluster.
• OpenSearch responds with JSON → Client parses → DataLayer maps back to Ash Resource structs.
• Mix Seeder Task uses Client and DataLayer APIs to seed initial indices.
• Application Supervisor (application.ex) starts the Client (e.g., HTTP pool) under the OTP tree.
c. Architectural patterns & principles
• Behavior‐based extension of Ash (DataLayer behaviour).
• Clear separation of concerns: DataLayer (interface), Translator (logic), Client (transport).
• OTP supervision for client processes.
• Modular pipeline: Resource → DataLayer → Translator → Client → External service → back.
d. Key technologies
• Elixir / OTP / Mix
• Ash Framework (Ash.Resource, Ash.DataLayer)
• OpenSearch (REST API)
• JSON library (Jason)
• HTTP client (e.g., Finch or Hackney inside Client module)
• ExDoc for documentation
Detail
• Supervisor: show Application.ex starting the Client.
• Config injection from config/runtime.exs into Client.
• Behavior callbacks in DataLayer (e.g., load, run_query).