@depup/apollo__server 5.5.0-depup.0

package/src/plugin/landingPage/default/types.ts

@@ -0,0 +1,198 @@
+type InitialDocumentVariablesHeaders = {
+  /**
+   * Users can configure their landing page to link to Studio Explorer with a
+   * document loaded in the UI.
+   */
+  document?: string;
+  /**
+   * Users can configure their landing page to link to Studio Explorer with
+   * variables loaded in the UI.
+   */
+  variables?: Record<string, any>;
+
+  /**
+   * Users can configure their landing page to link to Studio Explorer with
+   * headers loaded in the UI.
+   */
+  headers?: Record<string, string>;
+  collectionId?: never;
+  operationId?: never;
+};
+
+type InitialStateForEmbeds =
+  | {
+      /**
+       * The ID of a collection, paired with an operation ID to populate in the Sandbox on load.
+       *
+       * You can find these values from a registered graph in Studio by
+       * clicking the ... menu next to an operation in the Explorer of that graph and
+       * selecting View operation details.
+       */
+      collectionId: string;
+      operationId: string;
+      document?: never;
+      variables?: never;
+      headers?: never;
+    }
+  | InitialDocumentVariablesHeaders;
+
+export type ApolloServerPluginLandingPageDefaultBaseOptions = {
+  /**
+   * Specify the major version of the landing page to use, i.e v2 or
+   * provide a specific commit from the
+   * [embeddable explorer](https://github.com/apollographql/embeddable-explorer)
+   * repo.
+   * We also support a `latest` tag but don't recommend using it
+   * as it's subject to major version updates.
+   */
+  version?: string;
+  /**
+   * Set to false to suppress the footer which explains how to configure the
+   * landing page.
+   */
+  footer?: boolean;
+
+  includeCookies?: boolean;
+
+  // For Apollo use only.
+  __internal_apolloStudioEnv__?: 'staging' | 'prod';
+};
+
+export type ApolloServerPluginNonEmbeddedLandingPageLocalDefaultOptions =
+  ApolloServerPluginLandingPageDefaultBaseOptions &
+    InitialDocumentVariablesHeaders & {
+      /**
+       * Users can configure their landing page to render an embedded Explorer if
+       * given a graphRef, or an embedded Sandbox if there is no graphRef provided.
+       */
+      embed: false;
+    };
+
+export type ApolloServerPluginNonEmbeddedLandingPageProductionDefaultOptions =
+  ApolloServerPluginLandingPageDefaultBaseOptions &
+    InitialDocumentVariablesHeaders & {
+      /**
+       * If specified, provide a link (with opt-in auto-redirect) to the Studio page
+       * for the given graphRef. (You need to explicitly pass this here rather than
+       * relying on the server's ApolloConfig, because if your server is publicly
+       * accessible you may not want to display the graph ref publicly.)
+       */
+      graphRef?: string;
+      /**
+       * Users can configure their landing page to render an embedded Explorer if
+       * given a graphRef, or an embedded Sandbox if there is no graphRef provided.
+       */
+      embed?: false;
+    };
+
+export type ApolloServerPluginEmbeddedLandingPageLocalDefaultOptions =
+  ApolloServerPluginLandingPageDefaultBaseOptions & {
+    /**
+     * Users can configure their landing page to render an embedded Explorer if
+     * given a graphRef, or an embedded Sandbox if there is no graphRef provided.
+     */
+    embed?: true | EmbeddableSandboxOptions;
+  } & (InitialDocumentVariablesHeaders | InitialStateForEmbeds);
+
+export type ApolloServerPluginEmbeddedLandingPageProductionDefaultOptions =
+  ApolloServerPluginLandingPageDefaultBaseOptions & {
+    /**
+     * Use this registered's graphs schema to populate the embedded Explorer.
+     * Required if passing `embed: true`
+     */
+    graphRef: string;
+    /**
+     * Users can configure their landing page to render an embedded Explorer.
+     */
+    embed: true | EmbeddableExplorerOptions;
+  } & InitialStateForEmbeds;
+
+type EmbeddableSandboxOptions = {
+  /**
+   * Set to false to disable running telemetry in Apollo Studio from the landing pages.
+   */
+  runTelemetry?: boolean;
+  initialState?: {
+    /**
+     * If true, the embedded Sandbox periodically polls your initialEndpoint for schema updates.
+     *
+     * The default value is true.
+     */
+    pollForSchemaUpdates?: boolean;
+    /**
+     * Headers that are applied by default to every operation executed by the landing page's Sandbox.
+     * Users can disable the application of these headers, but they can't modify their values.
+     *
+     * The landing page's Sandbox always includes these headers in its introspection queries
+     * to your endpoint.
+     */
+    // TODO(as5): We currently have `headers` at the top level and `embed.initialState.sharedHeaders`
+    // at this level. Shared headers populate introspection headers in Sandbox, while `headers` just
+    // adds headers to your default tab. We should consider changing the behavior such that `headers`
+    // at the base level populates shared headers as well.
+    sharedHeaders?: Record<string, string>;
+  };
+  /**
+   * By default, the Apollo Server embedded Sandbox has a url input box that is not editable by users.
+   *
+   * Set `endpointIsEditable` to `true` to enable users of your
+   * Apollo Server landing page to change the endpoint url.
+   */
+  endpointIsEditable?: boolean;
+};
+
+type EmbeddableExplorerOptions = {
+  /**
+   * Set to false to disable running telemetry in Apollo Studio from the landing pages.
+   */
+  runTelemetry?: boolean;
+  /**
+   * Display options can be configured for the embedded Explorer.
+   */
+  displayOptions?: {
+    /**
+     * If true, the embedded Explorer includes the panels for setting
+     * request headers and environment variables.
+     * If false, those panels are not present.
+     *
+     * The default value is true.
+     */
+    showHeadersAndEnvVars: boolean;
+    /**
+     * If open, the Explorer's Documentation panel (the left column) is
+     * initially expanded. If closed, the panel is initially collapsed.
+     *
+     * The default value is open.
+     */
+    docsPanelState: 'open' | 'closed';
+    /**
+     * If dark, the Explorer's dark theme is used. If light, the light theme is used.
+     *
+     * The default value is dark.
+     */
+    theme: 'light' | 'dark';
+  };
+  /**
+   * If true, the embedded Explorer uses localStorage to persist its state
+   * (including operations, tabs, variables, and headers) between user sessions.
+   * This state is automatically populated in the Explorer on page load.
+   *
+   * If false, the embedded Explorer loads with an example query
+   * based on your schema (unless you provide document).
+   *
+   * The default value is false.
+   */
+  persistExplorerState?: boolean;
+};
+
+export type ApolloServerPluginLandingPageLocalDefaultOptions =
+  | ApolloServerPluginEmbeddedLandingPageLocalDefaultOptions
+  | ApolloServerPluginNonEmbeddedLandingPageLocalDefaultOptions;
+
+export type ApolloServerPluginLandingPageProductionDefaultOptions =
+  | ApolloServerPluginEmbeddedLandingPageProductionDefaultOptions
+  | ApolloServerPluginNonEmbeddedLandingPageProductionDefaultOptions;
+
+export type LandingPageConfig =
+  | ApolloServerPluginLandingPageLocalDefaultOptions
+  | ApolloServerPluginLandingPageProductionDefaultOptions;

