@stonyx/orm 0.3.2-beta.15 → 0.3.2-beta.151
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +402 -10
- package/config/environment.js +99 -12
- package/dist/commands.js +34 -0
- package/dist/dynamodb/connection.d.ts +31 -0
- package/dist/dynamodb/connection.js +28 -0
- package/dist/dynamodb/dynamodb-db.d.ts +142 -0
- package/dist/dynamodb/dynamodb-db.js +596 -0
- package/dist/dynamodb/operation-builder.d.ts +76 -0
- package/dist/dynamodb/operation-builder.js +116 -0
- package/dist/dynamodb/type-map.d.ts +31 -0
- package/dist/dynamodb/type-map.js +48 -0
- package/dist/main.js +10 -0
- package/dist/manage-record.js +34 -3
- package/dist/mysql/connection.d.ts +1 -0
- package/dist/mysql/mysql-db.d.ts +8 -0
- package/dist/mysql/mysql-db.js +44 -10
- package/dist/orm-request.d.ts +60 -0
- package/dist/orm-request.js +644 -47
- package/dist/postgres/connection.d.ts +1 -0
- package/dist/postgres/connection.js +8 -6
- package/dist/postgres/postgres-db.d.ts +8 -0
- package/dist/postgres/postgres-db.js +44 -10
- package/dist/record.js +7 -5
- package/dist/relationships.js +1 -1
- package/dist/serializer.js +38 -2
- package/dist/store.d.ts +13 -1
- package/dist/store.js +65 -6
- package/dist/types/orm-types.d.ts +11 -0
- package/package.json +16 -7
- package/src/commands.ts +43 -0
- package/src/dynamodb/connection.ts +50 -0
- package/src/dynamodb/dynamodb-db.ts +811 -0
- package/src/dynamodb/operation-builder.ts +202 -0
- package/src/dynamodb/type-map.ts +54 -0
- package/src/main.ts +10 -0
- package/src/manage-record.ts +41 -9
- package/src/mysql/connection.ts +1 -0
- package/src/mysql/mysql-db.ts +44 -12
- package/src/orm-request.ts +654 -45
- package/src/postgres/connection.ts +10 -6
- package/src/postgres/postgres-db.ts +44 -12
- package/src/record.ts +8 -5
- package/src/relationships.ts +1 -1
- package/src/serializer.ts +39 -2
- package/src/store.ts +68 -6
- package/src/types/orm-types.ts +12 -0
- package/src/types/stonyx.d.ts +7 -1
- package/config/environment.ts +0 -91
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* DynamoDB operation parameter builders.
|
|
3
|
+
*
|
|
4
|
+
* Each function returns a plain-object "params" bag that can be passed
|
|
5
|
+
* directly to the corresponding DocumentClient command
|
|
6
|
+
* (PutCommand, GetCommand, UpdateCommand, DeleteCommand, ScanCommand, QueryCommand).
|
|
7
|
+
*
|
|
8
|
+
* All functions are pure — no SDK imports here; the caller wraps params
|
|
9
|
+
* in the appropriate Command class.
|
|
10
|
+
*/
|
|
11
|
+
/**
|
|
12
|
+
* PutItem — optionally with a condition expression.
|
|
13
|
+
*
|
|
14
|
+
* Pass conditionExpression = 'attribute_not_exists(id)' to enforce uniqueness.
|
|
15
|
+
*/
|
|
16
|
+
export function buildPutItem(tableName, item, conditionExpression) {
|
|
17
|
+
const params = { TableName: tableName, Item: item };
|
|
18
|
+
if (conditionExpression)
|
|
19
|
+
params.ConditionExpression = conditionExpression;
|
|
20
|
+
return params;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* GetItem by primary key.
|
|
24
|
+
*/
|
|
25
|
+
export function buildGetItem(tableName, key) {
|
|
26
|
+
return { TableName: tableName, Key: key };
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* UpdateItem with a SET expression built from the `updates` object.
|
|
30
|
+
* Only the supplied attributes are updated (diff-based call site).
|
|
31
|
+
*/
|
|
32
|
+
export function buildUpdateItem(tableName, key, updates) {
|
|
33
|
+
const names = {};
|
|
34
|
+
const values = {};
|
|
35
|
+
const setClauses = [];
|
|
36
|
+
for (const [attr, val] of Object.entries(updates)) {
|
|
37
|
+
const nameAlias = `#${attr}`;
|
|
38
|
+
const valAlias = `:${attr}`;
|
|
39
|
+
names[nameAlias] = attr;
|
|
40
|
+
values[valAlias] = val;
|
|
41
|
+
setClauses.push(`${nameAlias} = ${valAlias}`);
|
|
42
|
+
}
|
|
43
|
+
return {
|
|
44
|
+
TableName: tableName,
|
|
45
|
+
Key: key,
|
|
46
|
+
UpdateExpression: `SET ${setClauses.join(', ')}`,
|
|
47
|
+
ExpressionAttributeNames: names,
|
|
48
|
+
ExpressionAttributeValues: values,
|
|
49
|
+
ReturnValues: 'NONE',
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* DeleteItem by primary key.
|
|
54
|
+
*/
|
|
55
|
+
export function buildDeleteItem(tableName, key) {
|
|
56
|
+
return { TableName: tableName, Key: key };
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* ScanCommand params.
|
|
60
|
+
* If conditions are supplied they are rendered as a FilterExpression using AND.
|
|
61
|
+
*/
|
|
62
|
+
export function buildScan(tableName, conditions, exclusiveStartKey) {
|
|
63
|
+
const params = { TableName: tableName };
|
|
64
|
+
if (exclusiveStartKey)
|
|
65
|
+
params.ExclusiveStartKey = exclusiveStartKey;
|
|
66
|
+
if (conditions && Object.keys(conditions).length > 0) {
|
|
67
|
+
const validEntries = Object.entries(conditions).filter(([, val]) => val !== undefined && val !== null);
|
|
68
|
+
if (validEntries.length > 0) {
|
|
69
|
+
const names = {};
|
|
70
|
+
const values = {};
|
|
71
|
+
const clauses = [];
|
|
72
|
+
for (const [attr, val] of validEntries) {
|
|
73
|
+
const nameAlias = `#${attr}`;
|
|
74
|
+
const valAlias = `:${attr}`;
|
|
75
|
+
names[nameAlias] = attr;
|
|
76
|
+
values[valAlias] = val;
|
|
77
|
+
clauses.push(`${nameAlias} = ${valAlias}`);
|
|
78
|
+
}
|
|
79
|
+
params.FilterExpression = clauses.join(' AND ');
|
|
80
|
+
params.ExpressionAttributeNames = names;
|
|
81
|
+
params.ExpressionAttributeValues = values;
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
return params;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* QueryCommand params for a GSI.
|
|
88
|
+
* keyConditions must be in the form { attrName: value } and will be rendered
|
|
89
|
+
* as equality expressions joined by AND.
|
|
90
|
+
*/
|
|
91
|
+
export function buildQuery(tableName, indexName, keyConditions, exclusiveStartKey) {
|
|
92
|
+
const validEntries = Object.entries(keyConditions).filter(([, val]) => val !== undefined && val !== null);
|
|
93
|
+
if (validEntries.length === 0) {
|
|
94
|
+
throw new Error('buildQuery: all keyCondition values are undefined/null');
|
|
95
|
+
}
|
|
96
|
+
const names = {};
|
|
97
|
+
const values = {};
|
|
98
|
+
const clauses = [];
|
|
99
|
+
for (const [attr, val] of validEntries) {
|
|
100
|
+
const nameAlias = `#${attr}`;
|
|
101
|
+
const valAlias = `:${attr}`;
|
|
102
|
+
names[nameAlias] = attr;
|
|
103
|
+
values[valAlias] = val;
|
|
104
|
+
clauses.push(`${nameAlias} = ${valAlias}`);
|
|
105
|
+
}
|
|
106
|
+
const params = {
|
|
107
|
+
TableName: tableName,
|
|
108
|
+
IndexName: indexName,
|
|
109
|
+
KeyConditionExpression: clauses.join(' AND '),
|
|
110
|
+
ExpressionAttributeNames: names,
|
|
111
|
+
ExpressionAttributeValues: values,
|
|
112
|
+
};
|
|
113
|
+
if (exclusiveStartKey)
|
|
114
|
+
params.ExclusiveStartKey = exclusiveStartKey;
|
|
115
|
+
return params;
|
|
116
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Maps ORM attribute types to DynamoDB scalar attribute types.
|
|
3
|
+
* DynamoDB DocumentClient auto-marshalls JS objects, so most values
|
|
4
|
+
* are sent as their native JS types. This map is used by the
|
|
5
|
+
* schema-introspector and startup provisioner for table/GSI creation.
|
|
6
|
+
*/
|
|
7
|
+
export type DynamoScalarType = 'S' | 'N' | 'BOOL';
|
|
8
|
+
/**
|
|
9
|
+
* DynamoDB attribute-type string for a given ORM attr type.
|
|
10
|
+
* - string → S
|
|
11
|
+
* - number / float → N (stored as Number; DocumentClient handles it)
|
|
12
|
+
* - boolean → BOOL
|
|
13
|
+
* - date → S (ISO-8601 string — enables range queries)
|
|
14
|
+
* - timestamp → N (milliseconds since epoch)
|
|
15
|
+
* - passthrough/trim/etc → S (safe default)
|
|
16
|
+
*
|
|
17
|
+
* For key schema declarations only `S` and `N` are valid; BOOL
|
|
18
|
+
* is legal for attributes but never for a PK/SK.
|
|
19
|
+
*/
|
|
20
|
+
declare const typeMap: Record<string, DynamoScalarType>;
|
|
21
|
+
/**
|
|
22
|
+
* Returns the DynamoDB attribute type for a given ORM type string.
|
|
23
|
+
* Defaults to 'S' for any unknown/custom type.
|
|
24
|
+
*/
|
|
25
|
+
export declare function getDynamoType(attrType: string): DynamoScalarType;
|
|
26
|
+
/**
|
|
27
|
+
* Returns the DynamoDB key type ('S' | 'N') for use in KeySchema.
|
|
28
|
+
* BOOL cannot be a key attribute; anything that maps to BOOL falls back to 'S'.
|
|
29
|
+
*/
|
|
30
|
+
export declare function getDynamoKeyType(attrType: string): 'S' | 'N';
|
|
31
|
+
export default typeMap;
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Maps ORM attribute types to DynamoDB scalar attribute types.
|
|
3
|
+
* DynamoDB DocumentClient auto-marshalls JS objects, so most values
|
|
4
|
+
* are sent as their native JS types. This map is used by the
|
|
5
|
+
* schema-introspector and startup provisioner for table/GSI creation.
|
|
6
|
+
*/
|
|
7
|
+
/**
|
|
8
|
+
* DynamoDB attribute-type string for a given ORM attr type.
|
|
9
|
+
* - string → S
|
|
10
|
+
* - number / float → N (stored as Number; DocumentClient handles it)
|
|
11
|
+
* - boolean → BOOL
|
|
12
|
+
* - date → S (ISO-8601 string — enables range queries)
|
|
13
|
+
* - timestamp → N (milliseconds since epoch)
|
|
14
|
+
* - passthrough/trim/etc → S (safe default)
|
|
15
|
+
*
|
|
16
|
+
* For key schema declarations only `S` and `N` are valid; BOOL
|
|
17
|
+
* is legal for attributes but never for a PK/SK.
|
|
18
|
+
*/
|
|
19
|
+
const typeMap = {
|
|
20
|
+
string: 'S',
|
|
21
|
+
number: 'N',
|
|
22
|
+
float: 'N',
|
|
23
|
+
boolean: 'BOOL',
|
|
24
|
+
date: 'S',
|
|
25
|
+
timestamp: 'N',
|
|
26
|
+
passthrough: 'S',
|
|
27
|
+
trim: 'S',
|
|
28
|
+
uppercase: 'S',
|
|
29
|
+
ceil: 'N',
|
|
30
|
+
floor: 'N',
|
|
31
|
+
round: 'N',
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* Returns the DynamoDB attribute type for a given ORM type string.
|
|
35
|
+
* Defaults to 'S' for any unknown/custom type.
|
|
36
|
+
*/
|
|
37
|
+
export function getDynamoType(attrType) {
|
|
38
|
+
return typeMap[attrType] ?? 'S';
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Returns the DynamoDB key type ('S' | 'N') for use in KeySchema.
|
|
42
|
+
* BOOL cannot be a key attribute; anything that maps to BOOL falls back to 'S'.
|
|
43
|
+
*/
|
|
44
|
+
export function getDynamoKeyType(attrType) {
|
|
45
|
+
const t = getDynamoType(attrType);
|
|
46
|
+
return t === 'N' ? 'N' : 'S';
|
|
47
|
+
}
|
|
48
|
+
export default typeMap;
|
package/dist/main.js
CHANGED
|
@@ -54,6 +54,10 @@ export default class Orm {
|
|
|
54
54
|
Orm.instance = this;
|
|
55
55
|
}
|
|
56
56
|
async init() {
|
|
57
|
+
// Self-register so log.db works even when @stonyx/orm is in the
|
|
58
|
+
// consumer's `dependencies` (stonyx loader only merges devDependencies).
|
|
59
|
+
const { logColor = 'white', logMethod = 'db' } = config.orm;
|
|
60
|
+
log.defineType(logMethod, logColor);
|
|
57
61
|
const { paths, restServer } = config.orm;
|
|
58
62
|
const promises = ['Model', 'Serializer', 'Transform'].map(type => {
|
|
59
63
|
const lowerCaseType = type.toLowerCase();
|
|
@@ -115,6 +119,12 @@ export default class Orm {
|
|
|
115
119
|
this.db = this.sqlDb;
|
|
116
120
|
promises.push(this.sqlDb.init());
|
|
117
121
|
}
|
|
122
|
+
else if (config.orm.dynamodb) {
|
|
123
|
+
const { default: DynamoDBDB } = await import('./dynamodb/dynamodb-db.js');
|
|
124
|
+
this.sqlDb = new DynamoDBDB();
|
|
125
|
+
this.db = this.sqlDb;
|
|
126
|
+
promises.push(this.sqlDb.init());
|
|
127
|
+
}
|
|
118
128
|
else if (this.options.dbType !== 'none') {
|
|
119
129
|
const db = new DB();
|
|
120
130
|
this.db = db;
|
package/dist/manage-record.js
CHANGED
|
@@ -52,13 +52,34 @@ export function createRecord(modelName, rawData = {}, userOptions = {}) {
|
|
|
52
52
|
relationship.push(record);
|
|
53
53
|
pendingHasMany.splice(0);
|
|
54
54
|
}
|
|
55
|
+
// FK-based inverse hasMany wiring — when a child record is created with a
|
|
56
|
+
// foreign-key field (e.g. `owner: 'owner-1'` on an animal), find any parent
|
|
57
|
+
// whose hasMany registry targets this model and push the child into the
|
|
58
|
+
// parent's shared array. This covers edge cases where the child is created
|
|
59
|
+
// in a separate async frame without a belongsTo handler firing.
|
|
60
|
+
const hasManyReg = getHasManyRegistry();
|
|
61
|
+
if (hasManyReg) {
|
|
62
|
+
for (const [parentModelName, targetMap] of hasManyReg) {
|
|
63
|
+
const childArrayMap = targetMap.get(modelName);
|
|
64
|
+
if (!childArrayMap)
|
|
65
|
+
continue;
|
|
66
|
+
// Check if rawData contains a FK field matching the parent model name
|
|
67
|
+
const fkValue = rawData[parentModelName];
|
|
68
|
+
if (fkValue === undefined || fkValue === null)
|
|
69
|
+
continue;
|
|
70
|
+
const parentArray = childArrayMap.get(fkValue);
|
|
71
|
+
if (parentArray && !parentArray.includes(record)) {
|
|
72
|
+
parentArray.push(record);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
}
|
|
55
76
|
// Fulfill pending belongsTo relationships
|
|
56
77
|
const pendingBelongsToQueue = getPendingBelongsToRegistry();
|
|
57
78
|
const pendingBelongsToRaw = pendingBelongsToQueue.get(modelName)?.get(record.id);
|
|
58
79
|
const pendingBelongsTo = Array.isArray(pendingBelongsToRaw) ? pendingBelongsToRaw : undefined;
|
|
59
80
|
if (pendingBelongsTo) {
|
|
60
81
|
const belongsToReg = getBelongsToRegistry();
|
|
61
|
-
const
|
|
82
|
+
const pendingHasManyReg = getHasManyRegistry();
|
|
62
83
|
for (const { sourceRecord, sourceModelName, relationshipKey, relationshipId } of pendingBelongsTo) {
|
|
63
84
|
// Update the belongsTo relationship on the source record
|
|
64
85
|
sourceRecord.__relationships[relationshipKey] = record;
|
|
@@ -72,7 +93,7 @@ export function createRecord(modelName, rawData = {}, userOptions = {}) {
|
|
|
72
93
|
}
|
|
73
94
|
}
|
|
74
95
|
// Wire inverse hasMany if it exists
|
|
75
|
-
const inverseHasMany =
|
|
96
|
+
const inverseHasMany = pendingHasManyReg.get(modelName)?.get(sourceModelName)?.get(record.id);
|
|
76
97
|
if (inverseHasMany && !inverseHasMany.includes(sourceRecord)) {
|
|
77
98
|
inverseHasMany.push(sourceRecord);
|
|
78
99
|
}
|
|
@@ -83,14 +104,24 @@ export function createRecord(modelName, rawData = {}, userOptions = {}) {
|
|
|
83
104
|
// Auto-persist to SQL — skip for DB loads (isDbRecord) and relationship resolution (_relationshipKey)
|
|
84
105
|
const shouldPersist = orm?.sqlDb && !options.isDbRecord && !userOptions._relationshipKey && !options._skipAutoPersist;
|
|
85
106
|
if (shouldPersist) {
|
|
107
|
+
// Capture ID before persist — SQL adapters re-key pending IDs to real DB IDs,
|
|
108
|
+
// but relationship registries were keyed with this original ID
|
|
109
|
+
const registryId = record.id;
|
|
86
110
|
const response = { data: { id: record.id } };
|
|
87
|
-
orm.sqlDb.persist('create', modelName, { rawData }, response)
|
|
111
|
+
orm.sqlDb.persist('create', modelName, { rawData }, response)
|
|
112
|
+
.catch((err) => {
|
|
88
113
|
orm.emitPersistError({
|
|
89
114
|
operation: 'create',
|
|
90
115
|
modelName,
|
|
91
116
|
recordId: record.id,
|
|
92
117
|
error: err instanceof Error ? err : new Error(String(err)),
|
|
93
118
|
});
|
|
119
|
+
})
|
|
120
|
+
.finally(() => {
|
|
121
|
+
// Evict non-memory records after persist to prevent unbounded heap growth (stonyx#81)
|
|
122
|
+
if (store._memoryResolver && !store._memoryResolver(modelName)) {
|
|
123
|
+
store.evictRecord(modelName, record.id, registryId);
|
|
124
|
+
}
|
|
94
125
|
});
|
|
95
126
|
}
|
|
96
127
|
return record;
|
|
@@ -8,6 +8,7 @@ interface MysqlConfig {
|
|
|
8
8
|
connectionLimit?: number;
|
|
9
9
|
migrationsTable?: string;
|
|
10
10
|
migrationsDir?: string;
|
|
11
|
+
autoMigrate?: boolean;
|
|
11
12
|
}
|
|
12
13
|
export declare function getPool(mysqlConfig: MysqlConfig): Promise<Pool>;
|
|
13
14
|
export declare function closePool(): Promise<void>;
|
package/dist/mysql/mysql-db.d.ts
CHANGED
|
@@ -61,6 +61,14 @@ export default class MysqlDB {
|
|
|
61
61
|
deps: MysqlDBDeps;
|
|
62
62
|
pool: Pool | null;
|
|
63
63
|
mysqlConfig: MysqlConfig;
|
|
64
|
+
/**
|
|
65
|
+
* Promise-chain mutex for write serialization (#156).
|
|
66
|
+
* All persist() calls chain through this single queue so concurrent
|
|
67
|
+
* fire-and-forget writes never produce parallel InnoDB transactions
|
|
68
|
+
* on FK-linked rows (which cause deadlocks).
|
|
69
|
+
* Reads are NOT affected — only persist() serializes.
|
|
70
|
+
*/
|
|
71
|
+
private _writeQueue;
|
|
64
72
|
constructor(deps?: Partial<MysqlDBDeps>);
|
|
65
73
|
private requirePool;
|
|
66
74
|
init(): Promise<void>;
|
package/dist/mysql/mysql-db.js
CHANGED
|
@@ -26,6 +26,14 @@ export default class MysqlDB {
|
|
|
26
26
|
deps;
|
|
27
27
|
pool;
|
|
28
28
|
mysqlConfig;
|
|
29
|
+
/**
|
|
30
|
+
* Promise-chain mutex for write serialization (#156).
|
|
31
|
+
* All persist() calls chain through this single queue so concurrent
|
|
32
|
+
* fire-and-forget writes never produce parallel InnoDB transactions
|
|
33
|
+
* on FK-linked rows (which cause deadlocks).
|
|
34
|
+
* Reads are NOT affected — only persist() serializes.
|
|
35
|
+
*/
|
|
36
|
+
_writeQueue = Promise.resolve();
|
|
29
37
|
constructor(deps = {}) {
|
|
30
38
|
if (MysqlDB.instance)
|
|
31
39
|
return MysqlDB.instance;
|
|
@@ -57,7 +65,17 @@ export default class MysqlDB {
|
|
|
57
65
|
const pending = files.filter(f => !applied.includes(f));
|
|
58
66
|
if (pending.length > 0) {
|
|
59
67
|
this.deps.log.db?.(`${pending.length} pending migration(s) found.`);
|
|
60
|
-
|
|
68
|
+
let shouldApply;
|
|
69
|
+
if (this.mysqlConfig.autoMigrate === true) {
|
|
70
|
+
shouldApply = true;
|
|
71
|
+
}
|
|
72
|
+
else if (this.mysqlConfig.autoMigrate === false) {
|
|
73
|
+
shouldApply = false;
|
|
74
|
+
this.deps.log.warn?.(`autoMigrate is false — skipping ${pending.length} pending migration(s).`);
|
|
75
|
+
}
|
|
76
|
+
else {
|
|
77
|
+
shouldApply = await this.deps.confirm(`${pending.length} pending migration(s) found. Apply now?`);
|
|
78
|
+
}
|
|
61
79
|
if (shouldApply) {
|
|
62
80
|
for (const filename of pending) {
|
|
63
81
|
const content = await this.deps.readFile(this.deps.path.join(migrationsPath, filename));
|
|
@@ -76,7 +94,17 @@ export default class MysqlDB {
|
|
|
76
94
|
const schemas = this.deps.introspectModels();
|
|
77
95
|
const modelCount = Object.keys(schemas).length;
|
|
78
96
|
if (modelCount > 0) {
|
|
79
|
-
|
|
97
|
+
let shouldGenerate;
|
|
98
|
+
if (this.mysqlConfig.autoMigrate === true) {
|
|
99
|
+
shouldGenerate = true;
|
|
100
|
+
}
|
|
101
|
+
else if (this.mysqlConfig.autoMigrate === false) {
|
|
102
|
+
shouldGenerate = false;
|
|
103
|
+
this.deps.log.warn?.(`autoMigrate is false — skipping initial migration generation for ${modelCount} model(s).`);
|
|
104
|
+
}
|
|
105
|
+
else {
|
|
106
|
+
shouldGenerate = await this.deps.confirm(`No migrations found but ${modelCount} model(s) detected. Generate and apply initial migration?`);
|
|
107
|
+
}
|
|
80
108
|
if (shouldGenerate) {
|
|
81
109
|
const { generateMigration } = await import('./migration-generator.js');
|
|
82
110
|
const result = await generateMigration('initial_setup');
|
|
@@ -302,14 +330,20 @@ export default class MysqlDB {
|
|
|
302
330
|
const Orm = (await import('@stonyx/orm')).default;
|
|
303
331
|
if (Orm.instance?.isView?.(modelName))
|
|
304
332
|
return;
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
333
|
+
const work = async () => {
|
|
334
|
+
switch (operation) {
|
|
335
|
+
case 'create':
|
|
336
|
+
return this._persistCreate(modelName, context, response);
|
|
337
|
+
case 'update':
|
|
338
|
+
return this._persistUpdate(modelName, context, response);
|
|
339
|
+
case 'delete':
|
|
340
|
+
return this._persistDelete(modelName, context);
|
|
341
|
+
}
|
|
342
|
+
};
|
|
343
|
+
// Chain through the write queue — .then(work, work) ensures the queue
|
|
344
|
+
// advances even when a previous persist rejects (#156).
|
|
345
|
+
this._writeQueue = this._writeQueue.then(work, work);
|
|
346
|
+
return this._writeQueue;
|
|
313
347
|
}
|
|
314
348
|
async _persistCreate(modelName, context, response) {
|
|
315
349
|
const schemas = this.deps.introspectModels();
|
package/dist/orm-request.d.ts
CHANGED
|
@@ -1,3 +1,63 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* REST request handling and access enforcement for @stonyx/orm.
|
|
3
|
+
*
|
|
4
|
+
* ---------------------------------------------------------------------------
|
|
5
|
+
* DO NOT RECONSTRUCT THE REQUEST PATH INSIDE `access()`.
|
|
6
|
+
* ---------------------------------------------------------------------------
|
|
7
|
+
* `auth()` below hands your `access(request)` a raw transport artifact and asks
|
|
8
|
+
* you to work out which collection it addresses. Every attempt to do that by
|
|
9
|
+
* parsing the request target has failed OPEN. Five distinct variants of the
|
|
10
|
+
* same three-line example have now been found, each after the previous was
|
|
11
|
+
* fixed, by five different people:
|
|
12
|
+
*
|
|
13
|
+
* 1. `request.url` is mount-relative under `RestServer.mountRoute`, so a
|
|
14
|
+
* prefix match against it is ALWAYS false.
|
|
15
|
+
* 2. `request.originalUrl` carries the query string, so an anchored equality
|
|
16
|
+
* check misses `/owners?filter[age]=30`.
|
|
17
|
+
* 3. The router is a bare `express()` (`caseSensitive: false`) while a
|
|
18
|
+
* hand-written matcher is case-SENSITIVE, so `GET /OwNeRs/angela` walks
|
|
19
|
+
* past it. Router-side: abofs/stonyx-rest-server#47.
|
|
20
|
+
* 4. Under a configured `ORM_REST_ROUTE` a hard-coded `/owners` matches
|
|
21
|
+
* nothing -- environment-specifically, which is worse.
|
|
22
|
+
* 5. HTTP/1.1 permits an ABSOLUTE-FORM request-target. Express routes on
|
|
23
|
+
* `parseurl(req).pathname`, but `originalUrl` is the raw target, so
|
|
24
|
+
* `GET http://anything.example/owners/angela` reaches the handler with
|
|
25
|
+
* `originalUrl === 'http://anything.example/owners/angela'`. A `/owners`
|
|
26
|
+
* prefix match is false, `access()` falls through to whatever it returns
|
|
27
|
+
* last, and the record comes back in full. It walks past a hard
|
|
28
|
+
* `return false` deny the same way.
|
|
29
|
+
*
|
|
30
|
+
* The fix is not a sixth rule. It is to stop parsing:
|
|
31
|
+
*
|
|
32
|
+
* `request.baseUrl` is the mount Express ACTUALLY MATCHED when it dispatched
|
|
33
|
+
* the request. It carries no query string, it is not mount-relative, it is
|
|
34
|
+
* unaffected by absolute-form, and it already includes the configured
|
|
35
|
+
* `ORM_REST_ROUTE` prefix -- so there is nothing to derive and nothing to
|
|
36
|
+
* join. Compare it lower-cased (the router matched case-insensitively) and
|
|
37
|
+
* fail CLOSED when it is absent. Use `request.path` -- mount-relative and
|
|
38
|
+
* query-free -- if you need to distinguish sub-paths.
|
|
39
|
+
*
|
|
40
|
+
* `?? ''` is not a defence. It converts an absent request target into an empty
|
|
41
|
+
* string, which matches no collection, which falls through to the permission
|
|
42
|
+
* array -- a total grant. An input you cannot identify must DENY.
|
|
43
|
+
*
|
|
44
|
+
* THAT IS STILL A STOPGAP. `baseUrl` closes all five variants, but it is a
|
|
45
|
+
* transport artifact being asked to stand in for a structural fact.
|
|
46
|
+
* THE REAL FIX IS abofs/stonyx-orm#202: `access()` should receive the model,
|
|
47
|
+
* the operation and the record. Prefer the array shape (`['read']`) or `false`
|
|
48
|
+
* until #202 lands; the function shape is what requires any matching at all.
|
|
49
|
+
*
|
|
50
|
+
* The enforcement gates in this file (GATE 0/1/2, the create rollback, the
|
|
51
|
+
* per-handler `isDenied` re-checks) are correct independently of that -- they
|
|
52
|
+
* enforce whatever predicate you return. The stopgap is the part where YOU have
|
|
53
|
+
* to work out which predicate to return.
|
|
54
|
+
*
|
|
55
|
+
* AND A PREDICATE IS NOT A GUARANTEE THAT A HIDDEN RECORD CANNOT BE MODIFIED.
|
|
56
|
+
* It is evaluated against the record the route is ADDRESSED TO, on that model
|
|
57
|
+
* only. A write to a DIFFERENT collection can still re-parent a hidden record
|
|
58
|
+
* and de-hide it -- abofs/stonyx-orm#207, which is blocked on #202 and #196.
|
|
59
|
+
* See `### Known limitations` in README.
|
|
60
|
+
*/
|
|
1
61
|
import { Request } from '@stonyx/rest-server';
|
|
2
62
|
interface OrmRequest$ extends Request {
|
|
3
63
|
protocol?: string;
|