‹ Reports
The Dispatch

OSS Report: scalar/scalar


Scalar Project Faces Critical UI Issues Post-Update, Prompting Urgent Fixes

Scalar, an open-source offline-first API client for OpenAPI, has encountered significant UI disruptions following recent updates, highlighting the need for immediate attention to stability.

Recent Activity

The Scalar project has been actively addressing a surge in issues, particularly those affecting the user interface and functionality post-version updates. Notable issues include critical UI crashes (#3165) and errors (#3158) linked to recent version releases. Authentication handling and query parameter display inconsistencies (#3180) are also prominent concerns.

Development Team Activity

Of Note

  1. Critical UI Crashes: Recent updates have led to severe UI issues (#3165, #3158), necessitating urgent fixes.
  2. Authentication Bugs: Problems with API key handling (#3168) indicate a need for improved authentication processes.
  3. Draft PRs Indicate Future Enhancements: Several draft pull requests suggest ongoing development of new features like Postman to OpenAPI conversion (#3161).
  4. Performance Upgrades: Significant improvements in sidebar performance (#3175) reflect efforts to enhance user experience.
  5. Community Engagement: Active user feedback is driving rapid bug identification and resolution efforts.

The Scalar project is actively working to resolve critical issues while continuing to develop new features and improve existing functionalities, maintaining a robust pace of development.

Quantified Reports

Quantify Issues



Recent GitHub Issues Activity

Timespan Opened Closed Comments Labeled Milestones
7 Days 21 13 37 0 1
30 Days 43 38 88 1 1
90 Days 158 127 285 5 1
All Time 498 393 - - -

Like all software activity quantification, these numbers are imperfect but sometimes useful. Comments, Labels, and Milestones refer to those issues opened in the timespan in question.

Quantify commits



Quantified Commit Activity Over 30 Days

Developer Avatar Branches PRs Commits Files Changes
Hans Pagel 5 75/69/5 93 652 50032
geoffgscott 2 4/4/0 10 202 17163
Amrit Kahlon 7 29/27/1 41 188 10932
Brynn 2 14/14/1 15 462 3994
Marc Laventure 3 9/8/1 20 64 2603
Anthony Lio 7 31/28/2 39 126 2487
Justin Lampe 1 3/3/0 3 41 2420
Thomas Mastromonaco 5 5/2/2 17 30 1524
Mason Little (Mason-Little) 2 2/0/0 3 6 1413
danwithabox 1 1/1/0 1 24 1125
Cameron Rohani 2 2/1/0 4 25 665
Facundo Juarez 1 1/1/0 1 7 522
Izuchukwu Kevin I 1 2/1/1 1 3 63
Alessio Koci 1 1/1/0 1 2 39
Tim Heuer 1 1/1/0 1 2 26
Edgaras 1 1/1/0 1 2 13
_sss 1 1/1/0 1 2 7
Ikko Eltociear Ashimine 1 1/1/0 1 1 4
Yasuhiro SHIMIZU 1 1/1/0 1 1 2
Chad Whitacre 1 1/1/0 1 1 2
Bhupendrakumar Piprava (bdpiprava) 0 1/0/1 0 0 0
None (fjdvchain) 0 1/0/1 0 0 0
Shine Zaw (ShineZaw123) 0 4/0/4 0 0 0
None (dependabot[bot]) 0 0/0/1 0 0 0
Tanguy Michardière (tanguyMichardiere) 0 1/0/1 0 0 0

PRs: created by that dev and opened/merged/closed-unmerged during the period

Detailed Reports

Report On: Fetch issues



Recent Activity Analysis

The Scalar project has recently seen a surge in activity, with 105 open issues on GitHub. Many of these issues are related to bugs and enhancements, particularly concerning the user interface and functionality of the API client. Notably, several issues have been reported regarding the handling of authentication methods, rendering of response schemas, and inconsistencies in the display of query parameters.

A recurring theme among the issues is the impact of recent updates on existing functionality, particularly with version changes that have introduced new bugs or altered expected behaviors. This suggests a potential need for more rigorous testing before releases.

Issue Details

Recent Issues

  1. Issue #3182: UI is broken in @scalar/hono-api-reference on v0.5.147

    • Priority: High
    • Status: Open
    • Created: 0 days ago
    • Update: N/A
  2. Issue #3180: Example values of query parameters not used in "Test Request" dialog

    • Priority: High
    • Status: Open
    • Created: 0 days ago
    • Update: N/A
  3. Issue #3168: API Key Not Set When Pasting into Authorization Header Field

    • Priority: Medium
    • Status: Open
    • Created: 1 day ago
    • Update: N/A
  4. Issue #3165: @scalar/api-reference v1.25.12 and v1.25.13 cause the UI to crash

    • Priority: Critical
    • Status: Open
    • Created: 0 days ago
    • Update: N/A
  5. Issue #3158: Critical errors happen since @scalar/api-reference v1.25.12 - v1.25.13 (current latest)

    • Priority: Critical
    • Status: Open
    • Created: 0 days ago
    • Update: N/A

Analysis of Themes and Commonalities

  • Many recent issues focus on bugs introduced by updates to versions v1.25.12 and v1.25.13, indicating that these releases may have destabilized previously functioning features.
  • A significant number of issues relate to the user interface, particularly around authentication handling and rendering of API responses.
  • The presence of critical bugs suggests that users are experiencing significant disruptions in their workflow, which could affect overall adoption and satisfaction with the Scalar platform.
  • The community appears engaged, with users providing detailed feedback and suggestions for fixes, which is a positive indicator for future improvements.

Summary of Important Issues

  • The ongoing problems with UI crashes (#3165) and critical errors (#3158) following version updates highlight a pressing need for stability in releases.
  • Issues related to authentication (#3168) and example values not being utilized correctly (#3180) suggest areas where user experience can be significantly improved.
  • The feedback loop between users reporting issues and developers addressing them is active, but there may be a need for enhanced communication regarding fixes and updates.

This analysis underscores the importance of maintaining robust testing practices during development cycles to ensure that new releases do not introduce regressions or critical failures in existing functionalities.

Report On: Fetch pull requests



Overview

The Scalar project has a diverse set of recent pull requests (PRs) that reflect ongoing enhancements, bug fixes, and community contributions. The PRs cover a range of topics from performance upgrades and feature additions to documentation updates and dependency management.

Summary of Pull Requests

Open Pull Requests

  • PR #3183: Updates to the contributors' README action. No version bump required.
  • PR #3161: Introduction of a new package for converting Postman specs to OpenAPI. Draft status indicates it's still under development.
  • PR #3160: Fixes a race condition in the API reference search functionality. Also in draft status.
  • PR #3151: Updates Vue dependencies across multiple packages. Draft status suggests it's awaiting further changes.
  • PR #3150: Upgrades TypeScript version across several packages. Draft status indicates ongoing work.
  • PR #3146: Fixes an issue with environment dropdown in the API client. Awaiting review.
  • PR #3095: Prepares the API client for a new dashboard layout. Draft status suggests it's still being worked on.

Closed Pull Requests

  • PR #3178: A routine release PR that updates several packages with new versions.
  • PR #3177: Fixes an issue with request security requirement lookup in the API client.
  • PR #3176: Removes trailing slashes from server URLs in examples and client configurations.
  • PR #3175: Significant performance upgrades for the API client sidebar, reducing load time dramatically.
  • PR #3174: Adds back content headers that were previously removed, addressing issues with request handling.
  • PR #3173: Addresses multiple issues related to API client modals and request handling.

Analysis of Pull Requests

The recent activity in the Scalar project repository indicates a strong focus on improving both functionality and performance. The introduction of new features such as the Postman to OpenAPI converter (#3161) and enhancements to existing functionalities like the API client's sidebar performance (#3175) demonstrate an active effort to expand and refine the tool's capabilities.

Bug fixes are also a significant part of the recent PRs, with issues like incorrect request security requirement lookups (#3177) and improper handling of trailing slashes in URLs (#3176) being addressed promptly. This reflects a commitment to maintaining high-quality standards and ensuring a smooth user experience.

The presence of draft PRs (#3161, #3160, #3151, #3150) suggests ongoing development efforts and possibly new features or major updates in the pipeline. These drafts indicate active contributions from the community or internal teams working on enhancing Scalar's functionality.

Overall, the Scalar project exhibits a healthy development pace with regular updates, community involvement, and a clear focus on both expanding features and improving existing ones. The mix of new feature introductions, performance enhancements, bug fixes, and routine maintenance releases highlights a well-rounded approach to software development that prioritizes both innovation and reliability.

Report On: Fetch commits



Repo Commits Analysis

Development Team and Recent Activity

Team Members and Recent Contributions

  1. Hans Pagel (hanspagel)

    • Recent Commits: 93 commits, significant contributions to releases, documentation, and various fixes.
    • Notable Activities:
    • Released multiple packages (e.g., 15 packages on the latest release).
    • Worked on documentation updates and CI improvements.
    • Collaborated with other team members on various features and bug fixes.
  2. Amrit Kahlon (amritk)

    • Recent Commits: 41 commits, focused on API client enhancements and bug fixes.
    • Notable Activities:
    • Implemented performance upgrades for the API client sidebar.
    • Addressed security requirements in requests.
    • Worked on OAuth2 integration and environmental variable handling.
  3. Marc Laventure (marclave)

    • Recent Commits: 20 commits, involved in documentation and minor fixes.
    • Notable Activities:
    • Fixed trailing slashes in examples.
    • Contributed to the API client’s content header management.
  4. Anthony Lio (antlio)

    • Recent Commits: 39 commits, concentrated on UI improvements and feature additions.
    • Notable Activities:
    • Enhanced the command palette and sidebar functionalities.
    • Worked on request handling and environment variable management.
  5. Justin Lampe (xC0dex)

    • Recent Commits: 3 commits, focused on configuration updates.
    • Notable Activities:
    • Updated Dependabot configuration for Nuget.
  6. Cameron Rohani (cameronrohani)

    • Recent Commits: 4 commits, primarily involved in UI fixes.
    • Notable Activities:
    • Improved icon sizes and modal layouts.
  7. Brynn (hwkr)

    • Recent Commits: 15 commits, contributed to component styling and performance optimizations.
    • Notable Activities:
    • Enhanced the command palette and search modal performance.
  8. Geoff Scott (geoffgscott)

    • Recent Commits: 10 commits, focused on refactoring and feature implementations.
    • Notable Activities:
    • Worked on send-request refactor and request sidebar improvements.
  9. Thomas Mastromonaco (tmastrom)

    • Recent Commits: 17 commits, involved in testing and configuration updates.
    • Notable Activities:
    • Added tests for configuration checks and improved build processes.

Patterns, Themes, and Conclusions

  • The team is actively engaged in releasing new features and fixing bugs, with a strong focus on improving the user interface of the API client.
  • There is a collaborative environment where team members frequently co-author commits, indicating effective teamwork across different functionalities.
  • Recent activities show a balance between feature development (e.g., enhancements to the command palette, sidebar functionalities) and maintenance tasks (e.g., fixing bugs related to OAuth2 integration).
  • The project has a robust release cycle with frequent updates to packages, suggesting a commitment to continuous improvement and responsiveness to user feedback.
  • Documentation efforts are ongoing alongside code changes, which is essential for maintaining clarity as the project evolves.

Overall, the development team demonstrates a high level of productivity with a clear focus on enhancing both functionality and user experience within the Scalar project.