Skip to content

Fix crash on unexpected plugin slugs #767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 26, 2024
Merged

Fix crash on unexpected plugin slugs #767

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
62b1eb7
Add an unit test to reproduce crash
crazytonyli Mar 26, 2024
719f829
Encode plugin slug into api url
crazytonyli Mar 26, 2024
eb87330
Add a changelog
crazytonyli Mar 26, 2024
7d52ac9
Merge remote-tracking branch 'origin/trunk' into fix-crash-on-unexpec…
mokagio Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ _None._

### Bug Fixes

_None._
- Fix crash when querying a WordPress plugin whose slug is not url-safe. [#767]

### Internal Changes

Expand Down
2 changes: 1 addition & 1 deletion Sources/WordPressKit/Services/PluginDirectoryServiceRemote.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public struct PluginDirectoryGetInformationEndpoint {

func buildRequest() throws -> URLRequest {
try HTTPRequestBuilder(url: PluginDirectoryRemoteConstants.getInformationEndpoint)
.append(percentEncodedPath: "\(slug).json")
.appendURLString("\(slug).json")
.query(name: "fields", value: "icons,banners")
.build()
}
Expand Down
12 changes: 12 additions & 0 deletions Tests/WordPressKitTests/Tests/PluginDirectoryTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,4 +343,16 @@ class PluginDirectoryTests: XCTestCase {

XCTAssertTrue(lhs == rhs)
}

func testUnconventionalPluginSlug() async throws {
let data = try MockPluginDirectoryProvider.getPluginDirectoryMockData(with: "plugin-directory-rename-xml-rpc", sender: type(of: self))
stub(condition: isHost("api.wordpress.org")) { _ in
HTTPStubsResponse(data: data, statusCode: 200, headers: ["Content-Type": "application/json"])
}

let _ = try await PluginDirectoryServiceRemote().getPluginInformation(slug: "%-is-not-allowed")
let _ = try await PluginDirectoryServiceRemote().getPluginInformation(slug: "中文")

// No assertion needed.
}
}