Skip to content

[Guided onboarding] Change the saved objects' type to hidden #148983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yuliacech merged 7 commits into from
Feb 6, 2023
Merged

[Guided onboarding] Change the saved objects' type to hidden #148983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4a55f5d
[Guided onboarding] Change the saved objects' type to hidden
yuliacech Jan 16, 2023
1794197
Merge branch 'main' into guided_onboarding/8.7/hidden_saved_objects
yuliacech Jan 18, 2023
4932c65
Merge branch 'main' into guided_onboarding/8.7/hidden_saved_objects
yuliacech Jan 26, 2023
03058ce
Merge branch 'main' into guided_onboarding/8.7/hidden_saved_objects
yuliacech Jan 30, 2023
6f28484
Merge branch 'main' into guided_onboarding/8.7/hidden_saved_objects
yuliacech Feb 1, 2023
c47a2d3
Merge branch 'main' into guided_onboarding/8.7/hidden_saved_objects
yuliacech Feb 6, 2023
288bc3c
Merge branch 'main' into guided_onboarding/8.7/hidden_saved_objects
yuliacech Feb 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/plugins/guided_onboarding/server/routes/guide_state_routes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import { IRouter, SavedObjectsClient } from '@kbn/core/server';
import { API_BASE_PATH } from '../../common';
import { findAllGuides } from '../helpers';
import { guideStateSavedObjectsType } from '../saved_objects';

export const registerGetGuideStateRoute = (router: IRouter) => {
// Fetch all guides state
Expand All @@ -19,7 +20,9 @@ export const registerGetGuideStateRoute = (router: IRouter) => {
},
async (context, request, response) => {
const coreContext = await context.core;
const soClient = coreContext.savedObjects.client as SavedObjectsClient;
const soClient = coreContext.savedObjects.getClient({
includedHiddenTypes: [guideStateSavedObjectsType],
}) as SavedObjectsClient;

const existingGuides = await findAllGuides(soClient);

Expand Down
9 changes: 7 additions & 2 deletions src/plugins/guided_onboarding/server/routes/plugin_state_routes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import { IRouter, SavedObjectsClient } from '@kbn/core/server';
import { schema } from '@kbn/config-schema';
import { GuideState } from '@kbn/guided-onboarding';
import { guideStateSavedObjectsType, pluginStateSavedObjectsType } from '../saved_objects';
import { getPluginState, updatePluginStatus } from '../helpers/plugin_state_utils';
import { API_BASE_PATH } from '../../common';
import { updateGuideState } from '../helpers';
Expand All @@ -21,7 +22,9 @@ export const registerGetPluginStateRoute = (router: IRouter) => {
},
async (context, request, response) => {
const coreContext = await context.core;
const savedObjectsClient = coreContext.savedObjects.client as SavedObjectsClient;
const savedObjectsClient = coreContext.savedObjects.getClient({
includedHiddenTypes: [pluginStateSavedObjectsType, guideStateSavedObjectsType],
}) as SavedObjectsClient;
const pluginState = await getPluginState(savedObjectsClient);
return response.ok({
body: {
Expand Down Expand Up @@ -59,7 +62,9 @@ export const registerPutPluginStateRoute = (router: IRouter) => {
const { status, guide } = request.body as { status?: string; guide?: GuideState };

const coreContext = await context.core;
const savedObjectsClient = coreContext.savedObjects.client as SavedObjectsClient;
const savedObjectsClient = coreContext.savedObjects.getClient({
includedHiddenTypes: [pluginStateSavedObjectsType, guideStateSavedObjectsType],
}) as SavedObjectsClient;

if (status) {
await updatePluginStatus(savedObjectsClient, status);
Expand Down
6 changes: 4 additions & 2 deletions src/plugins/guided_onboarding/server/saved_objects/guided_setup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ export const guideStateSavedObjectsType = 'guided-onboarding-guide-state';

export const guideStateSavedObjects: SavedObjectsType = {
name: guideStateSavedObjectsType,
hidden: false,
// hidden SO can't be changed by the SO client except when explicitly declared
hidden: true,
// make it available in all spaces for now https://github.com/elastic/kibana/issues/144227
namespaceType: 'agnostic',
mappings: {
Expand All @@ -33,7 +34,8 @@ export const pluginStateSavedObjectsId = 'guided-onboarding-plugin-state-id';

export const pluginStateSavedObjects: SavedObjectsType = {
name: pluginStateSavedObjectsType,
hidden: false,
// hidden SO can't be changed by the SO client except when explicitly declared
hidden: true,
// make it available in all spaces for now https://github.com/elastic/kibana/issues/144227
namespaceType: 'agnostic',
mappings: {
Expand Down