Invalid URL error with database credentials including special characters invalid for URLs

[karlhorky]

If a .env file has been set up with a PGUSERNAME, PGPASSWORD, PGHOST or PGDATABASE which include special characters that are invalid for usage in a URL, the SafeQL configuration value for databaseUrl that we use (which includes interpolation) will cause unusual problems:

eslint-config-upleveled/index.cjs

Lines 392 to 404 in 29d38f0

	(config.rules)['@ts-safeql/check-sql'] = [
	'error',
	{
	connections: [
	{
	databaseUrl: `postgres://${process.env.PGUSERNAME}:${process.env.PGPASSWORD}@${process.env.PGHOST}:5432/${process.env.PGDATABASE}`,
	tagName: 'sql',
	fieldTransform: 'camel',
	transform: '{type}[]',
	},
	],
	},
	];

Running ESLint or Preflight in such a project will lead to error messages such as TypeError [ERR_INVALID_URL]: Invalid URL:

We could escape the special characters in these values to avoid these types of errors with the interpolation.

TODOs:

• research for an official source (eg. official docs) on which characters need to be escaped in a PostgreSQL URL
• research for an official source (eg. official docs) on how we should escape them. seems like maybe percent-encoding is ok here?