Add server rendering service to enable standalone route rendering by eliperelman · Pull Request #52161 · elastic/kibana

eliperelman · 2019-12-04T09:43:09Z

Summary

Introduces a new backend application service which exposes rendering ability from a registered provider. The new server rendering service exposes a RenderingProvider to core for contextual rendering access during an HTTP request: await context.core.rendering.render(). This can be used directly as the content (i.e. response body) for a bootstrapped page.

Blocks #51527.

TODO

File an issue to migrate the bootstrap.js endpoint
File an issue to remove injected vars from KP
Ping teams to removed injected vars

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

~~This was checked for cross-browser compatibility, including a check against IE11~~
~~Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support~~
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
~~This was checked for keyboard-only and screenreader accessibility~~

For maintainers

This was checked for breaking API changes and was labeled appropriately
This includes a feature addition or change that requires a release note and was labeled appropriately

Dev Docs

Render a bootstrapped HTML page from a route handler using the RenderingService from your server plugin:

const router = createRouter();

router.get(
  { path: '/', validate: false },
  (context, request, response) =>
    response.ok({
      headers: {
        'content-security-policy': context.core.http.csp.header,
      },
      body: await context.core.rendering.render(),
    })
);

elasticmachine · 2019-12-04T09:43:13Z

Pinging @elastic/kibana-platform (Team:Platform)

src/legacy/server/kbn_server.js

elasticmachine · 2019-12-04T09:58:28Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: db70d9cc59742b125d74094566fd48e05ad2f7c7

src/core/server/rendering/rendering_provider.tsx

src/core/server/http/csp.test.ts

src/core/server/http/http_config.ts

src/core/server/http/http_service.mock.ts

src/core/server/legacy/legacy_service.ts

src/core/server/rendering/types.ts

src/legacy/server/kbn_server.d.ts

src/legacy/ui/ui_render/ui_render_mixin.js

src/plugins/testbed/server/index.ts

test/api_integration/apis/core/index.js

elasticmachine · 2019-12-04T19:00:47Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: 813641e724fd8ef1511ed432d544bfcc3bb8537b

elasticmachine · 2019-12-04T20:29:36Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: 290d348996c52dfb2d68e24c1f08d332f978e68b

joshdover

A few issues I noticed:

