-
-
Notifications
You must be signed in to change notification settings - Fork 496
/
MetadataDiscovery.ts
266 lines (211 loc) · 9.32 KB
/
MetadataDiscovery.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
import { sync as globby } from 'globby';
import { EntityClass, EntityClassGroup, EntityMetadata, EntityProperty, IEntityType } from '../decorators';
import { EntityManager } from '../EntityManager';
import { Configuration, Logger, Utils } from '../utils';
import { MetadataValidator } from './MetadataValidator';
import { MetadataStorage } from './MetadataStorage';
import { Cascade, EntityHelper, ReferenceType } from '../entity';
export class MetadataDiscovery {
private readonly metadata = MetadataStorage.getMetadata();
private readonly namingStrategy = this.config.getNamingStrategy();
private readonly metadataProvider = this.config.getMetadataProvider();
private readonly cache = this.config.getCacheAdapter();
private readonly platform = this.em.getDriver().getPlatform();
private readonly validator = new MetadataValidator();
private readonly discovered: EntityMetadata[] = [];
constructor(private readonly em: EntityManager,
private readonly config: Configuration,
private readonly logger: Logger) { }
async discover(): Promise<Record<string, EntityMetadata>> {
const startTime = Date.now();
this.logger.debug(`ORM entity discovery started`);
this.discovered.length = 0;
if (this.config.get('entities').length > 0) {
await Promise.all(this.config.get('entities').map(entity => this.discoverEntity(entity)));
} else if (process.argv[0].endsWith('ts-node')) {
await Promise.all(this.config.get('entitiesDirsTs').map(dir => this.discoverDirectory(dir)));
} else {
await Promise.all(this.config.get('entitiesDirs').map(dir => this.discoverDirectory(dir)));
}
// ignore base entities (not annotated with @Entity)
const filtered = this.discovered.filter(meta => meta.name);
filtered.forEach(meta => this.defineBaseEntityProperties(meta));
filtered.forEach(meta => this.discovered.push(...this.processEntity(meta)));
const diff = Date.now() - startTime;
this.logger.debug(`- entity discovery finished after ${diff} ms`);
const discovered: Record<string, EntityMetadata> = {};
this.discovered
.filter(meta => meta.name)
.forEach(meta => discovered[meta.name] = meta );
return discovered;
}
private async discoverDirectory(basePath: string): Promise<void> {
const files = globby('*', { cwd: `${this.config.get('baseDir')}/${basePath}` });
this.logger.debug(`- processing ${files.length} files from directory ${basePath}`);
for (const file of files) {
if (
!file.match(/\.[jt]s$/) ||
file.endsWith('.js.map') ||
file.endsWith('.d.ts') ||
file.startsWith('.') ||
file.match(/index\.[jt]s$/)
) {
this.logger.debug(`- ignoring file ${file}`);
continue;
}
const name = this.getClassName(file);
const path = `${this.config.get('baseDir')}/${basePath}/${file}`;
const target = require(path)[name]; // include the file to trigger loading of metadata
await this.discoverEntity(target, path);
}
}
private async discoverEntity<T extends IEntityType<T>>(entity: EntityClass<T> | EntityClassGroup<T>, path?: string): Promise<void> {
entity = this.metadataProvider.prepare(entity);
this.logger.debug(`- processing entity ${entity.name}`);
const meta = MetadataStorage.getMetadata(entity.name);
const cache = this.cache.get(entity.name);
meta.prototype = entity.prototype;
meta.path = path || meta.path;
meta.toJsonParams = Utils.getParamNames(entity.prototype.toJSON || '');
if (cache) {
this.logger.debug(`- using cached metadata for entity ${entity.name}`);
this.metadataProvider.loadFromCache(meta, cache);
this.discovered.push(meta);
return;
}
await this.metadataProvider.loadEntityMetadata(meta, entity.name);
if (!meta.collection && meta.name) {
meta.collection = this.namingStrategy.classToTableName(meta.name);
}
this.saveToCache(meta, entity);
this.discovered.push(meta);
}
private saveToCache<T extends IEntityType<T>>(meta: EntityMetadata, entity: EntityClass<T>): void {
const copy = Object.assign({}, meta);
delete copy.prototype;
// base entity without properties might not have path, but nothing to cache there
if (meta.path) {
this.cache.set(entity.name, copy, meta.path);
}
}
private applyNamingStrategy(meta: EntityMetadata, prop: EntityProperty): void {
if (prop.reference === ReferenceType.MANY_TO_ONE && !prop.fk) {
prop.fk = meta.properties[meta.primaryKey].fieldName;
}
if (!prop.fieldName) {
this.initFieldName(prop);
}
if (prop.reference === ReferenceType.MANY_TO_MANY) {
this.initManyToManyFields(meta, prop);
}
if (prop.reference === ReferenceType.ONE_TO_MANY) {
this.initOneToManyFields(meta, prop);
}
}
private initFieldName(prop: EntityProperty): void {
if (prop.reference === ReferenceType.SCALAR) {
prop.fieldName = this.namingStrategy.propertyToColumnName(prop.name);
} else if (prop.reference === ReferenceType.MANY_TO_ONE) {
prop.fieldName = this.initManyToOneFieldName(prop, prop.name);
} else if (prop.reference === ReferenceType.MANY_TO_MANY && prop.owner) {
prop.fieldName = this.namingStrategy.propertyToColumnName(prop.name);
}
}
private initManyToOneFieldName(prop: EntityProperty, name: string): string {
const meta2 = this.metadata[prop.type];
const referenceColumnName = meta2.properties[meta2.primaryKey].fieldName;
return this.namingStrategy.joinKeyColumnName(name, referenceColumnName);
}
private initManyToManyFields(meta: EntityMetadata, prop: EntityProperty): void {
if (!prop.pivotTable && prop.owner) {
prop.pivotTable = this.namingStrategy.joinTableName(meta.name, prop.type, prop.name);
}
if (!prop.referenceColumnName) {
prop.referenceColumnName = meta.properties[meta.primaryKey].fieldName;
}
if (!prop.inverseJoinColumn) {
prop.inverseJoinColumn = this.initManyToOneFieldName(prop, prop.type);
}
if (!prop.joinColumn) {
prop.joinColumn = this.namingStrategy.joinKeyColumnName(meta.name, prop.referenceColumnName);
}
}
private initOneToManyFields(meta: EntityMetadata, prop: EntityProperty): void {
if (!prop.joinColumn && prop.reference === ReferenceType.ONE_TO_MANY) {
prop.joinColumn = this.namingStrategy.joinColumnName(prop.name);
}
if (!prop.referenceColumnName) {
prop.referenceColumnName = meta.properties[meta.primaryKey].fieldName;
}
}
private processEntity(meta: EntityMetadata): EntityMetadata[] {
this.defineBaseEntityProperties(meta);
this.validator.validateEntityDefinition(this.metadata, meta.name);
Object.values(meta.properties).forEach(prop => this.applyNamingStrategy(meta, prop));
meta.serializedPrimaryKey = this.platform.getSerializedPrimaryKeyField(meta.primaryKey);
if (!Utils.isEntity(meta.prototype)) {
EntityHelper.decorate(meta, this.em);
}
const ret: EntityMetadata[] = [];
if (this.platform.usesPivotTable()) {
Object.values(meta.properties).forEach(prop => {
const pivotMeta = this.definePivotTableEntity(meta, prop);
if (pivotMeta) {
ret.push(pivotMeta);
}
});
}
return ret;
}
private definePivotTableEntity(meta: EntityMetadata, prop: EntityProperty): EntityMetadata | undefined {
if (prop.reference === ReferenceType.MANY_TO_MANY && prop.owner && prop.pivotTable) {
const pk = this.namingStrategy.referenceColumnName();
const primaryProp = { name: pk, type: 'number', reference: ReferenceType.SCALAR, primary: true } as EntityProperty;
this.initFieldName(primaryProp);
return this.metadata[prop.pivotTable] = {
name: prop.pivotTable,
collection: prop.pivotTable,
primaryKey: pk,
properties: {
[pk]: primaryProp,
[meta.name]: this.definePivotProperty(prop, meta.name),
[prop.type]: this.definePivotProperty(prop, prop.type),
},
} as EntityMetadata;
}
}
private definePivotProperty(prop: EntityProperty, name: string): EntityProperty {
const ret = { name, type: name, reference: ReferenceType.MANY_TO_ONE, cascade: [Cascade.ALL] } as EntityProperty;
if (name === prop.type) {
const meta = this.metadata[name];
const prop2 = meta.properties[meta.primaryKey];
if (!prop2.fieldName) {
this.initFieldName(prop2);
}
ret.referenceColumnName = prop2.fieldName;
ret.fieldName = ret.joinColumn = prop.inverseJoinColumn;
ret.inverseJoinColumn = prop.joinColumn;
} else {
ret.referenceColumnName = prop.referenceColumnName;
ret.fieldName = ret.joinColumn = prop.joinColumn;
ret.inverseJoinColumn = prop.inverseJoinColumn;
}
return ret;
}
private getClassName(file: string): string {
const name = file.split('.')[0];
const ret = name.replace(/-(\w)/, m => m[1].toUpperCase());
return ret.charAt(0).toUpperCase() + ret.slice(1);
}
private defineBaseEntityProperties(meta: EntityMetadata): void {
const base = this.metadata[meta.extends];
if (!meta.extends || !base) {
return;
}
meta.properties = { ...base.properties, ...meta.properties };
const primary = Object.values(meta.properties).find(p => p.primary);
if (primary && !meta.primaryKey) {
meta.primaryKey = primary.name;
}
}
}