Remove interface usage from types package for Node

All Node.js specific interfaces from the types package are now defined inside nodejs core package. There's still a dependency from types package for common types as `Func`, `HashMap`, and `HasMapValue`. With this change we keep taking advantage of interfaces but now they're defined in a place where they're used.
appsignal · Oct 6, 2021 · 9c8319e · 9c8319e
1 parent d24ccf4
commit 9c8319e
Show file tree

Hide file tree

Showing 41 changed files with 480 additions and 118 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/apollo-server/package.json b/packages/apollo-server/package.json
@@ -5,7 +5,7 @@
   "types": "dist/index",
   "license": "MIT",
   "dependencies": {
-    "@appsignal/types": "^2.1.5",
+    "@appsignal/nodejs": "^2.1.0",
     "apollo-server-plugin-base": "^0.10.3",
     "tslib": "^2.0.3"
   },

diff --git a/packages/apollo-server/src/index.ts b/packages/apollo-server/src/index.ts
@@ -1,7 +1,7 @@
-import { NodeClient } from "@appsignal/types"
+import { Client } from "@appsignal/nodejs"
 import { ApolloServerPlugin } from "apollo-server-plugin-base"
 
-export const createApolloPlugin = (appsignal: NodeClient, _options = {}) => {
+export const createApolloPlugin = (appsignal: Client, _options = {}) => {
   const tracer = appsignal.tracer()
 
   return (): ApolloServerPlugin => ({

diff --git a/packages/express/package.json b/packages/express/package.json
@@ -5,7 +5,7 @@
   "types": "dist/index",
   "license": "MIT",
   "dependencies": {
-    "@appsignal/types": "^2.1.5",
+    "@appsignal/nodejs": "^2.1.0",
     "tslib": "^2.0.3"
   },
   "peerDependencies": {

diff --git a/packages/express/src/middleware/index.ts b/packages/express/src/middleware/index.ts
@@ -1,4 +1,4 @@
-import { NodeClient } from "@appsignal/types"
+import { Client } from "@appsignal/nodejs"
 
 import {
   Request,
@@ -12,7 +12,7 @@ import {
  * Returns an Express middleware that can augment the current span
  * with data.
  */
-export function expressMiddleware(appsignal: NodeClient): RequestHandler {
+export function expressMiddleware(appsignal: Client): RequestHandler {
   return function (req: Request, res: Response, next: NextFunction) {
     const tracer = appsignal.tracer()
     const rootSpan = tracer.currentSpan()
@@ -57,9 +57,7 @@ export function expressMiddleware(appsignal: NodeClient): RequestHandler {
   }
 }
 
-export function expressErrorHandler(
-  appsignal: NodeClient
-): ErrorRequestHandler {
+export function expressErrorHandler(appsignal: Client): ErrorRequestHandler {
   return function (
     err: Error & { status?: number },
     req: Request,

diff --git a/packages/koa/package.json b/packages/koa/package.json
@@ -6,6 +6,7 @@
   "license": "MIT",
   "dependencies": {
     "@appsignal/types": "^2.1.5",
+    "@appsignal/nodejs": "^2.1.0",
     "shimmer": "^1.2.1",
     "tslib": "^2.0.3"
   },

diff --git a/packages/koa/src/index.ts b/packages/koa/src/index.ts
@@ -1,7 +1,7 @@
 import shimmer from "shimmer"
 
 import koa from "koa"
-import type { Tracer, Plugin } from "@appsignal/types"
+import type { Tracer, Plugin } from "@appsignal/nodejs"
 import { getKoaUsePatch } from "./patches"
 
 export const PLUGIN_NAME = "koa"

diff --git a/packages/koa/src/patches/index.ts b/packages/koa/src/patches/index.ts
@@ -4,7 +4,7 @@
  * Copyright 2019, OpenTelemetry Authors
  */
 
-import type { Tracer } from "@appsignal/types"
+import type { Tracer } from "@appsignal/nodejs"
 import koa, { Middleware, ParameterizedContext, DefaultState } from "koa"
 import type { RouterParamContext } from "@koa/router"
 import type * as Router from "@koa/router"

diff --git a/packages/nextjs/package.json b/packages/nextjs/package.json
@@ -5,7 +5,7 @@
   "types": "dist/index",
   "license": "MIT",
   "dependencies": {
-    "@appsignal/types": "^2.1.5",
+    "@appsignal/nodejs": "^2.1.0",
     "tslib": "^2.0.3"
   },
   "peerDependencies": {

diff --git a/packages/nextjs/src/experimental.ts b/packages/nextjs/src/experimental.ts
@@ -1,6 +1,6 @@
 import url from "url"
 import { IncomingMessage, ServerResponse } from "http"
-import { NodeClient, Metrics } from "@appsignal/types"
+import { Client, Metrics } from "@appsignal/nodejs"
 
 function handleWebVital(
   metric: { name: string; value: number },
@@ -45,7 +45,7 @@ function handleNextMetric(
  * Usage of this function is EXPERIMENTAL and may change or be deprecated
  * in future releases.
  */
-export function getWebVitalsHandler(appsignal: NodeClient) {
+export function getWebVitalsHandler(appsignal: Client) {
   return function (
     req: IncomingMessage,
     res: ServerResponse,

diff --git a/packages/nextjs/src/handler.ts b/packages/nextjs/src/handler.ts
@@ -1,5 +1,5 @@
 import url from "url"
-import { NodeClient } from "@appsignal/types"
+import { Client } from "@appsignal/nodejs"
 import { ServerResponse, IncomingMessage } from "http"
 
 interface NextServer {
@@ -33,7 +33,7 @@ interface NextServer {
  * span with data.
  */
 export function getRequestHandler<T extends NextServer>(
-  appsignal: NodeClient,
+  appsignal: Client,
   app: T
 ) {
   const handler = app.getRequestHandler()

diff --git a/packages/nodejs/.changesets/[email protected] b/packages/nodejs/.changesets/[email protected]
@@ -0,0 +1,12 @@
+---
+bump: "minor"
+---
+
+Remove interface usage from @appsignal/types
+
+All Node.js-specific interfaces from the types package are now defined
+inside the nodejs core package. There's still a dependency from types
+package for common types as Func, HashMap, and HasMapValue.
+
+With this change, we keep taking advantage of interfaces, but now they're
+defined in a place where they're used.
diff --git a/packages/nodejs/src/__tests__/bootstrap.test.ts b/packages/nodejs/src/__tests__/bootstrap.test.ts
@@ -1,4 +1,4 @@
-import { Metrics } from "@appsignal/types"
+import { Metrics } from "../interfaces"
 import { Instrumentation } from "../instrument"
 import { initCorePlugins, initCoreProbes } from "../bootstrap"
 

diff --git a/packages/nodejs/src/__tests__/client.test.ts b/packages/nodejs/src/__tests__/client.test.ts
@@ -1,21 +1,21 @@
-import { Client } from "../client"
+import { BaseClient } from "../client"
 import { BaseTracer as Tracer } from "../tracer"
 import { BaseMetrics as Metrics } from "../metrics"
 import { NoopTracer, NoopMetrics } from "../noops"
 
 jest.mock("../tracer")
 
-describe("Client", () => {
+describe("BaseClient", () => {
   const name = "TEST APP"
   const apiKey = "TEST_API_KEY"
 
-  let client: Client
+  let client: BaseClient
 
   // enableMinutelyProbes is set to false so we don't leak timers
   const DEFAULT_OPTS = { name, apiKey, enableMinutelyProbes: false }
 
   beforeEach(() => {
-    client = new Client({ ...DEFAULT_OPTS })
+    client = new BaseClient({ ...DEFAULT_OPTS })
   })
 
   it("starts the client", () => {
@@ -29,7 +29,7 @@ describe("Client", () => {
   })
 
   it("starts the client when the active option is true", () => {
-    client = new Client({ ...DEFAULT_OPTS, active: true })
+    client = new BaseClient({ ...DEFAULT_OPTS, active: true })
     expect(client.isActive).toBeTruthy()
   })
 
@@ -39,7 +39,7 @@ describe("Client", () => {
   })
 
   it("returns a `Tracer` object if the agent is started", () => {
-    client = new Client({ ...DEFAULT_OPTS, active: true })
+    client = new BaseClient({ ...DEFAULT_OPTS, active: true })
     const tracer = client.tracer()
     expect(tracer).toBeInstanceOf(Tracer)
   })
@@ -50,7 +50,7 @@ describe("Client", () => {
   })
 
   it("returns a `Metrics` object if the agent is started", () => {
-    client = new Client({ ...DEFAULT_OPTS, active: true })
+    client = new BaseClient({ ...DEFAULT_OPTS, active: true })
     const meter = client.metrics()
     expect(meter).toBeInstanceOf(Metrics)
   })

diff --git a/packages/nodejs/src/bootstrap.ts b/packages/nodejs/src/bootstrap.ts
@@ -1,5 +1,4 @@
-import { Metrics } from "@appsignal/types"
-
+import { Metrics } from "./interfaces"
 import { Instrumentation } from "./instrument"
 import { httpPlugin, httpsPlugin } from "./instrumentation/http"
 import * as pgPlugin from "./instrumentation/pg"

diff --git a/packages/nodejs/src/client.ts b/packages/nodejs/src/client.ts
@@ -1,4 +1,4 @@
-import { NodeClient, Metrics, Plugin, Tracer } from "@appsignal/types"
+import { Client, Metrics, Plugin, Tracer, AppsignalOptions } from "./interfaces"
 
 import { Agent } from "./agent"
 import { Configuration } from "./config"
@@ -8,9 +8,7 @@ import { NoopTracer, NoopMetrics } from "./noops"
 import { Instrumentation } from "./instrument"
 import { initCorePlugins, initCoreProbes } from "./bootstrap"
 import { demo } from "./demo"
-
 import { VERSION } from "./version"
-import { AppsignalOptions } from "./interfaces/options"
 
 /**
  * AppSignal for Node.js's main class.
@@ -20,7 +18,7 @@ import { AppsignalOptions } from "./interfaces/options"
  *
  * @class
  */
-export class Client implements NodeClient {
+export class BaseClient implements Client {
   readonly VERSION = VERSION
 
   config: Configuration

diff --git a/packages/nodejs/src/demo.ts b/packages/nodejs/src/demo.ts
@@ -1,4 +1,4 @@
-import { Tracer } from "@appsignal/types"
+import { Tracer } from "./interfaces"
 
 /**
  * Sends a demonstration/test sample for a exception and a performance issue.

diff --git a/packages/nodejs/src/index.ts b/packages/nodejs/src/index.ts
@@ -5,5 +5,6 @@
  * @module Appsignal
  */
 
-export { Client as Appsignal } from "./client"
+export { BaseClient as Appsignal } from "./client"
+export * from "./interfaces"
 export { EXPERIMENTAL } from "./experimental"
diff --git a/packages/nodejs/src/instrument.ts b/packages/nodejs/src/instrument.ts
@@ -1,4 +1,5 @@
-import { Plugin, Tracer, Metrics } from "@appsignal/types"
+import { Plugin, Tracer, Metrics } from "./interfaces"
+
 import Hook from "require-in-the-middle"
 import semver from "semver"
 

diff --git a/packages/nodejs/src/instrumentation/http/http.ts b/packages/nodejs/src/instrumentation/http/http.ts
@@ -1,4 +1,4 @@
-import { Tracer, Plugin } from "@appsignal/types"
+import { Tracer, Plugin } from "../../interfaces"
 import shimmer from "shimmer"
 import http from "http"
 

diff --git a/packages/nodejs/src/instrumentation/http/https.ts b/packages/nodejs/src/instrumentation/http/https.ts
@@ -1,4 +1,4 @@
-import { Tracer, Plugin } from "@appsignal/types"
+import { Tracer, Plugin } from "../../interfaces"
 import shimmer from "shimmer"
 import https from "https"
 

diff --git a/packages/nodejs/src/instrumentation/http/lifecycle/incoming.ts b/packages/nodejs/src/instrumentation/http/lifecycle/incoming.ts
@@ -4,7 +4,7 @@
  * Copyright 2019, OpenTelemetry Authors
  */
 
-import { Tracer } from "@appsignal/types"
+import { Tracer } from "../../../interfaces"
 import { parse } from "url"
 import { IncomingMessage, ServerResponse } from "http"
 

diff --git a/packages/nodejs/src/instrumentation/http/lifecycle/outgoing.ts b/packages/nodejs/src/instrumentation/http/lifecycle/outgoing.ts
@@ -4,7 +4,7 @@
  * Copyright 2019, OpenTelemetry Authors
  */
 
-import { Tracer, NodeSpan } from "@appsignal/types"
+import { Tracer, Span } from "../../../interfaces"
 import url from "url"
 import { IncomingMessage, ClientRequest, RequestOptions } from "http"
 
@@ -72,7 +72,7 @@ function outgoingRequestFunction(
     urlOrOptions: string | url.URL | RequestOptions,
     ...args: unknown[]
   ): ClientRequest {
-    let span: NodeSpan
+    let span: Span
     let origin: string
     let method: string
 

diff --git a/packages/nodejs/src/instrumentation/pg/index.ts b/packages/nodejs/src/instrumentation/pg/index.ts
@@ -1,4 +1,4 @@
-import { Tracer, Plugin } from "@appsignal/types"
+import { Tracer, Plugin } from "../../interfaces"
 import shimmer from "shimmer"
 import pg from "pg"
 import { EventEmitter } from "events"