mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2024-12-25 04:34:06 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

refactor(core): Port external storage config (no-changelog) (#10169)

Browse source
This commit is contained in:
Iván Ovejero 2024-07-24 13:08:20 +02:00 committed by GitHub
parent f1a3791abc
commit 66c49bb6a1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 71 additions and 60 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
packages/@n8n/config/src/configs/external-storage.ts Normal file
View file

@ -0,0 +1,42 @@
import { Config, Env, Nested } from '../decorators';
@Config
class S3BucketConfig {
/** Name of the n8n bucket in S3-compatible external storage */
@Env('N8N_EXTERNAL_STORAGE_S3_BUCKET_NAME')
readonly name: string = '';
/** Region of the n8n bucket in S3-compatible external storage @example "us-east-1" */
@Env('N8N_EXTERNAL_STORAGE_S3_BUCKET_REGION')
readonly region: string = '';
}
@Config
class S3CredentialsConfig {
/** Access key in S3-compatible external storage */
@Env('N8N_EXTERNAL_STORAGE_S3_ACCESS_KEY')
readonly accessKey: string = '';
/** Access secret in S3-compatible external storage */
@Env('N8N_EXTERNAL_STORAGE_S3_ACCESS_SECRET')
readonly accessSecret: string = '';
}
@Config
class S3Config {
/** Host of the n8n bucket in S3-compatible external storage @example "s3.us-east-1.amazonaws.com" */
@Env('N8N_EXTERNAL_STORAGE_S3_HOST')
readonly host: string = '';
@Nested
readonly bucket: S3BucketConfig;
@Nested
readonly credentials: S3CredentialsConfig;
}
@Config
export class ExternalStorageConfig {
@Nested
readonly s3: S3Config;
}

20
packages/@n8n/config/src/index.ts
View file

@ -8,6 +8,7 @@ import { ExternalSecretsConfig } from './configs/external-secrets';
import { TemplatesConfig } from './configs/templates';
import { EventBusConfig } from './configs/event-bus';
import { NodesConfig } from './configs/nodes';
import { ExternalStorageConfig } from './configs/external-storage';
@Config
class UserManagementConfig {
@ -18,29 +19,32 @@ class UserManagementConfig {
@Config
export class GlobalConfig {
@Nested
database: DatabaseConfig;
readonly database: DatabaseConfig;
@Nested
credentials: CredentialsConfig;
readonly credentials: CredentialsConfig;
@Nested
userManagement: UserManagementConfig;
readonly userManagement: UserManagementConfig;
@Nested
versionNotifications: VersionNotificationsConfig;
readonly versionNotifications: VersionNotificationsConfig;
@Nested
publicApi: PublicApiConfig;
readonly publicApi: PublicApiConfig;
@Nested
externalSecrets: ExternalSecretsConfig;
readonly externalSecrets: ExternalSecretsConfig;
@Nested
templates: TemplatesConfig;
readonly templates: TemplatesConfig;
@Nested
eventBus: EventBusConfig;
readonly eventBus: EventBusConfig;
@Nested
readonly nodes: NodesConfig;
@Nested
readonly externalStorage: ExternalStorageConfig;
}

13
packages/@n8n/config/test/config.test.ts
View file

@ -122,6 +122,19 @@ describe('GlobalConfig', () => {
endpoint: 'https://api.n8n.io/api/versions/',
infoUrl: 'https://docs.n8n.io/hosting/installation/updating/',
},
externalStorage: {
s3: {
host: '',
bucket: {
name: '',
region: '',
},
credentials: {
accessKey: '',
accessSecret: '',
},
},
},
};
it('should use all default values when no env variables are defined', () => {

17
packages/cli/src/commands/BaseCommand.ts
View file

@ -44,6 +44,8 @@ export abstract class BaseCommand extends Command {
protected license: License;
private globalConfig = Container.get(GlobalConfig);
/**
* How long to wait for graceful shutdown before force killing the process.
*/
@ -79,8 +81,7 @@ export abstract class BaseCommand extends Command {
await this.exitWithCrash('There was an error running database migrations', error),
);
const globalConfig = Container.get(GlobalConfig);
const { type: dbType } = globalConfig.database;
const { type: dbType } = this.globalConfig.database;
if (['mysqldb', 'mariadb'].includes(dbType)) {
this.logger.warn(
@ -199,7 +200,7 @@ export abstract class BaseCommand extends Command {
private async _initObjectStoreService(options = { isReadOnly: false }) {
const objectStoreService = Container.get(ObjectStoreService);
const host = config.getEnv('externalStorage.s3.host');
const { host, bucket, credentials } = this.globalConfig.externalStorage.s3;
if (host === '') {
throw new ApplicationError(
@ -207,11 +208,6 @@ export abstract class BaseCommand extends Command {
);
}
const bucket = {
name: config.getEnv('externalStorage.s3.bucket.name'),
region: config.getEnv('externalStorage.s3.bucket.region'),
};
if (bucket.name === '') {
throw new ApplicationError(
'External storage bucket name not configured. Please set `N8N_EXTERNAL_STORAGE_S3_BUCKET_NAME`.',
@ -224,11 +220,6 @@ export abstract class BaseCommand extends Command {
);
}
const credentials = {
accessKey: config.getEnv('externalStorage.s3.credentials.accessKey'),
accessSecret: config.getEnv('externalStorage.s3.credentials.accessSecret'),
};
if (credentials.accessKey === '') {
throw new ApplicationError(
'External storage access key not configured. Please set `N8N_EXTERNAL_STORAGE_S3_ACCESS_KEY`.',

39
packages/cli/src/config/schema.ts
View file

@ -671,45 +671,6 @@ export const schema = {
},
},
externalStorage: {
s3: {
host: {
format: String,
default: '',
env: 'N8N_EXTERNAL_STORAGE_S3_HOST',
doc: 'Host of the n8n bucket in S3-compatible external storage, e.g. `s3.us-east-1.amazonaws.com`',
},
bucket: {
name: {
format: String,
default: '',
env: 'N8N_EXTERNAL_STORAGE_S3_BUCKET_NAME',
doc: 'Name of the n8n bucket in S3-compatible external storage',
},
region: {
format: String,
default: '',
env: 'N8N_EXTERNAL_STORAGE_S3_BUCKET_REGION',
doc: 'Region of the n8n bucket in S3-compatible external storage, e.g. `us-east-1`',
},
},
credentials: {
accessKey: {
format: String,
default: '',
env: 'N8N_EXTERNAL_STORAGE_S3_ACCESS_KEY',
doc: 'Access key in S3-compatible external storage',
},
accessSecret: {
format: String,
default: '',
env: 'N8N_EXTERNAL_STORAGE_S3_ACCESS_SECRET',
doc: 'Access secret in S3-compatible external storage',
},
},
},
},
deployment: {
type: {
format: String,