Skip to content
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

[ECO-4968] Added NS_SWIFT_SENDABLE to all query types #1

Conversation

ruancomelli
Copy link
Collaborator

By analogy with ARTRealtimePresenceQuery (which causes warning in Xcode 16) I've added NS_SWIFT_SENDABLE to other query types as well.

Closes ably#1971

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced the ARTBaseQuery component, enhancing query capabilities within the Ably framework.
    • Added properties to various query classes, allowing for more granular control over query parameters, including start, end, limit, and direction.
    • Enhanced presence query functionality with new properties for improved control over synchronization behavior.
    • Improved handling of statistics queries with a new granularity unit.
  • Bug Fixes

    • Improved immutability checks for query objects to prevent modifications after they are marked as "frozen."
    • Enhanced handling of nil values during encoding and decoding processes to prevent unexpected behavior.
  • Tests

    • Expanded the test suite to include checks for exception handling when modifying frozen query properties, ensuring robustness and reliability.

@ruancomelli
Copy link
Collaborator Author

This is a benchmark review for experiment mermaid_diagrams.
Run ID: mermaid_diagrams/benchmark_2024-09-20T14-09-29_v1-22-0-140-ga8d2a8b27-dirty.

This pull request was cloned from https://github.com/ably/ably-cocoa/pull/1973. (Note: the URL is not a link to avoid triggering a notification on the original pull request.)

Experiment configuration
review_config:
  # User configuration for the review
  # - benchmark - use the user config from the benchmark reviews
  # - <value> - use the value directly
  user_review_config:
    enable_ai_review: true
    enable_rule_comments: false

    enable_complexity_comments: false
    enable_security_comments: false
    enable_tests_comments: false
    enable_comment_suggestions: false
    enable_functionality_review: false

    enable_pull_request_summary: false
    enable_review_guide: true

    enable_approvals: false

  ai_review_config:
    # The model responses to use for the experiment
    # - benchmark - use the model responses from the benchmark reviews
    # - llm - call the language model to generate responses
    model_responses:
      comments_model: benchmark
      comment_area_model: benchmark
      comment_validation_model: benchmark
      comment_suggestion_model: benchmark
      complexity_model: benchmark
      functionality_model: benchmark
      security_model: benchmark
      tests_model: benchmark
      pull_request_summary_model: benchmark
      review_guide_model: llm
      overall_comments_model: benchmark

# The pull request dataset to run the experiment on
pull_request_dataset:
- https://github.com/sourcery-ai/core/pull/4607
- https://github.com/sourcery-ai/core/pull/4631
- https://github.com/sourcery-ai/core/pull/4647
    # CodeRabbit examples:
- https://github.com/2lambda123/-Orange-OpenSource-oorobot/pull/15
- https://github.com/2lambda123/galaxyproject-galaxy/pull/12
- https://github.com/a0v0/avtoolz/pull/79
- https://github.com/adityask98/Hotaru/pull/10
- https://github.com/agdas/vscode/pull/2
- https://github.com/agluszak/hirschgarten/pull/2
- https://github.com/alexsnow348/insightface/pull/46
- https://github.com/alikuxac/utilities/pull/10
- https://github.com/AlphaDev87/timba-api/pull/49
- https://github.com/AngeloTadeucci/Maple2/pull/239
- https://github.com/AngeloTadeucci/Maple2.File/pull/36
- https://github.com/AngeloTadeucci/Maple2/pull/233
    # Examples where CodeRabbit does not generate diagrams
- https://github.com/baptisteArno/typebot.io/pull/1778
- https://github.com/btipling/foundations/pull/33
- https://github.com/btipling/foundations/pull/31
- https://github.com/chintu-777/jaeger/pull/1
- https://github.com/coji/remix-docs-ja/pull/55
- https://github.com/DaveMBush/SmartNgRX/pull/622
- https://github.com/DaveMBush/SmartNgRX/pull/481
- https://github.com/dkittle/party-connections/pull/6
- https://github.com/Drajad-Kusuma-Adi/onstudy-backend/pull/6
- https://github.com/imaami/libcanth/pull/2
  # Requested by Tim
