extract and export NonFtv1ErrorPath interface

apollographql · Jan 24, 2023 · 52f8b64 · glasser · Jan 25, 2023 · trevor-scheer
1 parent 0367f6a
commit 52f8b64
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 8 deletions.
diff --git a/packages/gateway-interface/src/index.ts b/packages/gateway-interface/src/index.ts
@@ -109,6 +109,11 @@ export interface GatewayHTTPResponse {
 
 export type GatewaySchemaHash = string & { __fauxpaque: 'SchemaHash' };
 
+export interface NonFtv1ErrorPath {
+  subgraph: string;
+  path: GraphQLError['path'];
+}
+
 export interface GatewayGraphQLRequestMetrics {
   captureTraces?: boolean;
   persistedQueryHit?: boolean;
@@ -118,10 +123,7 @@ export interface GatewayGraphQLRequestMetrics {
   registeredOperation?: boolean;
   startHrTime?: [number, number];
   queryPlanTrace?: Trace.QueryPlanNode;
-  nonFtv1ErrorPaths?: {
-    subgraph: string;
-    path: GraphQLError['path'];
-  }[];
+  nonFtv1ErrorPaths?: NonFtv1ErrorPath[];
 }
 
 export interface GatewayCachePolicy extends GatewayCacheHint {

diff --git a/packages/server/src/externalTypes/requestPipeline.ts b/packages/server/src/externalTypes/requestPipeline.ts
@@ -19,6 +19,7 @@ import type {
   OperationDefinitionNode,
 } from 'graphql';
 import type { CachePolicy } from '@apollo/cache-control-types';
+import type { NonFtv1ErrorPath } from '@apollo/server-gateway-interface';
 
 export interface GraphQLRequestMetrics {
   // It would be more accurate to call this fieldLevelInstrumentation (it is
@@ -33,7 +34,7 @@ export interface GraphQLRequestMetrics {
   registeredOperation?: boolean;
   startHrTime?: [number, number];
   queryPlanTrace?: Trace.QueryPlanNode;
-  nonFtv1ErrorPaths?: { subgraph: string; path: GraphQLError['path'] }[];
+  nonFtv1ErrorPaths?: NonFtv1ErrorPath[];
 }
 
 export interface GraphQLRequestContext<TContext extends BaseContext> {

diff --git a/packages/server/src/plugin/usageReporting/stats.ts b/packages/server/src/plugin/usageReporting/stats.ts
@@ -1,3 +1,4 @@
+import type { NonFtv1ErrorPath } from '@apollo/server-gateway-interface';
 import {
   type google,
   type IContextualizedStats,
@@ -73,7 +74,7 @@ export class OurReport implements Required<IReport> {
     asTrace: boolean;
     referencedFieldsByType: ReferencedFieldsByType;
     maxTraceBytes?: number;
-    nonFtv1ErrorPaths: { subgraph: string; path: GraphQLError['path'] }[];
+    nonFtv1ErrorPaths: NonFtv1ErrorPath[];
   }) {
     const tracesAndStats = this.getTracesAndStats({
       statsReportKey,
@@ -171,7 +172,7 @@ class StatsByContext {
   addTrace(
     trace: Trace,
     sizeEstimator: SizeEstimator,
-    nonFtv1ErrorPaths: { subgraph: string; path: GraphQLError['path'] }[],
+    nonFtv1ErrorPaths: NonFtv1ErrorPath[],
   ) {
     this.getContextualizedStats(trace, sizeEstimator).addTrace(
       trace,
@@ -226,7 +227,7 @@ export class OurContextualizedStats implements Required<IContextualizedStats> {
   addTrace(
     trace: Trace,
     sizeEstimator: SizeEstimator,
-    nonFtv1ErrorPaths: { subgraph: string; path: GraphQLError['path'] }[] = [],
+    nonFtv1ErrorPaths: NonFtv1ErrorPath[] = [],
   ) {
     const { fieldExecutionWeight } = trace;
     if (!fieldExecutionWeight) {