Provide API to filter unwanted contributions #17

tortmayr · 2021-03-22T07:40:39Z

What it does

Adds the ContributionFilterRegistry which can be used to filter contributions of Theia extensions before they are bound.

This mechanism can be used by application developers to specifically filter individual contributions from Theia extensions they have no control over, i.e. core or 3rd party extensions.

Resolves eclipse-theia#9069

Contributed on behalf of STMicroelectronics
Signed-off-by: Tobias Ortmayr [email protected]

How to test

You can take a look at the included test case, or
Contribute a ContributionFilter in an example Theia application

Review checklist

as an author, I have thoroughly tested my changes and carefully followed the review guidelines

Reminder for reviewers

as a reviewer, I agree to behave in accordance with the review guidelines

sdirix

Looks good overall.

Some generic comments:

We need to clarify which copyright notice we want to use for new files
I would like to see more documentation for each class / function / interface
I think the offered filters are good in general, I wonder if we could go with a more generalized approach. What do you think?

packages/core/src/common/contribution-filter/filter.ts

packages/core/src/common/contribution-filter/contribution-filter.ts

packages/core/src/common/contribution-filter/filter.ts

tortmayr · 2021-04-07T05:53:35Z

Thanks for the review.
@sdirix I addressed your comments/issues and also added a test for the contribution filter and prepared a changelog update.
While revisiting the FilterAPI I noticed that the IdBasedContributionFilter was actually dead code from the POC that we migrated on accident so I removed it.

sdirix · 2021-04-07T15:45:22Z

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log

+## v1.13.0
+
+- [core] add API to filter contributions at runtime #PR Contributed on behalf of STMicroelectronics [#XXXX](https://github.com/eclipse-theia/theia/pull/XXXX)


Suggested change

- [core] add API to filter contributions at runtime #PR Contributed on behalf of STMicroelectronics [#XXXX](https://github.com/eclipse-theia/theia/pull/XXXX)

