http_serving.dart

// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/// Features for serving HTTP requests on Google Cloud Platform.
///
/// This library provides functions to run a `shelf` server that handles
/// requests in a way that is compatible with Google Cloud environments like
/// Cloud Run and Cloud Functions. It includes middleware for logging requests
/// in the format expected by Google Cloud Logging.
///
/// ## Example
///
/// ```dart
/// import 'package:google_cloud/google_cloud.dart';
/// import 'package:shelf/shelf.dart';
///
/// Future<void> main() async {
///   final handler = const Pipeline()
///       .addMiddleware(createLoggingMiddleware())
///       .addHandler(_helloWorldHandler);
///
///   await serveHandler(handler);
/// }
///
/// Response _helloWorldHandler(Request request) {
///   return Response.ok('Hello, World!');
/// }
/// ```
///
/// {@canonicalFor http_serving.BadConfigurationException}
/// {@canonicalFor http_serving.badRequestMiddleware}
/// {@canonicalFor http_serving.cloudLoggingMiddleware}
/// {@canonicalFor http_serving.createLoggingMiddleware}
/// {@canonicalFor http_serving.currentLogger}
/// {@canonicalFor http_serving.errorLoggingMiddleware}
/// {@canonicalFor http_serving.BadRequestException}
/// {@canonicalFor http_serving.HttpResponseException}
/// {@canonicalFor http_serving.listenPortFromEnvironment}
/// {@canonicalFor http_serving.serveHandler}
/// {@canonicalFor http_serving.TraceContextData}
/// {@canonicalFor http_serving.waitForTerminate}
library;

export 'src/logger.dart' show CloudLogger, LogSeverity;
export 'src/serving/bad_configuration_exception.dart'
    show BadConfigurationException;
export 'src/serving/http_logging.dart'
    show
        badRequestMiddleware,
        cloudLoggingMiddleware,
        createLoggingMiddleware,
        currentLogger,
        errorLoggingMiddleware;
export 'src/serving/http_response_exception.dart'
    show
        // ignore: deprecated_member_use_from_same_package
        BadRequestException,
        HttpResponseException;
export 'src/serving/serve.dart' show listenPortFromEnvironment, serveHandler;
export 'src/serving/terminate.dart' show waitForTerminate;
export 'src/serving/trace_context_data.dart' show TraceContextData;