Quantify issues

Recent GitHub Issues Activity

_{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.}

Report On: Fetch issues

Recent Activity Analysis

The recent GitHub issue activity for the WireMock project involves a variety of bug reports, feature requests, and enhancements. Notable issues include problems with JSON parsing, proxying, and response templating. There are also requests for new features such as support for Jetty 12, enhancements to existing functionalities like scenario handling, and improvements in documentation.

A significant anomaly is the frequent occurrence of JSON parsing errors and issues related to proxying, which suggests a common pain point for users. Additionally, there are several requests for better handling of HTTP/2 and Jetty 12 compatibility, indicating a need for modernization to align with newer technologies.

Issue Details

• #2835: Closed 1 day ago. Bug report about @WiremockTest not working on two different tests.
• #2829: Closed 12 days ago. Enhancement request for multipart/related support.
• #2826: Closed 14 days ago. Bug report on diff rendering failure with path templates.
• #2816: Closed 21 days ago. Bug report on response template behavior change in version 3.x.
• #2807: Closed 34 days ago. Enhancement to support removeAndGet method on stores.
• #2794: Closed 46 days ago. Bug report about missing jsonMerge helper.
• #2783: Closed 57 days ago. Bug report about ID conflict when registering a single stub.
• #2775: Closed 63 days ago. Bug report on urlPathTemplate not working with query parameters.
• #2759: Closed 68 days ago. Enhancement to report webhook errors as sub-events.
• #2756: Closed 69 days ago. Enhancement to add a unique ID to the template request model.
• #2739: Closed 70 days ago. Bug report about automatic creation of __files directory.
• #2736: Closed 68 days ago. Bug report on proxying error with IPv6-only hosts.
• #2734: Closed 88 days ago. Enhancement to prevent duplicate stub mappings by ID.
• #2731: Closed 84 days ago. Bug report on potential memory leak in standalone release.
• #2728: Closed 98 days ago. Enhancement request for join handlebar helper alignment.

These issues highlight ongoing efforts to improve compatibility with modern web standards, enhance usability through better error handling and logging, and expand the functionality of WireMock's templating and proxying capabilities.

Report On: Fetch pull requests

Analysis of Pull Requests for wiremock/wiremock

Open Pull Requests

Notable Open PRs

1. #2830: support multipart/related Requests

   • State: Open
   • Created: 12 days ago
   • Description: This PR adds support for multipart/related requests in WireMock. It addresses a gap where only multipart/form-data or multipart/mixed were recognized.
   • Issues: Some checklist items are not completed, such as joining WireMock Slack and providing necessary documentation.
   • Review Comments: There was a suggestion to use Apache client's support for multipart requests instead of the old HTTP client.
   • Commits: Multiple commits, including refactoring and fixing code style issues.

2. #2823: Enable customization of cipher suites and TLS protocol with WiremockConfiguration

   • State: Open
   • Created: 21 days ago
   • Description: This PR allows customization of cipher suites and TLS protocols in WireMockServer, enabling simulation of deprecated TLS protocols or cipher suites.
   • Issues: Missing test coverage and documentation.
   • Review Comments: Suggestions to add new options to the Options interface and ensure changes are supported across both Jetty versions.

3. #2234: Feature Request: Matching Request method with isOneOf & isNoneOf

   • State: Open
   • Created: 429 days ago
   • Description: Adds the ability to specify a list of request methods using isOneOf and isNoneOf.
   • Issues: Long-standing PR with extensive discussions and changes. Needs a detailed review to ensure no breaking changes.

Draft/Open PRs Needing Attention

1. #2825: UrlPattern equality experiment

   • State: Open (Draft)
   • Created: 19 days ago
   • Description: An experimental change to identify when different matchers are conceptually identical.
   • Issues: Labeled as a draft, indicating it's not ready for final review or merge.

