[full-ci] Search and filter #5415

fschade · 2021-06-29T14:01:44Z

Description

as described in issue #5419 we reworked how searching and or filtering files is working.
It's important to differentiate between filtering and searching.

Filtering

this option 'search current folder' filters the current folder for the given term, it is inplace and has no dedicated search result page. It just mutates the current view and displays the filtered result from current folder. It previews the results under the search input.

It has a simple query language but will adopt ios-app dictionary in a later step (separate PR).

Searching

searching 'search all files' at the moment is only available if the backend is oc10 and uses the owcloud-sdk under the hood.
It also previews the results while typing. The results will be displayed in a dedicated search result page and includes all matching files.

Architecture

as mentioned the search now is an app on it own. The decision to extract it was made from the requirement that other apps (third party or core apps) needed the ability to register/inject own searches into the global available search or the search can be replaced entirely.

Following cases are valid:

a app want to only search for its own entities (a account search for example)
a preview of a result entity has different look and feel // parameters (folder name and path vs account name and role)
some searches have real results others only want to mutate the current view with the search term (filter for example)

The given implementation makes all of this possible by implementing the SearchProvider interface and register it to the search application.

To make all of this work applications needed a way to communicate between each other.
To mention just a few following concepts where introduced:

eventBus
portals (applications can inject components into pre defined slots in other application)
a registry to access singletons (static only for now, no di... maybe later)
runtime mounted notifications

on top of this this introduces the use of typescript decorators and ship a first decorator in the web-pkg (debounce).

All this is not breaking and backward compatible. It works with filtering and does not affect vuex.

Related Issue

Motivation and Context

we needed search and filter similar to github.

How Has This Been Tested?

manual oc10 (docker)
manual ocis (docker, local)

Screenshots (if appropriate):

Search (oc10)

Filter (oc10 and ocis)

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Technical debt
Tests

Checklist:

Code changes
Unit tests added
Acceptance tests added
Documentation ticket raised:

Open tasks:

update-docs · 2021-06-29T14:01:47Z

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

packages/web-app-search/src/types.ts

ownclouders · 2021-06-30T12:39:09Z

Results for oCISSharingBasic https://drone.owncloud.com/owncloud/web/16968/47/1
The following scenarios passed on retry:

webUIRestrictSharing/restrictSharing.feature:49

ownclouders · 2021-06-30T12:41:51Z

Results for oC10XGAPortrait1 https://drone.owncloud.com/owncloud/web/16968/40/1
💥 The acceptance tests pipeline failed. The build has been cancelled.

ownclouders · 2021-06-30T15:21:15Z

Results for oC10IntegrationApp1 https://drone.owncloud.com/owncloud/web/16972/62/1

💥 The acceptance tests failed. Please find the screenshots inside ...

webUIFilesSearch-search-feature-27.png

💥 The acceptance tests pipeline failed. The build has been cancelled.

ownclouders · 2021-07-01T11:56:17Z

Results for oC10IntegrationApp1 https://drone.owncloud.com/owncloud/web/17001/62/1

💥 The acceptance tests failed. Please find the screenshots inside ...

webUIFilesSearch-search-feature-27.png

💥 The acceptance tests pipeline failed. The build has been cancelled.

ownclouders · 2021-07-01T14:36:59Z

Results for oCISSharingBasic https://drone.owncloud.com/owncloud/web/17004/47/1
The following scenarios passed on retry:

webUIRestrictSharing/restrictSharing.feature:49

ownclouders · 2021-07-01T14:37:31Z

Results for oC10XGAPortrait1 https://drone.owncloud.com/owncloud/web/17004/40/1
💥 The acceptance tests pipeline failed. The build has been cancelled.

ownclouders · 2021-07-01T18:27:44Z

Results for oC10Files1 https://drone.owncloud.com/owncloud/web/17012/10/1

💥 The acceptance tests failed. Please find the screenshots inside ...

webUIFiles-options-feature-14.png

webUIFiles-options-feature-21.png

webUIFiles-options-feature-31.png

💥 The acceptance tests pipeline failed. The build has been cancelled.

ownclouders · 2021-07-01T18:31:30Z

