fix(appx): ship branded Store tiles instead of electron-builder's placeholders - #294
Merged
Merged
Conversation
…ceholders Store certification rejected 1.9.0 under 10.1.1.11 "On Device Tiles": "The available product tile icons include a default image." electron-builder reads AppX tile assets from `<buildResources>/appx/` and, when that directory is missing, silently maps its own vendored placeholders into the package — SampleAppx.50x50/150x150/44x44/310x150.png from the winCodeSign bundle, which are blank white squares. `win.icon` does not cover this: it feeds the NSIS installer and the executable, not the tiles. So every Store submission so far carried a default image and nothing in the build warned about it. Add build/appx/, generated from the 1024px master icon by the new `npm run assets:appx`. Each of the seven logos ships its 100% file plus .scale-125/150/200 (and .scale-400 on the small ones), and the 44x44 app-list icon also ships .targetsize-* and .targetsize-*_altform-unplated for the taskbar and Start list. The unqualified file of every asset is kept as the neutral MRT candidate so an unresolved qualifier still finds art rather than falling back to nothing. The generator does its own PNG decode/encode on node:zlib — the dependency tree has no image library, and pulling one with native prebuilds in to draw seven static logos is not a trade worth making. Resampling averages in premultiplied alpha so the transparent black outside the icon's rounded corners cannot bleed into the visible edge at small sizes. Assets are committed rather than generated during packaging: a build-time step goes missing exactly when someone packages from a checkout that skipped it, and the failure mode is a silently generic tile, which is the bug being fixed here. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JZV4hzYgcpTfL15wkxyYQz
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe project now generates Microsoft Store AppX/MSIX tile assets from a source PNG. Electron Builder uses ChangesAppX asset generation
Estimated code review effort: 4 (Complex) | ~45 minutes Sequence Diagram(s)sequenceDiagram
participant Developer
participant AssetsScript as assets:appx
participant Generator as generate-appx-assets.mjs
participant Builder as Electron Builder
participant Workflow as Windows build workflow
participant AppxPackage as .appx package
Developer->>AssetsScript: run asset generation
AssetsScript->>Generator: invoke generator
Generator->>Generator: decode, resample, and encode PNG variants
Generator->>Builder: provide assets in build/appx
Builder->>AppxPackage: create .appx package
Workflow->>AppxPackage: compare packaged PNG hashes
AppxPackage-->>Workflow: report missing or differing assets
Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
The tile substitution that failed certification is invisible from the outside: electron-builder maps a placeholder in for any name missing from build/appx/ and says nothing about it, so a renamed or dropped asset would silently reintroduce the exact bug the previous commit fixes — and we would only learn about it from Partner Center, days later, on a submission that has to be redone. Open the built .appx (it is a ZIP) and compare every committed asset against the copy actually inside it, by hash. Missing or substituted, either way the build fails with the asset named. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JZV4hzYgcpTfL15wkxyYQz
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/build.yml:
- Around line 103-117: Replace the `$expected = Get-ChildItem build/appx -Filter
*.png` source in the APPX validation block with an independent authoritative
asset manifest or clean generator output. Validate the complete expected
filename set against `$entries`, report missing or unexpected PNGs, and retain
hash comparisons for every expected asset so deleted source files or
placeholders cannot pass.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: a1a1c0b0-26b3-432a-89a6-8b33d7907ac7
📒 Files selected for processing (1)
.github/workflows/build.yml
…ld/appx The verification read build/appx/ to decide which assets to look for, which makes it blind in the one case it exists for: delete a PNG there and the name drops out of the expected set too, so the loop passes while electron-builder swaps its blank placeholder in under that exact name. An empty directory reported success with zero assets checked. The generator now owns the list — `--list` prints it, derived from ASSETS and TARGET_SIZES with no filesystem involved — and CI compares that list to both the committed directory (missing, or hand-added files) and the package. Refactoring the names out of the write loop also folded the targetsize variants into the same compose() path; at size == canvas with no shift it is the same pixels, and the regenerated assets are byte-identical. Reported by CodeRabbit on #294. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JZV4hzYgcpTfL15wkxyYQz
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Store certification rejected the 1.9.0 submission under 10.1.1.11 "On Device Tiles" — "The available product tile icons include a default image."
electron-builder reads AppX tile assets from
<buildResources>/appx/, i.e.build/appx/. That directory did not exist, soAppXTarget.computeUserAssets()silently mapped its own vendored placeholders into every package:Those four files (extracted from the
winCodeSign-2.6.0bundle to confirm) are blank white squares.win.icondoes not cover this path — it feeds the NSIS installer and the executable, not the tiles — so every Store submission so far carried a default image, with no warning anywhere in the build.This PR adds
build/appx/(41 PNGs, 960 KB) generated from the 1024 px master icon, plus the generator behindnpm run assets:appx.Design notes
SmallTile,LargeTileandSplashScreenare opt-in: their<uap:>manifest attributes only appear when a matching file is present..scale-125/150/200(plus.scale-400on the small assets), and the 44×44 app-list icon also ships.targetsize-*and.targetsize-*_altform-unplatedfor the taskbar and Start list. This switches electron-builder onto itsmakepri.execode path — verified thatmakepri.exeships in the same vendored bundle asmakeappx.exe(windows-10/x64/), so no new tooling requirement.appx.backgroundColoristransparent, so Windows paints the tile in the user's accent colour: tiles are a padded logo on a transparent canvas rather than full-bleed art, and the two tiles carryingshowNameOnTilesshift their logo up to clear the name band.node:zlib. The dependency tree has no image library, and pulling one with native prebuilds in to draw seven static logos is not a trade worth making. Resampling averages in premultiplied alpha, so the transparent black outside the icon's rounded corners cannot bleed into the visible edge at small sizes.directories.buildResourcesis now spelled out inelectron-builder.json5. It was already the default — behaviour is unchanged — but the whole failure hinged on an implicit path, so it is documented rather than assumed.Related issue
None — reported through Partner Center certification feedback, not a tracked issue.
Type of change
Release impact
Desktop impact
Screenshots / video
Before: there is nothing to show — the shipped 150×150 tile was
SampleAppx.150x150.png, a blank white square from electron-builder's vendored bundle. That blankness is what certification flagged.After — the generated tiles (rendered here at their 100 % dimensions; the transparent canvas is what Windows fills with the accent colour):
Square150x150Logo.scale-200Wide310x150Logo.scale-200StoreLogoSquare44x44Logo.scale-200SmallTileSplashScreenTesting
Verified locally:
npm run assets:appx— 41 files, byte-identical across runs (deterministic output, so re-running never produces a spurious diff).winCodeSign-2.6.0.7zand extractingappxAssets/SampleAppx.150x150.png— a blank white square.windows-10/x64/makepri.exeexists in that same bundle, which is what the scaled-asset code path invokes.node scripts/check-docs.mjs— OK (22 files). Biome clean on the changed JS/JSON.Not verified locally: the
.appxitself cannot be built here (Windows-only). A CI run ofbuild.ymlis in flight on this branch to exercise themakepri.exepath for the first time: https://github.com/getopenscreen/openscreen/actions/runs/31124509799 — the Windows Store package job is the one that matters. The resulting.appxis a ZIP, soassets/Square150x150Logo.pnginside it can be checked directly before the next submission.Note for the next Store submission: this correction round still has to be uploaded manually. Automated submission via the msstore CLI requires the app to be published and live in the Store first, which it is not while 1.9.0 sits rejected.
🤖 Generated with Claude Code
https://claude.ai/code/session_01JZV4hzYgcpTfL15wkxyYQz
Summary by CodeRabbit
New Features
Documentation
Build Improvements