Add a 'wires' command to allow easy investigation of bundle wires #466

laeubi · 2024-01-04T13:15:01Z

Currently it is quite hard to find out if/why a certain bundle is using some other bundles or are used by others.

This adds a new 'wires' command that when executed against a given bundle prints all wires that are used by the bundle and any wires it provides to other bundles. This results in a very powerful tool to analyze dependency problems and find out why a bundle is actually used.

An example output looks like this:

Bundle org.eclipse.ui.workbench 3.131.100.qualifier:
is wired to:
	 - com.ibm.icu 74.1.0
	   - because of Import-Package: com.ibm.icu.util
	 - jakarta.annotation-api 2.1.1
	   - because of Import-Package: jakarta.annotation; version="[2.1.0,3.0.0)"
	 - jakarta.inject.jakarta.inject-api 2.0.1
	   - because of Import-Package: jakarta.inject; version="[2.0.0,3.0.0)"
	 - org.apache.felix.scr 2.2.6
	   - because of Require-Capability: osgi.extender; filter:="(&(osgi.extender=osgi.component)(version>=1.2)(!(version>=2.0)))"
	 - org.eclipse.core.databinding.observable 1.13.200.qualifier
	   - because of Require-Bundle: org.eclipse.core.databinding.observable; bundle-version="[1.2.0,2.0.0)"
	 - org.eclipse.core.databinding.property 1.10.200.qualifier
	   - because of Require-Bundle: org.eclipse.core.databinding.property; bundle-version="[1.2.0,2.0.0)"
	 - org.eclipse.core.runtime 3.31.0.qualifier
	   - because of Require-Bundle: org.eclipse.core.runtime; bundle-version="[3.29.0,4.0.0)"
	 - org.eclipse.e4.core.commands 1.1.300.qualifier
	   - because of Import-Package: org.eclipse.e4.core.commands
	   - because of Import-Package: org.eclipse.e4.core.commands.internal
	 - org.eclipse.e4.core.contexts 1.12.500.qualifier
	   - because of Require-Bundle: org.eclipse.e4.core.contexts; bundle-version="1.0.0"
	 - org.eclipse.e4.core.di 1.9.300.qualifier
	   - because of Require-Bundle: org.eclipse.e4.core.di; bundle-version="1.1.0"
	 - org.eclipse.e4.core.di.extensions 0.18.200.qualifier
	   - because of Require-Bundle: org.eclipse.e4.core.di.extensions; bundle-version="0.13.0"
	 - org.eclipse.e4.core.services 2.4.300.qualifier
	   - because of Require-Bundle: org.eclipse.e4.core.services; bundle-version="2.2.0"
	 - org.eclipse.e4.ui.bindings 0.14.300.qualifier
	   - because of Require-Bundle: org.eclipse.e4.ui.bindings; bundle-version="0.9.0"
	 - org.eclipse.e4.ui.css.swt 0.15.300.qualifier
	   - because of Require-Bundle: org.eclipse.e4.ui.css.swt; bundle-version="0.9.1"
	 - org.eclipse.e4.ui.css.swt.theme 0.14.300.qualifier
	   - because of Require-Bundle: org.eclipse.e4.ui.css.swt.theme; bundle-version="0.9.0"
	 - org.eclipse.e4.ui.di 1.5.300.qualifier
	   - because of Require-Bundle: org.eclipse.e4.ui.di; bundle-version="0.9.0"
	 - org.eclipse.e4.ui.model.workbench 2.4.200.qualifier
	   - because of Require-Bundle: org.eclipse.e4.ui.model.workbench; bundle-version="0.9.1"
	 - org.eclipse.e4.ui.services 1.6.300.qualifier
	   - because of Import-Package: org.eclipse.e4.ui.services
	   - because of Require-Bundle: org.eclipse.e4.ui.services; bundle-version="1.3.0"
	 - org.eclipse.e4.ui.workbench 1.15.300.qualifier
	   - because of Import-Package: org.eclipse.e4.ui.internal.workbench
	   - because of Import-Package: org.eclipse.e4.ui.internal.workbench.addons
	   - because of Import-Package: org.eclipse.e4.ui.workbench
	   - because of Import-Package: org.eclipse.e4.ui.workbench.modeling
	 - org.eclipse.e4.ui.workbench.addons.swt 1.5.300.qualifier
	   - because of Require-Bundle: org.eclipse.e4.ui.workbench.addons.swt; bundle-version="0.10.0"
	 - org.eclipse.e4.ui.workbench.renderers.swt 0.16.300.qualifier
	   - because of Import-Package: org.eclipse.e4.ui.internal.workbench.renderers.swt
	   - because of Import-Package: org.eclipse.e4.ui.workbench.renderers.swt
	 - org.eclipse.e4.ui.workbench.swt 0.17.300.qualifier
	   - because of Import-Package: org.eclipse.e4.ui.internal.workbench.swt
	   - because of Require-Bundle: org.eclipse.e4.ui.workbench.swt; bundle-version="0.9.1"
	 - org.eclipse.e4.ui.workbench3 0.17.300.qualifier
	   - because of Require-Bundle: org.eclipse.e4.ui.workbench3; bundle-version="0.15.0"; visibility:="reexport"
	 - org.eclipse.emf.ecore.xmi 2.37.0.qualifier
	   - because of Require-Bundle: org.eclipse.emf.ecore.xmi; bundle-version="2.11.0"
	 - org.eclipse.help 3.10.300.qualifier
	   - because of Require-Bundle: org.eclipse.help; bundle-version="[3.2.0,4.0.0)"
	 - org.eclipse.jface 3.33.0.qualifier
	   - because of Require-Bundle: org.eclipse.jface; bundle-version="[3.31.0,4.0.0)"
	 - org.eclipse.jface.databinding 1.15.200.qualifier
	   - because of Require-Bundle: org.eclipse.jface.databinding; bundle-version="[1.3.0,2.0.0)"
	 - org.eclipse.osgi 3.19.0.qualifier
	   - because of Import-Package: javax.xml.parsers
	   - because of Import-Package: org.w3c.dom
	   - because of Import-Package: org.xml.sax
	   - because of Require-Capability: osgi.ee; filter:="(&(osgi.ee=JavaSE)(version=17))"
	 - org.osgi.service.event 1.4.1.202109301733
	   - because of Import-Package: org.osgi.service.event; version="[1.2.0,2.0.0)"
