1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

//! Components of a federated GraphQL Server.
//!
//! Most of these modules are of varying interest to different audiences.
//!
//! If your interests are confined to developing plugins, then the following modules
//! are likely to be of most interest to you:
//!
//! * [`self`] - this module (apollo_router) contains high level building blocks for a federated GraphQL router
//!
//! * [`graphql`] - graphql specific functionality for requests, responses, errors
//!
//! * [`layers`] - examples of tower layers used to implement plugins
//!
//! * [`plugin`] - various APIs for implementing a plugin
//!
//! * [`services`] - the various services handling a GraphQL requests,
//!   and APIs for plugins to intercept them

#![cfg_attr(feature = "failfast", allow(unreachable_code))]
#![warn(unreachable_pub)]
#![warn(missing_docs)]

macro_rules! failfast_debug {
    ($($tokens:tt)+) => {{
        tracing::debug!($($tokens)+);
        #[cfg(feature = "failfast")]
        panic!(
            "failfast triggered. \
            Please remove the feature failfast if you don't want to see these panics"
        );
    }};
}

macro_rules! failfast_error {
    ($($tokens:tt)+) => {{
        tracing::error!($($tokens)+);
        #[cfg(feature = "failfast")]
        panic!(
            "failfast triggered. \
            Please remove the feature failfast if you don't want to see these panics"
        );
    }};
}

#[macro_use]
mod json_ext;
#[macro_use]
pub mod plugin;

pub(crate) mod axum_factory;
mod cache;
mod configuration;
mod context;
mod error;
mod executable;
mod files;
pub mod graphql;
mod http_ext;
mod http_server_factory;
mod introspection;
pub mod layers;
mod orbiter;
mod plugins;
mod query_planner;
mod request;
mod response;
mod router;
mod router_factory;
pub mod services;
pub(crate) mod spec;
mod state_machine;
mod test_harness;
pub mod tracer;
mod uplink;

pub use crate::configuration::Configuration;
pub use crate::configuration::ListenAddr;
pub use crate::context::Context;
pub use crate::executable::main;
pub use crate::executable::Executable;
pub use crate::router::ApolloRouterError;
pub use crate::router::ConfigurationSource;
pub use crate::router::EntitlementSource;
pub use crate::router::RouterHttpServer;
pub use crate::router::SchemaSource;
pub use crate::router::ShutdownSource;
pub use crate::router_factory::Endpoint;
pub use crate::test_harness::MockedSubgraphs;
pub use crate::test_harness::TestHarness;

/// Not part of the public API
#[doc(hidden)]
pub mod _private {
    // Reexports for macros
    pub use linkme;
    pub use once_cell;
    pub use router_bridge;
    pub use serde_json;

    pub use crate::plugin::PluginFactory;
    pub use crate::plugin::PLUGINS;
    // For tests
    pub use crate::plugins::telemetry::Telemetry as TelemetryPlugin;
    pub use crate::router_factory::create_test_service_factory_from_yaml;

    /// Retuns the `Debug` fomatting of two `Result<Schema, SchemaError>`,
    /// from `parse_with_ast` and `parse_with_hir` respectively.
    ///
    /// The two strings are expected to be equal.
    pub fn compare_schema_parsing(schema: &str) -> (String, String) {
        use crate::spec::Schema;
        let conf = Default::default();
        (
            format!("{:?}", Schema::parse_with_ast(schema, &conf)),
            format!("{:?}", Schema::parse_with_hir(schema, &conf)),
        )
    }

    /// Retuns the `Debug` fomatting of two `Result<Query, SpecError>`,
    /// from `parse_with_ast` and `parse_with_hir` respectively.
    ///
    /// The two strings are expected to be equal.
    pub fn compare_query_parsing(query: &str) -> (String, String) {
        use once_cell::sync::OnceCell;

        use crate::spec::Query;
        use crate::spec::Schema;

        static DUMMY_SCHEMA: OnceCell<Schema> = OnceCell::new();
        let conf = Default::default();
        let schema = DUMMY_SCHEMA.get_or_init(|| {
            Schema::parse(include_str!("testdata/minimal_supergraph.graphql"), &conf).unwrap()
        });
        (
            format!("{:?}", Query::parse_with_ast(query, schema, &conf)),
            format!("{:?}", Query::parse_with_hir(query, schema, &conf)),
        )
    }
}