-
Notifications
You must be signed in to change notification settings - Fork 2
Improve URL/realm handling for ESPProvisionProvider #32
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.
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
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
b1b8daf
Improve URL handling and user proper realm when building API URL for …
ebariaux 7287623
Don't init ESPProvisionProvider with an apiURL, pass it in provision …
ebariaux 6c7fd9d
Make sure proper realm is part of configuration sent to device.
ebariaux e68bb0b
Fall back to targetURL if baseURL not (yet) set when computing apiURL…
ebariaux d184224
Fix line too long linting errors
ebariaux File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
103 changes: 103 additions & 0 deletions
103
ORLib/ConsoleProviders/ESPProvision/ESPProvisionURLResolver.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /* | ||
| * Copyright 2025, OpenRemote Inc. | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as | ||
| * published by the Free Software Foundation, either version 3 of the | ||
| * License, or (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
| * | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| import Foundation | ||
|
|
||
| struct ESPProvisionURLResolver { | ||
| private static let realmQueryKey = "realm" | ||
| private static let realmPathAllowedCharacters: CharacterSet = { | ||
| var allowedCharacters = CharacterSet.urlPathAllowed | ||
| allowedCharacters.remove(charactersIn: "/%") | ||
| return allowedCharacters | ||
| }() | ||
|
|
||
| private let userDefaults: UserDefaults? | ||
|
|
||
| init(userDefaults: UserDefaults? = UserDefaults(suiteName: DefaultsKey.groupEntitlement)) { | ||
| self.userDefaults = userDefaults | ||
| } | ||
|
|
||
| func realm(currentURL: URL?, targetUrl: String?, baseUrl: String?) -> String { | ||
| if let realm = realmFromURLs(currentURL: currentURL, targetUrl: targetUrl, baseUrl: baseUrl) { | ||
| return realm | ||
| } | ||
|
|
||
| if let realm = userDefaults?.string(forKey: DefaultsKey.realmKey), | ||
| !realm.trimmingCharacters(in: .whitespacesAndNewlines).isEmpty { | ||
| return realm | ||
| } | ||
|
|
||
| return "master" | ||
| } | ||
|
|
||
| func apiURL(baseUrl: String, realm: String) -> URL? { | ||
| guard let appUrl = makeURL(from: baseUrl), | ||
| var components = URLComponents(url: appUrl, resolvingAgainstBaseURL: false), | ||
| let encodedRealm = realm.addingPercentEncoding(withAllowedCharacters: Self.realmPathAllowedCharacters) else { | ||
| return nil | ||
| } | ||
|
|
||
| components.percentEncodedPath = "/api/\(encodedRealm)" | ||
| components.query = nil | ||
| components.fragment = nil | ||
| return components.url | ||
| } | ||
|
|
||
| func apiURL(currentURL: URL?, targetUrl: String?, baseUrl: String?, realm: String) -> URL? { | ||
| let urls = [ | ||
| baseUrl.flatMap { makeURL(from: $0) }, | ||
| currentURL, | ||
| targetUrl.flatMap { makeURL(from: $0) } | ||
| ] | ||
|
|
||
| for url in urls { | ||
| guard let url, | ||
| let apiURL = apiURL(baseUrl: url.absoluteString, realm: realm) else { | ||
| continue | ||
| } | ||
| return apiURL | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| private func realmFromURLs(currentURL: URL?, targetUrl: String?, baseUrl: String?) -> String? { | ||
| let urls = [ | ||
| currentURL, | ||
| targetUrl.flatMap { makeURL(from: $0) }, | ||
| baseUrl.flatMap { makeURL(from: $0) } | ||
| ] | ||
|
|
||
| for url in urls { | ||
| guard let url, | ||
| let components = URLComponents(url: url, resolvingAgainstBaseURL: false), | ||
| let realm = components.queryItems?.first(where: { $0.name == Self.realmQueryKey })?.value, | ||
| !realm.trimmingCharacters(in: .whitespacesAndNewlines).isEmpty else { | ||
| continue | ||
| } | ||
| return realm | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| private func makeURL(from urlString: String) -> URL? { | ||
| URL(string: urlString) ?? urlString.stringByURLEncoding().flatMap { URL(string: $0) } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.