DDF-4463 Simplify search forms selection with a dropdown #4227

mojogitoverhere · 2019-01-21T09:36:20Z

What does this PR do?

Simplifies the search form selection to be a simple list
Moves Basic and Text search out of the forms selection and into the initial query dropdown with Advanced search.
Refactors the code so that only one collection of search forms are maintained and only one network request is made to fetch them.
Starts the process of migrating the search forms to React
Also touches some of the result forms code, which is currently coupled to search forms

Who is reviewing it?

@willwill96 @rymach @gjvera @djblue

Select relevant component teams:

@codice/ui

Ask 2 committers to review/merge the PR and tag them here.

@andrewkfiedler
@bdeining

How should this be tested?

Basic/Text Searches

Ingest some data and verify Basic and Text searches work as expected

Search Forms

Click "Use another search form" and ensure "No search forms are available" is shown
Copy some forms into etc/forms and run 'forms:load'. Ensure the form titles are shown in "Use another search form". Click on a form and verify the query changes as expected.
Go into the "Search Forms" submenu (hamburger). Verify all previous behavior works as expected (change default forms, create a new form, delete a form, share a form, etc)

Result Forms

Ensure result forms still work as expected (create a new form, share a form, delete a form, etc)

Any background context you want to provide?

What are the relevant tickets?

DDF-4463

Screenshots

Basic and Text Search

Search Forms

Checklist:

Documentation Updated
Update / Add Threat Dragon models
Update / Add Unit Tests
Update / Add Integration Tests

Notes on Review Process

Please see Notes on Review Process for further guidance on requirements for merging and abbreviated reviews.

Review Comment Legend:

✏️ (Pencil) This comment is a nitpick or style suggestion, no action required for approval. This comment should provide a suggestion either as an in line code snippet or a gist.
❓ (Question Mark) This comment is to gain a clearer understanding of design or code choices, clarification is required but action may not be necessary for approval.
❗ (Exclamation Mark) This comment is critical and requires clarification or action before approval.

ui/packages/catalog-ui-search/src/main/webapp/component/search-form/search-form.less

ui/packages/catalog-ui-search/src/main/webapp/component/search-form/search-form.view.js

...ckages/catalog-ui-search/src/main/webapp/component/search-form-list/search-form-list.view.js

Schachte · 2019-01-21T19:34:53Z

Do we want a way to differentiate between system, shared, owned still somehow?

...rc/main/webapp/component/dropdown/search-form-selector/dropdown.search-form-selector.view.js

...kages/catalog-ui-search/src/main/webapp/component/result-form/result-form.collection.view.js

...ckages/catalog-ui-search/src/main/webapp/component/search-form-list/search-form-list.view.js

...es/catalog-ui-search/src/main/webapp/component/search-form/search-form-tab-container.view.js

...kages/catalog-ui-search/src/main/webapp/component/search-form/search-form.collection.view.js

ui/packages/catalog-ui-search/src/main/webapp/component/search-form/search-form.less

Bdthomson

Nice.

...talog-ui-search/src/main/webapp/component/search-form/search-form-all-collection-instance.js

...kages/catalog-ui-search/src/main/webapp/component/search-form/search-form.collection.view.js

andrewkfiedler · 2019-01-22T03:43:20Z

Do we have time to update it to work similar to how it worked here (#2906)?

I think something like this would work: https://codepen.io/andrewkfiedler/full/gqOazY

I think the filter capability will be important, as they're likely to have a good amount of search forms to choose from.

andrewkfiedler

The comment about deleting the type attribute by no means needs to be done in this PR, that's quite a mountain of work. However, it's causing us a world of pain and needs to be dealt with sooner rather than later if we have bandwidth.

...rc/main/webapp/component/dropdown/search-form-selector/dropdown.search-form-selector.view.js

ui/packages/catalog-ui-search/src/main/webapp/component/result-form/result-form.collection.js

...kages/catalog-ui-search/src/main/webapp/component/result-form/result-form.collection.view.js

...rc/main/webapp/component/search-form/forms-sharing/search-form-sharing-tab-container.view.js

ui/packages/catalog-ui-search/src/main/webapp/component/search-form/search-form.view.js

.../catalog-ui-search/src/main/webapp/component/search-interactions/search-interactions.view.js

mojogitoverhere · 2019-01-22T22:01:29Z

@andrewkfiedler I added the filter to the dropdown (thanks @djblue!) but I'm going to leave the menu layout of Text, Basic, Advanced, and Use Another Search Form as is for now (i.e. they won't be nested under Use Another Search Form)

