search

ably / ably-cocoa

iOS, tvOS and macOS Objective-C and Swift client library SDK for Ably realtime messaging service
https://ably.com/download
Apache License 2.0
46 stars 25 forks source link

fix test__144__JWT_and_realtime__when_using_authUrl__when_token_expires against frontdoor #1974

Closed amnonbc closed 2 months ago

amnonbc commented 2 months ago

The current test is over-specified - searching for exact error text. Updated so test asserts that error text contains the words token and expire

Fixes https://ably.atlassian.net/jira/software/projects/RAR/boards/159?selectedIssue=RAR-692 ::error file=/Users/runner/work/ably-cocoa/ably-cocoa/Test/Tests/AuthTests.swift,line=4162:: test__144__JWT_and_realtime__when_using_authUrl__when_token_expires__receives_a_40142_error_from_the_server, expected to contain <Key/token status changed (expire)>, got <Error 40142 - Key/token status changed (token expired).

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The pull request introduces modifications to the assertions in the AuthTests class. The original assertion that verified the presence of a specific string in the stateChange.reason?.description has been replaced with two distinct assertions. These new assertions check for the presence of the substrings "token" and "expire" separately, enhancing the specificity of the test without altering any exported or public entity declarations.

Changes

File Change Summary
Test/Tests/AuthTests.swift Modified assertions in AuthTests to check for "token" and "expire" separately in stateChange.reason?.description.

Poem

In the realm of tests so bright,
A rabbit hops with pure delight.
"Token" and "expire" now stand tall,
In assertions, they won't fall.
With clarity in each little check,
Our tests are strong, what the heck! 🐇✨

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 80f05fd4023b7e502797ba376f4be0efbd127fc5 and c28a8f8cd9cdc41932466a99cd663ee7c3cf7e67.
Files selected for processing (1) * Test/Tests/AuthTests.swift (1 hunks)
Additional comments not posted (1)
Test/Tests/AuthTests.swift (1)
`4162-4163`: **Good improvement on error description assertions** The updated assertions enhance the test's resilience by checking for key substrings "token" and "expire", reducing dependence on the exact error message.
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , please review it.` -- `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: -- `@coderabbitai generate unit testing code for this file.` -- `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: -- `@coderabbitai generate interesting stats about this repository and render them as a table.` -- `@coderabbitai read src/utils.ts and generate unit testing code.` -- `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` -- `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Early access features: enabled We are currently testing the following features in early access: - **OpenAI `o1` for code reviews**: OpenAI's new o1 model is being tested for generating code suggestions in code reviews. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
lmars commented 2 months ago

@amnonbc I thought I dealt with these types of tests in this SDK but perhaps not, none of them should assert on the error message, only the error code.

I made similar changes in other SDKs, e.g.:

https://github.com/ably/ably-java/pull/1023 https://github.com/ably/ably-ruby/pull/432

lmars commented 2 months ago

If you look at this diff, I removed some error message checks on my branch, but I forgot to PR:

https://github.com/ably/ably-cocoa/pull/1950/files

amnonbc commented 2 months ago

If you look at this diff, I removed some error message checks on my branch, but I forgot to PR:

https://github.com/ably/ably-cocoa/pull/1950/files

It looks like these got fixed in https://github.com/ably/ably-cocoa/commit/b98ce6ebd0cb8a0e1eb1a6ed47e18b5c8778e605

lawrence-forooghian commented 2 months ago

@amnonbc is this intended for review or should it be a draft?

amnonbc commented 2 months ago

@amnonbc is this intended for review or should it be a draft?

It is intended for review. Basically it is wrong for tests to rely on the exact wording of an error message, as we do not guarantee that these message will not change over time. When we reword an error message returned by Realtime to improve readability of the error message, this should not create failures in SDKs.

lawrence-forooghian commented 2 months ago

I’m assuming that some of the other test failures here also are from the time when sandbox WebSocket handling was through frontdoor (i.e. this Slack message)? I’ll re-run the tests to check they go away, and if so will merge.