- https://github.com/2lambda123/-Orange-OpenSource-oorobot/pull/15
- https://github.com/2lambda123/galaxyproject-galaxy/pull/12
- https://github.com/a0v0/avtoolz/pull/79
- https://github.com/adityask98/Hotaru/pull/10
- https://github.com/agdas/vscode/pull/2
- https://github.com/agluszak/hirschgarten/pull/2
- https://github.com/4DNucleome/PartSeg/pull/1183
- https://github.com/ably/ably-cocoa/pull/1973
- https://github.com/ably-labs/ably-chat-swift/pull/54
- https://github.com/ably-labs/ably-chat-swift/pull/35

# Questions to ask to label the review comments
review_comment_labels: []
# - label: correct
#   question: Is this comment correct?

# Benchmark reviews generated by running
#   python -m scripts.experiment benchmark <experiment_name>
benchmark_reviews:
- dataset_pull_request: https://github.com/sourcery-ai/core/pull/4607
  review_pull_request: https://github.com/sourcery-ai-experiments/core/pull/338
- dataset_pull_request: https://github.com/sourcery-ai/core/pull/4631
  review_pull_request: https://github.com/sourcery-ai-experiments/core/pull/339
- dataset_pull_request: https://github.com/sourcery-ai/core/pull/4647
  review_pull_request: https://github.com/sourcery-ai-experiments/core/pull/340
- dataset_pull_request: https://github.com/2lambda123/-Orange-OpenSource-oorobot/pull/15
  review_pull_request: https://github.com/sourcery-ai-experiments/-Orange-OpenSource-oorobot/pull/2
- dataset_pull_request: https://github.com/2lambda123/galaxyproject-galaxy/pull/12
  review_pull_request: https://github.com/sourcery-ai-experiments/galaxyproject-galaxy/pull/1
- dataset_pull_request: https://github.com/adityask98/Hotaru/pull/10
  review_pull_request: https://github.com/sourcery-ai-experiments/Hotaru/pull/2
- dataset_pull_request: https://github.com/agdas/vscode/pull/2
  review_pull_request: https://github.com/sourcery-ai-experiments/vscode/pull/3
- dataset_pull_request: https://github.com/agluszak/hirschgarten/pull/2
  review_pull_request: https://github.com/sourcery-ai-experiments/hirschgarten/pull/2
- dataset_pull_request: https://github.com/alikuxac/utilities/pull/10
  review_pull_request: https://github.com/sourcery-ai-experiments/utilities/pull/2
- dataset_pull_request: https://github.com/AlphaDev87/timba-api/pull/49
  review_pull_request: https://github.com/sourcery-ai-experiments/timba-api/pull/2
- dataset_pull_request: https://github.com/AngeloTadeucci/Maple2/pull/239
  review_pull_request: https://github.com/sourcery-ai-experiments/Maple2/pull/3
- dataset_pull_request: https://github.com/AngeloTadeucci/Maple2.File/pull/36
  review_pull_request: https://github.com/sourcery-ai-experiments/Maple2.File/pull/2
- dataset_pull_request: https://github.com/AngeloTadeucci/Maple2/pull/233
  review_pull_request: https://github.com/sourcery-ai-experiments/Maple2/pull/4
- dataset_pull_request: https://github.com/baptisteArno/typebot.io/pull/1778
  review_pull_request: https://github.com/sourcery-ai-experiments/typebot.io/pull/1
- dataset_pull_request: https://github.com/btipling/foundations/pull/33
  review_pull_request: https://github.com/sourcery-ai-experiments/foundations/pull/1
- dataset_pull_request: https://github.com/btipling/foundations/pull/31
  review_pull_request: https://github.com/sourcery-ai-experiments/foundations/pull/2
- dataset_pull_request: https://github.com/chintu-777/jaeger/pull/1
  review_pull_request: https://github.com/sourcery-ai-experiments/jaeger/pull/1
