Skip to content

Commit 5b9c646

Browse files
veksenveksen
committed
feat(typeorm): add sqlcommenter-typeorm package
Adds @query-doctor/sqlcommenter-typeorm with dual CJS/ESM build support. Patches QueryRunner.query() via DataSource.createQueryRunner() interception to append sqlcommenter tags (db_driver, file, route, W3C trace context) to all TypeORM queries. Uses alreadyHasTrailingComment() to coexist with TypeORM's QueryBuilder.comment() which prepends comments. Includes integration tests using EntitySchema + sql.js exercising Repository.find(), .save(), .findOneBy(), and QueryBuilder pipelines.
1 parent 9f1434c commit 5b9c646

13 files changed

Lines changed: 1956 additions & 0 deletions

File tree

‎nodejs/sqlcommenter-nodejs/packages/sqlcommenter-typeorm/LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎nodejs/sqlcommenter-nodejs/packages/sqlcommenter-typeorm/README.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# @query-doctor/sqlcommenter-typeorm
2+
3+
TypeORM sqlcommenter support for TypeORM >= 0.3.0.
4+
5+
Emits the following fields into the query:
6+
7+
| name | included by default? | description |
8+
| ------------- | -------------------- | --------------------------------------------------------------- |
9+
| db_driver | Yes | The driver used to connect to the database. (TypeORM) |
10+
| file | Yes | The file that the query was executed in. |
11+
| route | No | The route that the query was executed in. |
12+
| method | No | The http method for the request that the query was executed in. |
13+
| anything else | No | Any other information that the user wants to add to the query. |
14+
15+
It also emits the trace context, if available.
16+
17+
### Installation
18+
19+
```shell
20+
npm install @query-doctor/sqlcommenter-typeorm
21+
pnpm add @query-doctor/sqlcommenter-typeorm
22+
```
23+
24+
### Usage
25+
26+
Simply wrap your TypeORM DataSource with the `patchTypeORM` function.
27+
28+
Before:
29+
30+
```ts
31+
// db/data-source.ts
32+
import { DataSource } from "typeorm";
33+
34+
const dataSource = new DataSource({
35+
type: "postgres",
36+
url: process.env.DATABASE_URL,
37+
});
38+
```
39+
40+
After:
41+
42+
```ts
43+
// db/data-source.ts
44+
import { DataSource } from "typeorm";
45+
import { patchTypeORM } from "@query-doctor/sqlcommenter-typeorm";
46+
47+
const dataSource = patchTypeORM(new DataSource({
48+
type: "postgres",
49+
url: process.env.DATABASE_URL,
50+
}));
51+
```
52+
53+
### Emitting route information
54+
55+
To include route information in the comments, patching TypeORM by itself is not enough. You need to use the `withRequestContext` function to pass along relevant information to the query comments.
56+
57+
You can add any arbitrary information to the request context aside from `route`, `method` and `controller`.
58+
59+
Here are some examples of how to use it with different frameworks:
60+
61+
#### Express
62+
63+
```ts
64+
import { withRequestContext } from "@query-doctor/sqlcommenter-typeorm/http";
65+
66+
app.use((req, res, next) => {
67+
withRequestContext({ route: req.route.path, method: req.method }, next);
68+
});
69+
```
70+
71+
#### Hono
72+
73+
```ts
74+
import { withRequestContext } from "@query-doctor/sqlcommenter-typeorm/http";
75+
import { routePath } from "hono/route";
76+
77+
app.use((c, next) => {
78+
withRequestContext({ route: routePath(c), method: c.req.method }, next);
79+
});
80+
```
81+
82+
#### Fastify
83+
84+
```ts
85+
import { withRequestContext } from "@query-doctor/sqlcommenter-typeorm/http";
86+
87+
app.addHook("onRequest", (request, _, done) => {
88+
withRequestContext(
89+
{
90+
route: request.routerPath,
91+
method: request.method,
92+
},
93+
done
94+
);
95+
});
96+
```
97+
98+
#### NestJS
99+
100+
```ts
101+
import { withRequestContext } from "@query-doctor/sqlcommenter-typeorm/http";
102+
103+
@Injectable()
104+
export class SqlcommenterMiddleware implements NestMiddleware {
105+
use(req: Request, res: Response, next: NextFunction) {
106+
withRequestContext({ route: req.path, method: req.method }, next);
107+
}
108+
}
109+
```

‎nodejs/sqlcommenter-nodejs/packages/sqlcommenter-typeorm/package.json‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
{
2+
"name": "@query-doctor/sqlcommenter-typeorm",
3+
"version": "0.0.1",
4+
"description": "SQLCommenter patch for TypeORM",
5+
"main": "dist/cjs/index.js",
6+
"type": "module",
7+
"types": "dist/esm/index.d.ts",
8+
"module": "dist/esm/index.js",
9+
"files": [
10+
"dist"
11+
],
12+
"exports": {
13+
".": {
14+
"import": {
15+
"types": "./dist/esm/index.d.ts",
16+
"default": "./dist/esm/index.js"
17+
},
18+
"require": {
19+
"types": "./dist/cjs/index.d.ts",
20+
"default": "./dist/cjs/index.js"
21+
}
22+
},
23+
"./http": {
24+
"import": {
25+
"types": "./dist/esm/http.d.ts",
26+
"default": "./dist/esm/http.js"
27+
},
28+
"require": {
29+
"types": "./dist/cjs/http.d.ts",
30+
"default": "./dist/cjs/http.js"
31+
}
32+
}
33+
},
34+
"devDependencies": {
35+
"@types/node": "^24.5.2",
36+
"reflect-metadata": "^0.2.2",
37+
"sql.js": "^1.12.0",
38+
"tsx": "^4.20.5",
39+
"typescript": "^5.9.3"
40+
},
41+
"dependencies": {
42+
"@opentelemetry/api": "~1.9.0"
43+
},
44+
"peerDependencies": {
45+
"@opentelemetry/core": ">=1.0.0",
46+
"typeorm": ">=0.3.0"
47+
},
48+
"engines": {
49+
"node": ">=24.8.0"
50+
},
51+
"scripts": {
52+
"test": "node --import=tsx --test test/**/*.spec.ts",
53+
"build": "tsc -p tsconfig.json && tsc -p tsconfig.cjs.json && echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json"
54+
},
55+
"repository": {
56+
"type": "git",
57+
"url": "git+https://github.com/query-doctor/sqlcommenter.git"
58+
},
59+
"publishConfig": {
60+
"access": "public",
61+
"registry": "https://registry.npmjs.org"
62+
},
63+
"author": "Query Doctor",
64+
"license": "Apache-2.0",
65+
"packageManager": "pnpm@10.16.1+sha512.0e155aa2629db8672b49e8475da6226aa4bdea85fdcdfdc15350874946d4f3c91faaf64cbdc4a5d1ab8002f473d5c3fcedcd197989cf0390f9badd3c04678706"
66+
}

0 commit comments

Comments
 (0)