123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771 |
- import selectEvent from 'react-select-event';
- import {urlEncode} from '@sentry/utils';
- import {initializeOrg} from 'sentry-test/initializeOrg';
- import {mountGlobalModal} from 'sentry-test/modal';
- import {act, render, screen, userEvent, waitFor} from 'sentry-test/reactTestingLibrary';
- import * as indicators from 'sentry/actionCreators/indicator';
- import * as modals from 'sentry/actionCreators/modal';
- import TagStore from 'sentry/stores/tagStore';
- import {TOP_N} from 'sentry/utils/discover/types';
- import {
- DashboardDetails,
- DashboardWidgetSource,
- DisplayType,
- Widget,
- WidgetType,
- } from 'sentry/views/dashboardsV2/types';
- import WidgetBuilder, {WidgetBuilderProps} from 'sentry/views/dashboardsV2/widgetBuilder';
- const defaultOrgFeatures = [
- 'performance-view',
- 'new-widget-builder-experience-design',
- 'dashboards-edit',
- 'global-views',
- 'dashboards-mep',
- ];
- // Mocking worldMapChart to avoid act warnings
- jest.mock('sentry/components/charts/worldMapChart');
- function mockDashboard(dashboard: Partial<DashboardDetails>): DashboardDetails {
- return {
- id: '1',
- title: 'Dashboard',
- createdBy: undefined,
- dateCreated: '2020-01-01T00:00:00.000Z',
- widgets: [],
- projects: [],
- filters: {},
- ...dashboard,
- };
- }
- function renderTestComponent({
- dashboard,
- query,
- orgFeatures,
- onSave,
- params,
- }: {
- dashboard?: WidgetBuilderProps['dashboard'];
- onSave?: WidgetBuilderProps['onSave'];
- orgFeatures?: string[];
- params?: Partial<WidgetBuilderProps['params']>;
- query?: Record<string, any>;
- } = {}) {
- const {organization, router, routerContext} = initializeOrg({
- ...initializeOrg(),
- organization: {
- features: orgFeatures ?? defaultOrgFeatures,
- },
- router: {
- location: {
- query: {
- source: DashboardWidgetSource.DASHBOARDS,
- ...query,
- },
- },
- },
- });
- render(
- <WidgetBuilder
- route={{}}
- router={router}
- routes={router.routes}
- routeParams={router.params}
- location={router.location}
- dashboard={{
- id: 'new',
- title: 'Dashboard',
- createdBy: undefined,
- dateCreated: '2020-01-01T00:00:00.000Z',
- widgets: [],
- projects: [],
- filters: {},
- ...dashboard,
- }}
- onSave={onSave ?? jest.fn()}
- params={{
- orgId: organization.slug,
- dashboardId: dashboard?.id ?? 'new',
- ...params,
- }}
- />,
- {
- context: routerContext,
- organization,
- }
- );
- return {router};
- }
- describe('WidgetBuilder', function () {
- const untitledDashboard: DashboardDetails = {
- id: '1',
- title: 'Untitled Dashboard',
- createdBy: undefined,
- dateCreated: '2020-01-01T00:00:00.000Z',
- widgets: [],
- projects: [],
- filters: {},
- };
- const testDashboard: DashboardDetails = {
- id: '2',
- title: 'Test Dashboard',
- createdBy: undefined,
- dateCreated: '2020-01-01T00:00:00.000Z',
- widgets: [],
- projects: [],
- filters: {},
- };
- let eventsStatsMock: jest.Mock | undefined;
- let eventsv2Mock: jest.Mock | undefined;
- let eventsMock: jest.Mock | undefined;
- let sessionsDataMock: jest.Mock | undefined;
- let metricsDataMock: jest.Mock | undefined;
- let tagsMock: jest.Mock | undefined;
- let measurementsMetaMock: jest.Mock | undefined;
- beforeEach(function () {
- MockApiClient.addMockResponse({
- url: '/organizations/org-slug/dashboards/',
- body: [
- {...untitledDashboard, widgetDisplay: [DisplayType.TABLE]},
- {...testDashboard, widgetDisplay: [DisplayType.AREA]},
- ],
- });
- MockApiClient.addMockResponse({
- url: '/organizations/org-slug/dashboards/widgets/',
- method: 'POST',
- statusCode: 200,
- body: [],
- });
- eventsv2Mock = MockApiClient.addMockResponse({
- url: '/organizations/org-slug/eventsv2/',
- method: 'GET',
- statusCode: 200,
- body: {
- meta: {},
- data: [],
- },
- });
- eventsMock = MockApiClient.addMockResponse({
- url: '/organizations/org-slug/events/',
- method: 'GET',
- statusCode: 200,
- body: {
- meta: {fields: {}},
- data: [],
- },
- });
- MockApiClient.addMockResponse({
- url: '/organizations/org-slug/projects/',
- method: 'GET',
- body: [],
- });
- MockApiClient.addMockResponse({
- url: '/organizations/org-slug/recent-searches/',
- method: 'GET',
- body: [],
- });
- MockApiClient.addMockResponse({
- url: '/organizations/org-slug/recent-searches/',
- method: 'POST',
- body: [],
- });
- MockApiClient.addMockResponse({
- url: '/organizations/org-slug/issues/',
- method: 'GET',
- body: [],
- });
- eventsStatsMock = MockApiClient.addMockResponse({
- url: '/organizations/org-slug/events-stats/',
- body: [],
- });
- MockApiClient.addMockResponse({
- url: '/organizations/org-slug/tags/event.type/values/',
- body: [{count: 2, name: 'Nvidia 1080ti'}],
- });
- MockApiClient.addMockResponse({
- url: '/organizations/org-slug/events-geo/',
- body: {data: [], meta: {}},
- });
- MockApiClient.addMockResponse({
- url: '/organizations/org-slug/users/',
- body: [],
- });
- sessionsDataMock = MockApiClient.addMockResponse({
- method: 'GET',
- url: '/organizations/org-slug/sessions/',
- body: TestStubs.SessionsField({
- field: `sum(session)`,
- }),
- });
- metricsDataMock = MockApiClient.addMockResponse({
- method: 'GET',
- url: '/organizations/org-slug/metrics/data/',
- body: TestStubs.MetricsField({
- field: 'sum(sentry.sessions.session)',
- }),
- });
- tagsMock = MockApiClient.addMockResponse({
- url: '/organizations/org-slug/tags/',
- method: 'GET',
- body: TestStubs.Tags(),
- });
- measurementsMetaMock = MockApiClient.addMockResponse({
- url: '/organizations/org-slug/measurements-meta/',
- method: 'GET',
- body: {},
- });
- MockApiClient.addMockResponse({
- url: '/organizations/org-slug/tags/is/values/',
- method: 'GET',
- body: [],
- });
- TagStore.reset();
- });
- afterEach(function () {
- MockApiClient.clearMockResponses();
- jest.clearAllMocks();
- jest.useRealTimers();
- });
- describe('with eventsv2', function () {
- it('no feature access', function () {
- renderTestComponent({orgFeatures: []});
- expect(
- screen.getByText("You don't have access to this feature")
- ).toBeInTheDocument();
- });
- it('widget not found', function () {
- const widget: Widget = {
- displayType: DisplayType.AREA,
- interval: '1d',
- queries: [
- {
- name: 'Known Users',
- fields: [],
- columns: [],
- aggregates: [],
- conditions: '',
- orderby: '-time',
- },
- {
- name: 'Anonymous Users',
- fields: [],
- columns: [],
- aggregates: [],
- conditions: '',
- orderby: '-time',
- },
- ],
- title: 'Transactions',
- id: '1',
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({
- dashboard,
- orgFeatures: ['new-widget-builder-experience-design', 'dashboards-edit'],
- params: {
- widgetIndex: '2', // Out of bounds, only one widget
- },
- });
- expect(
- screen.getByText('The widget you want to edit was not found.')
- ).toBeInTheDocument();
- });
- it('renders a widget not found message if the widget index url is not an integer', function () {
- const widget: Widget = {
- displayType: DisplayType.AREA,
- interval: '1d',
- queries: [
- {
- name: 'Known Users',
- fields: [],
- columns: [],
- aggregates: [],
- conditions: '',
- orderby: '-time',
- },
- ],
- title: 'Transactions',
- id: '1',
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({
- dashboard,
- orgFeatures: ['new-widget-builder-experience-design', 'dashboards-edit'],
- params: {
- widgetIndex: '0.5', // Invalid index
- },
- });
- expect(
- screen.getByText('The widget you want to edit was not found.')
- ).toBeInTheDocument();
- });
- it('renders', async function () {
- renderTestComponent();
- // Header - Breadcrumbs
- expect(await screen.findByRole('link', {name: 'Dashboards'})).toHaveAttribute(
- 'href',
- '/organizations/org-slug/dashboards/'
- );
- expect(screen.getByRole('link', {name: 'Dashboard'})).toHaveAttribute(
- 'href',
- '/organizations/org-slug/dashboards/new/'
- );
- expect(screen.getByText('Widget Builder')).toBeInTheDocument();
- // Header - Widget Title
- expect(screen.getByRole('heading', {name: 'Custom Widget'})).toBeInTheDocument();
- // Footer - Actions
- expect(screen.getByLabelText('Cancel')).toBeInTheDocument();
- expect(screen.getByLabelText('Add Widget')).toBeInTheDocument();
- // Content - Step 1
- expect(
- screen.getByRole('heading', {name: 'Choose your dataset'})
- ).toBeInTheDocument();
- expect(screen.getByLabelText('Select Errors and Transactions')).toBeChecked();
- // Content - Step 2
- expect(
- screen.getByRole('heading', {name: 'Choose your visualization'})
- ).toBeInTheDocument();
- // Content - Step 3
- expect(
- screen.getByRole('heading', {name: 'Choose your columns'})
- ).toBeInTheDocument();
- // Content - Step 4
- expect(
- screen.getByRole('heading', {name: 'Filter your results'})
- ).toBeInTheDocument();
- // Content - Step 5
- expect(screen.getByRole('heading', {name: 'Sort by a column'})).toBeInTheDocument();
- });
- it('has links back to the new dashboard if creating', async function () {
- // Dashboard has undefined dashboardId when creating from a new dashboard
- // because of route setup
- renderTestComponent({params: {dashboardId: undefined}});
- expect(await screen.findByRole('link', {name: 'Dashboard'})).toHaveAttribute(
- 'href',
- '/organizations/org-slug/dashboards/new/'
- );
- expect(screen.getByLabelText('Cancel')).toHaveAttribute(
- 'href',
- '/organizations/org-slug/dashboards/new/'
- );
- });
- it('renders new design', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- // Switch to line chart for time series
- userEvent.click(await screen.findByText('Table'));
- userEvent.click(screen.getByText('Line Chart'));
- // Header - Breadcrumbs
- expect(await screen.findByRole('link', {name: 'Dashboards'})).toHaveAttribute(
- 'href',
- '/organizations/org-slug/dashboards/'
- );
- expect(screen.getByRole('link', {name: 'Dashboard'})).toHaveAttribute(
- 'href',
- '/organizations/org-slug/dashboards/new/'
- );
- expect(screen.getByText('Widget Builder')).toBeInTheDocument();
- // Header - Widget Title
- expect(screen.getByRole('heading', {name: 'Custom Widget'})).toBeInTheDocument();
- // Footer - Actions
- expect(screen.getByLabelText('Cancel')).toBeInTheDocument();
- expect(screen.getByLabelText('Add Widget')).toBeInTheDocument();
- // Content - Step 1
- expect(
- screen.getByRole('heading', {name: 'Choose your dataset'})
- ).toBeInTheDocument();
- expect(screen.getByLabelText('Select Errors and Transactions')).toBeChecked();
- // Content - Step 2
- expect(
- screen.getByRole('heading', {name: 'Choose your visualization'})
- ).toBeInTheDocument();
- // Content - Step 3
- expect(
- screen.getByRole('heading', {name: 'Choose what to plot in the y-axis'})
- ).toBeInTheDocument();
- // Content - Step 4
- expect(
- screen.getByRole('heading', {name: 'Filter your results'})
- ).toBeInTheDocument();
- // Content - Step 5
- expect(
- screen.getByRole('heading', {name: 'Group your results'})
- ).toBeInTheDocument();
- });
- it('can update the title', async function () {
- renderTestComponent({
- query: {source: DashboardWidgetSource.DISCOVERV2},
- });
- const customWidgetLabels = await screen.findAllByText('Custom Widget');
- // EditableText and chart title
- expect(customWidgetLabels).toHaveLength(2);
- userEvent.click(customWidgetLabels[0]);
- userEvent.clear(screen.getByRole('textbox', {name: 'Widget title'}));
- userEvent.paste(
- screen.getByRole('textbox', {name: 'Widget title'}),
- 'Unique Users'
- );
- userEvent.keyboard('{enter}');
- expect(screen.queryByText('Custom Widget')).not.toBeInTheDocument();
- expect(screen.getAllByText('Unique Users')).toHaveLength(2);
- });
- it('can add query conditions', async function () {
- const {router} = renderTestComponent({
- query: {source: DashboardWidgetSource.DISCOVERV2},
- dashboard: testDashboard,
- });
- userEvent.type(
- await screen.findByRole('textbox', {name: 'Search events'}),
- 'color:blue{enter}'
- );
- userEvent.click(screen.getByText('Add Widget'));
- await waitFor(() => {
- expect(router.push).toHaveBeenCalledWith(
- expect.objectContaining({
- pathname: '/organizations/org-slug/dashboard/2/',
- query: {
- displayType: 'table',
- interval: '5m',
- title: 'Custom Widget',
- queryNames: [''],
- queryConditions: ['color:blue'],
- queryFields: ['count()'],
- queryOrderby: '-count()',
- start: null,
- end: null,
- statsPeriod: '24h',
- utc: null,
- project: [],
- environment: [],
- },
- })
- );
- });
- });
- it('can choose a field', async function () {
- const {router} = renderTestComponent({
- query: {source: DashboardWidgetSource.DISCOVERV2},
- dashboard: testDashboard,
- });
- expect(await screen.findAllByText('Custom Widget')).toHaveLength(2);
- // No delete button as there is only one query.
- expect(screen.queryByLabelText('Remove query')).not.toBeInTheDocument();
- // 1 in the table header, 1 in the column selector, 1 in the sort field
- const countFields = screen.getAllByText('count()');
- expect(countFields).toHaveLength(3);
- await selectEvent.select(countFields[1], ['last_seen()']);
- userEvent.click(screen.getByText('Add Widget'));
- await waitFor(() => {
- expect(router.push).toHaveBeenCalledWith(
- expect.objectContaining({
- pathname: '/organizations/org-slug/dashboard/2/',
- query: {
- displayType: 'table',
- interval: '5m',
- title: 'Custom Widget',
- queryNames: [''],
- queryConditions: [''],
- queryFields: ['last_seen()'],
- queryOrderby: '-last_seen()',
- start: null,
- end: null,
- statsPeriod: '24h',
- utc: null,
- project: [],
- environment: [],
- },
- })
- );
- });
- });
- it('can add additional fields', async function () {
- const handleSave = jest.fn();
- renderTestComponent({onSave: handleSave});
- userEvent.click(await screen.findByText('Table'));
- // Select line chart display
- userEvent.click(screen.getByText('Line Chart'));
- // Click the add overlay button
- userEvent.click(screen.getByLabelText('Add Overlay'));
- await selectEvent.select(screen.getByText('(Required)'), ['count_unique(…)']);
- userEvent.click(screen.getByLabelText('Add Widget'));
- await waitFor(() => {
- expect(handleSave).toHaveBeenCalledWith([
- expect.objectContaining({
- title: 'Custom Widget',
- displayType: DisplayType.LINE,
- interval: '5m',
- widgetType: WidgetType.DISCOVER,
- queries: [
- {
- conditions: '',
- fields: ['count()', 'count_unique(user)'],
- aggregates: ['count()', 'count_unique(user)'],
- fieldAliases: [],
- columns: [],
- orderby: '',
- name: '',
- },
- ],
- }),
- ]);
- });
- expect(handleSave).toHaveBeenCalledTimes(1);
- });
- it('can add equation fields', async function () {
- const handleSave = jest.fn();
- renderTestComponent({onSave: handleSave});
- userEvent.click(await screen.findByText('Table'));
- // Select line chart display
- userEvent.click(screen.getByText('Line Chart'));
- // Click the add an equation button
- userEvent.click(screen.getByLabelText('Add an Equation'));
- expect(screen.getByPlaceholderText('Equation')).toBeInTheDocument();
- userEvent.paste(screen.getByPlaceholderText('Equation'), 'count() + 100');
- userEvent.click(screen.getByLabelText('Add Widget'));
- await waitFor(() => {
- expect(handleSave).toHaveBeenCalledWith([
- expect.objectContaining({
- title: 'Custom Widget',
- displayType: DisplayType.LINE,
- interval: '5m',
- widgetType: WidgetType.DISCOVER,
- queries: [
- {
- name: '',
- fields: ['count()', 'equation|count() + 100'],
- aggregates: ['count()', 'equation|count() + 100'],
- columns: [],
- fieldAliases: [],
- conditions: '',
- orderby: '',
- },
- ],
- }),
- ]);
- });
- expect(handleSave).toHaveBeenCalledTimes(1);
- });
- it('can respond to validation feedback', async function () {
- jest.spyOn(indicators, 'addErrorMessage');
- renderTestComponent();
- userEvent.click(await screen.findByText('Table'));
- const customWidgetLabels = await screen.findAllByText('Custom Widget');
- // EditableText and chart title
- expect(customWidgetLabels).toHaveLength(2);
- userEvent.click(customWidgetLabels[0]);
- userEvent.clear(screen.getByRole('textbox', {name: 'Widget title'}));
- userEvent.keyboard('{enter}');
- expect(indicators.addErrorMessage).toHaveBeenCalledWith('Widget title is required');
- });
- it('sets up widget data in edit correctly', async function () {
- const widget: Widget = {
- id: '1',
- title: 'Errors over time',
- interval: '5m',
- displayType: DisplayType.LINE,
- queries: [
- {
- name: 'errors',
- conditions: 'event.type:error',
- fields: ['count()', 'count_unique(id)'],
- aggregates: ['count()', 'count_unique(id)'],
- columns: [],
- orderby: '',
- },
- {
- name: 'csp',
- conditions: 'event.type:csp',
- fields: ['count()', 'count_unique(id)'],
- aggregates: ['count()', 'count_unique(id)'],
- columns: [],
- orderby: '',
- },
- ],
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({dashboard, params: {widgetIndex: '0'}});
- await screen.findByText('Line Chart');
- // Should be in edit 'mode'
- expect(await screen.findByText('Update Widget')).toBeInTheDocument();
- // Should set widget data up.
- expect(screen.getByText('Update Widget')).toBeInTheDocument();
- // Filters
- expect(
- screen.getAllByPlaceholderText('Search for events, users, tags, and more')
- ).toHaveLength(2);
- expect(screen.getByText('event.type:csp')).toBeInTheDocument();
- expect(screen.getByText('event.type:error')).toBeInTheDocument();
- // Y-axis
- expect(screen.getAllByRole('button', {name: 'Remove query'})).toHaveLength(2);
- expect(screen.getByText('count()')).toBeInTheDocument();
- expect(screen.getByText('count_unique(…)')).toBeInTheDocument();
- expect(screen.getByText('id')).toBeInTheDocument();
- // Expect events-stats endpoint to be called for each search conditions with
- // the same y-axis parameters
- expect(eventsStatsMock).toHaveBeenNthCalledWith(
- 1,
- '/organizations/org-slug/events-stats/',
- expect.objectContaining({
- query: expect.objectContaining({
- query: 'event.type:error',
- yAxis: ['count()', 'count_unique(id)'],
- }),
- })
- );
- expect(eventsStatsMock).toHaveBeenNthCalledWith(
- 2,
- '/organizations/org-slug/events-stats/',
- expect.objectContaining({
- query: expect.objectContaining({
- query: 'event.type:csp',
- yAxis: ['count()', 'count_unique(id)'],
- }),
- })
- );
- });
- it('can edit a widget', async function () {
- const widget: Widget = {
- id: '1',
- title: 'Errors over time',
- interval: '5m',
- displayType: DisplayType.LINE,
- queries: [
- {
- name: 'errors',
- conditions: 'event.type:error',
- fields: ['count()', 'count_unique(id)'],
- aggregates: ['count()', 'count_unique(id)'],
- columns: [],
- orderby: '',
- },
- {
- name: 'csp',
- conditions: 'event.type:csp',
- fields: ['count()', 'count_unique(id)'],
- aggregates: ['count()', 'count_unique(id)'],
- columns: [],
- orderby: '',
- },
- ],
- };
- const dashboard = mockDashboard({widgets: [widget]});
- const handleSave = jest.fn();
- renderTestComponent({onSave: handleSave, dashboard, params: {widgetIndex: '0'}});
- await screen.findByText('Line Chart');
- // Should be in edit 'mode'
- expect(await screen.findByText('Update Widget')).toBeInTheDocument();
- const customWidgetLabels = await screen.findAllByText(widget.title);
- // EditableText and chart title
- expect(customWidgetLabels).toHaveLength(2);
- userEvent.click(customWidgetLabels[0]);
- userEvent.clear(screen.getByRole('textbox', {name: 'Widget title'}));
- userEvent.paste(screen.getByRole('textbox', {name: 'Widget title'}), 'New Title');
- userEvent.click(screen.getByRole('button', {name: 'Update Widget'}));
- await waitFor(() => {
- expect(handleSave).toHaveBeenCalledWith([
- expect.objectContaining({
- ...widget,
- title: 'New Title',
- }),
- ]);
- });
- expect(handleSave).toHaveBeenCalledTimes(1);
- });
- it('renders column inputs for table widgets', async function () {
- const widget: Widget = {
- id: '0',
- title: 'sdk usage',
- interval: '5m',
- displayType: DisplayType.TABLE,
- queries: [
- {
- name: 'errors',
- conditions: 'event.type:error',
- fields: ['sdk.name', 'count()'],
- columns: ['sdk.name'],
- aggregates: ['count()'],
- orderby: '',
- },
- ],
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({dashboard, params: {widgetIndex: '0'}});
- // Should be in edit 'mode'
- expect(await screen.findByText('Update Widget')).toBeInTheDocument();
- // Should set widget data up.
- expect(screen.getByRole('heading', {name: widget.title})).toBeInTheDocument();
- expect(screen.getByText('Table')).toBeInTheDocument();
- expect(screen.getByLabelText('Search events')).toBeInTheDocument();
- // Should have an orderby select
- expect(screen.getByText('Sort by a column')).toBeInTheDocument();
- // Add a column, and choose a value,
- expect(screen.getByLabelText('Add a Column')).toBeInTheDocument();
- });
- it('can save table widgets', async function () {
- const widget: Widget = {
- id: '0',
- title: 'sdk usage',
- interval: '5m',
- displayType: DisplayType.TABLE,
- queries: [
- {
- name: 'errors',
- conditions: 'event.type:error',
- fields: ['sdk.name', 'count()'],
- columns: ['sdk.name'],
- aggregates: ['count()'],
- orderby: '-count()',
- },
- ],
- };
- const dashboard = mockDashboard({widgets: [widget]});
- const handleSave = jest.fn();
- renderTestComponent({dashboard, onSave: handleSave, params: {widgetIndex: '0'}});
- // Should be in edit 'mode'
- expect(await screen.findByText('Update Widget')).toBeInTheDocument();
- // Add a column, and choose a value,
- userEvent.click(screen.getByLabelText('Add a Column'));
- await selectEvent.select(screen.getByText('(Required)'), 'trace');
- // Save widget
- userEvent.click(screen.getByLabelText('Update Widget'));
- await waitFor(() => {
- expect(handleSave).toHaveBeenCalledWith([
- expect.objectContaining({
- id: '0',
- title: 'sdk usage',
- displayType: DisplayType.TABLE,
- interval: '5m',
- queries: [
- {
- name: 'errors',
- conditions: 'event.type:error',
- fields: ['sdk.name', 'count()', 'trace'],
- aggregates: ['count()'],
- columns: ['sdk.name', 'trace'],
- orderby: '-count()',
- fieldAliases: ['', '', ''],
- },
- ],
- widgetType: WidgetType.DISCOVER,
- }),
- ]);
- });
- expect(handleSave).toHaveBeenCalledTimes(1);
- });
- it('should properly query for table fields', async function () {
- const defaultWidgetQuery = {
- name: '',
- fields: ['title', 'count()'],
- columns: ['title'],
- aggregates: ['count()'],
- conditions: '',
- orderby: '',
- };
- const defaultTableColumns = ['title', 'count()', 'count_unique(user)', 'epm()'];
- renderTestComponent({
- query: {
- source: DashboardWidgetSource.DISCOVERV2,
- defaultWidgetQuery: urlEncode(defaultWidgetQuery),
- displayType: DisplayType.LINE,
- defaultTableColumns,
- },
- });
- expect(await screen.findByText('Line Chart')).toBeInTheDocument();
- userEvent.click(screen.getByText('Line Chart'));
- userEvent.click(screen.getByText('Table'));
- await waitFor(() => {
- expect(eventsv2Mock).toHaveBeenLastCalledWith(
- '/organizations/org-slug/eventsv2/',
- expect.objectContaining({
- query: expect.objectContaining({
- field: defaultTableColumns,
- }),
- })
- );
- });
- });
- it('should use defaultWidgetQuery Y-Axis and Conditions if given a defaultWidgetQuery', async function () {
- const defaultWidgetQuery = {
- name: '',
- fields: ['count()', 'failure_count()', 'count_unique(user)'],
- columns: [],
- aggregates: ['count()', 'failure_count()', 'count_unique(user)'],
- conditions: 'tag:value',
- orderby: '',
- };
- renderTestComponent({
- query: {
- source: DashboardWidgetSource.DISCOVERV2,
- defaultWidgetQuery: urlEncode(defaultWidgetQuery),
- },
- });
- expect(await screen.findByText('tag:value')).toBeInTheDocument();
- // Table display, column, and sort field
- expect(screen.getAllByText('count()')).toHaveLength(3);
- // Table display and column
- expect(screen.getAllByText('failure_count()')).toHaveLength(2);
- // Table display
- expect(screen.getByText('count_unique(user)')).toBeInTheDocument();
- // Column
- expect(screen.getByText('count_unique(…)')).toBeInTheDocument();
- // Column
- expect(screen.getByText('user')).toBeInTheDocument();
- });
- it('uses displayType if given a displayType', async function () {
- renderTestComponent({
- query: {
- displayType: DisplayType.BAR,
- },
- });
- expect(await screen.findByText('Bar Chart')).toBeInTheDocument();
- });
- it('deletes the widget when the modal is confirmed', async () => {
- const handleSave = jest.fn();
- const widget: Widget = {
- id: '1',
- title: 'Errors over time',
- interval: '5m',
- displayType: DisplayType.LINE,
- queries: [
- {
- name: 'errors',
- conditions: 'event.type:error',
- fields: ['count()', 'count_unique(id)'],
- aggregates: ['count()', 'count_unique(id)'],
- columns: [],
- orderby: '',
- },
- {
- name: 'csp',
- conditions: 'event.type:csp',
- fields: ['count()', 'count_unique(id)'],
- aggregates: ['count()', 'count_unique(id)'],
- columns: [],
- orderby: '',
- },
- ],
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({onSave: handleSave, dashboard, params: {widgetIndex: '0'}});
- userEvent.click(await screen.findByText('Delete'));
- await mountGlobalModal();
- userEvent.click(await screen.findByText('Confirm'));
- await waitFor(() => {
- // The only widget was deleted
- expect(handleSave).toHaveBeenCalledWith([]);
- });
- expect(handleSave).toHaveBeenCalledTimes(1);
- });
- it('persists the page filter period when updating a widget', async () => {
- const widget: Widget = {
- id: '1',
- title: 'Errors over time',
- interval: '5m',
- displayType: DisplayType.LINE,
- queries: [
- {
- name: 'errors',
- conditions: 'event.type:error',
- fields: ['count()', 'count_unique(id)'],
- aggregates: ['count()', 'count_unique(id)'],
- columns: [],
- orderby: '',
- },
- ],
- };
- const dashboard = mockDashboard({widgets: [widget]});
- const {router} = renderTestComponent({
- dashboard,
- params: {orgId: 'org-slug', widgetIndex: '0'},
- query: {statsPeriod: '90d'},
- });
- await screen.findByText('Update Widget');
- await screen.findByText('90D');
- expect(screen.getByTestId('page-filter-timerange-selector')).toBeEnabled();
- userEvent.click(screen.getByText('Update Widget'));
- await waitFor(() => {
- expect(router.push).toHaveBeenLastCalledWith(
- expect.objectContaining({
- pathname: '/organizations/org-slug/dashboard/1/',
- query: expect.objectContaining({
- statsPeriod: '90d',
- }),
- })
- );
- });
- });
- it('renders page filters in the filter step', async () => {
- const mockReleases = MockApiClient.addMockResponse({
- url: '/organizations/org-slug/releases/',
- body: [TestStubs.Release()],
- });
- renderTestComponent({
- params: {orgId: 'org-slug'},
- query: {statsPeriod: '90d'},
- orgFeatures: [...defaultOrgFeatures, 'dashboards-top-level-filter'],
- });
- await screen.findByText('90D');
- expect(screen.getByTestId('page-filter-timerange-selector')).toBeDisabled();
- expect(screen.getByTestId('page-filter-environment-selector')).toBeDisabled();
- expect(screen.getByTestId('page-filter-project-selector-loading')).toBeDisabled();
- await waitFor(() => {
- expect(mockReleases).toHaveBeenCalled();
- });
- expect(screen.getByRole('button', {name: /all releases/i})).toBeDisabled();
- });
- it('appends dashboard filters to widget builder fetch data request', async () => {
- MockApiClient.addMockResponse({
- url: '/organizations/org-slug/releases/',
- body: [TestStubs.Release()],
- });
- const mock = MockApiClient.addMockResponse({
- url: '/organizations/org-slug/eventsv2/',
- body: [],
- });
- renderTestComponent({
- dashboard: {
- id: 'new',
- title: 'Dashboard',
- createdBy: undefined,
- dateCreated: '2020-01-01T00:00:00.000Z',
- widgets: [],
- projects: [],
- filters: {release: ['abc@1.2.0']},
- },
- params: {orgId: 'org-slug'},
- query: {statsPeriod: '90d'},
- orgFeatures: [...defaultOrgFeatures, 'dashboards-top-level-filter'],
- });
- await waitFor(() => {
- expect(mock).toHaveBeenCalledWith(
- '/organizations/org-slug/eventsv2/',
- expect.objectContaining({
- query: expect.objectContaining({
- query: ' release:abc@1.2.0 ',
- }),
- })
- );
- });
- });
- it('does not error when query conditions field is blurred', async function () {
- jest.useFakeTimers();
- const widget: Widget = {
- id: '0',
- title: 'sdk usage',
- interval: '5m',
- displayType: DisplayType.BAR,
- queries: [
- {
- name: 'filled in',
- conditions: 'event.type:error',
- fields: ['count()', 'count_unique(id)'],
- aggregates: ['count()', 'count_unique(id)'],
- columns: [],
- orderby: '-count()',
- },
- ],
- };
- const dashboard = mockDashboard({widgets: [widget]});
- const handleSave = jest.fn();
- renderTestComponent({dashboard, onSave: handleSave, params: {widgetIndex: '0'}});
- userEvent.click(await screen.findByLabelText('Add Query'));
- // Triggering the onBlur of the new field should not error
- userEvent.click(
- screen.getAllByPlaceholderText('Search for events, users, tags, and more')[1]
- );
- userEvent.keyboard('{esc}');
- act(() => {
- // Run all timers because the handleBlur contains a setTimeout
- jest.runAllTimers();
- });
- });
- it('does not wipe column changes when filters are modified', async function () {
- jest.useFakeTimers();
- // widgetIndex: undefined means creating a new widget
- renderTestComponent({params: {widgetIndex: undefined}});
- userEvent.click(await screen.findByLabelText('Add a Column'));
- await selectEvent.select(screen.getByText('(Required)'), /project/);
- // Triggering the onBlur of the filter should not error
- userEvent.click(
- screen.getByPlaceholderText('Search for events, users, tags, and more')
- );
- userEvent.keyboard('{enter}');
- act(() => {
- // Run all timers because the handleBlur contains a setTimeout
- jest.runAllTimers();
- });
- expect(await screen.findAllByText('project')).toHaveLength(2);
- });
- it('renders fields with commas properly', async () => {
- const defaultWidgetQuery = {
- conditions: '',
- fields: ['equation|count_if(transaction.duration,equals,300)*2'],
- aggregates: ['equation|count_if(transaction.duration,equals,300)*2'],
- columns: [],
- orderby: '',
- name: '',
- };
- const defaultTableColumns = [
- 'count_if(transaction.duration,equals,300)',
- 'equation|count_if(transaction.duration,equals,300)*2',
- ];
- renderTestComponent({
- query: {
- source: DashboardWidgetSource.DISCOVERV2,
- defaultWidgetQuery: urlEncode(defaultWidgetQuery),
- defaultTableColumns,
- yAxis: ['equation|count_if(transaction.duration,equals,300)*2'],
- },
- });
- expect(
- await screen.findByText('count_if(transaction.duration,equals,300)*2')
- ).toBeInTheDocument();
- });
- it('sets the correct fields for a top n widget', async () => {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'performance-view'],
- query: {
- displayType: DisplayType.TOP_N,
- },
- });
- // Top N now opens as Area Chart
- await screen.findByText('Area Chart');
- // Add a group by
- userEvent.click(screen.getByText('Add Overlay'));
- await selectEvent.select(screen.getByText('Select group'), /project/);
- // Change the y-axis
- await selectEvent.select(screen.getAllByText('count()')[0], 'eps()');
- await waitFor(() => {
- expect(eventsStatsMock).toHaveBeenLastCalledWith(
- '/organizations/org-slug/events-stats/',
- expect.objectContaining({
- query: expect.objectContaining({
- query: '',
- yAxis: ['eps()'],
- field: ['project', 'eps()'],
- topEvents: TOP_N,
- orderby: '-eps()',
- }),
- })
- );
- });
- });
- it('fetches tags when tag store is empty', function () {
- renderTestComponent();
- expect(tagsMock).toHaveBeenCalled();
- });
- it('does not fetch tags when tag store is not empty', function () {
- TagStore.loadTagsSuccess(TestStubs.Tags());
- renderTestComponent();
- expect(tagsMock).not.toHaveBeenCalled();
- });
- it('excludes the Other series when grouping and using multiple y-axes', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- displayType: DisplayType.LINE,
- },
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- userEvent.click(screen.getByText('Add Overlay'));
- await selectEvent.select(screen.getByText('(Required)'), /count_unique/);
- await waitFor(() => {
- expect(eventsStatsMock).toBeCalledWith(
- '/organizations/org-slug/events-stats/',
- expect.objectContaining({
- query: expect.objectContaining({excludeOther: '1'}),
- })
- );
- });
- });
- it('excludes the Other series when grouping and using multiple queries', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- displayType: DisplayType.LINE,
- },
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- userEvent.click(screen.getByText('Add Query'));
- await waitFor(() => {
- expect(eventsStatsMock).toBeCalledWith(
- '/organizations/org-slug/events-stats/',
- expect.objectContaining({
- query: expect.objectContaining({excludeOther: '1'}),
- })
- );
- });
- });
- it('includes Other series when there is only one query and one y-axis', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- displayType: DisplayType.LINE,
- },
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- await waitFor(() => {
- expect(eventsStatsMock).toBeCalledWith(
- '/organizations/org-slug/events-stats/',
- expect.objectContaining({
- query: expect.not.objectContaining({excludeOther: '1'}),
- })
- );
- });
- });
- it('decreases the limit when more y-axes and queries are added', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- displayType: DisplayType.LINE,
- },
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- screen.getByText('Limit to 5 results');
- userEvent.click(screen.getByText('Add Query'));
- userEvent.click(screen.getByText('Add Overlay'));
- await screen.findByText('Limit to 2 results');
- });
- it('alerts the user if there are unsaved changes', async function () {
- const {router} = renderTestComponent();
- const alertMock = jest.fn();
- const setRouteLeaveHookMock = jest.spyOn(router, 'setRouteLeaveHook');
- setRouteLeaveHookMock.mockImplementationOnce((_route, _callback) => {
- alertMock();
- });
- const customWidgetLabels = await screen.findAllByText('Custom Widget');
- // EditableText and chart title
- expect(customWidgetLabels).toHaveLength(2);
- // Change title text
- userEvent.click(customWidgetLabels[0]);
- userEvent.clear(screen.getByRole('textbox', {name: 'Widget title'}));
- userEvent.paste(
- screen.getByRole('textbox', {name: 'Widget title'}),
- 'Unique Users'
- );
- userEvent.keyboard('{enter}');
- // Click Cancel
- userEvent.click(screen.getByText('Cancel'));
- // Assert an alert was triggered
- expect(alertMock).toHaveBeenCalled();
- });
- it('does not trigger alert dialog if no changes', async function () {
- const {router} = renderTestComponent();
- const alertMock = jest.fn();
- const setRouteLeaveHookMock = jest.spyOn(router, 'setRouteLeaveHook');
- setRouteLeaveHookMock.mockImplementationOnce((_route, _callback) => {
- alertMock();
- });
- await screen.findAllByText('Custom Widget');
- // Click Cancel
- userEvent.click(screen.getByText('Cancel'));
- // Assert an alert was triggered
- expect(alertMock).not.toHaveBeenCalled();
- });
- describe('Sort by selectors', function () {
- it('renders', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- expect(await screen.findByText('Sort by a column')).toBeInTheDocument();
- expect(
- screen.getByText("Choose one of the columns you've created to sort by.")
- ).toBeInTheDocument();
- // Selector "sortDirection"
- expect(screen.getByText('High to low')).toBeInTheDocument();
- // Selector "sortBy"
- expect(screen.getAllByText('count()')).toHaveLength(3);
- });
- it('ordering by column uses field form when selecting orderby', async function () {
- const widget: Widget = {
- id: '1',
- title: 'Test Widget',
- interval: '5m',
- displayType: DisplayType.TABLE,
- queries: [
- {
- name: 'errors',
- conditions: 'event.type:error',
- fields: ['count()'],
- aggregates: ['count()'],
- columns: ['project'],
- orderby: '-project',
- },
- ],
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- dashboard,
- params: {
- widgetIndex: '0',
- },
- });
- await waitFor(async () => {
- expect(await screen.findAllByText('project')).toHaveLength(3);
- });
- await selectEvent.select(screen.getAllByText('project')[2], 'count()');
- await waitFor(() => {
- expect(eventsv2Mock).toHaveBeenCalledWith(
- '/organizations/org-slug/eventsv2/',
- expect.objectContaining({
- query: expect.objectContaining({
- sort: ['-count()'],
- }),
- })
- );
- });
- });
- it('sortBy defaults to the first field value when changing display type to table', async function () {
- const widget: Widget = {
- id: '1',
- title: 'Errors over time',
- interval: '5m',
- displayType: DisplayType.LINE,
- queries: [
- {
- name: 'errors',
- conditions: 'event.type:error',
- fields: ['count()', 'count_unique(id)'],
- aggregates: ['count()', 'count_unique(id)'],
- columns: [],
- orderby: '',
- },
- {
- name: 'csp',
- conditions: 'event.type:csp',
- fields: ['count()', 'count_unique(id)'],
- aggregates: ['count()', 'count_unique(id)'],
- columns: [],
- orderby: '',
- },
- ],
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- dashboard,
- params: {
- widgetIndex: '0',
- },
- });
- // Click on the displayType selector
- userEvent.click(await screen.findByText('Line Chart'));
- // Choose the table visualization
- userEvent.click(screen.getByText('Table'));
- expect(await screen.findByText('Sort by a column')).toBeInTheDocument();
- // Selector "sortDirection"
- expect(screen.getByText('High to low')).toBeInTheDocument();
- // Selector "sortBy"
- expect(screen.getAllByText('count()')).toHaveLength(3);
- });
- it('can update selectors values', async function () {
- const handleSave = jest.fn();
- const widget: Widget = {
- id: '1',
- title: 'Errors over time',
- interval: '5m',
- displayType: DisplayType.TABLE,
- queries: [
- {
- name: '',
- conditions: '',
- fields: ['count()', 'count_unique(id)'],
- aggregates: ['count()', 'count_unique(id)'],
- columns: [],
- orderby: '-count()',
- },
- ],
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- dashboard,
- onSave: handleSave,
- params: {
- widgetIndex: '0',
- },
- });
- expect(await screen.findByText('Sort by a column')).toBeInTheDocument();
- // Selector "sortDirection"
- expect(screen.getByText('High to low')).toBeInTheDocument();
- // Selector "sortBy"
- expect(screen.getAllByText('count()')).toHaveLength(3);
- await selectEvent.select(screen.getAllByText('count()')[2], 'count_unique(id)');
- // Wait for the Builder update the widget values
- await waitFor(() => {
- expect(screen.getAllByText('count()')).toHaveLength(2);
- });
- // Now count_unique(id) is selected in the "sortBy" selector
- expect(screen.getAllByText('count_unique(id)')).toHaveLength(2);
- await selectEvent.select(screen.getByText('High to low'), 'Low to high');
- // Saves the widget
- userEvent.click(screen.getByText('Update Widget'));
- await waitFor(() => {
- expect(handleSave).toHaveBeenCalledWith([
- expect.objectContaining({
- queries: [expect.objectContaining({orderby: 'count_unique(id)'})],
- }),
- ]);
- });
- });
- it('sortBy defaults to the first field value when coming from discover', async function () {
- const defaultWidgetQuery = {
- name: '',
- fields: ['title', 'count()', 'count_unique(user)', 'epm()', 'count()'],
- columns: ['title'],
- aggregates: ['count()', 'count_unique(user)', 'epm()', 'count()'],
- conditions: 'tag:value',
- orderby: '',
- };
- const {router} = renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- source: DashboardWidgetSource.DISCOVERV2,
- defaultWidgetQuery: urlEncode(defaultWidgetQuery),
- displayType: DisplayType.TABLE,
- defaultTableColumns: ['title', 'count()', 'count_unique(user)', 'epm()'],
- },
- });
- expect(await screen.findByText('Sort by a column')).toBeInTheDocument();
- // Selector "sortDirection"
- expect(screen.getByText('Low to high')).toBeInTheDocument();
- // Selector "sortBy"
- expect(screen.getAllByText('title')).toHaveLength(2);
- // Saves the widget
- userEvent.click(screen.getByText('Add Widget'));
- await waitFor(() => {
- expect(router.push).toHaveBeenCalledWith(
- expect.objectContaining({
- query: expect.objectContaining({queryOrderby: 'count()'}),
- })
- );
- });
- });
- it('sortBy is only visible on tabular visualizations or when there is a groupBy value selected on time-series visualizations', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- // Sort by shall be visible on table visualization
- expect(await screen.findByText('Sort by a column')).toBeInTheDocument();
- // Update visualization to be a time-series
- userEvent.click(screen.getByText('Table'));
- userEvent.click(screen.getByText('Line Chart'));
- // Time-series visualizations display GroupBy step
- expect(await screen.findByText('Group your results')).toBeInTheDocument();
- // Do not show sortBy when empty columns (groupBys) are added
- userEvent.click(screen.getByText('Add Group'));
- expect(screen.getAllByText('Select group')).toHaveLength(2);
- // SortBy step shall not be visible
- expect(screen.queryByText('Sort by a y-axis')).not.toBeInTheDocument();
- // Select GroupBy value
- await selectEvent.select(screen.getAllByText('Select group')[0], 'project');
- // Now that at least one groupBy value is selected, the SortBy step shall be visible
- expect(screen.getByText('Sort by a y-axis')).toBeInTheDocument();
- // Remove selected GroupBy value
- userEvent.click(screen.getAllByLabelText('Remove group')[0]);
- // SortBy step shall no longer be visible
- expect(screen.queryByText('Sort by a y-axis')).not.toBeInTheDocument();
- });
- it('allows for sorting by a custom equation', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- source: DashboardWidgetSource.DASHBOARDS,
- displayType: DisplayType.LINE,
- },
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- expect(screen.getAllByText('count()')).toHaveLength(2);
- await selectEvent.select(screen.getAllByText('count()')[1], 'Custom Equation');
- userEvent.paste(
- screen.getByPlaceholderText('Enter Equation'),
- 'count_unique(user) * 2'
- );
- userEvent.keyboard('{enter}');
- await waitFor(() => {
- expect(eventsStatsMock).toHaveBeenCalledWith(
- '/organizations/org-slug/events-stats/',
- expect.objectContaining({
- query: expect.objectContaining({
- field: expect.arrayContaining(['equation|count_unique(user) * 2']),
- orderby: '-equation[0]',
- }),
- })
- );
- });
- }, 10000);
- it('persists the state when toggling between sorting options', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- source: DashboardWidgetSource.DASHBOARDS,
- displayType: DisplayType.LINE,
- },
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- expect(screen.getAllByText('count()')).toHaveLength(2);
- await selectEvent.select(screen.getAllByText('count()')[1], 'Custom Equation');
- userEvent.paste(
- screen.getByPlaceholderText('Enter Equation'),
- 'count_unique(user) * 2'
- );
- userEvent.keyboard('{enter}');
- // Switch away from the Custom Equation
- expect(screen.getByText('project')).toBeInTheDocument();
- await selectEvent.select(screen.getByText('Custom Equation'), 'project');
- expect(screen.getAllByText('project')).toHaveLength(2);
- // Switch back, the equation should still be visible
- await selectEvent.select(screen.getAllByText('project')[1], 'Custom Equation');
- expect(screen.getByPlaceholderText('Enter Equation')).toHaveValue(
- 'count_unique(user) * 2'
- );
- });
- it('persists the state when updating y-axes', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- source: DashboardWidgetSource.DASHBOARDS,
- displayType: DisplayType.LINE,
- },
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- expect(screen.getAllByText('count()')).toHaveLength(2);
- await selectEvent.select(screen.getAllByText('count()')[1], 'Custom Equation');
- userEvent.paste(
- screen.getByPlaceholderText('Enter Equation'),
- 'count_unique(user) * 2'
- );
- userEvent.keyboard('{enter}');
- // Add a y-axis
- userEvent.click(screen.getByText('Add Overlay'));
- // The equation should still be visible
- expect(screen.getByPlaceholderText('Enter Equation')).toHaveValue(
- 'count_unique(user) * 2'
- );
- });
- it('displays the custom equation if the widget has it saved', async function () {
- const widget: Widget = {
- id: '1',
- title: 'Test Widget',
- interval: '5m',
- displayType: DisplayType.LINE,
- queries: [
- {
- name: '',
- conditions: '',
- fields: ['count()', 'project'],
- aggregates: ['count()'],
- columns: ['project'],
- orderby: '-equation|count_unique(user) * 2',
- },
- ],
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- source: DashboardWidgetSource.DASHBOARDS,
- displayType: DisplayType.LINE,
- },
- params: {
- widgetIndex: '0',
- },
- dashboard,
- });
- expect(await screen.findByPlaceholderText('Enter Equation')).toHaveValue(
- 'count_unique(user) * 2'
- );
- });
- it('displays Operators in the input dropdown', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- source: DashboardWidgetSource.DASHBOARDS,
- displayType: DisplayType.LINE,
- },
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- expect(screen.getAllByText('count()')).toHaveLength(2);
- await selectEvent.select(screen.getAllByText('count()')[1], 'Custom Equation');
- selectEvent.openMenu(screen.getByPlaceholderText('Enter Equation'));
- expect(screen.getByText('Operators')).toBeInTheDocument();
- expect(screen.queryByText('Fields')).not.toBeInTheDocument();
- });
- it('hides Custom Equation input and resets orderby when switching to table', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- source: DashboardWidgetSource.DASHBOARDS,
- displayType: DisplayType.LINE,
- },
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- expect(screen.getAllByText('count()')).toHaveLength(2);
- await selectEvent.select(screen.getAllByText('count()')[1], 'Custom Equation');
- userEvent.paste(
- screen.getByPlaceholderText('Enter Equation'),
- 'count_unique(user) * 2'
- );
- userEvent.keyboard('{enter}');
- // Switch the display type to Table
- userEvent.click(screen.getByText('Line Chart'));
- userEvent.click(screen.getByText('Table'));
- expect(screen.getAllByText('count()')).toHaveLength(2);
- expect(screen.queryByPlaceholderText('Enter Equation')).not.toBeInTheDocument();
- await waitFor(() => {
- expect(eventsv2Mock).toHaveBeenCalledWith(
- '/organizations/org-slug/eventsv2/',
- expect.objectContaining({
- query: expect.objectContaining({
- sort: ['-count()'],
- }),
- })
- );
- });
- });
- it('does not show the Custom Equation input if the only y-axis left is an empty equation', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- source: DashboardWidgetSource.DASHBOARDS,
- displayType: DisplayType.LINE,
- },
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- userEvent.click(screen.getByText('Add an Equation'));
- userEvent.click(screen.getAllByLabelText('Remove this Y-Axis')[0]);
- expect(screen.queryByPlaceholderText('Enter Equation')).not.toBeInTheDocument();
- });
- it('persists a sort by a grouping when changing y-axes', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- source: DashboardWidgetSource.DASHBOARDS,
- displayType: DisplayType.LINE,
- },
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- expect(screen.getAllByText('count()')).toHaveLength(2);
- // Change the sort option to a grouping field, and then change a y-axis
- await selectEvent.select(screen.getAllByText('count()')[1], 'project');
- await selectEvent.select(screen.getAllByText('count()')[0], /count_unique/);
- // project should appear in the group by field, as well as the sort field
- expect(screen.getAllByText('project')).toHaveLength(2);
- });
- it('persists sort by a y-axis when grouping changes', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- source: DashboardWidgetSource.DASHBOARDS,
- displayType: DisplayType.LINE,
- },
- });
- userEvent.click(await screen.findByText('Add Overlay'));
- await selectEvent.select(screen.getByText('Select group'), 'project');
- // Change the sort by to count_unique
- await selectEvent.select(screen.getAllByText('count()')[1], /count_unique/);
- // Change the grouping
- await selectEvent.select(screen.getByText('project'), 'environment');
- // count_unique(user) should still be the sorting field
- expect(screen.getByText(/count_unique/)).toBeInTheDocument();
- expect(screen.getByText('user')).toBeInTheDocument();
- });
- it('does not remove the Custom Equation field if a grouping is updated', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- source: DashboardWidgetSource.DASHBOARDS,
- displayType: DisplayType.LINE,
- },
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- await selectEvent.select(screen.getAllByText('count()')[1], 'Custom Equation');
- userEvent.paste(
- screen.getByPlaceholderText('Enter Equation'),
- 'count_unique(user) * 2'
- );
- userEvent.keyboard('{enter}');
- userEvent.click(screen.getByText('Add Group'));
- expect(screen.getByPlaceholderText('Enter Equation')).toHaveValue(
- 'count_unique(user) * 2'
- );
- });
- it.each`
- directionPrefix | expectedOrderSelection | displayType
- ${'-'} | ${'High to low'} | ${DisplayType.TABLE}
- ${''} | ${'Low to high'} | ${DisplayType.TABLE}
- ${'-'} | ${'High to low'} | ${DisplayType.LINE}
- ${''} | ${'Low to high'} | ${DisplayType.LINE}
- `(
- `opens a widget with the '$expectedOrderSelection' sort order when the widget was saved with that direction`,
- async function ({directionPrefix, expectedOrderSelection}) {
- const widget: Widget = {
- id: '1',
- title: 'Test Widget',
- interval: '5m',
- displayType: DisplayType.LINE,
- queries: [
- {
- name: '',
- conditions: '',
- fields: ['count_unique(user)'],
- aggregates: ['count_unique(user)'],
- columns: ['project'],
- orderby: `${directionPrefix}count_unique(user)`,
- },
- ],
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- dashboard,
- params: {
- widgetIndex: '0',
- },
- });
- await screen.findByText(expectedOrderSelection);
- }
- );
- it('saved widget with aggregate alias as orderby should persist alias when y-axes change', async function () {
- const widget: Widget = {
- id: '1',
- title: 'Test Widget',
- interval: '5m',
- displayType: DisplayType.TABLE,
- queries: [
- {
- name: '',
- conditions: '',
- fields: ['project', 'count_unique(user)'],
- aggregates: ['count_unique(user)'],
- columns: ['project'],
- orderby: 'count_unique(user)',
- },
- ],
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- dashboard,
- params: {
- widgetIndex: '0',
- },
- });
- await screen.findByText('Sort by a column');
- // Assert for length 2 since one in the table header and one in sort by
- expect(screen.getAllByText('count_unique(user)')).toHaveLength(2);
- userEvent.click(screen.getByText('Add a Column'));
- // The sort by should still have count_unique(user)
- await waitFor(() =>
- expect(screen.getAllByText('count_unique(user)')).toHaveLength(2)
- );
- });
- it('will reset the sort field when going from line to table when sorting by a value not in fields', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- displayType: DisplayType.LINE,
- },
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- expect(screen.getAllByText('count()')).toHaveLength(2);
- await selectEvent.select(screen.getAllByText('count()')[1], /count_unique/);
- userEvent.click(screen.getByText('Line Chart'));
- userEvent.click(screen.getByText('Table'));
- // 1 for table header, 1 for column selection, and 1 for sorting
- await waitFor(() => {
- expect(screen.getAllByText('count()')).toHaveLength(3);
- });
- });
- it('equations in y-axis appear in sort by field for grouped timeseries', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- displayType: DisplayType.LINE,
- },
- });
- userEvent.click(await screen.findByText('Add an Equation'));
- userEvent.paste(screen.getByPlaceholderText('Equation'), 'count() * 100');
- userEvent.keyboard('{enter}');
- await selectEvent.select(screen.getByText('Select group'), 'project');
- expect(screen.getAllByText('count()')).toHaveLength(2);
- await selectEvent.select(screen.getAllByText('count()')[1], 'count() * 100');
- });
- it('does not reset the orderby when ordered by an equation in table', async function () {
- const widget: Widget = {
- id: '1',
- title: 'Errors over time',
- interval: '5m',
- displayType: DisplayType.TABLE,
- queries: [
- {
- name: '',
- conditions: '',
- fields: [
- 'count()',
- 'count_unique(id)',
- 'equation|count() + count_unique(id)',
- ],
- aggregates: [
- 'count()',
- 'count_unique(id)',
- 'equation|count() + count_unique(id)',
- ],
- columns: [],
- orderby: '-equation[0]',
- },
- ],
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({
- dashboard,
- params: {
- widgetIndex: '0',
- },
- });
- await screen.findByText('Sort by a column');
- // 1 in the column selector, 1 in the sort by field
- expect(screen.getAllByText('count() + count_unique(id)')).toHaveLength(2);
- });
- });
- describe('Widget creation coming from other verticals', function () {
- it('redirects correctly when creating a new dashboard', async function () {
- const {router} = renderTestComponent({
- query: {source: DashboardWidgetSource.DISCOVERV2},
- });
- userEvent.click(await screen.findByText('Add Widget'));
- await waitFor(() => {
- expect(router.push).toHaveBeenCalledWith(
- expect.objectContaining({
- pathname: '/organizations/org-slug/dashboards/new/',
- query: {
- displayType: 'table',
- interval: '5m',
- title: 'Custom Widget',
- queryNames: [''],
- queryConditions: [''],
- queryFields: ['count()'],
- queryOrderby: '-count()',
- start: null,
- end: null,
- statsPeriod: '24h',
- utc: null,
- project: [],
- environment: [],
- },
- })
- );
- });
- });
- it('redirects correctly when choosing an existing dashboard', async function () {
- const {router} = renderTestComponent({
- query: {source: DashboardWidgetSource.DISCOVERV2},
- dashboard: testDashboard,
- });
- userEvent.click(await screen.findByText('Add Widget'));
- await waitFor(() => {
- expect(router.push).toHaveBeenCalledWith(
- expect.objectContaining({
- pathname: '/organizations/org-slug/dashboard/2/',
- query: {
- displayType: 'table',
- interval: '5m',
- title: 'Custom Widget',
- queryNames: [''],
- queryConditions: [''],
- queryFields: ['count()'],
- queryOrderby: '-count()',
- start: null,
- end: null,
- statsPeriod: '24h',
- utc: null,
- project: [],
- environment: [],
- },
- })
- );
- });
- });
- it('shows the correct orderby when switching from a line chart to table', async function () {
- const defaultWidgetQuery = {
- name: '',
- fields: ['count_unique(user)'],
- columns: [],
- aggregates: ['count_unique(user)'],
- conditions: '',
- orderby: 'count_unique(user)',
- };
- const defaultTableColumns = ['title', 'count_unique(user)'];
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- source: DashboardWidgetSource.DISCOVERV2,
- defaultWidgetQuery: urlEncode(defaultWidgetQuery),
- displayType: DisplayType.LINE,
- defaultTableColumns,
- },
- });
- userEvent.click(await screen.findByText('Line Chart'));
- userEvent.click(screen.getByText('Table'));
- expect(screen.getByText('count_unique(user)')).toBeInTheDocument();
- await waitFor(() => {
- expect(eventsv2Mock).toHaveBeenLastCalledWith(
- '/organizations/org-slug/eventsv2/',
- expect.objectContaining({
- query: expect.objectContaining({
- field: defaultTableColumns,
- sort: ['count_unique(user)'],
- }),
- })
- );
- });
- });
- it('does not send request with orderby if a timeseries chart without grouping', async function () {
- const defaultWidgetQuery = {
- name: '',
- fields: ['count_unique(user)'],
- columns: [],
- aggregates: ['count_unique(user)'],
- conditions: '',
- orderby: 'count_unique(user)',
- };
- const defaultTableColumns = ['title', 'count_unique(user)'];
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- query: {
- source: DashboardWidgetSource.DISCOVERV2,
- defaultWidgetQuery: urlEncode(defaultWidgetQuery),
- displayType: DisplayType.LINE,
- defaultTableColumns,
- },
- });
- await waitFor(() => {
- expect(eventsStatsMock).toHaveBeenLastCalledWith(
- '/organizations/org-slug/events-stats/',
- expect.objectContaining({
- query: expect.objectContaining({
- orderby: '',
- }),
- })
- );
- });
- });
- });
- it('opens top-N widgets as area display', async function () {
- const widget: Widget = {
- id: '1',
- title: 'Errors over time',
- interval: '5m',
- displayType: DisplayType.TOP_N,
- queries: [
- {
- name: '',
- conditions: '',
- fields: ['count()', 'count_unique(id)'],
- aggregates: ['count()', 'count_unique(id)'],
- columns: [],
- orderby: '-count()',
- },
- ],
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- dashboard,
- params: {
- widgetIndex: '0',
- },
- });
- expect(await screen.findByText('Area Chart')).toBeInTheDocument();
- });
- it('Update table header values (field alias)', async function () {
- const handleSave = jest.fn();
- renderTestComponent({
- onSave: handleSave,
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- await screen.findByText('Table');
- userEvent.paste(screen.getByPlaceholderText('Alias'), 'First Alias');
- userEvent.click(screen.getByLabelText('Add a Column'));
- userEvent.paste(screen.getAllByPlaceholderText('Alias')[1], 'Second Alias');
- userEvent.click(screen.getByText('Add Widget'));
- await waitFor(() => {
- expect(handleSave).toHaveBeenCalledWith([
- expect.objectContaining({
- queries: [
- expect.objectContaining({fieldAliases: ['First Alias', 'Second Alias']}),
- ],
- }),
- ]);
- });
- });
- it('does not wipe equation aliases when a column alias is updated', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- await screen.findByText('Table');
- userEvent.click(screen.getByText('Add an Equation'));
- userEvent.paste(screen.getAllByPlaceholderText('Alias')[1], 'This should persist');
- userEvent.type(screen.getAllByPlaceholderText('Alias')[0], 'A');
- expect(await screen.findByText('This should persist')).toBeInTheDocument();
- });
- it('does not wipe equation aliases when a column selection is made', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- await screen.findByText('Table');
- userEvent.click(screen.getByText('Add an Equation'));
- userEvent.paste(screen.getAllByPlaceholderText('Alias')[1], 'This should persist');
- // 1 for the table, 1 for the the column selector, 1 for the sort
- await waitFor(() => expect(screen.getAllByText('count()')).toHaveLength(3));
- await selectEvent.select(screen.getAllByText('count()')[1], /count_unique/);
- expect(screen.getByText('This should persist')).toBeInTheDocument();
- });
- it('copies over the orderby from the previous query if adding another', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- userEvent.click(await screen.findByText('Table'));
- userEvent.click(screen.getByText('Line Chart'));
- await selectEvent.select(screen.getByText('Select group'), 'project');
- await selectEvent.select(screen.getAllByText('count()')[1], 'count_unique(…)');
- MockApiClient.clearMockResponses();
- eventsStatsMock = MockApiClient.addMockResponse({
- url: '/organizations/org-slug/events-stats/',
- body: [],
- });
- userEvent.click(screen.getByText('Add Query'));
- // Assert on two calls, one for each query
- const expectedArgs = expect.objectContaining({
- query: expect.objectContaining({
- orderby: '-count_unique(user)',
- }),
- });
- expect(eventsStatsMock).toHaveBeenNthCalledWith(
- 1,
- '/organizations/org-slug/events-stats/',
- expectedArgs
- );
- expect(eventsStatsMock).toHaveBeenNthCalledWith(
- 2,
- '/organizations/org-slug/events-stats/',
- expectedArgs
- );
- });
- describe('Issue Widgets', function () {
- it('sets widgetType to issues', async function () {
- const handleSave = jest.fn();
- renderTestComponent({onSave: handleSave});
- userEvent.click(
- await screen.findByText('Issues (States, Assignment, Time, etc.)')
- );
- userEvent.click(screen.getByLabelText('Add Widget'));
- await waitFor(() => {
- expect(handleSave).toHaveBeenCalledWith([
- expect.objectContaining({
- title: 'Custom Widget',
- displayType: DisplayType.TABLE,
- interval: '5m',
- widgetType: WidgetType.ISSUE,
- queries: [
- {
- conditions: '',
- fields: ['issue', 'assignee', 'title'],
- columns: ['issue', 'assignee', 'title'],
- aggregates: [],
- fieldAliases: [],
- name: '',
- orderby: 'date',
- },
- ],
- }),
- ]);
- });
- expect(handleSave).toHaveBeenCalledTimes(1);
- });
- it('render issues dataset disabled when the display type is not set to table', async function () {
- renderTestComponent({
- query: {
- source: DashboardWidgetSource.DISCOVERV2,
- },
- });
- userEvent.click(await screen.findByText('Table'));
- userEvent.click(screen.getByText('Line Chart'));
- expect(
- screen.getByRole('radio', {
- name: 'Select Errors and Transactions',
- })
- ).toBeEnabled();
- expect(
- screen.getByRole('radio', {
- name: 'Select Issues (States, Assignment, Time, etc.)',
- })
- ).toBeDisabled();
- });
- it('disables moving and deleting issue column', async function () {
- renderTestComponent();
- userEvent.click(
- await screen.findByText('Issues (States, Assignment, Time, etc.)')
- );
- expect(screen.getByText('issue')).toBeInTheDocument();
- expect(screen.getByText('assignee')).toBeInTheDocument();
- expect(screen.getByText('title')).toBeInTheDocument();
- expect(screen.getAllByLabelText('Remove column')).toHaveLength(2);
- expect(screen.getAllByLabelText('Drag to reorder')).toHaveLength(3);
- userEvent.click(screen.getAllByLabelText('Remove column')[1]);
- userEvent.click(screen.getAllByLabelText('Remove column')[0]);
- expect(screen.getByText('issue')).toBeInTheDocument();
- expect(screen.queryByText('assignee')).not.toBeInTheDocument();
- expect(screen.queryByText('title')).not.toBeInTheDocument();
- expect(screen.queryByLabelText('Remove column')).not.toBeInTheDocument();
- expect(screen.queryByLabelText('Drag to reorder')).not.toBeInTheDocument();
- });
- it('issue query does not work on default search bar', async function () {
- renderTestComponent();
- const input = (await screen.findByPlaceholderText(
- 'Search for events, users, tags, and more'
- )) as HTMLTextAreaElement;
- userEvent.paste(input, 'bookmarks', {
- clipboardData: {getData: () => ''},
- } as unknown as React.ClipboardEvent<HTMLTextAreaElement>);
- input.setSelectionRange(9, 9);
- expect(await screen.findByText('No items found')).toBeInTheDocument();
- });
- it('renders with an issues search bar when selected in dataset selection', async function () {
- renderTestComponent();
- userEvent.click(
- await screen.findByText('Issues (States, Assignment, Time, etc.)')
- );
- const input = (await screen.findByPlaceholderText(
- 'Search for issues, status, assigned, and more'
- )) as HTMLTextAreaElement;
- userEvent.paste(input, 'is:', {
- clipboardData: {getData: () => ''},
- } as unknown as React.ClipboardEvent<HTMLTextAreaElement>);
- input.setSelectionRange(3, 3);
- expect(await screen.findByText('resolved')).toBeInTheDocument();
- });
- it('Update table header values (field alias)', async function () {
- const handleSave = jest.fn();
- renderTestComponent({
- onSave: handleSave,
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- await screen.findByText('Table');
- userEvent.click(screen.getByText('Issues (States, Assignment, Time, etc.)'));
- userEvent.paste(screen.getAllByPlaceholderText('Alias')[0], 'First Alias');
- userEvent.click(screen.getByText('Add Widget'));
- await waitFor(() => {
- expect(handleSave).toHaveBeenCalledWith([
- expect.objectContaining({
- queries: [
- expect.objectContaining({
- fieldAliases: ['First Alias', '', ''],
- }),
- ],
- }),
- ]);
- });
- });
- });
- describe('Release Widgets', function () {
- const releaseHealthFeatureFlags = [
- ...defaultOrgFeatures,
- 'new-widget-builder-experience-design',
- 'dashboards-releases',
- ];
- it('does not show the Release Health dataset if there is no dashboards-releases flag', async function () {
- renderTestComponent({
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- expect(await screen.findByText('Errors and Transactions')).toBeInTheDocument();
- expect(
- screen.queryByText('Releases (sessions, crash rates)')
- ).not.toBeInTheDocument();
- });
- it('shows the Release Health dataset if there is the dashboards-releases flag', async function () {
- renderTestComponent({
- orgFeatures: releaseHealthFeatureFlags,
- });
- expect(await screen.findByText('Errors and Transactions')).toBeInTheDocument();
- expect(screen.getByText('Releases (sessions, crash rates)')).toBeInTheDocument();
- });
- it('maintains the selected dataset when display type is changed', async function () {
- renderTestComponent({
- orgFeatures: releaseHealthFeatureFlags,
- });
- expect(
- await screen.findByText('Releases (sessions, crash rates)')
- ).toBeInTheDocument();
- expect(screen.getByLabelText(/releases/i)).not.toBeChecked();
- userEvent.click(screen.getByLabelText(/releases/i));
- await waitFor(() => expect(screen.getByLabelText(/releases/i)).toBeChecked());
- userEvent.click(screen.getByText('Table'));
- userEvent.click(screen.getByText('Line Chart'));
- await waitFor(() => expect(screen.getByLabelText(/releases/i)).toBeChecked());
- });
- it('displays releases tags', async function () {
- renderTestComponent({
- orgFeatures: releaseHealthFeatureFlags,
- });
- expect(
- await screen.findByText('Releases (sessions, crash rates)')
- ).toBeInTheDocument();
- userEvent.click(screen.getByLabelText(/releases/i));
- expect(screen.getByText('crash_free_rate(…)')).toBeInTheDocument();
- expect(screen.getByText('session')).toBeInTheDocument();
- userEvent.click(screen.getByText('crash_free_rate(…)'));
- expect(screen.getByText('count_unique(…)')).toBeInTheDocument();
- expect(screen.getByText('release')).toBeInTheDocument();
- expect(screen.getByText('environment')).toBeInTheDocument();
- expect(screen.getByText('session.status')).toBeInTheDocument();
- userEvent.click(screen.getByText('count_unique(…)'));
- expect(screen.getByText('user')).toBeInTheDocument();
- });
- it('does not display tags as params', async function () {
- renderTestComponent({
- orgFeatures: releaseHealthFeatureFlags,
- });
- expect(
- await screen.findByText('Releases (sessions, crash rates)')
- ).toBeInTheDocument();
- userEvent.click(screen.getByLabelText(/releases/i));
- expect(screen.getByText('crash_free_rate(…)')).toBeInTheDocument();
- await selectEvent.select(
- screen.getByText('crash_free_rate(…)'),
- 'count_unique(…)'
- );
- userEvent.click(screen.getByText('user'));
- expect(screen.queryByText('release')).not.toBeInTheDocument();
- expect(screen.queryByText('environment')).not.toBeInTheDocument();
- expect(screen.queryByText('session.status')).not.toBeInTheDocument();
- });
- it('does not allow sort by when session.status is selected', async function () {
- renderTestComponent({
- orgFeatures: releaseHealthFeatureFlags,
- });
- expect(
- await screen.findByText('Releases (sessions, crash rates)')
- ).toBeInTheDocument();
- userEvent.click(screen.getByLabelText(/releases/i));
- expect(screen.getByText('High to low')).toBeEnabled();
- expect(screen.getByText('crash_free_rate(session)')).toBeInTheDocument();
- userEvent.click(screen.getByLabelText('Add a Column'));
- await selectEvent.select(screen.getByText('(Required)'), 'session.status');
- expect(screen.getByRole('textbox', {name: 'Sort direction'})).toBeDisabled();
- expect(screen.getByRole('textbox', {name: 'Sort by'})).toBeDisabled();
- });
- it('does not allow sort on tags except release', async function () {
- jest.useFakeTimers().setSystemTime(new Date('2022-08-02'));
- renderTestComponent({
- orgFeatures: releaseHealthFeatureFlags,
- });
- expect(
- await screen.findByText('Releases (sessions, crash rates)')
- ).toBeInTheDocument();
- userEvent.click(screen.getByLabelText(/releases/i));
- expect(screen.getByText('High to low')).toBeEnabled();
- expect(screen.getByText('crash_free_rate(session)')).toBeInTheDocument();
- userEvent.click(screen.getByLabelText('Add a Column'));
- await selectEvent.select(screen.getByText('(Required)'), 'release');
- userEvent.click(screen.getByLabelText('Add a Column'));
- await selectEvent.select(screen.getByText('(Required)'), 'environment');
- expect(await screen.findByText('Sort by a column')).toBeInTheDocument();
- // Selector "sortDirection"
- expect(screen.getByText('High to low')).toBeInTheDocument();
- // Selector "sortBy"
- userEvent.click(screen.getAllByText('crash_free_rate(session)')[1]);
- // release exists in sort by selector
- expect(screen.getAllByText('release')).toHaveLength(3);
- // environment does not exist in sort by selector
- expect(screen.getAllByText('environment')).toHaveLength(2);
- });
- it('makes the appropriate sessions call', async function () {
- jest.useFakeTimers().setSystemTime(new Date('2022-08-02'));
- renderTestComponent({
- orgFeatures: releaseHealthFeatureFlags,
- });
- expect(
- await screen.findByText('Releases (sessions, crash rates)')
- ).toBeInTheDocument();
- userEvent.click(screen.getByLabelText(/releases/i));
- userEvent.click(screen.getByText('Table'));
- userEvent.click(screen.getByText('Line Chart'));
- await waitFor(() =>
- expect(metricsDataMock).toHaveBeenLastCalledWith(
- `/organizations/org-slug/metrics/data/`,
- expect.objectContaining({
- query: expect.objectContaining({
- environment: [],
- field: [`session.crash_free_rate`],
- groupBy: [],
- interval: '5m',
- project: [],
- statsPeriod: '24h',
- }),
- })
- )
- );
- });
- it('calls the session endpoint with the right limit', async function () {
- jest.useFakeTimers().setSystemTime(new Date('2022-08-02'));
- renderTestComponent({
- orgFeatures: releaseHealthFeatureFlags,
- });
- expect(
- await screen.findByText('Releases (sessions, crash rates)')
- ).toBeInTheDocument();
- userEvent.click(screen.getByLabelText(/releases/i));
- userEvent.click(screen.getByText('Table'));
- userEvent.click(screen.getByText('Line Chart'));
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- expect(screen.getByText('Limit to 5 results')).toBeInTheDocument();
- await waitFor(() =>
- expect(metricsDataMock).toHaveBeenLastCalledWith(
- `/organizations/org-slug/metrics/data/`,
- expect.objectContaining({
- query: expect.objectContaining({
- environment: [],
- field: ['session.crash_free_rate'],
- groupBy: ['project_id'],
- interval: '5m',
- orderBy: '-session.crash_free_rate',
- per_page: 5,
- project: [],
- statsPeriod: '24h',
- }),
- })
- )
- );
- });
- it('calls sessions api when session.status is selected as a groupby', async function () {
- jest.useFakeTimers().setSystemTime(new Date('2022-08-02'));
- renderTestComponent({
- orgFeatures: releaseHealthFeatureFlags,
- });
- expect(
- await screen.findByText('Releases (sessions, crash rates)')
- ).toBeInTheDocument();
- userEvent.click(screen.getByLabelText(/releases/i));
- userEvent.click(screen.getByText('Table'));
- userEvent.click(screen.getByText('Line Chart'));
- await selectEvent.select(
- await screen.findByText('Select group'),
- 'session.status'
- );
- expect(screen.getByText('Limit to 5 results')).toBeInTheDocument();
- await waitFor(() =>
- expect(sessionsDataMock).toHaveBeenLastCalledWith(
- `/organizations/org-slug/sessions/`,
- expect.objectContaining({
- query: expect.objectContaining({
- environment: [],
- field: ['crash_free_rate(session)'],
- groupBy: ['session.status'],
- interval: '5m',
- project: [],
- statsPeriod: '24h',
- }),
- })
- )
- );
- });
- it('displays the correct options for area chart', async function () {
- renderTestComponent({
- orgFeatures: releaseHealthFeatureFlags,
- });
- expect(
- await screen.findByText('Releases (sessions, crash rates)')
- ).toBeInTheDocument();
- // change dataset to releases
- userEvent.click(screen.getByLabelText(/releases/i));
- userEvent.click(screen.getByText('Table'));
- userEvent.click(screen.getByText('Line Chart'));
- expect(screen.getByText('crash_free_rate(…)')).toBeInTheDocument();
- expect(screen.getByText(`session`)).toBeInTheDocument();
- userEvent.click(screen.getByText('crash_free_rate(…)'));
- expect(screen.getByText('count_unique(…)')).toBeInTheDocument();
- userEvent.click(screen.getByText('count_unique(…)'));
- expect(screen.getByText('user')).toBeInTheDocument();
- });
- it('sets widgetType to release', async function () {
- jest.useFakeTimers().setSystemTime(new Date('2022-08-02'));
- renderTestComponent({
- orgFeatures: releaseHealthFeatureFlags,
- });
- userEvent.click(await screen.findByText('Releases (sessions, crash rates)'));
- expect(metricsDataMock).toHaveBeenCalled();
- expect(screen.getByLabelText(/Releases/i)).toBeChecked();
- });
- it('does not display "add an equation" button', async function () {
- const widget: Widget = {
- title: 'Release Widget',
- displayType: DisplayType.TABLE,
- widgetType: WidgetType.RELEASE,
- queries: [
- {
- name: 'errors',
- conditions: 'event.type:error',
- fields: ['sdk.name', 'count()'],
- columns: ['sdk.name'],
- aggregates: ['count()'],
- orderby: '-sdk.name',
- },
- ],
- interval: '1d',
- id: '1',
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({
- orgFeatures: releaseHealthFeatureFlags,
- dashboard,
- params: {
- widgetIndex: '0',
- },
- });
- // Select line chart display
- userEvent.click(await screen.findByText('Table'));
- userEvent.click(screen.getByText('Line Chart'));
- await waitFor(() =>
- expect(screen.queryByLabelText('Add an Equation')).not.toBeInTheDocument()
- );
- });
- it('render release dataset disabled when the display type is world map', async function () {
- renderTestComponent({
- query: {
- source: DashboardWidgetSource.DISCOVERV2,
- },
- orgFeatures: releaseHealthFeatureFlags,
- });
- userEvent.click(await screen.findByText('Table'));
- userEvent.click(screen.getByText('World Map'));
- await waitFor(() => expect(screen.getByLabelText(/Releases/)).toBeDisabled());
- expect(
- screen.getByRole('radio', {
- name: 'Select Errors and Transactions',
- })
- ).toBeEnabled();
- expect(
- screen.getByRole('radio', {
- name: 'Select Issues (States, Assignment, Time, etc.)',
- })
- ).toBeDisabled();
- });
- it('renders with a release search bar', async function () {
- renderTestComponent({
- orgFeatures: releaseHealthFeatureFlags,
- });
- userEvent.type(
- await screen.findByPlaceholderText('Search for events, users, tags, and more'),
- 'session.status:'
- );
- await waitFor(() => {
- expect(screen.getByText("isn't supported here.")).toBeInTheDocument();
- });
- userEvent.click(screen.getByText('Releases (sessions, crash rates)'));
- userEvent.click(
- screen.getByPlaceholderText(
- 'Search for release version, session status, and more'
- )
- );
- expect(await screen.findByText('environment')).toBeInTheDocument();
- expect(screen.getByText('project')).toBeInTheDocument();
- expect(screen.getByText('release')).toBeInTheDocument();
- });
- it('adds a function when the only column chosen in a table is a tag', async function () {
- jest.useFakeTimers().setSystemTime(new Date('2022-08-02'));
- renderTestComponent({
- orgFeatures: releaseHealthFeatureFlags,
- });
- userEvent.click(await screen.findByText('Releases (sessions, crash rates)'));
- await selectEvent.select(screen.getByText('crash_free_rate(…)'), 'environment');
- // 1 in the table header, 1 in the column selector, and 1 in the sort by
- expect(screen.getAllByText(/crash_free_rate/)).toHaveLength(3);
- expect(screen.getAllByText('environment')).toHaveLength(2);
- });
- });
- describe('Widget Library', function () {
- it('renders', async function () {
- renderTestComponent();
- expect(await screen.findByText('Widget Library')).toBeInTheDocument();
- });
- it('only opens the modal when the query data is changed', async function () {
- const mockModal = jest.spyOn(modals, 'openWidgetBuilderOverwriteModal');
- renderTestComponent();
- await screen.findByText('Widget Library');
- userEvent.click(screen.getByText('Duration Distribution'));
- // Widget Library, Builder title, and Chart title
- expect(await screen.findAllByText('Duration Distribution')).toHaveLength(3);
- // Confirm modal doesn't open because no changes were made
- expect(mockModal).not.toHaveBeenCalled();
- userEvent.click(screen.getAllByLabelText('Remove this Y-Axis')[0]);
- userEvent.click(screen.getByText('High Throughput Transactions'));
- // Should not have overwritten widget data, and confirm modal should open
- expect(await screen.findAllByText('Duration Distribution')).toHaveLength(3);
- expect(mockModal).toHaveBeenCalled();
- });
- });
- describe('group by field', function () {
- it('does not contain functions as options', async function () {
- renderTestComponent({
- query: {displayType: 'line'},
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- await screen.findByText('Group your results');
- expect(screen.getByText('Select group')).toBeInTheDocument();
- userEvent.click(screen.getByText('Select group'));
- // Only one f(x) field set in the y-axis selector
- expect(screen.getByText('f(x)')).toBeInTheDocument();
- });
- it('adds more fields when Add Group is clicked', async function () {
- renderTestComponent({
- query: {displayType: 'line'},
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- await screen.findByText('Group your results');
- userEvent.click(screen.getByText('Add Group'));
- expect(await screen.findAllByText('Select group')).toHaveLength(2);
- });
- it("doesn't reset group by when changing y-axis", async function () {
- renderTestComponent({
- query: {displayType: 'line'},
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- userEvent.click(screen.getAllByText('count()')[0], undefined, {skipHover: true});
- userEvent.click(screen.getByText(/count_unique/), undefined, {skipHover: true});
- expect(await screen.findByText('project')).toBeInTheDocument();
- });
- it("doesn't erase the selection when switching to another time series", async function () {
- renderTestComponent({
- query: {displayType: 'line'},
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- userEvent.click(screen.getByText('Line Chart'));
- userEvent.click(screen.getByText('Area Chart'));
- expect(await screen.findByText('project')).toBeInTheDocument();
- });
- it('sends a top N request when a grouping is selected', async function () {
- renderTestComponent({
- query: {displayType: 'line'},
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- userEvent.click(await screen.findByText('Group your results'));
- userEvent.type(screen.getByText('Select group'), 'project{enter}');
- await waitFor(() =>
- expect(eventsStatsMock).toHaveBeenNthCalledWith(
- 2,
- '/organizations/org-slug/events-stats/',
- expect.objectContaining({
- query: expect.objectContaining({
- query: '',
- yAxis: ['count()'],
- field: ['project', 'count()'],
- topEvents: TOP_N,
- orderby: '-count()',
- }),
- })
- )
- );
- });
- it('allows deleting groups until there is one left', async function () {
- renderTestComponent({
- query: {displayType: 'line'},
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- await screen.findByText('Group your results');
- userEvent.click(screen.getByText('Add Group'));
- expect(screen.getAllByLabelText('Remove group')).toHaveLength(2);
- userEvent.click(screen.getAllByLabelText('Remove group')[1]);
- await waitFor(() =>
- expect(screen.queryByLabelText('Remove group')).not.toBeInTheDocument()
- );
- });
- it("display 'remove' and 'drag to reorder' buttons", async function () {
- renderTestComponent({
- query: {displayType: 'line'},
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- await screen.findByText('Select group');
- expect(screen.queryByLabelText('Remove group')).not.toBeInTheDocument();
- await selectEvent.select(screen.getByText('Select group'), 'project');
- expect(screen.getByLabelText('Remove group')).toBeInTheDocument();
- expect(screen.queryByLabelText('Drag to reorder')).not.toBeInTheDocument();
- userEvent.click(screen.getByText('Add Group'));
- expect(screen.getAllByLabelText('Remove group')).toHaveLength(2);
- expect(screen.getAllByLabelText('Drag to reorder')).toHaveLength(2);
- });
- it.todo(
- 'Since simulate drag and drop with RTL is not recommended because of browser layout, remember to create acceptance test for this'
- );
- });
- describe('limit field', function () {
- it('renders if groupBy value is present', async function () {
- const handleSave = jest.fn();
- renderTestComponent({
- query: {displayType: 'line'},
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- onSave: handleSave,
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- expect(screen.getByText('Limit to 5 results')).toBeInTheDocument();
- userEvent.click(screen.getByText('Add Widget'));
- await waitFor(() =>
- expect(handleSave).toHaveBeenCalledWith([
- expect.objectContaining({
- limit: 5,
- }),
- ])
- );
- });
- it('update value', async function () {
- renderTestComponent({
- query: {displayType: 'line'},
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- userEvent.click(screen.getByText('Limit to 5 results'));
- userEvent.click(screen.getByText('Limit to 2 results'));
- await waitFor(() =>
- expect(eventsStatsMock).toHaveBeenCalledWith(
- '/organizations/org-slug/events-stats/',
- expect.objectContaining({
- query: expect.objectContaining({
- query: '',
- yAxis: ['count()'],
- field: ['project', 'count()'],
- topEvents: 2,
- orderby: '-count()',
- }),
- })
- )
- );
- });
- it('gets removed if no groupBy value', async function () {
- renderTestComponent({
- query: {displayType: 'line'},
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- expect(screen.getByText('Limit to 5 results')).toBeInTheDocument();
- userEvent.click(screen.getByLabelText('Remove group'));
- await waitFor(() =>
- expect(screen.queryByText('Limit to 5 results')).not.toBeInTheDocument()
- );
- });
- it('applies a limit when switching from a table to timeseries chart with grouping', async function () {
- const widget: Widget = {
- displayType: DisplayType.TABLE,
- interval: '1d',
- queries: [
- {
- name: 'Test Widget',
- fields: ['count()', 'count_unique(user)', 'epm()', 'project'],
- columns: ['project'],
- aggregates: ['count()', 'count_unique(user)', 'epm()'],
- conditions: '',
- orderby: '',
- },
- ],
- title: 'Transactions',
- id: '1',
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({
- dashboard,
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- params: {
- widgetIndex: '0',
- },
- });
- userEvent.click(await screen.findByText('Table'));
- userEvent.click(screen.getByText('Line Chart'));
- expect(screen.getByText('Limit to 3 results')).toBeInTheDocument();
- expect(eventsStatsMock).toHaveBeenCalledWith(
- '/organizations/org-slug/events-stats/',
- expect.objectContaining({
- query: expect.objectContaining({
- topEvents: 3,
- }),
- })
- );
- });
- it('persists the limit when switching between timeseries charts', async function () {
- const widget: Widget = {
- displayType: DisplayType.AREA,
- interval: '1d',
- queries: [
- {
- name: 'Test Widget',
- fields: ['count()', 'count_unique(user)', 'epm()', 'project'],
- columns: ['project'],
- aggregates: ['count()', 'count_unique(user)', 'epm()'],
- conditions: '',
- orderby: '',
- },
- ],
- title: 'Transactions',
- id: '1',
- limit: 1,
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({
- dashboard,
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- params: {
- widgetIndex: '0',
- },
- });
- userEvent.click(await screen.findByText('Area Chart'));
- userEvent.click(screen.getByText('Line Chart'));
- expect(screen.getByText('Limit to 1 result')).toBeInTheDocument();
- expect(eventsStatsMock).toHaveBeenCalledWith(
- '/organizations/org-slug/events-stats/',
- expect.objectContaining({
- query: expect.objectContaining({
- topEvents: 1,
- }),
- })
- );
- });
- it('unsets the limit when going from timeseries to table', async function () {
- const widget: Widget = {
- displayType: DisplayType.AREA,
- interval: '1d',
- queries: [
- {
- name: 'Test Widget',
- fields: ['count()', 'count_unique(user)', 'epm()', 'project'],
- columns: ['project'],
- aggregates: ['count()', 'count_unique(user)', 'epm()'],
- conditions: '',
- orderby: '',
- },
- ],
- title: 'Transactions',
- id: '1',
- limit: 1,
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({
- dashboard,
- orgFeatures: [...defaultOrgFeatures, 'new-widget-builder-experience-design'],
- params: {
- widgetIndex: '0',
- },
- });
- userEvent.click(await screen.findByText('Area Chart'));
- userEvent.click(screen.getByText('Table'));
- expect(screen.queryByText('Limit to 1 result')).not.toBeInTheDocument();
- expect(eventsv2Mock).toHaveBeenCalledWith(
- '/organizations/org-slug/eventsv2/',
- expect.objectContaining({
- query: expect.objectContaining({
- topEvents: undefined,
- }),
- })
- );
- });
- });
- });
- describe('with events', function () {
- it('should properly query for table fields', async function () {
- const defaultWidgetQuery = {
- name: '',
- fields: ['title', 'count()'],
- columns: ['title'],
- aggregates: ['count()'],
- conditions: '',
- orderby: '',
- };
- const defaultTableColumns = ['title', 'count()', 'count_unique(user)', 'epm()'];
- renderTestComponent({
- query: {
- source: DashboardWidgetSource.DISCOVERV2,
- defaultWidgetQuery: urlEncode(defaultWidgetQuery),
- displayType: DisplayType.LINE,
- defaultTableColumns,
- },
- orgFeatures: [...defaultOrgFeatures, 'discover-frontend-use-events-endpoint'],
- });
- expect(await screen.findByText('Line Chart')).toBeInTheDocument();
- userEvent.click(screen.getByText('Line Chart'));
- userEvent.click(screen.getByText('Table'));
- await waitFor(() => {
- expect(eventsMock).toHaveBeenLastCalledWith(
- '/organizations/org-slug/events/',
- expect.objectContaining({
- query: expect.objectContaining({
- field: defaultTableColumns,
- }),
- })
- );
- });
- });
- describe('Sort by selectors', function () {
- it('ordering by column uses field form when selecting orderby', async function () {
- const widget: Widget = {
- id: '1',
- title: 'Test Widget',
- interval: '5m',
- displayType: DisplayType.TABLE,
- queries: [
- {
- name: 'errors',
- conditions: 'event.type:error',
- fields: ['count()'],
- aggregates: ['count()'],
- columns: ['project'],
- orderby: '-project',
- },
- ],
- };
- const dashboard = mockDashboard({widgets: [widget]});
- renderTestComponent({
- orgFeatures: [
- ...defaultOrgFeatures,
- 'new-widget-builder-experience-design',
- 'discover-frontend-use-events-endpoint',
- ],
- dashboard,
- params: {
- widgetIndex: '0',
- },
- });
- await waitFor(async () => {
- expect(await screen.findAllByText('project')).toHaveLength(3);
- });
- await selectEvent.select(screen.getAllByText('project')[2], 'count()');
- await waitFor(() => {
- expect(eventsMock).toHaveBeenCalledWith(
- '/organizations/org-slug/events/',
- expect.objectContaining({
- query: expect.objectContaining({
- sort: ['-count()'],
- }),
- })
- );
- });
- });
- it('hides Custom Equation input and resets orderby when switching to table', async function () {
- renderTestComponent({
- orgFeatures: [
- ...defaultOrgFeatures,
- 'new-widget-builder-experience-design',
- 'discover-frontend-use-events-endpoint',
- ],
- query: {
- source: DashboardWidgetSource.DASHBOARDS,
- displayType: DisplayType.LINE,
- },
- });
- await selectEvent.select(await screen.findByText('Select group'), 'project');
- expect(screen.getAllByText('count()')).toHaveLength(2);
- await selectEvent.select(screen.getAllByText('count()')[1], 'Custom Equation');
- userEvent.paste(
- screen.getByPlaceholderText('Enter Equation'),
- 'count_unique(user) * 2'
- );
- userEvent.keyboard('{enter}');
- // Switch the display type to Table
- userEvent.click(screen.getByText('Line Chart'));
- userEvent.click(screen.getByText('Table'));
- expect(screen.getAllByText('count()')).toHaveLength(2);
- expect(screen.queryByPlaceholderText('Enter Equation')).not.toBeInTheDocument();
- await waitFor(() => {
- expect(eventsMock).toHaveBeenCalledWith(
- '/organizations/org-slug/events/',
- expect.objectContaining({
- query: expect.objectContaining({
- sort: ['-count()'],
- }),
- })
- );
- });
- });
- });
- describe('Widget creation coming from other verticals', function () {
- it('shows the correct orderby when switching from a line chart to table', async function () {
- const defaultWidgetQuery = {
- name: '',
- fields: ['count_unique(user)'],
- columns: [],
- aggregates: ['count_unique(user)'],
- conditions: '',
- orderby: 'count_unique(user)',
- };
- const defaultTableColumns = ['title', 'count_unique(user)'];
- renderTestComponent({
- orgFeatures: [
- ...defaultOrgFeatures,
- 'new-widget-builder-experience-design',
- 'discover-frontend-use-events-endpoint',
- ],
- query: {
- source: DashboardWidgetSource.DISCOVERV2,
- defaultWidgetQuery: urlEncode(defaultWidgetQuery),
- displayType: DisplayType.LINE,
- defaultTableColumns,
- },
- });
- userEvent.click(await screen.findByText('Line Chart'));
- userEvent.click(screen.getByText('Table'));
- expect(screen.getByText('count_unique(user)')).toBeInTheDocument();
- await waitFor(() => {
- expect(eventsMock).toHaveBeenLastCalledWith(
- '/organizations/org-slug/events/',
- expect.objectContaining({
- query: expect.objectContaining({
- field: defaultTableColumns,
- sort: ['count_unique(user)'],
- }),
- })
- );
- });
- });
- });
- describe('Custom Performance Metrics', function () {
- it('can choose a custom measurement', async function () {
- measurementsMetaMock = MockApiClient.addMockResponse({
- url: '/organizations/org-slug/measurements-meta/',
- method: 'GET',
- body: {'measurements.custom.measurement': {functions: ['p99']}},
- });
- eventsMock = MockApiClient.addMockResponse({
- url: '/organizations/org-slug/events/',
- method: 'GET',
- statusCode: 200,
- body: {
- meta: {
- fields: {'p99(measurements.total.db.calls)': 'duration'},
- isMetricsData: true,
- },
- data: [{'p99(measurements.total.db.calls)': 10}],
- },
- });
- const {router} = renderTestComponent({
- query: {source: DashboardWidgetSource.DISCOVERV2},
- dashboard: testDashboard,
- orgFeatures: [...defaultOrgFeatures, 'discover-frontend-use-events-endpoint'],
- });
- expect(await screen.findAllByText('Custom Widget')).toHaveLength(2);
- // 1 in the table header, 1 in the column selector, 1 in the sort field
- const countFields = screen.getAllByText('count()');
- expect(countFields).toHaveLength(3);
- await selectEvent.select(countFields[1], ['p99(…)']);
- await selectEvent.select(screen.getByText('transaction.duration'), [
- 'measurements.custom.measurement',
- ]);
- userEvent.click(screen.getByText('Add Widget'));
- await waitFor(() => {
- expect(router.push).toHaveBeenCalledWith(
- expect.objectContaining({
- pathname: '/organizations/org-slug/dashboard/2/',
- query: {
- displayType: 'table',
- interval: '5m',
- title: 'Custom Widget',
- queryNames: [''],
- queryConditions: [''],
- queryFields: ['p99(measurements.custom.measurement)'],
- queryOrderby: '-p99(measurements.custom.measurement)',
- start: null,
- end: null,
- statsPeriod: '24h',
- utc: null,
- project: [],
- environment: [],
- },
- })
- );
- });
- });
- it('raises an alert banner and disables saving widget if widget result is not metrics data and widget is using custom measurements', async function () {
- eventsMock = MockApiClient.addMockResponse({
- url: '/organizations/org-slug/events/',
- method: 'GET',
- statusCode: 200,
- body: {
- meta: {
- fields: {'p99(measurements.custom.measurement)': 'duration'},
- isMetricsData: false,
- },
- data: [{'p99(measurements.custom.measurement)': 10}],
- },
- });
- const defaultWidgetQuery = {
- name: '',
- fields: ['p99(measurements.custom.measurement)'],
- columns: [],
- aggregates: ['p99(measurements.custom.measurement)'],
- conditions: 'user:test.user@sentry.io',
- orderby: '',
- };
- const defaultTableColumns = ['p99(measurements.custom.measurement)'];
- renderTestComponent({
- query: {
- source: DashboardWidgetSource.DISCOVERV2,
- defaultWidgetQuery: urlEncode(defaultWidgetQuery),
- displayType: DisplayType.TABLE,
- defaultTableColumns,
- },
- orgFeatures: [
- ...defaultOrgFeatures,
- 'discover-frontend-use-events-endpoint',
- 'dashboards-mep',
- ],
- });
- await waitFor(() => {
- expect(measurementsMetaMock).toHaveBeenCalled();
- });
- await waitFor(() => {
- expect(eventsMock).toHaveBeenCalled();
- });
- screen.getByText('You have inputs that are incompatible with');
- expect(screen.getByText('Add Widget').closest('button')).toBeDisabled();
- });
- it('raises an alert banner if widget result is not metrics data', async function () {
- eventsMock = MockApiClient.addMockResponse({
- url: '/organizations/org-slug/events/',
- method: 'GET',
- statusCode: 200,
- body: {
- meta: {
- fields: {'p99(measurements.lcp)': 'duration'},
- isMetricsData: false,
- },
- data: [{'p99(measurements.lcp)': 10}],
- },
- });
- const defaultWidgetQuery = {
- name: '',
- fields: ['p99(measurements.lcp)'],
- columns: [],
- aggregates: ['p99(measurements.lcp)'],
- conditions: 'user:test.user@sentry.io',
- orderby: '',
- };
- const defaultTableColumns = ['p99(measurements.lcp)'];
- renderTestComponent({
- query: {
- source: DashboardWidgetSource.DISCOVERV2,
- defaultWidgetQuery: urlEncode(defaultWidgetQuery),
- displayType: DisplayType.TABLE,
- defaultTableColumns,
- },
- orgFeatures: [
- ...defaultOrgFeatures,
- 'discover-frontend-use-events-endpoint',
- 'dashboards-mep',
- ],
- });
- await waitFor(() => {
- expect(measurementsMetaMock).toHaveBeenCalled();
- });
- await waitFor(() => {
- expect(eventsMock).toHaveBeenCalled();
- });
- screen.getByText('Your selection is only applicable to');
- });
- it('does not raise an alert banner if widget result is not metrics data but widget contains error fields', async function () {
- eventsMock = MockApiClient.addMockResponse({
- url: '/organizations/org-slug/events/',
- method: 'GET',
- statusCode: 200,
- body: {
- meta: {
- fields: {'p99(measurements.lcp)': 'duration'},
- isMetricsData: false,
- },
- data: [{'p99(measurements.lcp)': 10}],
- },
- });
- const defaultWidgetQuery = {
- name: '',
- fields: ['p99(measurements.lcp)'],
- columns: ['error.handled'],
- aggregates: ['p99(measurements.lcp)'],
- conditions: 'user:test.user@sentry.io',
- orderby: '',
- };
- const defaultTableColumns = ['p99(measurements.lcp)'];
- renderTestComponent({
- query: {
- source: DashboardWidgetSource.DISCOVERV2,
- defaultWidgetQuery: urlEncode(defaultWidgetQuery),
- displayType: DisplayType.TABLE,
- defaultTableColumns,
- },
- orgFeatures: [
- ...defaultOrgFeatures,
- 'discover-frontend-use-events-endpoint',
- 'dashboards-mep',
- ],
- });
- await waitFor(() => {
- expect(measurementsMetaMock).toHaveBeenCalled();
- });
- await waitFor(() => {
- expect(eventsMock).toHaveBeenCalled();
- });
- expect(
- screen.queryByText('Your selection is only applicable to')
- ).not.toBeInTheDocument();
- });
- it('only displays custom measurements in supported functions', async function () {
- measurementsMetaMock = MockApiClient.addMockResponse({
- url: '/organizations/org-slug/measurements-meta/',
- method: 'GET',
- body: {
- 'measurements.custom.measurement': {functions: ['p99']},
- 'measurements.another.custom.measurement': {functions: ['p95']},
- },
- });
- renderTestComponent({
- query: {source: DashboardWidgetSource.DISCOVERV2},
- dashboard: testDashboard,
- orgFeatures: [...defaultOrgFeatures, 'discover-frontend-use-events-endpoint'],
- });
- expect(await screen.findAllByText('Custom Widget')).toHaveLength(2);
- await selectEvent.select(screen.getAllByText('count()')[1], ['p99(…)']);
- userEvent.click(screen.getByText('transaction.duration'));
- screen.getByText('measurements.custom.measurement');
- expect(
- screen.queryByText('measurements.another.custom.measurement')
- ).not.toBeInTheDocument();
- await selectEvent.select(screen.getAllByText('p99(…)')[0], ['p95(…)']);
- userEvent.click(screen.getByText('transaction.duration'));
- screen.getByText('measurements.another.custom.measurement');
- expect(
- screen.queryByText('measurements.custom.measurement')
- ).not.toBeInTheDocument();
- });
- it('renders custom performance metric using duration units from events meta', async function () {
- eventsMock = MockApiClient.addMockResponse({
- url: '/organizations/org-slug/events/',
- method: 'GET',
- statusCode: 200,
- body: {
- meta: {
- fields: {'p99(measurements.custom.measurement)': 'duration'},
- isMetricsData: true,
- units: {'p99(measurements.custom.measurement)': 'hour'},
- },
- data: [{'p99(measurements.custom.measurement)': 12}],
- },
- });
- renderTestComponent({
- query: {source: DashboardWidgetSource.DISCOVERV2},
- dashboard: {
- ...testDashboard,
- widgets: [
- {
- title: 'Custom Measurement Widget',
- interval: '1d',
- id: '1',
- widgetType: WidgetType.DISCOVER,
- displayType: DisplayType.TABLE,
- queries: [
- {
- conditions: '',
- name: '',
- fields: ['p99(measurements.custom.measurement)'],
- columns: [],
- aggregates: ['p99(measurements.custom.measurement)'],
- orderby: '-p99(measurements.custom.measurement)',
- },
- ],
- },
- ],
- },
- params: {
- widgetIndex: '0',
- },
- orgFeatures: [...defaultOrgFeatures, 'discover-frontend-use-events-endpoint'],
- });
- await screen.findByText('12.00hr');
- });
- it('renders custom performance metric using size units from events meta', async function () {
- eventsMock = MockApiClient.addMockResponse({
- url: '/organizations/org-slug/events/',
- method: 'GET',
- statusCode: 200,
- body: {
- meta: {
- fields: {'p99(measurements.custom.measurement)': 'size'},
- isMetricsData: true,
- units: {'p99(measurements.custom.measurement)': 'kibibyte'},
- },
- data: [{'p99(measurements.custom.measurement)': 12}],
- },
- });
- renderTestComponent({
- query: {source: DashboardWidgetSource.DISCOVERV2},
- dashboard: {
- ...testDashboard,
- widgets: [
- {
- title: 'Custom Measurement Widget',
- interval: '1d',
- id: '1',
- widgetType: WidgetType.DISCOVER,
- displayType: DisplayType.TABLE,
- queries: [
- {
- conditions: '',
- name: '',
- fields: ['p99(measurements.custom.measurement)'],
- columns: [],
- aggregates: ['p99(measurements.custom.measurement)'],
- orderby: '-p99(measurements.custom.measurement)',
- },
- ],
- },
- ],
- },
- params: {
- widgetIndex: '0',
- },
- orgFeatures: [...defaultOrgFeatures, 'discover-frontend-use-events-endpoint'],
- });
- await screen.findByText('12.0 KiB');
- });
- it('displays custom performance metric in column select', async function () {
- renderTestComponent({
- query: {source: DashboardWidgetSource.DISCOVERV2},
- dashboard: {
- ...testDashboard,
- widgets: [
- {
- title: 'Custom Measurement Widget',
- interval: '1d',
- id: '1',
- widgetType: WidgetType.DISCOVER,
- displayType: DisplayType.TABLE,
- queries: [
- {
- conditions: '',
- name: '',
- fields: ['p99(measurements.custom.measurement)'],
- columns: [],
- aggregates: ['p99(measurements.custom.measurement)'],
- orderby: '-p99(measurements.custom.measurement)',
- },
- ],
- },
- ],
- },
- params: {
- widgetIndex: '0',
- },
- orgFeatures: [...defaultOrgFeatures, 'discover-frontend-use-events-endpoint'],
- });
- await screen.findByText('measurements.custom.measurement');
- });
- });
- });
- });
|