Fix circular dependencies that pollutes version bump #12495
Merged
Conversation
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
|
Thanks for making a pull request to jupyterlab! |
|
Current top circular loop detected by lerna:
|
github-actions
bot
added
pkg:cells
pkg:notebook
pkg:observables
pkg:settingregistry
pkg:statedb
labels
fcollonval
force-pushed
the
fix/11630-testutils-cycle-dep
branch
from
a7dcf23
to
70f9d2f
Compare
fcollonval
force-pushed
the
fix/11630-testutils-cycle-dep
branch
from
21a4fcb
to
330a454
Compare
|
Ok indeed this fixes it. Big thanks to @blink1073 🥇 🚀 |
fcollonval
force-pushed
the
fix/11630-testutils-cycle-dep
branch
from
f39d1bf
to
da601a0
Compare
This might look a bit odd and unusual at first since this was not really a pattern used across the lab code base until now. But yeah I am also not sure whether there would be another way to fix the circular dependency without doing something like this. |
Move tests from codeeditor to codemirror This is needed to respect package hierarchy Refactor test to have logical dependencies graph
Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com>
Locally all tests are passing (thanks to the --runInBand option) Hopefully this one can pass on the CI too.
fcollonval
force-pushed
the
fix/11630-testutils-cycle-dep
branch
from
da601a0
to
ece7937
Compare
jtpio
reviewed
Jan 3, 2023
| open: () => { | ||
| /* noop */ | ||
| } | ||
| } as any, |
There was a problem hiding this comment.
What was the reason for not using the DocumentWidgetOpenerMock here?
There was a problem hiding this comment.
A miss in the many rebase
There was a problem hiding this comment.
I'll push a follow-up PR
hbcarlos
pushed a commit
to hbcarlos/jupyterlab
that referenced
this pull request
Jan 29, 2023
* Create @jupyterlab/testing Move tests from codeeditor to codemirror This is needed to respect package hierarchy Refactor test to have logical dependencies graph * Add all test dependencies for coreutils * Internalize retry setup and server start up * Remove testutils from new files * Restore the testutils API as much as possible * Fix tests * Fix debugger tests * Update timeout for flaky test * Fix setup/teardown * Advice to use `runInBand` when running locally * Fix running all tests at once locally * [skip ci] Update docs/source/extension/extension_migration.rst Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com> * Increase timeout for last timed out test Locally all tests are passing (thanks to the --runInBand option) Hopefully this one can pass on the CI too. * Automatic application of license header * Undo custom timeout setting * Apply changes to @jupyterlab/metadataform Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
hbcarlos
pushed a commit
to hbcarlos/jupyterlab
that referenced
this pull request
Jan 29, 2023
* Create @jupyterlab/testing Move tests from codeeditor to codemirror This is needed to respect package hierarchy Refactor test to have logical dependencies graph * Add all test dependencies for coreutils * Internalize retry setup and server start up * Remove testutils from new files * Restore the testutils API as much as possible * Fix tests * Fix debugger tests * Update timeout for flaky test * Fix setup/teardown * Advice to use `runInBand` when running locally * Fix running all tests at once locally * [skip ci] Update docs/source/extension/extension_migration.rst Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com> * Increase timeout for last timed out test Locally all tests are passing (thanks to the --runInBand option) Hopefully this one can pass on the CI too. * Automatic application of license header * Undo custom timeout setting * Apply changes to @jupyterlab/metadataform Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
References
Fix #11630
Fix #5821
We have 2 circular dependencies to break. The major trouble being testutils. We cannot depend on test utils for all packages. But as it is published, we probably needs to keep publishing it although the best approach would be to internalize the utils in each package => This is done by adding a
src/testutils.tsthat is not exposed through thesrc/index.ts.lerna does not ignore circular dependencies that come from dev dependencies. So when bumping the version it is spreading to far more packages than needed.
Code changes
Create a new package
@jupyterlab/testingthat contains the configuration for babel and jest as well as all helpers for testing@jupyterlab/services.The helpers in
@jupyterlab/testutilshave been split between the packages in atestutils.tsfile (or folder) that is not directly exported by theirindex.Some tests have chicken/egg trouble (packages codeeditor, completer and rendermime are using their downstream packages for unit tests 😞) -> the quick solution done here where to move those test files in metapackage.
@jupyterlab/testutilsexports all previous helpers. But they main not be gathered under the same namespace.User-facing changes
N/A
Backwards-incompatible changes
Hopefully few