-
-
Notifications
You must be signed in to change notification settings - Fork 411
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
feat: Add a possibility to simulate push notifications via simctl #1286
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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 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 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 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 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,49 @@ | ||
import { errors } from 'appium-base-driver'; | ||
import _ from 'lodash'; | ||
|
||
const extensions = {}; | ||
|
||
/** | ||
* @typedef {Object} PushNotification | ||
* | ||
* @property {!string} bundleId - The bundle identifier of the target application | ||
* @property {!object} payload - Remote notification payload. Read the `Create the JSON Payload` topic of | ||
* https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification | ||
* for more details on how to create this payload. | ||
*/ | ||
|
||
/** | ||
* Simulates push notification delivery to Simulator. | ||
* Only application remote push notifications are supported. VoIP, Complication, File Provider, | ||
* and other types are not supported | ||
* | ||
* @since Xcode SDK 11.4 | ||
* @param {PushNotification} opts - The object that describes Apple push notification content. | ||
* It must contain a top-level `bundleId` key with a string value matching | ||
* the target application‘s bundle identifier and "payload.aps" key with valid Apple Push Notification values. | ||
* Check the output of `xcrun simctl help push` command for more details. | ||
*/ | ||
extensions.mobilePushNotification = async function mobilePushNotification (opts = {}) { | ||
if (!this.isSimulator()) { | ||
throw new Error('This extension only works on Simulator'); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 |
||
} | ||
|
||
const { payload, bundleId } = opts; | ||
if (!bundleId) { | ||
throw new errors.InvalidArgumentError(`'bundleId' argument must be a valid bundle identifier string`); | ||
} | ||
if (!_.isPlainObject(payload)) { | ||
throw new errors.InvalidArgumentError(`The 'payload' argument value must be a valid dictionary. ` + | ||
`Got ${JSON.stringify(payload)} instead`); | ||
} | ||
if (!_.isPlainObject(payload.aps)) { | ||
throw new errors.InvalidArgumentError(`The 'payload.aps' value must be a valid dictionary. ` + | ||
`Got ${JSON.stringify(payload.aps)} instead`); | ||
} | ||
return await this.opts.device.pushNotification({ | ||
...payload, | ||
'Simulator Target Bundle': bundleId, | ||
}); | ||
}; | ||
|
||
export default extensions; |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If I could made a comment, I have already try to use
{"aps": {"alert": "This is a simulated notification!", "badge": 3, "sound": "default"} }
and i got an error aboutSimulator Target Bundle
using Xcode 12.4. I have change it to{"Simulator Target Bundle": "your.apps.bundleId", "aps": {"alert": { "title": "This is a simulated notification!"}, "badge": 3, "sound": "default"} }
and it worked.