Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat! Dropping Sass support from builtin video block #35506

Merged
merged 3 commits into from
Oct 24, 2024

Conversation

farhan
Copy link
Contributor

@farhan farhan commented Sep 19, 2024

Dropping Sass support from builtin video block

Tickets: #35570

Tasks:

  • Convert Sass variable into css variables

  • Compile the css files of the block following below steps.

    • Change this line to the following to avoid adding comments in the compiled css files. This change is only for compilation, revert it when done with compilation.
           source_comments: int = SASS_COMMENTS_NONE
    • Compile the sass to uncompressed CSS using following command
            npm run compile-sass-dev
    • Copy the compiled XBlock linked CSS (lms/static/css/*Display.css and lms/static/css/*Editor.css) into xmodule/static/css-builtin-blocks.
    • Format the CSS files using the editor.
    • Add those CSS files to version control.
  • Replace add_sass_to_fragment to add_css_to_fragment in blocksin .py file

  • Remove all .scss files linked to the block under xmodule/assets.

    • Make sure to remove the .scss file in a separate alone commit so reviewer could review scss changes and they stay in history.
    • Don't remove the scss file if its linked to some other block.

Testing:

  • Run npm run build to run webpack and compile sass files.
  • Run ./manage.py lms collectstatic in lms shell to re-collect static files.
  • Run ./manage.py cms collectstatic in cms shell to re-collect static files.
  • Verify the block's compiled css and the css global variables in the LMS
  • Verify the block's compiled css and the css global variables in the Studio
  • Test the XBlock rendering and User Experience in LMS
  • Test the XBlock rendering and User Experience in Studio
Screenshots
Screenshot 2024-10-01 at 5 50 29 PM
Screenshot 2024-10-01 at 5 50 19 PM
lms
cms

@farhan farhan force-pushed the farhan/sass-to-css-video-block branch 3 times, most recently from bd41dcd to a509763 Compare September 21, 2024 12:16
@farhan farhan changed the title Dropping Sass support from builtin video block feat! Dropping Sass support from builtin video block Sep 23, 2024
@farhan farhan self-assigned this Sep 23, 2024
@farhan farhan marked this pull request as ready for review September 23, 2024 09:13
@farhan farhan force-pushed the farhan/sass-to-css-video-block branch 4 times, most recently from e4e5992 to a5919c0 Compare October 1, 2024 12:05
@farhan farhan requested a review from nsprenkle October 1, 2024 15:48
@farhan farhan added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Oct 3, 2024
@farhan farhan requested a review from feanil October 11, 2024 12:02
@farhan farhan force-pushed the farhan/sass-to-css-video-block branch from 84e9274 to 19a8c75 Compare October 11, 2024 17:39
@farhan farhan added the hacktoberfest-accepted Issue accepted for hacktoberfest participants label Oct 11, 2024
@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@farhan farhan force-pushed the farhan/sass-to-css-video-block branch from 19a8c75 to 7dc8eae Compare October 14, 2024 08:58
@open-craft-grove
Copy link

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@farhan farhan closed this Oct 14, 2024
@farhan farhan reopened this Oct 14, 2024
@openedx openedx deleted a comment from open-craft-grove Oct 14, 2024
@openedx openedx deleted a comment from open-craft-grove Oct 14, 2024
@farhan farhan added create-sandbox open-craft-grove should create a sandbox environment from this PR and removed create-sandbox open-craft-grove should create a sandbox environment from this PR labels Oct 14, 2024
@farhan farhan force-pushed the farhan/sass-to-css-video-block branch from 7dc8eae to d280339 Compare October 14, 2024 13:17
@open-craft-grove
Copy link

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@farhan farhan added create-sandbox open-craft-grove should create a sandbox environment from this PR and removed create-sandbox open-craft-grove should create a sandbox environment from this PR labels Oct 16, 2024
@farhan farhan force-pushed the farhan/sass-to-css-video-block branch from d280339 to 7558ad4 Compare October 16, 2024 10:24
@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@fayyazahmed66
Copy link

I am going to test this as its critical.
CC: @farhan

@fayyazahmed66
Copy link

I have tested Video Xblock, Things are working fine.
Here is the report.

@farhan
Copy link
Contributor Author

farhan commented Oct 23, 2024

@fayyazahmed66 Thanks for your valuable testing contribution, appreciated 🌟

@ttqureshi
Copy link
Contributor

I am going to review this PR.
CC: @farhan

Copy link
Contributor

@ttqureshi ttqureshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have reviewd the PR. It's good to go 🚀

Copy link
Contributor

@salman2013 salman2013 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@farhan farhan force-pushed the farhan/sass-to-css-video-block branch from 7558ad4 to a344a27 Compare October 23, 2024 11:13
@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some comment corrections.

If I'm merging this PR later in the day anyway, I can apply these before merging.

xmodule/util/builtin_assets.py Outdated Show resolved Hide resolved
xmodule/util/builtin_assets.py Outdated Show resolved Hide resolved
xmodule/util/builtin_assets.py Outdated Show resolved Hide resolved
@farhan farhan force-pushed the farhan/sass-to-css-video-block branch from 8f58637 to 7764e47 Compare October 23, 2024 13:40
@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! 🚀

@farhan farhan merged commit 0c91b62 into master Oct 24, 2024
49 checks passed
@farhan farhan deleted the farhan/sass-to-css-video-block branch October 24, 2024 07:50
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
create-sandbox open-craft-grove should create a sandbox environment from this PR hacktoberfest-accepted Issue accepted for hacktoberfest participants
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

7 participants