mojogitoverhere · 2019-01-22T22:57:32Z

build now

bdeining · 2019-01-22T23:03:38Z

@andrewkfiedler we already have a ticket for this request #4227 (comment)

cxbot · 2019-01-22T23:06:25Z

Internal build has been scheduled, your results will be available at build completion.

...kages/catalog-ui-search/src/main/webapp/component/result-form/result-form.collection.view.js

...es/catalog-ui-search/src/main/webapp/component/search-form-editor/search-form-editor.view.js

...ckages/catalog-ui-search/src/main/webapp/component/search-form-list/search-form-list.view.js

...ages/catalog-ui-search/src/main/webapp/component/search-interactions/search-interactions.hbs

cxbot · 2019-01-23T02:25:42Z

Refer to this link for build results (access rights to CI server needed):
https://jenkins.codice.org/job/DDF-Jobs/job/pr/job/Linux/6102/
✅ JOB SUCCESS

…he search form via the workspace" This reverts commit 89e71b2.

mojogitoverhere · 2019-01-23T19:03:54Z

build now

cxbot · 2019-01-23T19:08:15Z

Internal build has been scheduled, your results will be available at build completion.

gjvera · 2019-01-23T19:56:02Z

🎉 Hero Successful 🎉

Quick built/installed
Basic and text search work as expected
Created several search forms with different filters
search forms all performed as expected
marking forms as default, deleting, and sharing forms all worked as expected
When there's too many search forms in the list the list will scroll
the filter works in the dropdown
Result forms worked as for sharing, deleting, and using.

LGTM

cxbot · 2019-01-23T20:32:09Z

Refer to this link for build results (access rights to CI server needed):
https://jenkins.codice.org/job/DDF-Jobs/job/pr/job/Linux/6107/
✅ JOB SUCCESS

bdeining

@andrewkfiedler please re-review

Comments are addressed but I haven't had time to rereview

jrnorth assigned bdeining and andrewkfiedler Jan 21, 2019

jrnorth added the 👤 UI Has UI Changes label Jan 21, 2019

mojogitoverhere force-pushed the simplify-search-forms branch from 8ae3e4c to 7fc44e2 Compare January 21, 2019 18:14

gjvera reviewed Jan 21, 2019

View reviewed changes

ui/packages/catalog-ui-search/src/main/webapp/component/search-form/search-form.less Outdated Show resolved Hide resolved

gjvera reviewed Jan 21, 2019

View reviewed changes

ui/packages/catalog-ui-search/src/main/webapp/component/search-form/search-form.view.js Outdated Show resolved Hide resolved

gjvera reviewed Jan 21, 2019

View reviewed changes

...ckages/catalog-ui-search/src/main/webapp/component/search-form-list/search-form-list.view.js Outdated Show resolved Hide resolved

adimka reviewed Jan 21, 2019

View reviewed changes

Bdthomson reviewed Jan 21, 2019

View reviewed changes

...talog-ui-search/src/main/webapp/component/search-form/search-form-all-collection-instance.js Outdated Show resolved Hide resolved

...kages/catalog-ui-search/src/main/webapp/component/search-form/search-form.collection.view.js Show resolved Hide resolved

andrewkfiedler previously requested changes Jan 22, 2019

View reviewed changes

Bdthomson approved these changes Jan 23, 2019

View reviewed changes

codice deleted a comment Jan 23, 2019

gjvera approved these changes Jan 23, 2019

View reviewed changes

mojogitoverhere added 10 commits January 23, 2019 09:14

Revert "DDF-4283 remove search form interaction menu when accessing t…

2ed2b8e

…he search form via the workspace" This reverts commit 89e71b2.

DDF-4463 Render system forms as a list

924f3f3

DDF-4463 Add ability to click on forms

3e56663

DDF-4463 Use a single collection for search forms

9d84450

DDF-4463 Temporarily remove original collection

