V2 Ember Addon #16
V2 Ember Addon #16
Conversation
…dons feat: Use async import to only load third party libs when we actually need them potentially saving the 500k+ HLS.js hit on initial page loads BREAKING CHANGES!
# [5.0.0-beta.1](v4.1.1...v5.0.0-beta.1) (2023-04-30)
… try removing crossorigin. Resolves CORS issue when an identifier was a url that would redirect
…ork with howler since howler doesn't emit audio-position-changed events
…oblems with release/beta channels
# [5.0.0-beta.2](v5.0.0-beta.1...v5.0.0-beta.2) (2023-05-23) ### Bug Fixes * correctly handle setting currentSound = null ([c8f0e58](c8f0e58)) * if crossorigin=anonymous fails on <audio> element, automatically try removing crossorigin. Resolves CORS issue ([984eba7](984eba7)) * Implement proper teardown on sound destruction ([82affba](82affba)) * Resolve issue where sound-position-progress modifier would not work with howler since howler doesn't emit audio-position-changed events ([a8d75bb](a8d75bb)) * resolve typo which caused incorrect handling of autoplay check during testing ([57f3680](57f3680)) ### Features * Implement additional MediaSession actions and play state ([6f6e47a](6f6e47a))
…ition sliders on the same page
# [5.0.0-beta.3](v5.0.0-beta.2...v5.0.0-beta.3) (2023-05-24) ### Bug Fixes * Resolve issue introduced in last version when multiple sound position sliders on the same page ([7db16c1](7db16c1))
# [5.0.0-beta.4](v5.0.0-beta.3...v5.0.0-beta.4) (2023-05-24) ### Bug Fixes * Resolve some more bugs with sound-position modifiers ([2de3d45](2de3d45))
# [5.0.0-beta.14](v5.0.0-beta.13...v5.0.0-beta.14) (2024-01-11) ### Bug Fixes * revert previous change, fix the actual problem ([364720e](364720e))
# [5.0.0-beta.15](v5.0.0-beta.14...v5.0.0-beta.15) (2024-01-12)
# [5.0.0-beta.16](v5.0.0-beta.15...v5.0.0-beta.16) (2024-03-02)
# [5.0.0-beta.17](v5.0.0-beta.16...v5.0.0-beta.17) (2024-03-03)
# [5.0.0-beta.18](v5.0.0-beta.17...v5.0.0-beta.18) (2024-03-05) ### Bug Fixes * improve volume slider logic ([79d7d8b](79d7d8b))
…24 chore: refactor where position is set on a playing sound
|
Warning Rate Limit Exceeded@jkeen has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 14 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. WalkthroughThis update signifies a transformation in the project's development and deployment strategies. It introduces new GitHub Actions for asset management, package handling, and Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
# [5.0.0-beta.19](v5.0.0-beta.18...v5.0.0-beta.19) (2024-03-18) ### Features * improve firing resolution of audio-position-changed event. refs [#24](#24) ([e1ebbc0](e1ebbc0))
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 19
Configuration used: CodeRabbit UI
Files ignored due to path filters (39)
codemods.logis excluded by:!**/*.logdocs/config/ember-cli-update.jsonis excluded by:!**/*.jsondocs/config/optional-features.jsonis excluded by:!**/*.jsondocs/package.jsonis excluded by:!**/*.jsondocs/public/favicon.icois excluded by:!**/*.icodocs/public/images/angle-down.svgis excluded by:!**/*.svgdocs/public/images/angle-up.svgis excluded by:!**/*.svgdocs/public/images/close.svgis excluded by:!**/*.svgdocs/public/images/connection-eligible.svgis excluded by:!**/*.svgdocs/public/images/connection-failure.svgis excluded by:!**/*.svgdocs/public/images/connection-ineligible.svgis excluded by:!**/*.svgdocs/public/images/connection-success.svgis excluded by:!**/*.svgdocs/public/images/fastforward-outline.svgis excluded by:!**/*.svgdocs/public/images/like-outline.svgis excluded by:!**/*.svgdocs/public/images/load.svgis excluded by:!**/*.svgdocs/public/images/loading-outline.svgis excluded by:!**/*.svgdocs/public/images/loop-outline.svgis excluded by:!**/*.svgdocs/public/images/pause-outline.svgis excluded by:!**/*.svgdocs/public/images/play-outline.svgis excluded by:!**/*.svgdocs/public/images/record-outline.svgis excluded by:!**/*.svgdocs/public/images/resume-outline.svgis excluded by:!**/*.svgdocs/public/images/shuffle-outline.svgis excluded by:!**/*.svgdocs/public/images/skip-backward-outline.svgis excluded by:!**/*.svgdocs/public/images/skip-forward-outline.svgis excluded by:!**/*.svgdocs/public/images/stop-outline.svgis excluded by:!**/*.svgdocs/public/images/stop.svgis excluded by:!**/*.svgdocs/public/images/volume-high-outline.svgis excluded by:!**/*.svgdocs/public/images/volume-low-outline.svgis excluded by:!**/*.svgdocs/public/images/volume-mute-outline.svgis excluded by:!**/*.svgdocs/public/sounds/angry-lady-ms-cleo.mp3is excluded by:!**/*.mp3docs/public/sounds/attention.mp3is excluded by:!**/*.mp3docs/public/sounds/foghorn-leghorn.mp3is excluded by:!**/*.mp3docs/public/sounds/functional.mp3is excluded by:!**/*.mp3docs/public/sounds/internet-on-computers.mp3is excluded by:!**/*.mp3docs/public/sounds/tic-tac-toe.mp3is excluded by:!**/*.mp3docs/public/sounds/video-professor.mp3is excluded by:!**/*.mp3docs/public/sounds/works-just-like-a-vcr.mp3is excluded by:!**/*.mp3ember-stereo/babel.config.jsonis excluded by:!**/*.jsonember-stereo/package.jsonis excluded by:!**/*.json
Files selected for processing (102)
- .github/actions/assert-build/action.yml (1 hunks)
- .github/actions/download-built-package/action.yml (1 hunks)
- .github/actions/pnpm/action.yml (1 hunks)
- .github/workflows/ci.yml (2 hunks)
- .github/workflows/deploy-docs.yml (1 hunks)
- .github/workflows/push-dist.yml (1 hunks)
- .github/workflows/release.yml (1 hunks)
- .gitignore (1 hunks)
- CHANGELOG.md (1 hunks)
- CONTRIBUTING.md (1 hunks)
- README.md (2 hunks)
- docs/.editorconfig (1 hunks)
- docs/.eslintignore (1 hunks)
- docs/.eslintrc.js (1 hunks)
- docs/.github/workflows/ci.yml (1 hunks)
- docs/.gitignore (1 hunks)
- docs/.prettierrc.js (1 hunks)
- docs/README.md (1 hunks)
- docs/app/app.js (1 hunks)
- docs/app/components/diagnostic-controls.hbs (1 hunks)
- docs/app/components/docs/proxy-example.js (1 hunks)
- docs/app/components/docs/queued.hbs (1 hunks)
- docs/app/components/docs/queued.js (1 hunks)
- docs/app/components/docs/service-errors-try-catch.js (1 hunks)
- docs/app/components/docs/stereo-volume-example.hbs (2 hunks)
- docs/app/components/service-display.hbs (1 hunks)
- docs/app/components/sound-properties.hbs (1 hunks)
- docs/app/components/strategy-breakdown.js (1 hunks)
- docs/app/index.html (1 hunks)
- docs/app/router.js (2 hunks)
- docs/app/routes/diagnostic.js (1 hunks)
- docs/app/routes/diagnostic/sync.js (1 hunks)
- docs/app/styles/app.css (1 hunks)
- docs/app/templates/application.hbs (1 hunks)
- docs/app/templates/docs.hbs (1 hunks)
- docs/app/templates/docs/advanced.md (1 hunks)
- docs/app/templates/docs/audio-format.md (1 hunks)
- docs/app/templates/docs/debugging.md (1 hunks)
- docs/app/templates/docs/event-monitoring.md (1 hunks)
- docs/app/templates/docs/index.md (1 hunks)
- docs/app/templates/docs/metadata.md (1 hunks)
- docs/app/templates/docs/playing-sounds.md (1 hunks)
- docs/app/templates/docs/volume.md (1 hunks)
- docs/app/templates/docs/waiting-for-sounds.md (1 hunks)
- docs/app/templates/not-found.hbs (1 hunks)
- docs/config/addon-docs.js (1 hunks)
- docs/config/environment.js (1 hunks)
- docs/config/targets.js (1 hunks)
- docs/ember-cli-build.js (1 hunks)
- docs/tailwind.js (2 hunks)
- docs/testem.js (1 hunks)
- docs/tests/index.html (1 hunks)
- docs/tests/test-helper.js (1 hunks)
- ember-stereo/.eslintignore (1 hunks)
- ember-stereo/.gitignore (1 hunks)
- ember-stereo/.npmignore (1 hunks)
- ember-stereo/.prettierrc.js (1 hunks)
- ember-stereo/.template-lintrc.js (1 hunks)
- ember-stereo/CHANGELOG.md (1 hunks)
- ember-stereo/README.md (1 hunks)
- ember-stereo/addon-main.js (1 hunks)
- ember-stereo/config/environment.js (1 hunks)
- ember-stereo/rollup.config.js (1 hunks)
- ember-stereo/src/-private/helpers/action-helper.js (1 hunks)
- ember-stereo/src/-private/helpers/is-helper.js (1 hunks)
- ember-stereo/src/-private/utils/error-cache.js (1 hunks)
- ember-stereo/src/-private/utils/evented.js (1 hunks)
- ember-stereo/src/-private/utils/has-equal-identifiers.js (1 hunks)
- ember-stereo/src/-private/utils/has-equal-urls.js (1 hunks)
- ember-stereo/src/-private/utils/metadata-cache.js (1 hunks)
- ember-stereo/src/-private/utils/mime-types.js (1 hunks)
- ember-stereo/src/-private/utils/normalize-identifier.js (1 hunks)
- ember-stereo/src/-private/utils/object-cache.js (1 hunks)
- ember-stereo/src/-private/utils/shared-audio-access.js (1 hunks)
- ember-stereo/src/-private/utils/sound-cache.js (1 hunks)
- ember-stereo/src/-private/utils/sound-proxy.js (6 hunks)
- ember-stereo/src/-private/utils/strategizer.js (2 hunks)
- ember-stereo/src/-private/utils/strategy.js (1 hunks)
- ember-stereo/src/-private/utils/untracked-object-cache.js (1 hunks)
- ember-stereo/src/-private/utils/url-cache.js (1 hunks)
- ember-stereo/src/blueprints/stereo-connection/files/root/stereo-connections/name.js (1 hunks)
- ember-stereo/src/helpers/fastforward-sound.js (1 hunks)
- ember-stereo/src/helpers/find-sound.js (1 hunks)
- ember-stereo/src/helpers/load-sound.js (2 hunks)
- ember-stereo/src/helpers/pause-sound.js (1 hunks)
- ember-stereo/src/helpers/play-sound.js (2 hunks)
- ember-stereo/src/helpers/rewind-sound.js (1 hunks)
- ember-stereo/src/helpers/seek-sound.js (1 hunks)
- ember-stereo/src/helpers/sound-duration.js (1 hunks)
- ember-stereo/src/helpers/sound-error-details.js (1 hunks)
- ember-stereo/src/helpers/sound-is-blocked.js (1 hunks)
- ember-stereo/src/helpers/sound-is-errored.js (1 hunks)
- ember-stereo/src/helpers/sound-is-fastforwardable.js (1 hunks)
- ember-stereo/src/helpers/sound-is-loaded.js (1 hunks)
- ember-stereo/src/helpers/sound-is-loading.js (1 hunks)
- ember-stereo/src/helpers/sound-is-playing.js (1 hunks)
- ember-stereo/src/helpers/sound-is-rewindable.js (1 hunks)
- ember-stereo/src/helpers/sound-is-seekable.js (1 hunks)
- ember-stereo/src/helpers/sound-position.js (1 hunks)
- ember-stereo/src/helpers/stereo-volume.js (1 hunks)
- ember-stereo/src/helpers/stop-sound.js (1 hunks)
- ember-stereo/src/helpers/toggle-play-sound.js (2 hunks)
Files skipped from review due to trivial changes (42)
- .gitignore
- docs/.editorconfig
- docs/.eslintignore
- docs/.gitignore
- docs/.prettierrc.js
- docs/app/components/docs/service-errors-try-catch.js
- docs/app/index.html
- docs/app/templates/not-found.hbs
- docs/config/targets.js
- ember-stereo/.eslintignore
- ember-stereo/.gitignore
- ember-stereo/.npmignore
- ember-stereo/.prettierrc.js
- ember-stereo/.template-lintrc.js
- ember-stereo/config/environment.js
- ember-stereo/src/-private/helpers/action-helper.js
- ember-stereo/src/-private/utils/error-cache.js
- ember-stereo/src/-private/utils/evented.js
- ember-stereo/src/-private/utils/has-equal-identifiers.js
- ember-stereo/src/-private/utils/metadata-cache.js
- ember-stereo/src/-private/utils/mime-types.js
- ember-stereo/src/-private/utils/object-cache.js
- ember-stereo/src/-private/utils/untracked-object-cache.js
- ember-stereo/src/-private/utils/url-cache.js
- ember-stereo/src/helpers/fastforward-sound.js
- ember-stereo/src/helpers/find-sound.js
- ember-stereo/src/helpers/pause-sound.js
- ember-stereo/src/helpers/rewind-sound.js
- ember-stereo/src/helpers/seek-sound.js
- ember-stereo/src/helpers/sound-duration.js
- ember-stereo/src/helpers/sound-error-details.js
- ember-stereo/src/helpers/sound-is-blocked.js
- ember-stereo/src/helpers/sound-is-errored.js
- ember-stereo/src/helpers/sound-is-fastforwardable.js
- ember-stereo/src/helpers/sound-is-loaded.js
- ember-stereo/src/helpers/sound-is-loading.js
- ember-stereo/src/helpers/sound-is-playing.js
- ember-stereo/src/helpers/sound-is-rewindable.js
- ember-stereo/src/helpers/sound-is-seekable.js
- ember-stereo/src/helpers/sound-position.js
- ember-stereo/src/helpers/stereo-volume.js
- ember-stereo/src/helpers/stop-sound.js
Additional comments: 78
docs/app/templates/docs/waiting-for-sounds.md (1)
- 1-1: The component
<Docs::ProxyExample />is correctly used here. Ensure that this component is properly documented and tested, especially if it's newly introduced or has undergone significant changes.docs/app/templates/application.hbs (1)
- 1-2: The use of
{{outlet}}and<DocsKeyboardShortcuts />is appropriate and follows Ember's conventions for templates. Ensure that theDocsKeyboardShortcutscomponent is well-documented and accessible to users of all abilities.docs/app/templates/docs/debugging.md (1)
- 1-5: The structure of this document, with headings followed by component examples (
<Docs::ProxyExample/>and<Docs::Queued/>), is clear and follows good documentation practices. Ensure these components are well-documented and tested, especially if they are newly introduced or have undergone significant changes.ember-stereo/addon-main.js (1)
- 1-5: The use of
@embroider/addon-shimand theaddonV1Shimfunction is appropriate for making the addon compatible with Embroider. This change aligns with modern Ember.js development practices.docs/app/templates/docs/advanced.md (1)
- 1-5: The additions to the advanced documentation, including the use of
<Docs::CustomPositionControl />and<Docs::ProxyExample />, are well-structured and follow good documentation practices. Ensure these components are well-documented and tested, especially if they are newly introduced or have undergone significant changes.docs/app/routes/diagnostic/sync.js (1)
- 1-2: The update to the import path for
testSoundsreflects the project's reorganization and is correctly implemented. Ensure that thetestSoundsutility is well-documented and tested, especially after the change in its location.docs/app/routes/diagnostic.js (1)
- 1-2: The update to the import path for
testSoundsand the use of thestereoservice in theDiagnosticroute are well-implemented. These changes reflect the project's reorganization and its focus on enhancing diagnostic capabilities. Ensure that thetestSoundsutility and thestereoservice are well-documented and tested.ember-stereo/src/-private/utils/has-equal-urls.js (1)
- 1-2: The update to the import path for
StereoUrland its use in thehasEqualUrlsfunction are correctly implemented. This change reflects the project's reorganization of utility modules and enhances the functionality for comparing URLs. Ensure that theStereoUrlclass and thehasEqualUrlsfunction are well-documented and tested.docs/config/addon-docs.js (1)
- 6-6: The updated URL in the comment ensures users are directed to the latest version of the documentation. This is a good practice for maintainability and user guidance.
.github/actions/pnpm/action.yml (1)
- 1-14: The GitHub Action for setting up Node.js and pnpm is well-defined, using specific versions for actions and leveraging caching. Ensure the
pnpm installcommand works as expected in your CI environment.docs/app/app.js (1)
- 4-4: The update to the import path for the
configvariable aligns with the project's restructuring. Ensure thorough testing is conducted to verify that the new configuration path functions correctly within the application..github/actions/download-built-package/action.yml (1)
- 1-13: The GitHub Action for downloading a built package and installing dependencies with pnpm is correctly set up. Verify the
pnpm installcommand's effectiveness, especially in the context of using downloaded artifacts.docs/app/components/docs/proxy-example.js (1)
- 6-11: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-10]
The
ProxyExamplecomponent is well-implemented, using modern Ember component design patterns such as@trackedand@service. The removal of the constructor method simplifies the component while relying on Ember's default initialization behavior.docs/tests/test-helper.js (1)
- 1-13: The test setup for the documentation app is correctly configured, leveraging QUnit and sinon for a consistent testing environment. Ensure that all tests pass with this new setup to verify its effectiveness.
.github/workflows/push-dist.yml (1)
- 1-20: The workflow for pushing the distribution package is well-defined, using a custom action for setting up pnpm and dynamically specifying the branch for the dist package. Verify the workflow's effectiveness in your CI environment, especially the dynamic branch specification.
.github/workflows/release.yml (1)
- 4-23: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-20]
The workflow for generating new releases is well-defined, leveraging
actions/checkout@v3and a custom pnpm action for setup. Ensure to verify the release process in your CI environment, paying close attention to the custom pnpm action and the specified working directory.docs/app/components/docs/queued.hbs (1)
- 1-19: LGTM! The Handlebars template follows Ember.js conventions and correctly demonstrates the usage of a sound queue with play and stop functionality.
ember-stereo/src/-private/utils/normalize-identifier.js (1)
- 2-2: LGTM! The updated relative import path for
BaseSoundis correct and improves the modularity of the code.CONTRIBUTING.md (2)
- 7-7: The switch to
pnpm installaligns with the PR's objective of adopting efficient dependency management. Good update!- 4-10: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [25-25]
Consider capitalizing "ember-cli" as "Ember-CLI" for consistency with official naming conventions.
docs/testem.js (1)
- 1-23: LGTM! The Testem configuration is standard for Ember.js projects and correctly sets up browser settings for CI and development environments.
.github/workflows/deploy-docs.yml (1)
- 1-23: LGTM! The GitHub Actions workflow is well-structured and enhances the automation and consistency of the documentation deployment process.
docs/app/templates/docs/volume.md (1)
- 12-12: The addition of
<Docs::StereoVolumeElementExample />enhances the documentation by providing a practical example of volume control. Good update!docs/app/components/docs/stereo-volume-example.hbs (1)
- 1-8: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [4-23]
LGTM! The updates to the template structure and snippet reference improve clarity and maintainability. The template correctly demonstrates stereo volume control following Ember.js conventions.
docs/app/templates/docs/metadata.md (2)
- 13-13: The addition of
<Docs::CustomMetadata />provides a clear example of handling custom metadata in a "Now Playing" display. Good update!- 10-16: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [3-3]
Consider adding a comma after "load helpers" for improved readability.
docs/app/templates/docs/index.md (1)
- 5-5: The addition of a space after
Docs::AttentionGetteris a minor change that likely improves readability or conforms to a style guide. Looks good!docs/app/router.js (2)
- 2-2: The update to the import path for
configreflects a reorganization of the project structure. Please ensure that theconfigfile exists at the new location.- 25-27: The modifications to route names, including the replacement of 'custom-position-controls' with 'advanced' and the addition of a new route 'debugging', likely reflect updates to the documentation structure or new features. Please ensure these changes are consistent with the project's documentation and navigation strategy.
Verification successful
The modifications to route names, including the replacement of 'custom-position-controls' with 'advanced' and the addition of a new route 'debugging', are consistent with the project's documentation structure, as evidenced by the corresponding markdown files in the
docs/app/templates/docs/directory. This confirms that the changes likely reflect updates to the documentation structure or new features.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify consistency of route names with documentation structure grep -R 'route:' docs/app/templates/docs/Length of output: 41
Script:
#!/bin/bash # Verify the existence and content of the specified directory ls -l docs/app/templates/docs/ # Broaden the search for route names across the project to understand their definition and usage grep -R 'this.route' docs/Length of output: 1855
docs/app/components/sound-properties.hbs (1)
- 10-14: The addition of new properties
isLive,isSeekable, andcurrentTimeto thesound-propertiescomponent likely enhances its functionality. Please ensure these properties are supported by the underlying sound object and are correctly documented.Verification successful
The corrected search has successfully identified references to
isLive,isSeekable, andcurrentTimewithin theember-stereo/src/directory. These properties are utilized across various files, indicating that the addition of these properties to thesound-propertiescomponent in the documentation is consistent with their support and usage within theember-stereoproject. This confirms that the review comment is accurate and the properties are indeed supported by the underlying sound object, as well as being correctly documented in the context of the changes made.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify the support of new properties in the sound object grep -R 'isLive|isSeekable|currentTime' ember-stereo/src/Length of output: 59
Script:
#!/bin/bash # Correct the grep command to properly search for the properties using extended regular expressions grep -RE 'isLive|isSeekable|currentTime' ember-stereo/src/Length of output: 3330
ember-stereo/src/helpers/play-sound.js (2)
- 1-2: The updates to the import path for
StereoBaseActionHelperand the addition ofdidCancelfrom 'ember-concurrency' are good practices that reflect project reorganization and improve the robustness of the helper.- 26-33: The modifications to the
performActionmethod, including the use ofstereo.playTask.performand error handling withdidCancel, improve error handling and resilience to cancellations. Please ensure thatplayTaskis correctly implemented onstereoand that error handling is properly tested.Verification successful
The modifications to the
performActionmethod, including the use ofstereo.playTask.performand error handling withdidCancel, are supported by the script output. The presence ofplayTaskinservices/stereo.jsand its usage across the codebase confirm its correct implementation onstereo. The error handling approach, indicated by the use of.catch((e) => {, aligns with the intended improvements in error handling and resilience to cancellations. It's advisable to ensure comprehensive testing around these functionalities for robustness.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify the implementation of playTask and error handling grep -R 'playTask' ember-stereo/src/Length of output: 781
ember-stereo/src/helpers/toggle-play-sound.js (2)
- 1-2: The import of
didCancelfrom 'ember-concurrency' enhances the robustness of thetogglePlaySoundhelper by allowing for better cancellation handling in asynchronous operations.- 29-33: The modifications to the
performActionmethod, including the use ofplayTaskinstead ofplayfor playing sounds and handling cancellation withdidCancel, improve error handling and resilience. Please ensure thatplayTaskis correctly implemented and that error handling is properly tested.Verification successful
The grep output confirms the usage of
playTaskacross several files, including its definition inservices/stereo.jsand its usage inhelpers/toggle-play-sound.js, aligning with the review comment. To further verify the correctness ofplayTask's implementation and its error handling, particularly the use ofdidCancel, additional information is needed.
The provided script outputs confirm the implementation of
playTaskwithin theStereoservice inember-stereo/src/services/stereo.js, as well as the usage ofdidCancelfor error handling in various parts of the codebase, including theStereoservice and several helpers. TheplayTaskmethod is designed to handle playing sounds, with error handling that checks for cancellation errors usingdidCancel. This aligns with the modifications mentioned in the review comment, indicating that the changes have been correctly implemented to improve error handling and resilience.Given the evidence from the script outputs, it's clear that
playTaskis a valid method implemented within theStereoservice, anddidCancelis used appropriately for error handling across the codebase. Therefore, the modifications to theperformActionmethod, including the use ofplayTaskfor playing sounds and handling cancellation withdidCancel, are verified to improve error handling and resilience as intended.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify the implementation of playTask and error handling grep -R 'playTask' ember-stereo/src/Length of output: 781
Script:
#!/bin/bash # Verify the implementation of playTask in services/stereo.js cat ember-stereo/src/services/stereo.js # Verify the implementation of didCancel grep -R 'didCancel' ember-stereo/src/Length of output: 33754
docs/.github/workflows/ci.yml (1)
- 1-47: The CI workflow configuration is well-structured and follows best practices, including the use of Node.js version 14.x and caching dependencies with Yarn. Consider updating to a newer Node.js version if compatible with the project's requirements for potential performance improvements and access to newer features.
ember-stereo/src/helpers/load-sound.js (2)
- 3-3: The updates to the import path for
prepareOptionsand the addition of thexhrparameter for xhr options enhance the flexibility and functionality of theload-soundhelper. Good improvement!- 31-37: The addition of a try-catch block for handling exceptions, including cancellations with
didCancel, improves the robustness of theload-soundhelper. Please ensure that error handling is correctly implemented and thoroughly tested.docs/app/templates/docs.hbs (1)
- 1-32: The changes to the documentation template are well-structured and follow Ember.js best practices. The use of block components with
as |alias|syntax enhances readability and maintainability.docs/tests/index.html (1)
- 1-39: The HTML template for the test suite is correctly structured, including all necessary elements for running tests. The use of
{{rootURL}}for asset paths ensures compatibility across different deployment environments.ember-stereo/src/-private/helpers/is-helper.js (1)
- 32-32: The update to the sound retrieval logic in
StereoBaseIsHelperimproves robustness by ensuring that a sound object is returned only ifsoundProxyactually contains a sound. This is a sensible enhancement.docs/.eslintrc.js (1)
- 1-58: The ESLint configuration is well-structured and aligns with best practices for linting Ember.js projects. The inclusion of appropriate plugins, rules, and overrides contributes to maintaining code quality across the project.
docs/config/environment.js (1)
- 5-5: Updating the
modulePrefixvalue from'dummy'to'docs'is a necessary change following the separation of the documentation app. This correctly reflects the new context of the app within the Ember.js ecosystem.docs/app/components/strategy-breakdown.js (1)
- 39-39: Using the nullish coalescing operator
(results ?? [])for handling nullish values in theresultsarray is a precise improvement. It ensures that an empty array is used only ifresultsis null or undefined, aligning with likely intended behavior.docs/tailwind.js (2)
- 9-9: Adjusting the purge path in the Tailwind CSS configuration is a sensible correction that ensures the correct files are targeted for purging unused styles. This contributes to optimizing the final CSS bundle size.
- 66-66: Updating the themes path to use a different file location in the Tailwind CSS configuration reflects a sensible reorganization of the project structure. This change likely aligns with the objectives of improving the project's structure and maintainability.
ember-stereo/src/-private/utils/strategy.js (1)
- 11-11: The addition of
erroredSoundas a tracked property aligns with the class's management of sound states. Ensure its usage is effectively integrated into the class's functionality or by its consumers..github/actions/assert-build/action.yml (1)
- 8-50: The GitHub Action for building the package and asserting file existence is well-defined, using
pnpm buildand covering a comprehensive list of files. Ensure the assertion list is complete and verify the successful execution of the build process.docs/app/components/service-display.hbs (1)
- 1-57: The template for displaying stereo service information is well-structured, using components and helpers effectively. Ensure all components and helpers are up-to-date and correctly integrated.
docs/app/templates/docs/playing-sounds.md (1)
- 31-31: The minor formatting change improves readability and is consistent with HTML/XML standards. Consider reviewing the entire document for any additional formatting or clarity improvements.
docs/app/templates/docs/audio-format.md (1)
- 17-17: The update in component invocation syntax from angle-bracket to curly-brace improves consistency with Ember's standards. Ensure uniformity in component invocation syntax across all documentation.
docs/app/templates/docs/event-monitoring.md (1)
- 30-35: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-73]
The removal of a redundant line likely improves the document's layout without affecting the content's integrity. Consider reviewing the entire document for any additional formatting or clarity improvements.
ember-stereo/src/-private/utils/shared-audio-access.js (1)
- 11-15: The comment questioning the necessity of using a single audio element for shared access highlights an important point for reevaluation. Consider engaging in a broader discussion about the relevance of this approach and exploring potential alternatives that may simplify the codebase.
docs/ember-cli-build.js (1)
- 1-73: The Ember CLI build configuration is comprehensive and aligns with modern web development practices. Ensure that all plugins and dependencies are up-to-date and compatible with the latest Ember CLI versions.
ember-stereo/rollup.config.js (1)
- 1-67: The Rollup configuration is well-structured and effectively utilizes various plugins and utilities to manage the project's build process. It correctly specifies public entry points, handles app reexports, and manages assets and cleanup. This setup should serve the project well, ensuring a smooth build and development experience.
ember-stereo/src/-private/utils/sound-cache.js (2)
- 4-4: The update to the import path for
BaseSoundimproves the modularity and maintainability of the code. Using relative paths for imports within the same module or package is a good practice.- 11-13: The
SoundCacheclass is well-implemented, following Ember's conventions for reactive properties and service management. It provides a clear and efficient way to cache sound objects based on URLs, contributing to the project's overall functionality and user experience.ember-stereo/src/blueprints/stereo-connection/files/__root__/stereo-connections/__name__.js (2)
- 2-2: The update to import
assertfrom@ember/debugaligns with modern Ember best practices, promoting modularity and enabling better tree shaking. This is a positive change for maintainability and performance.- 1-5: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [2-96]
The
Soundclass provides a well-structured template for creating sound connections, with clear instructions andassertstatements to ensure that subclasses implement the necessary functionality. This approach enhances the project's modularity and ensures consistency across different sound connection implementations.ember-stereo/src/-private/utils/sound-proxy.js (2)
- 4-6: The refactoring to use
identifierinstead ofurlfor sound identification increases the flexibility and generality of the sound management system. This change allows for a broader range of sound identifiers, enhancing the project's capability to handle different sound sources.- 23-55: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [41-111]
The implementation of the
SoundProxyclass, including the use of Ember Concurrency tasks and tracked properties, is well-done. It effectively manages asynchronous state and tasks, such as resolving identifiers and waiting for sound loads, providing a robust and declarative approach to handling concurrency and cancellation.ember-stereo/src/-private/utils/strategizer.js (3)
- 3-3: The update to import
StereoUrlfrom a new path aligns with the goal of improving modularity and maintainability through the use of relative imports. This change is a positive step towards a more organized and modular codebase.- 23-32: The addition of logic to handle
xhroptions when building a strategy is a valuable enhancement, providing more control over XMLHttpRequests used in sound loading. This allows for customization of requests based on specific needs, improving the flexibility and capability of the sound loading process.- 20-35: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [3-103]
The
Strategizerclass is well-designed and implemented, offering a flexible and extensible approach to determining the best strategy for loading sounds. The use of tracked properties and cached getters ensures that the class is reactive and efficient, contributing to the project's overall functionality and user experience.docs/app/styles/app.css (3)
- 1-3: The inclusion of Tailwind CSS directives is correctly implemented, setting a solid foundation for utility-first styling throughout the project. This approach facilitates rapid development and ensures consistency in design.
- 7-12: The use of custom CSS variables, such as
--brand-primary, is a good practice for enhancing theming and consistency across the application. This allows for easier maintenance and updates to the application's color scheme.- 14-129: The custom styles for components and elements are well-defined, making effective use of Tailwind's
@applydirective for maintainability and readability. These styles contribute to a cohesive and visually appealing user interface..github/workflows/ci.yml (2)
- 9-9: The addition of the
betabranch trigger is a positive change, expanding the workflow's applicability and ensuring that CI processes run on important development branches.- 20-156: The workflow configuration is comprehensive and well-organized, covering key CI/CD practices such as linting, building, testing, and deploying. The use of matrix configurations for testing across different paths and Ember versions ensures thorough compatibility checks. The deployment conditions and dispatch for release are correctly configured, aligning with common release workflows.
docs/app/components/diagnostic-controls.hbs (1)
- 8-8: The change from
this.identifiertothis.urlin theplay-soundfunction call seems appropriate and aligns with the PR's objectives of enhancing URL handling. Ensure thatthis.urlis always correctly set and represents the expected value forplay-sound, especially in edge cases or when the form is initially loaded.README.md (1)
- 11-13: The updates to the compatibility section clearly outline the minimum required versions for Ember.js, Ember CLI, and Node.js, which is helpful for users to ensure they meet the project's requirements.
CHANGELOG.md (8)
- 14-14: The entry mentions the addition of a feature allowing multiple identifiers in the metadata cache to support fallback URLs. This is a significant enhancement for flexibility and reliability.
- 20-20: The update to slider and progress modifiers for better handling URL changes is a practical improvement for user experience, ensuring UI components reflect the current state accurately.
- 26-26: Fixing the invalid super call in the sound-position-slider modifier is crucial for maintaining the integrity of the inheritance chain and preventing runtime errors.
- 32-32: Removing console.log statements is a good practice for cleaner, production-ready code. It helps in avoiding unnecessary output in the console, which can be distracting or misleading during debugging.
- 36-36: The chore of updating to Ember 4.8 and modifying release settings indicates a significant step towards modernizing the project and ensuring compatibility with newer versions of Ember.
- 40-40: Dropping support for Ember versions below 3.28 is a breaking change that necessitates careful consideration and communication with the project's users to ensure they are prepared for the upgrade.
- 46-46: Updating the import statement for Ember 4.x compatibility is a minor but necessary change to ensure the project's codebase remains up-to-date with the latest Ember conventions.
- 52-52: Setting cross-origin to anonymous on audio elements is an important security measure for enabling audio analysis with the Web Audio API without running into CORS issues.
|
|
||
| ### Interactive docs at [ember-stereo.com](https://ember-stereo.com/docs)! | ||
|
|
||
| ##### Upgrading from `ember-hifi`? Read the [upgrade guide](https://jkeen.github.com/ember-stereo) |
There was a problem hiding this comment.
The upgrade guide link is broken due to a typo in the URL. It should use .io instead of .com for GitHub Pages.
- https://jkeen.github.com/ember-stereo
+ https://jkeen.github.io/ember-stereoCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ##### Upgrading from `ember-hifi`? Read the [upgrade guide](https://jkeen.github.com/ember-stereo) | |
| ##### Upgrading from `ember-hifi`? Read the [upgrade guide](https://jkeen.github.io/ember-stereo) |
|
|
||
| #### Service API | ||
|
|
||
| `stereo` plays one sound at a time. Multiple sounds can be loaded and ready to go, but only one sound plays at a time. The currently playing sound is set to `currentSound` on the service, and most methods and properties on the service simply proxy to that sound. |
There was a problem hiding this comment.
Consider starting the sentence with an uppercase letter for consistency.
- `stereo` plays one sound at a time. Multiple sounds can be loaded and ready to go, but only one sound plays at a time. The currently playing sound is set to `currentSound` on the service, and most methods and properties on the service simply proxy to that sound.
+ `Stereo` plays one sound at a time. Multiple sounds can be loaded and ready to go, but only one sound plays at a time. The currently playing sound is set to `currentSound` on the service, and most methods and properties on the service simply proxy to that sound.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| `stereo` plays one sound at a time. Multiple sounds can be loaded and ready to go, but only one sound plays at a time. The currently playing sound is set to `currentSound` on the service, and most methods and properties on the service simply proxy to that sound. | |
| `Stereo` plays one sound at a time. Multiple sounds can be loaded and ready to go, but only one sound plays at a time. The currently playing sound is set to `currentSound` on the service, and most methods and properties on the service simply proxy to that sound. |
| 1. `HLS` - Uses HLS.js for playing HLS streams on the desktop. | ||
| 1. `Howler` - Uses [howler](http://howlerjs.com) to play audio | ||
|
|
||
| `stereo` will take a list of urls and find the first connection/url combo that works. For desktop browsers, we'll try each url on each connection in the order the urls were specified. |
There was a problem hiding this comment.
Consider starting the sentence with an uppercase letter and using "URLs" instead of "urls" for consistency and correctness.
- `stereo` will take a list of urls and find the first connection/url combo that works. For desktop browsers, we'll try each url on each connection in the order the urls were specified.
+ `Stereo` will take a list of URLs and find the first connection/URL combo that works. For desktop browsers, we'll try each URL on each connection in the order the URLs were specified.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| `stereo` will take a list of urls and find the first connection/url combo that works. For desktop browsers, we'll try each url on each connection in the order the urls were specified. | |
| `Stereo` will take a list of URLs and find the first connection/URL combo that works. For desktop browsers, we'll try each URL on each connection in the order the URLs were specified. |
| # docs | ||
|
|
||
| This README outlines the details of collaborating on this Ember application. | ||
| A short introduction of this app could easily go here. |
There was a problem hiding this comment.
Consider using "brief" instead of "short" for the introduction to strengthen the wording.
- A short introduction of this app could easily go here.
+ A brief introduction of this app could easily go here.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| A short introduction of this app could easily go here. | |
| A brief introduction of this app could easily go here. |
| /* .docs-bg-white, | ||
| body > .ember-view { | ||
| background-color: rgba(var(--color-background), 1); | ||
| } | ||
| .docs-bg-grey-lightest { | ||
| background-color: rgba(var(--color-surface), 1); | ||
| } | ||
| .docs-text-grey-darker { | ||
| color: rgba(var(--color-on-surface), 1); | ||
| } */ |
There was a problem hiding this comment.
Consider removing the commented-out code if it is no longer needed. Keeping the stylesheet clean and focused on current styles enhances maintainability and readability.
- /* .docs-bg-white,
- body > .ember-view {
- background-color: rgba(var(--color-background), 1);
- }
- .docs-bg-grey-lightest {
- background-color: rgba(var(--color-surface), 1);
- }
- .docs-text-grey-darker {
- color: rgba(var(--color-on-surface), 1);
- } */Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| /* .docs-bg-white, | |
| body > .ember-view { | |
| background-color: rgba(var(--color-background), 1); | |
| } | |
| .docs-bg-grey-lightest { | |
| background-color: rgba(var(--color-surface), 1); | |
| } | |
| .docs-text-grey-darker { | |
| color: rgba(var(--color-on-surface), 1); | |
| } */ |
|
|
||
| <span class="text-xl">is an addon that makes it easy to reactively handle all sorts of audio files in your ember octane app.</span> | ||
|
|
||
| <Docs::AttentionGetter/> | ||
| <Docs::AttentionGetter /> | ||
|
|
||
| # Install | ||
|
|
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [15-15]
Consider using "open-source" as a hyphenated compound adjective to modify "audio library" for clarity.
- an open source audio library
+ an open-source audio library📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [15-15]
The term "web sites" is more commonly written as one word, "websites".
- most of NY Public Radio's web sites
+ most of NY Public Radio's websites
|
|
||
| ### Bug Fixes | ||
|
|
||
| * revert previous change, fix the actual problem ([364720e](https://github.com/jkeen/ember-stereo/commit/364720eb2f8eb88ee322aedfd6a2811a2e30dee2)) |
There was a problem hiding this comment.
Consider using more formal wording for bug fixes to enhance the professionalism of the changelog.
- * revert previous change, fix the actual problem
+ * Revert previous change, address the actual problemCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * revert previous change, fix the actual problem ([364720e](https://github.com/jkeen/ember-stereo/commit/364720eb2f8eb88ee322aedfd6a2811a2e30dee2)) | |
| * Revert previous change, address the actual problem ([364720e](https://github.com/jkeen/ember-stereo/commit/364720eb2f8eb88ee322aedfd6a2811a2e30dee2)) |
There was a problem hiding this comment.
Review Status
Actionable comments generated: 5
Configuration used: CodeRabbit UI
Files selected for processing (2)
- CHANGELOG.md (1 hunks)
- docs/app/components/docs/stereo-volume-element-example.hbs (1 hunks)
Additional comments: 7
docs/app/components/docs/stereo-volume-element-example.hbs (3)
- 6-11: The
{{stereo-volume}}helper is used both as an attribute and within the{{style}}helper for dynamic width calculation. Ensure that thestereo-volumehelper returns a value suitable for both uses, particularly a numeric value for the width calculation. If it returns complex data, consider refactoring for clarity and maintainability.- 18-18: The
{{on 'click' (toggle-stereo-mute)}}action handler is correctly used to toggle the stereo's mute state on click. Ensure that thetoggle-stereo-mutehelper is implemented to handle the toggle logic effectively and that it properly updates thestereo-volumestate.- 20-26: The conditional rendering based on
{{stereo-volume}}is a good practice for showing different icons and labels based on the volume level. However, ensure that thegthelper is correctly imported and used, and thatstereo-volumereturns a numeric value for this comparison to work as expected.CHANGELOG.md (4)
- 61-61: The phrase "in order to" could be shortened to "to" for conciseness without losing meaning.
Consider simplifying "in order to support providing fallback urls into stereo" to "to support providing fallback URLs into stereo".
- 56-102: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [110-110]
Consider simplifying "whether or not" to "whether" for conciseness.
Simplify "try to better detect whether or not audio source is a stream" to "try to better detect whether audio source is a stream".
- 56-102: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [205-205]
The term "isMobileDevice" should be followed by a comma when introducing a reason.
Consider adding a comma for clarity: "make isMobileDevice a tracked variable, so volume-related logic works reliably".
- 56-102: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [299-299]
The abbreviation "HLS" should be explained or defined at its first occurrence in the document for clarity.
Consider adding a brief explanation or definition of "HLS" at its first occurrence to ensure all readers understand the term.
| <DocsDemo as |demo|> | ||
| <demo.example @name='stereo-volume-element.hbs'> | ||
| <div class='flex items-center w-full'> | ||
| {{! template-lint-disable require-input-label }} |
There was a problem hiding this comment.
Consider adding an explicit input label for accessibility instead of disabling the lint rule with {{! template-lint-disable require-input-label }}. Improving accessibility is crucial for all users.
|
|
||
| # [4.1.0](https://github.com/jkeen/ember-stereo/compare/v4.0.3...v4.1.0) (2023-04-23) | ||
|
|
||
|
|
||
| ### Features | ||
|
|
||
| * Accept multiple identifiers into metadata cache in order to support providing fallback urls into stereo ([7a8226b](https://github.com/jkeen/ember-stereo/commit/7a8226b495a59b673e3cf9692e69d34242d515ba)) | ||
| - Accept multiple identifiers into metadata cache in order to support providing fallback urls into stereo ([7a8226b](https://github.com/jkeen/ember-stereo/commit/7a8226b495a59b673e3cf9692e69d34242d515ba)) | ||
|
|
||
| ## [4.0.3](https://github.com/jkeen/ember-stereo/compare/v4.0.2...v4.0.3) (2023-04-17) | ||
|
|
||
|
|
||
| ### Bug Fixes | ||
|
|
||
| * update slider and progress modifiers to better handle changes when the url changes ([235d563](https://github.com/jkeen/ember-stereo/commit/235d5637419ddf419c07e4ce5897ee4fd27af0cc)) | ||
| - update slider and progress modifiers to better handle changes when the url changes ([235d563](https://github.com/jkeen/ember-stereo/commit/235d5637419ddf419c07e4ce5897ee4fd27af0cc)) | ||
|
|
||
| ## [4.0.2](https://github.com/jkeen/ember-stereo/compare/v4.0.1...v4.0.2) (2022-12-24) | ||
|
|
||
|
|
||
| ### Bug Fixes | ||
|
|
||
| * update ember-modifier, fix invalid super call on sound-position-slider modifier ([f68b01b](https://github.com/jkeen/ember-stereo/commit/f68b01b56f35e02233a58c9739839e7d99bd78b1)) | ||
| - update ember-modifier, fix invalid super call on sound-position-slider modifier ([f68b01b](https://github.com/jkeen/ember-stereo/commit/f68b01b56f35e02233a58c9739839e7d99bd78b1)) | ||
|
|
||
| ## [4.0.1](https://github.com/jkeen/ember-stereo/compare/v4.0.0...v4.0.1) (2022-12-13) | ||
|
|
||
|
|
||
| ### Bug Fixes | ||
|
|
||
| * remove console.log statement in volume modifier ([6ff4940](https://github.com/jkeen/ember-stereo/commit/6ff494048d3c591157adb587a736095de0183872)) | ||
| - remove console.log statement in volume modifier ([6ff4940](https://github.com/jkeen/ember-stereo/commit/6ff494048d3c591157adb587a736095de0183872)) | ||
|
|
||
| # [4.0.0](https://github.com/jkeen/ember-stereo/compare/v3.2.2...v4.0.0) (2022-12-13) | ||
|
|
||
|
|
||
| * chore!: update to Ember 4.8, modify release settings ([871c7e5](https://github.com/jkeen/ember-stereo/commit/871c7e534aee7a4dbfd46fb1cda3c7192909cd41)) | ||
|
|
||
| - chore!: update to Ember 4.8, modify release settings ([871c7e5](https://github.com/jkeen/ember-stereo/commit/871c7e534aee7a4dbfd46fb1cda3c7192909cd41)) | ||
|
|
||
| ### BREAKING CHANGES | ||
|
|
||
| * drop support for Ember < 3.28 | ||
| - drop support for Ember < 3.28 | ||
|
|
||
| ## [3.2.2](https://github.com/jkeen/ember-stereo/compare/v3.2.1...v3.2.2) (2022-09-02) | ||
|
|
||
|
|
||
| ### Bug Fixes | ||
|
|
||
| * update import statement in setupStereoTest for Ember 4.x ([f53bd70](https://github.com/jkeen/ember-stereo/commit/f53bd7053e0d79b8a1242ec38bd9ec6833e2caa1)) | ||
| - update import statement in setupStereoTest for Ember 4.x ([f53bd70](https://github.com/jkeen/ember-stereo/commit/f53bd7053e0d79b8a1242ec38bd9ec6833e2caa1)) | ||
|
|
||
| ## [3.2.1](https://github.com/jkeen/ember-stereo/compare/v3.2.0...v3.2.1) (2022-08-21) | ||
|
|
||
|
|
||
| ### Bug Fixes | ||
|
|
||
| * Set cross-origin to anonymous on elements to allow for audio analysis using web audio api ([34022a4](https://github.com/jkeen/ember-stereo/commit/34022a45a8aa7510783d6cbcac8a0fbd9733f46b)) | ||
| - Set cross-origin to anonymous on elements to allow for audio analysis using web audio api ([34022a4](https://github.com/jkeen/ember-stereo/commit/34022a45a8aa7510783d6cbcac8a0fbd9733f46b)) | ||
|
|
||
| # [3.2.0](https://github.com/jkeen/ember-stereo/compare/v3.1.2...v3.2.0) (2022-07-14) | ||
|
|
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [46-46]
The term "crossorigin" should be hyphenated as "cross-origin" for correctness.
- if crossorigin=anonymous fails on <audio> element, automatically try removing crossorigin.
+ if cross-origin=anonymous fails on <audio> element, automatically try removing cross-origin.📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [246-246]
The term "incase" should be written as two words: "in case".
- safely check systemStereoOptions incase it's not set and we're going full defaults
+ safely check systemStereoOptions in case it's not set and we're going full defaults📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [199-199]
The term "etc." should be followed by a period to adhere to American English conventions.
- providing accurate now-playing info to iOS lock screens, etc
+ providing accurate now-playing info to iOS lock screens, etc.| ### Bug Fixes | ||
|
|
||
| * Set cross-origin to anonymous on elements to allow for audio analysis using web audio api ([34022a4](https://github.com/jkeen/ember-stereo/commit/34022a45a8aa7510783d6cbcac8a0fbd9733f46b)) | ||
| - Set cross-origin to anonymous on elements to allow for audio analysis using web audio api ([34022a4](https://github.com/jkeen/ember-stereo/commit/34022a45a8aa7510783d6cbcac8a0fbd9733f46b)) |
There was a problem hiding this comment.
The abbreviation "api" should be capitalized as "API" for consistency with standard abbreviations.
- Set cross-origin to anonymous on elements to allow for audio analysis using web audio api
+ Set cross-origin to anonymous on elements to allow for audio analysis using web audio APICommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| - Set cross-origin to anonymous on elements to allow for audio analysis using web audio api ([34022a4](https://github.com/jkeen/ember-stereo/commit/34022a45a8aa7510783d6cbcac8a0fbd9733f46b)) | |
| - Set cross-origin to anonymous on elements to allow for audio analysis using web audio API ([34022a4](https://github.com/jkeen/ember-stereo/commit/34022a45a8aa7510783d6cbcac8a0fbd9733f46b)) |
# [5.0.0-beta.20](v5.0.0-beta.19...v5.0.0-beta.20) (2024-03-18) ### Bug Fixes * if crossorigin=anonymous fails on <audio> element, automatically try removing crossorigin. Resolves CORS issue ([3bbda22](3bbda22)) * Implement proper teardown on sound destruction ([f1d6355](f1d6355)) * only show durationWorkaroundTask error if the task wasn't cancelled ([c5f6b08](c5f6b08)) * Resolve issue introduced in last version when multiple sound position sliders on the same page ([a2dc4bd](a2dc4bd)) * resolve issue when trying to play a sound that is already playing. fixes [#23](#23) ([dc32ba3](dc32ba3)) * Resolve issue where sound-position-progress modifier would not work with howler since howler doesn't emit audio-position-changed events ([77408ff](77408ff)) * Resolve some more bugs with sound-position modifiers ([fb496c3](fb496c3)) * send pause event when releasing control of shared audio element ([f7fec45](f7fec45)) ### Features * Allow xhr option to be passed through to connections, so each connection can handle authenticated requests ([82fc6ad](82fc6ad)) * Fail native audio connection if xhr is passed, as native audio does not support that. ([93dea68](93dea68)) * improve firing resolution of audio-position-changed event. refs [#24](#24) ([0777253](0777253))
# [4.3.0](v4.2.3...v4.3.0) (2023-11-12) ### Features * improve firing resolution of audio-position-changed event. refs [#24](#24) ([0777253](0777253))
## [4.3.1](v4.3.0...v4.3.1) (2024-03-18) ### Bug Fixes * only show durationWorkaroundTask error if the task wasn't cancelled ([6b6410b](6b6410b))
| @@ -0,0 +1,148 @@ | |||
| ember-stereo changelog | |||
There was a problem hiding this comment.
The changelog title should start with an uppercase letter for consistency and readability.
- ember-stereo changelog
+ Ember-Stereo ChangelogCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ember-stereo changelog | |
| Ember-Stereo Changelog |
|
|
||
| ### Bug Fixes | ||
|
|
||
| * if crossorigin=anonymous fails on <audio> element, automatically try removing crossorigin. Resolves CORS issue ([3bbda22](https://github.com/jkeen/ember-stereo/commit/3bbda2277c7d5b74190c6a3adf2a971635053afe)) |
There was a problem hiding this comment.
Capitalize the first word of the sentence for consistency and readability.
- * if crossorigin=anonymous fails on <audio> element, automatically try removing crossorigin. Resolves CORS issue ([3bbda22](https://github.com/jkeen/ember-stereo/commit/3bbda2277c7d5b74190c6a3adf2a971635053afe))
+ * If crossorigin=anonymous fails on <audio> element, automatically try removing crossorigin. Resolves CORS issue ([3bbda22](https://github.com/jkeen/ember-stereo/commit/3bbda2277c7d5b74190c6a3adf2a971635053afe))Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * if crossorigin=anonymous fails on <audio> element, automatically try removing crossorigin. Resolves CORS issue ([3bbda22](https://github.com/jkeen/ember-stereo/commit/3bbda2277c7d5b74190c6a3adf2a971635053afe)) | |
| * If crossorigin=anonymous fails on <audio> element, automatically try removing crossorigin. Resolves CORS issue ([3bbda22](https://github.com/jkeen/ember-stereo/commit/3bbda2277c7d5b74190c6a3adf2a971635053afe)) |
| * Implement proper teardown on sound destruction ([f1d6355](https://github.com/jkeen/ember-stereo/commit/f1d6355c845b43c8f10c93abde5782fe664be1b3)) | ||
| * only show durationWorkaroundTask error if the task wasn't cancelled ([c5f6b08](https://github.com/jkeen/ember-stereo/commit/c5f6b080529f1e32af65dd9c8dc87f959b2da46f)) | ||
| * Resolve issue introduced in last version when multiple sound position sliders on the same page ([a2dc4bd](https://github.com/jkeen/ember-stereo/commit/a2dc4bdb9f8313d72f98731f729c896b8e398b31)) | ||
| * resolve issue when trying to play a sound that is already playing. fixes [#23](https://github.com/jkeen/ember-stereo/issues/23) ([dc32ba3](https://github.com/jkeen/ember-stereo/commit/dc32ba3aae8f751144430a28ff9567ca0c5e118a)) |
There was a problem hiding this comment.
Capitalize the first word of the sentence and the word "fixes" for consistency and readability.
- * resolve issue when trying to play a sound that is already playing. fixes [#23](https://github.com/jkeen/ember-stereo/issues/23) ([dc32ba3](https://github.com/jkeen/ember-stereo/commit/dc32ba3aae8f751144430a28ff9567ca0c5e118a))
+ * Resolve issue when trying to play a sound that is already playing. Fixes [#23](https://github.com/jkeen/ember-stereo/issues/23) ([dc32ba3](https://github.com/jkeen/ember-stereo/commit/dc32ba3aae8f751144430a28ff9567ca0c5e118a))Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * resolve issue when trying to play a sound that is already playing. fixes [#23](https://github.com/jkeen/ember-stereo/issues/23) ([dc32ba3](https://github.com/jkeen/ember-stereo/commit/dc32ba3aae8f751144430a28ff9567ca0c5e118a)) | |
| * Resolve issue when trying to play a sound that is already playing. Fixes [#23](https://github.com/jkeen/ember-stereo/issues/23) ([dc32ba3](https://github.com/jkeen/ember-stereo/commit/dc32ba3aae8f751144430a28ff9567ca0c5e118a)) |
|
|
||
| * Allow xhr option to be passed through to connections, so each connection can handle authenticated requests ([82fc6ad](https://github.com/jkeen/ember-stereo/commit/82fc6ad9d1cfec1a15cf80960a92d7d9c63f7c0c)) | ||
| * Fail native audio connection if xhr is passed, as native audio does not support that. ([93dea68](https://github.com/jkeen/ember-stereo/commit/93dea688f8023013657c61953ec75f0f59835f5f)) | ||
| * improve firing resolution of audio-position-changed event. refs [#24](https://github.com/jkeen/ember-stereo/issues/24) ([0777253](https://github.com/jkeen/ember-stereo/commit/0777253152bc6e65448a13fca9a71168cc3971c1)) |
There was a problem hiding this comment.
Capitalize the first word of the sentence and the word "refs" for consistency and readability.
- * improve firing resolution of audio-position-changed event. refs [#24](https://github.com/jkeen/ember-stereo/issues/24) ([0777253](https://github.com/jkeen/ember-stereo/commit/0777253152bc6e65448a13fca9a71168cc3971c1))
+ * Improve firing resolution of audio-position-changed event. Refs [#24](https://github.com/jkeen/ember-stereo/issues/24) ([0777253](https://github.com/jkeen/ember-stereo/commit/0777253152bc6e65448a13fca9a71168cc3971c1))Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * improve firing resolution of audio-position-changed event. refs [#24](https://github.com/jkeen/ember-stereo/issues/24) ([0777253](https://github.com/jkeen/ember-stereo/commit/0777253152bc6e65448a13fca9a71168cc3971c1)) | |
| * Improve firing resolution of audio-position-changed event. Refs [#24](https://github.com/jkeen/ember-stereo/issues/24) ([0777253](https://github.com/jkeen/ember-stereo/commit/0777253152bc6e65448a13fca9a71168cc3971c1)) |
|
|
||
| ### Features | ||
|
|
||
| * adjust logic to allow for live streaming HLS files and allowing ([a633c17](https://github.com/jkeen/ember-stereo/commit/a633c17b8204d05a94ea1e98297ab8e20581d846)) |
There was a problem hiding this comment.
Consider using "live-streaming" for clarity and consistency in terminology.
- * adjust logic to allow for live streaming HLS files and allowing
+ * Adjust logic to allow for live-streaming HLS files and allowingCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * adjust logic to allow for live streaming HLS files and allowing ([a633c17](https://github.com/jkeen/ember-stereo/commit/a633c17b8204d05a94ea1e98297ab8e20581d846)) | |
| * Adjust logic to allow for live-streaming HLS files and allowing ([a633c17](https://github.com/jkeen/ember-stereo/commit/a633c17b8204d05a94ea1e98297ab8e20581d846)) |
|
🎉 This PR is included in version 5.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Summary by CodeRabbit
pnpm.ember-stereonow supports multiple identifiers in metadata cache.ember-stereo.load-soundandpause-soundbuttons in README.CONTRIBUTING.mdto recommendpnpm installovernpm install.ember-stereofor better understanding.ember-stereohelpers and utilities to use relative paths.sound-proxy.jsto useidentifierinstead ofurlfor sound identification..gitignorefor directories withdistin their names.