phoenix changelog

Hey there, awesome developers! We've got some cool updates and fixes to share with you. Check out the latest changes and improvements we've made to make your coding life a bit easier. 🚀

Improvements

  • Improved Docs for Verified Routes 📚 We’ve given the documentation for verified routes in the Phoenix framework a nice polish. With 27 additions and 21 deletions, the updated docs now better explain macros for building routes, injecting paths and URLs, and generating paths for static assets. These tweaks will help you navigate and use verified routes more effectively.

  • Clearer Argument Name 📝 We’ve enhanced the list function in the Phoenix.Presence module by changing the argument name to socket_or_topic :: Phoenix.Socket.t() | topic. This makes the code more readable and understandable, ensuring you know exactly what’s going on.

  • Closed Back-Tick Fix ✔️ A small but mighty fix: we’ve closed a back-tick in the Phoenix.Token module, correcting a typo in the comment related to cryptographic salts. This ensures consistency and clarity in the code, making it easier to understand and work with token authentication.

Bugfixes

  • Channel Leave on Unjoined Channels 🛠️ We’ve squashed a bug where leaving an unjoined channel would remove all unjoined channels from the socket. Now, only the specific unjoined channel instance is removed, ensuring proper channel management. This fix is reflected in the phoenix.js, phoenix.min.js, priv/static/phoenix.cjs.js, and priv/static/phoenix.mjs files.

  • Release 1.7.12 🐞 Version 1.7.12 is out! This release includes updates to version numbers in various configuration files and some bug fixes for the JavaScript client. The CHANGELOG.md has all the details, ensuring you’re up-to-date with the latest improvements.

Enjoy the updates, and happy coding! 🌟

Included Commits

2024-04-09T18:49:37 See commit

This commit modifies the list function in the Phoenix.Presence module by changing the argument name from Phoenix.Socket.t() | topic to socket_or_topic :: Phoenix.Socket.t() | topic. This change aims to make the argument name clearer and more descriptive, improving the readability and understanding of the function.

The commit involves a simple adjustment in the argument name of the list function within the Phoenix.Presence module. By replacing the previous argument name with a more explicit and descriptive one, the code becomes more understandable and easier to work with for developers working on the project. This change does not alter the functionality of the function itself but enhances the clarity of the codebase.

Files changed

  • lib/phoenix/presence.ex
2024-04-11T12:40:05 See commit

This commit fixes an issue with channel leave on unjoined channels. The changes include modifying the remove method in the Socket class to correctly filter out unjoined channels when channel.leave is called. Previously, all unjoined channels were being removed from the socket when leaving any single unjoined channel instance. The fix ensures that only the specific unjoined channel instance is removed from the socket.

Additionally, the CHANGELOG.md was updated to reflect this bug fix in the JavaScript client. The phoenix.js and phoenix.min.js files were also modified to implement the fix. The priv/static/phoenix.cjs.js and priv/static/phoenix.mjs files were updated as well. Overall, the commit addresses the issue of incorrectly removing unjoined channels from the socket when leaving a single unjoined channel instance, ensuring proper channel management.

Files changed

  • CHANGELOG.md
  • assets/js/phoenix/socket.js
  • priv/static/phoenix.cjs.js
  • priv/static/phoenix.cjs.js.map
  • priv/static/phoenix.js
  • priv/static/phoenix.min.js
  • priv/static/phoenix.mjs
  • priv/static/phoenix.mjs.map
2024-04-11T15:52:45 See commit

The commit for release 1.7.12 includes changes to various files. In the assets/package.json file, the version number was updated from 1.7.11 to 1.7.12. Similarly, in the package.json file, the version number was also updated to 1.7.12. The CHANGELOG.md file was modified to include a new section for version 1.7.12, with a specific date (2024-04-11) and details about JavaScript client bug fixes. Additionally, changes were made to the installer/mix.exs and mix.exs files to update the version number to 1.7.12.

Overall, this commit primarily focused on updating version numbers in various configuration files to reflect the release of version 1.7.12. Additionally, the CHANGELOG.md was updated to include details about bug fixes in the JavaScript client for this version. The changes ensure that the correct version information is reflected across different files and that users are aware of the updates made in this release.

Files changed

  • CHANGELOG.md
  • assets/package-lock.json
  • assets/package.json
  • installer/mix.exs
  • installer/mix.lock
  • mix.exs
  • mix.lock
  • package.json
2024-04-12T07:52:45 See commit

This commit closes a back-tick in the Phoenix.Token module by correcting a typo in the comment. The second argument in the sign and verify functions must have the same cryptographic salt, and the commit fixes a typo in the comment to ensure consistency between encrypt and decrypt calls. The changes made in this commit include modifying one line of code and adding one line of code, resulting in a total of two changes.

Overall, this commit aims to improve the clarity and accuracy of the code by fixing a typo in the comment related to cryptographic salts in the Phoenix.Token module. By ensuring consistency in the naming and usage of cryptographic salts in different functions, the commit enhances the understanding and usability of the code for developers working with token authentication in Phoenix applications.

Files changed

  • lib/phoenix/token.ex
2024-04-12T11:36:22 See commit

This commit improves the documentation for verified routes in the Phoenix framework. The changes involve modifying the lib/phoenix/verified_routes.ex file, with a total of 27 additions and 21 deletions. The changes mainly focus on macros related to building routes, injecting paths and URLs, and generating paths for static assets. The commit includes adjustments to the path and url macros, ensuring that forwarded paths in the main application router are verified correctly. Additionally, there are enhancements to functions like static_url, unverified_url, static_path, and unverified_path, providing more clarity and functionality for generating URLs and paths.

Overall, this commit refines the documentation and functionality of verified routes in Phoenix, making it easier for developers to understand and use these features effectively. By updating the macros and functions related to building routes and handling URLs and paths, the commit aims to enhance the overall user experience when working with verified routes in the Phoenix framework.

Files changed

  • lib/phoenix/verified_routes.ex