Skip to content
This repository was archived by the owner on Oct 18, 2021. It is now read-only.

Commit b66fcff

Browse files
nikkhnnikkhn
committed
copied from an older, forked version of template-node. update files with newest version
1 parent 5f2ad22 commit b66fcff

File tree

12 files changed

+192
-208
lines changed

12 files changed

+192
-208
lines changed

‎.eslintrc.json‎

Lines changed: 33 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,35 @@
11
{
2-
"extends": [
3-
"wikimedia/server"
4-
],
5-
"plugins": ["json", "jsdoc"],
6-
"rules": {
7-
"array-bracket-spacing": "off",
8-
"camelcase": [
9-
"error",
10-
{
11-
"properties": "never"
12-
}
13-
],
14-
"computed-property-spacing": "off",
15-
"indent": ["off", 4],
16-
"jsdoc/no-undefined-types": "off",
17-
"no-multi-spaces": "off",
18-
"no-shadow": "off",
19-
"no-underscore-dangle": "off",
20-
"no-unused-vars": [
21-
"error",
22-
{
23-
"args": "none"
24-
}
25-
],
26-
"space-in-parens": ["error", "never"]
27-
}
2+
"extends": [
3+
"wikimedia/server",
4+
"wikimedia/jsdoc"
5+
],
6+
"rules": {
7+
"array-bracket-spacing": "off",
8+
"camelcase": [
9+
"error",
10+
{
11+
"properties": "never"
12+
}
13+
],
14+
"computed-property-spacing": "off",
15+
"indent": ["off", 4],
16+
"no-multi-spaces": "off",
17+
"no-shadow": "off",
18+
"no-undefined": "off",
19+
"no-underscore-dangle": "off",
20+
"no-unused-vars": [
21+
"error",
22+
{
23+
"args": "none"
24+
}
25+
],
26+
"space-in-parens": ["error", "never"],
27+
"jsdoc/no-undefined-types": "off"
28+
},
29+
"overrides": [
30+
{
31+
"files": [ "**/*.json", "**/*.jsonc" ],
32+
"extends": "wikimedia/json"
33+
}
34+
]
2835
}

‎.gitignore‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,12 @@
1-
node_modules/
1+
Dockerfile
2+
.idea/
3+
.vscode/
4+
5+
coverage
6+
.nyc_output
7+
config.yaml
8+
node_modules
9+
npm-debug.log
10+
package-lock.json
11+
12+
.eslintcache

‎.pipeline/blubber.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ variants:
1616
includes: [build]
1717
apt: { packages: [ca-certificates] }
1818
entrypoint: [node, server.js]
19+
runs: { environment: { APP_CONFIG_PATH: ./config.dev.yaml } }
1920
test:
2021
includes: [build]
2122
apt: { packages: [ca-certificates] }
@@ -27,3 +28,4 @@ variants:
2728
copies: [prep]
2829
node: { env: production }
2930
entrypoint: [node, server.js]
31+
runs: { environment: { APP_CONFIG_PATH: ./config.prod.yaml } }

‎LICENSE‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Apache License
1+
Apache License
22
Version 2.0, January 2004
33
http://www.apache.org/licenses/
44

@@ -178,15 +178,15 @@
178178
APPENDIX: How to apply the Apache License to your work.
179179

180180
To apply the Apache License to your work, attach the following
181-
boilerplate notice, with the fields enclosed by brackets "[]"
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182182
replaced with your own identifying information. (Don't include
183183
the brackets!) The text should be enclosed in the appropriate
184184
comment syntax for the file format. We also recommend that a
185185
file or class name and description of purpose be included on the
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright [yyyy] [name of copyright owner]
189+
Copyright {yyyy} {name of copyright owner}
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.
@@ -199,3 +199,4 @@
199199
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200200
See the License for the specific language governing permissions and
201201
limitations under the License.
202+

‎config.dev.yaml‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,21 @@ worker_heap_limit_mb: 250
1010
# Logger info
1111
logging:
1212
level: trace
13-
# streams:
14-
# # Use syslog -> logstash
15-
# - type: syslog
16-
# host: localhost
17-
# port: 10514
18-
# prefix: '@cee: '
13+
# name: <your app name>
14+
# streams:
15+
# - type: syslog
16+
# host: localhost
17+
# port: 10514
18+
# prefix: '@cee: '
19+
# name: node
1920

20-
# Statsd metrics reporter
2121
metrics:
22-
#type: log
23-
#host: localhost
24-
#port: 8125
22+
# - type: prometheus
23+
# port: 9000
24+
# Statsd metrics reporter
25+
# - type: statsd
26+
# host: localhost
27+
# port: 8125
2528

2629
services:
2730
- name: service-template-node