and is consumed by:
	 - org.eclipse.jdt.ui 3.31.100.qualifier
	   - because it Require-Bundle: org.eclipse.ui.workbench; bundle-version="[3.131.0,4.0.0)"
	 - org.eclipse.ui 3.205.100.qualifier
	   - because it Require-Bundle: org.eclipse.ui.workbench; bundle-version="[3.130.0,4.0.0)"; visibility:="reexport"
	 - org.eclipse.ui.editors 3.17.200.qualifier
	   - because it Require-Bundle: org.eclipse.ui.workbench; bundle-version="[3.130.0,4.0.0)"
	 - org.eclipse.ui.genericeditor 1.3.300.qualifier
	   - because it Require-Bundle: org.eclipse.ui.workbench; bundle-version="3.109.0"
	 - org.eclipse.ui.intro.quicklinks 1.2.300.qualifier
	   - because it Require-Bundle: org.eclipse.ui.workbench; bundle-version="3.108.0"

github-actions · 2024-01-04T13:17:05Z

Test Results

24 files ±0 24 suites ±0 11m 19s ⏱️ -4s
2 150 tests ±0 2 105 ✅ ±0 45 💤 ±0 0 ❌ ±0
2 194 runs ±0 2 149 ✅ ±0 45 💤 ±0 0 ❌ ±0

Results for commit 232460e. ± Comparison against base commit de625e7.

♻️ This comment has been updated with latest results.

bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/ResourceFormatter.java

tjwatson

LGTM

tjwatson

Sorry, one change request. Can you update the package version for org.eclipse.osgi.container?

laeubi · 2024-01-05T06:35:41Z

Sorry, one change request. Can you update the package version for org.eclipse.osgi.container?

Done.

bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleContainer.java

bundles/org.eclipse.equinox.console/src/org/eclipse/equinox/console/commands/WireCommand.java

bundles/org.eclipse.equinox.console/META-INF/MANIFEST.MF

Currently it is quite hard to find out if/why a certain bundle is using some other bundles or are used by others. This adds a new 'wires' command that when executed against a given bundle prints all wires that are used by the bundle and any wires it provides to other bundles. This results in a very powerful tool to analyze dependency problems and find out why a bundle is actually used. Co-authored-by: Titouan Vervack <tivervac@gmail.com>

tjwatson

Thanks! LGTM

iloveeclipse · 2024-01-05T14:37:17Z

Question : is this available from osgi console? If yes, could you provide an example command? Ideally this would be also mentioned in N&N.

