🚀 Feature: Constants for Error Types #698

stnguyen90 · 2023-08-08T00:40:39Z

🔖 Feature description

For the error types exposed here we should have a class with constants or an enum so we don't have to manually put the string in the code.

🎤 Pitch

Let say I want to display some error message specifically to the user depending on the type, so instead of doing this:

AppWriteException exception;
if (exception.type == 'user_already_exists') {
...
}

I could use the constant instead

AppWriteException exception;

if (exception.type == ErrorType.userAlreadyExists) {
...
}

Requirements

To implement this, we'll need to update the API specs to include the error types. For the API specs, we'll want to add an AppwriteException schema/definition like so:

    "definitions": {
        "appwriteException": {
            "properties": {
                "message": {
                    "type": "string",
                    "description": "Error message.",
                    "x-example": "Invalid id: Parameter must be a valid number"
                },
                "type": {
                    "type": "string",
                    "description": "Error type.",
                    "enum": [
                        "general_mock",
                        "general_argument_invalid"
                    ],
                    "x-example": "argument_invalid"
                },
                "code": {
                    "type": "integer",
                    "description": "Error code.",
                    "x-example": 400,
                    "format": "int32"
                }
            },
            "x-appwrite": {
                "types": [
                    {
                        "code": 400,
                        "type": "general_mock",
                        "description": "General errors thrown by the mock controller used for testing."
                    },
                    {
                        "code": 400,
                        "type": "general_argument_invalid",
                        "description": "The request contains one or more invalid arguments. Please refer to the endpoint documentation."
                    }
                ]
            }
        },
        "any": {
            "description": "Any",
            "type": "object",
            "additionalProperties": true
        },

Note:

this is an example for Swagger 2. The equivalent will need to be done for OpenAPI 3
we're still finalizing whether was want the types in definitions.appwriteException or definitions.appwriteException.properties.types

The SDK Generator should use the API specs to generate the enums with descriptions like:

enum ErrorType {
   /**
    * General errors thrown by the mock controller used for testing.
    */
    GeneralMock = "general_mock",

    /**
     * The request contains one or more invalid arguments. Please refer to the endpoint documentation.
     */
   GeneralArgumentInvalid = "general_argument_invalid"
}

enum ErrorType implements Comparable<ErrorType> {
  /// General errors thrown by the mock controller used for testing.
  generalMock(code: 400, type: 'general_mock'),
  /// General errors thrown by the mock controller used for testing.
  generalArgumentInvalid(code: 400, type: 'general_argument_invalid');

  const ErrorType({
    required this.code,
    required this.type,
  });

  final int code;
  final String type;

  @override
  int compareTo(ErrorType other) => type.compareTo(other.type);
}

So that the developer's IDE will show the description like:

Tasks

👀 Have you spent some time to check if this issue has been raised before?

I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

I have read the Code of Conduct

The text was updated successfully, but these errors were encountered:

sahilsaha7773 · 2023-08-10T05:14:33Z

Hey @stnguyen90, I and @goswamianshuman are working on this, could you please assign it to us?

goswamianshuman · 2023-08-10T05:33:41Z

Hey @stnguyen90, we are here now you can assign this PR to us.😄

35C4n0r · 2023-10-03T05:54:05Z

@Haimantika I would like to work on this Issue.

Haimantika · 2023-10-03T08:13:14Z

@Haimantika I would like to work on this Issue.

Hi @35C4n0r have assigned the issue to you! Thank you for showing interest in contributing to Appwrite! Happy Hacktoberfest 🎃

Notes:

Please update us with your progress every 3 days, so that we know that you are working on it.
Join us on Discord - https://appwrite.io/discord to chat about Hacktoberfest and Appwrite!

monhelnog · 2023-10-03T15:28:01Z

I would like to work on this issue

Haimantika · 2023-10-03T15:29:43Z

I would like to work on this issue

Hi, we are assigning issues on a first-come, first-serve basis, if @35C4n0r decides to drop off, we will assign it to you.

heyhimansh · 2023-10-04T05:36:38Z

Hey @Haimantika, i would like to work on this issue.

Haimantika · 2023-10-04T20:10:22Z

Hey @Haimantika, i would like to work on this issue.

Hi, we are assigning issues on a first-come, first-serve basis, if @35C4n0r decides to drop off, we will assign it to you.

Haimantika · 2023-10-06T12:25:31Z

Hi @35C4n0r is there an update? The issue will be assigned to the next person in line soon due to inactivity

35C4n0r · 2023-10-06T19:02:14Z

Hi @Haimantika working on this, i've managed to understand the codebase, am still working on this issue.

35C4n0r · 2023-10-07T10:21:03Z

@stnguyen90 @Haimantika
the URL for the Swagger API Spec is invalid

sdk-generator/README.md

Line 50 in 2069238

    
           $spec = new Swagger2(file_get_contents('https://appwrite.io/v1/open-api-2.json?extension=1'));

Can you please inform me about the correct URL.
For now i'm using \tests\resources\spec.json

35C4n0r · 2023-10-07T14:50:55Z

@stnguyen90 should we put the enum in exceptions.*.twig or create a new file for it.
Also for the spec you provided this is the only part we should make an enum out of right?

"x-appwrite": {
                "types": [
                    {
                        "code": 400,
                        "type": "general_mock",
                        "description": "General errors thrown by the mock controller used for testing."
                    },
                    {
                        "code": 400,
                        "type": "general_argument_invalid",
                        "description": "The request contains one or more invalid arguments. Please refer to the endpoint documentation."
                    }
                ]
            }
        }