cc22c23

DDF-4463 Convert list to react

2c9dc47

DDF-4463 Add basic and text search to query dropdown

7849f86

DDF-4463 Cleanup search form list

4c511ab

DDF-4463 Formatting

10243ac

DDF-4463 Start search form tile react migration

6aaf9ed

mojogitoverhere added 16 commits January 23, 2019 09:14

DDF-4463 Remove this.model in favor of this.options.collection

6ec765e

DDF-4463 Remove unused SearchForm view

d7680e9

DDF-4463 Import React instead of require

cd4ed36

DDF-4463 Rename search-form-all-* to search-form-*

56dc52c

DDF-4463 Remove unused handleDefault function

fc10ee1

DDF-4463 Change tab filters to lambdas

53493b9

DDF-4463 Remove unused search-form-selector

ce97116

DDF-4463 Formatting

18fe663

DDF-4463 Remove unused classes from less file

101f1c7

DDF-4463 Refactor action menu into react component

b087121

DDF-4463 Add filter for search forms

b65a99d

DDF-4463 Added placeholder text for forms filter

3c71a4c

DDF-4463 Remove new result form button out of the collection

29e2075

DDF-4463 More search-form.view cleanup

51d56a7

DDF-4463 Remove search-form.less

095f8cd

DDF-4463 Consolidate the Item and NewForm components

478c72c

mojogitoverhere force-pushed the simplify-search-forms branch from a3ab952 to 478c72c Compare January 23, 2019 19:03

andrewkfiedler added the 📈 Improvement label Jan 24, 2019

Schachte approved these changes Jan 24, 2019

View reviewed changes

willwill96 approved these changes Jan 24, 2019

View reviewed changes

bdeining approved these changes Jan 25, 2019

View reviewed changes

millerw8 approved these changes Jan 29, 2019

View reviewed changes

djblue approved these changes Jan 31, 2019

View reviewed changes

bdeining merged commit 601f69f into codice:master Jan 31, 2019

mojogitoverhere mentioned this pull request Jan 31, 2019

Treat Basic / Text Search Forms as First Class Components #4276

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DDF-4463 Simplify search forms selection with a dropdown #4227

DDF-4463 Simplify search forms selection with a dropdown #4227

mojogitoverhere commented Jan 21, 2019 •

edited

Loading

Schachte commented Jan 21, 2019

Bdthomson left a comment

andrewkfiedler commented Jan 22, 2019

andrewkfiedler left a comment

mojogitoverhere commented Jan 22, 2019

mojogitoverhere commented Jan 22, 2019

bdeining commented Jan 22, 2019

cxbot commented Jan 22, 2019

cxbot commented Jan 23, 2019

mojogitoverhere commented Jan 23, 2019

cxbot commented Jan 23, 2019

gjvera commented Jan 23, 2019

cxbot commented Jan 23, 2019

bdeining left a comment

DDF-4463 Simplify search forms selection with a dropdown #4227

DDF-4463 Simplify search forms selection with a dropdown #4227

Conversation

mojogitoverhere commented Jan 21, 2019 • edited Loading

What does this PR do?

Who is reviewing it?

Select relevant component teams:

Ask 2 committers to review/merge the PR and tag them here.

How should this be tested?

Basic/Text Searches

Search Forms

Result Forms

Any background context you want to provide?

What are the relevant tickets?

Screenshots

Checklist:

Notes on Review Process

Review Comment Legend:

Schachte commented Jan 21, 2019

Bdthomson left a comment

Choose a reason for hiding this comment

andrewkfiedler commented Jan 22, 2019

andrewkfiedler left a comment

Choose a reason for hiding this comment

mojogitoverhere commented Jan 22, 2019

mojogitoverhere commented Jan 22, 2019

bdeining commented Jan 22, 2019

cxbot commented Jan 22, 2019

cxbot commented Jan 23, 2019

mojogitoverhere commented Jan 23, 2019

cxbot commented Jan 23, 2019

gjvera commented Jan 23, 2019

🎉 Hero Successful 🎉

cxbot commented Jan 23, 2019

bdeining left a comment

Choose a reason for hiding this comment

mojogitoverhere commented Jan 21, 2019 •

edited

Loading