[GH-862] Added issue status field in subscription modal #976
There are no files selected for viewing
This file contains 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 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 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 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 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 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 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 |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| { | ||
| "expand": "projects", | ||
| "issue_types_with_statuses": [ | ||
| { | ||
| "statuses": [] | ||
| } | ||
|
|
||
This file contains 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 |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| { | ||
| "expand": "projects", | ||
| "issue_types_with_statuses": [ | ||
| { | ||
| "statuses": [] | ||
| } | ||
|
|
||
This file contains 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 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 |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| { | ||
| "expand": "projects", | ||
| "issue_types_with_statuses": [ | ||
| { | ||
| "statuses": [] | ||
| } | ||
|
|
||
This file contains 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 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 |
|---|---|---|
|
|
@@ -5,10 +5,10 @@ import createMeta from 'testdata/cloud-get-create-issue-metadata-for-project-man | |
| import {ticketData} from 'testdata/get-ticket-metadata-for-tooltip'; | ||
| import {useFieldForIssueMetadata} from 'testdata/jira-issue-metadata-helpers'; | ||
|
|
||
| import {IssueMetadata, JiraField, FilterField, ChannelSubscriptionFilters, FilterFieldInclusion} from 'types/model'; | ||
| import {IssueAction, TicketDetails} from 'types/tooltip'; | ||
|
|
||
| import {getCustomFieldFiltersForProjects, generateJQLStringFromSubscriptionFilters, getConflictingFields, jiraIssueToReducer, getStatusField} from './jira_issue_metadata'; | ||
|
|
||
| describe('utils/jira_issue_metadata', () => { | ||
| const useField = (field: JiraField, key: string): IssueMetadata => { | ||
|
|
@@ -293,6 +293,105 @@ describe('utils/jira_issue_metadata', () => { | |
| expect(actual[0].values).toEqual([{value: '10001', label: 'Admin only'}, {value: '10000', label: 'Everyone'}, {value: '10002', label: 'Staff'}]); | ||
| }); | ||
|
|
||
| test('getStatusField should return options for statuses for selected issue types only', () => { | ||
| const metadata: IssueMetadata = { | ||
| projects: [ | ||
| { | ||
| key: 'TEST', | ||
| issuetypes: [], | ||
| }, | ||
| ], | ||
|
There was a problem hiding this comment. Is it realistic to have a blank array for There was a problem hiding this comment. @mickmister No, I don't think this will ever be blank. This particular field is not useful in the function we are testing here, so we kept it empty. I you want we can add some mock data or maybe just add a comment above it. There was a problem hiding this comment. We should try to have realistic test data I suppose. I recommend using the saved test data when possible. Or generate new ones / edit existing ones if we need to update them, which I think we do need to update them in this case since we changed the API associated with the testdata files There was a problem hiding this comment. @mickmister Updated the test files |
||
| issue_types_with_statuses: [ | ||
| { | ||
| id: '10001', | ||
| name: 'Task', | ||
| statuses: [ | ||
| { | ||
| id: '1001', | ||
| name: 'TODO', | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| id: '10002', | ||
| name: 'Story', | ||
| statuses: [ | ||
| { | ||
| id: '1002', | ||
| name: 'In Progress', | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| }; | ||
|
|
||
| const actual = getStatusField(metadata, ['10001']); | ||
| expect(actual).not.toBe(null); | ||
|
|
||
| if (actual) { | ||
| expect(actual.key).toEqual('status'); | ||
| expect(actual.name).toEqual('Status'); | ||
| expect(actual.values).toEqual([{value: '1001', label: 'TODO'}]); | ||
| } | ||
| }); | ||
|
|
||
| test('getStatusField should return options for statuses for all issue types if no issue type is selected', () => { | ||
mickmister marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| const metadata: IssueMetadata = { | ||
| projects: [ | ||
| { | ||
| key: 'TEST', | ||
| issuetypes: [], | ||
| }, | ||
| ], | ||
| issue_types_with_statuses: [ | ||
| { | ||
| id: '10001', | ||
| name: 'Task', | ||
| statuses: [ | ||
| { | ||
| id: '1001', | ||
| name: 'TODO', | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| id: '10002', | ||
| name: 'Story', | ||
| statuses: [ | ||
| { | ||
| id: '1002', | ||
| name: 'In Progress', | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| }; | ||
|
|
||
| const actual = getStatusField(metadata, []); | ||
| expect(actual).not.toBe(null); | ||
|
|
||
| if (actual) { | ||
| expect(actual.key).toEqual('status'); | ||
| expect(actual.name).toEqual('Status'); | ||
| expect(actual.values).toEqual([{value: '1001', label: 'TODO'}, {value: '1002', label: 'In Progress'}]); | ||
| } | ||
| }); | ||
|
|
||
| test('getStatusField should return null for statuses if statuses information is empty', () => { | ||
| const metadata: IssueMetadata = { | ||
| projects: [ | ||
| { | ||
| key: 'TEST', | ||
| issuetypes: [], | ||
| }, | ||
| ], | ||
| issue_types_with_statuses: [], | ||
| }; | ||
|
|
||
| const actual = getStatusField(metadata, []); | ||
| expect(actual).toBe(null); | ||
| }); | ||
|
|
||
| test('should return options with a `userDefined` flag for array of strings', () => { | ||
| const field = { | ||
| autoCompleteUrl: 'https://mmtest.atlassian.net/rest/api/1.0/labels/suggest?customFieldId=10071&query=', | ||
|
|
@@ -388,7 +487,7 @@ describe('utils/jira_issue_metadata', () => { | |
| }; | ||
|
|
||
| const issueMetadata: IssueMetadata = { | ||
| issue_types_with_statuses: [ | ||
| { | ||
| id: '10001', | ||
| name: 'Bug', | ||
|
|
||
This file contains 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 |
|---|---|---|
|
|
@@ -190,6 +190,47 @@ function isValidFieldForFilter(field: JiraField): boolean { | |
| (type === 'array' && allowedArrayTypes.includes(items)); | ||
| } | ||
|
|
||
| export function getStatusField(metadata: IssueMetadata | null, issueTypes: string[]): FilterField | null { | ||
| // Filtering out the statuses on the basis of selected issue types | ||
| const issueTypesWithStatuses = metadata && metadata.issue_types_with_statuses; | ||
| const keys = new Set<string>(); | ||
| const statuses: Status[] = []; | ||
| if (issueTypesWithStatuses) { | ||
| for (const issueType of issueTypesWithStatuses) { | ||
| if (issueTypes.includes(issueType.id) || !issueTypes.length) { | ||
| for (const status of issueType.statuses) { | ||
| if (!keys.has(status.id)) { | ||
| keys.add(status.id); | ||
| statuses.push(status); | ||
|
There was a problem hiding this comment. Will Also it's a bit hard to read will all of the variations of:
Not sure there is a better way though. I was going to suggest renaming the function parameter There was a problem hiding this comment. Just to clarify, There was a problem hiding this comment.
There was a problem hiding this comment. Maybe we can change the name to There was a problem hiding this comment.
@mickmister Already changed |
||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (!statuses.length) { | ||
| return null; | ||
| } | ||
|
|
||
| return { | ||
| key: FIELD_KEY_STATUS, | ||
| name: 'Status', | ||
| schema: { | ||
| type: 'array', | ||
| }, | ||
| values: statuses.map((value) => ({ | ||
| label: value.name, | ||
| value: value.id, | ||
| })), | ||
| issueTypes: metadata && metadata.issue_types_with_statuses.map((type) => { | ||
| return { | ||
| id: type.id, | ||
| name: type.name, | ||
| }; | ||
| }), | ||
| } as FilterField; | ||
| } | ||
|
|
||
| export function getCustomFieldFiltersForProjects(metadata: IssueMetadata | null, projectKeys: string[], issueTypes: string[]): FilterField[] { | ||
| const fields = getCustomFieldsForProjects(metadata, projectKeys).filter(isValidFieldForFilter); | ||
| const selectFields = fields.filter((field) => Boolean(field.allowedValues && field.allowedValues.length)) as (SelectField & FieldWithInfo)[]; | ||
|
|
@@ -229,42 +270,9 @@ export function getCustomFieldFiltersForProjects(metadata: IssueMetadata | null, | |
| } as FilterField); | ||
| } | ||
|
|
||
| const statusField = getStatusField(metadata, issueTypes); | ||
| if (statusField) { | ||
| result.push(statusField); | ||
| } | ||
|
|
||
| return sortByName(result); | ||
|
|
||
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.
A little concerning to me, what causes this to change from 3 to 2?
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.
@mickmister It was a mistake on my side, the latest API version for the Jira server is
2.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.
Okay we definitely want to test any changes made to Jira Server code, with Jira Server. And mention in the test steps of the PR to test both Jira Cloud/Server depending on the changes
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.
@mickmister Yes, we always test the changes on both instances and it's also mentioned in the description. We missed it initially in this PR, apologies for that.