The Kibana logo is missing on the bootstrap loading page spinner
The frontend fails to boot with this error: A legacy application is already registered with the id "siem" (I'm guessing you already noticed this one though)

src/core/server/rendering/types.ts

src/core/server/rendering/rendering_service.ts

src/legacy/ui/ui_render/ui_render_mixin.js

test/api_integration/apis/core/index.js

src/core/server/rendering/create_metadata_factory.ts

x-pack/legacy/plugins/spaces/index.ts

src/core/server/legacy/plugins/get_nav_links.ts

src/core/server/rendering/create_metadata_factory.ts

src/core/server/rendering/create_metadata_factory.test.ts

src/core/server/rendering/create_metadata_factory.ts

src/core/server/rendering/rendering_provider.test.ts

kibanamachine · 2019-12-28T05:37:54Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: becf2bb

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

kibanamachine · 2019-12-28T10:13:49Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 983bc52

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

…astic#52161) * Add server rendering service to enable standalone route rendering * Update renovate config * Move legacy rendering functionality to legacy service * Use config for exposed variable in new platform * Lint changes from rebase * Rebase artifact * Remove RenderingProvider, add tests for legacy vars implementation, review notes * Add UI app functionality to legacy service * Update rendering snapshots * Update docs * Fix up functional tests * Clean up legacy types * Revise types from reverting injected metadata changes * Update translations and broken tests * Mock legacy internals in legacy tests * Add missing doc types * Rename InternalRenderOptions to LegacyRenderOptions * Remove extraneous legacy exports, review nits * Functional tests fixes * Rebase, attempt CI test fixes * Only allow specified appIds in testbed rendering integration test * Update snapshot names * Review nits

…2161) (#53832) * Add server rendering service to enable standalone route rendering * Update renovate config * Move legacy rendering functionality to legacy service * Use config for exposed variable in new platform * Lint changes from rebase * Rebase artifact * Remove RenderingProvider, add tests for legacy vars implementation, review notes * Add UI app functionality to legacy service * Update rendering snapshots * Update docs * Fix up functional tests * Clean up legacy types * Revise types from reverting injected metadata changes * Update translations and broken tests * Mock legacy internals in legacy tests * Add missing doc types * Rename InternalRenderOptions to LegacyRenderOptions * Remove extraneous legacy exports, review nits * Functional tests fixes * Rebase, attempt CI test fixes * Only allow specified appIds in testbed rendering integration test * Update snapshot names * Review nits

* master: Allow chromeless applications to render via non-/app routes (elastic#51527) Add server rendering service to enable standalone route rendering (elastic#52161)

…le-saved-objects * 'master' of github.com:elastic/kibana: (250 commits) Allow chromeless applications to render via non-/app routes (elastic#51527) Add server rendering service to enable standalone route rendering (elastic#52161) Possibility to filter when testing scripted fields (elastic#35379) (elastic#44220) Update maps telemetry mappings to account for recent updates (elastic#53803) [Maps] Only show legend when layer is visible (elastic#53781) remove use of experimental fs.promises api (elastic#53346) [APM] Add log statements for flaky test (elastic#53775) [APM] Transaction page throws unhandled exception if transactions doesn't have `http.request` (elastic#53760) Licensing plugin functional tests (elastic#53580) [Lens] Disable saving visualization until there are no changes to the document (elastic#52982) [Monitoring] Added safeguard for some EUI components (elastic#53318) [Vega] Shim new platform - cleanup vega_visualization dependencies (elastic#53605) Display changed field formats without requiring hard page refresh. (elastic#53746) Upgrade EUI to v17.3.1 (elastic#53655) [APM] Fix missing apm indicies (elastic#53541) Disable inspector for timelion (elastic#53747) Clean up search servie (elastic#53701) [Dashboard] Grid: removing double handler (elastic#53707) Remove SavedObjectRegistryProvider from codebase (elastic#53455) Move ui/courier into data shim plugin (elastic#52359) ...

…ris/kibana into alerting/created_at-and-updated_at * 'alerting/created_at-and-updated_at' of github.com:gmmorris/kibana: Allow chromeless applications to render via non-/app routes (elastic#51527) Add server rendering service to enable standalone route rendering (elastic#52161)

…astic#52161) * Add server rendering service to enable standalone route rendering * Update renovate config * Move legacy rendering functionality to legacy service * Use config for exposed variable in new platform * Lint changes from rebase * Rebase artifact * Remove RenderingProvider, add tests for legacy vars implementation, review notes * Add UI app functionality to legacy service * Update rendering snapshots * Update docs * Fix up functional tests * Clean up legacy types * Revise types from reverting injected metadata changes * Update translations and broken tests * Mock legacy internals in legacy tests * Add missing doc types * Rename InternalRenderOptions to LegacyRenderOptions * Remove extraneous legacy exports, review nits * Functional tests fixes * Rebase, attempt CI test fixes * Only allow specified appIds in testbed rendering integration test * Update snapshot names * Review nits

kibanamachine · 2020-01-09T18:57:28Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: 983bc52

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

flash1293 · 2020-01-16T08:56:54Z

@eliperelman It seems like there is a small typo in your dev docs example -

        'content-security-policy': context.core.http.csp.header,

should actually be

        'content-security-policy': core.http.csp.header,

At least that's what the types say. Could you confirm?

eliperelman added Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// Feature:New Platform release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. v8.0.0 v7.6.0 labels Dec 4, 2019

eliperelman requested review from epixa, joshdover, mshustov and pgayvallet December 4, 2019 09:43

eliperelman requested review from a team as code owners December 4, 2019 09:43

eliperelman self-assigned this Dec 4, 2019

eliperelman commented Dec 4, 2019

View reviewed changes

src/legacy/server/kbn_server.js Outdated Show resolved Hide resolved

eliperelman mentioned this pull request Dec 4, 2019

Allow chromeless applications to render via non-/app routes #51527

Merged

7 tasks

pgayvallet reviewed Dec 4, 2019

View reviewed changes

eliperelman force-pushed the feature/rendering-service branch from db70d9c to 813641e Compare December 4, 2019 18:47

joshdover reviewed Dec 4, 2019

View reviewed changes

kobelb reviewed Dec 5, 2019

View reviewed changes

x-pack/legacy/plugins/spaces/index.ts Outdated Show resolved Hide resolved