Skip to content

Docs: FireAndForget pattern documented but not implemented #51

@kluth

Description

@kluth

Problem

The FireAndForget messaging pattern is extensively documented in the Circulatory System guide, but the class does not exist in the codebase.

Affected Files

Documentation: /home/matthias/projects/synapse/docs/systems/circulatory/README.md (lines 348-376)
Missing Code: /home/matthias/projects/synapse/src/circulatory/patterns/FireAndForget.ts

Issue Details

Severity: CRITICAL
Impact: Users following documentation will encounter ModuleNotFoundError

Documented Code (Won't Work)

import { FireAndForget } from '@synapse-framework/core';

const fireAndForget = new FireAndForget(heart);

// Send message without waiting for confirmation
await fireAndForget.send('analytics.track', {
  event: 'user.login',
  userId: '123',
  timestamp: new Date()
});

Impact

Users attempting to use this pattern will get:

Error: Cannot find module '@synapse-framework/core/FireAndForget'

Resolution Options

Option A (Recommended): Implement the FireAndForget class

  • Create /src/circulatory/patterns/FireAndForget.ts
  • Export from main module
  • Add tests
  • Pattern seems useful and well-designed

Option B: Remove documentation

  • Delete lines 348-376 from circulatory README
  • Or move to "Planned Features" section

Priority

CRITICAL - Immediate action required. Blocking for users following documentation.

References

  • Documentation Testing Summary: /home/matthias/projects/synapse/DOCUMENTATION_TESTING_SUMMARY.md
  • Documentation Issue Log: /home/matthias/projects/synapse/DOCUMENTATION_ISSUE_LOG.md (Issue Initial Setup #1)

User Story

As a framework user, I want all documented patterns to be available in the codebase, so that I can implement the messaging patterns described in the documentation without encountering module errors.

Acceptance Criteria

  • Either FireAndForget class is implemented and exported, OR
  • Documentation section is removed/moved to planned features
  • All code examples work without errors
  • Tests exist for implemented pattern (if Option A)

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingcriticalCritical priority - immediate action requireddocumentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions