ref(types): deprecate session status

Author: JonasBa

packages/core/src/baseclient.ts

@@ -7,7 +7,6 @@ import {
   Integration,
   IntegrationClass,
   Options,
-  SessionStatus,
   SeverityLevel,
   Transport,
 } from '@sentry/types';
@@ -267,12 +266,12 @@ export abstract class BaseClient<B extends Backend, O extends Options> implement
     // A session is updated and that session update is sent in only one of the two following scenarios:
     // 1. Session with non terminal status and 0 errors + an error occurred -> Will set error count to 1 and send update
     // 2. Session with non terminal status and 1 error + a crash occurred -> Will set status crashed and send update
-    const sessionNonTerminal = session.status === SessionStatus.Ok;
+    const sessionNonTerminal = session.status === 'ok';
     const shouldUpdateAndSend = (sessionNonTerminal && session.errors === 0) || (sessionNonTerminal && crashed);
 
     if (shouldUpdateAndSend) {
       session.update({
-        ...(crashed && { status: SessionStatus.Crashed }),
+        ...(crashed && { status: 'crashed' }),
         errors: session.errors || Number(errored || crashed),
       });
       this.captureSession(session);

packages/hub/src/hub.ts

@@ -13,7 +13,6 @@ import {
   IntegrationClass,
   Primitive,
   SessionContext,
-  SessionStatus,
   SeverityLevel,
   Span,
   SpanContext,
@@ -451,8 +450,8 @@ export class Hub implements HubInterface {
     if (scope) {
       // End existing session if there's one
       const currentSession = scope.getSession && scope.getSession();
-      if (currentSession && currentSession.status === SessionStatus.Ok) {
-        currentSession.update({ status: SessionStatus.Exited });
+      if (currentSession && currentSession.status === 'ok') {
+        currentSession.update({ status: 'exited' });
       }
       this.endSession();
 

packages/hub/src/session.ts

@@ -13,7 +13,7 @@ export class Session implements SessionInterface {
   public timestamp: number;
   public started: number;
   public duration?: number = 0;
-  public status: SessionStatus = SessionStatus.Ok;
+  public status: SessionStatus = 'ok';
   public environment?: string;
   public ipAddress?: string;
   public init: boolean = true;
@@ -88,11 +88,11 @@ export class Session implements SessionInterface {
   }
 
   /** JSDoc */
-  public close(status?: Exclude<SessionStatus, SessionStatus.Ok>): void {
+  public close(status?: Exclude<SessionStatus, 'ok'>): void {
     if (status) {
       this.update({ status });
-    } else if (this.status === SessionStatus.Ok) {
-      this.update({ status: SessionStatus.Exited });
+    } else if (this.status === 'ok') {
+      this.update({ status: 'exited' });
     } else {
       this.update();
     }

packages/hub/test/session.test.ts

@@ -1,4 +1,4 @@
-import { SessionContext, SessionStatus } from '@sentry/types';
+import { SessionContext } from '@sentry/types';
 import { timestampInSeconds } from '@sentry/utils';
 
 import { Session } from '../src/session';
@@ -16,7 +16,7 @@ describe('Session', () => {
       init: true,
       sid: expect.any(String),
       started: expect.stringMatching(currentYear),
-      status: SessionStatus.Ok,
+      status: 'ok',
       timestamp: expect.stringMatching(currentYear),
     });
 
@@ -74,7 +74,7 @@ describe('Session', () => {
       ],
       ['sets an userAgent', { userAgent: 'Mozilla/5.0' }, { attrs: { user_agent: 'Mozilla/5.0' } }],
       ['sets errors', { errors: 3 }, { errors: 3 }],
-      ['sets status', { status: SessionStatus.Crashed }, { status: SessionStatus.Crashed }],
+      ['sets status', { status: 'crashed' }, { status: 'crashed' }],
     ];
 
     test.each(table)('%s', (...test) => {
@@ -93,26 +93,26 @@ describe('Session', () => {
   describe('close', () => {
     it('exits a normal session', () => {
       const session = new Session();
-      expect(session.status).toEqual(SessionStatus.Ok);
+      expect(session.status).toEqual('ok');
       session.close();
-      expect(session.status).toEqual(SessionStatus.Exited);
+      expect(session.status).toEqual('exited');
     });
 
     it('updates session status when give status', () => {
       const session = new Session();
-      expect(session.status).toEqual(SessionStatus.Ok);
+      expect(session.status).toEqual('ok');
 
-      session.close(SessionStatus.Abnormal);
-      expect(session.status).toEqual(SessionStatus.Abnormal);
+      session.close('abnormal');
+      expect(session.status).toEqual('abnormal');
     });
 
     it('only changes status ok to exited', () => {
       const session = new Session();
-      session.update({ status: SessionStatus.Crashed });
-      expect(session.status).toEqual(SessionStatus.Crashed);
+      session.update({ status: 'crashed' });
+      expect(session.status).toEqual('crashed');
 
       session.close();
-      expect(session.status).toEqual(SessionStatus.Crashed);
+      expect(session.status).toEqual('crashed');
     });
   });
 });

packages/node/src/sdk.ts

@@ -232,7 +232,7 @@ function startSessionTracking(): void {
   // Ref: https://nodejs.org/api/process.html#process_event_beforeexit
   process.on('beforeExit', () => {
     const session = hub.getScope()?.getSession();
-    const terminalStates = [SessionStatus.Exited, SessionStatus.Crashed];
+    const terminalStates: SessionStatus[] = ['exited', 'crashed'];
     // Only call endSession, if the Session exists on Scope and SessionStatus is not a
     // Terminal Status i.e. Exited or Crashed because
     // "When a session is moved away from ok it must not be updated anymore."

packages/node/test/transports/http.test.ts

@@ -1,5 +1,5 @@
 import { Session } from '@sentry/hub';
-import { Event, SessionAggregates, SessionStatus, TransportOptions } from '@sentry/types';
+import { Event, SessionAggregates, TransportOptions } from '@sentry/types';
 import { SentryError } from '@sentry/utils';
 import * as http from 'http';
 import * as HttpsProxyAgent from 'https-proxy-agent';
@@ -27,7 +27,7 @@ const sessionPayload: Session = {
   timestamp: Date.now(),
   init: true,
   duration: 0,
-  status: SessionStatus.Exited,
+  status: 'exited',
   update: jest.fn(),
   close: jest.fn(),
   toJSON: jest.fn(),

packages/types/src/session.ts

@@ -55,20 +55,7 @@ export interface SessionContext {
   ignoreDuration?: boolean;
 }
 
-/**
- * Session Status
- */
-export enum SessionStatus {
-  /** JSDoc */
-  Ok = 'ok',
-  /** JSDoc */
-  Exited = 'exited',
-  /** JSDoc */
-  Crashed = 'crashed',
-  /** JSDoc */
-  Abnormal = 'abnormal',
-}
-
+export type SessionStatus = 'ok' | 'exited' | 'crashed' | 'abnormal';
 export type RequestSessionStatus = 'ok' | 'errored' | 'crashed';
 
 /** JSDoc */

packages/types/src/sessionstatus.ts

@@ -0,0 +1,13 @@
+/** JSDoc
+ * @deprecated Use string literals - if you require type casting, cast to SessionStatus type
+ */
+export enum SessionStatus {
+  /** JSDoc */
+  Ok = 'ok',
+  /** JSDoc */
+  Exited = 'exited',
+  /** JSDoc */
+  Crashed = 'crashed',
+  /** JSDoc */
+  Abnormal = 'abnormal',
+}