Skip to content

feat-custom-exception-model #113

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

Merged
eldadfux merged 7 commits into from
Feb 25, 2021
Merged

feat-custom-exception-model #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
017d0e3
converting flutter sdk to library format
lohanidamodar Feb 18, 2021
3a32914
converting dart sdk to library format
lohanidamodar Feb 18, 2021
916de91
set the package name for flutter and dart sdk to better test packages…
lohanidamodar Feb 18, 2021
e603b14
remove extra spacing
lohanidamodar Feb 21, 2021
6401953
exception model and handling in flutter
lohanidamodar Feb 22, 2021
6f5a872
fixing when no response and other small fixes
lohanidamodar Feb 24, 2021
c6dce47
fix typo
lohanidamodar Feb 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions example.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,10 @@ function getSSLPage($url) {
$sdk->generate(__DIR__ . '/examples/python');

// Dart
$sdk = new SDK(new Dart(), new Swagger2($spec));
$dart = new Dart();
$dart->setPackageName('dart_appwrite');

$sdk = new SDK($dart, new Swagger2($spec));

$sdk
->setName('NAME')
Expand All @@ -219,7 +222,9 @@ function getSSLPage($url) {
$sdk->generate(__DIR__ . '/examples/dart');

// Flutter
$sdk = new SDK(new Flutter(), new Swagger2($spec));
$flutter = new Flutter();
$flutter->setPackageName('appwrite');
$sdk = new SDK($flutter, new Swagger2($spec));

$sdk
->setName('NAME')
Expand Down
6 changes: 1 addition & 5 deletions templates/dart/lib/client.dart.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
import 'dart:io';
import 'package:dio/dio.dart';
import 'package:dio/adapter.dart';

import 'enums.dart';
part of {{ language.params.packageName }};

class Client {
String endPoint;
Expand Down
2 changes: 2 additions & 0 deletions templates/dart/lib/enums.dart.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
part of {{ language.params.packageName }};

enum HttpMethod { get, post, put, delete, patch }

extension HttpMethodString on HttpMethod {
Expand Down
15 changes: 12 additions & 3 deletions templates/dart/lib/package.dart.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
library {{ language.params.packageName }};

import 'dart:io';
import 'package:dio/dio.dart';
import 'package:meta/meta.dart';
import 'package:dio/adapter.dart';


export 'package:dio/dio.dart' show Response, MultipartFile;

export 'client.dart';
export 'enums.dart';
part 'client.dart';
part 'enums.dart';
part 'service.dart';
{% for service in spec.services %}
export 'services/{{service.name | caseDash}}.dart';
part 'services/{{service.name | caseDash}}.dart';
{% endfor %}
2 changes: 1 addition & 1 deletion templates/dart/lib/service.dart.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import 'client.dart';
part of {{ language.params.packageName }};

class Service {
final Client client;
Expand Down
8 changes: 2 additions & 6 deletions templates/dart/lib/services/service.dart.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
part of {{ language.params.packageName }};

{% macro parameter(parameter) %}
{% if parameter.name == 'orderType' %}{% if parameter.required %}@required {% endif %}{{ 'OrderType orderType = OrderType.asc' }}{% else %}
{% if parameter.required %}@required {% endif %}{{ parameter.type | typeName }} {{ parameter.name | caseCamel }}{{ parameter | escapeDollarSign | paramDefault }}{% endif %}
Expand All @@ -10,12 +12,6 @@
'{{ parameter.name }}': {{ parameter.name | caseCamel }},{% endif %}
{% endmacro %}

import 'package:dio/dio.dart';
import 'package:meta/meta.dart';
import "../client.dart";
import '../enums.dart';
import "../service.dart";

class {{ service.name | caseUcfirst }} extends Service {
{{ service.name | caseUcfirst }}(Client client): super(client);
{% for method in service.methods %}
Expand Down
45 changes: 22 additions & 23 deletions templates/flutter/lib/client.dart.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
import 'dart:io';

import 'package:dio/dio.dart';
import 'package:flutter/foundation.dart';
import 'package:dio/adapter.dart';
import 'package:dio_cookie_manager/dio_cookie_manager.dart';
import 'package:cookie_jar/cookie_jar.dart';
import 'package:path_provider/path_provider.dart';
import 'package:package_info_plus/package_info_plus.dart';

import 'enums.dart';
part of {{ language.params.packageName }};

class Client {
String endPoint;
Expand Down Expand Up @@ -118,18 +108,27 @@ class Client {
method: method.name(),
);

if(headers['content-type'] == 'multipart/form-data') {
return http.request(path, data: FormData.fromMap(params), options: options);
}

if (method == HttpMethod.get) {
params.keys.forEach((key) {if (params[key] is int || params[key] is double) {
params[key] = params[key].toString();
}});

return http.get(path, queryParameters: params, options: options);
} else {
return http.request(path, data: params, options: options);
try {
if(headers['content-type'] == 'multipart/form-data') {
return await http.request(path, data: FormData.fromMap(params), options: options);
}

if (method == HttpMethod.get) {
params.keys.forEach((key) {if (params[key] is int || params[key] is double) {
params[key] = params[key].toString();
}});

return await http.get(path, queryParameters: params, options: options);
} else {
return await http.request(path, data: params, options: options);
}
} on DioError catch(e) {
if(e.response == null) {
throw {{spec.title | caseUcfirst}}Exception(e.message);
}
throw {{spec.title | caseUcfirst}}Exception(e.response.data['message'],e.response.data['code'], e.response.data);
} catch(e) {
throw {{spec.title | caseUcfirst}}Exception(e.message);
}
}
}
2 changes: 2 additions & 0 deletions templates/flutter/lib/enums.dart.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
part of {{ language.params.packageName }};

enum HttpMethod { get, post, put, delete, patch }

extension HttpMethodString on HttpMethod {
Expand Down
10 changes: 10 additions & 0 deletions templates/flutter/lib/exception.dart.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
part of {{ language.params.packageName }};

class {{spec.title | caseUcfirst}}Exception implements Exception {
final String message;
final int code;
final dynamic response;
Copy link
Contributor

@JulianBissekkou JulianBissekkou Feb 24, 2021

Choose a reason for hiding this comment

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

Can we maybe have a specific type here? 🤔
String maybe?
Map<String, dynamic> is fine as well, but as a mobile developer who is coming from strongly typed languages like kotlin, java or swift I like having types 👍

Copy link
Contributor

@JulianBissekkou JulianBissekkou Feb 24, 2021

Choose a reason for hiding this comment

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

If the response can be different in some cases it's fine to have dynamic but then I would add a little comment to it. In our case, we are casting to some type.

Copy link
Member Author

@lohanidamodar lohanidamodar Feb 25, 2021

Choose a reason for hiding this comment

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

I believe the response can be Json or can be String as well. @eldadfux do you agree?

Copy link
Member

@eldadfux eldadfux Feb 25, 2021

Choose a reason for hiding this comment

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

Yeh It might be tricky because sometimes a proxy can throw the error and we can't be sure of the format.


{{spec.title | caseUcfirst}}Exception([this.message = "", this.code, this.response]);

}
23 changes: 20 additions & 3 deletions templates/flutter/lib/package.dart.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,24 @@
library {{ language.params.packageName }};

import 'dart:io';
import 'package:universal_html/html.dart' as html;
import 'package:dio/dio.dart';
import 'package:meta/meta.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter_web_auth/flutter_web_auth.dart';
import 'package:dio/adapter.dart';
import 'package:dio_cookie_manager/dio_cookie_manager.dart';
import 'package:cookie_jar/cookie_jar.dart';
import 'package:path_provider/path_provider.dart';
import 'package:package_info_plus/package_info_plus.dart';


export 'package:dio/dio.dart' show Response;

export 'client.dart';
export 'enums.dart';
part 'client.dart';
part 'enums.dart';
part 'service.dart';
part 'exception.dart';
{% for service in spec.services %}
export 'services/{{service.name | caseDash}}.dart';
part 'services/{{service.name | caseDash}}.dart';
{% endfor %}
2 changes: 1 addition & 1 deletion templates/flutter/lib/service.dart.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import 'client.dart';
part of {{ language.params.packageName }};

class Service {
final Client client;
Expand Down
18 changes: 2 additions & 16 deletions templates/flutter/lib/services/service.dart.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
part of {{ language.params.packageName }};

{% macro parameter(parameter) %}
{% if parameter.name == 'orderType' %}{% if parameter.required %}@required {% endif %}{{ 'OrderType orderType = OrderType.asc' }}{% else %}
{% if parameter.required %}@required {% endif %}{{ parameter.type | typeName }} {{ parameter.name | caseCamel }}{{ parameter | escapeDollarSign | paramDefault }}{% endif %}
Expand All @@ -10,22 +12,6 @@
'{{ parameter.name }}': {{ parameter.name | caseCamel }},{% endif %}
{% endmacro %}

{% if(service.features.webAuth) %}
import 'dart:io';
import 'package:universal_html/html.dart' as html;
{% endif %}

import 'package:dio/dio.dart';
import 'package:meta/meta.dart';
{% if(service.features.webAuth) %}
import 'package:flutter/foundation.dart';
import 'package:flutter_web_auth/flutter_web_auth.dart';
{% endif %}

import "../client.dart";
import '../enums.dart';
import "../service.dart";

class {{ service.name | caseUcfirst }} extends Service {
{{ service.name | caseUcfirst }}(Client client): super(client);
{% for method in service.methods %}
Expand Down