This is the official v2.3.0 release. It is dropping a little over a week from Release Candidate 1. We simply wanted to make sure the new CI/CD workflow was functioning before calling the release final. We feel confident that we’re good to mark this release as final. There are no new enhancement or bug fixes in this release from 2.3.0.rc.1.
If should be an easy upgrade, just swap out the wheels folder.
Please refer to release 2.3.0.rc.1 for details.
This version has been cooking for a while and there have been many contributors. But since this is my first release a the helm with a new CI pipeline in place, I felt more comfortable doing a Release Candidate first.
If should be an easy upgrade, just swap out the wheels folder.
includeAssociations argument #1080 – [Nikolaj Frey]Debug() usage in plugin test cases #1061 – [Tom King]ValidatesConfirmationOf() now correctly enforces prescence of confirmation property #1070 – [Adam Cameron, Tom King]resource()/resources() now allows empty only property to utilise as non-route parent #1083 – [Brian Ramsey]As you may know, many years ago CFWheels embraced the distribution of Plugins via ForgeBox packages instead of maintaining our own directory. But the framework itself remains illusive. There was some work done in the last few months to put up packages for the framework but those packages were being maintained by hand which made them a show stopper for a long term solution.
Well, thanks to a new CI workflow based on GitHub Actions we now have the building and publishing of the packages fully automated. Giving credit where credit is due, the new workflow borrows heavily from the ColdBox workflow. It used GitHub Actions, Ant, and CommandBox to automate the process.
So what does all this mean for you, let’s cut to the chase. This means you can now install a fresh copy of the framework using the following command:
box install cfwheels-base-templateThis will pull down a copy of the latest stable release of the template files and then pull down a copy of the latest stable release of the framework via package dependencies. In fact the CI workflow mentioned about publishes two packages cfwheels which is the core framework directory and cfwheels-base-template which is all the other files you need to scaffold the framework.
We’ve even backfilled all the prior released versions of the framework all the way back to version 1.0.0. So you can install a particular version of the framework using the following command:
box install [email protected]In addition you can install the bleeding edge which includes all the work in process towards the next major release using:
box install [email protected]And if you ever just need to get a copy of the latest framework files simply use the following command:
box install cfwheelsAll this means that upgrading to a newer version of the framework should be much easier going forward. Frankly you should just need to modify the version of the dependency in the box.json file and issue a box update command. But we’ll document that more fully when we make our next release.
For now please feel free to play with all this package goodness and let us know if we fumbled anything.
It’s been a while coming. Can I blame the pandemic? Lots of nice little tweaks and fixes in this version. Please see the changelog for all details.
If updating from CFWheels 2.1.x:
It should be an easy upgrade , just swap out the wheels folder.
If updating from CFWheels 2.0.x:
wheels folder from the one in the download, and wheels folder, ensure you’ve got a file at events/onabort.cfm and create it if needed.findLast() to findLastOne() (this has been changed due to Lucee 5.3 having a new inbuilt function called findLast() which clashes with the wheels internals)As always, a huge thanks to all contributors – stay safe out there!
Today sees the release of CFWheels 2.1. Only a couple of bug fixes since the beta, so please refer to the changelog for a list of all changes.
Download now (zip)
If updating from CFWheels 2.0.x:
wheels folder from the one in the download, and wheels folder, ensure you’ve got a file at events/onabort.cfm and create it if needed.findLast() to findLastOne() (this has been changed due to Lucee 5.3 having a new inbuilt function called findLast() which clashes with the wheels internals)Happy Easter, and stay safe!
It’s been far too long in the making, but the beta for 2.1 has now arrived! Please do check it out: this should be considered an essential upgrade for anyone on 2.x. A huge thanks to all have contributed!
Make sure to check the “Potenitally Breaking Changes” section below, and please report any bugs.
Probably the most obvious change in 2.1 beta is the new internal user interface. Previously, Wheels internal pages like test outputs and routing tables could accidentally be broken by your app, as they extended your Controller.cfc by default. Now, they’re completely isolated, and have been significantly beefed up to show everything that you might want to look at as a developer.
The new GUI has it’s own dedicated internal routes which can be accessed directly at /wheels/info (assuming you’ve got URL rewriting on) or via the usual links in the debug footer.
It’s made up of six main sections:
This GUI is only available in development mode by default, but can be enabled in other modes – this isn’t recommended, but it can be done if you really need to check the configuration or try and track something specific down. You can enable it via set(enablePublicComponent=true) in your environment specific configuration files.
Next up is some much needed and improved CORS handling. CORS, or Cross-Origin Resource Sharing, will be very familiar to any of you who have a javascript component or fully fledged progressive web app which runs on one domain, but needs to get information from another. A full explanation of CORS is probably beyond the scope of this post, but if you’re thinking of running your own API on a standalone domain where other applications talk to it, you’ll need to be able to handle CORS.
In Wheels 2.0, you could handle CORS requests, but they could only be configured in a very broad way. For instance, the CORS Allow Methods just returned all methods by default in an OPTIONS request, which kinda defeated the whole point.
The CORS Headers – Access-Control-Allow-Origin, Access-Control-Allow-Methods, Access-Control-Allow-Credentials can now be directly set by their respective functions.
However, for most people, a new helper configuration, accessControlAllowMethodsByRoute() will be the single most useful function to set: it allows for automatic matching of available methods for a route and sets the CORS Header Access-Control-Allow-Methods automatically; so now when your OPTIONS request hits your wheels app, it will actually respond with the available methods which are allowed for that resource endpoint. This makes it much easier to diagnose why certain requests might not get through, and means javascript libraries such as axios can respond more appropriately to hitting the wrong URL with the wrong HTTP method.
Redirects can now be put directly in the mapper() routing call, so you can quickly add a simple redirect for a route if you need.
mapFormat can now be set as false, which bypasses the additional ‘.[format]’ routes which were put in by default for each resource. So if you don’t use them, you can now just turn them off, and make your routing table a lot cleaner. This can be set either globally on the mapper() call itself, or on a per resource basis when using resources()
Previously, if you POSTed or PUT/PATCHed json to an endpoint with an array as it’s root element, it would just get ignored, and you’d not be able to access it in the params struct. This has now been changed and if the incoming payload is a json array, it will be available at params._json which matches rails conventions.
You can now change the default flash behaviour to append to an existing key, rather than directly replacing it. To turn on this behaviour, add set(flashAppend=true) to your /config/settings.cfm file. This allows you to more easily collect flash notifications during a request:
flashInsert(success="One");
flashInsert(success="Two");
The plugins system has been reverted back to 1.x behaviour, as it was simply non-performant; more on this in a future post.
Controller.cfc which caused multiple issues. The migrator, test runner and routing GUIs have therefore all been re-written._method)addRecord() and updateRecord() calls – #852 [Charley Contreras]setUpdatedAtOnCreate, softDeleteProperty, timeStampMode, timeStampOnCreateProperty, timeStampOnUpdateProperty) – #852 [Charley Contreras]MSSQL now uses NVARCHAR(max) instead of TEXT #896 [Reuben Brown]allowExplicitTimestamps=true argument – #887 – [Adam Chapman]set(flashAppend=true) option allows for appending of a Flash key instead of replacing – #855 – [Tom King]flashMessages() now checks for an array of strings or just a string and outputs appropriately – #855 – [Tom King]flashInsert() can now accept a one dimensional array – #855 – [Tom King]OR and AND – #765 [Dmitry Yakhnov, Adam Chapman]handle to a valid variable name so it doesn’t break when using dot notation – #846 [Per Djurner]validatesUniquenessOf() check now handles cases when duplicates already exist – #480 [Randall Meeker, Per Djurner]validatesConfirmationOf() now has a caseSensitive argument to optionally perform a case sensitive comparison – #918 [Tom King]sendFile() no longer expands an already expanded directory on ACF2016 – #873 [David Paul Belanger, Tom King, strubenstein]usesLayout() now can be called more than once and properly respects the order called – #891 [David Paul Belanger]Time and Timestamp Column Types – #906 [Reuben Brown]cacheFileChecking to true in development mode – [Adam Chapman, Steve Harvey]params._json – #939 [Tom King]&lock=false in the URL for when reload requests won’t work due to locking – [Per Djurner]redirect argument for GET/PUT/PATCH/POST/DELETE – #847 – [Tom King].[format] based routes can now be turned off in resources() and resource() via mapFormat=false – #899 – [Tom King]mapFormat can now be set as a default in mapper() for all child resources() and resource() calls – #899 – [Tom King]HEAD requests are now aliased to GET requests #860 – [Tom King]includeFilters argument to the processRequest function for skipping execution of filters during controller unit tests – [Adam Chapman]useIndex argument to finders for adding table index hints #864 – [Adam Chapman]GET requests and must be performed via POST #886 – [Tom King]Access-Control-Allow-Origin can now be set either via a simple value or list in accessControlAllowOrigin() #888 [Tom King]Access-Control-Allow-Methods can now be set via accessControlAllowMethods(value) #888 [Tom King]Access-Control-Allow-Credentials can now be turned on via accessControlAllowCredentials(true); #888 [Tom King]accessControlAllowMethodsByRoute() now allows for automatic matching of available methods for a route and sets CORS Header Access-Control-Allow-Methods appropriately #888 [Tom King]accessControlAllowHeaders(value) #888 [Tom King]authenticityToken() function for returning the raw CSRF authenticity token #925 [Adam Chapman]enablePublicComponent, enableMigratorComponent,enablePluginsComponent environment settings to completely disable those features #926 [Tom King]pluginRunner() now removed in favour of 1.x plugin behaviour for performance purposes #916 [Core Team]validateTestPackageMetaData environment setting for skipping test package validation on large test suites #950 [Adam Chapman]migrator.TableDefinition functions to allow singular variant of the columnNames property #922 [Sébastien FOCK CHOW THO]onAbort is now supported via events/onabort.cfm #962 [Brian Ramsey]
Today sees a security release for the 2.x series.
It is strongly recommended to update to CFWheels 2.0.2 if you are running either 2.0.0 or 2.0.1. This issue does not affect 1.x releases. This release introduces a potentially breaking change, so you are encouraged to test your application appropriately before deploying. Thanks to Bryan Welter for bringing it to our attention.
Today sees a maintenance release for the 2.x series.
Download 2.0.1 today to fix the following:
dbname in cfdbinfo calls when using custom database connection string – #822 [Per Djurner]humanize() function – #663 [Chris Peters, Per Djurner, kmd1970]rel attribute for stylesheetlinkTag() – #834 [Michael Diederich]NULL value from a query with NULL support enabled no longer throws an error – #834 [Michael Diederich]Today sees a maintenance release for the 1.4.x series. Please note that as 2.0 is now released, future updates to the 1.x branch will be limited to essential bug fixes only.
Download 1.4.6 today to fix the following:
Ok, it’s been a while, but *finally*, CFWheels 2.0 has gone gold!
install cfwheels (Just downloads and unzips)wheels newinstall cfwheels-cli)Make sure to check the “Breaking Changes” section, and please report any bugs.
Needless to say, this has been a massive undertaking with over 1000 commits, and over a year in the making. The core team wishes to thank all the many contributors, testers, and well, just users of the framework. We think we’re in a pretty strong place to move forward with loads more exciting things in the future.
For a comprehensive list of changes, check the Changelog, but for a quick summary:
Need help upgrading? Check the upgrade notes, and feel free to post questions to the Google Group, or hit us up on the #cfwheels room on the CFML Slack Channel