diff --git a/.github/workflows/dart.yml b/.github/workflows/dart.yml
index 8e04434..444d75a 100644
--- a/.github/workflows/dart.yml
+++ b/.github/workflows/dart.yml
@@ -36,16 +36,16 @@ jobs:
run: dart format --output=none --set-exit-if-changed .
working-directory: packages/${{ matrix.package }}
+ - name: Run build_runner
+ if: contains(fromJson('[ "kiota_abstractions", "kiota_http" ]'), matrix.package)
+ run: dart run build_runner build --delete-conflicting-outputs
+ working-directory: packages/${{ matrix.package }}
+
- name: Analyze project source
continue-on-error: true
run: dart analyze --fatal-infos
working-directory: packages/${{ matrix.package }}
- - name: Run build_runner
- if: contains(fromJson('[ "kiota_abstractions" ]'), matrix.package)
- run: dart run build_runner build --delete-conflicting-outputs
- working-directory: packages/${{ matrix.package }}
-
- name: Run tests
run: dart test
working-directory: packages/${{ matrix.package }}
diff --git a/.run/All Tests.run.xml b/.run/All Tests.run.xml
new file mode 100644
index 0000000..0e1baf4
--- /dev/null
+++ b/.run/All Tests.run.xml
@@ -0,0 +1,7 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.run/Test kiota_abstractions.run.xml b/.run/Test kiota_abstractions.run.xml
new file mode 100644
index 0000000..82c9dbe
--- /dev/null
+++ b/.run/Test kiota_abstractions.run.xml
@@ -0,0 +1,7 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.run/Test kiota_http.run.xml b/.run/Test kiota_http.run.xml
new file mode 100644
index 0000000..543ce3f
--- /dev/null
+++ b/.run/Test kiota_http.run.xml
@@ -0,0 +1,7 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.run/watch kiota_abstractions.run.xml b/.run/watch kiota_abstractions.run.xml
new file mode 100644
index 0000000..6917eea
--- /dev/null
+++ b/.run/watch kiota_abstractions.run.xml
@@ -0,0 +1,17 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.run/build_runner watch.run.xml b/.run/watch kiota_http.run.xml
similarity index 87%
rename from .run/build_runner watch.run.xml
rename to .run/watch kiota_http.run.xml
index 2ee9648..bd6d3ce 100644
--- a/.run/build_runner watch.run.xml
+++ b/.run/watch kiota_http.run.xml
@@ -1,11 +1,11 @@
-
+
-
+
diff --git a/packages/kiota_abstractions/lib/kiota_abstractions.dart b/packages/kiota_abstractions/lib/kiota_abstractions.dart
index c8834c2..e8ee35f 100644
--- a/packages/kiota_abstractions/lib/kiota_abstractions.dart
+++ b/packages/kiota_abstractions/lib/kiota_abstractions.dart
@@ -15,6 +15,7 @@ import 'package:std_uritemplate/std_uritemplate.dart';
import 'package:uuid/uuid.dart';
part 'src/api_client_builder.dart';
+part 'src/api_exception.dart';
part 'src/authentication/access_token_provider.dart';
part 'src/authentication/allowed_hosts_validator.dart';
part 'src/authentication/anonymous_authentication_provider.dart';
diff --git a/packages/kiota_abstractions/lib/src/api_exception.dart b/packages/kiota_abstractions/lib/src/api_exception.dart
index 118325a..876a966 100644
--- a/packages/kiota_abstractions/lib/src/api_exception.dart
+++ b/packages/kiota_abstractions/lib/src/api_exception.dart
@@ -8,6 +8,7 @@ class ApiException implements Exception {
this.statusCode,
this.message,
this.responseHeaders,
+ this.innerExceptions,
});
/// The HTTP status code of the response.
@@ -19,8 +20,26 @@ class ApiException implements Exception {
/// The headers of the response.
final Map>? responseHeaders;
+ /// The inner exceptions that caused this exception.
+ final Iterable? innerExceptions;
+
@override
String toString() {
- return 'ApiException{statusCode: $statusCode, message: $message, headers: $responseHeaders}';
+ return 'ApiException{statusCode: $statusCode, message: $message, headers: $responseHeaders, innerExceptions: $innerExceptions}';
+ }
+
+ /// Creates a new instance of [ApiException] with the given parameters.
+ ApiException copyWith({
+ int? statusCode,
+ String? message,
+ Map>? responseHeaders,
+ Iterable? innerExceptions,
+ }) {
+ return ApiException(
+ statusCode: statusCode ?? this.statusCode,
+ message: message ?? this.message,
+ responseHeaders: responseHeaders ?? this.responseHeaders,
+ innerExceptions: innerExceptions ?? this.innerExceptions,
+ );
}
}
diff --git a/packages/kiota_abstractions/lib/src/http_method.dart b/packages/kiota_abstractions/lib/src/http_method.dart
index a252226..ac6f946 100644
--- a/packages/kiota_abstractions/lib/src/http_method.dart
+++ b/packages/kiota_abstractions/lib/src/http_method.dart
@@ -3,29 +3,34 @@ part of '../kiota_abstractions.dart';
/// Represents the HTTP method used by a request.
enum HttpMethod {
/// The GET method requests a representation of the specified resource. Requests using GET should only retrieve data.
- get,
+ get('GET'),
/// The POST method is used to submit an entity to the specified resource, often causing a change in state or side effects on the server.
- post,
+ post('POST'),
/// The PATCH method is used to apply partial modifications to a resource.
- patch,
+ patch('PATCH'),
/// The DELETE method deletes the specified resource.
- delete,
+ delete('DELETE'),
/// The OPTIONS method is used to describe the communication options for the target resource.
- options,
+ options('OPTIONS'),
/// The PUT method replaces all current representations of the target resource with the request payload.
- put,
+ put('PUT'),
/// The HEAD method asks for a response identical to that of a GET request, but without the response body.
- head,
+ head('HEAD'),
/// The CONNECT method establishes a tunnel to the server identified by the target resource.
- connect,
+ connect('CONNECT'),
/// The TRACE method performs a message loop-back test along the path to the target resource.
- trace,
+ trace('TRACE');
+
+ const HttpMethod(this.value);
+
+ /// The value or name of the method (for example "GET" or "POST").
+ final String value;
}
diff --git a/packages/kiota_abstractions/lib/src/request_adapter.dart b/packages/kiota_abstractions/lib/src/request_adapter.dart
index df88fc0..cd720c3 100644
--- a/packages/kiota_abstractions/lib/src/request_adapter.dart
+++ b/packages/kiota_abstractions/lib/src/request_adapter.dart
@@ -61,4 +61,8 @@ abstract class RequestAdapter {
/// the implementing adapter.
/// [T] is the type of the native request.
Future convertToNativeRequest(RequestInformation requestInfo);
+
+ /// Enables the backing store proxies for the [SerializationWriter]s and
+ /// [ParseNode]s in use using the given [backingStoreFactory].
+ void enableBackingStore(BackingStoreFactory backingStoreFactory);
}
diff --git a/packages/kiota_abstractions/lib/src/request_information.dart b/packages/kiota_abstractions/lib/src/request_information.dart
index 0df02f0..411f8bb 100644
--- a/packages/kiota_abstractions/lib/src/request_information.dart
+++ b/packages/kiota_abstractions/lib/src/request_information.dart
@@ -34,7 +34,7 @@ class RequestInformation {
HttpHeaders get headers => _headers;
/// The request body.
- Uint8List content = Uint8List(0);
+ Uint8List? content;
final Map _requestOptions = {};
diff --git a/packages/kiota_abstractions/test/request_information_test.dart b/packages/kiota_abstractions/test/request_information_test.dart
index 962c677..f145fb3 100644
--- a/packages/kiota_abstractions/test/request_information_test.dart
+++ b/packages/kiota_abstractions/test/request_information_test.dart
@@ -21,11 +21,7 @@ void main() {
expect(blank.pathParameters, {});
expect(blank.queryParameters, {});
expect(blank.headers, HttpHeaders());
- expect(
- blank.content,
- isA()
- .having((content) => content.length, 'length', equals(0)),
- );
+ expect(blank.content, isNull);
expect(blank.requestOptions, []);
expect(() => blank.uri, throwsArgumentError);
diff --git a/packages/kiota_http/README.md b/packages/kiota_http/README.md
index c9dfa54..f5a4f31 100644
--- a/packages/kiota_http/README.md
+++ b/packages/kiota_http/README.md
@@ -19,3 +19,12 @@ Install the package in the generated project:
```bash
dart pub add kiota_http
```
+
+## Development
+
+To build the package, you first need to run `build_runner`.
+It generates the necessary files for the package to work and for running the tests:
+
+```bash
+dart run build_runner build -d
+```
diff --git a/packages/kiota_http/analysis_options.yaml b/packages/kiota_http/analysis_options.yaml
new file mode 100644
index 0000000..feb86ff
--- /dev/null
+++ b/packages/kiota_http/analysis_options.yaml
@@ -0,0 +1 @@
+include: package:strict/analysis_options.yaml
diff --git a/packages/kiota_http/build.yaml b/packages/kiota_http/build.yaml
new file mode 100644
index 0000000..08a3c45
--- /dev/null
+++ b/packages/kiota_http/build.yaml
@@ -0,0 +1,6 @@
+targets:
+ $default:
+ builders:
+ build_version:
+ options:
+ output: lib/gen/version.dart
diff --git a/packages/kiota_http/lib/kiota_http.dart b/packages/kiota_http/lib/kiota_http.dart
new file mode 100644
index 0000000..fd8bd9a
--- /dev/null
+++ b/packages/kiota_http/lib/kiota_http.dart
@@ -0,0 +1,15 @@
+/// This library implements a request adapter for generated
+/// [Kiota](https://github.com/microsoft/kiota) clients.
+library kiota_http;
+
+import 'dart:typed_data';
+
+import 'package:http/http.dart' as http;
+import 'package:http/retry.dart' as retry;
+import 'package:kiota_abstractions/kiota_abstractions.dart';
+import 'package:kiota_http/gen/version.dart';
+import 'package:uuid/uuid.dart';
+
+part 'src/http_client_request_adapter.dart';
+part 'src/kiota_client_factory.dart';
+part 'src/middleware/user_agent_client.dart';
diff --git a/packages/kiota_http/lib/src/http_client_request_adapter.dart b/packages/kiota_http/lib/src/http_client_request_adapter.dart
new file mode 100644
index 0000000..44b600f
--- /dev/null
+++ b/packages/kiota_http/lib/src/http_client_request_adapter.dart
@@ -0,0 +1,298 @@
+part of '../kiota_http.dart';
+
+class HttpClientRequestAdapter implements RequestAdapter {
+ HttpClientRequestAdapter({
+ required http.Client client,
+ required AuthenticationProvider authProvider,
+ required ParseNodeFactory pNodeFactory,
+ required SerializationWriterFactory sWriterFactory,
+ }) : _client = client,
+ _authProvider = authProvider,
+ _pNodeFactory = pNodeFactory,
+ _sWriterFactory = sWriterFactory;
+
+ static const String _claimsKey = 'claims';
+
+ final http.Client _client;
+ final AuthenticationProvider _authProvider;
+
+ // ignore: prefer_final_fields
+ ParseNodeFactory _pNodeFactory;
+ // ignore: prefer_final_fields
+ SerializationWriterFactory _sWriterFactory;
+
+ String? _baseUrl;
+
+ @override
+ String? get baseUrl => _baseUrl;
+
+ @override
+ set baseUrl(String? value) {
+ if (value?.endsWith('/') ?? false) {
+ _baseUrl = value?.substring(0, value.length - 1);
+ } else {
+ _baseUrl = value;
+ }
+ }
+
+ http.BaseRequest _getMessageFromInfo(
+ RequestInformation requestInfo,
+ ) {
+ final request = http.Request(
+ requestInfo.httpMethod!.value,
+ requestInfo.uri,
+ );
+
+ if (requestInfo.headers.isNotEmpty) {
+ final flattenedHeaders = requestInfo.headers.map((name, values) {
+ // according to https://stackoverflow.com/a/3097052/5107884 it is
+ // possible to concatenate multiple header values for the same name with
+ // a comma
+ return MapEntry(name, values.join(', '));
+ });
+
+ request.headers.addAll(flattenedHeaders);
+ }
+
+ if (requestInfo.content case final Uint8List content) {
+ request.bodyBytes = content;
+ }
+
+ return request;
+ }
+
+ Future _getResponse(
+ RequestInformation requestInfo, [
+ String? claims,
+ ]) async {
+ _setBaseUrl(requestInfo);
+
+ Map? additionalAuthContext;
+ if (claims != null) {
+ additionalAuthContext = {_claimsKey: claims};
+ }
+
+ await _authProvider.authenticateRequest(requestInfo, additionalAuthContext);
+
+ final message = _getMessageFromInfo(requestInfo);
+
+ return _client.send(message);
+ }
+
+ void _setBaseUrl(RequestInformation requestInfo) {
+ requestInfo.pathParameters['baseUrl'] = baseUrl;
+ }
+
+ ResponseHandler? _getResponseHandler(RequestInformation requestInfo) {
+ final option = requestInfo.getRequestOption();
+
+ return option?.responseHandler;
+ }
+
+ Future _throwIfFailedResponse(
+ http.StreamedResponse response,
+ ErrorMappings? errorMapping,
+ ) async {
+ if (response.statusCode >= 200 && response.statusCode < 400) {
+ return;
+ }
+
+ final statusCodeInt = response.statusCode;
+ final statusCodeString = response.statusCode.toString();
+ final headers = response.headersSplitValues;
+
+ final ParsableFactory? errorFactory;
+ if (errorMapping == null) {
+ errorFactory = null;
+ } else if (errorMapping.containsKey(statusCodeString)) {
+ errorFactory = errorMapping[statusCodeString];
+ } else if (statusCodeInt >= 400 &&
+ statusCodeInt < 500 &&
+ errorMapping.containsKey('4XX')) {
+ errorFactory = errorMapping['4XX'];
+ } else if (statusCodeInt >= 500 &&
+ statusCodeInt < 600 &&
+ errorMapping.containsKey('5XX')) {
+ errorFactory = errorMapping['5XX'];
+ } else {
+ errorFactory = errorMapping['XXX'];
+ }
+
+ if (errorFactory == null) {
+ throw ApiException(
+ statusCode: statusCodeInt,
+ message:
+ 'The server returned an unexpected status code and no error factory is registered for this code: $statusCodeString',
+ responseHeaders: headers,
+ );
+ }
+
+ final rootNode = await _getRootParseNode(response);
+ final result = rootNode?.getObjectValue(errorFactory);
+
+ if (result case Exception exception) {
+ if (exception case final ApiException apiException) {
+ exception = apiException.copyWith(
+ statusCode: statusCodeInt,
+ responseHeaders: headers,
+ );
+ }
+
+ throw exception;
+ }
+
+ throw ApiException(
+ statusCode: statusCodeInt,
+ message:
+ 'The server returned an unexpected status code and the error registered for this code failed to deserialize: $statusCodeString',
+ responseHeaders: headers,
+ );
+ }
+
+ bool _shouldReturnNull(http.StreamedResponse response) {
+ return response.statusCode == 204 || response.contentLength == 0;
+ }
+
+ Future _getRootParseNode(http.StreamedResponse response) async {
+ final responseContentType = response.headers['content-type'];
+ if (responseContentType == null || responseContentType.isEmpty) {
+ return null;
+ }
+
+ final content = await response.stream.toBytes();
+
+ return _pNodeFactory.getRootParseNode(responseContentType, content);
+ }
+
+ @override
+ Future convertToNativeRequest(RequestInformation requestInfo) async {
+ await _authProvider.authenticateRequest(requestInfo);
+
+ final request = _getMessageFromInfo(requestInfo);
+ if (request is T) {
+ return request as T;
+ }
+
+ throw ArgumentError(
+ 'The request could not be converted to the desired type $T',
+ );
+ }
+
+ Future _sendRequestAndHandleResponse(
+ RequestInformation requestInfo,
+ ErrorMappings? errorMapping,
+ ) async {
+ final response = await _getResponse(requestInfo);
+
+ final handler = _getResponseHandler(requestInfo);
+ if (handler != null) {
+ return handler.handleResponse(response, errorMapping);
+ }
+
+ await _throwIfFailedResponse(response, errorMapping);
+
+ if (_shouldReturnNull(response)) {
+ return null;
+ }
+
+ return _getRootParseNode(response);
+ }
+
+ @override
+ Future send(
+ RequestInformation requestInfo,
+ ParsableFactory factory, [
+ ErrorMappings? errorMapping,
+ ]) async {
+ final rootNode =
+ await _sendRequestAndHandleResponse(requestInfo, errorMapping);
+
+ return rootNode?.getObjectValue(factory);
+ }
+
+ @override
+ Future?> sendCollection(
+ RequestInformation requestInfo,
+ ParsableFactory factory, [
+ ErrorMappings? errorMapping,
+ ]) async {
+ final rootNode =
+ await _sendRequestAndHandleResponse(requestInfo, errorMapping);
+
+ return rootNode?.getCollectionOfObjectValues(factory);
+ }
+
+ @override
+ Future sendNoContent(
+ RequestInformation requestInfo, [
+ ErrorMappings? errorMapping,
+ ]) async {
+ final response = await _getResponse(requestInfo);
+
+ final handler = _getResponseHandler(requestInfo);
+ if (handler != null) {
+ await handler.handleResponse(response, errorMapping);
+
+ return;
+ }
+
+ await _throwIfFailedResponse(response, errorMapping);
+ }
+
+ @override
+ Future sendPrimitive(
+ RequestInformation requestInfo, [
+ ErrorMappings? errorMapping,
+ ]) async {
+ final rootNode =
+ await _sendRequestAndHandleResponse(requestInfo, errorMapping);
+
+ if (rootNode == null) {
+ return null;
+ }
+
+ switch (ModelType) {
+ case const (bool):
+ return rootNode.getBoolValue() as ModelType;
+ case const (int):
+ return rootNode.getIntValue() as ModelType;
+ case const (double):
+ return rootNode.getDoubleValue() as ModelType;
+ case const (String):
+ return rootNode.getStringValue() as ModelType;
+ case const (DateTime):
+ return rootNode.getDateTimeValue() as ModelType;
+ case const (DateOnly):
+ return rootNode.getDateOnlyValue() as ModelType;
+ case const (TimeOnly):
+ return rootNode.getTimeOnlyValue() as ModelType;
+ case const (Duration):
+ return rootNode.getDurationValue() as ModelType;
+ case const (UuidValue):
+ return rootNode.getGuidValue() as ModelType;
+ default:
+ throw ArgumentError(
+ 'The type $ModelType is not supported for primitive deserialization',
+ );
+ }
+ }
+
+ @override
+ Future?> sendPrimitiveCollection(
+ RequestInformation requestInfo, [
+ ErrorMappings? errorMapping,
+ ]) async {
+ final rootNode =
+ await _sendRequestAndHandleResponse(requestInfo, errorMapping);
+
+ return rootNode?.getCollectionOfPrimitiveValues();
+ }
+
+ @override
+ SerializationWriterFactory get serializationWriterFactory => _sWriterFactory;
+
+ @override
+ void enableBackingStore(BackingStoreFactory backingStoreFactory) {
+ throw UnimplementedError('Backing stores not implemented.');
+ }
+}
diff --git a/packages/kiota_http/lib/src/kiota_client_factory.dart b/packages/kiota_http/lib/src/kiota_client_factory.dart
new file mode 100644
index 0000000..04b5776
--- /dev/null
+++ b/packages/kiota_http/lib/src/kiota_client_factory.dart
@@ -0,0 +1,26 @@
+part of '../kiota_http.dart';
+
+class KiotaClientFactory {
+ KiotaClientFactory._();
+
+ static http.Client createClient() {
+ return UserAgentClient(
+ retry.RetryClient(
+ http.Client(),
+ when: (response) {
+ const retryCodes = {
+ 408, // Request Timeout
+ 429, // Too Many Requests
+ 500, // Internal Server Error
+ 502, // Bad Gateway
+ 503, // Service Unavailable
+ 504, // Gateway Timeout
+ };
+
+ return retryCodes.contains(response.statusCode);
+ },
+ ),
+ userAgent: 'kiota_http/$packageVersion',
+ );
+ }
+}
diff --git a/packages/kiota_http/lib/src/middleware/user_agent_client.dart b/packages/kiota_http/lib/src/middleware/user_agent_client.dart
new file mode 100644
index 0000000..634786e
--- /dev/null
+++ b/packages/kiota_http/lib/src/middleware/user_agent_client.dart
@@ -0,0 +1,18 @@
+part of '../../kiota_http.dart';
+
+class UserAgentClient extends http.BaseClient {
+ UserAgentClient(
+ this._inner, {
+ required this.userAgent,
+ });
+
+ final http.Client _inner;
+ final String userAgent;
+
+ @override
+ Future send(http.BaseRequest request) {
+ request.headers['User-Agent'] = userAgent;
+
+ return _inner.send(request);
+ }
+}
diff --git a/packages/kiota_http/pubspec.yaml b/packages/kiota_http/pubspec.yaml
index 5f5fcc2..1db96cb 100644
--- a/packages/kiota_http/pubspec.yaml
+++ b/packages/kiota_http/pubspec.yaml
@@ -12,6 +12,11 @@ dependencies:
path: ../kiota_abstractions
http: ^1.2.1
http_parser: ^4.0.2
+ uuid: ^4.3.3
dev_dependencies:
+ strict: ^2.0.0
test: ^1.25.2
+ mockito: ^5.4.4
+ build_runner: ^2.4.9
+ build_version: ^2.1.1
diff --git a/packages/kiota_http/test/dummy_test.dart b/packages/kiota_http/test/dummy_test.dart
deleted file mode 100644
index 4db2e30..0000000
--- a/packages/kiota_http/test/dummy_test.dart
+++ /dev/null
@@ -1,7 +0,0 @@
-import 'package:test/test.dart';
-
-void main() {
- test('dummy test', () {
- expect(1, 1);
- });
-}
diff --git a/packages/kiota_http/test/http_client_request_adapter_test.dart b/packages/kiota_http/test/http_client_request_adapter_test.dart
new file mode 100644
index 0000000..3b9b730
--- /dev/null
+++ b/packages/kiota_http/test/http_client_request_adapter_test.dart
@@ -0,0 +1,67 @@
+import 'dart:typed_data';
+
+import 'package:http/http.dart' as http;
+import 'package:kiota_abstractions/kiota_abstractions.dart';
+import 'package:kiota_http/kiota_http.dart';
+import 'package:mockito/annotations.dart';
+import 'package:mockito/mockito.dart';
+import 'package:test/test.dart';
+
+import 'http_client_request_adapter_test.mocks.dart';
+
+@GenerateMocks([
+ http.Client,
+ AuthenticationProvider,
+ ParseNodeFactory,
+ SerializationWriterFactory,
+ ParseNode,
+])
+void main() {
+ group('HttpClientRequestAdapter', () {
+ test('sendPrimitive String', () async {
+ final client = MockClient();
+ final authProvider = MockAuthenticationProvider();
+ final pNodeFactory = MockParseNodeFactory();
+ final sWriterFactory = MockSerializationWriterFactory();
+ final parseNode = MockParseNode();
+
+ const stringContent = 'Hello, World!';
+ final contentBytes = Uint8List.fromList(stringContent.codeUnits);
+
+ final adapter = HttpClientRequestAdapter(
+ client: client,
+ authProvider: authProvider,
+ pNodeFactory: pNodeFactory,
+ sWriterFactory: sWriterFactory,
+ );
+
+ final info = RequestInformation(
+ httpMethod: HttpMethod.get,
+ urlTemplate: 'https://example.test/primitive',
+ );
+
+ when(authProvider.authenticateRequest(info))
+ .thenAnswer((_) async => Future.value());
+
+ when(client.send(any)).thenAnswer((_) async {
+ return http.StreamedResponse(
+ Stream.fromIterable([contentBytes]),
+ 200,
+ headers: {
+ 'content-type': 'text/plain',
+ },
+ );
+ });
+
+ when(pNodeFactory.getRootParseNode('text/plain', contentBytes))
+ .thenReturn(parseNode);
+
+ when(parseNode.getStringValue()).thenReturn(stringContent);
+
+ final stringResult = await adapter.sendPrimitive(info);
+
+ expect(stringResult, isNotNull);
+ expect(stringResult, stringContent);
+ });
+ });
+}