refactor(core,service): Overhaul request and workflow management system

[pcfreak30]

Major refactoring of request, operation, and workflow handling:

• Introduced new abstractions for request and operation management
• Added support for protocol-specific request models
• Implemented new workflow coordination system with step-by-step processing
• Added WorkflowCoordinator interface and default implementation
• Created workflow step processing with flexible failure behaviors
• Enhanced error handling and status tracking
• Updated database models to support new service architecture
• Added generic interfaces for operation and workflow management

Breaking changes:

• Significant changes to request service interfaces
• Removed several existing methods in favor of more generic approaches
• Changed how protocol and upload data are handled

Summary by CodeRabbit

• New Features

  • Introduced a comprehensive content scanning system for evaluating and tracking content integrity.
  • Launched an enhanced hash management framework with multi-algorithm processing for improved data consistency.
  • Rolled out a new workflow coordination capability to streamline multi-step operations and request handling.
  • Upgraded protocol-specific support for pin data alongside a more efficient request creation and upload management experience.

• Chores

  • Integrated new dependencies to boost concurrency and optimize data structures.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 0765866

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a range of new features and refactors across multiple packages. New frameworks and interfaces for content scanning, hash mapping, multi-hashing, operation management, and workflow coordination have been added to the core package. Several data models and type aliases have been introduced or modified in the database models. Service layer components now implement the new core functionality with enhanced methods for request, pin, storage, TUS upload, and workflow management. Additionally, dependency updates have been made in the module file.

Changes

File(s)	Change Summary
core/content_scan.go, core/hash_mapping.go, core/hash_registry.go, core/model.go, core/multihasher.go, core/operation.go, core/workflow.go, core/protocol.go	Added new frameworks, interfaces, and types for content scanning, hash mapping/registry, multi-hashing, operation management, workflows, and model aliases.
core/pin.go, core/request.go, core/storage.go	Updated interfaces to support protocol-specific data models; enhanced request and storage handling with refined method signatures and functionality.
db/models/ (data_models.go, hash_mapping.go, request.go, scan_result.go, tus_request.go, upload.go)	Introduced new models and interfaces (e.g., RequestDataModel, PinDataModel, HashMapping, ScanResult) and adjusted existing models (e.g., changes to Request operation types, removal of HashType from Upload).
go.mod	Added new dependencies: github.com/gammazero/workerpool v1.1.3 (direct) and github.com/gammazero/deque v0.2.0 (indirect).
service/ (content_scan.go, hash_mapping.go, pin.go, request.go, storage.go, tus.go, upload.go, workflow.go)	Implemented new service layer components for content scanning, hash mapping, pin management, request handling, TUS uploads, and workflow coordination; minor modifications in upload service.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ScannerService as ContentScannerServiceDefault
    participant Scanner as ContentScanner (e.g., noopScanHandler)
    participant DB as Database

    Client->>+ScannerService: ScanContent(ctx, hash)
    ScannerService-->>ScannerService: Iterate registered scanners (by priority)
    ScannerService->>+Scanner: ScanContent(ctx, hash)
    Scanner-->>-Scanner: Return ScanResult (pass/fail, metadata)
    ScannerService->>DB: storeScanResult(ctx, hash, ScanResult)
    DB-->>ScannerService: Acknowledge storage
    ScannerService-->>-Client: Return aggregated scan results

Loading

sequenceDiagram
    participant Client
    participant Workflow as WorkflowCoordinatorDefault
    participant Request as RequestServiceDefault
    participant OpHandler as OperationHandler

    Client->>+Workflow: StartWorkflow(ctx, name, initialData)
    Workflow->>Request: Create workflow request with metadata
    Request-->>Workflow: Request Created
    Workflow->>+OpHandler: Execute Operation (Step 1)
    OpHandler-->>-Workflow: Operation Completed
    Workflow->>Request: CompleteWorkflowStep(ctx, requestID)
    alt More Steps
        Workflow->>OpHandler: Execute Next Operation
        OpHandler-->>Workflow: Next Operation Result
    end
    Workflow-->>-Client: Return Workflow Status/Completion

Loading

Poem

I'm a lively bunny, hopping through new code,
Leaping over changes on every winding road.
Scanners, workflows, and hashes now play,
In corridors of logic where bytes dance and sway.
With each fresh command, my heart does a flip—
CodeRabbit smiles as the new features skip!
🐇💻 Hop on, my friends, let the code unwrap!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ce1dd38 and 0765866.

⛔ Files ignored due to path filters (1)

• go.sum is excluded by !**/*.sum

📒 Files selected for processing (26)

• core/content_scan.go (1 hunks)
• core/hash_mapping.go (1 hunks)
• core/hash_registry.go (1 hunks)
• core/model.go (1 hunks)
• core/multihasher.go (1 hunks)
• core/operation.go (1 hunks)
• core/pin.go (2 hunks)
• core/protocol.go (1 hunks)
• core/request.go (3 hunks)
• core/storage.go (3 hunks)
• core/workflow.go (1 hunks)
• db/models/data_models/data_models.go (1 hunks)
• db/models/hash_mapping.go (1 hunks)
• db/models/request.go (2 hunks)
• db/models/scan_result.go (1 hunks)
• db/models/tus_request.go (2 hunks)
• db/models/upload.go (0 hunks)
• go.mod (2 hunks)
• service/content_scan.go (1 hunks)
• service/hash_mapping.go (1 hunks)
• service/pin.go (4 hunks)
• service/request.go (8 hunks)
• service/storage.go (3 hunks)
• service/tus.go (9 hunks)
• service/upload.go (0 hunks)
• service/workflow.go (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.