Results for oCISSharingBasic https://drone.owncloud.com/owncloud/web/17013/47/1
The following scenarios passed on retry:

webUIRestrictSharing/restrictSharing.feature:49

ownclouders · 2021-07-01T18:31:38Z

Results for oC10IntegrationApp1 https://drone.owncloud.com/owncloud/web/17013/62/1

💥 The acceptance tests failed. Please find the screenshots inside ...

webUIFilesSearch-search-feature-27.png

💥 The acceptance tests pipeline failed. The build has been cancelled.

ownclouders · 2021-07-02T10:18:01Z

Results for oCISSharingBasic https://drone.owncloud.com/owncloud/web/17024/47/1
The following scenarios passed on retry:

webUIRestrictSharing/restrictSharing.feature:49

ownclouders · 2021-07-02T10:21:05Z

Results for oC10Files1 https://drone.owncloud.com/owncloud/web/17024/10/1

💥 The acceptance tests failed. Please find the screenshots inside ...

webUIFiles-options-feature-14.png

webUIFiles-options-feature-21.png

webUIFiles-options-feature-31.png

💥 The acceptance tests pipeline failed. The build has been cancelled.

kulmann

What exactly, apart from a rebase, is needed to get this PR done? Are the open tasks accurate? Or can we keep it simpler and merge this ASAP, taking care of e.g. documentation in a separate PR?

changelog/unreleased/enhancement-add-custom-search-service

fschade · 2021-07-26T06:07:43Z

What exactly, apart from a rebase, is needed to get this PR done? Are the open tasks accurate? Or can we keep it simpler and merge this ASAP, taking care of e.g. documentation in a separate PR?

We need to work on the mobile view, then we’re good to go.

changelog/unreleased/enhancement-add-custom-search-service

ownclouders · 2021-07-27T10:04:00Z

Results for oC10SharingInternalUsersSharingIndicator https://drone.owncloud.com/owncloud/web/17699/27/1
The following scenarios passed on retry:

webUISharingInternalUsersSharingIndicator/shareWithUsers.feature:154

ownclouders · 2021-07-27T10:06:35Z

Results for oC10IntegrationApp1 https://drone.owncloud.com/owncloud/web/17699/64/1

💥 The acceptance tests failed. Please find the screenshots inside ...

webUIFilesSearch-search-feature-27.png

💥 The acceptance tests pipeline failed. The build has been cancelled.

ownclouders · 2021-07-27T11:17:20Z

Results for oCISFiles1 https://drone.owncloud.com/owncloud/web/17701/51/1

💥 Visual regression tests failed. Please find the screenshots inside ...

Diff Image:

Actual Image:

Comparing Against:

ownclouders · 2021-07-27T11:20:41Z

Results for oC10Files1 https://drone.owncloud.com/owncloud/web/17701/11/1

💥 The acceptance tests failed. Please find the screenshots inside ...

webUIFiles-options-feature-21.png

webUIFiles-options-feature-31.png

webUIFiles-options-feature-7.png

ownclouders · 2021-07-27T11:24:04Z

Results for oC10Files2 https://drone.owncloud.com/owncloud/web/17701/12/1

💥 Visual regression tests failed. Please find the screenshots inside ...

Diff Image:

Actual Image:

Comparing Against:

💥 The acceptance tests failed. Please find the screenshots inside ...

webUIFilesDetails-fileDetails-feature-107.png

webUIFilesDetails-fileDetails-feature-124.png

webUIFilesDetails-fileDetails-feature-74.png

webUIFilesDetails-fileDetails-feature-90.png

webUIFilesList-fileList-feature-15.png

webUIFilesSearch-search-feature-129.png

webUIFilesSearch-search-feature-139.png

webUIFilesSearch-search-feature-145.png

webUIFilesSearch-search-feature-173.png

webUIFilesSearch-search-feature-38.png

webUIFilesSearch-search-feature-50.png

ownclouders · 2021-07-27T19:50:33Z

Results for oC10SharingInternalGroupsSharingIndicator https://drone.owncloud.com/owncloud/web/17730/23/1
The following scenarios passed on retry:

webUISharingInternalGroupsToRootSharingIndicator/shareWithGroups.feature:104

packages/web-app-files/src/index.js