package/src/plugin/schemaIsSubgraph.ts

@@ -0,0 +1,41 @@
+import {
+  type GraphQLSchema,
+  isObjectType,
+  isScalarType,
+  isNonNullType,
+} from 'graphql';
+
+// Returns true if it appears that the schema was appears to be of a subgraph
+// (eg, returned from @apollo/subgraph's buildSubgraphSchema). This strategy
+// avoids depending explicitly on @apollo/subgraph or relying on something that
+// might not survive transformations like monkey-patching a boolean field onto
+// the schema.
+//
+// This is used for two things:
+// 1) Determining whether traces should be added to responses if requested with
+//    an HTTP header. If you want to include these traces even for non-subgraphs
+//    (when requested via header, eg for Apollo Explorer's trace view) you can
+//    use ApolloServerPluginInlineTrace explicitly; if you want to never include
+//    these traces even for subgraphs you can use
+//    ApolloServerPluginInlineTraceDisabled.
+// 2) Determining whether schema-reporting should be allowed; subgraphs cannot
+//    report schemas, and we accordingly throw if it's attempted.
+export function schemaIsSubgraph(schema: GraphQLSchema): boolean {
+  const serviceType = schema.getType('_Service');
+  if (!isObjectType(serviceType)) {
+    return false;
+  }
+  const sdlField = serviceType.getFields().sdl;
+  if (!sdlField) {
+    return false;
+  }
+
+  let sdlFieldType = sdlField.type;
+  if (isNonNullType(sdlFieldType)) {
+    sdlFieldType = sdlFieldType.ofType;
+  }
+  if (!isScalarType(sdlFieldType)) {
+    return false;
+  }
+  return sdlFieldType.name == 'String';
+}