-
Notifications
You must be signed in to change notification settings - Fork 4.9k
ci : add github pages workflow for wasm examples #2969
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| name: Examples WASM | ||
| on: | ||
| push: | ||
| branches: ["master"] | ||
|
|
||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
|
|
||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| deploy-wasm-github-pages: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v4 | ||
|
|
||
| - name: Setup emsdk | ||
| uses: mymindstorm/setup-emsdk@v14 | ||
|
|
||
| - name: Build WASM Examples | ||
| # Enable for real build later in whisper.cpp | ||
| run: | | ||
| mkdir -p build-em && cd build-em | ||
| emcmake cmake .. -DCMAKE_BUILD_TYPE=Release | ||
| make -j | ||
|
|
||
| - name: Create staging directory | ||
| run: mkdir -p staging | ||
|
|
||
| - name: Create .nojekyll file in staging directory | ||
| run: touch staging/.nojekyll | ||
|
|
||
| - name: Copy application files | ||
| run: | | ||
| build_dir=build-em/bin | ||
|
|
||
| ls ${build_dir} | ||
|
|
||
| # command.wasm | ||
| target_dir=staging/command.wasm | ||
| mkdir -p ${target_dir} | ||
| cp ${build_dir}/command.wasm/{index.html,command.js,helpers.js} ${target_dir} | ||
| cp ${build_dir}/libcommand.js ${target_dir} | ||
|
|
||
| # bench.wasm | ||
| target_dir=staging/bench.wasm | ||
| mkdir -p ${target_dir} | ||
| cp ${build_dir}/bench.wasm/{index.html,bench.js,helpers.js} ${target_dir} | ||
| cp ${build_dir}/libbench.js ${target_dir} | ||
|
|
||
| # stream.wasm | ||
| target_dir=staging/stream.wasm | ||
| mkdir -p ${target_dir} | ||
| cp ${build_dir}/stream.wasm/{index.html,stream.js,helpers.js} ${target_dir} | ||
| cp ${build_dir}/libstream.js ${target_dir} | ||
|
|
||
| # whisper.wasm (this will be the main example page) | ||
| target_dir=staging | ||
| mkdir -p ${target_dir} | ||
| cp ${build_dir}/whisper.wasm/{index.html,main.js,helpers.js} ${target_dir} | ||
| cp ${build_dir}/libmain.js ${target_dir} | ||
|
|
||
| # Copy Cross-Origin Isolation service worker | ||
| cp -v examples/whisper.wasm/coi-serviceworker.js staging/ | ||
|
|
||
| - name: List files in staging directory (for debugging) | ||
| run: | | ||
| echo "Files in staging directory:" | ||
| find staging -type f | sort | ||
|
|
||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: ./staging | ||
|
|
||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 |
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| /*! coi-serviceworker v0.1.7 - Guido Zuidhof and contributors, licensed under MIT */ | ||
| let coepCredentialless = false; | ||
| if (typeof window === 'undefined') { | ||
| self.addEventListener("install", () => self.skipWaiting()); | ||
| self.addEventListener("activate", (event) => event.waitUntil(self.clients.claim())); | ||
|
|
||
| self.addEventListener("message", (ev) => { | ||
| if (!ev.data) { | ||
| return; | ||
| } else if (ev.data.type === "deregister") { | ||
| self.registration | ||
| .unregister() | ||
| .then(() => { | ||
| return self.clients.matchAll(); | ||
| }) | ||
| .then(clients => { | ||
| clients.forEach((client) => client.navigate(client.url)); | ||
| }); | ||
| } else if (ev.data.type === "coepCredentialless") { | ||
| coepCredentialless = ev.data.value; | ||
| } | ||
| }); | ||
|
|
||
| self.addEventListener("fetch", function (event) { | ||
| const r = event.request; | ||
| if (r.cache === "only-if-cached" && r.mode !== "same-origin") { | ||
| return; | ||
| } | ||
|
|
||
| const request = (coepCredentialless && r.mode === "no-cors") | ||
| ? new Request(r, { | ||
| credentials: "omit", | ||
| }) | ||
| : r; | ||
| event.respondWith( | ||
| fetch(request) | ||
| .then((response) => { | ||
| if (response.status === 0) { | ||
| return response; | ||
| } | ||
|
|
||
| const newHeaders = new Headers(response.headers); | ||
| newHeaders.set("Cross-Origin-Embedder-Policy", | ||
| coepCredentialless ? "credentialless" : "require-corp" | ||
| ); | ||
| if (!coepCredentialless) { | ||
| newHeaders.set("Cross-Origin-Resource-Policy", "cross-origin"); | ||
| } | ||
| newHeaders.set("Cross-Origin-Opener-Policy", "same-origin"); | ||
|
|
||
| return new Response(response.body, { | ||
| status: response.status, | ||
| statusText: response.statusText, | ||
| headers: newHeaders, | ||
| }); | ||
| }) | ||
| .catch((e) => console.error(e)) | ||
| ); | ||
| }); | ||
|
|
||
| } else { | ||
| (() => { | ||
| const reloadedBySelf = window.sessionStorage.getItem("coiReloadedBySelf"); | ||
| window.sessionStorage.removeItem("coiReloadedBySelf"); | ||
| const coepDegrading = (reloadedBySelf == "coepdegrade"); | ||
|
|
||
| // You can customize the behavior of this script through a global `coi` variable. | ||
| const coi = { | ||
| shouldRegister: () => !reloadedBySelf, | ||
| shouldDeregister: () => false, | ||
| coepCredentialless: () => true, | ||
| coepDegrade: () => true, | ||
| doReload: () => window.location.reload(), | ||
| quiet: false, | ||
| ...window.coi | ||
| }; | ||
|
|
||
| const n = navigator; | ||
| const controlling = n.serviceWorker && n.serviceWorker.controller; | ||
|
|
||
| // Record the failure if the page is served by serviceWorker. | ||
| if (controlling && !window.crossOriginIsolated) { | ||
| window.sessionStorage.setItem("coiCoepHasFailed", "true"); | ||
| } | ||
| const coepHasFailed = window.sessionStorage.getItem("coiCoepHasFailed"); | ||
|
|
||
| if (controlling) { | ||
| // Reload only on the first failure. | ||
| const reloadToDegrade = coi.coepDegrade() && !( | ||
| coepDegrading || window.crossOriginIsolated | ||
| ); | ||
| n.serviceWorker.controller.postMessage({ | ||
| type: "coepCredentialless", | ||
| value: (reloadToDegrade || coepHasFailed && coi.coepDegrade()) | ||
| ? false | ||
| : coi.coepCredentialless(), | ||
| }); | ||
| if (reloadToDegrade) { | ||
| !coi.quiet && console.log("Reloading page to degrade COEP."); | ||
| window.sessionStorage.setItem("coiReloadedBySelf", "coepdegrade"); | ||
| coi.doReload("coepdegrade"); | ||
| } | ||
|
|
||
| if (coi.shouldDeregister()) { | ||
| n.serviceWorker.controller.postMessage({ type: "deregister" }); | ||
| } | ||
| } | ||
|
|
||
| // If we're already coi: do nothing. Perhaps it's due to this script doing its job, or COOP/COEP are | ||
| // already set from the origin server. Also if the browser has no notion of crossOriginIsolated, just give up here. | ||
| if (window.crossOriginIsolated !== false || !coi.shouldRegister()) return; | ||
|
|
||
| if (!window.isSecureContext) { | ||
| !coi.quiet && console.log("COOP/COEP Service Worker not registered, a secure context is required."); | ||
| return; | ||
| } | ||
|
|
||
| // In some environments (e.g. Firefox private mode) this won't be available | ||
| if (!n.serviceWorker) { | ||
| !coi.quiet && console.error("COOP/COEP Service Worker not registered, perhaps due to private mode."); | ||
| return; | ||
| } | ||
|
|
||
| n.serviceWorker.register(window.document.currentScript.src).then( | ||
| (registration) => { | ||
| !coi.quiet && console.log("COOP/COEP Service Worker registered", registration.scope); | ||
|
|
||
| registration.addEventListener("updatefound", () => { | ||
| !coi.quiet && console.log("Reloading page to make use of updated COOP/COEP Service Worker."); | ||
| window.sessionStorage.setItem("coiReloadedBySelf", "updatefound"); | ||
| coi.doReload(); | ||
| }); | ||
|
|
||
| // If the registration is active, but it's not controlling the page | ||
| if (registration.active && !n.serviceWorker.controller) { | ||
| !coi.quiet && console.log("Reloading page to make use of COOP/COEP Service Worker."); | ||
| window.sessionStorage.setItem("coiReloadedBySelf", "notcontrolling"); | ||
| coi.doReload(); | ||
| } | ||
| }, | ||
| (err) => { | ||
| !coi.quiet && console.error("COOP/COEP Service Worker failed to register:", err); | ||
| } | ||
| ); | ||
| })(); | ||
| } |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.