- [core] add API to filter contributions at runtime [#XXXX](https://github.com/eclipse-theia/theia/pull/XXXX) Contributed on behalf of STMicroelectronics

sdirix · 2021-04-07T15:46:00Z

examples/api-samples/src/browser/api-samples-frontend-module.ts

@@ -15,20 +15,22 @@
 ********************************************************************************/

 import { ContainerModule } from '@theia/core/shared/inversify';
+import '../../src/browser/style/branding.css';


We should avoid reordering all the imports

sdirix · 2021-04-07T15:50:16Z

packages/core/src/common/contribution-filter/contribution-filter-registry.ts

+    get(type: ContributionType): ContributionFilter[] {
+        const genericFilters = this.registry.get(GENERIC_CONTRIBUTION_FILTER_KEY) || [];
+        const filters = this.registry.get(type) || [];
+        filters.push(...genericFilters);
+        return filters;
+    }


If type === GENERIC_CONTRIBUTION_FILTER then we return them twice, correct?

sdirix · 2021-04-07T15:53:02Z

packages/core/src/common/contribution-filter/contribution-filter-registry.ts

+        return filters;
+    }
+
+    applyFilters<T extends Object>(toFilter: T[], type: ContributionType): T[] {


Should we make type optional by setting it to GENERIC_CONTRIBUTION_FILTER_KEY by default?

We should add documentation that the given type of filters as well as the generic filters will be executed

sdirix · 2021-04-07T15:53:35Z

packages/core/src/common/contribution-filter/contribution-filter.ts

+
+/**
+ * Specialized `Filter` that is used by the `ContainerBasedContributionProvider` to
+ * filter out unwanted contributions that are already bound in the DI container.


Suggested change

* filter out unwanted contributions that are already bound in the DI container.

* filter unwanted contributions that are already bound in the DI container.

sdirix · 2021-04-07T15:55:21Z

packages/core/src/common/contribution-filter/filter.ts

+/**
+ * A `Filter` can be used to test wether a given object
+ * should be filtered out/removed from a set of objects. The `test` function
+ * can be applied to an object of matching type and returns true if the object
+ * should be filtered out.
+ */


Suggested change

/**

* A `Filter` can be used to test wether a given object

* should be filtered out/removed from a set of objects. The `test` function

* can be applied to an object of matching type and returns true if the object

* should be filtered out.

*/

/**

* A `Filter` can be used to test whether a given object should be filtered

* from a set of objects. The `test` function can be applied to an object

* of matching type and returns `true` if the object should be filtered out.

*/

sdirix · 2021-04-07T15:59:29Z

packages/core/src/common/contribution-filter/filter.ts

+    /**
+     * Evaluates this filter on the given argument
+     * @param toTest Object that should be tested
+     * @returns `true` if the object should be filtered out, `false` otherwise
+     */


Suggested change

/**

* Evaluates this filter on the given argument

* @param toTest Object that should be tested

* @returns `true` if the object should be filtered out, `false` otherwise

*/

/**

* Evaluates this filter on the given argument.

* @param toTest Object that should be tested

* @returns `true` if the object should be filtered out, `false` otherwise

*/

sdirix · 2021-04-07T16:00:02Z

packages/core/src/common/contribution-filter/filter.ts

+/**
+ * Applies a set of filters to a set of given objects and returns the set of filtered objects
+ * @param toFilter Set of objects which should be filtered.
+ * @param filters Set of filters that should be applied.
+ * @param negate Negation flag. If set to true the result of all Filter.test methods is negated.
+ * @returns The set of filtered arguments.
+ */


Suggested change

/**

* Applies a set of filters to a set of given objects and returns the set of filtered objects

* @param toFilter Set of objects which should be filtered.

* @param filters Set of filters that should be applied.

* @param negate Negation flag. If set to true the result of all Filter.test methods is negated.

* @returns The set of filtered arguments.

*/

/**

* Applies a set of filters to a set of given objects and returns the set of filtered objects.

* @param toFilter Set of objects which should be filtered

* @param filters Set of filters that should be applied

* @param negate Negation flag. If set to true the result of all `Filter.test` methods is negated

* @returns The set of filtered arguments

*/

sdirix · 2021-04-07T16:01:23Z

packages/core/src/common/contribution-filter/string-based-filter.ts

+    abstract toString(toTest: T): string | undefined;
+
+    /**
+     * Tests wether the object should be filtered out based on its string representation.


Suggested change

* Tests wether the object should be filtered out based on its string representation.

* Tests whether the object should be filtered out based on its string representation.

sdirix · 2021-04-07T16:07:33Z

packages/core/src/common/contribution-filter/contribution-filter.ts

+export interface ContributionFilter extends Filter<Object> {
+    /**
+     * Contribution types for which this filter is applicable. If `undefined` or empty this filter
+     * will be applied to all contribution types.


We should give an example contribution type as it's hard to know what exactly is expected here.

sdirix · 2021-04-07T16:23:21Z

@tortmayr I applied the code review myself. It's almost only doc changes, however I changed the functionality in the registry getter. Can you recheck that code?

tortmayr · 2021-04-08T08:26:39Z

Thanks for the fixes. Looks good to me now. 👍

Signed-off-by: Paul Maréchal <[email protected]>

What it does - Updates styling of `rename-label` to align with VSCode. Signed-off-by: seantan22 <[email protected]>

The following commit adds support for the preference 'search.smartCase'. When the preference is true, search is case-insensitive if the pattern is all lowercase, otherwise search is case-sensitive. Signed-off-by: Duc Nguyen <[email protected]>

Signed-off-by: tsmaeder <[email protected]>

The following pull-request sanitizes the rendered `readme` of extensions for security purposes. The sanitization is similar to other areas of the code which make use of `dangerouslySetInnerHTML`. Signed-off-by: vince-fugnitto <[email protected]>

Signed-off-by: Colin Grant <[email protected]>

process.env is not available when in a browser environment. Webpack most likely included a shim for it.

The commit updates the `sanitize-html` dependency and typings to address known moderate vulnerabilities. The updated dependency was verified for being license compliant. Signed-off-by: vince-fugnitto <[email protected]>

Signed-off-by: 李云峰 <[email protected]>

This changes the default goto line range from position 0 to undefined. This will make it feasible to differentiate between the actual default and a user input at location zero. Signed-off-by: Alvaro Sanchez-Leon <[email protected]>

Signed-off-by: Colin Grant <[email protected]>

The commit updates the repository's `yarn.lock` following the `v1.14.0` release to update dependencies to what downstream applications might expect the first time they attempt to build a `theia`-based application. Signed-off-by: vince-fugnitto <[email protected]>

The PluginViewWidget has a property to suppress visibility updates from a `when` clause in the case a user specifically requests to hide it. However when the browser got reloaded, the flag was reset to default and did not keep the hide request from the user. This change preserves the flag mentioned above in the PluginViewWidget state, this state is preserved and then available for use in `restoreState` where the flag is now updated to the state before the browser reloads. Signed-off-by: Alvaro Sanchez-Leon <[email protected]>

Signed-off-by: Colin Grant <[email protected]>

The BackendApplicationServer is an optional backend contribution that serves frontend files. When not bound, the generators may bind one. This component is useful when your application is packaged in such a way that you need to customize how the frontend is served.

Signed-off-by: Igor Vinokur <[email protected]>

Signed-off-by: Colin Grant <[email protected]>

Rework how the different application configurations are defined to allow partial setting when calling configuration providers. Use default values when setting a partial configuration through the configuration providers.

The commit adds support for `prefix` arguments when plugins execute the `workbench.action.quickOpen` command. Previously `prefix` arguments were ignored. Signed-off-by: vince-fugnitto <[email protected]>

Signed-off-by: Kenneth Marut <[email protected]>

) refactor preference ui + add commonly used section

The commit adds `libsecret` to the `gitpod` dockerfile which was previously failing to start the application due to the new `keytar` dependency. Signed-off-by: vince-fugnitto <[email protected]>

The commit adds support for additional queries: - `@builtin` - `@installed` The changes also include commands to open the `extensions-view` with the corresponding query. Signed-off-by: vince-fugnitto <[email protected]>

The commit includes the following: - adds `dompurify` as a shared dependency from `@theia/core` - bumps the `dompurify` dependency to the latest version. - suppresses the sanitized content warnings for content which is known to be explicitly handled. Signed-off-by: vince-fugnitto <[email protected]>

The cursor or the selection is now preserved when we close an editor and when we use ctrlcmd + p to reopen it. It stays at the location where we left it and doesn't end up at the beginning of the file like before.

Signed-off-by: Colin Grant <[email protected]>

Adds the ContributionFilterRegistry which can be used to filter contributions of Theia extensions before they are bound. This mechanism can be used by application developers to specifically filter individual contributions from Theia extensions they have no control over, i.e. core or 3rd party extensions. Resolves eclipse-theia#9069 Contributed on behalf of STMicroelectronics Signed-off-by: Tobias Ortmayr <[email protected]> Co-Authored-By: Paul Maréchal <[email protected]> squash me? Signed-off-by: Paul Maréchal <[email protected]>

sdirix · 2022-11-16T14:07:57Z

Merged upstream with eclipse-theia#9317

tortmayr assigned sdirix Mar 22, 2021

tortmayr force-pushed the filter-api branch from bf69f97 to 2327261 Compare March 22, 2021 08:18

sdirix requested changes Mar 26, 2021

View reviewed changes

tortmayr force-pushed the filter-api branch 3 times, most recently from b8d8ab2 to ef10221 Compare April 7, 2021 05:51

tortmayr requested a review from sdirix April 7, 2021 05:53

tortmayr force-pushed the filter-api branch 2 times, most recently from 4ce9258 to 4b66222 Compare April 7, 2021 07:30

sdirix requested changes Apr 7, 2021

View reviewed changes

sdirix force-pushed the filter-api branch 3 times, most recently from bb1bdd5 to deeaa16 Compare April 8, 2021 09:19

sdirix approved these changes Apr 8, 2021

View reviewed changes

tortmayr changed the title ~~[WIP] Provide API to filter unwanted contributions~~ Provide API to filter unwanted contributions Apr 8, 2021

tortmayr force-pushed the filter-api branch 4 times, most recently from 4ae3ca5 to fd50b21 Compare April 9, 2021 07:36

paul-marechal and others added 8 commits May 4, 2021 10:58

yarn upgrade

cefb980

Signed-off-by: Paul Maréchal <[email protected]>

UI: Improve Styling of Rename Symbol

3e5ce53

What it does - Updates styling of `rename-label` to align with VSCode. Signed-off-by: seantan22 <[email protected]>

SIW: Support search.smartCase

6a8af03

The following commit adds support for the preference 'search.smartCase'. When the preference is true, search is case-insensitive if the pattern is all lowercase, otherwise search is case-sensitive. Signed-off-by: Duc Nguyen <[email protected]>

Make reviver/replacer pluggable

774f1f6

Signed-off-by: tsmaeder <[email protected]>

Introduce our own vscode.URI class and use it in plugin host

c86b82d

Signed-off-by: tsmaeder <[email protected]>

vsx-registry: sanitize readme

2560b65

The following pull-request sanitizes the rendered `readme` of extensions for security purposes. The sanitization is similar to other areas of the code which make use of `dangerouslySetInnerHTML`. Signed-off-by: vince-fugnitto <[email protected]>

Support language overrides in frontend config object

d4642c8

Signed-off-by: Colin Grant <[email protected]>

terminal: remove process.env from browser

b4b99ce

process.env is not available when in a browser environment. Webpack most likely included a shim for it.

vince-fugnitto and others added 10 commits May 28, 2021 09:47

vsx-registry: upgrade sanitize-html dep

8eb33e3

The commit updates the `sanitize-html` dependency and typings to address known moderate vulnerabilities. The updated dependency was verified for being license compliant. Signed-off-by: vince-fugnitto <[email protected]>

eclipse-theiaGH-9375: fix nested wrapped issue of Disposable

2b65150

Signed-off-by: 李云峰 <[email protected]>

Change default of goto line range to undefined

47a7cfc

This changes the default goto line range from position 0 to undefined. This will make it feasible to differentiate between the actual default and a user input at location zero. Signed-off-by: Alvaro Sanchez-Leon <[email protected]>

WorkspacePreferenceProvider waits for WorkspaceService to be ready

3f7cf88

Signed-off-by: Colin Grant <[email protected]>

Track index in Pref Tree to facilitate automatic scrolling

1e2c702

Signed-off-by: Colin Grant <[email protected]>

Open last seen editor, not last created

9b9cc2b

Signed-off-by: Colin Grant <[email protected]>

Apply Secrets plugin API

f9c0311

Signed-off-by: Igor Vinokur <[email protected]>

tortmayr force-pushed the filter-api branch 3 times, most recently from 6b65888 to 85a5423 Compare June 9, 2021 07:36

Colin Grant and others added 13 commits June 9, 2021 09:03

Enable extensions.json

d0aadd6

Signed-off-by: Colin Grant <[email protected]>

Rewrite Editor Preview as extensions of Editor classes

e8e88b7

Signed-off-by: Colin Grant <[email protected]>

application-package: refine config typings

aa4fe4a

Rework how the different application configurations are defined to allow partial setting when calling configuration providers. Use default values when setting a partial configuration through the configuration providers.

plugin: support prefix arguments for quickOpen

93c5c8d

The commit adds support for `prefix` arguments when plugins execute the `workbench.action.quickOpen` command. Previously `prefix` arguments were ignored. Signed-off-by: vince-fugnitto <[email protected]>

add resizing to editor input

64e613f

Signed-off-by: Kenneth Marut <[email protected]>

Refactor preference UI + add 'Commonly Used' section (eclipse-theia#9439

b86616b

) refactor preference ui + add commonly used section

gitpod: add libsecret to dockerfile

1f2574b

The commit adds `libsecret` to the `gitpod` dockerfile which was previously failing to start the application due to the new `keytar` dependency. Signed-off-by: vince-fugnitto <[email protected]>

vsx-registry: add support for additional queries

6067172

The commit adds support for additional queries: - `@builtin` - `@installed` The changes also include commands to open the `extensions-view` with the corresponding query. Signed-off-by: vince-fugnitto <[email protected]>

Enhancement : cursor/selection preserved

a5bfd57

The cursor or the selection is now preserved when we close an editor and when we use ctrlcmd + p to reopen it. It stays at the location where we left it and doesn't end up at the beginning of the file like before.

Check visible leaves for all change types

739a40d

Signed-off-by: Colin Grant <[email protected]>

Use more unique ID for non-command toolbar items

af9b883

Signed-off-by: Colin Grant <[email protected]>

tortmayr force-pushed the filter-api branch from 85a5423 to 6583387 Compare June 16, 2021 08:32

sdirix closed this Nov 16, 2022

sdirix deleted the filter-api branch May 16, 2024 15:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Provide API to filter unwanted contributions #17

Provide API to filter unwanted contributions #17

tortmayr commented Mar 22, 2021 •

edited by sdirix

Loading

sdirix left a comment •

edited

Loading

tortmayr commented Apr 7, 2021

sdirix Apr 7, 2021

sdirix Apr 7, 2021

sdirix Apr 7, 2021

sdirix Apr 7, 2021

sdirix Apr 7, 2021

sdirix Apr 7, 2021

sdirix Apr 7, 2021

sdirix Apr 7, 2021

sdirix Apr 7, 2021

sdirix Apr 7, 2021

sdirix commented Apr 7, 2021

tortmayr commented Apr 8, 2021

sdirix commented Nov 16, 2022

	- [core] add API to filter contributions at runtime #PR Contributed on behalf of STMicroelectronics [#XXXX](https://github.com/eclipse-theia/theia/pull/XXXX)
	- [core] add API to filter contributions at runtime [#XXXX](https://github.com/eclipse-theia/theia/pull/XXXX) Contributed on behalf of STMicroelectronics

	* filter out unwanted contributions that are already bound in the DI container.
	* filter unwanted contributions that are already bound in the DI container.

	* Tests wether the object should be filtered out based on its string representation.
	* Tests whether the object should be filtered out based on its string representation.

Provide API to filter unwanted contributions #17

Provide API to filter unwanted contributions #17

Conversation

tortmayr commented Mar 22, 2021 • edited by sdirix Loading

What it does

How to test

Review checklist

Reminder for reviewers

sdirix left a comment • edited Loading

Choose a reason for hiding this comment

tortmayr commented Apr 7, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sdirix commented Apr 7, 2021

tortmayr commented Apr 8, 2021

sdirix commented Nov 16, 2022

tortmayr commented Mar 22, 2021 •

edited by sdirix

Loading

sdirix left a comment •

edited

Loading