Skip to content

[heft-sass-plugin] Make the incremental cache file name machine-independent - #6212

Open
Heramb_Inamke (HerambInamke) wants to merge 1 commit into
microsoft:mainfrom
HerambInamke:fix/issue-6126-sass-cache-file-name
Open

Heramb_Inamke (HerambInamke) wants to merge 1 commit into
microsoft:mainfrom
HerambInamke:fix/issue-6126-sass-cache-file-name

Conversation

@HerambInamke

Copy link
Copy Markdown

Summary

Fixes #6126.

The incremental cache file written by @rushstack/heft-sass-plugin (temp/build/sass/sass_<hash>.json) got a different name on each machine, because the name came from hashing every processor option. That included the absolute build folder, other absolute folder paths, and concurrency (the core count). Identical builds in different checkout folders, or on machines with different core counts, produced different output folder listings and different build cache entries.

This PR makes the name depend only on options that affect the output.

Details

Root cause: SassProcessor.loadCacheAsync computed the name as getContentsHash('sass.json', JSON.stringify({ version: 2, options })). The options object from SassPlugin holds buildFolder, absolute srcFolder / dtsOutputFolders / cssOutputFolders / loadPaths, concurrency = numberOfCores, and the logger.

Fix: the JSON.stringify call that builds the hash input now uses a replacer. It:

  • drops logger and concurrency, which do not affect the output;
  • rewrites every absolute path string as a path relative to buildFolder, using forward slashes, so buildFolder itself and every folder under it give the same text on any machine and OS.

Options that do affect the output (for example exportAsDefault, file extensions, output folders relative to the project) still change the name, so the cache is still invalidated when they change.

Safety of sharing the file across machines: the old name also stopped a cache file from another checkout from ever being loaded. The cache contents are already portable: each record stores relativePath (relative to buildFolder) plus content-derived version / cssVersion hashes, and the paths are resolved against the current buildFolder on load. So a cache file restored from another machine is valid.

Compatibility: this is not a breaking change. The first build after upgrading writes a cache file under the new name and does a full Sass compile. The old sass_<oldhash>.json file stays in temp/ until it is cleaned, as with any earlier option change.

I also considered a fixed file name with the options hash stored inside the file. I chose the smaller change, which keeps the existing scheme.

How it was tested

New unit tests in src/test/SassProcessor.test.ts (loadCacheAsync):

  • The cache file name is the same for two processors whose build folders are at different absolute locations and whose concurrency differs (4 vs 16).
  • The cache file name changes when an option that affects the output changes (exportAsDefault).

The first test fails without the fix and passes with it.

Commands run:

node common/scripts/install-run-rush.js install --to @rushstack/heft-sass-plugin
node common/scripts/install-run-rush.js build --to-except @rushstack/heft-sass-plugin
cd heft-plugins/heft-sass-plugin
node_modules/.bin/heft test --clean        # build + lint + tests: 172 passed, 0 failed, 0 lint warnings
cd ../..
node common/scripts/install-run-rush.js change --verify -b origin/main   # passes

Follow-up issues created: none.

…endent

The cache file name was a hash of all processor options, including the
absolute build folder, other absolute paths, and the core count. Exclude
the logger and concurrency from the hash and make absolute paths relative
to the build folder.

Fixes microsoft#6126
@microsoft-github-policy-service

Copy link
Copy Markdown

Heramb_Inamke (@HerambInamke) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Needs triage

Development

Successfully merging this pull request may close these issues.

[heft-sass-plugin] Incremental cache file name depends on the machine (absolute build folder, core count)

1 participant