[DAPS-1912] - refactor: register linkml storage engine with schema handler

[JoshuaSBrown]

Needs

#1918

That pr creates integration tests with the Schema Handler for the json validator and the Arango backend. That needs to be brought into this PR so we can locally test with the linkml pieces once they are integrated.

Summary by Sourcery

New Features:

• Add registration of a dedicated linkml schema storage backend in the schema handler.

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Registers the LinkML schema storage engine in SchemaHandler by creating and registering a dedicated storage instance, and prepares for external schema storage and validation by including their headers.

Sequence diagram for SchemaHandler construction and LinkML storage registration

sequenceDiagram
    actor Server
    participant SchemaHandler
    participant SchemaStorageFactory
    participant ArangoSchemaStorage

    Server->>SchemaHandler: construct SchemaHandler(a_db_client)
    activate SchemaHandler
    SchemaHandler->>ArangoSchemaStorage: create shared ArangoSchemaStorage() as linkml_storage
    activate ArangoSchemaStorage
    ArangoSchemaStorage-->>SchemaHandler: shared_ptr<ArangoSchemaStorage>
    deactivate ArangoSchemaStorage
    SchemaHandler->>SchemaStorageFactory: registerStorage(linkml, linkml_storage)
    SchemaStorageFactory-->>SchemaHandler: void
    deactivate SchemaHandler

Loading

Class diagram for SchemaHandler and schema storage registration

classDiagram
    class DatabaseAPI

    class SchemaStorage {
        <<interface>>
    }

    class ArangoSchemaStorage {
    }

    SchemaStorage <|.. ArangoSchemaStorage

    class SchemaStorageFactory {
        +registerStorage(storageType, storage)
    }

    class SchemaHandler {
        -DatabaseAPI &m_db_client
        -SchemaStorageFactory m_schema_factory
        +SchemaHandler(a_db_client)
    }

    SchemaHandler --> DatabaseAPI : uses
    SchemaHandler --> SchemaStorageFactory : manages
    SchemaHandler ..> ArangoSchemaStorage : creates
    SchemaStorageFactory o--> SchemaStorage : owns registered storages

Loading

File-Level Changes

Change	Details	Files
Register a LinkML schema storage engine instance with the schema factory in SchemaHandler.	Include headers for ExternalSchemaStorage and ExternalSchemaValidator alongside existing storage and validator includes. Instantiate a shared ArangoSchemaStorage object intended for LinkML usage. Register the created LinkML storage instance in m_schema_factory under the "linkml" storage key before the existing Arango storage registration.	core/server/client_handlers/SchemaHandler.cpp

Possibly linked issues

• #[Feature] - Core server, integrate new linkml storage and validation into core server: The PR registers a LinkML storage engine in SchemaHandler, directly implementing part of the requested LinkML integration.
• #[Feature] - Support linkml directly in the SchemaHandler alongside json-schema (Integration): PR registers linkml storage in SchemaHandler, directly implementing the requested linkml integration alongside json-schema.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've left some high level feedback:

• The newly added ExternalSchemaStorage.hpp and ExternalSchemaValidator.hpp headers are not used in this file and can be removed to avoid unnecessary dependencies.
• You can simplify the linkml storage registration by passing std::make_shared<ArangoSchemaStorage>() directly to registerStorage instead of storing it in a local variable and then std::move-ing it.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- The newly added `ExternalSchemaStorage.hpp` and `ExternalSchemaValidator.hpp` headers are not used in this file and can be removed to avoid unnecessary dependencies.
- You can simplify the `linkml` storage registration by passing `std::make_shared<ArangoSchemaStorage>()` directly to `registerStorage` instead of storing it in a local variable and then `std::move`-ing it.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}