Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-4219

Spike: Investigate custom stream compliance with Node.js stream implementation guidelines

    • Type: Icon: Task Task
    • Resolution: Done
    • Priority: Icon: Unknown Unknown
    • None
    • Affects Version/s: None
    • Component/s: None
    • 3
    • Not Needed
    • Not Needed

      Use Case

      As a nodejs driver developer
      I want to make sure we are following nodejs best practices for custom stream implementation
      So that we avoid accidentally introducing bugs that could be prevented by correct api usage

      User Impact

      Avoiding subtle bugs like NODE-3833

      Dependencies

      N/A

      Unknowns

      • questions that need to be answered to determine implementation

      Acceptance Criteria

      • Review all custom stream implementations in the driver (not just writable)
      • Identify divergence from Node.js stream implementation guidelines
      • Determine whether we can replace public method overrides with appropriate `_` method implementations and eliminate any other divergences from the implementation guidelines
      • File follow up tickets for any major changes split by individual streams or code areas; minor cleanup can be done as part of this ticket

      Implementation Requirements

      • Any changes done as part of this ticket must be non-breaking

      Testing Requirements

      • Any code changes must be accompanied by tests

      Documentation Requirements

      • N/A

      Follow Up Requirements

      • Tickets must be filed for follow up work

            Assignee:
            durran.jordan@mongodb.com Durran Jordan
            Reporter:
            daria.pardue@mongodb.com Daria Pardue
            Daria Pardue
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: