-
-
Notifications
You must be signed in to change notification settings - Fork 528
/
ArrayCollection.ts
272 lines (221 loc) · 7.83 KB
/
ArrayCollection.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
267
268
269
270
271
272
import { inspect } from 'util';
import type { AnyEntity, EntityDTO, EntityProperty, IPrimaryKey, Primary } from '../typings';
import { Reference } from './Reference';
import { wrap } from './wrap';
import { ReferenceType } from '../enums';
import { MetadataError } from '../errors';
import { Utils } from '../utils/Utils';
export class ArrayCollection<T, O> {
protected readonly items = new Set<T>();
protected initialized = true;
protected dirty = false;
protected _count?: number;
private _property?: EntityProperty;
constructor(readonly owner: O & AnyEntity<O>, items?: T[]) {
/* istanbul ignore next */
if (items) {
let i = 0;
this.items = new Set(items);
this.items.forEach(item => this[i++] = item);
}
}
async loadCount(): Promise<number> {
return this.items.size;
}
getItems(): T[] {
return [...this.items];
}
toArray(): EntityDTO<T>[] {
if (this.items.size === 0) {
return [];
}
const meta = this.property.targetMeta!;
const args = [...meta.toJsonParams.map(() => undefined)];
return this.getItems().map(item => wrap(item).toJSON(...args));
}
toJSON(): EntityDTO<T>[] {
return this.toArray();
}
getIdentifiers<U extends IPrimaryKey = Primary<T> & IPrimaryKey>(field?: string): U[] {
const items = this.getItems();
if (items.length === 0) {
return [];
}
field ??= this.property.targetMeta!.serializedPrimaryKey;
return items.map(i => {
if (Utils.isEntity(i[field as keyof T], true)) {
return wrap(i[field as keyof T], true).getPrimaryKey();
}
return i[field as keyof T];
}) as unknown as U[];
}
add(...items: (T | Reference<T>)[]): void {
for (const item of items) {
const entity = Reference.unwrapReference(item);
if (!this.contains(entity, false)) {
this.incrementCount(1);
this[this.items.size] = entity;
this.items.add(entity);
this.propagate(entity, 'add');
}
}
}
set(items: (T | Reference<T>)[]): void {
this.remove(...this.items);
this.add(...items);
}
/**
* @internal
*/
hydrate(items: T[]): void {
for (let i = 0; i < this.items.size; i++) {
delete this[i];
}
this.items.clear();
this._count = 0;
this.add(...items);
}
/**
* Remove specified item(s) from the collection. Note that removing item from collection does necessarily imply deleting the target entity,
* it means we are disconnecting the relation - removing items from collection, not removing entities from database - `Collection.remove()`
* is not the same as `em.remove()`. If we want to delete the entity by removing it from collection, we need to enable `orphanRemoval: true`,
* which tells the ORM we don't want orphaned entities to exist, so we know those should be removed.
*/
remove(...items: (T | Reference<T>)[]): void {
for (const item of items) {
if (!item) {
continue;
}
const entity = Reference.unwrapReference(item);
if (this.items.delete(entity)) {
this.incrementCount(-1);
delete this[this.items.size]; // remove last item
Object.assign(this, [...this.items]); // reassign array access
this.propagate(entity, 'remove');
}
}
}
/**
* Remove all items from the collection. Note that removing items from collection does necessarily imply deleting the target entity,
* it means we are disconnecting the relation - removing items from collection, not removing entities from database - `Collection.remove()`
* is not the same as `em.remove()`. If we want to delete the entity by removing it from collection, we need to enable `orphanRemoval: true`,
* which tells the ORM we don't want orphaned entities to exist, so we know those should be removed.
*/
removeAll(): void {
this.remove(...this.items);
}
/**
* @internal
*/
removeWithoutPropagation(entity: T): void {
if (!this.items.delete(entity)) {
return;
}
this.incrementCount(-1);
delete this[this.items.size];
Object.assign(this, [...this.items]);
}
contains(item: T | Reference<T>, check?: boolean): boolean {
const entity = Reference.unwrapReference(item);
return this.items.has(entity);
}
count(): number {
return this.items.size;
}
isInitialized(fully = false): boolean {
if (fully) {
return this.initialized && [...this.items].every((item: AnyEntity<T>) => item.__helper!.__initialized);
}
return this.initialized;
}
isDirty(): boolean {
return this.dirty;
}
setDirty(dirty = true): void {
this.dirty = dirty;
}
get length(): number {
return this.count();
}
* [Symbol.iterator](): IterableIterator<T> {
for (const item of this.items) {
yield item;
}
}
/**
* @internal
*/
get property(): EntityProperty<T> {
if (!this._property) {
const meta = this.owner.__meta;
/* istanbul ignore if */
if (!meta) {
throw MetadataError.missingMetadata(this.owner.constructor.name);
}
const field = Object.keys(meta.properties).find(k => this.owner[k] === this);
this._property = meta.properties[field!];
}
return this._property!;
}
protected propagate(item: T, method: 'add' | 'remove' | 'takeSnapshot'): void {
if (this.property.owner && this.property.inversedBy) {
this.propagateToInverseSide(item, method);
} else if (!this.property.owner && this.property.mappedBy) {
this.propagateToOwningSide(item, method);
}
}
protected propagateToInverseSide(item: T, method: 'add' | 'remove' | 'takeSnapshot'): void {
const collection = item[this.property.inversedBy as keyof T] as unknown as ArrayCollection<O, T>;
if (this.shouldPropagateToCollection(collection, method)) {
collection[method](this.owner);
}
}
protected propagateToOwningSide(item: T, method: 'add' | 'remove' | 'takeSnapshot'): void {
const collection = item[this.property.mappedBy as keyof T] as unknown as ArrayCollection<O, T>;
if (this.property.reference === ReferenceType.MANY_TO_MANY) {
if (this.shouldPropagateToCollection(collection, method)) {
collection[method](this.owner);
}
} else if (this.property.reference === ReferenceType.ONE_TO_MANY && method !== 'takeSnapshot' && !(this.property.orphanRemoval && method === 'remove')) {
const prop2 = this.property.targetMeta!.properties[this.property.mappedBy];
const owner = prop2.mapToPk ? this.owner.__helper!.getPrimaryKey() : this.owner;
const value = method === 'add' ? owner : null;
// skip if already propagated
if (Reference.unwrapReference(item[this.property.mappedBy]) !== value) {
item[this.property.mappedBy] = value;
}
}
}
protected shouldPropagateToCollection(collection: ArrayCollection<O, T>, method: 'add' | 'remove' | 'takeSnapshot'): boolean {
if (!collection) {
return false;
}
switch (method) {
case 'add':
return !collection.contains(this.owner, false);
case 'remove':
return collection.isInitialized() && collection.contains(this.owner, false);
case 'takeSnapshot':
return collection.isDirty();
}
}
protected incrementCount(value: number) {
if (typeof this._count === 'number') {
this._count += value;
}
}
[inspect.custom](depth: number) {
const object = { ...this };
const hidden = ['items', 'owner', '_property', '_count', 'snapshot', '_populated', '_lazyInitialized'];
hidden.forEach(k => delete object[k]);
const ret = inspect(object, { depth });
const name = `${this.constructor.name}<${this.property.type}>`;
return ret === '[Object]' ? `[${name}]` : name + ' ' + ret;
}
}
Object.defineProperties(ArrayCollection.prototype, {
__collection: { value: true, enumerable: false, writable: false },
});
export interface ArrayCollection<T, O> {
[k: number]: T;
}