Migration Guide: Extensibility and Node 12
On December 31, 2019, Node.js v8 went out of long-term support (LTS), which means that the Node.js development team no longer back-ports critical security fixes to this version. This could expose your extensibility code to security vulnerabilities.
As such, Auth0 is migrating from Node 8 to Node 12.
In this document, we:
- Provide recommendations on how you can ensure a smooth migration for your environment
- Detail the specific modules affected
Summary of the migration
The Webtask runtime powering the following Auth0 features use Node 8:
- Custom database connections
- Custom social connections
If you do not use any of the extensibility features mentioned above, you are not affected by this migration.
As part of this migration, the Auth0 development team has performed extensive testing to proactively detect any breaking changes.
Verified extensions for Node 12 include:
- Realtime Webtask Logs
- Deploy extensions (Github, Gitlab, etc.)
- Deploy CLI
Still, there may be behavioral changes as a result of this migration, so we have provided a migration switch that allows you to control the migration of your environment to the new Webtask runtime using Node 12.
Enable the Node 12 runtime
Node 12 can be enabled through the new Extensibility panel on the Advanced Tenant Settings page of the Dashboard.
Whitelist the new URLs
The Delegated Administration Extension and the Single Sign-on (SSO) Dashboard Extension require whitelisting the URLs used to access extensions and custom webtasks. When you upgrade to Node 12, the URLs you use to access extensions and custom webtasks will change. This is a breaking change for these extensions.
If you use any of these extensions, you must whitelist the new URLs both as Allowed Callback and as Allowed Logout URLs.
The region portion of the URL will change from 8 to 12. If you access an extension using the URL
https://YOUR_TENANT.us8.webtask.io/dummy-extension-url, when you upgrade to Node 12 the URL will be
To do so, go to Dashboard > Applications > Settings, and add the URL to the fields Allowed Callback URLs and Allowed Logout URLs.
The execution URLs will also change for custom webtasks in your Auth0 container. You must update any external applications that call those webtasks.
If you use the Authorization Extension, it generates an
auth0-authorization-extension rule. Republishing this rule from within the Authorization Extension will update the URLs automatically.
To ensure a clean upgrade:
- Ensure you have upgraded to the latest version of the Authorization Extension from the "Installed Extensions" tab. If the upgrade button is present, click to upgrade. If the button is not present, you are already on the latest version of the extension.
- Open the Authorization Extension configuration page.
- To update the URL in the rule, publish the rule again by clicking the "Publish Rule" button.
- Test to make sure everything is still working.
- If you see an "Invalid API Key" error after updating, use the "Rotate" button to generate a new API key.
Delegated Administration URLs
If you use the Delegated Administration Extension, the matrix that follows contains the updated URLs you must configure after you migrate to Node 12. The URL varies based on your location.
|Location||Allowed Callback URL for Node 12||Allowed Logout URL for Node 12|
For example, if you are located in the USA and you use the Delegated Administration, you should update the following fields in your application's settings:
- Allowed Callback URLs:
- Allowed Logout URLs:
SSO Dashboard URLs
The matrix that follows contains the updated URLs you must configure after you migrate to Node 12. The URL varies based on your location.
The login URL for Admins:
|Location||Allowed Callback URL|
The login URL for Users:
|Location||Allowed Callback URL|
Most extensions use the
PUBLIC_WT_URL hidden secret for authorization. This secret depends on the runtime version and does not update automatically.
To update it, you need to save the extension's settings (no changes are necessary). To do so, after switching the runtime to
Node 12, you need to open the extension's settings in the extensions dashboard (gear icon) and hit
Save. After that, the extensions gallery will update the
PUBLIC_WT_URL secret accordingly based on the selected runtime.
If you do not update the
PUBLIC_WT_URL hidden secret, you will receive the following error:
How to ensure a stable migration
As part of the process of introducing Node 12 in our Webtask runtime, we ran a number of tests to determine which modules are not forward-compatible from Node 8 to 12. Most customers should be able to upgrade to Node 12 without any issues.
With that said, before you migrate, we highly recommend testing all of your:
- Custom Database Connections/Scripts
- Custom Social Connections
Furthermore, we recommend that the testing be done in your development tenant and migrating your production tenant only if you see no issues in development.
You can query the Management API for your Rules, Hooks, Custom Database scripts, and Custom Social Connections. This will make it easier for you to move items from your production tenant to development tenant for testing purposes.
When using the Connections endpoints in the Management API, Custom Database Scripts can be retrieved or updated using
Similarly, you can find Custom Social Connections in
If you are using the following built-in modules (that is, modules that you did not explicitly require), please be aware that some versions were updated to work with Node 12. The following table summarizes the changes.
|Module name||Old version||New version|
These new versions should remain backwards compatible with their previous versions.
If you have manually pinned modules, you may need to manually update them so that your code runs with Node 12.
For example, you must change
var bcrypt = require(‘firstname.lastname@example.org’);
var bcrypt = require(‘bcrypt’);
or, if the module must be pinned to a specific version:
var bcrypt = require(‘email@example.com’);