Skip to content

Enhance Error Logging and Address Minor TODOs #6538

Open

Description

@HussainAther

Is your feature request related to a problem? Please describe.

While working with the Hubs codebase, I noticed several areas where silent failures occur (e.g., empty .catch blocks) and a number of TODO comments indicating pending improvements. These can make debugging more difficult, especially for new contributors or when tracking down unexpected behavior. Improving developer logs and addressing minor TODOs would enhance maintainability and overall developer experience (DX).


Describe the solution you'd like

  • Add helpful console.warn or console.error messages in places where failures are currently silent, particularly in .catch blocks.
  • Gradually address simple TODO items that can be resolved without large architectural changes.
  • Ensure consistent logging practices across the codebase to make debugging easier for both core developers and open-source contributors.

Describe alternatives you've considered

  • Leaving the current logging as-is, but this risks continued confusion when debugging.
  • Creating separate issues for each TODO, but many are minor enough to be handled collectively under a broader developer experience improvement initiative.

Additional context

  • Found multiple silent .catch blocks during a grep search that could benefit from at least basic warnings or error outputs.
  • Several TODO comments are low-hanging fruit and could be cleaned up to reduce technical debt.
  • This improvement aligns with open-source best practices by making the project more approachable for contributors.

Example:

promiseFunction()
  .catch(() => {
    // Silent failure — could log context here
  });

Would become:

promiseFunction()
  .catch((err) => {
    console.warn("Promise failed in [function/module]:", err);
  });

These small changes can significantly improve traceability during development.

Activity

  1. HussainAther commented on Apr 23, 2025

    @HussainAther
    Author

    Hi team,

    I’ve opened this issue to highlight areas where we can improve developer experience through better error logging and by addressing minor TODO comments.

    I'd be happy to start working on this by:

    Adding console.warn or console.error messages to some of the silent .catch blocks I’ve identified.
    Tackling a few of the simpler TODO items that don’t require major refactoring.
    I’ll aim to keep the pull requests small and focused for easier reviews. Please let me know if there are any logging standards or preferences I should follow before I get started!

    Looking forward to contributing further!

    — @HussainAther

  2. DougReeder commented on Apr 29, 2025

    @DougReeder
    Member

    Please do submit a Pull Request for each logical group of changes.

    It's probably best to make these Pull Requests against the development branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementwork that enhances an existing feature

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions