feat(tooling): convert-repo-to-yarn-workspace #1443

Shreyas281299 · 2024-10-23T07:52:48Z

Completes -SPARK-559074

My suggestion on how to review this PR - close the packages folder, it only has file name changes. After that its a small PR

This PR is the second PR in the series of many PRs to create react-widgets a yarn workspace
First PR #1438

This PR completes the final 4tasks in the list below

Tasks required to make react-widgets a yarn workspace

Move components out of node_modules
Adjust the tooling to use the new paths
Enable yarn workspace in react-widget
Add dependencies inside each package
Add scripts for each package
Fix tooling to use yarn workspaces packages

Checks

Build is passing
UTs are passing
Integration tests are passing

Testing

Ran yarn build:all
Ran yarn workspace @webex/ build:src
Ran yarn workspace @webex/ serve
Served all the demos
Ran all UTs

Issues found

All these errors are persistent in master and node-upgrade branch also

People list has ENOENT  error while building - any css file thats why this error - its doesnt affect anything 
Widget-meet has ENOENT - any css file thats why this error - its doesnt affect anything 
All demo components fails the buildES function.
Issue with tsconfig- webpack build fails for all ts 'widget' components
Failling command - npm run deploy is failing in master and node-upgrade as well
We are ignoring all the src files for eslint tests
journey tests are failling in the node-upgrade branch as well

Shreyas281299 · 2024-10-23T08:20:13Z

The reason why github actions is failling is because the base branch is configured for npm. Once we merge this PR all the subsequent PRs should be configured for yarn and will pass. Since there is no yarnrc or yarn.lock file in base branch github actions is using npm for this PR. Example PR against create-workspace branch -https://github.com/Shreyas281299/react-widgets/actions/runs/11476200784/job/31935688832

scripts/webpack/webpack.base.babel.js

Shreyas281299 · 2024-10-23T10:40:36Z

scripts/webpack/webpack.base.babel.js

+      REACT_WEBEX_VERSION: "",
+      FEDERATION: "",
+      IDBROKER_BASE_URL: "",
+      U2C_SERVICE_URL: "",
+      WEBEX_CLIENT_ID: "",
+      WDM_SERVICE_URL: "",
+      WEBEX_CONVERSATION_DEFAULT_CLUSTER: "",
+      WEBEX_TEST_USERS_CONVERSATION_SERVICE_URL: "",
+    }),


After moving to yarn workspaces, there is a different way in which env variables are passed. This change does nothing but provides a fallback to these empty string just in case these variables are not available. Im still trying to figure out how yarn workspaces work with env varibales.

A possible speculation is that previously all the commands were run from root folder and the .env folder was also present in the root folder. But now when we run yarn build for each workspace the root folder becomes the workspace and there is no .env available there.

mkesavan13

Mostly looks good. Just a few comments

.yarnrc.yml

scripts/utils/build.js

scripts/utils/package.js

scripts/webpack/webpack.base.babel.js

scripts/webpack/webpack.prod.babel.js

adhmenon

LGTM. Nit - just modify the yarn version from 4.5.0 to 4.5.1

coderabbitai · 2024-10-25T14:10:17Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

mkesavan13

Mostly good. However,

We do not this file to be checked-in: .yarn/install-state.gz as per this documentation. Let us remove it before merging the PR. Quoting the same here: .yarn/install-state.gz is an optimization file that you shouldn't ever have to commit. It simply stores the exact state of your project so that the next commands can boot without having to resolve your workspaces all over again.
Please change the PR title
The CI seems to be failing. Please check that one too

Shreyas281299 · 2024-10-28T09:13:34Z

Mostly good. However,

* We do not this file to be checked-in: `.yarn/install-state.gz` as per [this documentation](https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored). Let us remove it before merging the PR. Quoting the same here: `.yarn/install-state.gz is an optimization file that you shouldn't ever have to commit. It simply stores the exact state of your project so that the next commands can boot without having to resolve your workspaces all over again.`

* Please change the PR title

* The CI seems to be failing. Please check that one too

Removed the yarn/install-state file
Changed the PR title

For the pipelines failure-
1. CircleCi, will fail because I havnt made any changes to circleCi scripts as we are moving to github-actions.
2. Why github actions is failling? When github actions runs install it considers the base branch(which is still using npm). After we merge this PR and make the repo use yarn after that all the PRs will work fine. I tested this in my fork, here is the github action for that - https://github.com/Shreyas281299/react-widgets/actions/runs/11476200784/job/31935688832

Shreyas281299 · 2024-10-28T11:09:29Z

Mostly good. However,
* We do not this file to be checked-in: `.yarn/install-state.gz` as per [this documentation](https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored). Let us remove it before merging the PR. Quoting the same here: `.yarn/install-state.gz is an optimization file that you shouldn't ever have to commit. It simply stores the exact state of your project so that the next commands can boot without having to resolve your workspaces all over again.`