2. #2773: Make InMemoryObjectStore deterministic

   • State: Open (Draft)
   • Created: 67 days ago
   • Description: Introduces locks around write operations to make InMemoryObjectStore deterministic, potentially reducing throughput.
   • Issues: Concerns about reduced throughput due to locking.

Closed Pull Requests

Recently Closed Notable PRs

1. #2834 & #2833: Chore to remove node vulnerabilities

   • Closed: 5 days ago
   • Description: These PRs aimed at removing node vulnerabilities by updating dependencies and removing unnecessary packages.

2. #2827: Fix failing diffing for multiple path params

   • Closed: 14 days ago
   • Description: Fixed an issue with diff report rendering failures when stubs contain multiple path parameters.

3. #2814 & #2803 & #2804 & #2809 & #2810 & #2811 & #2812 & #2813 & #2818 & #2819 & #2820 & #2821 & #2824 & #2828 & #2796 & #2797 & #2798 & #2799 & #2800 & #2801 & #2802 & #2805 & #2806 & #2807 & #2808: Various dependency updates and minor fixes.

Summary

• The project has several open pull requests that address significant features like TLS customization (#2823) and multipart request support (#2830).
• Some long-standing PRs like #2234 need attention to resolve outstanding issues or merge conflicts.
• Recent closed PRs focused on dependency updates and security improvements, indicating ongoing maintenance efforts.
• Draft PRs suggest ongoing experimentation with potential new features or improvements, such as URL pattern equality (#2825).

Recommendations

• Prioritize reviewing open PRs with significant feature additions or bug fixes, especially those that have been open for an extended period like #2234.
• Encourage contributors to complete checklist items, such as test coverage and documentation, before final reviews.
• Monitor draft PRs for readiness to transition into active reviews once they mature beyond the experimental stage.

Report On: Fetch PR 2830 For Assessment

PR #2830

Summary

This pull request introduces support for handling multipart/related requests in Wiremock. This is particularly relevant for SOAP requests with MTOM enabled, where attachments are externalized. Previously, Wiremock only recognized multipart/form-data and multipart/mixed content types. The changes ensure that multipart/related requests are appropriately recognized and processed.

Changes

1. FileUpload.java:

   • Added a constant for the multipart/related content type.
   • Modified the constructor to check for the multipart/related content type and handle it accordingly.
   • Adjusted error messages to include multipart/related as a valid content type.
   • Introduced logic to handle multipart/related requests by setting the field name to an empty string and creating a FileItemStreamImpl.

2. MultipartBodyMatchingAcceptanceTest.java:

   • Added a new test case to verify that multipart/related requests are accepted and processed correctly.
   • Utilized Apache HttpClient 5 to construct and send a multipart request with a SOAP body and an attachment.

Code Quality Assessment

• Code Structure: The code is well-structured, with clear separation between logic for different content types. The use of constants for content types improves readability and maintainability.

• Error Handling: The error messages have been updated to reflect the inclusion of multipart/related, which is good practice for clarity in debugging.

• Testing: A comprehensive test has been added to ensure that the new functionality works as expected. The test uses Apache HttpClient 5, which is a modern and robust choice for HTTP operations.

• Documentation: While the code changes are self-explanatory, additional documentation or comments explaining the rationale behind supporting multipart/related could be beneficial for future maintainers.

• Performance: There are no apparent performance concerns introduced by this change. The handling of multipart requests is consistent with existing patterns in the codebase.

Recommendations

1. Documentation: Consider adding documentation or comments within the codebase to explain why support for multipart/related was added, especially if there are specific use cases or limitations.

2. Submitter Checklist: Ensure that all items in the submitter checklist are addressed, particularly joining relevant communication channels like WireMock Slack for community support and collaboration.

3. Changelog Entry: Although not checked in the submitter checklist, ensure that this change is documented in the project's changelog to inform users of new features and improvements.

Overall, this pull request is well-executed, addressing a specific need with appropriate tests and minimal disruption to existing functionality.

Report On: Fetch Files For Assessment

Source Code Assessment

File: WireMockServer.java

Overview

• Purpose: This file is central to the WireMock server functionality, handling core operations of the mock server.
• Size: 589 lines, 17,261 characters.

Structure and Quality

• Imports: Utilizes static imports for utility methods, which enhances readability for common operations.
• Class Design: Implements Container, Stubbing, and Admin interfaces, indicating a well-structured design that separates concerns effectively.
• Constructor Overloading: Multiple constructors provide flexibility in initializing the server with various configurations.
• Dependency Injection: Uses Options for configuration, promoting flexibility and testability.
• Error Handling: Uses custom exceptions like FatalStartupException to handle critical errors, which is good for clarity and debugging.
• Thread Management: The shutdown method uses a separate thread to handle server shutdown gracefully, which is a good practice for non-blocking operations.
• Code Duplication: Some methods like removeStubMapping are overloaded with similar logic; consider refactoring to reduce duplication.
• Documentation: Lacks inline comments explaining complex logic or decisions, which could aid future maintainers.

Potential Improvements

• Logging: Enhance logging around critical operations like starting/stopping the server to aid in debugging and monitoring.
• Error Messages: Ensure all exceptions provide meaningful messages to help diagnose issues quickly.

File: WireMockApp.java

Overview

• Purpose: Crucial for understanding application-level configurations and operations within WireMock.
• Size: 625 lines, 21,387 characters.

Structure and Quality

• Initialization Logic: Handles extensive initialization logic in the constructor, which could be refactored into smaller methods for clarity.
• Extension Management: Manages extensions dynamically, facilitating a flexible architecture that can be extended easily.
• Caching Strategy: Disables JsonPath's cache due to known issues, demonstrating awareness of external library limitations.
• Separation of Concerns: Clearly separates different responsibilities such as request handling, stub management, and scenario management.
• Use of AtomicBoolean: Utilizes AtomicBoolean for thread-safe operations related to factory loading optimization.

Potential Improvements

• Complexity Reduction: Consider breaking down the constructor into smaller methods or using a builder pattern to manage complexity.
• Documentation: Add more detailed comments explaining the purpose of key sections and decisions made during implementation.

File: HttpAdminClient.java

Overview

• Purpose: Manages administrative HTTP client interactions, essential for API management and testing.
• Size: 601 lines, 20,278 characters.

Structure and Quality

• HTTP Client Usage: Utilizes Apache HttpClient5 for making HTTP requests, which is a robust choice for handling HTTP interactions.
• Request Execution: Provides a generic method executeRequest to handle various types of requests efficiently.
• Error Handling: Implements custom error handling logic with meaningful exceptions like NotAuthorisedException.
• Security Considerations: Supports client authentication via customizable authenticators.

Potential Improvements

• Code Duplication: Methods like postJsonAssertOkAndReturnBody and putJsonAssertOkAndReturnBody have similar logic; consider refactoring to reduce redundancy.
• Testing Hooks: Introduce hooks or interfaces that allow easier testing of HTTP interactions without relying on actual network calls.

File: build.gradle

Overview

• Purpose: Important for understanding project dependencies and build processes.

Structure and Quality

• Dependency Management: Uses Gradle's dependency management effectively with version constraints and exclusions to avoid conflicts.
• Plugin Usage: Employs a wide range of plugins for tasks such as code formatting (spotless), testing (jacoco), and publishing (maven-publish).
• Versioning Strategy: Includes tasks for bumping version numbers automatically, which aids in release management.

Potential Improvements

• Modularization: Consider splitting the build script into multiple files if it grows further to improve maintainability.
• Environment Variables Handling: Ensure secure handling of environment variables used in publishing tasks.

File: wiremock-admin-api.json

Overview

• Purpose: Defines API specifications critical for understanding how the WireMock API is structured and operates.

Structure and Quality

• Due to its size (2,842 lines), this file likely contains comprehensive API definitions. However, specific details are not available due to truncation.

Potential Improvements

• Ensure that this file is kept up-to-date with any changes in the API to prevent discrepancies between documentation and implementation.

Report On: Fetch commits

Project Overview

WireMock is an open-source tool designed for API mock testing. It is maintained by the WireMock organization and has been actively developed since its inception in 2011. The tool is primarily written in Java and is widely used to create stable test and development environments, simulate APIs that are not yet available, and isolate systems from unreliable third-party services. WireMock supports multiple programming languages and can be deployed as a standalone server or integrated into various workflows via its comprehensive APIs. The project is well-received within the developer community, boasting over 6,254 stars on GitHub. The repository is actively maintained with 3,528 commits, 91 branches, and 412 open issues or pull requests. The project appears to be on a positive trajectory with regular updates and community engagement.

Recent Activities of the Development Team

Reverse Chronological List of Commits

5 days ago - Robert Elliot (Mahoney)

• Commit: Merge pull request #2834 from wiremock/npm-upgrade-glob
• Description: Chore to remove node vulnerabilities by forcing the glob package to a version that no longer uses deprecated inflight.
• Files Affected: ui/package-lock.json, ui/package.json
• Lines Changed: +405, -73
• Collaborations: None specified.

5 days ago - Robert Elliot (Mahoney)

• Commit: Merge pull request #2833 from wiremock/remove-node-vulns
• Description: Chore to remove node vulnerabilities by removing unnecessary packages and upgrading swagger-ui-dist.
• Files Affected: Multiple files including .nvmrc, build.gradle, and several files under src/main/resources/assets/swagger-ui/swagger-ui-dist/.
• Lines Changed: +5117, -6325
• Collaborations: None specified.

7 days ago - Lee Turner (leeturner)

• Commit: Merge pull request #2805 from wiremock/dependabot/gradle/versions.jsonUnit-2.40.1
• Description: Bump versions.jsonUnit from 2.40.0 to 2.40.1.
• Files Affected: build.gradle
• Lines Changed: +1, -1
• Collaborations: None specified.

14 days ago - Rafe Arnold (RafeArnold)

• Commit: Merge pull request #2827 from wiremock/path-param-diff-report-fix
• Description: Fix failing diffing for multiple path params.
• Files Affected: src/main/java/com/github/tomakehurst/wiremock/verification/diff/Diff.java, src/test/java/com/github/tomakehurst/wiremock/verification/diff/DiffTest.java
• Lines Changed: +18
• Collaborations: None specified.

Team Members and Activity Patterns

1. Robert Elliot (Mahoney)

   • Active in addressing security vulnerabilities, particularly related to Node.js dependencies.
   • Engaged in significant refactoring efforts as seen in recent commits.
   • Collaborated on multiple branches but no specific team member collaborations noted.

2. Lee Turner (leeturner)

   • Primarily involved in dependency management through version bumps.
   • Engages with community contributions via Dependabot PRs.
   • No direct code changes in the last two weeks but active in merging PRs.

3. Rafe Arnold (RafeArnold)

   • Focused on bug fixes related to API diffing functionality.
   • Contributed directly to codebase improvements with minimal file changes.

4. dependabot[bot]

   • Automated bot handling dependency updates across various branches.
   • Regularly contributes to keeping dependencies up-to-date with minor version bumps.

5. mufasa1976

   • No recent commits or changes but has an open PR indicating ongoing involvement.

Conclusions

The WireMock development team is actively maintaining the project with a focus on security improvements and dependency management. Robert Elliot is leading efforts on addressing vulnerabilities while Lee Turner manages dependency updates through automated tools like Dependabot. Rafe Arnold's contributions indicate a focus on refining existing functionalities, particularly around API diffing logic. The project benefits from both human contributions and automated processes to ensure stability and security in its offerings. Overall, the team demonstrates a collaborative approach with regular updates and improvements being made to the codebase.