packages/web-pkg/src/event/bus.ts

packages/web-runtime/src/components/TopBar.vue

packages/web-runtime/tests/unit/components/TopBar.spec.js

packages/web-pkg/src/event/bus.spec.ts

packages/web-pkg/src/decorator/debounce.spec.ts

packages/web-pkg/src/event/bus.spec.ts

packages/web-pkg/src/instance/index.spec.ts

packages/web-app-search/src/views/List.vue

packages/web-app-search/src/index.ts

packages/web-app-files/src/components/Search/List.vue

packages/web-app-files/src/mixins/resourceCleanup.js

packages/web-app-files/src/search/filter/index.ts

packages/web-app-files/src/search/sdk/index.ts

packages/web-app-files/src/search/sdk/list.ts

packages/web-app-files/src/search/filter/preview.ts

packages/web-runtime/src/store/config.js

ownclouders · 2021-07-28T17:16:31Z

Results for oC10SharingInternalUsersSharingIndicator https://drone.owncloud.com/owncloud/web/17759/27/1
The following scenarios passed on retry:

webUISharingInternalUsersSharingIndicator/shareWithUsers.feature:154

ownclouders · 2021-07-28T17:43:51Z

Results for oC10SharingInternalUsers https://drone.owncloud.com/owncloud/web/17759/24/1
The following scenarios passed on retry:

webUISharingInternalUsersShareWithPage/shareWithUsers.feature:91

introduce search for files app in oc10 introduce filtering files app in oc10 and ocis introduce ability to inject searches with preview for third party applications remove searchBar from runtime add searchBar portal to runtime introduce eventBus introduce typescript decorators implement debounce decorator add dedicated selenium docker image which is able to render indic fonts update oc10 test docker entrypoint to work with oc10 10.8

sonarcloud · 2021-07-29T11:36:35Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
2 Code Smells

72.5% Coverage
0.0% Duplication

ownclouders · 2021-07-29T12:17:51Z

Results for oC10SharingInternalGroupsSharingIndicator https://drone.owncloud.com/owncloud/web/17787/23/1
The following scenarios passed on retry:

webUISharingInternalGroupsToRootSharingIndicator/shareWithGroups.feature:104

ownclouders · 2021-07-29T12:19:04Z

Results for oC10SharingInternalUsersSharingIndicator https://drone.owncloud.com/owncloud/web/17787/27/1
The following scenarios passed on retry:

webUISharingInternalUsersToRootSharingIndicator/shareWithUsers.feature:98

pascalwengerter

Happy to merge once CI is 🟢

kulmann

Awesome work! ❤️

pascalwengerter reviewed Jun 29, 2021

View reviewed changes

packages/web-app-search/src/types.ts Show resolved Hide resolved

pascalwengerter force-pushed the search branch from b6ce303 to 113cc5f Compare June 30, 2021 07:40

fschade mentioned this pull request Jun 30, 2021

extract loadPreview into helper #5426

Merged

8 tasks

fschade force-pushed the search branch from aab1da0 to c8af429 Compare July 1, 2021 10:52

fschade marked this pull request as ready for review July 1, 2021 10:56

kulmann reviewed Jul 25, 2021

View reviewed changes

changelog/unreleased/enhancement-add-custom-search-service Outdated Show resolved Hide resolved

pascalwengerter reviewed Jul 26, 2021

View reviewed changes

changelog/unreleased/enhancement-add-custom-search-service Show resolved Hide resolved

pascalwengerter changed the title ~~[DRAFT] Search and filter~~ Search and filter Jul 26, 2021

pascalwengerter force-pushed the search branch from 95190ac to 7d8e94e Compare July 26, 2021 23:57

pascalwengerter changed the title ~~Search and filter~~ [full-ci] Search and filter Jul 27, 2021

pascalwengerter force-pushed the search branch from e0ce1b6 to 20bc6fc Compare July 27, 2021 10:42

pascalwengerter force-pushed the search branch from 20bc6fc to c7bc152 Compare July 27, 2021 19:24

kulmann reviewed Jul 28, 2021

View reviewed changes

packages/web-app-files/src/components/Search/List.vue Outdated Show resolved Hide resolved

