Skip to content

Commit

Permalink
chore(contexts): Simplify state context (#80674)
Browse files Browse the repository at this point in the history
See #80420

Also removes the deprecated redux state files

9/13
  • Loading branch information
leeandher authored Nov 13, 2024
1 parent 92b0340 commit 47d9f09
Show file tree
Hide file tree
Showing 10 changed files with 131 additions and 200 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
type GPUContext,
} from 'sentry/components/events/contexts/knownContext/gpu';

export const MOCK_GPU_CONTEXT: GPUContext = {
const MOCK_GPU_CONTEXT: GPUContext = {
name: '',
version: 'Metal',
id: 2400,
Expand Down
4 changes: 2 additions & 2 deletions static/app/components/events/contexts/knownContext/gpu.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ enum GPUContextKeys {
SUPPORTS_GEOMETRY_SHADERS = 'supports_geometry_shaders',
}

export type GPUContext = {
export interface GPUContext {
// Any custom keys users may set
[key: string]: any;
[GPUContextKeys.ID]: number;
Expand All @@ -40,7 +40,7 @@ export type GPUContext = {
[GPUContextKeys.SUPPORTS_RAY_TRACING]?: boolean;
[GPUContextKeys.SUPPORTS_COMPUTE_SHADERS]?: boolean;
[GPUContextKeys.SUPPORTS_GEOMETRY_SHADERS]?: boolean;
};
}

const MEGABYTE_IN_BYTES = 1048576;

Expand Down
76 changes: 76 additions & 0 deletions static/app/components/events/contexts/knownContext/state.spec.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
import {EventFixture} from 'sentry-fixture/event';

import {render, screen} from 'sentry-test/reactTestingLibrary';

import ContextCard from 'sentry/components/events/contexts/contextCard';
import {
getStateContextData,
type StateContext,
} from 'sentry/components/events/contexts/knownContext/state';

const MOCK_STATE_CONTEXT: StateContext = {
state: {
type: 'redux',
value: {
a: 'abc',
},
},
// Extra data is still valid and preserved
extra_data: 'something',
unknown_key: 123,
};

const MOCK_REDACTION = {
extra_data: {
'': {
rem: [['organization:0', 's', 0, 0]],
len: 5,
},
},
};

describe('StateContext', function () {
it('returns values and according to the parameters', function () {
expect(getStateContextData({data: MOCK_STATE_CONTEXT})).toEqual([
{
key: 'state',
subject: 'State (Redux)',
value: {a: 'abc'},
meta: undefined,
},
{
key: 'extra_data',
subject: 'extra_data',
value: 'something',
meta: undefined,
},
{
key: 'unknown_key',
subject: 'unknown_key',
value: 123,
meta: undefined,
},
]);
});

it('renders with meta annotations correctly', function () {
const event = EventFixture({
_meta: {contexts: {state: MOCK_REDACTION}},
});

render(
<ContextCard
event={event}
type={'default'}
alias={'state'}
value={{...MOCK_STATE_CONTEXT, extra_data: ''}}
/>
);

expect(screen.getByText('Application State')).toBeInTheDocument();
expect(screen.getByText('State (Redux)')).toBeInTheDocument();
expect(screen.getByRole('button', {name: '1 item'})).toBeInTheDocument();
expect(screen.getByText('extra_data')).toBeInTheDocument();
expect(screen.getByText(/redacted/)).toBeInTheDocument();
});
});
43 changes: 43 additions & 0 deletions static/app/components/events/contexts/knownContext/state.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import upperFirst from 'lodash/upperFirst';

import {getContextKeys} from 'sentry/components/events/contexts/utils';
import {t} from 'sentry/locale';
import type {KeyValueListData} from 'sentry/types/group';

enum StateContextKeys {
STATE = 'state',
}

export interface StateContext {
// Any custom keys users may set
[key: string]: any;
[StateContextKeys.STATE]: Record<string, any>;
}

export function getStateContextData({
data,
meta,
}: {
data: StateContext;
meta?: Record<keyof StateContext, any>;
}): KeyValueListData {
return getContextKeys({data}).map(ctxKey => {
switch (ctxKey) {
case StateContextKeys.STATE:
return {
key: ctxKey,
subject: `${t('State')}${data.state.type ? ` (${upperFirst(data.state.type)})` : ''}`,
// TODO(TS): Objects cannot be rendered to dom
value: data.state.value as string,
meta: meta?.state?.value?.[''],
};
default:
return {
key: ctxKey,
subject: ctxKey,
value: data[ctxKey],
meta: meta?.[ctxKey]?.[''],
};
}
});
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,13 @@ import {OrganizationFixture} from 'sentry-fixture/organization';
import {render, screen} from 'sentry-test/reactTestingLibrary';

import ContextCard from 'sentry/components/events/contexts/contextCard';
import {getTraceContextData} from 'sentry/components/events/contexts/knownContext/trace';
import {
getTraceContextData,
type TraceContext,
} from 'sentry/components/events/contexts/knownContext/trace';

const TRACE_ID = '61d2d7c5acf448ffa8e2f8f973e2cd36';
const MOCK_TRACE_CONTEXT = {
const MOCK_TRACE_CONTEXT: TraceContext = {
type: 'default',
trace_id: TRACE_ID,
span_id: '0415201309082013',
Expand Down
4 changes: 2 additions & 2 deletions static/app/components/events/contexts/knownContext/trace.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ enum TraceContextKeys {
DATA = 'data',
}

type TraceContext = {
export interface TraceContext {
// Any custom keys users may set
[key: string]: any;
[TraceContextKeys.TRACE_ID]?: string;
Expand All @@ -35,7 +35,7 @@ type TraceContext = {
[TraceContextKeys.DYNAMIC_SAMPLING_CONTEXT]?: Record<string, string>;
[TraceContextKeys.ORIGIN]?: string;
[TraceContextKeys.DATA]?: Record<string, any>;
};
}

export function getTraceContextData({
data,
Expand Down
32 changes: 0 additions & 32 deletions static/app/components/events/contexts/redux/index.tsx

This file was deleted.

81 changes: 0 additions & 81 deletions static/app/components/events/contexts/state/index.spec.tsx

This file was deleted.

72 changes: 0 additions & 72 deletions static/app/components/events/contexts/state/index.tsx

This file was deleted.

Loading

0 comments on commit 47d9f09

Please sign in to comment.