* First pass at chat user registration and validation
* Disable chat if the user is disabled/blocked or the server hits max connections
* Handle dropping sockets if chat is disabled
* Fix origin in automated chat test
* Work for updated chat moderation
* Chat message markdown rendering and fix tests
* Put /api/chat behind a chat user access token. Closes#1085
* Reject blocked username changes
* More WIP moderation
* Defer configuring chat until we know if it is enabled. Closes#1135
* chat user blocking. Closes#1096
* Add tests around user access for #1096
* Add external integration chat message API + update integration auth middleware to pass along integration name. Closes#1092
* Delete old chat messages from db as to not hold on to excessive data. Closes#1152
* Add schema migration for messages. Closes#1155
* Commit updated API documentation
* Add chat load test
* Shared db mutex and db optimizations
* Simplify past display name handling
* Use a new test db for each test run
* Wire up the external messages actions + add tests for them
* Move access tokens to be actual users
* Run message pruning at launch + fix comparison
* Do not return API users in disabled users response
* Fix incorrect highlighting. Closes#1160
* Consolidate user table statements
* Set the max process connection limit to 70% of maximum
* Fix wrong old display name being returned in name change event
* Delete the old chat server files
* Wire back up the webhooks
* Remove unused
* Invalidate user cache on changes
* Do not send rendered body as RawBody
* Some cleanup
* Standardize names for external API users to ExternalAPIUser
* Do not log token
* Checkout branch when building admin for testing
* Bundle in dev admin for testing
* Some cleanup
* Cleanup js logs
* Cleanup and standardize event names
* Clean up some logging
* Update API spec. Closes#1133
* Commit updated API documentation
* Change paths to be better named
* Commit updated API documentation
* Update admin bundle
* Fix duplicate event name
* Rename scope var
* Update admin bundle
* Move connected clients controller into admin package
* Fix collecting usernames for autocomplete purposes
* No longer generate username when it is empty
* Sort clients and users by timestamp
* Move file to admin controller package
* Swap, so the comments stay correct
Co-authored-by: Jannik <jannik@outlook.com>
* Use explicit type alias
Co-authored-by: Jannik <jannik@outlook.com>
* Remove commented code.
Co-authored-by: Jannik <jannik@outlook.com>
* Cleanup test
* Remove some extra logging
* Add some clarity
* Update dev instance of admin for testing
* Consolidate lines
Co-authored-by: Jannik <jannik@outlook.com>
* Remove commented unused vars
Co-authored-by: Jannik <jannik@outlook.com>
* Until needed do not return IP address with client list
* Fix typo of wrong var
* Typo led to a bad test. Fix typo and fix test.
* Guard against the socket reconnecting on error if previously set to shutdown
* Do not log access tokens
* Return success message on enable/disable user
* Clean up some inactionable error messages. Sent ban message. Sort banned users.
* fix styling for when chat is completely disabled
* Unused
* guard against nil clients
* Update dev admin bundle
* Do not unhide messages when unblocking user just to be safe. Send removal action from the controller
* Add convinience function for getting active connections for a single user
* Lock db on these mutations
* Cleanup force disconnect using GetClientsForUser and capture client reference explicitly
* No longer re-showing banned user messages for safety. Removing this test.
* Remove no longer needed comment
* Tweaks to forbidden username handling.
- Standardize naming to not use "block" but "forbidden" instead.
- Pass array over the wire instead of string.
- Add API test
- Fix default list incorrectly being appended to custom list.
* Logging cleanup
* Update dev admin bundle
* Add an artificial delay in order to visually see message being hidden when testing
* Remove the user cache as it is a premature optimization
* When connected to chat let the user know their current user details to sync the username in the UI
* On connected send current display name back to client.
- Move name change out of chat component.
- Add additional event type constants.
* Fix broken workflow due to typo
* Troubleshoot workflow
* Bump htm from 3.0.4 to 3.1.0 in /build/javascript (#1181)
* Bump htm from 3.0.4 to 3.1.0 in /build/javascript
Bumps [htm](https://github.com/developit/htm) from 3.0.4 to 3.1.0.
- [Release notes](https://github.com/developit/htm/releases)
- [Commits](https://github.com/developit/htm/compare/3.0.4...3.1.0)
---
updated-dependencies:
- dependency-name: htm
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
* Run npm run build and update libraries
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Gabe Kangas <gabek@real-ity.com>
* Commit updated Javascript packages
* Re-send current user info when a rejected name change takes place
* All socket writes should be through the send chan and not directly
* Seed the random generator
* Add keys and indexes to users table
* a util to generate consistent emoji markup
* console clean up
* mod tidy
* Commit updated API documentation
* Handle the max payload size of a socket message.
- Only close socket if x2 greater than the max size.
- Send the user a message if a message is too large.
- Surface the max size in bytes in the config.
* Update admin bundle
* Force all events to be sent in their own socket message and do not concatinate in a single message
* Update chat embed to register for access token
* Use a different access token for embed chat
* Update the chat message bubble background color to be bolder
* add base tag to open links in new window, closes#1220
* Support text input of :emoji: in chat (#1190)
* Initial implementation of emoji injection
* fix bookkeeping with multiple emoji
* make the emoji lookup case-insensitive
* try another solution for Caretposition
* add title to emojis
minor refactoring
* bind moji injection to InputKeyUp
* simplify the code
replace all found emojis
* inject emoji if the modifer is released earlier
* more efficient emoji tag search
* use json emoji.emoji as url
* use createEmojiMarkup()
* move emojify() to chat.js
* emojify on paste
* cleanup emoji titles in paste
* update inputText in InputKeyup
* mark emoji titles with 2*zwnj
this way paste cleanup will not interfere with text which include zwnj
* emoji should not change the inputText
* Do not show join messages when chat is offline. Closes#1224
- Show stream starting/ending messages in chat.
- When stream starts show everyone the welcome message.
* Force scrolling chat to bottom after history is populated regardless of scroll position. Closes https://github.com/owncast/owncast/issues/1222
* use maxSocketPayloadSize to calculate total bytes of message payload (#1221)
* utilize maxSocketPayloadSize from config; update chatInput to calculate based on that value instead of text value; remove usage of inputText for counting
* add a buffer to account for entire websocket payload for message char counting; trim nbsp;'s from ends of messages when calculating count
Co-authored-by: Gabe Kangas <gabek@real-ity.com>
Co-authored-by: Owncast <owncast@owncast.online>
Co-authored-by: Jannik <jannik@outlook.com>
Co-authored-by: Ginger Wong <omqmail@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Meisam <39205857+MFTabriz@users.noreply.github.com>
- Also, disable global CSS transition animations for now. If we want to add transitions onto anything, we can target specific elements and add styles individually intead.
* added f and m keys
* added more keys and volume control
* added p for play and c for chatview toggle
* remove vscode auto format
* changed e.target check to not trigger kb-controls if input is in focus
* fixed the default mute problem
* Commit updated API documentation
* merged keydown and keypressed methods
Co-authored-by: Owncast <owncast@owncast.online>
* WIP External actions modal frontend
* Add external action links
* Allow modal to show/hide and use a dynamic url
* Use external link object instead of just url for state
* add style and placement to external action buttons
* reformat and simplify tag list style as not to conflict with action buttons and make them look less actionable since they're not
* fix bug to open modal
* have Esc key close modal
* fix style on modal
* make modal bg darker
* close modal when you click outside of it
* fix zindex
* Add support for external action icons and colors
* Some external action modal sizing + loading spinner
Co-authored-by: Ginger Wong <omqmail@gmail.com>
* WIP video quality selector
* The quality selector works even though it is not pretty
* Support getting and setting variant name. Closes#743
* Sort video qualities
* Fix odd looking selected states of menubutton items
* Fix comment
* Implement webhook events for external integrations (#574)
* Implement webhook events for external integrations
Reference #556
* move message type to models and remove duplicate
* add json header so content type can be determined
* Pass at migrating webhooks to datastore + management apis (#589)
* Pass at migrating webhooks to datastore + management apis
* Support nil lastUsed timestamps and return back the new webhook on create
* Cleanup from review feedback
* Simplify a bit
Co-authored-by: Aaron Ogle <aaron@geekgonecrazy.com>
Co-authored-by: Gabe Kangas <gabek@real-ity.com>
* Webhook query cleanup
* Access tokens + Send system message external API (#585)
* New add, get and delete access token APIs
* Create auth token middleware
* Update last_used timestamp when using an access token
* Add auth'ed endpoint for sending system messages
* Cleanup
* Update api spec for new apis
* Commit updated API documentation
* Add auth'ed endpoint for sending user chat messages
* Return access token string
* Commit updated API documentation
* Fix route
* Support nil lastUsed time
* Commit updated Javascript packages
* Remove duplicate function post rebase
* Fix msg id generation
* Update controllers/admin/chat.go
Co-authored-by: Aaron Ogle <geekgonecrazy@users.noreply.github.com>
* Webhook query cleanup
* Add SystemMessageSent to EventType
Co-authored-by: Owncast <owncast@owncast.online>
Co-authored-by: Aaron Ogle <geekgonecrazy@users.noreply.github.com>
* Set webhook as used on completion. Closes#610
* Display webhook errors as errors
* Commit updated API documentation
* Add user joined chat event
* Change integration API paths. Update API spec
* Update development version of admin that supports integration apis
* Commit updated API documentation
* Add automated tests for external integration APIs
* check error
* quiet this test for now
* Route up some additional 3rd party apis. #638
* Commit updated API documentation
* Save username on user joined event
* Add missing scope to valid scopes list
* Add generic chat action event API for 3rd parties. Closes#666
* Commit updated API documentation
* First pass at moving WIP config framework into project for #234
* Only support exported fields in custom types
* Using YP get/set key as a first pass at using the data layer. Fixes + integration.
* Ignore test db
* Start adding getters and setters for config values
* More get/set config work. Starting to populate api with data
* Wire up some config edit endpoints
* More endpoints
* Disable cors middleware
* Add more endpoints and add test to test them
* Remove the in-memory change APIs
* Add endpoint for changing tags
* Add more config endpoints
* Starting to point more things away from config file and to the datastore
* Populate YP with db data
* Create new util method for parsing page body markdown and return it in api
* Verify proposed path to ffmpeg
* For development purposes show the config key in logs
* Move stats values to datastore
* Moving over more values to the datastore
* Move S3 config to datastore
* First pass the config -> db migrator
* Add the start of the video config apis
* It builds pointing everything away from the config
* Tweak ffmpeg path error message
* Backup database every hour. Closes#549
* Config + defaults + migration work for db
* Cleanup logging
* Remove all the old config structs
* Add descriptive info about migration
* Tweak ffmpeg validation logic
* Fix db backup path. backup on db version migration
* Set video and s3 configurations
* Update api spec with new config endpoints
* Add migrator for stats file
* Commit updated API documentation
* Use a dynamic system port for internal HLS writes. Closes#577 (#626)
* Use a dynamic system port for internal HLS writes. Closes#577
* Cleanup
* YP key migration to datastore
* Create a backup directory if needed before migrations
* Remove config test that no longer makes sense. Cleanup.
* Change number types from float32 to float64
* Update automated test suite
* Allow restoring a database backup via command line flags. Closes#549
* Add new hls segment config api
* Commit updated API documentation
* Update apis to require a value container property
* add socialHandles api
* Commit updated API documentation
* Add new latancy level setting to replace segment settings
* Commit updated API documentation
* Fix spelling
* Commit updated API documentation
* hardcode a json api of available social platforms
* Add additional icons
* Return social handles in server config api
* Add socialhandles validation to test
* Move list of hard coded social platforms to an api
* Remove audio only code from transcoder since we do not use it
* Add latency levels api + snapshot of video settings as current broadcast
* Add config/serverurl endpoint
* Return 404 on YP api if disabled
* Surface stream title in YP response
* Add stream title to web ui
* Cleanup log message. Closes#520
* Rename ffmpeg package to transcoder
* Add ws package for testing
* Reduce chat backlog to past 5hrs, max 50. Closes#548
* Fix error formatting
* Add endpoint for resetting yp registration
* Add yp/reset to api spec. return status in response
* Return zero viewer count if stream is offline. Closes#422
* Post-rebase fixes
* Fix merge conflict in openapi file
* Commit updated API documentation
* Standardize controller names
* Support setting the stream key via the command line. Closes#665
* Return social handles with YP data. First half of https://github.com/owncast/owncast-yp/issues/28
* Give the YP package access to server status regardless if enabled or not
* Change delay in automated tests
* Add stream title integration API. For #638
* Commit updated API documentation
* Add storage to the migrator
* Missing returning NSFW value in server config
* Add flag to ignore websocket client. Closes#537
* Add error for parsing broadcaster metadata
* Add support for a cli specified http server port. Closes#674
* Add cpu usage levels and a temporary mapping between it and libx264 presets
* Test for valid url endpoint when saving s3 config
* Re-configure storage on every stream to allow changing storage providers
* After 5 minutes of a stream being stopped clear the stream title
* Hide viewer count once stream goes offline instead of when player stops
* Pull steamTitle from the status that gets updated instead of the config
* Commit updated API documentation
* Optionally show stream title in the header
* Reset stream title when server starts
* Show chat action when stream title is updated
* Allow system messages to come back in persistence
* Split out getting chat history for moderation + fix tests
* Remove server title and standardize on name only
* Commit updated API documentation
* Bump github.com/aws/aws-sdk-go from 1.37.1 to 1.37.2 (#680)
Bumps [github.com/aws/aws-sdk-go](https://github.com/aws/aws-sdk-go) from 1.37.1 to 1.37.2.
- [Release notes](https://github.com/aws/aws-sdk-go/releases)
- [Changelog](https://github.com/aws/aws-sdk-go/blob/master/CHANGELOG.md)
- [Commits](https://github.com/aws/aws-sdk-go/compare/v1.37.1...v1.37.2)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Add video variant and stream latency config file migrator
* Remove mostly unused disable upgrade check bool
* Commit updated API documentation
* Allow bundling the admin from the 0.0.6 branch
* Fix saving port numbers
* Use name instead of old title on window focus
* Work on latency levels. Fix test to use levels. Clean up transcoder to only reference levels
* Another place where title -> name
* Fix test
* Bump github.com/aws/aws-sdk-go from 1.37.2 to 1.37.3 (#690)
Bumps [github.com/aws/aws-sdk-go](https://github.com/aws/aws-sdk-go) from 1.37.2 to 1.37.3.
- [Release notes](https://github.com/aws/aws-sdk-go/releases)
- [Changelog](https://github.com/aws/aws-sdk-go/blob/master/CHANGELOG.md)
- [Commits](https://github.com/aws/aws-sdk-go/compare/v1.37.2...v1.37.3)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Update dependabot config
* Bump github.com/aws/aws-sdk-go from 1.37.3 to 1.37.5 (#693)
Bumps [github.com/aws/aws-sdk-go](https://github.com/aws/aws-sdk-go) from 1.37.3 to 1.37.5.
- [Release notes](https://github.com/aws/aws-sdk-go/releases)
- [Changelog](https://github.com/aws/aws-sdk-go/blob/master/CHANGELOG.md)
- [Commits](https://github.com/aws/aws-sdk-go/compare/v1.37.3...v1.37.5)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Bump video.js from 7.10.2 to 7.11.4 in /build/javascript (#694)
* Bump video.js from 7.10.2 to 7.11.4 in /build/javascript
Bumps [video.js](https://github.com/videojs/video.js) from 7.10.2 to 7.11.4.
- [Release notes](https://github.com/videojs/video.js/releases)
- [Changelog](https://github.com/videojs/video.js/blob/main/CHANGELOG.md)
- [Commits](https://github.com/videojs/video.js/compare/v7.10.2...v7.11.4)
Signed-off-by: dependabot[bot] <support@github.com>
* Commit updated Javascript packages
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Owncast <owncast@owncast.online>
* Make the latency migrator dynamic so I can tweak values easier
* Split out fetching ffmpeg path from validating the path so it can be changed in the admin
* Some commenting and linter cleanup
* Validate the path for a logo change and throw an error if it does not exist
* Logo change requests have to be a real file now
* Cleanup, making linter happy
* Format javascript on push
* Only format js in master
* Tweak latency level values
* Remove unused config file examples
* Fix thumbnail generation after messing with the ffmpeg path getter
* Reduce how often we report high hardware utilization warnings
* Bundle the 0.0.6 branch version of the admin
* Return validated ffmpeg path in admin server config
* Change the logo to be stored in the data directory instead of webroot
* Bump postcss from 8.2.4 to 8.2.5 in /build/javascript (#702)
Bumps [postcss](https://github.com/postcss/postcss) from 8.2.4 to 8.2.5.
- [Release notes](https://github.com/postcss/postcss/releases)
- [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
- [Commits](https://github.com/postcss/postcss/compare/8.2.4...8.2.5)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Default config file no longer used
* don't show stream title when offline
addresses https://github.com/owncast/owncast/issues/677
* Remove auto-clearing stream title. #677
* webroot -> data when using logo as thumbnail
* Do not list websocket/access token create/delete as integration APIs
* Commit updated API documentation
* Bundle updated admin
* Remove pointing to the 0.0.6 admin branch
* Linter cleanup
* Linter cleanup
* Add donations and follow links to show up under social handles
* Prettified Code!
* More linter cleanup
* Update admin bundle
* Remove use of platforms.js and return icons with social handles. Closes#732
* Update admin bundle
* Support custom config path for use in migration
* Remove unused platform-logos.gif
* Reduce log level of message
* Remove unused logo files in static dir
* Handle dev vs. release build info
* Restore logo.png for initial thumbnail
* Cleanup some files from the build process that are not needed
* Fix incorrect build-time injection var
* Fix missing file getting copied to the build
* Remove console directory message.
* Update admin bundle
* Fix comment
* Report storage setup error
* add some value set error checking
* Use validated dynamic ffmpeg path for animated gif preview
* Make chat message links be white so they don't hide in the bg. Closes#599
* Restore conditional that was accidentally removed
Co-authored-by: Aaron Ogle <geekgonecrazy@users.noreply.github.com>
Co-authored-by: Owncast <owncast@owncast.online>
Co-authored-by: Ginger Wong <omqmail@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: nebunez <uoj2y7wak869@opayq.net>
Co-authored-by: gabek <gabek@users.noreply.github.com>
* make spacebar control the play state
* improved keyboard handling
* only allow pause and play when stream is online
* some formatting fixes
* remove event listener on destruction
* #515 switched to SVG icons, #525 added Ko-Fi platform
* fixes#515, fixes#525 - added color to the SVGs directly
* Removed `color` from config for socialHandles, not required anymore
* update message viz in db
* create admin endpoint to update message visibility
* convert UpdateMessageVisibility api to take in an array of IDs to change visibility on instead
* Support requesting filtered or unfiltered chat messages
* Handle UPDATE chat events on front and backend for toggling messages
* Return entire message with UPDATE events
* Remove the UPDATE message type
* Revert "Remove the UPDATE message type"
This reverts commit 3a83df3d492f7ecf2bab65e845aa2b0365d3a7f6.
* update -> visibility update
* completely remove messages when they turn hidden on VISIBILITY-UPDATEs, and insert them if they turn visible
* Explicitly set visibility
* Fix multi-id sql updates
* increate scroll buffer a bit so chat scrolls when new large messages come in
* Add automated test around chat moderation
* Add new chat admin APIs to api spec
* Commit updated API documentation
Co-authored-by: Gabe Kangas <gabek@real-ity.com>
Co-authored-by: Owncast <owncast@owncast.online>
* rename social-icons to prevent adblockers from blocking scripts, fix for #491
* hide viewer count when stream is off, fixes#428
* show a notice in document title of num messages if window is blurred, #426
* display indicator when stream has gone onlnie or offline when window is blurred
* - format messages on didMount instead of didUpdate. will also prevent bad setSTate loops when message is blank;
- convert message.js to functional comp
- prevent extra rerenders in messages and chat with shouldComponentUpdate checks
* revert chat test
* more concise returns;
* Simplify Logo requirement from users.
- Only require 1 logo file, instead of a `small` and `large` one. Just require `logo`.
- Update frontend sso that primary header logo will ALWAYS be owncast logo.
- User's logo will remain in "user content" area.
* Commit updated API documentation
Co-authored-by: Owncast <owncast@owncast.online>
* Custom thumbnail poster component
* add opacity transition to thumbnail img
* fix some videoonly styles
* move video styles to video.css
* make component out of image layers; put inline styles into css
* cleanup
* update videoonly ; don't render poster if video player, remove dom modification in player
* revert interval
Co-authored-by: Ginger Wong <omqmail@gmail.com>
* WIP with new transcoder progress monitor
* A whole different WIP in progress monitoring via local PUTs
* Use an actual hls playlist parser to rewrite master playlist
* Cleanup
* Private vs public path for thumbnail generation
* Allow each storage provider to make decisions of how to store different types of files
* Simplify inbound file writes
* Revert
* Split out set stream as connected/disconnected state methods
* Update videojs
* Add comment about the hls handler
* Rework of the offline stream state. For #85
* Delete old unreferenced video segment files from disk
* Cleanup all segments and revert to a completely offline state after 5min
* Stop thumbnail generation on stream stop. Copy logo to thumbnail on cleanup.
* Update transcoder test
* Add comment
* Return http 200 on success to transcoder. Tweak how files are written to disk
* Force pixel color format in transcoder
* Add debugging info for S3 transfers. Add default ACL.
* Fix cleanup timer
* Reset session stats when we cleanup the session.
* Put log file back
* Update test
* File should not be a part of this commit
* Add centralized shared performance timer for use anywhere
* Post-rebase cleanup
* Support returning nil from storage provider save
* Updates to reflect package changes + other updates in master
* Fix storage providers being overwritten
* Do not return pointer in save. Support cache headers with S3 providers
* Split out videojs + vhs and point to specific working versions of them
* Bump vjs and vhs versions
* Fix test
* Remove unused
* Update upload warning message
* No longer valid comment
* Pin videojs and vhs versions
* Render and sanitize chat messages server-side. Closes#235
* Render content.md server-side and return it in the client config
* Remove showdown from web project
* Update api spec
* Move example user content file
* Experiment with javascript bundling
* Experiment with snowpack. Making progress
* Success! Uses local js modules and assets and no cdns
* Missing local css
* only consider short-heights when not smallscreen; hide status bar when small screen, but leave shadow;
* fix max char counting bugs with paste, yet be still be able to use modifier keys even when max chars reached
* rmeove 'chat' button; move into textarea
* use image for emoji picker for sizing consitency
* cleanup unused things
* - totally unecessary emoji picker style improvements
- totally necessary doctype added to emoji picker so it shows up more stable-y on mobile views
* more stable layout positioning for chat panel without hacky margins, so that the bottom of the message list will always be on top of the form input, and not behind it at any point.
* hide header on touch screens when screns are small and screen height is short (possibly when keyboard is up), so that there's more visibliity to see messages. this only works on chrome, not ios safari right now, due to the position: fixed of things.
* move char counting to keyup instead
* address message text horiz overflow (#157)
* dont jumpToBottom if user has scrolled about 200px from the bottom (#101)
* scroll to bottom on resize too
* cleanup
* revert test bool
* typo
* re-readjust short-wide case again
* - add focus to input field after emoji is selected, put cursor at end
- instead of smooth scrolling to bottom, just jump there.
* Try and clarify max viewer count string
* Shrink title font size on small screens to fit username
* Hide stream info on small screens to buy some space
* Hide emoji button on small screens until we can fix it. For #140
* Make jumping to bottom be a part of the render pass to fix race condition. For #140
* Remove About in info view. We can add it back. Just playing with that since it was missing a space anyway
* address some own mr comments
Co-authored-by: Ginger Wong <omqmail@gmail.com>