@backstage/test-utils 0.1.17 → 0.1.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,51 @@
1
1
  # @backstage/test-utils
2
2
 
3
+ ## 0.1.21
4
+
5
+ ### Patch Changes
6
+
7
+ - 71fd5cd735: Update Keyboard deprecation with a link to the recommended successor
8
+ - Updated dependencies
9
+ - @backstage/theme@0.2.13
10
+ - @backstage/core-plugin-api@0.1.13
11
+ - @backstage/core-app-api@0.1.20
12
+
13
+ ## 0.1.20
14
+
15
+ ### Patch Changes
16
+
17
+ - bb12aae352: Migrates all utility methods from `test-utils-core` into `test-utils` and delete exports from the old package.
18
+ This should have no impact since this package is considered internal and have no usages outside core packages.
19
+
20
+ Notable changes are that the testing tool `msw.setupDefaultHandlers()` have been deprecated in favour of `setupRequestMockHandlers()`.
21
+
22
+ - c5bb1df55d: Bump `msw` to `v0.35.0` to resolve [CVE-2021-32796](https://github.com/advisories/GHSA-5fg8-2547-mr8q).
23
+ - 10615525f3: Switch to use the json and observable types from `@backstage/types`
24
+ - Updated dependencies
25
+ - @backstage/theme@0.2.12
26
+ - @backstage/core-app-api@0.1.19
27
+ - @backstage/core-plugin-api@0.1.12
28
+
29
+ ## 0.1.19
30
+
31
+ ### Patch Changes
32
+
33
+ - 54bbe25c34: Store the namespaced bucket storage for each instance that was created with `MockStorage.create()` instead of global variable.
34
+ - Updated dependencies
35
+ - @backstage/core-app-api@0.1.17
36
+ - @backstage/theme@0.2.11
37
+
38
+ ## 0.1.18
39
+
40
+ ### Patch Changes
41
+
42
+ - e749a38e89: Added a mock implementation of the `AnalyticsApi`, which can be used to make
43
+ assertions about captured analytics events.
44
+ - Updated dependencies
45
+ - @backstage/core-plugin-api@0.1.10
46
+ - @backstage/core-app-api@0.1.16
47
+ - @backstage/test-utils-core@0.1.3
48
+
3
49
  ## 0.1.17
4
50
 
5
51
  ### Patch Changes
package/dist/index.d.ts CHANGED
@@ -1,20 +1,44 @@
1
- import { ErrorApi, ErrorContext, Observable, StorageApi, StorageValueChange, RouteRef, ExternalRouteRef } from '@backstage/core-plugin-api';
1
+ import { AnalyticsApi, AnalyticsEvent, ErrorContext, ErrorApi, StorageApi, StorageValueChange, RouteRef, ExternalRouteRef } from '@backstage/core-plugin-api';
2
+ import { Observable } from '@backstage/types';
2
3
  import { ComponentType, ReactNode, ReactElement } from 'react';
3
4
  import { RenderResult } from '@testing-library/react';
4
- export * from '@backstage/test-utils-core';
5
5
 
6
- declare type Options = {
6
+ /**
7
+ * Mock implementation of {@link core-plugin-api#AnalyticsApi} with helpers to ensure that events are sent correctly.
8
+ * Use getEvents in tests to verify captured events.
9
+ * @public
10
+ */
11
+ declare class MockAnalyticsApi implements AnalyticsApi {
12
+ private events;
13
+ captureEvent({ action, subject, value, attributes, context, }: AnalyticsEvent): void;
14
+ getEvents(): AnalyticsEvent[];
15
+ }
16
+
17
+ /**
18
+ * Constructor arguments for {@link MockErrorApi}
19
+ * @public
20
+ */
21
+ declare type MockErrorApiOptions = {
7
22
  collect?: boolean;
8
23
  };
24
+ /**
25
+ * ErrorWithContext contains error and ErrorContext
26
+ * @public
27
+ */
9
28
  declare type ErrorWithContext = {
10
29
  error: Error;
11
30
  context?: ErrorContext;
12
31
  };
32
+ /**
33
+ * Mock implementation of the {@link core-plugin-api#ErrorApi} to be used in tests.
34
+ * Incudes withForError and getErrors methods for error testing.
35
+ * @public
36
+ */
13
37
  declare class MockErrorApi implements ErrorApi {
14
38
  private readonly options;
15
39
  private readonly errors;
16
40
  private readonly waiters;
17
- constructor(options?: Options);
41
+ constructor(options?: MockErrorApiOptions);
18
42
  post(error: Error, context?: ErrorContext): void;
19
43
  error$(): Observable<{
20
44
  error: Error;
@@ -24,12 +48,21 @@ declare class MockErrorApi implements ErrorApi {
24
48
  waitForError(pattern: RegExp, timeoutMs?: number): Promise<ErrorWithContext>;
25
49
  }
26
50
 
51
+ /**
52
+ * Type for map holding data in {@link MockStorageApi}
53
+ * @public
54
+ */
27
55
  declare type MockStorageBucket = {
28
56
  [key: string]: any;
29
57
  };
58
+ /**
59
+ * Mock implementation of the {@link core-plugin-api#StorageApi} to be used in tests
60
+ * @public
61
+ */
30
62
  declare class MockStorageApi implements StorageApi {
31
63
  private readonly namespace;
32
64
  private readonly data;
65
+ private readonly bucketStorageApis;
33
66
  private constructor();
34
67
  static create(data?: MockStorageBucket): MockStorageApi;
35
68
  forBucket(name: string): StorageApi;
@@ -53,7 +86,7 @@ declare class MockStorageApi implements StorageApi {
53
86
  * If there are any updates from MUI React on testing `useMediaQuery` this mock should be replaced
54
87
  * https://material-ui.com/components/use-media-query/#testing
55
88
  *
56
- * @param matchMediaOptions
89
+ * @public
57
90
  */
58
91
  declare function mockBreakpoint({ matches }: {
59
92
  matches?: boolean | undefined;
@@ -61,6 +94,7 @@ declare function mockBreakpoint({ matches }: {
61
94
 
62
95
  /**
63
96
  * Options to customize the behavior of the test app wrapper.
97
+ * @public
64
98
  */
65
99
  declare type TestAppOptions = {
66
100
  /**
@@ -73,11 +107,11 @@ declare type TestAppOptions = {
73
107
  * used by `useRouteRef` in the rendered elements.
74
108
  *
75
109
  * @example
76
- * wrapInTestApp(<MyComponent />, {
77
- * mountedRoutes: {
110
+ * wrapInTestApp(<MyComponent />, \{
111
+ * mountedRoutes: \{
78
112
  * '/my-path': myRouteRef,
79
- * }
80
- * })
113
+ * \}
114
+ * \})
81
115
  * // ...
82
116
  * const link = useRouteRef(myRouteRef)
83
117
  */
@@ -91,6 +125,7 @@ declare type TestAppOptions = {
91
125
  *
92
126
  * @param Component - A component or react node to render inside the test app.
93
127
  * @param options - Additional options for the rendering.
128
+ * @public
94
129
  */
95
130
  declare function wrapInTestApp(Component: ComponentType | ReactNode, options?: TestAppOptions): ReactElement;
96
131
  /**
@@ -102,9 +137,14 @@ declare function wrapInTestApp(Component: ComponentType | ReactNode, options?: T
102
137
  *
103
138
  * @param Component - A component or react node to render inside the test app.
104
139
  * @param options - Additional options for the rendering.
140
+ * @public
105
141
  */
106
142
  declare function renderInTestApp(Component: ComponentType | ReactNode, options?: TestAppOptions): Promise<RenderResult>;
107
143
 
144
+ /**
145
+ * @deprecated use {@link setupRequestMockHandlers} instead which can be called directly with the worker.
146
+ * @public
147
+ */
108
148
  declare const msw: {
109
149
  setupDefaultHandlers: (worker: {
110
150
  listen: (t: any) => void;
@@ -112,5 +152,96 @@ declare const msw: {
112
152
  resetHandlers: () => void;
113
153
  }) => void;
114
154
  };
155
+ /**
156
+ * Sets up handlers for request mocking
157
+ * @public
158
+ * @param worker - service worker
159
+ */
160
+ declare function setupRequestMockHandlers(worker: {
161
+ listen: (t: any) => void;
162
+ close: () => void;
163
+ resetHandlers: () => void;
164
+ }): void;
165
+
166
+ /**
167
+ * @public
168
+ * @deprecated superseded by {@link @testing-library/user-event#userEvent}
169
+ */
170
+ declare class Keyboard {
171
+ static type(target: any, input: any): Promise<void>;
172
+ static typeDebug(target: any, input: any): Promise<void>;
173
+ static toReadableInput(chars: any): any;
174
+ static fromReadableInput(input: any): any;
175
+ constructor(target: any, { debug }?: {
176
+ debug?: boolean | undefined;
177
+ });
178
+ debug: boolean;
179
+ document: any;
180
+ toString(): string;
181
+ _log(message: any, ...args: any[]): void;
182
+ _pretty(element: any): string;
183
+ get focused(): any;
184
+ type(input: any): Promise<void>;
185
+ send(chars: any): Promise<void>;
186
+ click(): Promise<void>;
187
+ tab(): Promise<void>;
188
+ enter(value: any): Promise<void>;
189
+ escape(): Promise<void>;
190
+ _sendKey(key: any, charCode: any, action: any): Promise<void>;
191
+ }
192
+
193
+ /**
194
+ * Severity levels of {@link CollectedLogs}
195
+ * @public */
196
+ declare type LogFuncs = 'log' | 'warn' | 'error';
197
+ /**
198
+ * AsyncLogCollector type used in {@link (withLogCollector:1)} callback function.
199
+ * @public */
200
+ declare type AsyncLogCollector = () => Promise<void>;
201
+ /**
202
+ * SyncLogCollector type used in {@link (withLogCollector:2)} callback function.
203
+ * @public */
204
+ declare type SyncLogCollector = () => void;
205
+ /**
206
+ * Union type used in {@link (withLogCollector:3)} callback function.
207
+ * @public */
208
+ declare type LogCollector = AsyncLogCollector | SyncLogCollector;
209
+ /**
210
+ * Map of severity level and corresponding log lines.
211
+ * @public */
212
+ declare type CollectedLogs<T extends LogFuncs> = {
213
+ [key in T]: string[];
214
+ };
215
+ /**
216
+ * Asynchronous log collector with that collects all categories
217
+ * @public */
218
+ declare function withLogCollector(callback: AsyncLogCollector): Promise<CollectedLogs<LogFuncs>>;
219
+ /**
220
+ * Synchronous log collector with that collects all categories
221
+ * @public */
222
+ declare function withLogCollector(callback: SyncLogCollector): CollectedLogs<LogFuncs>;
223
+ /**
224
+ * Asynchronous log collector with that only collects selected categories
225
+ * @public
226
+ */
227
+ declare function withLogCollector<T extends LogFuncs>(logsToCollect: T[], callback: AsyncLogCollector): Promise<CollectedLogs<T>>;
228
+ /**
229
+ * Synchronous log collector with that only collects selected categories
230
+ * @public */
231
+ declare function withLogCollector<T extends LogFuncs>(logsToCollect: T[], callback: SyncLogCollector): CollectedLogs<T>;
232
+
233
+ /**
234
+ * @public
235
+ * Simplifies rendering of async components in by taking care of the wrapping inside act
236
+ *
237
+ * @remarks
238
+ *
239
+ * Components using useEffect to perform an asynchronous action (such as fetch) must be rendered within an async
240
+ * act call to properly get the final state, even with mocked responses. This utility method makes the signature a bit
241
+ * cleaner, since act doesn't return the result of the evaluated function.
242
+ * https://github.com/testing-library/react-testing-library/issues/281
243
+ * https://github.com/facebook/react/pull/14853
244
+ */
245
+ declare function renderWithEffects(nodes: ReactElement): Promise<RenderResult>;
115
246
 
116
- export { MockErrorApi, MockStorageApi, MockStorageBucket, mockBreakpoint, msw, renderInTestApp, wrapInTestApp };
247
+ export { AsyncLogCollector, CollectedLogs, ErrorWithContext, Keyboard, LogCollector, LogFuncs, MockAnalyticsApi, MockErrorApi, MockErrorApiOptions, MockStorageApi, MockStorageBucket, SyncLogCollector, TestAppOptions, mockBreakpoint, msw, renderInTestApp, renderWithEffects, setupRequestMockHandlers, withLogCollector, wrapInTestApp };
package/dist/index.esm.js CHANGED
@@ -5,8 +5,32 @@ import { Route } from 'react-router-dom';
5
5
  import { lightTheme } from '@backstage/theme';
6
6
  import { createApp } from '@backstage/core-app-api';
7
7
  import { createApiFactory, errorApiRef, storageApiRef, createRouteRef, attachComponentData } from '@backstage/core-plugin-api';
8
- import { renderWithEffects } from '@backstage/test-utils-core';
9
- export * from '@backstage/test-utils-core';
8
+ import { act } from 'react-dom/test-utils';
9
+ import { render, fireEvent, act as act$1 } from '@testing-library/react';
10
+
11
+ class MockAnalyticsApi {
12
+ constructor() {
13
+ this.events = [];
14
+ }
15
+ captureEvent({
16
+ action,
17
+ subject,
18
+ value,
19
+ attributes,
20
+ context
21
+ }) {
22
+ this.events.push({
23
+ action,
24
+ subject,
25
+ context,
26
+ ...value !== void 0 ? {value} : {},
27
+ ...attributes !== void 0 ? {attributes} : {}
28
+ });
29
+ }
30
+ getEvents() {
31
+ return this.events;
32
+ }
33
+ }
10
34
 
11
35
  const nullObservable = {
12
36
  subscribe: () => ({unsubscribe: () => {
@@ -50,9 +74,8 @@ class MockErrorApi {
50
74
  }
51
75
  }
52
76
 
53
- const bucketStorageApis = new Map();
54
77
  class MockStorageApi {
55
- constructor(namespace, data) {
78
+ constructor(namespace, bucketStorageApis, data) {
56
79
  this.subscribers = new Set();
57
80
  this.observable = new ObservableImpl((subscriber) => {
58
81
  this.subscribers.add(subscriber);
@@ -61,16 +84,17 @@ class MockStorageApi {
61
84
  };
62
85
  });
63
86
  this.namespace = namespace;
87
+ this.bucketStorageApis = bucketStorageApis;
64
88
  this.data = {...data};
65
89
  }
66
90
  static create(data) {
67
- return new MockStorageApi("", data);
91
+ return new MockStorageApi("", new Map(), data);
68
92
  }
69
93
  forBucket(name) {
70
- if (!bucketStorageApis.has(name)) {
71
- bucketStorageApis.set(name, new MockStorageApi(`${this.namespace}/${name}`, this.data));
94
+ if (!this.bucketStorageApis.has(name)) {
95
+ this.bucketStorageApis.set(name, new MockStorageApi(`${this.namespace}/${name}`, this.bucketStorageApis, this.data));
72
96
  }
73
- return bucketStorageApis.get(name);
97
+ return this.bucketStorageApis.get(name);
74
98
  }
75
99
  get(key) {
76
100
  return this.data[this.getKeyName(key)];
@@ -112,6 +136,14 @@ function mockBreakpoint({matches = false}) {
112
136
  });
113
137
  }
114
138
 
139
+ async function renderWithEffects(nodes) {
140
+ let value;
141
+ await act(async () => {
142
+ value = render(nodes);
143
+ });
144
+ return value;
145
+ }
146
+
115
147
  const mockApis = [
116
148
  createApiFactory(errorApiRef, new MockErrorApi()),
117
149
  createApiFactory(storageApiRef, MockStorageApi.create())
@@ -200,11 +232,225 @@ async function renderInTestApp(Component, options = {}) {
200
232
 
201
233
  const msw = {
202
234
  setupDefaultHandlers: (worker) => {
203
- beforeAll(() => worker.listen({onUnhandledRequest: "error"}));
204
- afterAll(() => worker.close());
205
- afterEach(() => worker.resetHandlers());
235
+ setupRequestMockHandlers(worker);
206
236
  }
207
237
  };
238
+ function setupRequestMockHandlers(worker) {
239
+ beforeAll(() => worker.listen({onUnhandledRequest: "error"}));
240
+ afterAll(() => worker.close());
241
+ afterEach(() => worker.resetHandlers());
242
+ }
243
+
244
+ const codes = {
245
+ Tab: 9,
246
+ Enter: 10,
247
+ Click: 17,
248
+ Esc: 27
249
+ };
250
+ class Keyboard {
251
+ static async type(target, input) {
252
+ await new Keyboard(target).type(input);
253
+ }
254
+ static async typeDebug(target, input) {
255
+ await new Keyboard(target, {debug: true}).type(input);
256
+ }
257
+ static toReadableInput(chars) {
258
+ return chars.split("").map((char) => {
259
+ switch (char.charCodeAt(0)) {
260
+ case codes.Tab:
261
+ return "<Tab>";
262
+ case codes.Enter:
263
+ return "<Enter>";
264
+ case codes.Click:
265
+ return "<Click>";
266
+ case codes.Esc:
267
+ return "<Esc>";
268
+ default:
269
+ return char;
270
+ }
271
+ });
272
+ }
273
+ static fromReadableInput(input) {
274
+ return input.trim().replace(/\s*<([a-zA-Z]+)>\s*/g, (match, name) => {
275
+ if (name in codes) {
276
+ return String.fromCharCode(codes[name]);
277
+ }
278
+ throw new Error(`Unknown char name: '${name}'`);
279
+ });
280
+ }
281
+ constructor(target, {debug = false} = {}) {
282
+ this.debug = debug;
283
+ if (target.ownerDocument) {
284
+ this.document = target.ownerDocument;
285
+ } else if (target.baseElement) {
286
+ this.document = target.baseElement.ownerDocument;
287
+ } else {
288
+ throw new TypeError("Keyboard(target): target must be DOM node or react-testing-library render() output");
289
+ }
290
+ }
291
+ toString() {
292
+ return `Keyboard{document=${this.document}, debug=${this.debug}}`;
293
+ }
294
+ _log(message, ...args) {
295
+ if (this.debug) {
296
+ console.log(`[Keyboard] ${message}`, ...args);
297
+ }
298
+ }
299
+ _pretty(element) {
300
+ const attrs = [...element.attributes].map((attr) => `${attr.name}="${attr.value}"`).join(" ");
301
+ return `<${element.nodeName.toLocaleLowerCase("en-US")} ${attrs}>`;
302
+ }
303
+ get focused() {
304
+ return this.document.activeElement;
305
+ }
306
+ async type(input) {
307
+ this._log(`sending sequence '${input}' with initial focus ${this._pretty(this.focused)}`);
308
+ await this.send(Keyboard.fromReadableInput(input));
309
+ }
310
+ async send(chars) {
311
+ for (const key of chars.split("")) {
312
+ const charCode = key.charCodeAt(0);
313
+ if (charCode === codes.Tab) {
314
+ await this.tab();
315
+ continue;
316
+ }
317
+ const focused = this.focused;
318
+ if (!focused || focused === this.document.body) {
319
+ throw Error(`No element focused in document while trying to type '${Keyboard.toReadableInput(chars)}'`);
320
+ }
321
+ const nextValue = (focused.value || "") + key;
322
+ if (charCode >= 32) {
323
+ await this._sendKey(key, charCode, () => {
324
+ this._log(`sending +${key} = '${nextValue}' to ${this._pretty(focused)}`);
325
+ fireEvent.change(focused, {
326
+ target: {value: nextValue},
327
+ bubbles: true,
328
+ cancelable: true
329
+ });
330
+ });
331
+ } else if (charCode === codes.Enter) {
332
+ await this.enter(focused.value || "");
333
+ } else if (charCode === codes.Esc) {
334
+ await this.escape();
335
+ } else if (charCode === codes.Click) {
336
+ await this.click();
337
+ } else {
338
+ throw new Error(`Unsupported char code, ${charCode}`);
339
+ }
340
+ }
341
+ }
342
+ async click() {
343
+ this._log(`clicking ${this._pretty(this.focused)}`);
344
+ await act$1(async () => fireEvent.click(this.focused));
345
+ }
346
+ async tab() {
347
+ await this._sendKey("Tab", codes.Tab, () => {
348
+ const focusable = this.document.querySelectorAll([
349
+ "a[href]",
350
+ "area[href]",
351
+ "input:not([disabled])",
352
+ "select:not([disabled])",
353
+ "textarea:not([disabled])",
354
+ "button:not([disabled])",
355
+ "iframe",
356
+ "object",
357
+ "embed",
358
+ "*[tabindex]",
359
+ "*[contenteditable]"
360
+ ].join(","));
361
+ const tabbable = [...focusable].filter((el) => {
362
+ return el.tabIndex >= 0;
363
+ });
364
+ const focused = this.document.activeElement;
365
+ const focusedIndex = tabbable.indexOf(focused);
366
+ const nextFocus = tabbable[focusedIndex + 1 % tabbable.length];
367
+ this._log(`tabbing to ${this._pretty(nextFocus)} ${this.focused.textContent}`);
368
+ nextFocus.focus();
369
+ });
370
+ }
371
+ async enter(value) {
372
+ this._log(`submitting '${value}' via ${this._pretty(this.focused)}`);
373
+ await act$1(() => this._sendKey("Enter", codes.Enter, () => {
374
+ if (this.focused.type === "button") {
375
+ fireEvent.click(this.focused, {target: {value}});
376
+ } else {
377
+ fireEvent.submit(this.focused, {
378
+ target: {value},
379
+ bubbles: true,
380
+ cancelable: true
381
+ });
382
+ }
383
+ }));
384
+ }
385
+ async escape() {
386
+ this._log(`escape from ${this._pretty(this.focused)}`);
387
+ await act$1(async () => this._sendKey("Escape", codes.Esc));
388
+ }
389
+ async _sendKey(key, charCode, action) {
390
+ const event = {key, charCode, keyCode: charCode, which: charCode};
391
+ const focused = this.focused;
392
+ if (fireEvent.keyDown(focused, event)) {
393
+ if (fireEvent.keyPress(focused, event)) {
394
+ if (action) {
395
+ action();
396
+ }
397
+ }
398
+ }
399
+ fireEvent.keyUp(focused, event);
400
+ }
401
+ }
402
+
403
+ const allCategories = ["log", "warn", "error"];
404
+ function withLogCollector(logsToCollect, callback) {
405
+ const oneArg = !callback;
406
+ const actualCallback = oneArg ? logsToCollect : callback;
407
+ const categories = oneArg ? allCategories : logsToCollect;
408
+ const logs = {
409
+ log: new Array(),
410
+ warn: new Array(),
411
+ error: new Array()
412
+ };
413
+ const origLog = console.log;
414
+ const origWarn = console.warn;
415
+ const origError = console.error;
416
+ if (categories.includes("log")) {
417
+ console.log = (message) => {
418
+ logs.log.push(message);
419
+ };
420
+ }
421
+ if (categories.includes("warn")) {
422
+ console.warn = (message) => {
423
+ logs.warn.push(message);
424
+ };
425
+ }
426
+ if (categories.includes("error")) {
427
+ console.error = (message) => {
428
+ logs.error.push(message);
429
+ };
430
+ }
431
+ const restore = () => {
432
+ console.log = origLog;
433
+ console.warn = origWarn;
434
+ console.error = origError;
435
+ };
436
+ try {
437
+ const ret = actualCallback();
438
+ if (!ret || !ret.then) {
439
+ restore();
440
+ return logs;
441
+ }
442
+ return ret.then(() => {
443
+ restore();
444
+ return logs;
445
+ }, (error) => {
446
+ restore();
447
+ throw error;
448
+ });
449
+ } catch (error) {
450
+ restore();
451
+ throw error;
452
+ }
453
+ }
208
454
 
209
- export { MockErrorApi, MockStorageApi, mockBreakpoint, msw, renderInTestApp, wrapInTestApp };
455
+ export { Keyboard, MockAnalyticsApi, MockErrorApi, MockStorageApi, mockBreakpoint, msw, renderInTestApp, renderWithEffects, setupRequestMockHandlers, withLogCollector, wrapInTestApp };
210
456
  //# sourceMappingURL=index.esm.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.esm.js","sources":["../src/testUtils/apis/ErrorApi/MockErrorApi.ts","../src/testUtils/apis/StorageApi/MockStorageApi.ts","../src/testUtils/mockBreakpoint.ts","../src/testUtils/mockApis.ts","../src/testUtils/appWrappers.tsx","../src/testUtils/msw/index.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ErrorApi, ErrorContext, Observable } from '@backstage/core-plugin-api';\n\ntype Options = {\n collect?: boolean;\n};\n\ntype ErrorWithContext = {\n error: Error;\n context?: ErrorContext;\n};\n\ntype Waiter = {\n pattern: RegExp;\n resolve: (err: ErrorWithContext) => void;\n};\n\nconst nullObservable = {\n subscribe: () => ({ unsubscribe: () => {}, closed: true }),\n\n [Symbol.observable]() {\n return this;\n },\n};\n\nexport class MockErrorApi implements ErrorApi {\n private readonly errors = new Array<ErrorWithContext>();\n private readonly waiters = new Set<Waiter>();\n\n constructor(private readonly options: Options = {}) {}\n\n post(error: Error, context?: ErrorContext) {\n if (this.options.collect) {\n this.errors.push({ error, context });\n\n for (const waiter of this.waiters) {\n if (waiter.pattern.test(error.message)) {\n this.waiters.delete(waiter);\n waiter.resolve({ error, context });\n }\n }\n\n return;\n }\n\n throw new Error(`MockErrorApi received unexpected error, ${error}`);\n }\n\n error$(): Observable<{ error: Error; context?: ErrorContext }> {\n return nullObservable;\n }\n\n getErrors(): ErrorWithContext[] {\n return this.errors;\n }\n\n waitForError(\n pattern: RegExp,\n timeoutMs: number = 2000,\n ): Promise<ErrorWithContext> {\n return new Promise<ErrorWithContext>((resolve, reject) => {\n setTimeout(() => {\n reject(new Error('Timed out waiting for error'));\n }, timeoutMs);\n\n this.waiters.add({ resolve, pattern });\n });\n }\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n Observable,\n StorageApi,\n StorageValueChange,\n} from '@backstage/core-plugin-api';\nimport ObservableImpl from 'zen-observable';\n\nexport type MockStorageBucket = { [key: string]: any };\n\nconst bucketStorageApis = new Map<string, MockStorageApi>();\n\nexport class MockStorageApi implements StorageApi {\n private readonly namespace: string;\n private readonly data: MockStorageBucket;\n\n private constructor(namespace: string, data?: MockStorageBucket) {\n this.namespace = namespace;\n this.data = { ...data };\n }\n\n static create(data?: MockStorageBucket) {\n return new MockStorageApi('', data);\n }\n\n forBucket(name: string): StorageApi {\n if (!bucketStorageApis.has(name)) {\n bucketStorageApis.set(\n name,\n new MockStorageApi(`${this.namespace}/${name}`, this.data),\n );\n }\n return bucketStorageApis.get(name)!;\n }\n\n get<T>(key: string): T | undefined {\n return this.data[this.getKeyName(key)];\n }\n\n async set<T>(key: string, data: T): Promise<void> {\n this.data[this.getKeyName(key)] = data;\n this.notifyChanges({ key, newValue: data });\n }\n\n async remove(key: string): Promise<void> {\n delete this.data[this.getKeyName(key)];\n this.notifyChanges({ key, newValue: undefined });\n }\n\n observe$<T>(key: string): Observable<StorageValueChange<T>> {\n return this.observable.filter(({ key: messageKey }) => messageKey === key);\n }\n\n private getKeyName(key: string) {\n return `${this.namespace}/${encodeURIComponent(key)}`;\n }\n\n private notifyChanges<T>(message: StorageValueChange<T>) {\n for (const subscription of this.subscribers) {\n subscription.next(message);\n }\n }\n\n private subscribers = new Set<\n ZenObservable.SubscriptionObserver<StorageValueChange>\n >();\n\n private readonly observable = new ObservableImpl<StorageValueChange>(\n subscriber => {\n this.subscribers.add(subscriber);\n return () => {\n this.subscribers.delete(subscriber);\n };\n },\n );\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * This is a mocking method suggested in the Jest Doc's, as it is not implemented in JSDOM yet.\n * It can be used to mock values when the MUI `useMediaQuery` hook if it is used in a tested component.\n *\n * For issues checkout the documentation:\n * https://jestjs.io/docs/manual-mocks#mocking-methods-which-are-not-implemented-in-jsdom\n *\n * If there are any updates from MUI React on testing `useMediaQuery` this mock should be replaced\n * https://material-ui.com/components/use-media-query/#testing\n *\n * @param matchMediaOptions\n */\nexport default function mockBreakpoint({ matches = false }) {\n Object.defineProperty(window, 'matchMedia', {\n writable: true,\n value: jest.fn().mockImplementation(query => ({\n matches: matches,\n media: query,\n onchange: null,\n addListener: jest.fn(), // deprecated\n removeListener: jest.fn(), // deprecated\n addEventListener: jest.fn(),\n removeEventListener: jest.fn(),\n dispatchEvent: jest.fn(),\n })),\n });\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n storageApiRef,\n errorApiRef,\n createApiFactory,\n} from '@backstage/core-plugin-api';\nimport { MockErrorApi, MockStorageApi } from './apis';\n\nexport const mockApis = [\n createApiFactory(errorApiRef, new MockErrorApi()),\n createApiFactory(storageApiRef, MockStorageApi.create()),\n];\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport React, { ComponentType, ReactNode, ReactElement } from 'react';\nimport { MemoryRouter } from 'react-router';\nimport { Route } from 'react-router-dom';\nimport { lightTheme } from '@backstage/theme';\nimport { createApp } from '@backstage/core-app-api';\nimport {\n BootErrorPageProps,\n RouteRef,\n ExternalRouteRef,\n attachComponentData,\n createRouteRef,\n} from '@backstage/core-plugin-api';\nimport { RenderResult } from '@testing-library/react';\nimport { renderWithEffects } from '@backstage/test-utils-core';\nimport { mockApis } from './mockApis';\n\nconst ErrorBoundaryFallback = ({ error }: { error: Error }) => {\n throw new Error(`Reached ErrorBoundaryFallback Page with error, ${error}`);\n};\nconst NotFoundErrorPage = () => {\n throw new Error('Reached NotFound Page');\n};\nconst BootErrorPage = ({ step, error }: BootErrorPageProps) => {\n throw new Error(`Reached BootError Page at step ${step} with error ${error}`);\n};\nconst Progress = () => <div data-testid=\"progress\" />;\n\n/**\n * Options to customize the behavior of the test app wrapper.\n */\ntype TestAppOptions = {\n /**\n * Initial route entries to pass along as `initialEntries` to the router.\n */\n routeEntries?: string[];\n\n /**\n * An object of paths to mount route ref on, with the key being the path and the value\n * being the RouteRef that the path will be bound to. This allows the route refs to be\n * used by `useRouteRef` in the rendered elements.\n *\n * @example\n * wrapInTestApp(<MyComponent />, {\n * mountedRoutes: {\n * '/my-path': myRouteRef,\n * }\n * })\n * // ...\n * const link = useRouteRef(myRouteRef)\n */\n mountedRoutes?: { [path: string]: RouteRef | ExternalRouteRef };\n};\n\nfunction isExternalRouteRef(\n routeRef: RouteRef | ExternalRouteRef,\n): routeRef is ExternalRouteRef {\n // TODO(Rugvip): Least ugly workaround for now, but replace :D\n return String(routeRef).includes('{type=external,');\n}\n\n/**\n * Wraps a component inside a Backstage test app, providing a mocked theme\n * and app context, along with mocked APIs.\n *\n * @param Component - A component or react node to render inside the test app.\n * @param options - Additional options for the rendering.\n */\nexport function wrapInTestApp(\n Component: ComponentType | ReactNode,\n options: TestAppOptions = {},\n): ReactElement {\n const { routeEntries = ['/'] } = options;\n const boundRoutes = new Map<ExternalRouteRef, RouteRef>();\n\n const app = createApp({\n apis: mockApis,\n // Bit of a hack to make sure that the default config loader isn't used\n // as that would force every single test to wait for config loading.\n configLoader: false as unknown as undefined,\n components: {\n Progress,\n BootErrorPage,\n NotFoundErrorPage,\n ErrorBoundaryFallback,\n Router: ({ children }) => (\n <MemoryRouter initialEntries={routeEntries} children={children} />\n ),\n },\n plugins: [],\n themes: [\n {\n id: 'light',\n theme: lightTheme,\n title: 'Test App Theme',\n variant: 'light',\n },\n ],\n bindRoutes: ({ bind }) => {\n for (const [externalRef, absoluteRef] of boundRoutes) {\n bind(\n { ref: externalRef },\n {\n ref: absoluteRef,\n },\n );\n }\n },\n });\n\n let wrappedElement: React.ReactElement;\n if (Component instanceof Function) {\n wrappedElement = <Component />;\n } else {\n wrappedElement = Component as React.ReactElement;\n }\n\n const routeElements = Object.entries(options.mountedRoutes ?? {}).map(\n ([path, routeRef]) => {\n const Page = () => <div>Mounted at {path}</div>;\n\n // Allow external route refs to be bound to paths as well, for convenience.\n // We work around it by creating and binding an absolute ref to the external one.\n if (isExternalRouteRef(routeRef)) {\n const absoluteRef = createRouteRef({ id: 'id' });\n boundRoutes.set(routeRef, absoluteRef);\n attachComponentData(Page, 'core.mountPoint', absoluteRef);\n } else {\n attachComponentData(Page, 'core.mountPoint', routeRef);\n }\n return <Route key={path} path={path} element={<Page />} />;\n },\n );\n\n const AppProvider = app.getProvider();\n const AppRouter = app.getRouter();\n\n return (\n <AppProvider>\n <AppRouter>\n {routeElements}\n {/* The path of * here is needed to be set as a catch all, so it will render the wrapper element\n * and work with nested routes if they exist too */}\n <Route path=\"*\" element={wrappedElement} />\n </AppRouter>\n </AppProvider>\n );\n}\n\n/**\n * Renders a component inside a Backstage test app, providing a mocked theme\n * and app context, along with mocked APIs.\n *\n * The render executes async effects similar to `renderWithEffects`. To avoid this\n * behavior, use a regular `render()` + `wrapInTestApp()` instead.\n *\n * @param Component - A component or react node to render inside the test app.\n * @param options - Additional options for the rendering.\n */\nexport async function renderInTestApp(\n Component: ComponentType | ReactNode,\n options: TestAppOptions = {},\n): Promise<RenderResult> {\n return renderWithEffects(wrapInTestApp(Component, options));\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport const msw = {\n setupDefaultHandlers: (worker: {\n listen: (t: any) => void;\n close: () => void;\n resetHandlers: () => void;\n }) => {\n beforeAll(() => worker.listen({ onUnhandledRequest: 'error' }));\n afterAll(() => worker.close());\n afterEach(() => worker.resetHandlers());\n },\n};\n"],"names":[],"mappings":";;;;;;;;;;AAgCA,MAAM,iBAAiB;AAAA,EACrB,WAAW,QAAS,aAAa,MAAM;AAAA,KAAI,QAAQ;AAAA,GAElD,OAAO,cAAc;AACpB,WAAO;AAAA;AAAA;mBAImC;AAAA,EAI5C,YAA6B,UAAmB,IAAI;AAAvB;AAHZ,kBAAS,IAAI;AACb,mBAAU,IAAI;AAAA;AAAA,EAI/B,KAAK,OAAc,SAAwB;AACzC,QAAI,KAAK,QAAQ,SAAS;AACxB,WAAK,OAAO,KAAK,CAAE,OAAO;AAE1B,iBAAW,UAAU,KAAK,SAAS;AACjC,YAAI,OAAO,QAAQ,KAAK,MAAM,UAAU;AACtC,eAAK,QAAQ,OAAO;AACpB,iBAAO,QAAQ,CAAE,OAAO;AAAA;AAAA;AAI5B;AAAA;AAGF,UAAM,IAAI,MAAM,2CAA2C;AAAA;AAAA,EAG7D,SAA+D;AAC7D,WAAO;AAAA;AAAA,EAGT,YAAgC;AAC9B,WAAO,KAAK;AAAA;AAAA,EAGd,aACE,SACA,YAAoB,KACO;AAC3B,WAAO,IAAI,QAA0B,CAAC,SAAS,WAAW;AACxD,iBAAW,MAAM;AACf,eAAO,IAAI,MAAM;AAAA,SAChB;AAEH,WAAK,QAAQ,IAAI,CAAE,SAAS;AAAA;AAAA;AAAA;;ACvDlC,MAAM,oBAAoB,IAAI;qBAEoB;AAAA,EAIxC,YAAY,WAAmB,MAA0B;AA+CzD,uBAAc,IAAI;AAIT,sBAAa,IAAI,eAChC,gBAAc;AACZ,WAAK,YAAY,IAAI;AACrB,aAAO,MAAM;AACX,aAAK,YAAY,OAAO;AAAA;AAAA;AAtD5B,SAAK,YAAY;AACjB,SAAK,OAAO,IAAK;AAAA;AAAA,SAGZ,OAAO,MAA0B;AACtC,WAAO,IAAI,eAAe,IAAI;AAAA;AAAA,EAGhC,UAAU,MAA0B;AAClC,QAAI,CAAC,kBAAkB,IAAI,OAAO;AAChC,wBAAkB,IAChB,MACA,IAAI,eAAe,GAAG,KAAK,aAAa,QAAQ,KAAK;AAAA;AAGzD,WAAO,kBAAkB,IAAI;AAAA;AAAA,EAG/B,IAAO,KAA4B;AACjC,WAAO,KAAK,KAAK,KAAK,WAAW;AAAA;AAAA,QAG7B,IAAO,KAAa,MAAwB;AAChD,SAAK,KAAK,KAAK,WAAW,QAAQ;AAClC,SAAK,cAAc,CAAE,KAAK,UAAU;AAAA;AAAA,QAGhC,OAAO,KAA4B;AACvC,WAAO,KAAK,KAAK,KAAK,WAAW;AACjC,SAAK,cAAc,CAAE,KAAK,UAAU;AAAA;AAAA,EAGtC,SAAY,KAAgD;AAC1D,WAAO,KAAK,WAAW,OAAO,CAAC,CAAE,KAAK,gBAAiB,eAAe;AAAA;AAAA,EAGhE,WAAW,KAAa;AAC9B,WAAO,GAAG,KAAK,aAAa,mBAAmB;AAAA;AAAA,EAGzC,cAAiB,SAAgC;AACvD,eAAW,gBAAgB,KAAK,aAAa;AAC3C,mBAAa,KAAK;AAAA;AAAA;AAAA;;wBC9Ce,CAAE,UAAU,QAAS;AAC1D,SAAO,eAAe,QAAQ,cAAc;AAAA,IAC1C,UAAU;AAAA,IACV,OAAO,KAAK,KAAK,mBAAmB;AAAU,MAC5C;AAAA,MACA,OAAO;AAAA,MACP,UAAU;AAAA,MACV,aAAa,KAAK;AAAA,MAClB,gBAAgB,KAAK;AAAA,MACrB,kBAAkB,KAAK;AAAA,MACvB,qBAAqB,KAAK;AAAA,MAC1B,eAAe,KAAK;AAAA;AAAA;AAAA;;MChBb,WAAW;AAAA,EACtB,iBAAiB,aAAa,IAAI;AAAA,EAClC,iBAAiB,eAAe,eAAe;AAAA;;ACOjD,MAAM,wBAAwB,CAAC,CAAE,WAA8B;AAC7D,QAAM,IAAI,MAAM,kDAAkD;AAAA;AAEpE,MAAM,oBAAoB,MAAM;AAC9B,QAAM,IAAI,MAAM;AAAA;AAElB,MAAM,gBAAgB,CAAC,CAAE,MAAM,WAAgC;AAC7D,QAAM,IAAI,MAAM,kCAAkC,mBAAmB;AAAA;AAEvE,MAAM,WAAW,0CAAO,OAAD;AAAA,EAAK,eAAY;AAAA;AA4BxC,4BACE,UAC8B;AAE9B,SAAO,OAAO,UAAU,SAAS;AAAA;uBAWjC,WACA,UAA0B,IACZ;AAtFhB;AAuFE,QAAM,CAAE,eAAe,CAAC,QAAS;AACjC,QAAM,cAAc,IAAI;AAExB,QAAM,MAAM,UAAU;AAAA,IACpB,MAAM;AAAA,IAGN,cAAc;AAAA,IACd,YAAY;AAAA,MACV;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,QAAQ,CAAC,CAAE,kDACR,cAAD;AAAA,QAAc,gBAAgB;AAAA,QAAc;AAAA;AAAA;AAAA,IAGhD,SAAS;AAAA,IACT,QAAQ;AAAA,MACN;AAAA,QACE,IAAI;AAAA,QACJ,OAAO;AAAA,QACP,OAAO;AAAA,QACP,SAAS;AAAA;AAAA;AAAA,IAGb,YAAY,CAAC,CAAE,UAAW;AACxB,iBAAW,CAAC,aAAa,gBAAgB,aAAa;AACpD,aACE,CAAE,KAAK,cACP;AAAA,UACE,KAAK;AAAA;AAAA;AAAA;AAAA;AAOf,MAAI;AACJ,MAAI,qBAAqB,UAAU;AACjC,yDAAkB,WAAD;AAAA,SACZ;AACL,qBAAiB;AAAA;AAGnB,QAAM,gBAAgB,OAAO,QAAQ,cAAQ,kBAAR,YAAyB,IAAI,IAChE,CAAC,CAAC,MAAM,cAAc;AACpB,UAAM,OAAO,0CAAO,OAAD,MAAK,eAAY;AAIpC,QAAI,mBAAmB,WAAW;AAChC,YAAM,cAAc,eAAe,CAAE,IAAI;AACzC,kBAAY,IAAI,UAAU;AAC1B,0BAAoB,MAAM,mBAAmB;AAAA,WACxC;AACL,0BAAoB,MAAM,mBAAmB;AAAA;AAE/C,+CAAQ,OAAD;AAAA,MAAO,KAAK;AAAA,MAAM;AAAA,MAAY,6CAAU,MAAD;AAAA;AAAA;AAIlD,QAAM,cAAc,IAAI;AACxB,QAAM,YAAY,IAAI;AAEtB,6CACG,aAAD,0CACG,WAAD,MACG,mDAGA,OAAD;AAAA,IAAO,MAAK;AAAA,IAAI,SAAS;AAAA;AAAA;+BAiB/B,WACA,UAA0B,IACH;AACvB,SAAO,kBAAkB,cAAc,WAAW;AAAA;;MClKvC,MAAM;AAAA,EACjB,sBAAsB,CAAC,WAIjB;AACJ,cAAU,MAAM,OAAO,OAAO,CAAE,oBAAoB;AACpD,aAAS,MAAM,OAAO;AACtB,cAAU,MAAM,OAAO;AAAA;AAAA;;;;"}
1
+ {"version":3,"file":"index.esm.js","sources":["../src/testUtils/apis/AnalyticsApi/MockAnalyticsApi.ts","../src/testUtils/apis/ErrorApi/MockErrorApi.ts","../src/testUtils/apis/StorageApi/MockStorageApi.ts","../src/testUtils/mockBreakpoint.ts","../src/testUtils/testingLibrary.ts","../src/testUtils/mockApis.ts","../src/testUtils/appWrappers.tsx","../src/testUtils/msw/index.ts","../src/testUtils/Keyboard.js","../src/testUtils/logCollector.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { AnalyticsApi, AnalyticsEvent } from '@backstage/core-plugin-api';\n\n/**\n * Mock implementation of {@link core-plugin-api#AnalyticsApi} with helpers to ensure that events are sent correctly.\n * Use getEvents in tests to verify captured events.\n * @public\n */\nexport class MockAnalyticsApi implements AnalyticsApi {\n private events: AnalyticsEvent[] = [];\n\n captureEvent({\n action,\n subject,\n value,\n attributes,\n context,\n }: AnalyticsEvent) {\n this.events.push({\n action,\n subject,\n context,\n ...(value !== undefined ? { value } : {}),\n ...(attributes !== undefined ? { attributes } : {}),\n });\n }\n\n getEvents(): AnalyticsEvent[] {\n return this.events;\n }\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ErrorApi, ErrorContext } from '@backstage/core-plugin-api';\nimport { Observable } from '@backstage/types';\n\n/**\n * Constructor arguments for {@link MockErrorApi}\n * @public\n */\nexport type MockErrorApiOptions = {\n // Need to be true if getErrors is used in testing.\n collect?: boolean;\n};\n\n/**\n * ErrorWithContext contains error and ErrorContext\n * @public\n */\nexport type ErrorWithContext = {\n error: Error;\n context?: ErrorContext;\n};\n\ntype Waiter = {\n pattern: RegExp;\n resolve: (err: ErrorWithContext) => void;\n};\n\nconst nullObservable = {\n subscribe: () => ({ unsubscribe: () => {}, closed: true }),\n\n [Symbol.observable]() {\n return this;\n },\n};\n\n/**\n * Mock implementation of the {@link core-plugin-api#ErrorApi} to be used in tests.\n * Incudes withForError and getErrors methods for error testing.\n * @public\n */\nexport class MockErrorApi implements ErrorApi {\n private readonly errors = new Array<ErrorWithContext>();\n private readonly waiters = new Set<Waiter>();\n\n constructor(private readonly options: MockErrorApiOptions = {}) {}\n\n post(error: Error, context?: ErrorContext) {\n if (this.options.collect) {\n this.errors.push({ error, context });\n\n for (const waiter of this.waiters) {\n if (waiter.pattern.test(error.message)) {\n this.waiters.delete(waiter);\n waiter.resolve({ error, context });\n }\n }\n\n return;\n }\n\n throw new Error(`MockErrorApi received unexpected error, ${error}`);\n }\n\n error$(): Observable<{ error: Error; context?: ErrorContext }> {\n return nullObservable;\n }\n\n getErrors(): ErrorWithContext[] {\n return this.errors;\n }\n\n waitForError(\n pattern: RegExp,\n timeoutMs: number = 2000,\n ): Promise<ErrorWithContext> {\n return new Promise<ErrorWithContext>((resolve, reject) => {\n setTimeout(() => {\n reject(new Error('Timed out waiting for error'));\n }, timeoutMs);\n\n this.waiters.add({ resolve, pattern });\n });\n }\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { StorageApi, StorageValueChange } from '@backstage/core-plugin-api';\nimport { Observable } from '@backstage/types';\nimport ObservableImpl from 'zen-observable';\n\n/**\n * Type for map holding data in {@link MockStorageApi}\n * @public\n */\nexport type MockStorageBucket = { [key: string]: any };\n\n/**\n * Mock implementation of the {@link core-plugin-api#StorageApi} to be used in tests\n * @public\n */\nexport class MockStorageApi implements StorageApi {\n private readonly namespace: string;\n private readonly data: MockStorageBucket;\n private readonly bucketStorageApis: Map<string, MockStorageApi>;\n\n private constructor(\n namespace: string,\n bucketStorageApis: Map<string, MockStorageApi>,\n data?: MockStorageBucket,\n ) {\n this.namespace = namespace;\n this.bucketStorageApis = bucketStorageApis;\n this.data = { ...data };\n }\n\n static create(data?: MockStorageBucket) {\n return new MockStorageApi('', new Map(), data);\n }\n\n forBucket(name: string): StorageApi {\n if (!this.bucketStorageApis.has(name)) {\n this.bucketStorageApis.set(\n name,\n new MockStorageApi(\n `${this.namespace}/${name}`,\n this.bucketStorageApis,\n this.data,\n ),\n );\n }\n return this.bucketStorageApis.get(name)!;\n }\n\n get<T>(key: string): T | undefined {\n return this.data[this.getKeyName(key)];\n }\n\n async set<T>(key: string, data: T): Promise<void> {\n this.data[this.getKeyName(key)] = data;\n this.notifyChanges({ key, newValue: data });\n }\n\n async remove(key: string): Promise<void> {\n delete this.data[this.getKeyName(key)];\n this.notifyChanges({ key, newValue: undefined });\n }\n\n observe$<T>(key: string): Observable<StorageValueChange<T>> {\n return this.observable.filter(({ key: messageKey }) => messageKey === key);\n }\n\n private getKeyName(key: string) {\n return `${this.namespace}/${encodeURIComponent(key)}`;\n }\n\n private notifyChanges<T>(message: StorageValueChange<T>) {\n for (const subscription of this.subscribers) {\n subscription.next(message);\n }\n }\n\n private subscribers = new Set<\n ZenObservable.SubscriptionObserver<StorageValueChange>\n >();\n\n private readonly observable = new ObservableImpl<StorageValueChange>(\n subscriber => {\n this.subscribers.add(subscriber);\n return () => {\n this.subscribers.delete(subscriber);\n };\n },\n );\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * This is a mocking method suggested in the Jest Doc's, as it is not implemented in JSDOM yet.\n * It can be used to mock values when the MUI `useMediaQuery` hook if it is used in a tested component.\n *\n * For issues checkout the documentation:\n * https://jestjs.io/docs/manual-mocks#mocking-methods-which-are-not-implemented-in-jsdom\n *\n * If there are any updates from MUI React on testing `useMediaQuery` this mock should be replaced\n * https://material-ui.com/components/use-media-query/#testing\n *\n * @public\n */\nexport default function mockBreakpoint({ matches = false }) {\n Object.defineProperty(window, 'matchMedia', {\n writable: true,\n value: jest.fn().mockImplementation(query => ({\n matches: matches,\n media: query,\n onchange: null,\n addListener: jest.fn(), // deprecated\n removeListener: jest.fn(), // deprecated\n addEventListener: jest.fn(),\n removeEventListener: jest.fn(),\n dispatchEvent: jest.fn(),\n })),\n });\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ReactElement } from 'react';\nimport { act } from 'react-dom/test-utils';\nimport { render, RenderResult } from '@testing-library/react';\n\n/**\n * @public\n * Simplifies rendering of async components in by taking care of the wrapping inside act\n *\n * @remarks\n *\n * Components using useEffect to perform an asynchronous action (such as fetch) must be rendered within an async\n * act call to properly get the final state, even with mocked responses. This utility method makes the signature a bit\n * cleaner, since act doesn't return the result of the evaluated function.\n * https://github.com/testing-library/react-testing-library/issues/281\n * https://github.com/facebook/react/pull/14853\n */\nexport async function renderWithEffects(\n nodes: ReactElement,\n): Promise<RenderResult> {\n let value: RenderResult;\n await act(async () => {\n value = render(nodes);\n });\n // @ts-ignore\n return value;\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n storageApiRef,\n errorApiRef,\n createApiFactory,\n} from '@backstage/core-plugin-api';\nimport { MockErrorApi, MockStorageApi } from './apis';\n\nexport const mockApis = [\n createApiFactory(errorApiRef, new MockErrorApi()),\n createApiFactory(storageApiRef, MockStorageApi.create()),\n];\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport React, { ComponentType, ReactNode, ReactElement } from 'react';\nimport { MemoryRouter } from 'react-router';\nimport { Route } from 'react-router-dom';\nimport { lightTheme } from '@backstage/theme';\nimport { createApp } from '@backstage/core-app-api';\nimport {\n BootErrorPageProps,\n RouteRef,\n ExternalRouteRef,\n attachComponentData,\n createRouteRef,\n} from '@backstage/core-plugin-api';\nimport { RenderResult } from '@testing-library/react';\nimport { renderWithEffects } from './testingLibrary';\nimport { mockApis } from './mockApis';\n\nconst ErrorBoundaryFallback = ({ error }: { error: Error }) => {\n throw new Error(`Reached ErrorBoundaryFallback Page with error, ${error}`);\n};\nconst NotFoundErrorPage = () => {\n throw new Error('Reached NotFound Page');\n};\nconst BootErrorPage = ({ step, error }: BootErrorPageProps) => {\n throw new Error(`Reached BootError Page at step ${step} with error ${error}`);\n};\nconst Progress = () => <div data-testid=\"progress\" />;\n\n/**\n * Options to customize the behavior of the test app wrapper.\n * @public\n */\nexport type TestAppOptions = {\n /**\n * Initial route entries to pass along as `initialEntries` to the router.\n */\n routeEntries?: string[];\n\n /**\n * An object of paths to mount route ref on, with the key being the path and the value\n * being the RouteRef that the path will be bound to. This allows the route refs to be\n * used by `useRouteRef` in the rendered elements.\n *\n * @example\n * wrapInTestApp(<MyComponent />, \\{\n * mountedRoutes: \\{\n * '/my-path': myRouteRef,\n * \\}\n * \\})\n * // ...\n * const link = useRouteRef(myRouteRef)\n */\n mountedRoutes?: { [path: string]: RouteRef | ExternalRouteRef };\n};\n\nfunction isExternalRouteRef(\n routeRef: RouteRef | ExternalRouteRef,\n): routeRef is ExternalRouteRef {\n // TODO(Rugvip): Least ugly workaround for now, but replace :D\n return String(routeRef).includes('{type=external,');\n}\n\n/**\n * Wraps a component inside a Backstage test app, providing a mocked theme\n * and app context, along with mocked APIs.\n *\n * @param Component - A component or react node to render inside the test app.\n * @param options - Additional options for the rendering.\n * @public\n */\nexport function wrapInTestApp(\n Component: ComponentType | ReactNode,\n options: TestAppOptions = {},\n): ReactElement {\n const { routeEntries = ['/'] } = options;\n const boundRoutes = new Map<ExternalRouteRef, RouteRef>();\n\n const app = createApp({\n apis: mockApis,\n // Bit of a hack to make sure that the default config loader isn't used\n // as that would force every single test to wait for config loading.\n configLoader: false as unknown as undefined,\n components: {\n Progress,\n BootErrorPage,\n NotFoundErrorPage,\n ErrorBoundaryFallback,\n Router: ({ children }) => (\n <MemoryRouter initialEntries={routeEntries} children={children} />\n ),\n },\n plugins: [],\n themes: [\n {\n id: 'light',\n theme: lightTheme,\n title: 'Test App Theme',\n variant: 'light',\n },\n ],\n bindRoutes: ({ bind }) => {\n for (const [externalRef, absoluteRef] of boundRoutes) {\n bind(\n { ref: externalRef },\n {\n ref: absoluteRef,\n },\n );\n }\n },\n });\n\n let wrappedElement: React.ReactElement;\n if (Component instanceof Function) {\n wrappedElement = <Component />;\n } else {\n wrappedElement = Component as React.ReactElement;\n }\n\n const routeElements = Object.entries(options.mountedRoutes ?? {}).map(\n ([path, routeRef]) => {\n const Page = () => <div>Mounted at {path}</div>;\n\n // Allow external route refs to be bound to paths as well, for convenience.\n // We work around it by creating and binding an absolute ref to the external one.\n if (isExternalRouteRef(routeRef)) {\n const absoluteRef = createRouteRef({ id: 'id' });\n boundRoutes.set(routeRef, absoluteRef);\n attachComponentData(Page, 'core.mountPoint', absoluteRef);\n } else {\n attachComponentData(Page, 'core.mountPoint', routeRef);\n }\n return <Route key={path} path={path} element={<Page />} />;\n },\n );\n\n const AppProvider = app.getProvider();\n const AppRouter = app.getRouter();\n\n return (\n <AppProvider>\n <AppRouter>\n {routeElements}\n {/* The path of * here is needed to be set as a catch all, so it will render the wrapper element\n * and work with nested routes if they exist too */}\n <Route path=\"*\" element={wrappedElement} />\n </AppRouter>\n </AppProvider>\n );\n}\n\n/**\n * Renders a component inside a Backstage test app, providing a mocked theme\n * and app context, along with mocked APIs.\n *\n * The render executes async effects similar to `renderWithEffects`. To avoid this\n * behavior, use a regular `render()` + `wrapInTestApp()` instead.\n *\n * @param Component - A component or react node to render inside the test app.\n * @param options - Additional options for the rendering.\n * @public\n */\nexport async function renderInTestApp(\n Component: ComponentType | ReactNode,\n options: TestAppOptions = {},\n): Promise<RenderResult> {\n return renderWithEffects(wrapInTestApp(Component, options));\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * @deprecated use {@link setupRequestMockHandlers} instead which can be called directly with the worker.\n * @public\n */\nexport const msw = {\n setupDefaultHandlers: (worker: {\n listen: (t: any) => void;\n close: () => void;\n resetHandlers: () => void;\n }) => {\n setupRequestMockHandlers(worker);\n },\n};\n\n/**\n * Sets up handlers for request mocking\n * @public\n * @param worker - service worker\n */\nexport function setupRequestMockHandlers(worker: {\n listen: (t: any) => void;\n close: () => void;\n resetHandlers: () => void;\n}) {\n beforeAll(() => worker.listen({ onUnhandledRequest: 'error' }));\n afterAll(() => worker.close());\n afterEach(() => worker.resetHandlers());\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { act, fireEvent } from '@testing-library/react';\n\nconst codes = {\n Tab: 9,\n Enter: 10,\n Click: 17 /* This keyboard can click, deal with it */,\n Esc: 27,\n};\n\n/**\n * @public\n * @deprecated superseded by {@link @testing-library/user-event#userEvent}\n */\nexport class Keyboard {\n static async type(target, input) {\n await new Keyboard(target).type(input);\n }\n\n static async typeDebug(target, input) {\n await new Keyboard(target, { debug: true }).type(input);\n }\n\n static toReadableInput(chars) {\n return chars.split('').map(char => {\n switch (char.charCodeAt(0)) {\n case codes.Tab:\n return '<Tab>';\n case codes.Enter:\n return '<Enter>';\n case codes.Click:\n return '<Click>';\n case codes.Esc:\n return '<Esc>';\n default:\n return char;\n }\n });\n }\n\n static fromReadableInput(input) {\n return input.trim().replace(/\\s*<([a-zA-Z]+)>\\s*/g, (match, name) => {\n if (name in codes) {\n return String.fromCharCode(codes[name]);\n }\n throw new Error(`Unknown char name: '${name}'`);\n });\n }\n\n constructor(target, { debug = false } = {}) {\n this.debug = debug;\n\n if (target.ownerDocument) {\n this.document = target.ownerDocument;\n } else if (target.baseElement) {\n this.document = target.baseElement.ownerDocument;\n } else {\n throw new TypeError(\n 'Keyboard(target): target must be DOM node or react-testing-library render() output',\n );\n }\n }\n\n toString() {\n return `Keyboard{document=${this.document}, debug=${this.debug}}`;\n }\n\n _log(message, ...args) {\n if (this.debug) {\n // eslint-disable-next-line no-console\n console.log(`[Keyboard] ${message}`, ...args);\n }\n }\n\n _pretty(element) {\n const attrs = [...element.attributes]\n .map(attr => `${attr.name}=\"${attr.value}\"`)\n .join(' ');\n return `<${element.nodeName.toLocaleLowerCase('en-US')} ${attrs}>`;\n }\n\n get focused() {\n return this.document.activeElement;\n }\n\n async type(input) {\n this._log(\n `sending sequence '${input}' with initial focus ${this._pretty(\n this.focused,\n )}`,\n );\n await this.send(Keyboard.fromReadableInput(input));\n }\n\n async send(chars) {\n for (const key of chars.split('')) {\n const charCode = key.charCodeAt(0);\n\n if (charCode === codes.Tab) {\n await this.tab();\n continue;\n }\n\n const focused = this.focused;\n if (!focused || focused === this.document.body) {\n throw Error(\n `No element focused in document while trying to type '${Keyboard.toReadableInput(\n chars,\n )}'`,\n );\n }\n const nextValue = (focused.value || '') + key;\n\n if (charCode >= 32) {\n await this._sendKey(key, charCode, () => {\n this._log(\n `sending +${key} = '${nextValue}' to ${this._pretty(focused)}`,\n );\n fireEvent.change(focused, {\n target: { value: nextValue },\n bubbles: true,\n cancelable: true,\n });\n });\n } else if (charCode === codes.Enter) {\n await this.enter(focused.value || '');\n } else if (charCode === codes.Esc) {\n await this.escape();\n } else if (charCode === codes.Click) {\n await this.click();\n } else {\n throw new Error(`Unsupported char code, ${charCode}`);\n }\n }\n }\n\n async click() {\n this._log(`clicking ${this._pretty(this.focused)}`);\n await act(async () => fireEvent.click(this.focused));\n }\n\n async tab() {\n await this._sendKey('Tab', codes.Tab, () => {\n const focusable = this.document.querySelectorAll(\n [\n 'a[href]',\n 'area[href]',\n 'input:not([disabled])',\n 'select:not([disabled])',\n 'textarea:not([disabled])',\n 'button:not([disabled])',\n 'iframe',\n 'object',\n 'embed',\n '*[tabindex]',\n '*[contenteditable]',\n ].join(','),\n );\n\n const tabbable = [...focusable].filter(el => {\n return el.tabIndex >= 0;\n });\n\n const focused = this.document.activeElement;\n const focusedIndex = tabbable.indexOf(focused);\n const nextFocus = tabbable[focusedIndex + (1 % tabbable.length)];\n\n this._log(\n `tabbing to ${this._pretty(nextFocus)} ${this.focused.textContent}`,\n );\n nextFocus.focus();\n });\n }\n\n async enter(value) {\n this._log(`submitting '${value}' via ${this._pretty(this.focused)}`);\n await act(() =>\n this._sendKey('Enter', codes.Enter, () => {\n if (this.focused.type === 'button') {\n fireEvent.click(this.focused, { target: { value } });\n } else {\n fireEvent.submit(this.focused, {\n target: { value },\n bubbles: true,\n cancelable: true,\n });\n }\n }),\n );\n }\n\n async escape() {\n this._log(`escape from ${this._pretty(this.focused)}`);\n await act(async () => this._sendKey('Escape', codes.Esc));\n }\n\n async _sendKey(key, charCode, action) {\n const event = { key, charCode, keyCode: charCode, which: charCode };\n const focused = this.focused;\n\n if (fireEvent.keyDown(focused, event)) {\n if (fireEvent.keyPress(focused, event)) {\n if (action) {\n action();\n }\n }\n }\n fireEvent.keyUp(focused, event);\n }\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/* eslint-disable no-console */\n\n/**\n * Severity levels of {@link CollectedLogs}\n * @public */\nexport type LogFuncs = 'log' | 'warn' | 'error';\n/**\n * AsyncLogCollector type used in {@link (withLogCollector:1)} callback function.\n * @public */\nexport type AsyncLogCollector = () => Promise<void>;\n/**\n * SyncLogCollector type used in {@link (withLogCollector:2)} callback function.\n * @public */\nexport type SyncLogCollector = () => void;\n/**\n * Union type used in {@link (withLogCollector:3)} callback function.\n * @public */\nexport type LogCollector = AsyncLogCollector | SyncLogCollector;\n/**\n * Map of severity level and corresponding log lines.\n * @public */\nexport type CollectedLogs<T extends LogFuncs> = { [key in T]: string[] };\n\nconst allCategories = ['log', 'warn', 'error'];\n\n/**\n * Asynchronous log collector with that collects all categories\n * @public */\nexport function withLogCollector(\n callback: AsyncLogCollector,\n): Promise<CollectedLogs<LogFuncs>>;\n\n/**\n * Synchronous log collector with that collects all categories\n * @public */\nexport function withLogCollector(\n callback: SyncLogCollector,\n): CollectedLogs<LogFuncs>;\n\n/**\n * Asynchronous log collector with that only collects selected categories\n * @public\n */\nexport function withLogCollector<T extends LogFuncs>(\n logsToCollect: T[],\n callback: AsyncLogCollector,\n): Promise<CollectedLogs<T>>;\n\n/**\n * Synchronous log collector with that only collects selected categories\n * @public */\nexport function withLogCollector<T extends LogFuncs>(\n logsToCollect: T[],\n callback: SyncLogCollector,\n): CollectedLogs<T>;\n\n/**\n * Log collector that collect logs either from a sync or async collector.\n * @public\n * @deprecated import from test-utils instead\n * */\nexport function withLogCollector(\n logsToCollect: LogFuncs[] | LogCollector,\n callback?: LogCollector,\n): CollectedLogs<LogFuncs> | Promise<CollectedLogs<LogFuncs>> {\n const oneArg = !callback;\n const actualCallback = (oneArg ? logsToCollect : callback) as LogCollector;\n const categories = (oneArg ? allCategories : logsToCollect) as LogFuncs[];\n\n const logs = {\n log: new Array<string>(),\n warn: new Array<string>(),\n error: new Array<string>(),\n };\n\n const origLog = console.log;\n const origWarn = console.warn;\n const origError = console.error;\n\n if (categories.includes('log')) {\n console.log = (message: string) => {\n logs.log.push(message);\n };\n }\n if (categories.includes('warn')) {\n console.warn = (message: string) => {\n logs.warn.push(message);\n };\n }\n if (categories.includes('error')) {\n console.error = (message: string) => {\n logs.error.push(message);\n };\n }\n\n const restore = () => {\n console.log = origLog;\n console.warn = origWarn;\n console.error = origError;\n };\n\n try {\n const ret = actualCallback();\n\n if (!ret || !ret.then) {\n restore();\n return logs;\n }\n\n return ret.then(\n () => {\n restore();\n return logs;\n },\n error => {\n restore();\n throw error;\n },\n );\n } catch (error) {\n restore();\n throw error;\n }\n}\n"],"names":["act"],"mappings":";;;;;;;;;;uBAuBsD;AAAA,EAA/C,cAvBP;AAwBU,kBAA2B;AAAA;AAAA,EAEnC,aAAa;AAAA,IACX;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,KACiB;AACjB,SAAK,OAAO,KAAK;AAAA,MACf;AAAA,MACA;AAAA,MACA;AAAA,SACI,UAAU,SAAY,CAAE,SAAU;AAAA,SAClC,eAAe,SAAY,CAAE,cAAe;AAAA;AAAA;AAAA,EAIpD,YAA8B;AAC5B,WAAO,KAAK;AAAA;AAAA;;ACDhB,MAAM,iBAAiB;AAAA,EACrB,WAAW,QAAS,aAAa,MAAM;AAAA,KAAI,QAAQ;AAAA,GAElD,OAAO,cAAc;AACpB,WAAO;AAAA;AAAA;mBASmC;AAAA,EAI5C,YAA6B,UAA+B,IAAI;AAAnC;AAHZ,kBAAS,IAAI;AACb,mBAAU,IAAI;AAAA;AAAA,EAI/B,KAAK,OAAc,SAAwB;AACzC,QAAI,KAAK,QAAQ,SAAS;AACxB,WAAK,OAAO,KAAK,CAAE,OAAO;AAE1B,iBAAW,UAAU,KAAK,SAAS;AACjC,YAAI,OAAO,QAAQ,KAAK,MAAM,UAAU;AACtC,eAAK,QAAQ,OAAO;AACpB,iBAAO,QAAQ,CAAE,OAAO;AAAA;AAAA;AAI5B;AAAA;AAGF,UAAM,IAAI,MAAM,2CAA2C;AAAA;AAAA,EAG7D,SAA+D;AAC7D,WAAO;AAAA;AAAA,EAGT,YAAgC;AAC9B,WAAO,KAAK;AAAA;AAAA,EAGd,aACE,SACA,YAAoB,KACO;AAC3B,WAAO,IAAI,QAA0B,CAAC,SAAS,WAAW;AACxD,iBAAW,MAAM;AACf,eAAO,IAAI,MAAM;AAAA,SAChB;AAEH,WAAK,QAAQ,IAAI,CAAE,SAAS;AAAA;AAAA;AAAA;;qBCjEgB;AAAA,EAKxC,YACN,WACA,mBACA,MACA;AAoDM,uBAAc,IAAI;AAIT,sBAAa,IAAI,eAChC,gBAAc;AACZ,WAAK,YAAY,IAAI;AACrB,aAAO,MAAM;AACX,aAAK,YAAY,OAAO;AAAA;AAAA;AA3D5B,SAAK,YAAY;AACjB,SAAK,oBAAoB;AACzB,SAAK,OAAO,IAAK;AAAA;AAAA,SAGZ,OAAO,MAA0B;AACtC,WAAO,IAAI,eAAe,IAAI,IAAI,OAAO;AAAA;AAAA,EAG3C,UAAU,MAA0B;AAClC,QAAI,CAAC,KAAK,kBAAkB,IAAI,OAAO;AACrC,WAAK,kBAAkB,IACrB,MACA,IAAI,eACF,GAAG,KAAK,aAAa,QACrB,KAAK,mBACL,KAAK;AAAA;AAIX,WAAO,KAAK,kBAAkB,IAAI;AAAA;AAAA,EAGpC,IAAO,KAA4B;AACjC,WAAO,KAAK,KAAK,KAAK,WAAW;AAAA;AAAA,QAG7B,IAAO,KAAa,MAAwB;AAChD,SAAK,KAAK,KAAK,WAAW,QAAQ;AAClC,SAAK,cAAc,CAAE,KAAK,UAAU;AAAA;AAAA,QAGhC,OAAO,KAA4B;AACvC,WAAO,KAAK,KAAK,KAAK,WAAW;AACjC,SAAK,cAAc,CAAE,KAAK,UAAU;AAAA;AAAA,EAGtC,SAAY,KAAgD;AAC1D,WAAO,KAAK,WAAW,OAAO,CAAC,CAAE,KAAK,gBAAiB,eAAe;AAAA;AAAA,EAGhE,WAAW,KAAa;AAC9B,WAAO,GAAG,KAAK,aAAa,mBAAmB;AAAA;AAAA,EAGzC,cAAiB,SAAgC;AACvD,eAAW,gBAAgB,KAAK,aAAa;AAC3C,mBAAa,KAAK;AAAA;AAAA;AAAA;;wBC3De,CAAE,UAAU,QAAS;AAC1D,SAAO,eAAe,QAAQ,cAAc;AAAA,IAC1C,UAAU;AAAA,IACV,OAAO,KAAK,KAAK,mBAAmB;AAAU,MAC5C;AAAA,MACA,OAAO;AAAA,MACP,UAAU;AAAA,MACV,aAAa,KAAK;AAAA,MAClB,gBAAgB,KAAK;AAAA,MACrB,kBAAkB,KAAK;AAAA,MACvB,qBAAqB,KAAK;AAAA,MAC1B,eAAe,KAAK;AAAA;AAAA;AAAA;;iCCNxB,OACuB;AACvB,MAAI;AACJ,QAAM,IAAI,YAAY;AACpB,YAAQ,OAAO;AAAA;AAGjB,SAAO;AAAA;;MCjBI,WAAW;AAAA,EACtB,iBAAiB,aAAa,IAAI;AAAA,EAClC,iBAAiB,eAAe,eAAe;AAAA;;ACOjD,MAAM,wBAAwB,CAAC,CAAE,WAA8B;AAC7D,QAAM,IAAI,MAAM,kDAAkD;AAAA;AAEpE,MAAM,oBAAoB,MAAM;AAC9B,QAAM,IAAI,MAAM;AAAA;AAElB,MAAM,gBAAgB,CAAC,CAAE,MAAM,WAAgC;AAC7D,QAAM,IAAI,MAAM,kCAAkC,mBAAmB;AAAA;AAEvE,MAAM,WAAW,0CAAO,OAAD;AAAA,EAAK,eAAY;AAAA;AA6BxC,4BACE,UAC8B;AAE9B,SAAO,OAAO,UAAU,SAAS;AAAA;uBAYjC,WACA,UAA0B,IACZ;AAxFhB;AAyFE,QAAM,CAAE,eAAe,CAAC,QAAS;AACjC,QAAM,cAAc,IAAI;AAExB,QAAM,MAAM,UAAU;AAAA,IACpB,MAAM;AAAA,IAGN,cAAc;AAAA,IACd,YAAY;AAAA,MACV;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,QAAQ,CAAC,CAAE,kDACR,cAAD;AAAA,QAAc,gBAAgB;AAAA,QAAc;AAAA;AAAA;AAAA,IAGhD,SAAS;AAAA,IACT,QAAQ;AAAA,MACN;AAAA,QACE,IAAI;AAAA,QACJ,OAAO;AAAA,QACP,OAAO;AAAA,QACP,SAAS;AAAA;AAAA;AAAA,IAGb,YAAY,CAAC,CAAE,UAAW;AACxB,iBAAW,CAAC,aAAa,gBAAgB,aAAa;AACpD,aACE,CAAE,KAAK,cACP;AAAA,UACE,KAAK;AAAA;AAAA;AAAA;AAAA;AAOf,MAAI;AACJ,MAAI,qBAAqB,UAAU;AACjC,yDAAkB,WAAD;AAAA,SACZ;AACL,qBAAiB;AAAA;AAGnB,QAAM,gBAAgB,OAAO,QAAQ,cAAQ,kBAAR,YAAyB,IAAI,IAChE,CAAC,CAAC,MAAM,cAAc;AACpB,UAAM,OAAO,0CAAO,OAAD,MAAK,eAAY;AAIpC,QAAI,mBAAmB,WAAW;AAChC,YAAM,cAAc,eAAe,CAAE,IAAI;AACzC,kBAAY,IAAI,UAAU;AAC1B,0BAAoB,MAAM,mBAAmB;AAAA,WACxC;AACL,0BAAoB,MAAM,mBAAmB;AAAA;AAE/C,+CAAQ,OAAD;AAAA,MAAO,KAAK;AAAA,MAAM;AAAA,MAAY,6CAAU,MAAD;AAAA;AAAA;AAIlD,QAAM,cAAc,IAAI;AACxB,QAAM,YAAY,IAAI;AAEtB,6CACG,aAAD,0CACG,WAAD,MACG,mDAGA,OAAD;AAAA,IAAO,MAAK;AAAA,IAAI,SAAS;AAAA;AAAA;+BAkB/B,WACA,UAA0B,IACH;AACvB,SAAO,kBAAkB,cAAc,WAAW;AAAA;;MCjKvC,MAAM;AAAA,EACjB,sBAAsB,CAAC,WAIjB;AACJ,6BAAyB;AAAA;AAAA;kCASY,QAItC;AACD,YAAU,MAAM,OAAO,OAAO,CAAE,oBAAoB;AACpD,WAAS,MAAM,OAAO;AACtB,YAAU,MAAM,OAAO;AAAA;;ACxBzB,MAAM,QAAQ;AAAA,EACZ,KAAK;AAAA,EACL,OAAO;AAAA,EACP,OAAO;AAAA,EACP,KAAK;AAAA;eAOe;AAAA,eACP,KAAK,QAAQ,OAAO;AAC/B,UAAM,IAAI,SAAS,QAAQ,KAAK;AAAA;AAAA,eAGrB,UAAU,QAAQ,OAAO;AACpC,UAAM,IAAI,SAAS,QAAQ,CAAE,OAAO,OAAQ,KAAK;AAAA;AAAA,SAG5C,gBAAgB,OAAO;AAC5B,WAAO,MAAM,MAAM,IAAI,IAAI,UAAQ;AACjC,cAAQ,KAAK,WAAW;AAAA,aACjB,MAAM;AACT,iBAAO;AAAA,aACJ,MAAM;AACT,iBAAO;AAAA,aACJ,MAAM;AACT,iBAAO;AAAA,aACJ,MAAM;AACT,iBAAO;AAAA;AAEP,iBAAO;AAAA;AAAA;AAAA;AAAA,SAKR,kBAAkB,OAAO;AAC9B,WAAO,MAAM,OAAO,QAAQ,wBAAwB,CAAC,OAAO,SAAS;AACnE,UAAI,QAAQ,OAAO;AACjB,eAAO,OAAO,aAAa,MAAM;AAAA;AAEnC,YAAM,IAAI,MAAM,uBAAuB;AAAA;AAAA;AAAA,EAI3C,YAAY,QAAQ,CAAE,QAAQ,SAAU,IAAI;AAC1C,SAAK,QAAQ;AAEb,QAAI,OAAO,eAAe;AACxB,WAAK,WAAW,OAAO;AAAA,eACd,OAAO,aAAa;AAC7B,WAAK,WAAW,OAAO,YAAY;AAAA,WAC9B;AACL,YAAM,IAAI,UACR;AAAA;AAAA;AAAA,EAKN,WAAW;AACT,WAAO,qBAAqB,KAAK,mBAAmB,KAAK;AAAA;AAAA,EAG3D,KAAK,YAAY,MAAM;AACrB,QAAI,KAAK,OAAO;AAEd,cAAQ,IAAI,cAAc,WAAW,GAAG;AAAA;AAAA;AAAA,EAI5C,QAAQ,SAAS;AACf,UAAM,QAAQ,CAAC,GAAG,QAAQ,YACvB,IAAI,UAAQ,GAAG,KAAK,SAAS,KAAK,UAClC,KAAK;AACR,WAAO,IAAI,QAAQ,SAAS,kBAAkB,YAAY;AAAA;AAAA,MAGxD,UAAU;AACZ,WAAO,KAAK,SAAS;AAAA;AAAA,QAGjB,KAAK,OAAO;AAChB,SAAK,KACH,qBAAqB,6BAA6B,KAAK,QACrD,KAAK;AAGT,UAAM,KAAK,KAAK,SAAS,kBAAkB;AAAA;AAAA,QAGvC,KAAK,OAAO;AAChB,eAAW,OAAO,MAAM,MAAM,KAAK;AACjC,YAAM,WAAW,IAAI,WAAW;AAEhC,UAAI,aAAa,MAAM,KAAK;AAC1B,cAAM,KAAK;AACX;AAAA;AAGF,YAAM,UAAU,KAAK;AACrB,UAAI,CAAC,WAAW,YAAY,KAAK,SAAS,MAAM;AAC9C,cAAM,MACJ,wDAAwD,SAAS,gBAC/D;AAAA;AAIN,YAAM,YAAa,SAAQ,SAAS,MAAM;AAE1C,UAAI,YAAY,IAAI;AAClB,cAAM,KAAK,SAAS,KAAK,UAAU,MAAM;AACvC,eAAK,KACH,YAAY,UAAU,iBAAiB,KAAK,QAAQ;AAEtD,oBAAU,OAAO,SAAS;AAAA,YACxB,QAAQ,CAAE,OAAO;AAAA,YACjB,SAAS;AAAA,YACT,YAAY;AAAA;AAAA;AAAA,iBAGP,aAAa,MAAM,OAAO;AACnC,cAAM,KAAK,MAAM,QAAQ,SAAS;AAAA,iBACzB,aAAa,MAAM,KAAK;AACjC,cAAM,KAAK;AAAA,iBACF,aAAa,MAAM,OAAO;AACnC,cAAM,KAAK;AAAA,aACN;AACL,cAAM,IAAI,MAAM,0BAA0B;AAAA;AAAA;AAAA;AAAA,QAK1C,QAAQ;AACZ,SAAK,KAAK,YAAY,KAAK,QAAQ,KAAK;AACxC,UAAMA,MAAI,YAAY,UAAU,MAAM,KAAK;AAAA;AAAA,QAGvC,MAAM;AACV,UAAM,KAAK,SAAS,OAAO,MAAM,KAAK,MAAM;AAC1C,YAAM,YAAY,KAAK,SAAS,iBAC9B;AAAA,QACE;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA,KAAK;AAGT,YAAM,WAAW,CAAC,GAAG,WAAW,OAAO,QAAM;AAC3C,eAAO,GAAG,YAAY;AAAA;AAGxB,YAAM,UAAU,KAAK,SAAS;AAC9B,YAAM,eAAe,SAAS,QAAQ;AACtC,YAAM,YAAY,SAAS,eAAgB,IAAI,SAAS;AAExD,WAAK,KACH,cAAc,KAAK,QAAQ,cAAc,KAAK,QAAQ;AAExD,gBAAU;AAAA;AAAA;AAAA,QAIR,MAAM,OAAO;AACjB,SAAK,KAAK,eAAe,cAAc,KAAK,QAAQ,KAAK;AACzD,UAAMA,MAAI,MACR,KAAK,SAAS,SAAS,MAAM,OAAO,MAAM;AACxC,UAAI,KAAK,QAAQ,SAAS,UAAU;AAClC,kBAAU,MAAM,KAAK,SAAS,CAAE,QAAQ,CAAE;AAAA,aACrC;AACL,kBAAU,OAAO,KAAK,SAAS;AAAA,UAC7B,QAAQ,CAAE;AAAA,UACV,SAAS;AAAA,UACT,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA,QAOhB,SAAS;AACb,SAAK,KAAK,eAAe,KAAK,QAAQ,KAAK;AAC3C,UAAMA,MAAI,YAAY,KAAK,SAAS,UAAU,MAAM;AAAA;AAAA,QAGhD,SAAS,KAAK,UAAU,QAAQ;AACpC,UAAM,QAAQ,CAAE,KAAK,UAAU,SAAS,UAAU,OAAO;AACzD,UAAM,UAAU,KAAK;AAErB,QAAI,UAAU,QAAQ,SAAS,QAAQ;AACrC,UAAI,UAAU,SAAS,SAAS,QAAQ;AACtC,YAAI,QAAQ;AACV;AAAA;AAAA;AAAA;AAIN,cAAU,MAAM,SAAS;AAAA;AAAA;;ACvL7B,MAAM,gBAAgB,CAAC,OAAO,QAAQ;0BAuCpC,eACA,UAC4D;AAC5D,QAAM,SAAS,CAAC;AAChB,QAAM,iBAAkB,SAAS,gBAAgB;AACjD,QAAM,aAAc,SAAS,gBAAgB;AAE7C,QAAM,OAAO;AAAA,IACX,KAAK,IAAI;AAAA,IACT,MAAM,IAAI;AAAA,IACV,OAAO,IAAI;AAAA;AAGb,QAAM,UAAU,QAAQ;AACxB,QAAM,WAAW,QAAQ;AACzB,QAAM,YAAY,QAAQ;AAE1B,MAAI,WAAW,SAAS,QAAQ;AAC9B,YAAQ,MAAM,CAAC,YAAoB;AACjC,WAAK,IAAI,KAAK;AAAA;AAAA;AAGlB,MAAI,WAAW,SAAS,SAAS;AAC/B,YAAQ,OAAO,CAAC,YAAoB;AAClC,WAAK,KAAK,KAAK;AAAA;AAAA;AAGnB,MAAI,WAAW,SAAS,UAAU;AAChC,YAAQ,QAAQ,CAAC,YAAoB;AACnC,WAAK,MAAM,KAAK;AAAA;AAAA;AAIpB,QAAM,UAAU,MAAM;AACpB,YAAQ,MAAM;AACd,YAAQ,OAAO;AACf,YAAQ,QAAQ;AAAA;AAGlB,MAAI;AACF,UAAM,MAAM;AAEZ,QAAI,CAAC,OAAO,CAAC,IAAI,MAAM;AACrB;AACA,aAAO;AAAA;AAGT,WAAO,IAAI,KACT,MAAM;AACJ;AACA,aAAO;AAAA,OAET,WAAS;AACP;AACA,YAAM;AAAA;AAAA,WAGH,OAAP;AACA;AACA,UAAM;AAAA;AAAA;;;;"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@backstage/test-utils",
3
3
  "description": "Utilities to test Backstage plugins and apps.",
4
- "version": "0.1.17",
4
+ "version": "0.1.21",
5
5
  "private": false,
6
6
  "publishConfig": {
7
7
  "access": "public",
@@ -29,16 +29,15 @@
29
29
  "clean": "backstage-cli clean"
30
30
  },
31
31
  "dependencies": {
32
- "@backstage/core-app-api": "^0.1.8",
33
- "@backstage/core-plugin-api": "^0.1.6",
34
- "@backstage/test-utils-core": "^0.1.2",
35
- "@backstage/theme": "^0.2.9",
32
+ "@backstage/core-app-api": "^0.1.20",
33
+ "@backstage/core-plugin-api": "^0.1.13",
34
+ "@backstage/theme": "^0.2.13",
35
+ "@backstage/types": "^0.1.1",
36
36
  "@material-ui/core": "^4.12.2",
37
37
  "@testing-library/jest-dom": "^5.10.1",
38
38
  "@testing-library/react": "^11.2.5",
39
39
  "@testing-library/user-event": "^13.1.8",
40
40
  "@types/react": "*",
41
- "msw": "^0.29.0",
42
41
  "react": "^16.12.0",
43
42
  "react-dom": "^16.12.0",
44
43
  "react-router": "6.0.0-beta.0",
@@ -46,12 +45,12 @@
46
45
  "zen-observable": "^0.8.15"
47
46
  },
48
47
  "devDependencies": {
49
- "@backstage/cli": "^0.7.8",
48
+ "@backstage/cli": "^0.8.2",
50
49
  "@types/jest": "^26.0.7",
51
50
  "@types/node": "^14.14.32"
52
51
  },
53
52
  "files": [
54
53
  "dist"
55
54
  ],
56
- "gitHead": "90439d524d1228d1d1660ac5568e9f4d1af1832c"
55
+ "gitHead": "5bdaccc40b4a814cf0b45d429f15a3afacc2f60b"
57
56
  }