[CM] Setup client side content client by Dosant · Pull Request #150171 · elastic/kibana

Dosant · 2023-02-02T13:53:19Z

Summary

Partially addresses #149216, #149939
Closes #149217

Setup basic client-side content client (client, cache, react content and hooks) based on the latest API from @sebelga's server-side and rpc POC. We assume that the POC isn't far from the initial version that we are going to merge to main

The client side content client is based on the proposal described in private doc

Initial content client implementation scope:

We start from using tanstack/query for client side caching, content queuing and mutating . Also use it as a basis for the API. We start from their defaults and will adjust defaults as we go. Basically our content client would be a helpful wrapper around tanstack/query (at least initially)
We start from exposing minimal query lib API surface, but we will gradually expose more as needed
For content retrieval we support promise based, RXJS observable based and react hook based methods
For the RPC/api I copied over the latest from server-side and rpc POC assuming it won't change much.
no optimistic update or automatic invalidation after updates yet (this will be later)
just get and create for now

Dosant · 2023-02-02T13:54:43Z

src/plugins/content_management/common/rpc.ts

@@ -0,0 +1,72 @@
+/*


This file is copy paste from the server-side POC #148791.

Assuming this won't change much when initial server-side is merged to main. Also won't be a problem if this is changed a lot

Dosant · 2023-02-02T13:55:27Z

src/plugins/content_management/public/rpc_client/rpc_client.ts

+import { API_ENDPOINT } from '../../common';
+import type { GetIn, CreateIn, ProcedureName } from '../../common';
+
+export class RpcClient {


This file is copy paste from the server-side POC #148791.

Assuming this won't change much when initial server-side is merged to main. Also won't be a problem if this is changed a lot

elasticmachine · 2023-02-02T13:59:02Z

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

…fix'

Dosant · 2023-02-06T10:56:33Z

@elasticmachine merge upstream

…fix'

vadimkibana

LGTM

…na into d/2023-02-02-cm-setup-client

Dosant · 2023-02-07T10:38:32Z

@elasticmachine merge upstream

sebelga

Great work @Dosant ! I left a few nit comments but looks good 👍

src/plugins/content_management/public/content_client/content_client.tsx

sebelga · 2023-02-07T11:12:04Z

src/plugins/content_management/public/content_client/content_client.test.ts

+  it('calls rpcClient.get with input and returns output', async () => {
+    const input: GetIn = { id: 'test', contentType: 'testType' };
+    const output = { test: 'test' };
+    rpcClient.get.mockImplementation(() => Promise.resolve(output));


nit: could be rpcClient.get.mockResolvedValueOnce(output);

sebelga · 2023-02-07T11:13:22Z

src/plugins/content_management/public/content_client/content_client.test.ts

+import { createRpcClientMock } from '../rpc_client/rpc_client.mock';
+import { ContentClient } from './content_client';
+import type { GetIn, CreateIn } from '../../common';
+import { lastValueFrom } from 'rxjs';


nit: can we put absolute imports above relative ones?

Was it supposed to be linted? 🤔

sebelga · 2023-02-07T11:58:38Z

src/plugins/content_management/public/content_client/content_client_mutation_hooks.test.tsx

+);
+
+describe('useCreateContentMutation', () => {
+  test('should call rpcClient.get with input and resolve with output', async () => {


nit: ... "rpcClient.create"

sebelga · 2023-02-07T12:40:43Z

src/plugins/content_management/public/plugin.ts

-  public start() {
-    return {};
+  public start(core: CoreStart, deps: StartDependencies) {
+    // don't actually expose the client until it is used to avoid increasing bundle size


Dosant · 2023-02-07T14:56:29Z

@elasticmachine merge upstream

kibana-ci · 2023-02-07T15:58:14Z

💚 Build Succeeded

Buildkite Build
Commit: 2158319

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`	5	22	+17

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`contentManagement`	0	1	+1

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`contentManagement`	1.2KB	1.2KB	+12.0B

Unknown metric groups

API count

id	before	after	diff
`contentManagement`	5	22	+17

History

💚 Build #106008 succeeded 765af05
💛 Build #105725 was flaky df2d6bd
💚 Build #105599 succeeded b704196
💚 Build #105156 succeeded 16e8b91
💔 Build #105111 failed 290c7ea

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

…hods (#151041) Nothing to write home about - just a bit more boilerplate setup code. Method signatures and RPC related interfaces are expected to be changed later with an initial RPC layer implementation. - Follow-up to #150171, adding a dummy setup for `update` `delete` and `search` methods. **The `IN` and `OUT` args will be changes when we glue these to the rpc service and its types** - Also clean up unit tests a bit to have setup logic contained in a helper instead of scattered in global scope

…hods (elastic#151041) Nothing to write home about - just a bit more boilerplate setup code. Method signatures and RPC related interfaces are expected to be changed later with an initial RPC layer implementation. - Follow-up to elastic#150171, adding a dummy setup for `update` `delete` and `search` methods. **The `IN` and `OUT` args will be changes when we glue these to the rpc service and its types** - Also clean up unit tests a bit to have setup logic contained in a helper instead of scattered in global scope

Setup client side content client

04060f3

Dosant commented Feb 2, 2023

View reviewed changes

Dosant added Feature:Content Management User generated content (saved objects) management release_note:skip Skip the PR/issue when compiling release notes Team:SharedUX Platform AppEx-SharedUX (formerly Global Experience) t// labels Feb 2, 2023

Dosant requested review from sebelga and vadimkibana February 2, 2023 13:58

Dosant marked this pull request as ready for review February 2, 2023 13:58

kibanamachine and others added 2 commits February 2, 2023 13:59

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

290c7ea

…fix'

don’t increase bundle size until needed

16e8b91

kibanamachine and others added 3 commits February 6, 2023 05:56

Merge branch 'main' into d/2023-02-02-cm-setup-client

d6b7fbe

add basic content client tests

c10ee8e

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

b704196

…fix'

vadimkibana approved these changes Feb 6, 2023

View reviewed changes

Dosant added 2 commits February 6, 2023 16:07

add more tests

5de9d5f

Merge branch 'd/2023-02-02-cm-setup-client' of github.com:Dosant/kiba…

df2d6bd

…na into d/2023-02-02-cm-setup-client

Merge branch 'main' into d/2023-02-02-cm-setup-client

765af05

sebelga approved these changes Feb 7, 2023

View reviewed changes

clean up

2ba0f27

Merge branch 'main' into d/2023-02-02-cm-setup-client

2158319

Dosant merged commit 6d96f51 into elastic:main Feb 7, 2023

Dosant mentioned this pull request Feb 7, 2023

[CM] Setup browse-side cache #149939

Closed

3 tasks

kibanamachine added v8.7.0 backport:skip This PR does not require backporting labels Feb 7, 2023

Dosant mentioned this pull request Feb 7, 2023

[CM] Setup browser-side service #149216

Closed

4 tasks

This was referenced Feb 8, 2023

[CM] Setup browser-side RPC client #149940

Closed

[CM] Client-side content client: setup update delete search methods #151041

Merged

Conversation

Dosant commented Feb 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

Dosant Feb 2, 2023

Choose a reason for hiding this comment

Uh oh!

Dosant Feb 2, 2023

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Feb 2, 2023

Uh oh!

Dosant commented Feb 6, 2023

Uh oh!

vadimkibana left a comment

Choose a reason for hiding this comment

Uh oh!

Dosant commented Feb 7, 2023

Uh oh!

sebelga left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sebelga Feb 7, 2023

Choose a reason for hiding this comment

Uh oh!

sebelga Feb 7, 2023

Choose a reason for hiding this comment

Uh oh!

Dosant Feb 7, 2023

Choose a reason for hiding this comment

Uh oh!

sebelga Feb 7, 2023

Choose a reason for hiding this comment

Uh oh!

sebelga Feb 7, 2023

Choose a reason for hiding this comment

Uh oh!

Dosant commented Feb 7, 2023

Uh oh!

kibana-ci commented Feb 7, 2023

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Public APIs missing exports

Page load bundle

API count

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Dosant commented Feb 2, 2023 •

edited

Loading