Merge branch 'master' into ml-licence-msg

dev_docs/tutorials/debugging.mdx

@@ -0,0 +1,61 @@
+---
+id: kibDevTutorialDebugging
+slug: /kibana-dev-docs/tutorial/debugging
+title: Debugging in development
+summary: Learn how to debug Kibana while running from source
+date: 2021-04-26
+tags: ['kibana', 'onboarding', 'dev', 'tutorials', 'debugging']
+---
+
+There are multiple ways to go about debugging Kibana when running from source.
+
+## Debugging using Chrome DevTools
+
+You will need to run Node using `--inspect` or `--inspect-brk` in order to enable the inspector. Additional information can be found in the [Node.js docs](https://nodejs.org/en/docs/guides/debugging-getting-started/).
+
+Once Node is running with the inspector enabled, you can open `chrome://inspect` in your Chrome browser. You should see a remote target for the inspector running. Click "inspect". You can now begin using the debugger.
+
+Next we will go over how to exactly enable the inspector for different aspects of the codebase.
+
+### Jest Unit Tests
+
+You will need to run Jest directly from the Node script:
+
+`node --inspect-brk scripts/jest [TestPathPattern]`
+
+### Functional Test Runner
+
+`node --inspect-brk scripts/functional_test_runner`
+
+### Development Server 
+
+`node --inspect-brk scripts/kibana`
+
+## Debugging using logging
+
+When running Kibana, it's sometimes helpful to enable verbose logging.
+
+`yarn start --verbose`
+
+Using verbose logging usually results in much more information than you're interested in. The [logging documentation](https://www.elastic.co/guide/en/kibana/current/logging-settings.html) covers ways to change the log level of certain types.
+
+In the following example of a configuration stored in `config/kibana.dev.yml` we are logging all Elasticsearch queries and any logs created by the Management plugin.
+
+```
+logging:
+  appenders:
+    console:
+      type: console
+      layout:
+        type: pattern
+        highlight: true
+  root:
+    appenders: [default, console]
+    level: info
+
+  loggers:
+    - name: plugins.management
+      level: debug
+    - name: elasticsearch.query
+      level: debug
+```

src/plugins/discover/public/application/angular/doc_table/components/row_headers.test.js

@@ -19,6 +19,7 @@ import { setScopedHistory, setServices, setDocViewsRegistry } from '../../../../
 import { coreMock } from '../../../../../../../core/public/mocks';
 import { dataPluginMock } from '../../../../../../data/public/mocks';
 import { navigationPluginMock } from '../../../../../../navigation/public/mocks';
+import { initAngularBootstrap } from '../../../../../../kibana_legacy/public/angular_bootstrap';
 import { getInnerAngularModule } from '../../get_inner_angular';
 import { createBrowserHistory } from 'history';
 
@@ -41,6 +42,9 @@ describe('Doc Table', () => {
   // Stub out a minimal mapping of 4 fields
   let mapping;
 
+  beforeAll(async () => {
+    await initAngularBootstrap();
+  });
   beforeAll(() => setScopedHistory(createBrowserHistory()));
   beforeEach(() => {
     angular.element.prototype.slice = jest.fn(function (index) {

src/plugins/discover/public/application/angular/doc_table/doc_table.test.js

@@ -17,6 +17,7 @@ import hits from '../../../__fixtures__/real_hits';
 import { coreMock } from '../../../../../../core/public/mocks';
 import { dataPluginMock } from '../../../../../data/public/mocks';
 import { navigationPluginMock } from '../../../../../navigation/public/mocks';
+import { initAngularBootstrap } from '../../../../../kibana_legacy/public/angular_bootstrap';
 import { setScopedHistory, setServices } from '../../../kibana_services';
 import { getInnerAngularModule } from '../get_inner_angular';
 
@@ -54,6 +55,9 @@ describe('docTable', () => {
   const core = coreMock.createStart();
   let $elem;
 
+  beforeAll(async () => {
+    await initAngularBootstrap();
+  });
   beforeAll(() => setScopedHistory(createBrowserHistory()));
   beforeEach(() => {
     angular.element.prototype.slice = jest.fn(() => {

src/plugins/discover/public/application/angular/get_inner_angular.ts

@@ -33,13 +33,12 @@ import { createDocViewerDirective } from './doc_viewer';
 import { createDiscoverGridDirective } from './create_discover_grid_directive';
 import { createRenderCompleteDirective } from './directives/render_complete';
 import {
-  initAngularBootstrap,
   configureAppAngularModule,
   PrivateProvider,
-  PromiseServiceCreator,
   registerListenEventListener,
   watchMultiDecorator,
 } from '../../../../kibana_legacy/public';
+import { PromiseServiceCreator } from './helpers';
 import { DiscoverStartPlugins } from '../../plugin';
 import { getScopedHistory } from '../../kibana_services';
 import { createDiscoverDirective } from './create_discover_directive';
@@ -54,7 +53,6 @@ export function getInnerAngularModule(
   deps: DiscoverStartPlugins,
   context: PluginInitializerContext
 ) {
-  initAngularBootstrap();
   const module = initializeInnerAngularModule(name, core, deps.navigation, deps.data);
   configureAppAngularModule(module, { core, env: context.env }, true, getScopedHistory);
   return module;

src/plugins/discover/public/application/angular/helpers/index.ts

@@ -8,3 +8,4 @@
 
 export { formatRow, formatTopLevelObject } from './row_formatter';
 export { handleSourceColumnState } from './state_helpers';
+export { PromiseServiceCreator } from './promises';

src/plugins/discover/public/plugin.tsx

@@ -403,6 +403,7 @@ export class DiscoverPlugin
       }
       // this is used by application mount and tests
       const { getInnerAngularModule } = await import('./application/angular/get_inner_angular');
+      await plugins.kibanaLegacy.loadAngularBootstrap();
       const module = getInnerAngularModule(
         innerAngularName,
         core,
@@ -473,6 +474,7 @@ export class DiscoverPlugin
         throw Error('Discover plugin getEmbeddableInjector:  initializeServices is undefined');
       }
       const { core, plugins } = await this.initializeServices();
+      await getServices().kibanaLegacy.loadAngularBootstrap();
       getServices().kibanaLegacy.loadFontAwesome();
       const { getInnerAngularModuleEmbeddable } = await import(
         './application/angular/get_inner_angular'

src/plugins/kibana_legacy/public/angular/angular_config.tsx

@@ -13,6 +13,7 @@ import {
   ILocationProvider,
   IModule,
   IRootScopeService,
+  IRequestConfig,
 } from 'angular';
 import $ from 'jquery';
 import { set } from '@elastic/safer-lodash-set';
@@ -22,7 +23,6 @@ import { ChromeBreadcrumb, EnvironmentMode, PackageInfo } from 'kibana/public';
 import { History } from 'history';
 
 import { CoreStart } from 'kibana/public';
-import { isSystemApiRequest } from '../utils';
 import { formatAngularHttpError, isAngularHttpError } from '../notify/lib';
 
 export interface RouteConfiguration {
@@ -38,6 +38,11 @@ export interface RouteConfiguration {
   requireUICapability?: string;
 }
 
+function isSystemApiRequest(request: IRequestConfig) {
+  const { headers } = request;
+  return headers && !!headers['kbn-system-request'];
+}
+
 /**
  * Detects whether a given angular route is a dummy route that doesn't
  * require any action. There are two ways this can happen:

src/plugins/kibana_legacy/public/angular/index.ts

@@ -6,8 +6,6 @@
  * Side Public License, v 1.
  */
 
-// @ts-ignore
-export { PromiseServiceCreator } from './promises';
 // @ts-ignore
 export { watchMultiDecorator } from './watch_multi';
 export * from './angular_config';

src/plugins/kibana_legacy/public/index.ts

@@ -14,7 +14,6 @@ export const plugin = (initializerContext: PluginInitializerContext) =>
 
 export * from './plugin';
 
-export { initAngularBootstrap } from './angular_bootstrap';
 export { PaginateDirectiveProvider, PaginateControlsDirectiveProvider } from './paginate/paginate';
 export * from './angular';
 export * from './notify';

src/plugins/kibana_legacy/public/mocks.ts

@@ -22,6 +22,7 @@ const createStartContract = (): Start => ({
     getHideWriteControls: jest.fn(),
   },
   loadFontAwesome: jest.fn(),
+  loadAngularBootstrap: jest.fn(),
 });
 
 export const kibanaLegacyPluginMock = {

src/plugins/kibana_legacy/public/notify/index.ts

@@ -6,5 +6,4 @@
  * Side Public License, v 1.
  */
 
-export * from './toasts';
 export * from './lib';