[DAPS-1513] Rustlike JS

[AronPerez]

Ticket

• 1513

Description

This PR implements a Rust-compatible design pattern system for the DataFed repository management, preparing the codebase for eventual Rust migration while maintaining JavaScript functionality.

Key changes:

1. Created Repository Type System - Implemented enum-like types (globus, metadata_only) to support different repository behaviors
2. Replaced Inheritance with Composition - Transformed OOP patterns to use trait-like operations and factory patterns
3. Added Result Type Error Handling - Implemented Rust-style Result types for explicit error propagation
4. Created Modular Repository Implementation - Separated concerns into:
   - types.js - Type definitions and data structures
   - factory.js - Type-based repository creation
   - operations.js - Trait-like repository operations
   - validation.js - Pure validation functions
   - globus.js / metadata.js - Type-specific implementations
5. Added Rust Book References - Comprehensive documentation linking to relevant Rust patterns

How Has This Been Tested?

• Docker Compose with ArangoDB 3.12.4
• Node.js Foxx microservices
• Local development environment

Unit Tests - Created repository_types.test.js covering:

• Type creation and validation
• Factory pattern functionality
• Operation implementations
• Error handling scenarios

Integration Tests - Created test-foxx-api.sh:

• API endpoint connectivity
• Repository CRUD operations
• Type-specific behaviors
• Error response validation

Artifacts

API Response Examples:

  // Version endpoint working at /api/1
  {
    "release_year": 2025,
    "api_major": 1,
    "api_minor": 1,
    "component_major": 1
  }

  // Repository with type field
  {
    "_id": "repo/metadata_only_repo",
    "type": "metadata_only",
    "title": "Metadata Only Repository",
    "capacity": 1000000
  }

Test Execution Output:

  === Foxx API Test Suite ===
  Testing: Version endpoint... PASSED
  Testing: Foxx service health... PASSED
  Testing: List repositories endpoint... PASSED
  Tests passed: 3

Summary by Sourcery

Introduce a Rust-compatible repository type system in JavaScript by modularizing repository logic into enum-like types, trait-like operations, and composition-based factories, update the Foxx API to use the new patterns while preserving legacy compatibility, and add supporting tests, examples, and documentation to facilitate a future Rust migration.

New Features:

• Define a RepositoryType enum and a Rust-style Result type for explicit error handling
• Implement factory-based repository creation and trait-like operations in types.js, factory.js, operations.js, validation.js, globus.js, and metadata.js
• Add a new Foxx API router (repo_router_new.js) that uses the repository type system for CRUD and allocation endpoints
• Provide an ArangoDB migration script to backfill the type field on existing repositories
• Include usage examples (example.js) and a detailed README documenting the Rust-compatible design patterns

Enhancements:

• Refactor the legacy Repo class to delegate to the new repository operations internally for backward compatibility

Documentation:

• Add a comprehensive README in the repository module illustrating the design patterns and migration benefits
• Include example code demonstrating repository creation, trait-like operations, and error handling

Tests:

• Add unit tests in repository_types.test.js covering types, factory, validation, and operations
• Add integration tests for the Foxx API endpoints to verify repository CRUD and allocation behaviors

Chores:

• Modularize repository code into separate files for better maintainability and future Rust migration

[JoshuaSBrown]

Please address these two items.

message: "Missing required repository fields",

@param {string} config.pub_key - Public SSH key for authentication

[JoshuaSBrown]

This is not an ssh key, see below.

[AronPerez]

Updated https://github.com/ORNL/DataFed/pull/1523/files#diff-8321b8ffb15edeb055813863d9f5ee0155112ec11e2ca706e6ea2a01fb10a455R33