[Content Management] Server side client

[sebelga]

In this PR I'v added a server side client for Content management.
The client operates on a single content type and has the same methods as the content storage:

• get
• bulkGet
• create
• update
• delete
• search

I've also exposed an multi type search client with a single method to search accros different content types.
Currently it only support searching content types stored using the Saved object client.

• msearch

API

When registering a content type

// 1. When registering the content type on the server, a content client for this specific content is returned
const { contentClient } = contentManagement.register({
  id: CONTENT_ID,
  storage: new MapsStorage(), // Instantiate our storage class
  version: {
    latest: LATEST_VERSION,
  },
});

// 2. On an incoming HTTP request we instantiate the client for this request
const client = contentClient.getForRequest({
  request, // the Kibana HTTP request
  requestHandlerContext, // the Kibana Request context
  version, // OPTIONAL: the browser client content version
});

// 3. We can now use any of the client method (e.g. fetch a map with ID '123')
const myMap = await client.get('123');

From the plugin setup contract

// setup lifecycle
const { contentClient } = plugins.contentManagement;

// Instantiate the factory for an incoming request
const client = contentClient.getForRequest({
  request,
  requestHandlerContext,
});

// Get a client for "dashboards" content type on version "2"
// Note: version is optional and will default to the latest version of the content if not provided
// It is recommended to provide the version of the browser making the request to be able to up/down transform the
// content if need be.
const dashboardClient = client.for("dashboards", 2);

// Fetch a dashboard
const myDashboard = await dashboardClient.get("123");

// -------------- Multi content type search --------------------

// Instantiate the factory for an incoming request
const client = contentClient.getForRequest({
  request,
  requestHandlerContext,
});

const { hits } = await client.msearch({
  contentTypes: [
    { contentTypeId: "dashboards" }, // optionally a "version" can be provided (defaults to "latest")
    { contentTypeId: "lens" },
  ],
  query: { text:  "my title" }
});

Notes on implementation

I've replaced the code in all the RPC procedures to consume the clients. This means that appart from the unit tests that I've added, the server side client is used on all the functional tests for the content registered in CM.

Fixes #154836
Fixes #170877

[sebelga]

/ci

[sebelga]

/ci

[elasticmachine]

Pinging @elastic/appex-sharedux (Team:SharedUX)

[sebelga]

Pinging @mattkime @thomasneirynck @davismcphee as you all requested this feature to be released at some point.
Feedback welcome on the provided API or any part of the code 😊

[sebelga]

/ci

[sebelga]

@elasticmachine run elasticsearch-ci/docs

[sebelga]

/ci

[tsullivan]

LGTM, very straightforward CRUD additions

[tsullivan]

Note to self: this never gets stored. I had to check because that could pose an issue if we ever handle a token that was created in a separate Kibana instance

[sebelga]

Thanks for the review @tsullivan !

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: fe950a5

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
contentManagement	126	125	-1

History

• 💚 Build #191093 succeeded 6b247ae
• 💚 Build #190820 succeeded 7fe6871
• 💚 Build #190786 succeeded d81a968
• 💛 Build #190714 was flaky 73a0d61
• 💚 Build #190594 succeeded c3e07b2

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

cc @sebelga

[thomasneirynck]

thx @sebelga this will be useful when looking at #174497