Fix/yarn test #6681
Merged
Fix/yarn test #6681
Conversation
This file contains hidden or 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
willhuang1997
commented
May 15, 2023
| // We need MessageChannel for BokehChart.test.tsx as we import bokeh scripts that use MessageChannel and jsdom doesn't define it (https://github.com/jsdom/jsdom/issues/2448) | ||
| // Additionally: the test command in package.json now uses the --experimental-worker node option in order to define the message channel | ||
| window.MessageChannel = require("worker_threads").MessageChannel | ||
| // delete MessageChannel in tests as scheduler doesn't close their MessageChannel |
Contributor
Author
There was a problem hiding this comment.
Fixes github actions from hanging.
Contributor
There was a problem hiding this comment.
Can we also "backport" this change into develop? (Any idea why it hangs in this branch but not on develop?)
tconkling
approved these changes
May 16, 2023
Comment on lines
16
to
32
|
|
||
| // default babel-jest configs | ||
| const babelJest = require("babel-jest").default | ||
|
|
||
| module.exports = babelJest.createTransformer({ | ||
| presets: [ | ||
| [ | ||
| // default preset react app configs | ||
| require.resolve("babel-preset-react-app"), | ||
| { | ||
| runtime: "automatic", | ||
| }, | ||
| ], | ||
| ], | ||
| // emotion plugin for transpiling | ||
| plugins: ["@emotion"], | ||
| }) |
Contributor
There was a problem hiding this comment.
Can you add some (short) documentation to this and the other jest transform files explaining what they do and why they're needed?
| // We need MessageChannel for BokehChart.test.tsx as we import bokeh scripts that use MessageChannel and jsdom doesn't define it (https://github.com/jsdom/jsdom/issues/2448) | ||
| // Additionally: the test command in package.json now uses the --experimental-worker node option in order to define the message channel | ||
| window.MessageChannel = require("worker_threads").MessageChannel | ||
| // delete MessageChannel in tests as scheduler doesn't close their MessageChannel |
Contributor
There was a problem hiding this comment.
Can we also "backport" this change into develop? (Any idea why it hangs in this branch but not on develop?)
frontend/jest/cssTransform.js
Outdated
Comment on lines
19
to
20
| // This is a custom Jest transformer turning style imports into empty objects. | ||
| // http://facebook.github.io/jest/docs/en/webpack.html |
Contributor
There was a problem hiding this comment.
Needs a bit more explanation (what problem does this solve?)
frontend/jest/fileTransform.js
Outdated
Comment on lines
22
to
23
| // This is a custom Jest transformer turning file imports into filenames. | ||
| // http://facebook.github.io/jest/docs/en/webpack.html |
tconkling
approved these changes
May 16, 2023
Comment on lines
+19
to
+21
| module.exports = function (api, opts) { | ||
| return create(api, Object.assign({ helpers: false }, opts), "test") | ||
| } |
Contributor
There was a problem hiding this comment.
What does this do? Can you add a comment describing it?
| collectCoverageFrom: [ | ||
| "src/**/*.{js,jsx,ts,tsx}", | ||
| "!src/**/*.d.ts", | ||
| "!src/**/bokeh/*.esm.min.js", |
Contributor
There was a problem hiding this comment.
Can this be simplified to !src/**/*.min.js (since we presumably never want to be testing coverage of any minified file?)
willhuang1997
added a commit
that referenced
this pull request
Jul 10, 2023
* Minimal exports for app to consume + VerticalBlock and ElementNodeRenderer (#6623) This PR is the first milestone to determine the minimal number of exports needed for app to consume + VerticalBlock + ElementNodeRenderer. Most of the changes are import path changes. Some of the more notable changes to look through are How the @streamlit/lib is built. It's built through the monorepo config for babel (https://babeljs.io/docs/config-files/#monorepos). a. The babel process works by using a custom preset that is mainly babel-preset-react-app but slightly modified in order to make sure glide data grid code is es6 compatible and hard coding isTypeScriptEnabled to True. b. The other keys are adding in the emotion plugin for styled-components, ignoring proto, vendor, test files, and telling babel that frontend is the root directory for babel config. The actual index.ts that is added to frontend/lib Some things to note that will be punt down but worked on later: We also need to look into why protobuf can't be compiled through tsc. Cleaning frontend/app/package.json Cleaning frontend/app/yarn.lock Cleaning frontend/lib/scripts/create.js Determine what's going wrong with globalStyles typing Determine what's going wrong with styled-components typing for EmotionTheme * Change exports for protobuf to be included in index.ts instead of copied through cp command. (#6635) Tim noticed that I was copying the protobuf.js and protobuf.d.ts instead of compiling it through babel. That causes problems because then you have to import by doing import { ... } from "@streamlit/lib/dist/proto" which doesn't make any sense. The reason why I did that was because I was getting an error on first try: `src/proto.js:4:1 - error TS9005: Declaration emit for this file requires using private name 'Radii'. An explicit type annotation may unblock declaration emit. 4 import * as $protobuf from "protobufjs/minimal"; ~~~~~~ src/proto.js:4:1 - error TS9005: Declaration emit for this file requires using private name 'Radio'. An explicit type annotation may unblock declaration emit. 4 import * as $protobuf from "protobufjs/minimal";` I just removed the proto files and did a make protobuf and then tried exporting and that worked, as it should. * Simple fix for globalStyles (#6651) * Fix typing issues for styled-components (#6652) There are going to be 2 emotion.d.ts. Our @streamlit/lib has our own theming and then our app will simply just be consuming from @streamlit/lib which makes sense. * remove extra app directory in frontend dir (#6653) The current folder structure is frontend/app/src/app. We should make it so that it's frontend/app/src and remove the extra app directory. This PR also fixes the audit_license script. * Remove unnecessary files * Fix naming of directories and files * Fix BaseColorPicker directory * Add Fixes that should exist in feature/st-lib * Fix Eslint and Type-checking for st-lib (#6675) This PR is to fix eslint for app and lib. This also adds dependencies that are necessary to lib's package.json. This is done through eslint noticing the necessary dependencies. This PR also does some linting and also does a merge from develop as we need the BaseButton refactoring to stop duplication of exports from the root index.ts. In addition, this PR fixes the type checking github actions by adding new commands. * Fix notices (#6676) * Clean up audit_frontend_licenses * Fix/yarn test (#6681) This is to fix yarn test. This simply adds new scripts through the yarn workspace command to run app and lib tests. Currently, the lib testing works by mainly using the same scripts that CRA uses for transpiling typescript to javascript. There is one other thing to note: It looks like if you were to upgrade to 17.0.1 supposedly for react-dom, it would fix jest tests for app to not hang (facebook/react#20756 (comment)). However, jest was still hanging so I just did a delete MessageChannel within src/setupTests.js and we can remove that when we upgrade to React 18. * Fix regex that I accidentally forgot to commit (#6698) * Fix/cypress (#6699) * Remove unused app dep / dev dep and declarations.d.ts (#6713) * Remove unused app dep / dev dep and declarations.d.ts * Remove d3 color resolution (#6714) * Add dependencies removed from app to lib/package.json * Add pbjs cli * Readd notices * Add watch lib script (#6730) Since @streamlit/lib is separated out to be its own separate lib, we need a script to constantly rebuild when the files change. Will also need to update the contributing wiki after this is merged to develop. * Get rid of yarn start warnings and clean Makefile (#6739) * Remove streamlit.css. I'm not sure where it came from * Fix yarn buildLib * Fix eslintrc * Fix codeql * Add notices and yarn.lock * Fix glide-data-grid versions * Fix nits * Fix nits * Lint and cleanup * Minor cleanup for Block utils as comments got removed * Remove accidentally committed file * Revert "Remove accidentally committed file" This reverts commit 87b7f13. * Fix yarn lock * Fix compilation errors * Fix lint * Fix notices * Remove unnecessary package.json dependencies * Fix package.json versions * Fix yarn.lock and streamlit dialog snapshots * Fix notices * Have faster hot reloading and absolute imports for @streamlit/lib (#6961) <!--⚠️ BEFORE CONTRIBUTING PLEASE READ OUR CONTRIBUTING GUIDELINES! https://github.com/streamlit/streamlit/wiki/Contributing --> ## Describe your changes - Change imports for `app` to `@streamlit/app/src...` as we removed the `ModuleScopePlugin` which allows us to import out of `app/src`. - Change imports for `lib` to absolute imports - add `tsconfig.dev.json` that is specifically for developement - change `tsconfig.json` for `lib` and `app` - change `.eslintrc` to `.eslintrc.js` in order to gain access to `__dirname` to make typescript configs relative to each project ## GitHub Issue Link (if applicable) ## Testing Plan Manually testing - Explanation of why no additional tests are needed - Unit Tests (JS and/or Python) - E2E Tests - Any manual testing needed? yes https://github.com/streamlit/streamlit/assets/16749069/cc0a5f96-f8cd-487b-b70e-6a4e5823f0e7 --- **Contribution License Agreement** By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license. * Fix minor comments from Lukas
asmeralt
pushed a commit
to asmeralt/streamlit
that referenced
this pull request
Sep 29, 2025
* Minimal exports for app to consume + VerticalBlock and ElementNodeRenderer (streamlit#6623) This PR is the first milestone to determine the minimal number of exports needed for app to consume + VerticalBlock + ElementNodeRenderer. Most of the changes are import path changes. Some of the more notable changes to look through are How the @streamlit/lib is built. It's built through the monorepo config for babel (https://babeljs.io/docs/config-files/#monorepos). a. The babel process works by using a custom preset that is mainly babel-preset-react-app but slightly modified in order to make sure glide data grid code is es6 compatible and hard coding isTypeScriptEnabled to True. b. The other keys are adding in the emotion plugin for styled-components, ignoring proto, vendor, test files, and telling babel that frontend is the root directory for babel config. The actual index.ts that is added to frontend/lib Some things to note that will be punt down but worked on later: We also need to look into why protobuf can't be compiled through tsc. Cleaning frontend/app/package.json Cleaning frontend/app/yarn.lock Cleaning frontend/lib/scripts/create.js Determine what's going wrong with globalStyles typing Determine what's going wrong with styled-components typing for EmotionTheme * Change exports for protobuf to be included in index.ts instead of copied through cp command. (streamlit#6635) Tim noticed that I was copying the protobuf.js and protobuf.d.ts instead of compiling it through babel. That causes problems because then you have to import by doing import { ... } from "@streamlit/lib/dist/proto" which doesn't make any sense. The reason why I did that was because I was getting an error on first try: `src/proto.js:4:1 - error TS9005: Declaration emit for this file requires using private name 'Radii'. An explicit type annotation may unblock declaration emit. 4 import * as $protobuf from "protobufjs/minimal"; ~~~~~~ src/proto.js:4:1 - error TS9005: Declaration emit for this file requires using private name 'Radio'. An explicit type annotation may unblock declaration emit. 4 import * as $protobuf from "protobufjs/minimal";` I just removed the proto files and did a make protobuf and then tried exporting and that worked, as it should. * Simple fix for globalStyles (streamlit#6651) * Fix typing issues for styled-components (streamlit#6652) There are going to be 2 emotion.d.ts. Our @streamlit/lib has our own theming and then our app will simply just be consuming from @streamlit/lib which makes sense. * remove extra app directory in frontend dir (streamlit#6653) The current folder structure is frontend/app/src/app. We should make it so that it's frontend/app/src and remove the extra app directory. This PR also fixes the audit_license script. * Remove unnecessary files * Fix naming of directories and files * Fix BaseColorPicker directory * Add Fixes that should exist in feature/st-lib * Fix Eslint and Type-checking for st-lib (streamlit#6675) This PR is to fix eslint for app and lib. This also adds dependencies that are necessary to lib's package.json. This is done through eslint noticing the necessary dependencies. This PR also does some linting and also does a merge from develop as we need the BaseButton refactoring to stop duplication of exports from the root index.ts. In addition, this PR fixes the type checking github actions by adding new commands. * Fix notices (streamlit#6676) * Clean up audit_frontend_licenses * Fix/yarn test (streamlit#6681) This is to fix yarn test. This simply adds new scripts through the yarn workspace command to run app and lib tests. Currently, the lib testing works by mainly using the same scripts that CRA uses for transpiling typescript to javascript. There is one other thing to note: It looks like if you were to upgrade to 17.0.1 supposedly for react-dom, it would fix jest tests for app to not hang (facebook/react#20756 (comment)). However, jest was still hanging so I just did a delete MessageChannel within src/setupTests.js and we can remove that when we upgrade to React 18. * Fix regex that I accidentally forgot to commit (streamlit#6698) * Fix/cypress (streamlit#6699) * Remove unused app dep / dev dep and declarations.d.ts (streamlit#6713) * Remove unused app dep / dev dep and declarations.d.ts * Remove d3 color resolution (streamlit#6714) * Add dependencies removed from app to lib/package.json * Add pbjs cli * Readd notices * Add watch lib script (streamlit#6730) Since @streamlit/lib is separated out to be its own separate lib, we need a script to constantly rebuild when the files change. Will also need to update the contributing wiki after this is merged to develop. * Get rid of yarn start warnings and clean Makefile (streamlit#6739) * Remove streamlit.css. I'm not sure where it came from * Fix yarn buildLib * Fix eslintrc * Fix codeql * Add notices and yarn.lock * Fix glide-data-grid versions * Fix nits * Fix nits * Lint and cleanup * Minor cleanup for Block utils as comments got removed * Remove accidentally committed file * Revert "Remove accidentally committed file" This reverts commit 87b7f13. * Fix yarn lock * Fix compilation errors * Fix lint * Fix notices * Remove unnecessary package.json dependencies * Fix package.json versions * Fix yarn.lock and streamlit dialog snapshots * Fix notices * Have faster hot reloading and absolute imports for @streamlit/lib (streamlit#6961) <!--⚠️ BEFORE CONTRIBUTING PLEASE READ OUR CONTRIBUTING GUIDELINES! https://github.com/streamlit/streamlit/wiki/Contributing --> ## Describe your changes - Change imports for `app` to `@streamlit/app/src...` as we removed the `ModuleScopePlugin` which allows us to import out of `app/src`. - Change imports for `lib` to absolute imports - add `tsconfig.dev.json` that is specifically for developement - change `tsconfig.json` for `lib` and `app` - change `.eslintrc` to `.eslintrc.js` in order to gain access to `__dirname` to make typescript configs relative to each project ## GitHub Issue Link (if applicable) ## Testing Plan Manually testing - Explanation of why no additional tests are needed - Unit Tests (JS and/or Python) - E2E Tests - Any manual testing needed? yes https://github.com/streamlit/streamlit/assets/16749069/cc0a5f96-f8cd-487b-b70e-6a4e5823f0e7 --- **Contribution License Agreement** By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license. * Fix minor comments from Lukas
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is to fix yarn test. This simply adds new scripts through the
yarn workspacecommand to runappandlibtests.Currently, the lib testing works by mainly using the same scripts that CRA uses for transpiling typescript to javascript.
There is one other thing to note: It looks like if you were to upgrade to 17.0.1 supposedly for
react-dom, it would fix jest tests forappto not hang (facebook/react#20756 (comment)). However, jest was still hanging so I just did adelete MessageChannelwithinsrc/setupTests.jsand we can remove that when we upgrade to React 18.