3.1.0: slim default request context

CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## Unreleased
 
+## 3.1.0
+
+**Housekeeping:**
+
+- Slim down the default request context to `headers`, `ip`, and `library`. The
+  client id is already carried by `headers` (the `x-castle-client-id` header /
+  `__cid` cookie) and resolved by Castle server-side, so the SDK no longer
+  derives it separately.
+- Remove the internal client-id extraction service and the now-unused cookie
+  plumbing (`HeadersGetCookieService`) in `ContextGetDefaultService` /
+  `ContextPrepareService`.
+
 ## 3.0.0
 
 **BREAKING CHANGES:**

package.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/package",
   "name": "@castleio/sdk",
   "description": "Castle SDK for Node",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",

src/context/services/context-get-default.service.ts

@@ -1,43 +1,19 @@
-import { isEmpty, pickByTruthy } from '../../utils/object';
 import { Configuration } from '../../configuration';
-import { ClientIdExtractService } from '../../client-id/client-id.module';
 import { HeadersExtractService } from '../../headers/headers.module';
 import { IPsExtractService } from '../../ips/ips.module';
 import { version } from '../../../package.json';
 import type { IncomingHttpHeaders } from 'http2';
 
-const requestContextData = (
-  request: { headers: IncomingHttpHeaders },
-  cookies: string | undefined,
-  configuration: Configuration
-): { [key: string]: any } => {
-  if (isEmpty(request)) {
-    return {};
-  }
-
-  const cookiesForClientId =
-    cookies || (request.headers as { [key: string]: any })?.cookies;
-  return {
-    client_id:
-      ClientIdExtractService.call(request.headers, cookiesForClientId) || false,
-    active: true,
-    headers: HeadersExtractService.call(request.headers, configuration),
-    ip: IPsExtractService.call(request.headers, configuration),
-  };
-};
-
 export const ContextGetDefaultService = {
   call: (
     request: { headers: IncomingHttpHeaders },
-    cookies: string | undefined,
     configuration: Configuration
-  ): { [key: string]: any } => {
-    return {
-      ...pickByTruthy(requestContextData(request, cookies, configuration)),
-      library: {
-        name: 'castle-node',
-        version,
-      },
-    };
-  },
+  ): { [key: string]: any } => ({
+    headers: HeadersExtractService.call(request.headers, configuration),
+    ip: IPsExtractService.call(request.headers, configuration),
+    library: {
+      name: 'castle-node',
+      version,
+    },
+  }),
 };

src/context/services/context-prepare.service.ts

@@ -11,7 +11,6 @@ export const ContextPrepareService = {
   ) => {
     const defaultContext = ContextGetDefaultService.call(
       request,
-      options?.cookies,
       configuration
     );
     return deepMerge(defaultContext, options?.context);

src/headers/services/index.ts

@@ -1,2 +1 @@
 export * from './headers-extract.service';
-export * from './headers-get-cookie.service';

test/context/services/context-get-default.service.test.ts

@@ -14,7 +14,6 @@ describe('ContextGetDefaultService', () => {
         name: 'castle-node',
         version,
       },
-      client_id: 'client_id',
       ip: '1.2.3.4',
     };
 
@@ -29,17 +28,12 @@ describe('ContextGetDefaultService', () => {
       headers: {
         'x-forwarded-for': '1.2.3.4',
         'x-castle-client-id': 'client_id',
-        cookies: 'client_id',
       },
       body: {},
     } as ExpressRequest;
 
     it('generates default context', () => {
-      const received = ContextGetDefaultService.call(
-        mockRequest,
-        undefined,
-        config
-      );
+      const received = ContextGetDefaultService.call(mockRequest, config);
       expect(received).toMatchObject(expected);
     });
   });

test/context/services/context-prepare.service.test.ts

@@ -22,7 +22,6 @@ describe('ContextPrepareService', () => {
     });
 
     const options = {
-      cookies: '__cid=abcd;',
       context: {
         client_id: 'client_id',
         active: true,

test/payload/services/payload-prepare-service.test.ts

@@ -11,7 +11,6 @@ describe('PayloadPrepareService', () => {
           version,
         },
         client_id: '123',
-        active: true,
       },
       user_id: '123',
     };