-
Notifications
You must be signed in to change notification settings - Fork 8.6k
[Cases] Add cases.removeTags workflow step
#268465
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.
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
Open
janmonschke
wants to merge
4
commits into
elastic:main
Choose a base branch
from
janmonschke:cases/add-remove-tag-workflow-step
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
56 changes: 56 additions & 0 deletions
56
x-pack/platform/plugins/shared/cases/common/workflows/steps/remove_tags.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import type { z } from '@kbn/zod/v4'; | ||
| import { StepCategory } from '@kbn/workflows'; | ||
| import type { CommonStepDefinition } from '@kbn/workflows-extensions/common'; | ||
| import { CaseTags } from '../../bundled-types.gen'; | ||
| import * as i18n from '../translations'; | ||
| import { | ||
| CasesStepBaseConfigSchema, | ||
| CasesStepCaseIdSchema, | ||
| CasesStepSingleCaseOutputSchema, | ||
| } from './shared'; | ||
|
|
||
| export const RemoveTagsStepTypeId = 'cases.removeTags'; | ||
|
|
||
| const InputSchema = CasesStepCaseIdSchema.extend({ | ||
| tags: CaseTags, | ||
| }); | ||
|
|
||
| const OutputSchema = CasesStepSingleCaseOutputSchema; | ||
|
|
||
| type RemoveTagsStepInputSchema = typeof InputSchema; | ||
| type RemoveTagsStepOutputSchema = typeof OutputSchema; | ||
|
|
||
| export type RemoveTagsStepInput = z.infer<typeof InputSchema>; | ||
|
|
||
| export const removeTagsStepCommonDefinition: CommonStepDefinition< | ||
| RemoveTagsStepInputSchema, | ||
| RemoveTagsStepOutputSchema | ||
| > = { | ||
| id: RemoveTagsStepTypeId, | ||
| category: StepCategory.KibanaCases, | ||
| label: i18n.REMOVE_TAG_STEP_LABEL, | ||
| description: i18n.REMOVE_TAG_STEP_DESCRIPTION, | ||
| documentation: { | ||
| details: i18n.REMOVE_TAG_STEP_DOCUMENTATION_DETAILS, | ||
| examples: [ | ||
| `## Remove case tags | ||
| \`\`\`yaml | ||
| - name: remove_case_tags | ||
| type: ${RemoveTagsStepTypeId} | ||
| with: | ||
| case_id: "abc-123-def-456" | ||
| tags: ["investigation", "high-priority"] | ||
| \`\`\``, | ||
| ], | ||
| }, | ||
| inputSchema: InputSchema, | ||
| outputSchema: OutputSchema, | ||
| configSchema: CasesStepBaseConfigSchema, | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
71 changes: 71 additions & 0 deletions
71
x-pack/platform/plugins/shared/cases/server/workflows/steps/remove_tags.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import { createCaseResponseFixture } from '../../../common/fixtures/create_case'; | ||
| import type { CasesClient } from '../../client'; | ||
| import { removeTagsStepDefinition } from './remove_tags'; | ||
| import { createStepHandlerContext } from './test_utils'; | ||
|
|
||
| const createContext = (input: unknown) => | ||
| createStepHandlerContext({ input, stepType: 'cases.removeTags' }); | ||
|
|
||
| describe('removeTagsStepDefinition', () => { | ||
| it('removes tags from a case', async () => { | ||
| const inputTags = ['triage', 'coke']; | ||
| const remainingTags = ['pepsi']; | ||
| const currentCase = { ...createCaseResponseFixture, tags: ['coke', 'pepsi', 'triage'] }; | ||
| const get = jest.fn().mockResolvedValue(currentCase); | ||
| const bulkUpdate = jest | ||
| .fn() | ||
| .mockResolvedValue([{ ...createCaseResponseFixture, tags: remainingTags }]); | ||
| const getCasesClient = jest.fn().mockResolvedValue({ | ||
| cases: { get, bulkUpdate }, | ||
| } as unknown as CasesClient); | ||
| const definition = removeTagsStepDefinition(getCasesClient); | ||
|
|
||
| const result = await definition.handler(createContext({ case_id: 'case-1', tags: inputTags })); | ||
|
|
||
| expect(definition.id).toBe('cases.removeTags'); | ||
| expect(get).toHaveBeenCalledWith({ id: 'case-1', includeComments: false }); | ||
| expect(bulkUpdate).toHaveBeenCalledWith({ | ||
| cases: [ | ||
| expect.objectContaining({ | ||
| id: 'case-1', | ||
| version: currentCase.version, | ||
| tags: remainingTags, | ||
| }), | ||
| ], | ||
| }); | ||
| expect(result).toEqual({ | ||
| output: { | ||
| case: { ...createCaseResponseFixture, tags: remainingTags }, | ||
| }, | ||
| }); | ||
| }); | ||
|
|
||
| it('leaves tags unchanged when none of the input tags are present', async () => { | ||
| const currentCase = { ...createCaseResponseFixture, tags: ['coke', 'pepsi'] }; | ||
| const get = jest.fn().mockResolvedValue(currentCase); | ||
| const bulkUpdate = jest.fn().mockResolvedValue([currentCase]); | ||
| const getCasesClient = jest.fn().mockResolvedValue({ | ||
| cases: { get, bulkUpdate }, | ||
| } as unknown as CasesClient); | ||
| const definition = removeTagsStepDefinition(getCasesClient); | ||
|
|
||
| await definition.handler(createContext({ case_id: 'case-1', tags: ['triage'] })); | ||
|
|
||
| expect(bulkUpdate).toHaveBeenCalledWith({ | ||
| cases: [ | ||
| expect.objectContaining({ | ||
| id: 'case-1', | ||
| version: currentCase.version, | ||
| tags: ['coke', 'pepsi'], | ||
| }), | ||
| ], | ||
| }); | ||
| }); | ||
| }); |
38 changes: 38 additions & 0 deletions
38
x-pack/platform/plugins/shared/cases/server/workflows/steps/remove_tags.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import type { KibanaRequest } from '@kbn/core/server'; | ||
| import { createServerStepDefinition } from '@kbn/workflows-extensions/server'; | ||
| import { | ||
| removeTagsStepCommonDefinition, | ||
| type RemoveTagsStepInput, | ||
| } from '../../../common/workflows/steps/remove_tags'; | ||
| import type { CasesClient } from '../../client'; | ||
| import { createCasesStepHandler } from './utils'; | ||
| import { updateSingleCaseFromInput } from './update_case_helpers'; | ||
|
|
||
| export const removeTagsStepDefinition = ( | ||
| getCasesClient: (request: KibanaRequest) => Promise<CasesClient> | ||
| ) => | ||
| createServerStepDefinition({ | ||
| ...removeTagsStepCommonDefinition, | ||
| handler: createCasesStepHandler(getCasesClient, async (client, input: RemoveTagsStepInput) => { | ||
| const currentCase = await client.cases.get({ | ||
| id: input.case_id, | ||
| includeComments: false, | ||
| }); | ||
|
|
||
| const tagsToRemove = new Set(input.tags); | ||
| const tags = (currentCase.tags ?? []).filter((tag) => !tagsToRemove.has(tag)); | ||
|
|
||
| return updateSingleCaseFromInput( | ||
| client, | ||
| { ...input, version: currentCase.version }, | ||
| { tags } | ||
| ); | ||
| }), | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same for below