packages/web-app-files/src/components/Search/List.vue Outdated Show resolved Hide resolved

kulmann reviewed Jul 28, 2021

View reviewed changes

pascalwengerter reviewed Jul 28, 2021

View reviewed changes

packages/web-app-files/src/search/sdk/list.ts Outdated Show resolved Hide resolved

pascalwengerter reviewed Jul 28, 2021

View reviewed changes

packages/web-app-files/src/search/filter/preview.ts Show resolved Hide resolved

pascalwengerter reviewed Jul 28, 2021

View reviewed changes

packages/web-runtime/src/store/config.js Show resolved Hide resolved

fschade force-pushed the search branch 2 times, most recently from 46101c8 to 7039fb4 Compare July 28, 2021 16:50

fschade force-pushed the search branch from 7039fb4 to 79c57c2 Compare July 28, 2021 17:54

fschade force-pushed the search branch from 79c57c2 to 653d00b Compare July 28, 2021 17:57

kulmann mentioned this pull request Jul 29, 2021

Release v4.0.0 #5581

Closed

20 tasks

Fix broken search tests

8c51111

pascalwengerter force-pushed the search branch from 6d3199c to 8c51111 Compare July 29, 2021 11:26

pascalwengerter approved these changes Jul 29, 2021

View reviewed changes

kulmann approved these changes Jul 29, 2021

View reviewed changes

pascalwengerter merged commit 21d4d32 into master Jul 29, 2021

delete-merged-branch bot deleted the search branch July 29, 2021 12:59

[full-ci] Search and filter #5415

[full-ci] Search and filter #5415

Conversation

fschade commented Jun 29, 2021 • edited Loading

Description

Filtering

Searching

Architecture

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Search (oc10)

Filter (oc10 and ocis)

Types of changes

Checklist:

Open tasks:

update-docs bot commented Jun 29, 2021

ownclouders commented Jun 30, 2021

ownclouders commented Jun 30, 2021

ownclouders commented Jun 30, 2021

webUIFilesSearch-search-feature-27.png

ownclouders commented Jul 1, 2021

webUIFilesSearch-search-feature-27.png

ownclouders commented Jul 1, 2021

ownclouders commented Jul 1, 2021

ownclouders commented Jul 1, 2021

webUIFiles-options-feature-14.png

webUIFiles-options-feature-21.png

webUIFiles-options-feature-31.png

ownclouders commented Jul 1, 2021

ownclouders commented Jul 1, 2021

webUIFilesSearch-search-feature-27.png

ownclouders commented Jul 2, 2021

ownclouders commented Jul 2, 2021

webUIFiles-options-feature-14.png

webUIFiles-options-feature-21.png

webUIFiles-options-feature-31.png

kulmann left a comment

Choose a reason for hiding this comment

fschade commented Jul 26, 2021

ownclouders commented Jul 27, 2021

ownclouders commented Jul 27, 2021

webUIFilesSearch-search-feature-27.png

ownclouders commented Jul 27, 2021

ownclouders commented Jul 27, 2021

webUIFiles-options-feature-21.png

webUIFiles-options-feature-31.png

webUIFiles-options-feature-7.png

ownclouders commented Jul 27, 2021

webUIFilesDetails-fileDetails-feature-107.png

webUIFilesDetails-fileDetails-feature-124.png

webUIFilesDetails-fileDetails-feature-74.png

webUIFilesDetails-fileDetails-feature-90.png

webUIFilesList-fileList-feature-15.png

webUIFilesSearch-search-feature-129.png

webUIFilesSearch-search-feature-139.png

webUIFilesSearch-search-feature-145.png

webUIFilesSearch-search-feature-173.png

webUIFilesSearch-search-feature-38.png

webUIFilesSearch-search-feature-50.png

ownclouders commented Jul 27, 2021

ownclouders commented Jul 28, 2021

ownclouders commented Jul 28, 2021

sonarcloud bot commented Jul 29, 2021

ownclouders commented Jul 29, 2021

ownclouders commented Jul 29, 2021

pascalwengerter left a comment

Choose a reason for hiding this comment

kulmann left a comment

Choose a reason for hiding this comment

fschade commented Jun 29, 2021 •

edited

Loading