Inline usage reporting protobuf into main package

.codesandbox/ci.json

@@ -2,7 +2,6 @@
   "buildCommand": "compile",
   "installCommand": "install-with-npm-8.5",
   "packages": [
-    "packages/usage-reporting-protobuf",
     "packages/server"
   ],
   "sandboxes": ["apollo-server-typescript-3opde","apollo-server"],

package.json

@@ -21,7 +21,11 @@
     "codegen": "graphql-codegen",
     "prettier-check": "prettier --check .",
     "prettier-fix": "prettier --write .",
-    "spell-check": "cspell lint '**' --no-progress || (echo 'Add any real words to cspell-dict.txt.'; exit 1)"
+    "spell-check": "cspell lint '**' --no-progress || (echo 'Add any real words to cspell-dict.txt.'; exit 1)",
+    "protobuf-generate": "rm -rf packages/server/usageReportingProtobuf/generated && mkdir packages/server/usageReportingProtobuf/generated && npm run protobuf-pbjs && npm run protobuf-pbts",
+    "protobuf-pbjs": "apollo-pbjs --target static-module --out packages/server/usageReportingProtobuf/generated/protobuf.js --wrap commonjs --force-number --no-from-object packages/server/usageReportingProtobuf/reports.proto",
+    "protobuf-pbts": "apollo-pbts -o packages/server/usageReportingProtobuf/generated/protobuf.d.ts packages/server/usageReportingProtobuf/generated/protobuf.js",
+    "protobuf-update": "curl -sSfo packages/server/usageReportingProtobuf/reports.proto https://usage-reporting.api.apollographql.com/proto/reports.proto"
   },
   "workspaces": [
     "packages/*"

packages/server/.npmignore

@@ -5,3 +5,4 @@ src/**/__tests__/**
 dist/**/__tests__/**
 !package.json
 !README.md
+!usageReportingProtobuf/**/*

packages/server/package.json

@@ -25,7 +25,7 @@
     "node": ">=12.0"
   },
   "dependencies": {
-    "@apollo/usage-reporting-protobuf": "^3.3.0",
+    "@apollo/protobufjs": "1.2.2",
     "@apollo/utils.createhash": "^1.1.0",
     "@apollo/utils.isnodelike": "^1.1.0",
     "@apollo/utils.logger": "^1.0.0",
@@ -40,6 +40,8 @@
     "@types/lru-cache": "^7.6.1",
     "@types/node-fetch": "^2.6.1",
     "async-retry": "^1.2.1",
+    "body-parser": "^1.20.0",
+    "cors": "^2.8.5",
     "express": "^4.17.1",
     "graphql-tag": "^2.11.0",
     "keyv": "^4.2.2",

packages/server/src/__tests__/integration/apolloServerTests.ts

@@ -5,7 +5,7 @@ import express from 'express';
 import bodyParser from 'body-parser';
 import loglevel from 'loglevel';
 
-import { Report, Trace } from '@apollo/usage-reporting-protobuf';
+import { Report, Trace } from '../../../usageReportingProtobuf';
 
 import {
   GraphQLSchema,

packages/server/src/__tests__/plugin/usageReporting/plugin.test.ts

@@ -11,7 +11,7 @@ import {
   ITrace,
   ITracesAndStats,
   ContextualizedStats,
-} from '@apollo/usage-reporting-protobuf';
+} from '../../../../usageReportingProtobuf';
 import { pluginsEnabledForSchemaResolvers } from '../../../utils/schemaInstrumentation';
 import nock from 'nock';
 import sumBy from 'lodash.sumby';

packages/server/src/__tests__/plugin/usageReporting/stats.test.ts

@@ -1,4 +1,4 @@
-import { Trace } from '@apollo/usage-reporting-protobuf';
+import { Trace } from '../../../../usageReportingProtobuf';
 import { dateToProtoTimestamp } from '../../../plugin/traceTreeBuilder';
 import {
   OurContextualizedStats,

packages/server/src/__tests__/plugin/usageReporting/traceDetails.test.ts

@@ -1,5 +1,5 @@
 import { makeTraceDetails } from '../../../plugin/usageReporting/traceDetails';
-import { Trace } from '@apollo/usage-reporting-protobuf';
+import { Trace } from '../../../../usageReportingProtobuf';
 import { GraphQLError } from 'graphql';
 
 const variables: Record<string, any> = {

packages/server/src/externalTypes/graphql.ts

@@ -1,5 +1,4 @@
-// TODO(AS4): This seems like it could live in this package too.
-import type { Trace } from '@apollo/usage-reporting-protobuf';
+import type { Trace } from '../../usageReportingProtobuf';
 import type { Logger } from '@apollo/utils.logger';
 import type {
   DocumentNode,

packages/server/src/plugin/inlineTrace/index.ts

@@ -1,4 +1,4 @@
-import { Trace } from '@apollo/usage-reporting-protobuf';
+import { Trace } from '../../../usageReportingProtobuf';
 import { TraceTreeBuilder } from '../traceTreeBuilder';
 import type { ApolloServerPluginUsageReportingOptions } from '../usageReporting/options';
 import type { InternalApolloServerPlugin } from '../../internalPlugin';

packages/server/src/plugin/traceTreeBuilder.ts

@@ -1,7 +1,7 @@
 // This class is a helper for ApolloServerPluginUsageReporting and
 // ApolloServerPluginInlineTrace.
 import { GraphQLError, GraphQLResolveInfo, ResponsePath } from 'graphql';
-import { Trace, google } from '@apollo/usage-reporting-protobuf';
+import { Trace, google } from '../../usageReportingProtobuf';
 import type { Logger } from '@apollo/utils.logger';
 
 function internalError(message: string) {

packages/server/src/plugin/usageReporting/defaultSendOperationsAsTrace.ts

@@ -1,5 +1,5 @@
 import LRUCache from 'lru-cache';
-import type { Trace } from '@apollo/usage-reporting-protobuf';
+import type { Trace } from '../../../usageReportingProtobuf';
 import { iterateOverTrace } from './iterateOverTrace';
 import { DurationHistogram } from './durationHistogram';
 

packages/server/src/plugin/usageReporting/iterateOverTrace.ts

@@ -1,4 +1,4 @@
-import type { Trace } from '@apollo/usage-reporting-protobuf';
+import type { Trace } from '../../../usageReportingProtobuf';
 
 /**
  * Iterates over the entire trace, calling `f` on each Trace.Node found. It

packages/server/src/plugin/usageReporting/options.ts

@@ -6,7 +6,7 @@ import type {
   BaseContext,
 } from '../../externalTypes';
 import type { Logger } from '@apollo/utils.logger';
-import type { Trace } from '@apollo/usage-reporting-protobuf';
+import type { Trace } from '../../../usageReportingProtobuf';
 import type { Fetcher } from '@apollo/utils.fetcher';
 
 export interface ApolloServerPluginUsageReportingOptions<

packages/server/src/plugin/usageReporting/plugin.ts

@@ -1,4 +1,4 @@
-import { Report, ReportHeader, Trace } from '@apollo/usage-reporting-protobuf';
+import { Report, ReportHeader, Trace } from '../../../usageReportingProtobuf';
 import type { Fetcher, FetcherResponse } from '@apollo/utils.fetcher';
 import {
   usageReportingSignature,

packages/server/src/plugin/usageReporting/stats.ts

@@ -10,7 +10,7 @@ import {
   ITypeStat,
   ReportHeader,
   Trace,
-} from '@apollo/usage-reporting-protobuf';
+} from '../../../usageReportingProtobuf';
 import type { ReferencedFieldsByType } from '@apollo/utils.usagereporting';
 import { DurationHistogram } from './durationHistogram';
 import { iterateOverTrace, ResponseNamePath } from './iterateOverTrace';

packages/server/src/plugin/usageReporting/traceDetails.ts

@@ -1,4 +1,4 @@
-import { Trace } from '@apollo/usage-reporting-protobuf';
+import { Trace } from '../../../usageReportingProtobuf';
 import type { VariableValueOptions } from './options';
 
 // Creates trace details from request variables, given a specification for modifying

packages/server/usageReportingProtobuf/README.md

@@ -0,0 +1,41 @@
+# Usage reporting protobuf
+
+> **Note:** The Apollo usage reporting API is subject to change.  We strongly
+> encourage developers to contact Apollo support at `[email protected]`
+> to discuss their use case prior to building their own reporting agent using
+> this module.
+
+This subdirectory provides JavaScript/TypeScript [Protocol
+buffer](https://developers.google.com/protocol-buffers/) definitions for the
+Apollo usage reporting API.  These definitions are generated for consumption
+from the `reports.proto` file which is defined internally within Apollo.
+
+## Development
+
+> **Note:** Due to a dependency on Unix tools (e.g. `bash`, `grep`, etc.), the
+> development of this module requires a Unix system.  There is no reason why
+> this can't be avoided, the time just hasn't been taken to make those changes.
+> We'd happily accept a PR which makes the appropriate changes!
+
+This directory contains .js and .d.ts files. The index files are written
+manually and the files in `generated` are automatically generated with
+`@apollo/protobufjs` (a fork of
+[`protobufjs`](https://www.npmjs.com/package/protobufjs) that we maintain
+specifically for this package) based on the `reports.proto` file. None of these
+files are generated from .ts files by tsc, which is why this directory is not
+under `src`.
+
+To update `reports.proto` to the current version recognized by the Studio usage
+reporting ingress, run `npm run protobuf-update`. To then regenerate the JS and
+TS files, run `npm run protobuf-generate`. We check in the generated code and only
+regenerate it manually, partially to make builds faster (no need to run pbjs on
+every `npm install`) and partially so that we don't have to make sure that
+`pbjs` runs on every Node version that we support.
+
+The files in this subdirectory are large, so we want to avoid loading them at
+runtime unless necessary. Thus, files in this directory should only be imported
+in three contexts:
+- Inside `src/plugin`, in files that will only be loaded indirectly via the
+  runtime require calls in `src/plugin/index.ts`
+- In tests
+- At compile-time only via `import type` calls

packages/server/usageReportingProtobuf/index.d.ts

@@ -0,0 +1,2 @@
+import * as protobuf from './generated/protobuf';
+export = protobuf;

packages/usage-reporting-protobuf/src/index.js → packages/server/usageReportingProtobuf/index.js

@@ -1,4 +1,4 @@
-const protobuf = require('./protobuf');
+const protobuf = require('./generated/protobuf');
 const protobufJS = require('@apollo/protobufjs/minimal');
 
 // Remove Long support.  Our uint64s tend to be small (less