* Please change the PR title

* The CI seems to be failing. Please check that one too
Removed the yarn/install-state file Changed the PR title

For the pipelines failure- 1. CircleCi, will fail because I havnt made any changes to circleCi scripts as we are moving to github-actions. 2. Why github actions is failling? When github actions runs install it considers the base branch(which is still using npm). After we merge this PR and make the repo use yarn after that all the PRs will work fine. I tested this in my fork, here is the github action for that - https://github.com/Shreyas281299/react-widgets/actions/runs/11476200784/job/31935688832

This takeaway was incorrect. The actually issue was that github was not checking out the correct commit.
#1449 Fixed in the PR

ShreyasSharma28 and others added 5 commits October 10, 2024 11:49

tolling(workspace): turn-react-widgets-into-a-yarn-workspace

da22acc

feat(tooling): add-scripts-in-each package

8a4d0bd

fix(tooling): remove-unecessary-formatting

a88fee9

Merge remote-tracking branch 'origin/node-upgrade' into create-workspace

8ddce2c

Merge branch 'node-upgrade' into create-workspace

56a4aa4

Shreyas281299 force-pushed the create-workspace branch from c5626c0 to 56a4aa4 Compare October 23, 2024 08:15

Shreyas281299 closed this Oct 23, 2024

Shreyas281299 reopened this Oct 23, 2024

fix(build): fix-public-path-issue

a405787

Shreyas281299 force-pushed the create-workspace branch from 0c7bb4b to c8d1b0e Compare October 23, 2024 08:33

fix(yarn): add-yarn-path-in-yarnrc

af1ea91

Shreyas281299 force-pushed the create-workspace branch from c8d1b0e to af1ea91 Compare October 23, 2024 08:36

Shreyas281299 commented Oct 23, 2024

View reviewed changes

scripts/webpack/webpack.base.babel.js Show resolved Hide resolved

Shreyas281299 commented Oct 23, 2024

View reviewed changes

mkesavan13 requested changes Oct 25, 2024

View reviewed changes

.yarnrc.yml Outdated Show resolved Hide resolved

scripts/utils/build.js Show resolved Hide resolved

scripts/utils/package.js Show resolved Hide resolved

scripts/webpack/webpack.base.babel.js Show resolved Hide resolved

scripts/webpack/webpack.prod.babel.js Show resolved Hide resolved

adhmenon approved these changes Oct 25, 2024

View reviewed changes

ShreyasSharma28 added 2 commits October 25, 2024 19:03

Merge remote-tracking branch 'origin/node-upgrade' into create-workspace

16e9c20

fix(yarn): upgrade-yarn-to-4-5-1

e309d06

mkesavan13 approved these changes Oct 28, 2024

View reviewed changes

fix(tooling): remove-yarn-install-file

7845ada

Shreyas281299 changed the title ~~Create workspace~~ feat(tooling): convert-repo-to-yarn-workspace Oct 28, 2024

ShreyasSharma28 added 2 commits October 28, 2024 15:26

fix(tooling): fix-checkout-issue-in-actions

36531bd

Merge remote-tracking branch 'origin/node-upgrade' into create-workspace

b88d6ce

Shreyas281299 merged commit 12dea86 into webex:node-upgrade Oct 28, 2024
4 of 7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(tooling): convert-repo-to-yarn-workspace #1443

feat(tooling): convert-repo-to-yarn-workspace #1443

Shreyas281299 commented Oct 23, 2024 •

edited

Loading

Shreyas281299 commented Oct 23, 2024 •

edited

Loading

Shreyas281299 Oct 23, 2024

mkesavan13 left a comment

adhmenon left a comment

coderabbitai bot commented Oct 25, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

mkesavan13 left a comment

Shreyas281299 commented Oct 28, 2024

Shreyas281299 commented Oct 28, 2024

feat(tooling): convert-repo-to-yarn-workspace #1443

feat(tooling): convert-repo-to-yarn-workspace #1443

Conversation

Shreyas281299 commented Oct 23, 2024 • edited Loading

Completes -SPARK-559074

My suggestion on how to review this PR - close the packages folder, it only has file name changes. After that its a small PR

Tasks required to make react-widgets a yarn workspace

Checks

Testing

Issues found

Shreyas281299 commented Oct 23, 2024 • edited Loading

Shreyas281299 Oct 23, 2024

Choose a reason for hiding this comment

mkesavan13 left a comment

Choose a reason for hiding this comment

adhmenon left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Oct 25, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

mkesavan13 left a comment

Choose a reason for hiding this comment

Shreyas281299 commented Oct 28, 2024

Shreyas281299 commented Oct 28, 2024

Shreyas281299 commented Oct 23, 2024 •

edited

Loading

Shreyas281299 commented Oct 23, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)