laeubi · 2024-01-05T14:57:22Z

is this available from osgi console

Yes it is a regular osgi console command

If yes, could you provide an example command

Given you know the id of the bundle simply type

wires <id>

and you get the output.

Ideally this would be also mentioned in N&N.

Add N&N for https://github.com/eclipse-equinox/equinox/pull/466 eclipse-platform/www.eclipse.org-eclipse#107

mickaelistria · 2024-01-08T09:04:15Z

Thank you for this great and extremely useful addition!

HannesWell · 2024-01-09T00:26:17Z

Thank you for this great and extremely useful addition!

I can only second that. I often needed that in the past and had to find other less convenient ways.

laeubi · 2024-01-09T14:07:29Z

This improvement was gently sponsored by Sigasi.

laeubi force-pushed the add_wire_command branch from efa0be2 to 3bd2a9d Compare January 4, 2024 13:31

tjwatson requested changes Jan 4, 2024

View reviewed changes

tjwatson reviewed Jan 4, 2024

View reviewed changes

bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/ResourceFormatter.java Outdated Show resolved Hide resolved

bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/ResourceFormatter.java Outdated Show resolved Hide resolved

laeubi force-pushed the add_wire_command branch from 3bd2a9d to a7d6e6b Compare January 4, 2024 16:18

laeubi requested a review from tjwatson January 4, 2024 16:19

tjwatson approved these changes Jan 4, 2024

View reviewed changes

tjwatson requested changes Jan 4, 2024

View reviewed changes

laeubi force-pushed the add_wire_command branch from a7d6e6b to 65f344b Compare January 5, 2024 06:35

laeubi requested a review from tjwatson January 5, 2024 06:35

tivervac reviewed Jan 5, 2024

View reviewed changes

tjwatson reviewed Jan 5, 2024

View reviewed changes

bundles/org.eclipse.equinox.console/META-INF/MANIFEST.MF Outdated Show resolved Hide resolved

laeubi force-pushed the add_wire_command branch from 0ba16a1 to f463b8e Compare January 5, 2024 14:06

laeubi force-pushed the add_wire_command branch from f463b8e to 232460e Compare January 5, 2024 14:10

laeubi requested a review from tjwatson January 5, 2024 14:11

tjwatson approved these changes Jan 5, 2024

View reviewed changes

laeubi merged commit 1d9eb47 into eclipse-equinox:master Jan 5, 2024
22 of 24 checks passed

laeubi added a commit to laeubi/www.eclipse.org-eclipse that referenced this pull request Jan 5, 2024

Add N&N for eclipse-equinox/equinox#466

751d2cf

laeubi added a commit to eclipse-platform/www.eclipse.org-eclipse that referenced this pull request Jan 5, 2024

Add N&N for eclipse-equinox/equinox#466

1b15fba

laeubi mentioned this pull request Jan 9, 2024

Additional testcase that show some unexpected behavior of resolver #469

Draft

laeubi mentioned this pull request Sep 13, 2024

Issues with 2024-06 and gson library used by lsp4j v0.22 eclipse-jdtls/eclipse.jdt.ls#3236

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a 'wires' command to allow easy investigation of bundle wires #466

Add a 'wires' command to allow easy investigation of bundle wires #466

laeubi commented Jan 4, 2024

github-actions bot commented Jan 4, 2024 •

edited

Loading

tjwatson left a comment

tjwatson left a comment

laeubi commented Jan 5, 2024

tjwatson left a comment

iloveeclipse commented Jan 5, 2024

laeubi commented Jan 5, 2024

mickaelistria commented Jan 8, 2024

HannesWell commented Jan 9, 2024

laeubi commented Jan 9, 2024

Add a 'wires' command to allow easy investigation of bundle wires #466

Add a 'wires' command to allow easy investigation of bundle wires #466

Conversation

laeubi commented Jan 4, 2024

github-actions bot commented Jan 4, 2024 • edited Loading

Test Results

tjwatson left a comment

Choose a reason for hiding this comment

tjwatson left a comment

Choose a reason for hiding this comment

laeubi commented Jan 5, 2024

tjwatson left a comment

Choose a reason for hiding this comment

iloveeclipse commented Jan 5, 2024

laeubi commented Jan 5, 2024

mickaelistria commented Jan 8, 2024

HannesWell commented Jan 9, 2024

laeubi commented Jan 9, 2024

github-actions bot commented Jan 4, 2024 •

edited

Loading