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.

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

Jump to bottom

EDU:1615 Error handling #2382

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

EDU:1615 Error handling #2382

wants to merge 2 commits into from

Conversation

franrob-projects
Copy link
Contributor

@franrob-projects franrob-projects commented Jan 15, 2025 •
edited
Loading

This PR:

  • Creates a new error handling section.
    • Consists of two pages not connected to the nav (still waiting for the products section).
  • Improves examples.
  • Improves resolutions.
  • Improves inconsistencies.

Question

  1. Do we need to redirect the error codes from the app's output?
  2. Where can we add the "general notes". There is a fair bit of content there. But they are generic and don't fit into the current pages. How can we add them?

Question

The padding below the bullet points throws the general look of the document off IMO.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jan 15, 2025 •
edited
Loading

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ably-ci ably-ci temporarily deployed to ably-docs-edu-1615-erro-wxze34 January 15, 2025 16:11 Inactive
@franrob-projects franrob-projects force-pushed the EDU-1615--Error-handling branch from 9d80a82 to c042913 Compare January 15, 2025 16:14
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-1615-erro-wxze34 January 15, 2025 16:15 Inactive
@franrob-projects franrob-projects force-pushed the EDU-1615--Error-handling branch from c042913 to 65cc759 Compare January 15, 2025 16:16
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-1615-erro-wxze34 January 15, 2025 16:16 Inactive
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-1615-erro-wxze34 January 15, 2025 16:43 Inactive
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-1615-erro-wxze34 January 20, 2025 12:36 Inactive
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-1615-erro-wxze34 January 20, 2025 12:37 Inactive
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-1615-erro-wxze34 January 20, 2025 13:05 Inactive
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-1615-erro-wxze34 January 20, 2025 13:49 Inactive
@franrob-projects franrob-projects force-pushed the EDU-1615--Error-handling branch from a892b4f to 5f8fe53 Compare January 20, 2025 13:52
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-1615-erro-wxze34 January 20, 2025 13:53 Inactive
@m-hulbert m-hulbert temporarily deployed to ably-docs-edu-1615-erro-e1exnx February 20, 2025 10:26 Inactive
m-hulbert
m-hulbert requested changes Feb 20, 2025
View reviewed changes
Copy link
Contributor

@m-hulbert m-hulbert left a comment

Choose a reason for hiding this comment

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

This seems to be missing a significant number of errors in addition to the notes on the error codes page.

content/push/index.textile Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we drop this out of the PR please? 🙂

content/error-handling/error-codes.textile
@@ -0,0 +1,301 @@
---
title: Error handling
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be 'Error codes'.

What are your thoughts about the folder being errors and this file being codes. We can still label this differently in the nav, but it keeps the URL concise.

content/error-handling/error-codes.textile Outdated
@@ -0,0 +1,301 @@
---
title: Error handling
meta_description: " "
Copy link
Contributor

Choose a reason for hiding this comment

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

Need a description here.

content/error-handling/error-codes.textile Outdated

h2(#errors). Invalid input/request errors

h3(40000). 40000 - Bad request
Copy link
Contributor

Choose a reason for hiding this comment

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

Missing your #

content/error-handling/error-codes.textile Outdated
Comment on lines 8 to 16
If the provided information does not resolve your issue, contact Ably "support":https://ably.com/support. When contacting, include details such as your app ID, the error code, and any relevant logs to help troubleshoot. Include as much of the following information as possible:
* Provide timestamps in UTC format.
* Include complete SDK logs from the time of the failure. Ensure these logs show activity before and after the timeout, as SDKs retry failed requests by default.
* Specify which endpoints were accessed. Mention if you use custom client options, the environment setting, and the failing SDK operation.
* State the SDK/s you use, including the platform and versions.
* Include any stack traces related to the error.
* Indicate whether the issue occurs consistently or was a one-time event.
* Provide details to confirm whether the issue was related to your network or Ably's availability. For example, note whether other internet operations were succeeding simultaneously.
* Include the app ID associated with the request.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this would be better off on the main errors page, rather than here. WDYT?

content/error-handling/error-codes.textile Outdated

*Resolution:* If you need to change your client's @clientId@, deactivate and reactivate the device. This process triggers an internal @device.reset()@ call, which clears and resets the old device details.

h2(#spaces). Spaces and locking errors
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
h2(#spaces). Spaces and locking errors
h2(#spaces). Spaces errors

content/error-handling/error-codes.textile Outdated

*Resolution:* Specify the name parameter when calling the @spaces.get()@ method:

```[realtime_javascript]
Copy link
Contributor

Choose a reason for hiding this comment

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

The above is only js, this is realtime_js

content/error-handling/error-codes.textile Outdated

*Resolution:* Call the @space.enter()@ method before using any features. For example:

```[realtime_javascript]
Copy link
Contributor

Choose a reason for hiding this comment

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

As above - these should be consistent throughout

content/error-handling/error-codes.textile Outdated

h3(#40022). 40022 - Invalid resource

The requested resource is invalid or already exists.
Copy link
Contributor

Choose a reason for hiding this comment

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

This should mention that it's returned by the Control API

content/error-handling/error-codes.textile Outdated

An example of this error is attempting to create an app named "MyApp" when an app with that name already exists or attempting to create a user account with an email address that is already registered.

*Resolution:* Ensure unique app's name has valid capabilities in requests.
Copy link
Contributor

Choose a reason for hiding this comment

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

This only covers 1 instance of the error occurring.

@franrob-projects franrob-projects force-pushed the EDU-1615--Error-handling branch from 4f03213 to 8abdcf8 Compare March 10, 2025 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@m-hulbert m-hulbert Awaiting requested review from m-hulbert

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@franrob-projects @m-hulbert @ably-ci