- dataset_pull_request: https://github.com/coji/remix-docs-ja/pull/55
  review_pull_request: https://github.com/sourcery-ai-experiments/remix-docs-ja/pull/1
- dataset_pull_request: https://github.com/DaveMBush/SmartNgRX/pull/622
  review_pull_request: https://github.com/sourcery-ai-experiments/SmartNgRX/pull/1
- dataset_pull_request: https://github.com/DaveMBush/SmartNgRX/pull/481
  review_pull_request: https://github.com/sourcery-ai-experiments/SmartNgRX/pull/2
- dataset_pull_request: https://github.com/dkittle/party-connections/pull/6
  review_pull_request: https://github.com/sourcery-ai-experiments/party-connections/pull/1
- dataset_pull_request: https://github.com/Drajad-Kusuma-Adi/onstudy-backend/pull/6
  review_pull_request: https://github.com/sourcery-ai-experiments/onstudy-backend/pull/1
- dataset_pull_request: https://github.com/imaami/libcanth/pull/2
  review_pull_request: https://github.com/sourcery-ai-experiments/libcanth/pull/1

@SourceryAI
Copy link

SourceryAI commented Sep 20, 2024

Reviewer's Guide by Sourcery

This pull request adds the NS_SWIFT_SENDABLE attribute to various query types in the Ably SDK, enhancing Swift concurrency support. It also introduces a new ARTBaseQuery class to improve query handling and implements property accessors with immutability checks for query objects.

File-Level Changes

Change Details Files
Added NS_SWIFT_SENDABLE attribute to query classes
  • Added NS_SWIFT_SENDABLE to ARTDataQuery, ARTPresenceQuery, ARTRealtimePresenceQuery, ARTStatsQuery, and ARTChannelProperties
  • Created a new ARTBaseQuery class as a base for query objects
Source/include/Ably/ARTDataQuery.h
Source/include/Ably/ARTRestPresence.h
Source/include/Ably/ARTRealtimePresence.h
Source/include/Ably/ARTStats.h
Source/include/Ably/ARTRealtimeChannel.h
Source/include/Ably/ARTBaseQuery.h
Source/ARTBaseQuery.m
Implemented property accessors with immutability checks
  • Added private instance variables for query properties
  • Implemented getter and setter methods for query properties
  • Added throwIfFrozen method to prevent modifications after query is used
Source/ARTDataQuery.m
Source/ARTRestPresence.m
Source/ARTRealtimePresence.m
Source/ARTStats.m
Updated query handling in REST and Realtime clients
  • Set query.frozen = true before using queries in client methods
  • Updated test cases to check for exceptions when modifying frozen queries
Source/ARTRest.m
Source/ARTRestChannel.m
Test/Tests/RestClientPresenceTests.swift
Test/Tests/RestClientChannelTests.swift
Test/Tests/RealtimeClientPresenceTests.swift
Test/Tests/RealtimeClientChannelTests.swift
Test/Tests/RestClientStatsTests.swift
Enhanced Swift compatibility
  • Added conditional compilation for Swift 6 compatibility
  • Updated Sequence conformance for ARTRealtimeChannels and ARTRestChannels
Test/Tests/RealtimeClientChannelsTests.swift
Test/Tests/RestClientChannelsTests.swift
Improved error handling in data encoding and decoding
  • Added null check for encoded data in ARTDataEncoder
  • Enhanced type checking for delta compression decoding
Source/ARTDataEncoder.m

Sequence Diagram

sequenceDiagram
    participant Client as Ably Client
    participant Query as Query Object
    participant BaseQuery as ARTBaseQuery
    Client->>Query: Create query
    Query->>BaseQuery: Inherit from
    Client->>Query: Set properties
    Client->>Query: Pass to API method
    Query->>BaseQuery: Set frozen = true
    Note over Query: Properties can no longer be modified
    Client->>Query: Attempt to modify property
    Query->>BaseQuery: throwIfFrozen
    BaseQuery-->>Client: Throw exception
Loading

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link

@SourceryAI SourceryAI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ruancomelli - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Documentation: all looks good

LangSmith trace

Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants