Repository navigation
add JOSS paper, experiment infrastructure, and QUIC enhancements #53
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
Closed
Closed
Changes from all commits
Commits
Show all changes
34 commits
Select commit
Hold shift + click to select a range
ff07262
fix experiment methodology and add payload format scripts
fabracht 0d7904c
use configurable port and repo binary in localhost experiment
fabracht adfa757
fix HOL blocking investigation: deprecate per-subscription, add broke…
fabracht 92167a0
add HOL blocking trace instrumentation and analysis
fabracht ce61d33
add WebSocket bridge support to WASM broker
fabracht ae87bf3
add publication prep: QoS fix, analysis scripts, experiment scripts 0…
fabracht 0359c4c
add 02d/02e experiment results and diary entries
fabracht a91d563
add interventional PublishAction to on_client_publish event handler
fabracht bf8b885
add per-client outbound delivery rate limiting
fabracht 96daa37
add fig08-11, bootstrap CI, Cliff's delta, exp01/exp03 parsers
fabracht 5458eb0
fix queue filename collision and stale subscription leak
fabracht 8779611
add exp 05/06 results, RTT sweep for datagram vs stream
fabracht f9d1433
ignore generated figure output and result analysis files
fabracht f479085
add experiment scripts, HOL analysis, ACL README, QUIC spec
fabracht 1a672d2
document per-subscription deprecation architectural rationale
fabracht 98489e6
use unidirectional QUIC streams for data paths
fabracht 583b8a7
add parallel experiment infrastructure for split pub/sub on n2 VMs
fabracht f7a851c
gitignore paper/ directory
fabracht c767acb
add exp 04-06 figure scripts, stats parsers, and updated config
fabracht cb956f6
write parallel experiment results to results_v2/
fabracht d271161
fill group env IPs, add ProxyJump support for sub-3
fabracht 183e0e8
add experiment scripts, HOL analysis, ACL README, QUIC spec
fabracht 543c248
fix v3 experiment script to skip unused sub VM monitoring
fabracht 97ca83b
update figure scripts and stats to use v3 HOL blocking metrics
fabracht 3f2e731
add JOSS paper, references, and code of conduct
fabracht f602018
add LaTeX paper with verified references and experiment figures
fabracht e48983e
move JOSS paper from paper/ to joss/
fabracht 361c0a2
bump crate versions for release
fabracht 7de47b8
deprecate per-subscription stream strategy in CLI and tests
fabracht 30d9895
remove per-subscription from docs
fabracht 57ae3b4
fix PR review issues: semver, lock scope, persistence, config path
fabracht 1cf65bd
allow result_large_err on websocket callback (type dictated by tungst…
fabracht eb0bc0a
re-inject identity properties on PublishAction::Transform, clean up s…
fabracht 210cb9c
rewrite JOSS paper for flow, add draft PDF workflow
fabracht 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,24 @@ | ||
| name: Draft JOSS Paper | ||
| on: | ||
| push: | ||
| paths: | ||
| - joss/** | ||
| - .github/workflows/joss.yml | ||
|
|
||
| jobs: | ||
| paper: | ||
| runs-on: ubuntu-latest | ||
| name: Paper Draft | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Build draft PDF | ||
| uses: openjournals/openjournals-draft-action@master | ||
| with: | ||
| journal: joss | ||
| paper-path: joss/paper.md | ||
| - name: Upload | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: paper | ||
| path: joss/paper.pdf | ||
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,85 @@ | ||
|
|
||
| # Contributor Covenant Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. | ||
|
|
||
| We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. | ||
|
|
||
| ## Our Standards | ||
|
|
||
| Examples of behavior that contributes to a positive environment for our community include: | ||
|
|
||
| * Demonstrating empathy and kindness toward other people | ||
| * Being respectful of differing opinions, viewpoints, and experiences | ||
| * Giving and gracefully accepting constructive feedback | ||
| * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience | ||
| * Focusing on what is best not just for us as individuals, but for the overall community | ||
|
|
||
| Examples of unacceptable behavior include: | ||
|
|
||
| * The use of sexualized language or imagery, and sexual attention or advances of any kind | ||
| * Trolling, insulting or derogatory comments, and personal or political attacks | ||
| * Public or private harassment | ||
| * Publishing others' private information, such as a physical or email address, without their explicit permission | ||
| * Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
|
||
| ## Enforcement Responsibilities | ||
|
|
||
| Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. | ||
|
|
||
| Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. | ||
|
|
||
| ## Scope | ||
|
|
||
| This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at fabricio@bracht.dev. All complaints will be reviewed and investigated promptly and fairly. | ||
|
|
||
| All community leaders are obligated to respect the privacy and security of the reporter of any incident. | ||
|
|
||
| ## Enforcement Guidelines | ||
|
|
||
| Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: | ||
|
|
||
| ### 1. Correction | ||
|
|
||
| **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. | ||
|
|
||
| **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. | ||
|
|
||
| ### 2. Warning | ||
|
|
||
| **Community Impact**: A violation through a single incident or series of actions. | ||
|
|
||
| **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. | ||
|
|
||
| ### 3. Temporary Ban | ||
|
|
||
| **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. | ||
|
|
||
| **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. | ||
|
|
||
| ### 4. Permanent Ban | ||
|
|
||
| **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. | ||
|
|
||
| **Consequence**: A permanent ban from any sort of public interaction within the community. | ||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. | ||
|
|
||
| Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. | ||
|
|
||
| For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations]. | ||
|
|
||
| [homepage]: https://www.contributor-covenant.org | ||
| [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html | ||
| [Mozilla CoC]: https://github.com/mozilla/diversity | ||
| [FAQ]: https://www.contributor-covenant.org/faq | ||
| [translations]: https://www.contributor-covenant.org/translations | ||
|
|
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
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,44 @@ | ||
| # ACL Permission Demo | ||
|
|
||
| This example demonstrates **Access Control Lists (ACL)** with role-based access control (RBAC). Users are assigned roles that define read/write permissions on topic patterns, and the broker enforces these rules on every PUBLISH and SUBSCRIBE. | ||
|
|
||
| ## Running the Example | ||
|
|
||
| 1. Build the WASM package: | ||
| ```bash | ||
| cd crates/mqtt5-wasm | ||
| wasm-bindgen ../target/wasm32-unknown-unknown/release/mqtt5_wasm.wasm --out-dir examples/acl-permissions/pkg --target web | ||
| ``` | ||
|
|
||
| 2. Serve the example: | ||
| ```bash | ||
| cd examples/acl-permissions | ||
| python3 -m http.server 8080 | ||
| ``` | ||
|
|
||
| 3. Open http://localhost:8080 in your browser | ||
|
|
||
| ## How the Demo Works | ||
|
|
||
| - Four users are pre-configured with distinct roles and permissions | ||
| - Select a user to connect as that identity | ||
| - Test subscribe and publish operations against various topics | ||
| - Operations are checked against the ACL rules and shown as ALLOWED or DENIED | ||
| - A permission matrix shows all topic/operation combinations for the selected user | ||
|
|
||
| ## Users and Roles | ||
|
|
||
| | User | Role | Topic Pattern | Permission | | ||
| |------|------|---------------|------------| | ||
| | Alice | admin | `#` | read/write | | ||
| | Bob | publisher | `data/#` | write | | ||
| | Carol | subscriber | `data/#` | read | | ||
| | Dave | guest | `public/#` | read | | ||
|
|
||
| ## Try It | ||
|
|
||
| 1. Start as Alice (admin) — all operations succeed on any topic | ||
| 2. Switch to Bob (publisher) — can publish to `data/sensors` but cannot subscribe | ||
| 3. Switch to Carol (subscriber) — can subscribe to `data/sensors` but cannot publish | ||
| 4. Switch to Dave (guest) — limited to reading `public/#` topics only | ||
| 5. Try operations on topics outside each user's allowed patterns to see denials |
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.
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Copilot Autofix
AI 7 months ago
In general, the fix is to add an explicit
permissionsblock to the workflow or the specific job, granting only the minimal scopes required. For this workflow, the actions used (actions/checkout,openjournals/openjournals-draft-action, andactions/upload-artifact) only need read access to repository contents; they do not need to write to the repository or modify issues, PRs, etc. Therefore, the safest and simplest change is to addpermissions: contents: readat the job level forpaper.Concretely, in
.github/workflows/joss.yml, underjobs: paper:and aligned withruns-on/name, add:This will restrict the
GITHUB_TOKENused in that job to read-only repository contents, without altering the workflow’s behavior. No additional methods, imports, or other definitions are needed because this is purely a YAML configuration change.