directus/docs/releases/breaking-changes.md

description

description
A list of any actions you may need to take on upgrades of Directus.

Breaking Changes

As we continue to build Directus, we occasionally make changes that change how certain features works. We try and keep these to a minimum, but rest assured we only make them with good reason.

Learn more about Versioning ->

Learn more about Upgrading your Instance ->

Starting with Directus 10.0, here is a list of potential breaking changes with remedial action you may need to take.

Version 10.6.2

Swapped Parameters and Auth Mode for Refresh Method in the SDK

The parameter order for the refresh method and thus also the default auth mode have been swapped in order to work well with both auth modes, cookie and json.

::: code-group

// refresh http request using a cookie
const result = await client.request(refresh('', 'cookie'));

// refresh http request using json
const result = await client.request(refresh(refresh_token));
const result = await client.request(refresh(refresh_token, 'json'));

// refresh http request using a cookie
const result = await client.request(refresh());
const result = await client.request(refresh('cookie'));

// refresh http request using json
const result = await client.request(refresh('json', refresh_token));

:::

Renamed Helper Function in the SDK

The SDK helper function asSearch has been renamed to withSearch for naming consistency in helpers.

Version 10.6

Dropped Support for Custom NPM Modules in the Run Script operation in Flows

Prior to this release, Directus relied on vm2 to run code from Run Script operations in Flows - our automation feature. vm2 is now unmaintained with critical security issues that could potentially allow code to escape the sandbox and potentially access the machine which hosts your Directus project. We have migrated to isolated-vm to allow Flows to continue to run safely.

If you used to rely on axios, node-fetch, or other libraries to make web requests, we strongly recommend migrating to using the Webhook / Request URL operation instead. This operation includes additional security measures, like the IP allow-list that prevents traffic. For other npm packages in Flows, your will need to create a custom operation extension.

Version 10.4

Consolidated Environment Variables for Redis Use

Directus had various different functionalities that required you to use Redis when running Directus in a horizontally scaled environment such as caching, rate-limiting, realtime, and flows. The configuration for these different parts have been combined into a single set of REDIS environment variables that are reused across the system.

::: details Migration/Mitigation

Combine all the *_REDIS environment variables into a single shared one as followed:

::: code-group

CACHE_STORE="redis"
CACHE_REDIS_HOST="127.0.0.1"
CACHE_REDIS_PORT="6379"
...
RATE_LIMITER_STORE="redis"
RATE_LIMITER_REDIS_HOST="127.0.0.1"
RATE_LIMITER_REDIS_PORT="6379"
...
SYNCHRONIZATION_STORE="redis"
SYNCHRONIZATION_REDIS_HOST="127.0.0.1"
SYNCHRONIZATION_REDIS_PORT="6379"
...
MESSENGER_STORE="redis"
MESSENGER_REDIS_HOST="127.0.0.1"
MESSENGER_REDIS_PORT="6379"

REDIS_HOST="127.0.0.1"
REDIS_PORT="6379"

CACHE_STORE="redis"
RATE_LIMITER_STORE="redis"
SYNCHRONIZATION_STORE="redis"
MESSENGER_STORE="redis"

:::

Dropped Support for Memcached

Directus used to support either memory, Redis, or Memcached for caching and rate-limiting storage. Given a deeper integration with Redis, and the low overall usage/adoption of Memcached across Directus installations, we've decided to sunset Memcached in favor of focusing on Redis as the primary solution for pub/sub and hot-storage across load-balanced Directus installations.

Updated Errors Structure for Extensions

As part of standardizing how extensions are built and shipped, you must replace any system exceptions you extracted from exceptions with new errors created within the extension itself. We recommend prefixing the error code with your extension name for improved debugging, but you can keep using the system codes if you relied on that in the past.

::: details Migration/Mitigation

::: code-group

export default (router, { exceptions }) => {
	const { ForbiddenException } = exceptions;

	router.get('/', (req, res) => {
		throw new ForbiddenException();
	});
};

import { createError } from '@directus/errors';

const ForbiddenError = createError('MY_EXTENSION_FORBIDDEN', 'No script kiddies please...');

export default (router) => {
	router.get('/', (req, res) => {
		throw new ForbiddenError();
	});
};

:::

Version 10.2

Removed Fields from Server Info Endpoint

As a security precaution, we have removed the following information from the /server/info endpoint:

• Directus Version
• Node Version and Uptime
• OS Type, Version, Uptime, and Memory