stnguyen90 · 2023-10-09T20:14:24Z

@35C4n0r,

the URL for the Swagger API Spec is invalid

The specs are here.

should we put the enum in exceptions.*.twig or create a new file for it.

In the exception file is fine.

Also for the spec you provided this is the only part we should make an enum out of right?

FYI, we already have appwrite/appwrite#5979 open for the specs part, although we haven't finalized where in the specs the types should go.

ItzNotABug · 2024-03-01T04:52:06Z

Commenting to get notified of any updates to this!

sahilsaha7773 mentioned this issue Aug 12, 2023

Feat: Add appwriteException with constants for error types in specs appwrite/appwrite#5979

Open

1 task

github-actions bot mentioned this issue Sep 1, 2023

Issues Opened in August 2023 appwrite/.github#67

Closed

stnguyen90 linked a pull request Sep 10, 2023 that will close this issue

add missing error type while throwing error #716

Merged

lohanidamodar closed this as completed in #716 Sep 11, 2023

stnguyen90 removed a link to a pull request Sep 25, 2023

add missing error type while throwing error #716

Merged

stnguyen90 reopened this Sep 25, 2023

Haimantika added the hacktoberfest Issues that can win you some cool merchandise! label Sep 30, 2023

Haimantika assigned 35C4n0r Oct 3, 2023

stnguyen90 self-assigned this Oct 9, 2023

35C4n0r linked a pull request Oct 10, 2023 that will close this issue

feat: added constants for Error Types #724

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🚀 Feature: Constants for Error Types #698

🚀 Feature: Constants for Error Types #698

stnguyen90 commented Aug 8, 2023 •

edited

sahilsaha7773 commented Aug 10, 2023

goswamianshuman commented Aug 10, 2023

35C4n0r commented Oct 3, 2023

Haimantika commented Oct 3, 2023

monhelnog commented Oct 3, 2023

Haimantika commented Oct 3, 2023 •

edited

heyhimansh commented Oct 4, 2023

Haimantika commented Oct 4, 2023

Haimantika commented Oct 6, 2023

35C4n0r commented Oct 6, 2023

35C4n0r commented Oct 7, 2023 •

edited

35C4n0r commented Oct 7, 2023

stnguyen90 commented Oct 9, 2023

ItzNotABug commented Mar 1, 2024

🚀 Feature: Constants for Error Types #698

🚀 Feature: Constants for Error Types #698

Comments

stnguyen90 commented Aug 8, 2023 • edited

🔖 Feature description

🎤 Pitch

Requirements

Tasks

👀 Have you spent some time to check if this issue has been raised before?

🏢 Have you read the Code of Conduct?

sahilsaha7773 commented Aug 10, 2023

goswamianshuman commented Aug 10, 2023

35C4n0r commented Oct 3, 2023

Haimantika commented Oct 3, 2023

monhelnog commented Oct 3, 2023

Haimantika commented Oct 3, 2023 • edited

heyhimansh commented Oct 4, 2023

Haimantika commented Oct 4, 2023

Haimantika commented Oct 6, 2023

35C4n0r commented Oct 6, 2023

35C4n0r commented Oct 7, 2023 • edited

35C4n0r commented Oct 7, 2023

stnguyen90 commented Oct 9, 2023

ItzNotABug commented Mar 1, 2024

stnguyen90 commented Aug 8, 2023 •

edited

Haimantika commented Oct 3, 2023 •

edited

35C4n0r commented Oct 7, 2023 •

edited