‎config.prod.yaml‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@ worker_heap_limit_mb: 500
1010
# Logger info
1111
logging:
1212
level: warn
13-
# streams:
14-
# # Use syslog -> logstash
15-
# - type: syslog
16-
# host: localhost
17-
# port: 10514
18-
# prefix: '@cee: '
13+
# name: <your app name>
14+
streams:
15+
- type: syslog
16+
host: localhost
17+
port: 10514
18+
prefix: '@cee: '
19+
name: node
1920

2021
# Statsd metrics reporter
2122
metrics:

‎lib/util.js‎

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -101,13 +101,26 @@ function errForLog(err) {
101101
function wrapRouteHandlers(route, app) {
102102

103103
route.router.stack.forEach((routerLayer) => {
104-
let path = (route.path + routerLayer.route.path.slice(1))
104+
const path = (route.path + routerLayer.route.path.slice(1))
105105
.replace(/\/:/g, '/--')
106106
.replace(/^\//, '')
107107
.replace(/[/?]+$/, '');
108-
path = app.metrics.normalizeName(path || 'root');
109108
routerLayer.route.stack.forEach((layer) => {
110109
const origHandler = layer.handle;
110+
const metric = app.metrics.makeMetric({
111+
type: 'Histogram',
112+
name: 'router',
113+
prometheus: {
114+
name: 'express_router_request_duration_seconds',
115+
help: 'request duration handled by router in seconds',
116+
staticLabels: app.metrics.getServiceLabel(),
117+
buckets: [0.01, 0.05, 0.1, 0.3, 1]
118+
},
119+
labels: {
120+
names: ['path', 'method', 'status'],
121+
omitLabelNames: true
122+
}
123+
});
111124
layer.handle = (req, res, next) => {
112125
const startTime = Date.now();
113126
BBPromise.try(() => origHandler(req, res, next))
@@ -117,13 +130,7 @@ function wrapRouteHandlers(route, app) {
117130
if (statusCode < 100 || statusCode > 599) {
118131
statusCode = 500;
119132
}
120-
const statusClass = `${Math.floor(statusCode / 100)}xx`;
121-
const stat = `${path}.${req.method}.`;
122-
app.metrics.endTiming([
123-
stat + statusCode,
124-
stat + statusClass,
125-
`${stat}ALL`
126-
], startTime);
133+
metric.endTiming(startTime, [path || 'root', req.method, statusCode]);
127134
});
128135
};
129136
});

‎package.json‎

Lines changed: 57 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,59 @@
11
{
2-
"name": "service-template-node",
3-
"version": "0.8.0",
4-
"description": "A blueprint for MediaWiki REST API services",
5-
"main": "./app.js",
6-
"scripts": {
7-
"start": "service-runner",
8-
"test": "npm run lint && PREQ_CONNECT_TIMEOUT=15 mocha",
9-
"lint": "eslint --max-warnings 0 --ext .js --ext .json .",
10-
"lint:fix": "eslint --fix .",
11-
"docker-start": "service-runner docker-start",
12-
"docker-test": "service-runner docker-test",
13-
"test-build": "service-runner docker-test && service-runner build --deploy-repo --force",
14-
"coverage": "PREQ_CONNECT_TIMEOUT=15 nyc --reporter=lcov _mocha"
15-
},
16-
"repository": {
17-
"type": "git",
18-
"url": "git://github.com/wikimedia/service-template-node.git"
19-
},
20-
"keywords": [
21-
"REST",
22-
"API",
23-
"service template",
24-
"MediaWiki"
25-
],
26-
"author": "Wikimedia Service Team <services@lists.wikimedia.org>",
27-
"contributors": [],
28-
"license": "Apache-2.0",
29-
"bugs": {
30-
"url": "https://phabricator.wikimedia.org/tag/service-template-node/"
31-
},
32-
"homepage": "https://github.com/wikimedia/service-template-node",
33-
"dependencies": {
34-
"bluebird": "^3.5.5",
35-
"body-parser": "^1.19.0",
36-
"bunyan": "^1.8.12",
37-
"compression": "^1.7.4",
38-
"domino": "^2.1.3",
39-
"express": "^4.17.1",
40-
"http-shutdown": "^1.2.1",
41-
"js-yaml": "^3.13.1",
42-
"preq": "^0.5.9",
43-
"service-runner": "^2.7.1",
44-
"swagger-router": "^0.7.4",
45-
"swagger-ui-dist": "^3.22.3",
46-
"uuid": "^3.3.2"
47-
},
48-
"devDependencies": {
49-
"ajv": "^6.5.4",
50-
"eslint-config-wikimedia": "^0.17.0",
51-
"eslint-plugin-jsdoc": "^30.6.2",
52-
"eslint-plugin-json": "^2.1.2",
53-
"extend": "^3.0.2",
54-
"mocha": "^5.2.0",
55-
"mocha-lcov-reporter": "^1.3.0",
56-
"mocha.parallel": "^0.15.6",
57-
"nyc": "^14.1.1",
58-
"openapi-schema-validator": "^3.0.3"
59-
},
60-
"deploy": {
61-
"target": "debian",
62-
"node": "10.15.2",
63-
"dependencies": {
64-
"_all": []
65-
}
66-
}
2+
"name": "service-template-node",
3+
"version": "0.10.0",
4+
"description": "A blueprint for MediaWiki REST API services",
5+
"main": "./app.js",
6+
"scripts": {
7+
"start": "service-runner",
8+
"test": "npm run lint && PREQ_CONNECT_TIMEOUT=15 mocha",
9+
"lint": "eslint --max-warnings 0 --ext .js --ext .json .",
10+
"lint:fix": "eslint --fix .",
11+
"docker-start": "service-runner docker-start",
12+
"docker-test": "service-runner docker-test",
13+
"test-build": "service-runner docker-test && service-runner build --deploy-repo --force",
14+
"coverage": "PREQ_CONNECT_TIMEOUT=15 nyc --reporter=lcov _mocha"
15+
},
16+
"repository": {
17+
"type": "git",
18+
"url": "git://github.com/wikimedia/service-template-node.git"
19+
},
20+
"keywords": [
21+
"REST",
22+
"API",
23+
"service template",
24+
"MediaWiki"
25+
],
26+
"author": "Wikimedia Service Team <services@lists.wikimedia.org>",
27+
"contributors": [],
28+
"license": "Apache-2.0",
29+
"bugs": {
30+
"url": "https://phabricator.wikimedia.org/tag/service-template-node/"
31+
},
32+
"homepage": "https://github.com/wikimedia/service-template-node",
33+
"dependencies": {
34+
"bluebird": "^3.5.5",
35+
"body-parser": "^1.19.0",
36+
"bunyan": "^1.8.12",
37+
"compression": "^1.7.4",
38+
"domino": "^2.1.3",
39+
"express": "^4.17.1",
40+
"http-shutdown": "^1.2.1",
41+
"js-yaml": "^3.13.1",
42+
"preq": "^0.5.9",
43+
"service-runner": "^2.8.4",
44+
"swagger-router": "^0.7.4",
45+
"swagger-ui-dist": "^3.22.3",
46+
"uuid": "^3.3.2"
47+
},
48+
"devDependencies": {
49+
"ajv": "^6.5.4",
50+
"chai": "^4.3.0",
51+
"eslint-config-wikimedia": "0.20.0",
52+
"extend": "^3.0.2",
53+
"mocha": "^5.2.0",
54+
"mocha-lcov-reporter": "^1.3.0",
55+
"mocha.parallel": "^0.15.6",
56+
"nyc": "^14.1.1",
57+
"openapi-schema-validator": "^3.0.3"
58+
}
6759
}

‎test/.eslintrc.json‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
{
2-
"extends": "../.eslintrc.json",
3-
"env": { "mocha": true },
4-
"rules": {
5-
"max-len": "off",
6-
"no-console": "off",
7-
"no-invalid-this": "off"
8-
}
2+
"extends": [
3+
"../.eslintrc.json",
4+
"wikimedia/mocha"
5+
],
6+
"rules": {
7+
"max-len": "off",
8+
"no-console": "off",
9+
"no-invalid-this": "off"
10+
}
911
}

‎test/features/app/spec.js‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ function cmp(result, expected, errMsg) {
151151
}
152152

153153
if (expected.length > 1 && expected[0] === '/' && expected[expected.length - 1] === '/') {
154-
if ((new RegExp(expected.slice(1, -1))).test(result)) {
154+
if (new RegExp(expected.slice(1, -1)).test(result)) {
155155
return true;
156156
}
157157
} else if (expected.length === 0 && result.length === 0) {
@@ -264,11 +264,15 @@ describe('Swagger spec', function () {
264264
})
265265
.then((spec) => {
266266
const routeTests = () => {
267+
// eslint-disable-next-line mocha/no-sibling-hooks
267268
before(() => server.start());
269+
// eslint-disable-next-line mocha/no-sibling-hooks
268270
after(() => server.stop());
269271

270272
constructTests(spec).forEach((testCase) => {
273+
// eslint-disable-next-line mocha/handle-done-callback, mocha/no-nested-tests
271274
it(testCase.title, function (done) {
275+
// eslint-disable-next-line mocha/no-return-and-callback
272276
return preq(testCase.request)
273277
.then((res) => {
274278
assert.status(res, testCase.response.status);

0 commit comments

Comments
 (0)