Fix MACOS Zip Import Error when compressing plugin #3629
Merged
Conversation
This file contains 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
Added an edge case test to make sure that the temporary hidden file created by MacOS when compressing a folder is not checked. If this is not there, a zip import error will occur.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Ignored Deployment
|
ntindle
approved these changes
May 1, 2023
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## master #3629 +/- ##
=======================================
Coverage 60.55% 60.55%
=======================================
Files 69 69
Lines 3189 3189
Branches 529 529
=======================================
Hits 1931 1931
Misses 1123 1123
Partials 135 135
☔ View full report in Codecov by Sentry. |
ntindle
approved these changes
May 2, 2023
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.
Background
When a user on MacOS downloads a folder for a plugin, and compresses it via the built in MacOS compress feature, a hidden directory __MACOSX is created inside the zipped file. It will result in this error when trying to import that zipped plugin:
zipimport.ZipImportError: can't find module '__MACOSX/plugin_name'
Changes
This fix adds a check to see if the plugin starts with __MACOSX and if it does, the file is ignored.
Documentation
I did not document my changes, as the change is very minor, and is just testing an edge case.
Test Plan
I tested multiple plugins from the official plugins repo, with and without the fix. Each time, after I zipped a plugin, I got the zip import error when loading the plugin. However, after the fix, no zip import errors occurred.
PR Quality Checklist