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

build: remove unused libsass dependency #1987

Merged
merged 1 commit into from
Jul 18, 2023

Conversation

kdmccormick
Copy link
Member

@kdmccormick kdmccormick commented Jul 11, 2023

The libsass Python requirement doesn't seem to be used any more. I was able to compile ORA's assets by running make static; no Python dependencies needed.

We are eager to remove libsass from ORA's base requirements because it'll allow us to optimize how edx-platform installs the library. Libsass is a deprecated Sass compilation library written in C, and installing it into edx-platform adds a whole minute to the build because there are no pre-compiled binaries available for the version we install.

Closes: #1986

@kdmccormick kdmccormick force-pushed the kdmccormick/rm-libsass branch from f5b6df0 to ccb0ce8 Compare July 11, 2023 16:53
@codecov
Copy link

codecov bot commented Jul 11, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (c2a59ee) 94.99% compared to head (8798579) 94.99%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1987   +/-   ##
=======================================
  Coverage   94.99%   94.99%           
=======================================
  Files         155      155           
  Lines       17107    17107           
  Branches     1616     1616           
=======================================
  Hits        16250    16250           
  Misses        642      642           
  Partials      215      215           
Flag Coverage Δ
unittests 94.99% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
openassessment/__init__.py 100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@kdmccormick
Copy link
Member Author

kdmccormick commented Jul 11, 2023

@openedx/content-aurora , per the release process I ran make static and ended up with a lot of asset changes:

On branch kdmccormick/rm-libsass
Your branch is up to date with 'origin/kdmccormick/rm-libsass'.

Changes not staged for commit:
  (use "git add/rm <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   openassessment/xblock/static/dist/manifest.json
	modified:   openassessment/xblock/static/dist/openassessment-editor-textarea.js
	modified:   openassessment/xblock/static/dist/openassessment-editor-tinymce.js
	deleted:    openassessment/xblock/static/dist/openassessment-lms.967dad15c001a5dc6a5e.css
	deleted:    openassessment/xblock/static/dist/openassessment-lms.967dad15c001a5dc6a5e.js
	deleted:    openassessment/xblock/static/dist/openassessment-lms.e009f195cfd3e23b44e3.css
	deleted:    openassessment/xblock/static/dist/openassessment-lms.e009f195cfd3e23b44e3.js
	modified:   openassessment/xblock/static/dist/openassessment-lms.js
	deleted:    openassessment/xblock/static/dist/openassessment-ltr.af4f203c872dac1a24b5.css
	deleted:    openassessment/xblock/static/dist/openassessment-ltr.af4f203c872dac1a24b5.js
	modified:   openassessment/xblock/static/dist/openassessment-ltr.css
	modified:   openassessment/xblock/static/dist/openassessment-ltr.js
	deleted:    openassessment/xblock/static/dist/openassessment-rtl.b8d173da7a201af6385c.css
	deleted:    openassessment/xblock/static/dist/openassessment-rtl.b8d173da7a201af6385c.js
	modified:   openassessment/xblock/static/dist/openassessment-rtl.css
	modified:   openassessment/xblock/static/dist/openassessment-rtl.js
	deleted:    openassessment/xblock/static/dist/openassessment-studio.1ef78b4390a9cfa2e9b1.js
	modified:   openassessment/xblock/static/dist/openassessment-studio.js

Untracked files:
  (use "git add <file>..." to include in what will be committed)
	openassessment/xblock/static/dist/openassessment-lms.2104c24f053bcbe15f3a.css
	openassessment/xblock/static/dist/openassessment-lms.2104c24f053bcbe15f3a.js

I tried make static on master as well, and found that it showed the same changeset.

Should I commit these changes, or leave them out?

@kdmccormick kdmccormick marked this pull request as ready for review July 11, 2023 17:13
@kdmccormick kdmccormick requested a review from a team as a code owner July 11, 2023 17:13
@kdmccormick kdmccormick changed the title build: remove unused libsass dependency (WIP) build: remove unused libsass dependency Jul 11, 2023
@kdmccormick kdmccormick force-pushed the kdmccormick/rm-libsass branch from ccb0ce8 to fae49ca Compare July 11, 2023 17:15
Bump version: 5.1.1 -> 5.2.0

TODO will paste in details from PR description

Closes: openedx#1986
@kdmccormick kdmccormick force-pushed the kdmccormick/rm-libsass branch from fae49ca to 8798579 Compare July 18, 2023 17:09
Copy link

@e0d e0d left a comment

Choose a reason for hiding this comment

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

This change looks completely reasonable to me, but I'm not in a good position to understand or test issues this might cause when it's deployed. As this is related to speeding up edx-platform deployment I wonder if ArchBOM could review? @jmbowman does that seem reasonable?

@kdmccormick
Copy link
Member Author

Thanks for the reviews!

@kdmccormick kdmccormick merged commit f9355d1 into openedx:master Jul 18, 2023
@kdmccormick kdmccormick deleted the kdmccormick/rm-libsass branch July 18, 2023 18:41
BryanttV pushed a commit to eduNEXT/edx-ora2 that referenced this pull request Feb 6, 2024
(Bumps version: 5.1.1 -> 5.2.0)

We remove the libsass Python requirement as it doesn't seem to be used
any more. (I was able to compile ORA's assets by running `make static`;
no Python dependencies needed.) Removing libsass from ORA's requirements
will allow us to move it out of edx-platform's base requirements and into a new
static-asset-compilation-specific requirements stage.

Libsass [1] is a deprecated Sass compilation library written in C,
and installing it into edx-platform adds a whole minute to the
build because there are no pre-compiled binaries available
for the version we install.

1. https://sass-lang.com/libsass/

Closes: openedx#1986
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove libsass from base requirements for edx-ora2
3 participants