fix: move event models and publishEvents() method to server-request lib

Author: jonathannorris

lib/shared/server-request/src/index.ts

@@ -1,2 +1,5 @@
 export * from './request'
 export * from './userError'
+export * from './utils/paramUtils'
+export * from './models/devcycleEvent'
+export * from './models/requestEvent'

lib/shared/server-request/src/models/devcycleEvent.ts

@@ -0,0 +1,26 @@
+export interface DevCycleEvent {
+    /**
+     * type of the event
+     */
+    type: string
+
+    /**
+     * date event occurred according to client stored as time since epoch
+     */
+    date?: number
+
+    /**
+     * target / subject of event. Contextual to event type
+     */
+    target?: string
+
+    /**
+     * value for numerical events. Contextual to event type
+     */
+    value?: number
+
+    /**
+     * extra metadata for event. Contextual to event type
+     */
+    metaData?: Record<string, unknown>
+}

sdk/nodejs/src/models/requestEvent.ts renamed to lib/shared/server-request/src/models/requestEvent.ts

@@ -1,9 +1,16 @@
-import { EventTypes } from '../eventQueue'
-import {
-    DevCycleEvent,
-    checkParamDefined,
-    checkParamString,
-} from '@devcycle/js-cloud-server-sdk'
+import { checkParamDefined, checkParamString } from '../utils/paramUtils'
+import { DevCycleEvent } from './devcycleEvent'
+
+export const AggregateEventTypes: Record<string, string> = {
+    variableEvaluated: 'variableEvaluated',
+    aggVariableEvaluated: 'aggVariableEvaluated',
+    variableDefaulted: 'variableDefaulted',
+    aggVariableDefaulted: 'aggVariableDefaulted',
+}
+
+export const EventTypes: Record<string, string> = {
+    ...AggregateEventTypes,
+}
 
 export class DVCRequestEvent {
     type: string

lib/shared/server-request/src/request.ts

@@ -1,4 +1,27 @@
 import fetchWithRetry, { RequestInitWithRetry } from 'fetch-retry'
+import { DVCLogger, SDKEventBatchRequestBody } from '@devcycle/types'
+
+export const HOST = '.devcycle.com'
+export const EVENT_URL = 'https://events'
+export const EVENTS_PATH = '/v1/events/batch'
+
+export async function publishEvents(
+    logger: DVCLogger,
+    sdkKey: string,
+    eventsBatch: SDKEventBatchRequestBody,
+    eventsBaseURLOverride?: string,
+): Promise<Response> {
+    const url = eventsBaseURLOverride
+        ? `${eventsBaseURLOverride}${EVENTS_PATH}`
+        : `${EVENT_URL}${HOST}${EVENTS_PATH}`
+    return await post(
+        url,
+        {
+            body: JSON.stringify({ batch: eventsBatch }),
+        },
+        sdkKey,
+    )
+}
 
 export class ResponseError extends Error {
     constructor(message: string) {

sdk/js-cloud-server/src/utils/paramUtils.ts renamed to lib/shared/server-request/src/utils/paramUtils.ts

@@ -1,5 +1,4 @@
-import { DVCRequestEvent } from '../../src/models/requestEvent'
-// import { EventTypes } from '../../src/eventQueue'
+import { DVCRequestEvent, EventTypes } from '@devcycle/server-request'
 
 describe('DVCRequestEvent Unit Tests', () => {
     it('should construct custom DVCRequestEvent from DVCEvent', () => {
@@ -28,21 +27,21 @@ describe('DVCRequestEvent Unit Tests', () => {
         })
     })
 
-    // it('should construct an event for an internal DVC Event', () => {
-    //     const requestEvent = new DVCRequestEvent(
-    //         {
-    //             type: EventTypes.variableEvaluated,
-    //         },
-    //         'user_id',
-    //     )
-    //     expect(requestEvent).toEqual(
-    //         expect.objectContaining({
-    //             type: EventTypes.variableEvaluated,
-    //             user_id: 'user_id',
-    //             clientDate: expect.any(Number),
-    //         }),
-    //     )
-    // })
+    it('should construct an event for an internal DVC Event', () => {
+        const requestEvent = new DVCRequestEvent(
+            {
+                type: EventTypes.variableEvaluated,
+            },
+            'user_id',
+        )
+        expect(requestEvent).toEqual(
+            expect.objectContaining({
+                type: EventTypes.variableEvaluated,
+                user_id: 'user_id',
+                clientDate: expect.any(Number),
+            }),
+        )
+    })
 
     it('should check that type is defined as a string', () => {
         expect(() => new (DVCRequestEvent as any)({})).toThrow(

sdk/edge-worker-server/__tests__/models/requestEvent.spec.ts

@@ -9,16 +9,18 @@ import {
     DevCycleUser,
     DVCVariable,
     VariableParam,
-    checkParamDefined,
     dvcDefaultLogger,
     DVCVariableValue,
     DVCVariableSet,
     DVCFeatureSet,
-    DevCycleEvent,
     DevCycleCloudOptions,
 } from '@devcycle/js-cloud-server-sdk'
 import { DVCPopulatedUserFromDevCycleUser } from './models/populatedUserHelpers'
-import { UserError } from '@devcycle/server-request'
+import {
+    UserError,
+    DevCycleEvent,
+    checkParamDefined,
+} from '@devcycle/server-request'
 import { generateBucketedConfig } from '@devcycle/bucketing'
 
 const castIncomingUser = (user: DevCycleUser) => {

sdk/edge-worker-server/src/client.ts

@@ -3,9 +3,7 @@ import {
     DevCycleUser,
     DevCycleCloudClient,
     dvcDefaultLogger,
-    isValidServerSDKKey,
     DevCycleOptions,
-    DevCycleEvent,
     DVCVariableValue,
     JSON,
     DVCJSON,
@@ -17,6 +15,7 @@ import {
     DVCFeatureSet,
     DevCycleCloudOptions,
 } from '@devcycle/js-cloud-server-sdk'
+import { isValidServerSDKKey, DevCycleEvent } from '@devcycle/server-request'
 
 export {
     DevCycleEdgeClient,
@@ -36,10 +35,14 @@ export {
 }
 export { dvcDefaultLogger }
 
-type DevCycleOptionsCloudEnabled = DevCycleCloudOptions & {
+type DevCycleEdgeOptions = DevCycleCloudOptions & {
+    enableCloudBucketing?: boolean
+}
+
+type DevCycleOptionsCloudEnabled = DevCycleEdgeOptions & {
     enableCloudBucketing: true
 }
-type DevCycleOptionsLocalEnabled = DevCycleCloudOptions & {
+type DevCycleOptionsLocalEnabled = DevCycleEdgeOptions & {
     enableCloudBucketing?: false
 }
 
@@ -53,11 +56,11 @@ export function initializeDevCycle(
 ): DevCycleCloudClient
 export function initializeDevCycle(
     sdkKey: string,
-    options?: DevCycleCloudOptions,
+    options?: DevCycleEdgeOptions,
 ): DevCycleEdgeClient | DevCycleCloudClient
 export function initializeDevCycle(
     sdkKey: string,
-    options: DevCycleCloudOptions = {},
+    options: DevCycleEdgeOptions = {},
 ): DevCycleEdgeClient | DevCycleCloudClient {
     if (!sdkKey) {
         throw new Error('Missing SDK key! Call initialize with a valid SDK key')