Compare commits
1 Commits
express
...
server-202
| Author | SHA1 | Date | |
|---|---|---|---|
|
6f03524c29 |
190
.github/actions/close-bot/package-lock.json
generated
vendored
190
.github/actions/close-bot/package-lock.json
generated
vendored
@@ -10,7 +10,7 @@
|
||||
"license": "CC0",
|
||||
"dependencies": {
|
||||
"@actions/core": "^1.6.0",
|
||||
"@actions/github": "^5.0.1"
|
||||
"@actions/github": "^5.0.0"
|
||||
}
|
||||
},
|
||||
"node_modules/@actions/core": {
|
||||
@@ -22,14 +22,14 @@
|
||||
}
|
||||
},
|
||||
"node_modules/@actions/github": {
|
||||
"version": "5.0.1",
|
||||
"resolved": "https://registry.npmjs.org/@actions/github/-/github-5.0.1.tgz",
|
||||
"integrity": "sha512-JZGyPM9ektb8NVTTI/2gfJ9DL7Rk98tQ7OVyTlgTuaQroariRBsOnzjy0I2EarX4xUZpK88YyO503fhmjFdyAg==",
|
||||
"version": "5.0.0",
|
||||
"resolved": "https://registry.npmjs.org/@actions/github/-/github-5.0.0.tgz",
|
||||
"integrity": "sha512-QvE9eAAfEsS+yOOk0cylLBIO/d6WyWIOvsxxzdrPFaud39G6BOkUwScXZn1iBzQzHyu9SBkkLSWlohDWdsasAQ==",
|
||||
"dependencies": {
|
||||
"@actions/http-client": "^1.0.11",
|
||||
"@octokit/core": "^3.6.0",
|
||||
"@octokit/plugin-paginate-rest": "^2.17.0",
|
||||
"@octokit/plugin-rest-endpoint-methods": "^5.13.0"
|
||||
"@octokit/core": "^3.4.0",
|
||||
"@octokit/plugin-paginate-rest": "^2.13.3",
|
||||
"@octokit/plugin-rest-endpoint-methods": "^5.1.1"
|
||||
}
|
||||
},
|
||||
"node_modules/@actions/http-client": {
|
||||
@@ -41,21 +41,21 @@
|
||||
}
|
||||
},
|
||||
"node_modules/@octokit/auth-token": {
|
||||
"version": "2.5.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.5.0.tgz",
|
||||
"integrity": "sha512-r5FVUJCOLl19AxiuZD2VRZ/ORjp/4IN98Of6YJoJOkY75CIBuYfmiNHGrDwXr+aLGG55igl9QrxX3hbiXlLb+g==",
|
||||
"version": "2.4.5",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.4.5.tgz",
|
||||
"integrity": "sha512-BpGYsPgJt05M7/L/5FoE1PiAbdxXFZkX/3kDYcsvd1v6UhlnE5e96dTDr0ezX/EFwciQxf3cNV0loipsURU+WA==",
|
||||
"dependencies": {
|
||||
"@octokit/types": "^6.0.3"
|
||||
}
|
||||
},
|
||||
"node_modules/@octokit/core": {
|
||||
"version": "3.6.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/core/-/core-3.6.0.tgz",
|
||||
"integrity": "sha512-7RKRKuA4xTjMhY+eG3jthb3hlZCsOwg3rztWh75Xc+ShDWOfDDATWbeZpAHBNRpm4Tv9WgBMOy1zEJYXG6NJ7Q==",
|
||||
"version": "3.4.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/core/-/core-3.4.0.tgz",
|
||||
"integrity": "sha512-6/vlKPP8NF17cgYXqucdshWqmMZGXkuvtcrWCgU5NOI0Pl2GjlmZyWgBMrU8zJ3v2MJlM6++CiB45VKYmhiWWg==",
|
||||
"dependencies": {
|
||||
"@octokit/auth-token": "^2.4.4",
|
||||
"@octokit/graphql": "^4.5.8",
|
||||
"@octokit/request": "^5.6.3",
|
||||
"@octokit/request": "^5.4.12",
|
||||
"@octokit/request-error": "^2.0.5",
|
||||
"@octokit/types": "^6.0.3",
|
||||
"before-after-hook": "^2.2.0",
|
||||
@@ -63,9 +63,9 @@
|
||||
}
|
||||
},
|
||||
"node_modules/@octokit/endpoint": {
|
||||
"version": "6.0.12",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.12.tgz",
|
||||
"integrity": "sha512-lF3puPwkQWGfkMClXb4k/eUT/nZKQfxinRWJrdZaJO85Dqwo/G0yOC434Jr2ojwafWJMYqFGFa5ms4jJUgujdA==",
|
||||
"version": "6.0.11",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.11.tgz",
|
||||
"integrity": "sha512-fUIPpx+pZyoLW4GCs3yMnlj2LfoXTWDUVPTC4V3MUEKZm48W+XYpeWSZCv+vYF1ZABUm2CqnDVf1sFtIYrj7KQ==",
|
||||
"dependencies": {
|
||||
"@octokit/types": "^6.0.3",
|
||||
"is-plain-object": "^5.0.0",
|
||||
@@ -73,37 +73,37 @@
|
||||
}
|
||||
},
|
||||
"node_modules/@octokit/graphql": {
|
||||
"version": "4.8.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.8.0.tgz",
|
||||
"integrity": "sha512-0gv+qLSBLKF0z8TKaSKTsS39scVKF9dbMxJpj3U0vC7wjNWFuIpL/z76Qe2fiuCbDRcJSavkXsVtMS6/dtQQsg==",
|
||||
"version": "4.6.2",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.6.2.tgz",
|
||||
"integrity": "sha512-WmsIR1OzOr/3IqfG9JIczI8gMJUMzzyx5j0XXQ4YihHtKlQc+u35VpVoOXhlKAlaBntvry1WpAzPl/a+s3n89Q==",
|
||||
"dependencies": {
|
||||
"@octokit/request": "^5.6.0",
|
||||
"@octokit/request": "^5.3.0",
|
||||
"@octokit/types": "^6.0.3",
|
||||
"universal-user-agent": "^6.0.0"
|
||||
}
|
||||
},
|
||||
"node_modules/@octokit/openapi-types": {
|
||||
"version": "11.2.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-11.2.0.tgz",
|
||||
"integrity": "sha512-PBsVO+15KSlGmiI8QAzaqvsNlZlrDlyAJYcrXBCvVUxCp7VnXjkwPoFHgjEJXx3WF9BAwkA6nfCUA7i9sODzKA=="
|
||||
"version": "7.0.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-7.0.0.tgz",
|
||||
"integrity": "sha512-gV/8DJhAL/04zjTI95a7FhQwS6jlEE0W/7xeYAzuArD0KVAVWDLP2f3vi98hs3HLTczxXdRK/mF0tRoQPpolEw=="
|
||||
},
|
||||
"node_modules/@octokit/plugin-paginate-rest": {
|
||||
"version": "2.17.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-2.17.0.tgz",
|
||||
"integrity": "sha512-tzMbrbnam2Mt4AhuyCHvpRkS0oZ5MvwwcQPYGtMv4tUa5kkzG58SVB0fcsLulOZQeRnOgdkZWkRUiyBlh0Bkyw==",
|
||||
"version": "2.13.3",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-2.13.3.tgz",
|
||||
"integrity": "sha512-46lptzM9lTeSmIBt/sVP/FLSTPGx6DCzAdSX3PfeJ3mTf4h9sGC26WpaQzMEq/Z44cOcmx8VsOhO+uEgE3cjYg==",
|
||||
"dependencies": {
|
||||
"@octokit/types": "^6.34.0"
|
||||
"@octokit/types": "^6.11.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@octokit/core": ">=2"
|
||||
}
|
||||
},
|
||||
"node_modules/@octokit/plugin-rest-endpoint-methods": {
|
||||
"version": "5.13.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-5.13.0.tgz",
|
||||
"integrity": "sha512-uJjMTkN1KaOIgNtUPMtIXDOjx6dGYysdIFhgA52x4xSadQCz3b/zJexvITDVpANnfKPW/+E0xkOvLntqMYpviA==",
|
||||
"version": "5.1.1",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-5.1.1.tgz",
|
||||
"integrity": "sha512-u4zy0rVA8darm/AYsIeWkRalhQR99qPL1D/EXHejV2yaECMdHfxXiTXtba8NMBSajOJe8+C9g+EqMKSvysx0dg==",
|
||||
"dependencies": {
|
||||
"@octokit/types": "^6.34.0",
|
||||
"@octokit/types": "^6.14.1",
|
||||
"deprecation": "^2.3.1"
|
||||
},
|
||||
"peerDependencies": {
|
||||
@@ -111,22 +111,22 @@
|
||||
}
|
||||
},
|
||||
"node_modules/@octokit/request": {
|
||||
"version": "5.6.3",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.6.3.tgz",
|
||||
"integrity": "sha512-bFJl0I1KVc9jYTe9tdGGpAMPy32dLBXXo1dS/YwSCTL/2nd9XeHsY616RE3HPXDVk+a+dBuzyz5YdlXwcDTr2A==",
|
||||
"version": "5.4.15",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.4.15.tgz",
|
||||
"integrity": "sha512-6UnZfZzLwNhdLRreOtTkT9n57ZwulCve8q3IT/Z477vThu6snfdkBuhxnChpOKNGxcQ71ow561Qoa6uqLdPtag==",
|
||||
"dependencies": {
|
||||
"@octokit/endpoint": "^6.0.1",
|
||||
"@octokit/request-error": "^2.1.0",
|
||||
"@octokit/types": "^6.16.1",
|
||||
"@octokit/request-error": "^2.0.0",
|
||||
"@octokit/types": "^6.7.1",
|
||||
"is-plain-object": "^5.0.0",
|
||||
"node-fetch": "^2.6.7",
|
||||
"node-fetch": "^2.6.1",
|
||||
"universal-user-agent": "^6.0.0"
|
||||
}
|
||||
},
|
||||
"node_modules/@octokit/request-error": {
|
||||
"version": "2.1.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.1.0.tgz",
|
||||
"integrity": "sha512-1VIvgXxs9WHSjicsRwq8PlR2LR2x6DwsJAaFgzdi0JfJoGSO8mYI/cHJQ+9FbN21aa+DrgNLnwObmyeSC8Rmpg==",
|
||||
"version": "2.0.5",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.0.5.tgz",
|
||||
"integrity": "sha512-T/2wcCFyM7SkXzNoyVNWjyVlUwBvW3igM3Btr/eKYiPmucXTtkxt2RBsf6gn3LTzaLSLTQtNmvg+dGsOxQrjZg==",
|
||||
"dependencies": {
|
||||
"@octokit/types": "^6.0.3",
|
||||
"deprecation": "^2.0.0",
|
||||
@@ -134,17 +134,17 @@
|
||||
}
|
||||
},
|
||||
"node_modules/@octokit/types": {
|
||||
"version": "6.34.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.34.0.tgz",
|
||||
"integrity": "sha512-s1zLBjWhdEI2zwaoSgyOFoKSl109CUcVBCc7biPJ3aAf6LGLU6szDvi31JPU7bxfla2lqfhjbbg/5DdFNxOwHw==",
|
||||
"version": "6.14.2",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.14.2.tgz",
|
||||
"integrity": "sha512-wiQtW9ZSy4OvgQ09iQOdyXYNN60GqjCL/UdMsepDr1Gr0QzpW6irIKbH3REuAHXAhxkEk9/F2a3Gcs1P6kW5jA==",
|
||||
"dependencies": {
|
||||
"@octokit/openapi-types": "^11.2.0"
|
||||
"@octokit/openapi-types": "^7.0.0"
|
||||
}
|
||||
},
|
||||
"node_modules/before-after-hook": {
|
||||
"version": "2.2.2",
|
||||
"resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-2.2.2.tgz",
|
||||
"integrity": "sha512-3pZEU3NT5BFUo/AD5ERPWOgQOCZITni6iavr5AUw5AUwQjMlI0kzu5btnyD39AF0gUEsDPwJT+oY1ORBJijPjQ=="
|
||||
"version": "2.2.1",
|
||||
"resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-2.2.1.tgz",
|
||||
"integrity": "sha512-/6FKxSTWoJdbsLDF8tdIjaRiFXiE6UHsEHE3OPI/cwPURCVi1ukP0gmLn7XWEiFk5TcwQjjY5PWsU+j+tgXgmw=="
|
||||
},
|
||||
"node_modules/deprecation": {
|
||||
"version": "2.3.1",
|
||||
@@ -234,14 +234,14 @@
|
||||
}
|
||||
},
|
||||
"@actions/github": {
|
||||
"version": "5.0.1",
|
||||
"resolved": "https://registry.npmjs.org/@actions/github/-/github-5.0.1.tgz",
|
||||
"integrity": "sha512-JZGyPM9ektb8NVTTI/2gfJ9DL7Rk98tQ7OVyTlgTuaQroariRBsOnzjy0I2EarX4xUZpK88YyO503fhmjFdyAg==",
|
||||
"version": "5.0.0",
|
||||
"resolved": "https://registry.npmjs.org/@actions/github/-/github-5.0.0.tgz",
|
||||
"integrity": "sha512-QvE9eAAfEsS+yOOk0cylLBIO/d6WyWIOvsxxzdrPFaud39G6BOkUwScXZn1iBzQzHyu9SBkkLSWlohDWdsasAQ==",
|
||||
"requires": {
|
||||
"@actions/http-client": "^1.0.11",
|
||||
"@octokit/core": "^3.6.0",
|
||||
"@octokit/plugin-paginate-rest": "^2.17.0",
|
||||
"@octokit/plugin-rest-endpoint-methods": "^5.13.0"
|
||||
"@octokit/core": "^3.4.0",
|
||||
"@octokit/plugin-paginate-rest": "^2.13.3",
|
||||
"@octokit/plugin-rest-endpoint-methods": "^5.1.1"
|
||||
}
|
||||
},
|
||||
"@actions/http-client": {
|
||||
@@ -253,21 +253,21 @@
|
||||
}
|
||||
},
|
||||
"@octokit/auth-token": {
|
||||
"version": "2.5.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.5.0.tgz",
|
||||
"integrity": "sha512-r5FVUJCOLl19AxiuZD2VRZ/ORjp/4IN98Of6YJoJOkY75CIBuYfmiNHGrDwXr+aLGG55igl9QrxX3hbiXlLb+g==",
|
||||
"version": "2.4.5",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.4.5.tgz",
|
||||
"integrity": "sha512-BpGYsPgJt05M7/L/5FoE1PiAbdxXFZkX/3kDYcsvd1v6UhlnE5e96dTDr0ezX/EFwciQxf3cNV0loipsURU+WA==",
|
||||
"requires": {
|
||||
"@octokit/types": "^6.0.3"
|
||||
}
|
||||
},
|
||||
"@octokit/core": {
|
||||
"version": "3.6.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/core/-/core-3.6.0.tgz",
|
||||
"integrity": "sha512-7RKRKuA4xTjMhY+eG3jthb3hlZCsOwg3rztWh75Xc+ShDWOfDDATWbeZpAHBNRpm4Tv9WgBMOy1zEJYXG6NJ7Q==",
|
||||
"version": "3.4.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/core/-/core-3.4.0.tgz",
|
||||
"integrity": "sha512-6/vlKPP8NF17cgYXqucdshWqmMZGXkuvtcrWCgU5NOI0Pl2GjlmZyWgBMrU8zJ3v2MJlM6++CiB45VKYmhiWWg==",
|
||||
"requires": {
|
||||
"@octokit/auth-token": "^2.4.4",
|
||||
"@octokit/graphql": "^4.5.8",
|
||||
"@octokit/request": "^5.6.3",
|
||||
"@octokit/request": "^5.4.12",
|
||||
"@octokit/request-error": "^2.0.5",
|
||||
"@octokit/types": "^6.0.3",
|
||||
"before-after-hook": "^2.2.0",
|
||||
@@ -275,9 +275,9 @@
|
||||
}
|
||||
},
|
||||
"@octokit/endpoint": {
|
||||
"version": "6.0.12",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.12.tgz",
|
||||
"integrity": "sha512-lF3puPwkQWGfkMClXb4k/eUT/nZKQfxinRWJrdZaJO85Dqwo/G0yOC434Jr2ojwafWJMYqFGFa5ms4jJUgujdA==",
|
||||
"version": "6.0.11",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.11.tgz",
|
||||
"integrity": "sha512-fUIPpx+pZyoLW4GCs3yMnlj2LfoXTWDUVPTC4V3MUEKZm48W+XYpeWSZCv+vYF1ZABUm2CqnDVf1sFtIYrj7KQ==",
|
||||
"requires": {
|
||||
"@octokit/types": "^6.0.3",
|
||||
"is-plain-object": "^5.0.0",
|
||||
@@ -285,54 +285,54 @@
|
||||
}
|
||||
},
|
||||
"@octokit/graphql": {
|
||||
"version": "4.8.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.8.0.tgz",
|
||||
"integrity": "sha512-0gv+qLSBLKF0z8TKaSKTsS39scVKF9dbMxJpj3U0vC7wjNWFuIpL/z76Qe2fiuCbDRcJSavkXsVtMS6/dtQQsg==",
|
||||
"version": "4.6.2",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.6.2.tgz",
|
||||
"integrity": "sha512-WmsIR1OzOr/3IqfG9JIczI8gMJUMzzyx5j0XXQ4YihHtKlQc+u35VpVoOXhlKAlaBntvry1WpAzPl/a+s3n89Q==",
|
||||
"requires": {
|
||||
"@octokit/request": "^5.6.0",
|
||||
"@octokit/request": "^5.3.0",
|
||||
"@octokit/types": "^6.0.3",
|
||||
"universal-user-agent": "^6.0.0"
|
||||
}
|
||||
},
|
||||
"@octokit/openapi-types": {
|
||||
"version": "11.2.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-11.2.0.tgz",
|
||||
"integrity": "sha512-PBsVO+15KSlGmiI8QAzaqvsNlZlrDlyAJYcrXBCvVUxCp7VnXjkwPoFHgjEJXx3WF9BAwkA6nfCUA7i9sODzKA=="
|
||||
"version": "7.0.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-7.0.0.tgz",
|
||||
"integrity": "sha512-gV/8DJhAL/04zjTI95a7FhQwS6jlEE0W/7xeYAzuArD0KVAVWDLP2f3vi98hs3HLTczxXdRK/mF0tRoQPpolEw=="
|
||||
},
|
||||
"@octokit/plugin-paginate-rest": {
|
||||
"version": "2.17.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-2.17.0.tgz",
|
||||
"integrity": "sha512-tzMbrbnam2Mt4AhuyCHvpRkS0oZ5MvwwcQPYGtMv4tUa5kkzG58SVB0fcsLulOZQeRnOgdkZWkRUiyBlh0Bkyw==",
|
||||
"version": "2.13.3",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-2.13.3.tgz",
|
||||
"integrity": "sha512-46lptzM9lTeSmIBt/sVP/FLSTPGx6DCzAdSX3PfeJ3mTf4h9sGC26WpaQzMEq/Z44cOcmx8VsOhO+uEgE3cjYg==",
|
||||
"requires": {
|
||||
"@octokit/types": "^6.34.0"
|
||||
"@octokit/types": "^6.11.0"
|
||||
}
|
||||
},
|
||||
"@octokit/plugin-rest-endpoint-methods": {
|
||||
"version": "5.13.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-5.13.0.tgz",
|
||||
"integrity": "sha512-uJjMTkN1KaOIgNtUPMtIXDOjx6dGYysdIFhgA52x4xSadQCz3b/zJexvITDVpANnfKPW/+E0xkOvLntqMYpviA==",
|
||||
"version": "5.1.1",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-5.1.1.tgz",
|
||||
"integrity": "sha512-u4zy0rVA8darm/AYsIeWkRalhQR99qPL1D/EXHejV2yaECMdHfxXiTXtba8NMBSajOJe8+C9g+EqMKSvysx0dg==",
|
||||
"requires": {
|
||||
"@octokit/types": "^6.34.0",
|
||||
"@octokit/types": "^6.14.1",
|
||||
"deprecation": "^2.3.1"
|
||||
}
|
||||
},
|
||||
"@octokit/request": {
|
||||
"version": "5.6.3",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.6.3.tgz",
|
||||
"integrity": "sha512-bFJl0I1KVc9jYTe9tdGGpAMPy32dLBXXo1dS/YwSCTL/2nd9XeHsY616RE3HPXDVk+a+dBuzyz5YdlXwcDTr2A==",
|
||||
"version": "5.4.15",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.4.15.tgz",
|
||||
"integrity": "sha512-6UnZfZzLwNhdLRreOtTkT9n57ZwulCve8q3IT/Z477vThu6snfdkBuhxnChpOKNGxcQ71ow561Qoa6uqLdPtag==",
|
||||
"requires": {
|
||||
"@octokit/endpoint": "^6.0.1",
|
||||
"@octokit/request-error": "^2.1.0",
|
||||
"@octokit/types": "^6.16.1",
|
||||
"@octokit/request-error": "^2.0.0",
|
||||
"@octokit/types": "^6.7.1",
|
||||
"is-plain-object": "^5.0.0",
|
||||
"node-fetch": "^2.6.7",
|
||||
"node-fetch": "^2.6.1",
|
||||
"universal-user-agent": "^6.0.0"
|
||||
}
|
||||
},
|
||||
"@octokit/request-error": {
|
||||
"version": "2.1.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.1.0.tgz",
|
||||
"integrity": "sha512-1VIvgXxs9WHSjicsRwq8PlR2LR2x6DwsJAaFgzdi0JfJoGSO8mYI/cHJQ+9FbN21aa+DrgNLnwObmyeSC8Rmpg==",
|
||||
"version": "2.0.5",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.0.5.tgz",
|
||||
"integrity": "sha512-T/2wcCFyM7SkXzNoyVNWjyVlUwBvW3igM3Btr/eKYiPmucXTtkxt2RBsf6gn3LTzaLSLTQtNmvg+dGsOxQrjZg==",
|
||||
"requires": {
|
||||
"@octokit/types": "^6.0.3",
|
||||
"deprecation": "^2.0.0",
|
||||
@@ -340,17 +340,17 @@
|
||||
}
|
||||
},
|
||||
"@octokit/types": {
|
||||
"version": "6.34.0",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.34.0.tgz",
|
||||
"integrity": "sha512-s1zLBjWhdEI2zwaoSgyOFoKSl109CUcVBCc7biPJ3aAf6LGLU6szDvi31JPU7bxfla2lqfhjbbg/5DdFNxOwHw==",
|
||||
"version": "6.14.2",
|
||||
"resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.14.2.tgz",
|
||||
"integrity": "sha512-wiQtW9ZSy4OvgQ09iQOdyXYNN60GqjCL/UdMsepDr1Gr0QzpW6irIKbH3REuAHXAhxkEk9/F2a3Gcs1P6kW5jA==",
|
||||
"requires": {
|
||||
"@octokit/openapi-types": "^11.2.0"
|
||||
"@octokit/openapi-types": "^7.0.0"
|
||||
}
|
||||
},
|
||||
"before-after-hook": {
|
||||
"version": "2.2.2",
|
||||
"resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-2.2.2.tgz",
|
||||
"integrity": "sha512-3pZEU3NT5BFUo/AD5ERPWOgQOCZITni6iavr5AUw5AUwQjMlI0kzu5btnyD39AF0gUEsDPwJT+oY1ORBJijPjQ=="
|
||||
"version": "2.2.1",
|
||||
"resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-2.2.1.tgz",
|
||||
"integrity": "sha512-/6FKxSTWoJdbsLDF8tdIjaRiFXiE6UHsEHE3OPI/cwPURCVi1ukP0gmLn7XWEiFk5TcwQjjY5PWsU+j+tgXgmw=="
|
||||
},
|
||||
"deprecation": {
|
||||
"version": "2.3.1",
|
||||
|
||||
2
.github/actions/close-bot/package.json
vendored
2
.github/actions/close-bot/package.json
vendored
@@ -11,6 +11,6 @@
|
||||
"license": "CC0",
|
||||
"dependencies": {
|
||||
"@actions/core": "^1.6.0",
|
||||
"@actions/github": "^5.0.1"
|
||||
"@actions/github": "^5.0.0"
|
||||
}
|
||||
}
|
||||
|
||||
14
.github/workflows/enforce-dependency-review.yml
vendored
14
.github/workflows/enforce-dependency-review.yml
vendored
@@ -1,14 +0,0 @@
|
||||
name: 'Dependency Review'
|
||||
on: [pull_request]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
dependency-review:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: 'Checkout Repository'
|
||||
uses: actions/checkout@v3
|
||||
- name: 'Dependency Review'
|
||||
uses: actions/dependency-review-action@v1
|
||||
16
CHANGELOG.md
16
CHANGELOG.md
@@ -4,19 +4,15 @@ Note: this changelog is for the shields.io server. The changelog for the badge-m
|
||||
|
||||
---
|
||||
|
||||
## server-2022-04-03
|
||||
## server-2022-04-01
|
||||
|
||||
- Breaking change: This release updates ioredis from v4 to v5.
|
||||
If you are using redis for GitHub token pooling, redis connection strings of the form
|
||||
`redis://junkusername:authpassword@example.com:1234` will need to be updated to
|
||||
`redis://:authpassword@example.com:1234`. See the
|
||||
[ioredis upgrade guide](https://github.com/luin/ioredis/wiki/Upgrading-from-v4-to-v5)
|
||||
for further details.
|
||||
- fix installation issue on npm >= 8.5.5 [#7809](https://github.com/badges/shields/issues/7809)
|
||||
- two fixes for [packagist] schemas [#7782](https://github.com/badges/shields/issues/7782)
|
||||
- allow requireCloudflare setting to work when hosted on fly.io [#7781](https://github.com/badges/shields/issues/7781)
|
||||
- fix [pypi] badges when package has null license [#7761](https://github.com/badges/shields/issues/7761)
|
||||
- Use new CircleCI "convenience" images [#7726](https://github.com/badges/shields/issues/7726)
|
||||
- cache [pub] publisher badge for an hour [#7762](https://github.com/badges/shields/issues/7762)
|
||||
- Add a [pub] publisher badge [#7715](https://github.com/badges/shields/issues/7715)
|
||||
- Update number of badges served each month [#7723](https://github.com/badges/shields/issues/7723)
|
||||
- Switch Steam file size badge to informational color [#7722](https://github.com/badges/shields/issues/7722)
|
||||
- Make W3C and Youtube documentation links clickable [#7721](https://github.com/badges/shields/issues/7721)
|
||||
- Improve Wercker examples [#7720](https://github.com/badges/shields/issues/7720)
|
||||
@@ -29,8 +25,10 @@ Note: this changelog is for the shields.io server. The changelog for the badge-m
|
||||
- set a longer cacheLength on [librariesio] badges [#7692](https://github.com/badges/shields/issues/7692)
|
||||
- improve python version formatting [#7682](https://github.com/badges/shields/issues/7682)
|
||||
- Clarify GitHub All Contributors badge [#7690](https://github.com/badges/shields/issues/7690)
|
||||
- Fix GitHub Deployments example color [#7691](https://github.com/badges/shields/issues/7691)
|
||||
- Support [HexPM] packages with no stable release [#7685](https://github.com/badges/shields/issues/7685)
|
||||
- Add Test at Scale Badge [#7612](https://github.com/badges/shields/issues/7612)
|
||||
- Fix [SnykVulnerability] test [#7686](https://github.com/badges/shields/issues/7686)
|
||||
- Support for Test at Scale Badge, run [TAS] [#7612](https://github.com/badges/shields/issues/7612)
|
||||
- [packagist] api v2 support [#7681](https://github.com/badges/shields/issues/7681)
|
||||
- Add [piwheels] version badge [#7656](https://github.com/badges/shields/issues/7656)
|
||||
- Dependency updates
|
||||
|
||||
@@ -23,8 +23,6 @@ FROM node:16-alpine
|
||||
|
||||
ARG version=dev
|
||||
ENV DOCKER_SHIELDS_VERSION=$version
|
||||
LABEL version=$version
|
||||
LABEL fly.version=$version
|
||||
|
||||
# Run the server using production configs.
|
||||
ENV NODE_ENV production
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
'use strict'
|
||||
|
||||
const { toSvgColor } = require('./color')
|
||||
const { normalizeColor, toSvgColor } = require('./color')
|
||||
const badgeRenderers = require('./badge-renderers')
|
||||
const { stripXmlWhitespace } = require('./xml')
|
||||
|
||||
@@ -9,6 +9,7 @@ note: makeBadge() is fairly thinly wrapped so if we are making changes here
|
||||
it is likely this will impact on the package's public interface in index.js
|
||||
*/
|
||||
module.exports = function makeBadge({
|
||||
format,
|
||||
style = 'flat',
|
||||
label,
|
||||
message,
|
||||
@@ -23,6 +24,22 @@ module.exports = function makeBadge({
|
||||
label = `${label}`.trim()
|
||||
message = `${message}`.trim()
|
||||
|
||||
// This ought to be the responsibility of the server, not `makeBadge`.
|
||||
if (format === 'json') {
|
||||
return JSON.stringify({
|
||||
label,
|
||||
message,
|
||||
logoWidth,
|
||||
// Only call normalizeColor for the JSON case: this is handled
|
||||
// internally by toSvgColor in the SVG case.
|
||||
color: normalizeColor(color),
|
||||
labelColor: normalizeColor(labelColor),
|
||||
link: links,
|
||||
name: label,
|
||||
value: message,
|
||||
})
|
||||
}
|
||||
|
||||
const render = badgeRenderers[style]
|
||||
if (!render) {
|
||||
throw new Error(`Unknown badge style: '${style}'`)
|
||||
|
||||
@@ -1,48 +1,143 @@
|
||||
'use strict'
|
||||
|
||||
const { test, given, forCases } = require('sazerac')
|
||||
const { expect } = require('chai')
|
||||
const snapshot = require('snap-shot-it')
|
||||
const isSvg = require('is-svg')
|
||||
const prettier = require('prettier')
|
||||
const makeBadge = require('./make-badge')
|
||||
|
||||
function expectBadgeToMatchSnapshot(badgeData) {
|
||||
snapshot(prettier.format(makeBadge(badgeData), { parser: 'html' }))
|
||||
function expectBadgeToMatchSnapshot(format) {
|
||||
snapshot(prettier.format(makeBadge(format), { parser: 'html' }))
|
||||
}
|
||||
|
||||
function testColor(color = '', colorAttr = 'color') {
|
||||
return JSON.parse(
|
||||
makeBadge({
|
||||
label: 'name',
|
||||
message: 'Bob',
|
||||
[colorAttr]: color,
|
||||
format: 'json',
|
||||
})
|
||||
).color
|
||||
}
|
||||
|
||||
describe('The badge generator', function () {
|
||||
describe('color test', function () {
|
||||
test(testColor, () => {
|
||||
// valid hex
|
||||
forCases([
|
||||
given('#4c1'),
|
||||
given('#4C1'),
|
||||
given('4C1'),
|
||||
given('4c1'),
|
||||
]).expect('#4c1')
|
||||
forCases([
|
||||
given('#abc123'),
|
||||
given('#ABC123'),
|
||||
given('abc123'),
|
||||
given('ABC123'),
|
||||
]).expect('#abc123')
|
||||
// valid rgb(a)
|
||||
given('rgb(0,128,255)').expect('rgb(0,128,255)')
|
||||
given('rgb(220,128,255,0.5)').expect('rgb(220,128,255,0.5)')
|
||||
given('rgba(0,0,255)').expect('rgba(0,0,255)')
|
||||
given('rgba(0,128,255,0)').expect('rgba(0,128,255,0)')
|
||||
// valid hsl(a)
|
||||
given('hsl(100, 56%, 10%)').expect('hsl(100, 56%, 10%)')
|
||||
given('hsl(360,50%,50%,0.5)').expect('hsl(360,50%,50%,0.5)')
|
||||
given('hsla(25,20%,0%,0.1)').expect('hsla(25,20%,0%,0.1)')
|
||||
given('hsla(0,50%,101%)').expect('hsla(0,50%,101%)')
|
||||
// CSS named color.
|
||||
given('papayawhip').expect('papayawhip')
|
||||
// Shields named color.
|
||||
given('red').expect('red')
|
||||
given('green').expect('green')
|
||||
given('blue').expect('blue')
|
||||
given('yellow').expect('yellow')
|
||||
// Semantic color alias
|
||||
given('success').expect('brightgreen')
|
||||
given('informational').expect('blue')
|
||||
|
||||
forCases(
|
||||
// invalid hex
|
||||
given('#123red'), // contains letter above F
|
||||
given('#red'), // contains letter above F
|
||||
// neither a css named color nor colorscheme
|
||||
given('notacolor'),
|
||||
given('bluish'),
|
||||
given('almostred'),
|
||||
given('brightmaroon'),
|
||||
given('cactus')
|
||||
).expect(undefined)
|
||||
})
|
||||
})
|
||||
|
||||
describe('color aliases', function () {
|
||||
test(testColor, () => {
|
||||
forCases([given('#4c1', 'color')]).expect('#4c1')
|
||||
})
|
||||
})
|
||||
|
||||
describe('SVG', function () {
|
||||
it('should produce SVG', function () {
|
||||
expect(makeBadge({ label: 'cactus', message: 'grown' }))
|
||||
expect(makeBadge({ label: 'cactus', message: 'grown', format: 'svg' }))
|
||||
.to.satisfy(isSvg)
|
||||
.and.to.include('cactus')
|
||||
.and.to.include('grown')
|
||||
})
|
||||
|
||||
it('should match snapshot', function () {
|
||||
expectBadgeToMatchSnapshot({ label: 'cactus', message: 'grown' })
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('JSON', function () {
|
||||
it('should produce the expected JSON', function () {
|
||||
const json = makeBadge({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'json',
|
||||
links: ['https://example.com/', 'https://other.example.com/'],
|
||||
})
|
||||
expect(JSON.parse(json)).to.deep.equal({
|
||||
name: 'cactus',
|
||||
label: 'cactus',
|
||||
value: 'grown',
|
||||
message: 'grown',
|
||||
link: ['https://example.com/', 'https://other.example.com/'],
|
||||
})
|
||||
})
|
||||
|
||||
it('should replace undefined svg badge style with "flat"', function () {
|
||||
expect(
|
||||
makeBadge({
|
||||
label: 'name',
|
||||
message: 'Bob',
|
||||
})
|
||||
)
|
||||
.to.satisfy(isSvg)
|
||||
.and.to.equal(
|
||||
makeBadge({
|
||||
label: 'name',
|
||||
message: 'Bob',
|
||||
style: 'flat',
|
||||
})
|
||||
)
|
||||
const jsonBadgeWithUnknownStyle = makeBadge({
|
||||
label: 'name',
|
||||
message: 'Bob',
|
||||
format: 'svg',
|
||||
})
|
||||
const jsonBadgeWithDefaultStyle = makeBadge({
|
||||
label: 'name',
|
||||
message: 'Bob',
|
||||
format: 'svg',
|
||||
style: 'flat',
|
||||
})
|
||||
expect(jsonBadgeWithUnknownStyle)
|
||||
.to.equal(jsonBadgeWithDefaultStyle)
|
||||
.and.to.satisfy(isSvg)
|
||||
})
|
||||
|
||||
it('should fail with unknown svg badge style', function () {
|
||||
expect(() =>
|
||||
makeBadge({ label: 'name', message: 'Bob', style: 'unknown_style' })
|
||||
makeBadge({
|
||||
label: 'name',
|
||||
message: 'Bob',
|
||||
format: 'svg',
|
||||
style: 'unknown_style',
|
||||
})
|
||||
).to.throw(Error, "Unknown badge style: 'unknown_style'")
|
||||
})
|
||||
})
|
||||
@@ -52,6 +147,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'flat',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -62,6 +158,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'flat',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -73,6 +170,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: '',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'flat',
|
||||
color: '#b3e',
|
||||
})
|
||||
@@ -82,6 +180,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: '',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'flat',
|
||||
color: '#b3e',
|
||||
logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
|
||||
@@ -92,6 +191,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: '',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'flat',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -103,6 +203,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'flat',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -114,6 +215,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'flat',
|
||||
color: '#000',
|
||||
labelColor: '#f3f3f3',
|
||||
@@ -124,6 +226,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'flat',
|
||||
color: '#e2ffe1',
|
||||
labelColor: '#000',
|
||||
@@ -136,6 +239,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'flat-square',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -146,6 +250,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'flat-square',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -157,6 +262,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: '',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'flat-square',
|
||||
color: '#b3e',
|
||||
})
|
||||
@@ -166,6 +272,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: '',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'flat-square',
|
||||
color: '#b3e',
|
||||
logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
|
||||
@@ -176,6 +283,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: '',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'flat-square',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -187,6 +295,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'flat-square',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -198,6 +307,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'flat-square',
|
||||
color: '#000',
|
||||
labelColor: '#f3f3f3',
|
||||
@@ -208,6 +318,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'flat-square',
|
||||
color: '#e2ffe1',
|
||||
labelColor: '#000',
|
||||
@@ -220,6 +331,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'plastic',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -230,6 +342,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'plastic',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -241,6 +354,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: '',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'plastic',
|
||||
color: '#b3e',
|
||||
})
|
||||
@@ -250,6 +364,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: '',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'plastic',
|
||||
color: '#b3e',
|
||||
logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
|
||||
@@ -260,6 +375,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: '',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'plastic',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -271,6 +387,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'plastic',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -282,6 +399,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'plastic',
|
||||
color: '#000',
|
||||
labelColor: '#f3f3f3',
|
||||
@@ -292,6 +410,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'plastic',
|
||||
color: '#e2ffe1',
|
||||
labelColor: '#000',
|
||||
@@ -306,6 +425,7 @@ describe('The badge generator', function () {
|
||||
makeBadge({
|
||||
label: 1998,
|
||||
message: 1999,
|
||||
format: 'svg',
|
||||
style: 'for-the-badge',
|
||||
})
|
||||
)
|
||||
@@ -318,6 +438,7 @@ describe('The badge generator', function () {
|
||||
makeBadge({
|
||||
label: 'Label',
|
||||
message: '1 string',
|
||||
format: 'svg',
|
||||
style: 'for-the-badge',
|
||||
})
|
||||
)
|
||||
@@ -329,6 +450,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'for-the-badge',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -339,6 +461,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'for-the-badge',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -350,6 +473,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: '',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'for-the-badge',
|
||||
color: '#b3e',
|
||||
})
|
||||
@@ -359,6 +483,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: '',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'for-the-badge',
|
||||
color: '#b3e',
|
||||
logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
|
||||
@@ -369,6 +494,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: '',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'for-the-badge',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -380,6 +506,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'for-the-badge',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -391,6 +518,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'for-the-badge',
|
||||
color: '#000',
|
||||
labelColor: '#f3f3f3',
|
||||
@@ -401,6 +529,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'for-the-badge',
|
||||
color: '#e2ffe1',
|
||||
labelColor: '#000',
|
||||
@@ -414,6 +543,7 @@ describe('The badge generator', function () {
|
||||
makeBadge({
|
||||
label: 'some-key',
|
||||
message: 'some-value',
|
||||
format: 'svg',
|
||||
style: 'social',
|
||||
})
|
||||
)
|
||||
@@ -427,10 +557,11 @@ describe('The badge generator', function () {
|
||||
makeBadge({
|
||||
label: '',
|
||||
message: 'some-value',
|
||||
format: 'json',
|
||||
style: 'social',
|
||||
})
|
||||
)
|
||||
.to.include('></text>')
|
||||
.to.include('""')
|
||||
.and.to.include('some-value')
|
||||
})
|
||||
|
||||
@@ -438,6 +569,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'social',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -448,6 +580,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'social',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -459,6 +592,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: '',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'social',
|
||||
color: '#b3e',
|
||||
})
|
||||
@@ -468,6 +602,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: '',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'social',
|
||||
color: '#b3e',
|
||||
logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
|
||||
@@ -478,6 +613,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: '',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'social',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -489,6 +625,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
format: 'svg',
|
||||
style: 'social',
|
||||
color: '#b3e',
|
||||
labelColor: '#0f0',
|
||||
@@ -502,6 +639,7 @@ describe('The badge generator', function () {
|
||||
expectBadgeToMatchSnapshot({
|
||||
label: 'label',
|
||||
message: 'message',
|
||||
format: 'svg',
|
||||
logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1,29 +1,58 @@
|
||||
import makeBadge from '../../badge-maker/lib/make-badge.js'
|
||||
import BaseService from './base.js'
|
||||
import {
|
||||
serverHasBeenUpSinceResourceCached,
|
||||
setCacheHeadersForStaticResource,
|
||||
} from './cache-headers.js'
|
||||
import { prepareRoute } from './route.js'
|
||||
import { makeSend } from './legacy-result-sender.js'
|
||||
import { MetricHelper } from './metric-helper.js'
|
||||
import coalesceBadge from './coalesce-badge.js'
|
||||
import { prepareRoute, namedParamsForMatch } from './route.js'
|
||||
|
||||
export default class BaseStaticService extends BaseService {
|
||||
static _applyCacheHeaders({ res }) {
|
||||
setCacheHeadersForStaticResource(res)
|
||||
}
|
||||
static register({ camp, metricInstance }, serviceConfig) {
|
||||
const { regex, captureNames } = prepareRoute(this.route)
|
||||
|
||||
static register({ app, ...serviceContext }, serviceConfig) {
|
||||
const { regex } = prepareRoute(this.route)
|
||||
app.get(
|
||||
regex,
|
||||
(req, res, next) => {
|
||||
if (serverHasBeenUpSinceResourceCached(req)) {
|
||||
// Send Not Modified.
|
||||
res.status(304)
|
||||
res.end()
|
||||
} else {
|
||||
next()
|
||||
}
|
||||
},
|
||||
this.makeExpressHandler(serviceContext, serviceConfig)
|
||||
)
|
||||
const metricHelper = MetricHelper.create({
|
||||
metricInstance,
|
||||
ServiceClass: this,
|
||||
})
|
||||
|
||||
camp.route(regex, async (queryParams, match, end, ask) => {
|
||||
if (serverHasBeenUpSinceResourceCached(ask.req)) {
|
||||
// Send Not Modified.
|
||||
ask.res.statusCode = 304
|
||||
ask.res.end()
|
||||
return
|
||||
}
|
||||
|
||||
const metricHandle = metricHelper.startRequest()
|
||||
|
||||
const namedParams = namedParamsForMatch(captureNames, match, this)
|
||||
const serviceData = await this.invoke(
|
||||
{},
|
||||
serviceConfig,
|
||||
namedParams,
|
||||
queryParams
|
||||
)
|
||||
|
||||
const badgeData = coalesceBadge(
|
||||
queryParams,
|
||||
serviceData,
|
||||
this.defaultBadgeData,
|
||||
this
|
||||
)
|
||||
|
||||
// The final capture group is the extension.
|
||||
const format = (match.slice(-1)[0] || '.svg').replace(/^\./, '')
|
||||
badgeData.format = format
|
||||
|
||||
setCacheHeadersForStaticResource(ask.res)
|
||||
|
||||
const svg = makeBadge(badgeData)
|
||||
makeSend(format, ask.res, end)(svg)
|
||||
|
||||
metricHandle.noteResponseSent()
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,13 +6,8 @@
|
||||
import emojic from 'emojic'
|
||||
import Joi from 'joi'
|
||||
import log from '../server/log.js'
|
||||
import makeBadge from '../../badge-maker/lib/make-badge.js'
|
||||
import { AuthHelper } from './auth-helper.js'
|
||||
import { MetricHelper, MetricNames } from './metric-helper.js'
|
||||
import {
|
||||
coalesceCacheLength,
|
||||
setHeadersForCacheLength,
|
||||
} from './cache-headers.js'
|
||||
import { assertValidCategory } from './categories.js'
|
||||
import checkErrorResponse from './check-error-response.js'
|
||||
import coalesceBadge from './coalesce-badge.js'
|
||||
@@ -26,12 +21,11 @@ import {
|
||||
} from './errors.js'
|
||||
import { validateExample, transformExample } from './examples.js'
|
||||
import { fetch } from './got.js'
|
||||
import { makeJsonBadge } from './make-json-badge.js'
|
||||
import {
|
||||
makeFullUrl,
|
||||
assertValidRoute,
|
||||
paramsForReq,
|
||||
prepareRoute,
|
||||
namedParamsForMatch,
|
||||
getQueryParamNames,
|
||||
} from './route.js'
|
||||
import { assertValidServiceDefinition } from './service-definitions.js'
|
||||
@@ -429,90 +423,60 @@ class BaseService {
|
||||
return serviceData
|
||||
}
|
||||
|
||||
// `defaultCacheLengthSeconds` can be overridden by
|
||||
// `serviceDefaultCacheLengthSeconds` (either by category or on a badge-
|
||||
// by-badge basis). Then in turn that can be overridden by
|
||||
// `serviceOverrideCacheLengthSeconds` (which we expect to be used only in
|
||||
// the dynamic badge) but only if `serviceOverrideCacheLengthSeconds` is
|
||||
// longer than `serviceDefaultCacheLengthSeconds` and then the `cacheSeconds`
|
||||
// query param can also override both of those but again only if `cacheSeconds`
|
||||
// is longer.
|
||||
//
|
||||
// Ref: https://github.com/badges/shields/pull/2755
|
||||
static _applyCacheHeaders({
|
||||
cacheHeaderConfig,
|
||||
req,
|
||||
res,
|
||||
serviceOverrideCacheLengthSeconds,
|
||||
}) {
|
||||
const cacheLengthSeconds = coalesceCacheLength({
|
||||
cacheHeaderConfig,
|
||||
serviceDefaultCacheLengthSeconds: this._cacheLength,
|
||||
serviceOverrideCacheLengthSeconds,
|
||||
queryParams: req.query,
|
||||
})
|
||||
setHeadersForCacheLength(res, cacheLengthSeconds)
|
||||
}
|
||||
|
||||
static makeExpressHandler(
|
||||
{ githubApiProvider, librariesIoApiProvider, metricInstance },
|
||||
static register(
|
||||
{
|
||||
camp,
|
||||
handleRequest,
|
||||
githubApiProvider,
|
||||
librariesIoApiProvider,
|
||||
metricInstance,
|
||||
},
|
||||
serviceConfig
|
||||
) {
|
||||
const { cacheHeaders: cacheHeaderConfig } = serviceConfig
|
||||
const { regex, captureNames } = prepareRoute(this.route)
|
||||
const queryParams = getQueryParamNames(this.route)
|
||||
|
||||
const metricHelper = MetricHelper.create({
|
||||
metricInstance,
|
||||
ServiceClass: this,
|
||||
})
|
||||
const { captureNames } = prepareRoute(this.route)
|
||||
const { cacheHeaders: cacheHeaderConfig } = serviceConfig
|
||||
|
||||
return async (req, res) => {
|
||||
const metricHandle = metricHelper.startRequest()
|
||||
camp.route(
|
||||
regex,
|
||||
handleRequest(cacheHeaderConfig, {
|
||||
queryParams,
|
||||
handler: async (queryParams, match, sendBadge) => {
|
||||
const metricHandle = metricHelper.startRequest()
|
||||
|
||||
const { namedParams, format } = paramsForReq(captureNames, req, this)
|
||||
const serviceData = await this.invoke(
|
||||
{
|
||||
requestFetcher: fetch,
|
||||
githubApiProvider,
|
||||
librariesIoApiProvider,
|
||||
metricHelper,
|
||||
const namedParams = namedParamsForMatch(captureNames, match, this)
|
||||
const serviceData = await this.invoke(
|
||||
{
|
||||
requestFetcher: fetch,
|
||||
githubApiProvider,
|
||||
librariesIoApiProvider,
|
||||
metricHelper,
|
||||
},
|
||||
serviceConfig,
|
||||
namedParams,
|
||||
queryParams
|
||||
)
|
||||
|
||||
const badgeData = coalesceBadge(
|
||||
queryParams,
|
||||
serviceData,
|
||||
this.defaultBadgeData,
|
||||
this
|
||||
)
|
||||
// The final capture group is the extension.
|
||||
const format = (match.slice(-1)[0] || '.svg').replace(/^\./, '')
|
||||
sendBadge(format, badgeData)
|
||||
|
||||
metricHandle.noteResponseSent()
|
||||
},
|
||||
serviceConfig,
|
||||
namedParams,
|
||||
req.query
|
||||
)
|
||||
|
||||
const badgeData = coalesceBadge(
|
||||
req.query,
|
||||
serviceData,
|
||||
this.defaultBadgeData,
|
||||
this
|
||||
)
|
||||
|
||||
this._applyCacheHeaders({
|
||||
cacheHeaderConfig,
|
||||
req,
|
||||
res,
|
||||
serviceOverrideCacheLengthSeconds: badgeData.cacheLengthSeconds,
|
||||
cacheLength: this._cacheLength,
|
||||
})
|
||||
|
||||
if (format === 'svg') {
|
||||
res.setHeader('Content-Type', 'image/svg+xml')
|
||||
res.send(makeBadge(badgeData))
|
||||
} else if (format === 'json') {
|
||||
res.json(makeJsonBadge(badgeData))
|
||||
} else {
|
||||
throw Error(`Unrecognized format: ${format}`)
|
||||
}
|
||||
|
||||
res.end()
|
||||
|
||||
metricHandle.noteResponseSent()
|
||||
}
|
||||
}
|
||||
|
||||
static register({ app, ...serviceContext }, serviceConfig) {
|
||||
const { regex } = prepareRoute(this.route)
|
||||
app.get(regex, this.makeExpressHandler(serviceContext, serviceConfig))
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
import Joi from 'joi'
|
||||
import chai from 'chai'
|
||||
import isSvg from 'is-svg'
|
||||
import sinon from 'sinon'
|
||||
import prometheus from 'prom-client'
|
||||
import chaiAsPromised from 'chai-as-promised'
|
||||
import PrometheusMetrics from '../server/prometheus-metrics.js'
|
||||
import { ExpressTestHarness } from '../express-test-harness.js'
|
||||
import trace from './trace.js'
|
||||
import {
|
||||
NotFound,
|
||||
@@ -17,7 +15,6 @@ import {
|
||||
import BaseService from './base.js'
|
||||
import { MetricHelper, MetricNames } from './metric-helper.js'
|
||||
import '../register-chai-plugins.spec.js'
|
||||
|
||||
const { expect } = chai
|
||||
chai.use(chaiAsPromised)
|
||||
|
||||
@@ -62,12 +59,9 @@ class DummyServiceWithServiceResponseSizeMetricEnabled extends DummyService {
|
||||
|
||||
describe('BaseService', function () {
|
||||
const defaultConfig = {
|
||||
handleInternalErrors: false,
|
||||
cacheHeaders: { defaultCacheLengthSeconds: 120 },
|
||||
public: {
|
||||
handleInternalErrors: false,
|
||||
services: {},
|
||||
cacheHeaders: { defaultCacheLengthSeconds: 120 },
|
||||
},
|
||||
private: {},
|
||||
}
|
||||
@@ -327,45 +321,62 @@ describe('BaseService', function () {
|
||||
})
|
||||
})
|
||||
|
||||
describe('Express integration', function () {
|
||||
let harness
|
||||
beforeEach(async function () {
|
||||
harness = new ExpressTestHarness()
|
||||
DummyService.register({ app: harness.app }, defaultConfig)
|
||||
await harness.start()
|
||||
})
|
||||
describe('ScoutCamp integration', function () {
|
||||
// TODO Strangly, without the useless escape the regexes do not match in Node 12.
|
||||
// eslint-disable-next-line no-useless-escape
|
||||
const expectedRouteRegex = /^\/foo(?:\/([^\/#\?]+?))(|\.svg|\.json)$/
|
||||
|
||||
afterEach(async function () {
|
||||
await harness.stop()
|
||||
})
|
||||
let mockCamp
|
||||
let mockHandleRequest
|
||||
|
||||
it('fulfills the request for an SVG badge', async function () {
|
||||
const { headers, body } = await harness.get(
|
||||
'/foo/bar.svg?queryParamA=%3F'
|
||||
beforeEach(function () {
|
||||
mockCamp = {
|
||||
route: sinon.spy(),
|
||||
}
|
||||
mockHandleRequest = sinon.spy()
|
||||
DummyService.register(
|
||||
{ camp: mockCamp, handleRequest: mockHandleRequest },
|
||||
defaultConfig
|
||||
)
|
||||
|
||||
expect(headers).to.include({
|
||||
'content-type': 'image/svg+xml; charset=utf-8',
|
||||
})
|
||||
|
||||
expect(body)
|
||||
.to.satisfy(isSvg)
|
||||
.and.to.include('cat: Hello namedParamA: bar with queryParamA: ?')
|
||||
})
|
||||
|
||||
it('fulfills the request for a JSON badge', async function () {
|
||||
const { headers, body } = await harness.get(
|
||||
'/foo/bar.json?queryParamA=%3F',
|
||||
{ responseType: 'json' }
|
||||
)
|
||||
it('registers the service', function () {
|
||||
expect(mockCamp.route).to.have.been.calledOnce
|
||||
expect(mockCamp.route).to.have.been.calledWith(expectedRouteRegex)
|
||||
})
|
||||
|
||||
expect(headers).to.include({
|
||||
'content-type': 'application/json; charset=utf-8',
|
||||
})
|
||||
it('handles the request', async function () {
|
||||
expect(mockHandleRequest).to.have.been.calledOnce
|
||||
|
||||
expect(body).to.include({
|
||||
const { queryParams: serviceQueryParams, handler: requestHandler } =
|
||||
mockHandleRequest.getCall(0).args[1]
|
||||
expect(serviceQueryParams).to.deep.equal([
|
||||
'queryParamA',
|
||||
'legacyQueryParamA',
|
||||
])
|
||||
|
||||
const mockSendBadge = sinon.spy()
|
||||
const mockRequest = {
|
||||
asPromise: sinon.spy(),
|
||||
}
|
||||
const queryParams = { queryParamA: '?' }
|
||||
const match = '/foo/bar.svg'.match(expectedRouteRegex)
|
||||
await requestHandler(queryParams, match, mockSendBadge, mockRequest)
|
||||
|
||||
const expectedFormat = 'svg'
|
||||
expect(mockSendBadge).to.have.been.calledOnce
|
||||
expect(mockSendBadge).to.have.been.calledWith(expectedFormat, {
|
||||
label: 'cat',
|
||||
message: 'Hello namedParamA: bar with queryParamA: ?',
|
||||
color: 'lightgrey',
|
||||
style: 'flat',
|
||||
namedLogo: undefined,
|
||||
logo: undefined,
|
||||
logoWidth: undefined,
|
||||
logoPosition: undefined,
|
||||
links: [],
|
||||
labelColor: undefined,
|
||||
cacheLengthSeconds: undefined,
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -563,7 +574,9 @@ describe('BaseService', function () {
|
||||
},
|
||||
private: {},
|
||||
},
|
||||
{ namedParamA: 'bar.bar.bar' }
|
||||
{
|
||||
namedParamA: 'bar.bar.bar',
|
||||
}
|
||||
)
|
||||
).to.deep.equal({
|
||||
color: 'lightgray',
|
||||
|
||||
143
core/base-service/legacy-request-handler.js
Normal file
143
core/base-service/legacy-request-handler.js
Normal file
@@ -0,0 +1,143 @@
|
||||
import makeBadge from '../../badge-maker/lib/make-badge.js'
|
||||
import { setCacheHeaders } from './cache-headers.js'
|
||||
import { makeSend } from './legacy-result-sender.js'
|
||||
import coalesceBadge from './coalesce-badge.js'
|
||||
|
||||
// These query parameters are available to any badge. They are handled by
|
||||
// `coalesceBadge`.
|
||||
const globalQueryParams = new Set([
|
||||
'label',
|
||||
'style',
|
||||
'link',
|
||||
'logo',
|
||||
'logoColor',
|
||||
'logoPosition',
|
||||
'logoWidth',
|
||||
'link',
|
||||
'colorA',
|
||||
'colorB',
|
||||
'color',
|
||||
'labelColor',
|
||||
])
|
||||
|
||||
function flattenQueryParams(queryParams) {
|
||||
const union = new Set(globalQueryParams)
|
||||
;(queryParams || []).forEach(name => {
|
||||
union.add(name)
|
||||
})
|
||||
return Array.from(union).sort()
|
||||
}
|
||||
|
||||
// handlerOptions can contain:
|
||||
// - handler: The service's request handler function
|
||||
// - queryParams: An array of the field names of any custom query parameters
|
||||
// the service uses
|
||||
// - cacheLength: An optional badge or category-specific cache length
|
||||
// (in number of seconds) to be used in preference to the default
|
||||
//
|
||||
// For safety, the service must declare the query parameters it wants to use.
|
||||
// Only the declared parameters (and the global parameters) are provided to
|
||||
// the service. Consequently, failure to declare a parameter results in the
|
||||
// parameter not working at all (which is undesirable, but easy to debug)
|
||||
// rather than indeterminate behavior that depends on the cache state
|
||||
// (undesirable and hard to debug).
|
||||
//
|
||||
// Pass just the handler function as shorthand.
|
||||
function handleRequest(cacheHeaderConfig, handlerOptions) {
|
||||
if (!cacheHeaderConfig) {
|
||||
throw Error('cacheHeaderConfig is required')
|
||||
}
|
||||
|
||||
if (typeof handlerOptions === 'function') {
|
||||
handlerOptions = { handler: handlerOptions }
|
||||
}
|
||||
|
||||
const allowedKeys = flattenQueryParams(handlerOptions.queryParams)
|
||||
const { cacheLength: serviceDefaultCacheLengthSeconds } = handlerOptions
|
||||
|
||||
return (queryParams, match, end, ask) => {
|
||||
/*
|
||||
This is here for legacy reasons. The badge server and frontend used to live
|
||||
on two different servers. When we merged them there was a conflict so we
|
||||
did this to avoid moving the endpoint docs to another URL.
|
||||
|
||||
Never ever do this again.
|
||||
*/
|
||||
if (match[0] === '/endpoint' && Object.keys(queryParams).length === 0) {
|
||||
ask.res.statusCode = 301
|
||||
ask.res.setHeader('Location', '/endpoint/')
|
||||
ask.res.end()
|
||||
return
|
||||
}
|
||||
|
||||
// `defaultCacheLengthSeconds` can be overridden by
|
||||
// `serviceDefaultCacheLengthSeconds` (either by category or on a badge-
|
||||
// by-badge basis). Then in turn that can be overridden by
|
||||
// `serviceOverrideCacheLengthSeconds` (which we expect to be used only in
|
||||
// the dynamic badge) but only if `serviceOverrideCacheLengthSeconds` is
|
||||
// longer than `serviceDefaultCacheLengthSeconds` and then the `cacheSeconds`
|
||||
// query param can also override both of those but again only if `cacheSeconds`
|
||||
// is longer.
|
||||
//
|
||||
// When the legacy services have been rewritten, all the code in here
|
||||
// will go away, which should achieve this goal in a simpler way.
|
||||
//
|
||||
// Ref: https://github.com/badges/shields/pull/2755
|
||||
function setCacheHeadersOnResponse(res, serviceOverrideCacheLengthSeconds) {
|
||||
setCacheHeaders({
|
||||
cacheHeaderConfig,
|
||||
serviceDefaultCacheLengthSeconds,
|
||||
serviceOverrideCacheLengthSeconds,
|
||||
queryParams,
|
||||
res,
|
||||
})
|
||||
}
|
||||
|
||||
const filteredQueryParams = {}
|
||||
allowedKeys.forEach(key => {
|
||||
filteredQueryParams[key] = queryParams[key]
|
||||
})
|
||||
|
||||
// In case our vendor servers are unresponsive.
|
||||
let serverUnresponsive = false
|
||||
const serverResponsive = setTimeout(() => {
|
||||
serverUnresponsive = true
|
||||
ask.res.setHeader('Cache-Control', 'no-cache, no-store, must-revalidate')
|
||||
const badgeData = coalesceBadge(
|
||||
filteredQueryParams,
|
||||
{ label: 'vendor', message: 'unresponsive' },
|
||||
{}
|
||||
)
|
||||
const svg = makeBadge(badgeData)
|
||||
const extension = (match.slice(-1)[0] || '.svg').replace(/^\./, '')
|
||||
setCacheHeadersOnResponse(ask.res)
|
||||
makeSend(extension, ask.res, end)(svg)
|
||||
}, 25000)
|
||||
|
||||
const result = handlerOptions.handler(
|
||||
filteredQueryParams,
|
||||
match,
|
||||
// eslint-disable-next-line mocha/prefer-arrow-callback
|
||||
function sendBadge(format, badgeData) {
|
||||
if (serverUnresponsive) {
|
||||
return
|
||||
}
|
||||
clearTimeout(serverResponsive)
|
||||
// Add format to badge data.
|
||||
badgeData.format = format
|
||||
const svg = makeBadge(badgeData)
|
||||
setCacheHeadersOnResponse(ask.res, badgeData.cacheLengthSeconds)
|
||||
makeSend(format, ask.res, end)(svg)
|
||||
}
|
||||
)
|
||||
// eslint-disable-next-line promise/prefer-await-to-then
|
||||
if (result && result.catch) {
|
||||
// eslint-disable-next-line promise/prefer-await-to-then
|
||||
result.catch(err => {
|
||||
throw err
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export { handleRequest }
|
||||
251
core/base-service/legacy-request-handler.spec.js
Normal file
251
core/base-service/legacy-request-handler.spec.js
Normal file
@@ -0,0 +1,251 @@
|
||||
import { expect } from 'chai'
|
||||
import portfinder from 'portfinder'
|
||||
import Camp from '@shields_io/camp'
|
||||
import got from '../got-test-client.js'
|
||||
import coalesceBadge from './coalesce-badge.js'
|
||||
import { handleRequest } from './legacy-request-handler.js'
|
||||
|
||||
async function performTwoRequests(baseUrl, first, second) {
|
||||
expect((await got(`${baseUrl}${first}`)).statusCode).to.equal(200)
|
||||
expect((await got(`${baseUrl}${second}`)).statusCode).to.equal(200)
|
||||
}
|
||||
|
||||
function fakeHandler(queryParams, match, sendBadge, request) {
|
||||
const [, someValue, format] = match
|
||||
const badgeData = coalesceBadge(
|
||||
queryParams,
|
||||
{
|
||||
label: 'testing',
|
||||
message: someValue,
|
||||
},
|
||||
{}
|
||||
)
|
||||
sendBadge(format, badgeData)
|
||||
}
|
||||
|
||||
function createFakeHandlerWithCacheLength(cacheLengthSeconds) {
|
||||
return function fakeHandler(queryParams, match, sendBadge, request) {
|
||||
const [, someValue, format] = match
|
||||
const badgeData = coalesceBadge(
|
||||
queryParams,
|
||||
{
|
||||
label: 'testing',
|
||||
message: someValue,
|
||||
},
|
||||
{},
|
||||
{
|
||||
_cacheLength: cacheLengthSeconds,
|
||||
}
|
||||
)
|
||||
sendBadge(format, badgeData)
|
||||
}
|
||||
}
|
||||
|
||||
describe('The request handler', function () {
|
||||
let port, baseUrl
|
||||
beforeEach(async function () {
|
||||
port = await portfinder.getPortPromise()
|
||||
baseUrl = `http://127.0.0.1:${port}`
|
||||
})
|
||||
|
||||
let camp
|
||||
beforeEach(function (done) {
|
||||
camp = Camp.start({ port, hostname: '::' })
|
||||
camp.on('listening', () => done())
|
||||
})
|
||||
afterEach(function (done) {
|
||||
if (camp) {
|
||||
camp.close(() => done())
|
||||
camp = null
|
||||
}
|
||||
})
|
||||
|
||||
const standardCacheHeaders = { defaultCacheLengthSeconds: 120 }
|
||||
|
||||
describe('the options object calling style', function () {
|
||||
beforeEach(function () {
|
||||
camp.route(
|
||||
/^\/testing\/([^/]+)\.(svg|png|gif|jpg|json)$/,
|
||||
handleRequest(standardCacheHeaders, { handler: fakeHandler })
|
||||
)
|
||||
})
|
||||
|
||||
it('should return the expected response', async function () {
|
||||
const { statusCode, body } = await got(`${baseUrl}/testing/123.json`, {
|
||||
responseType: 'json',
|
||||
})
|
||||
expect(statusCode).to.equal(200)
|
||||
expect(body).to.deep.equal({
|
||||
name: 'testing',
|
||||
value: '123',
|
||||
label: 'testing',
|
||||
message: '123',
|
||||
color: 'lightgrey',
|
||||
link: [],
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('the function shorthand calling style', function () {
|
||||
beforeEach(function () {
|
||||
camp.route(
|
||||
/^\/testing\/([^/]+)\.(svg|png|gif|jpg|json)$/,
|
||||
handleRequest(standardCacheHeaders, fakeHandler)
|
||||
)
|
||||
})
|
||||
|
||||
it('should return the expected response', async function () {
|
||||
const { statusCode, body } = await got(`${baseUrl}/testing/123.json`, {
|
||||
responseType: 'json',
|
||||
})
|
||||
expect(statusCode).to.equal(200)
|
||||
expect(body).to.deep.equal({
|
||||
name: 'testing',
|
||||
value: '123',
|
||||
label: 'testing',
|
||||
message: '123',
|
||||
color: 'lightgrey',
|
||||
link: [],
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('caching', function () {
|
||||
describe('standard query parameters', function () {
|
||||
function register({ cacheHeaderConfig }) {
|
||||
camp.route(
|
||||
/^\/testing\/([^/]+)\.(svg|png|gif|jpg|json)$/,
|
||||
handleRequest(
|
||||
cacheHeaderConfig,
|
||||
(queryParams, match, sendBadge, request) => {
|
||||
fakeHandler(queryParams, match, sendBadge, request)
|
||||
}
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
it('should set the expires header to current time + defaultCacheLengthSeconds', async function () {
|
||||
register({ cacheHeaderConfig: { defaultCacheLengthSeconds: 900 } })
|
||||
const { headers } = await got(`${baseUrl}/testing/123.json`)
|
||||
const expectedExpiry = new Date(
|
||||
+new Date(headers.date) + 900000
|
||||
).toGMTString()
|
||||
expect(headers.expires).to.equal(expectedExpiry)
|
||||
expect(headers['cache-control']).to.equal('max-age=900, s-maxage=900')
|
||||
})
|
||||
|
||||
it('should set the expected cache headers on cached responses', async function () {
|
||||
register({ cacheHeaderConfig: { defaultCacheLengthSeconds: 900 } })
|
||||
|
||||
// Make first request.
|
||||
await got(`${baseUrl}/testing/123.json`)
|
||||
|
||||
const { headers } = await got(`${baseUrl}/testing/123.json`)
|
||||
const expectedExpiry = new Date(
|
||||
+new Date(headers.date) + 900000
|
||||
).toGMTString()
|
||||
expect(headers.expires).to.equal(expectedExpiry)
|
||||
expect(headers['cache-control']).to.equal('max-age=900, s-maxage=900')
|
||||
})
|
||||
|
||||
it('should let live service data override the default cache headers with longer value', async function () {
|
||||
camp.route(
|
||||
/^\/testing\/([^/]+)\.(svg|png|gif|jpg|json)$/,
|
||||
handleRequest(
|
||||
{ defaultCacheLengthSeconds: 300 },
|
||||
(queryParams, match, sendBadge, request) => {
|
||||
createFakeHandlerWithCacheLength(400)(
|
||||
queryParams,
|
||||
match,
|
||||
sendBadge,
|
||||
request
|
||||
)
|
||||
}
|
||||
)
|
||||
)
|
||||
|
||||
const { headers } = await got(`${baseUrl}/testing/123.json`)
|
||||
expect(headers['cache-control']).to.equal('max-age=400, s-maxage=400')
|
||||
})
|
||||
|
||||
it('should not let live service data override the default cache headers with shorter value', async function () {
|
||||
camp.route(
|
||||
/^\/testing\/([^/]+)\.(svg|png|gif|jpg|json)$/,
|
||||
handleRequest(
|
||||
{ defaultCacheLengthSeconds: 300 },
|
||||
(queryParams, match, sendBadge, request) => {
|
||||
createFakeHandlerWithCacheLength(200)(
|
||||
queryParams,
|
||||
match,
|
||||
sendBadge,
|
||||
request
|
||||
)
|
||||
}
|
||||
)
|
||||
)
|
||||
|
||||
const { headers } = await got(`${baseUrl}/testing/123.json`)
|
||||
expect(headers['cache-control']).to.equal('max-age=300, s-maxage=300')
|
||||
})
|
||||
|
||||
it('should set the expires header to current time + cacheSeconds', async function () {
|
||||
register({ cacheHeaderConfig: { defaultCacheLengthSeconds: 0 } })
|
||||
const { headers } = await got(
|
||||
`${baseUrl}/testing/123.json?cacheSeconds=3600`
|
||||
)
|
||||
const expectedExpiry = new Date(
|
||||
+new Date(headers.date) + 3600000
|
||||
).toGMTString()
|
||||
expect(headers.expires).to.equal(expectedExpiry)
|
||||
expect(headers['cache-control']).to.equal('max-age=3600, s-maxage=3600')
|
||||
})
|
||||
|
||||
it('should ignore cacheSeconds when shorter than defaultCacheLengthSeconds', async function () {
|
||||
register({ cacheHeaderConfig: { defaultCacheLengthSeconds: 600 } })
|
||||
const { headers } = await got(
|
||||
`${baseUrl}/testing/123.json?cacheSeconds=300`
|
||||
)
|
||||
const expectedExpiry = new Date(
|
||||
+new Date(headers.date) + 600000
|
||||
).toGMTString()
|
||||
expect(headers.expires).to.equal(expectedExpiry)
|
||||
expect(headers['cache-control']).to.equal('max-age=600, s-maxage=600')
|
||||
})
|
||||
|
||||
it('should set Cache-Control: no-cache, no-store, must-revalidate if cache seconds is 0', async function () {
|
||||
register({ cacheHeaderConfig: { defaultCacheLengthSeconds: 0 } })
|
||||
const { headers } = await got(`${baseUrl}/testing/123.json`)
|
||||
expect(headers.expires).to.equal(headers.date)
|
||||
expect(headers['cache-control']).to.equal(
|
||||
'no-cache, no-store, must-revalidate'
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
describe('custom query parameters', function () {
|
||||
let handlerCallCount
|
||||
beforeEach(function () {
|
||||
handlerCallCount = 0
|
||||
camp.route(
|
||||
/^\/testing\/([^/]+)\.(svg|png|gif|jpg|json)$/,
|
||||
handleRequest(standardCacheHeaders, {
|
||||
queryParams: ['foo'],
|
||||
handler: (queryParams, match, sendBadge, request) => {
|
||||
++handlerCallCount
|
||||
fakeHandler(queryParams, match, sendBadge, request)
|
||||
},
|
||||
})
|
||||
)
|
||||
})
|
||||
|
||||
it('should differentiate them', async function () {
|
||||
await performTwoRequests(
|
||||
baseUrl,
|
||||
'/testing/123.svg?foo=1',
|
||||
'/testing/123.svg?foo=2'
|
||||
)
|
||||
expect(handlerCallCount).to.equal(2)
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
35
core/base-service/legacy-result-sender.js
Normal file
35
core/base-service/legacy-result-sender.js
Normal file
@@ -0,0 +1,35 @@
|
||||
import stream from 'stream'
|
||||
|
||||
function streamFromString(str) {
|
||||
const newStream = new stream.Readable()
|
||||
newStream._read = () => {
|
||||
newStream.push(str)
|
||||
newStream.push(null)
|
||||
}
|
||||
return newStream
|
||||
}
|
||||
|
||||
function sendSVG(res, askres, end) {
|
||||
askres.setHeader('Content-Type', 'image/svg+xml;charset=utf-8')
|
||||
askres.setHeader('Content-Length', Buffer.byteLength(res, 'utf8'))
|
||||
end(null, { template: streamFromString(res) })
|
||||
}
|
||||
|
||||
function sendJSON(res, askres, end) {
|
||||
askres.setHeader('Content-Type', 'application/json')
|
||||
askres.setHeader('Access-Control-Allow-Origin', '*')
|
||||
askres.setHeader('Content-Length', Buffer.byteLength(res, 'utf8'))
|
||||
end(null, { template: streamFromString(res) })
|
||||
}
|
||||
|
||||
function makeSend(format, askres, end) {
|
||||
if (format === 'svg') {
|
||||
return res => sendSVG(res, askres, end)
|
||||
} else if (format === 'json') {
|
||||
return res => sendJSON(res, askres, end)
|
||||
} else {
|
||||
throw Error(`Unrecognized format: ${format}`)
|
||||
}
|
||||
}
|
||||
|
||||
export { makeSend }
|
||||
@@ -1,16 +0,0 @@
|
||||
import { normalizeColor } from 'badge-maker/lib/color.js'
|
||||
|
||||
export function makeJsonBadge(badgeData) {
|
||||
const { label, message, logoWidth, color, labelColor, links } = badgeData
|
||||
|
||||
return {
|
||||
label,
|
||||
message,
|
||||
logoWidth,
|
||||
color: normalizeColor(color),
|
||||
labelColor: normalizeColor(labelColor),
|
||||
link: links,
|
||||
name: label,
|
||||
value: message,
|
||||
}
|
||||
}
|
||||
@@ -1,23 +0,0 @@
|
||||
import { expect } from 'chai'
|
||||
import { makeJsonBadge } from './make-json-badge.js'
|
||||
|
||||
describe('makeJsonBadge()', function () {
|
||||
it('should produce the expected JSON', function () {
|
||||
expect(
|
||||
makeJsonBadge({
|
||||
label: 'cactus',
|
||||
message: 'grown',
|
||||
links: ['https://example.com/', 'https://other.example.com/'],
|
||||
})
|
||||
).to.deep.equal({
|
||||
name: 'cactus',
|
||||
label: 'cactus',
|
||||
value: 'grown',
|
||||
message: 'grown',
|
||||
link: ['https://example.com/', 'https://other.example.com/'],
|
||||
color: undefined,
|
||||
labelColor: undefined,
|
||||
logoWidth: undefined,
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -1,4 +1,3 @@
|
||||
import url from 'url'
|
||||
import camelcase from 'camelcase'
|
||||
import emojic from 'emojic'
|
||||
import Joi from 'joi'
|
||||
@@ -10,7 +9,7 @@ import {
|
||||
} from './cache-headers.js'
|
||||
import { isValidCategory } from './categories.js'
|
||||
import { MetricHelper } from './metric-helper.js'
|
||||
import { isValidRoute, prepareRoute, paramsForReq } from './route.js'
|
||||
import { isValidRoute, prepareRoute, namedParamsForMatch } from './route.js'
|
||||
import trace from './trace.js'
|
||||
|
||||
const attrSchema = Joi.object({
|
||||
@@ -55,7 +54,7 @@ export default function redirector(attrs) {
|
||||
static route = route
|
||||
static examples = examples
|
||||
|
||||
static register({ app, metricInstance }, { rasterUrl }) {
|
||||
static register({ camp, metricInstance }, { rasterUrl }) {
|
||||
const { regex, captureNames } = prepareRoute({
|
||||
...this.route,
|
||||
withPng: Boolean(rasterUrl),
|
||||
@@ -66,17 +65,17 @@ export default function redirector(attrs) {
|
||||
ServiceClass: this,
|
||||
})
|
||||
|
||||
app.get(regex, async (req, res) => {
|
||||
if (serverHasBeenUpSinceResourceCached(req)) {
|
||||
camp.route(regex, async (queryParams, match, end, ask) => {
|
||||
if (serverHasBeenUpSinceResourceCached(ask.req)) {
|
||||
// Send Not Modified.
|
||||
res.status(304)
|
||||
res.end()
|
||||
ask.res.statusCode = 304
|
||||
ask.res.end()
|
||||
return
|
||||
}
|
||||
|
||||
const metricHandle = metricHelper.startRequest()
|
||||
|
||||
const { namedParams, format } = paramsForReq(captureNames, req, this)
|
||||
const namedParams = namedParamsForMatch(captureNames, match, this)
|
||||
trace.logTrace(
|
||||
'inbound',
|
||||
emojic.arrowHeadingUp,
|
||||
@@ -84,12 +83,12 @@ export default function redirector(attrs) {
|
||||
route.base
|
||||
)
|
||||
trace.logTrace('inbound', emojic.ticket, 'Named params', namedParams)
|
||||
trace.logTrace('inbound', emojic.crayon, 'Query params', req.query)
|
||||
trace.logTrace('inbound', emojic.crayon, 'Query params', queryParams)
|
||||
|
||||
const targetPath = encodeURI(transformPath(namedParams))
|
||||
trace.logTrace('validate', emojic.dart, 'Target', targetPath)
|
||||
|
||||
let urlSuffix = url.parse(req.url).search ?? '' // eslint-disable-line node/no-deprecated-api
|
||||
let urlSuffix = ask.uri.search || ''
|
||||
|
||||
if (transformQueryParams) {
|
||||
const specifiedParams = queryString.parse(urlSuffix)
|
||||
@@ -101,18 +100,21 @@ export default function redirector(attrs) {
|
||||
urlSuffix = `?${outQueryString}`
|
||||
}
|
||||
|
||||
const baseUrl = format === 'png' ? rasterUrl : ''
|
||||
const redirectUrl = `${baseUrl}${targetPath}.${format}${urlSuffix}`
|
||||
// The final capture group is the extension.
|
||||
const format = (match.slice(-1)[0] || '.svg').replace(/^\./, '')
|
||||
const redirectUrl = `${
|
||||
format === 'png' ? rasterUrl : ''
|
||||
}${targetPath}.${format}${urlSuffix}`
|
||||
trace.logTrace('outbound', emojic.shield, 'Redirect URL', redirectUrl)
|
||||
|
||||
res.status(301)
|
||||
res.setHeader('Location', redirectUrl)
|
||||
ask.res.statusCode = 301
|
||||
ask.res.setHeader('Location', redirectUrl)
|
||||
|
||||
// To avoid caching mistakes for a long time, and to make this simpler
|
||||
// to reason about, use the same cache semantics as the static badge.
|
||||
setCacheHeadersForStaticResource(res)
|
||||
setCacheHeadersForStaticResource(ask.res)
|
||||
|
||||
res.end()
|
||||
ask.res.end()
|
||||
|
||||
metricHandle.noteResponseSent()
|
||||
})
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
import Camp from '@shields_io/camp'
|
||||
import portfinder from 'portfinder'
|
||||
import { expect } from 'chai'
|
||||
import { ExpressTestHarness } from '../express-test-harness.js'
|
||||
import got from '../got-test-client.js'
|
||||
import redirector from './redirector.js'
|
||||
|
||||
describe('Redirector', function () {
|
||||
@@ -61,12 +63,28 @@ describe('Redirector', function () {
|
||||
expect(redirector({ ...attrs, examples }).examples).to.equal(examples)
|
||||
})
|
||||
|
||||
describe('Express integration', function () {
|
||||
describe('ScoutCamp integration', function () {
|
||||
let port, baseUrl
|
||||
beforeEach(async function () {
|
||||
port = await portfinder.getPortPromise()
|
||||
baseUrl = `http://127.0.0.1:${port}`
|
||||
})
|
||||
|
||||
let camp
|
||||
beforeEach(async function () {
|
||||
camp = Camp.start({ port, hostname: '::' })
|
||||
await new Promise(resolve => camp.on('listening', () => resolve()))
|
||||
})
|
||||
afterEach(async function () {
|
||||
if (camp) {
|
||||
await new Promise(resolve => camp.close(resolve))
|
||||
camp = undefined
|
||||
}
|
||||
})
|
||||
|
||||
const transformPath = ({ namedParamA }) => `/new/service/${namedParamA}`
|
||||
|
||||
let harness
|
||||
beforeEach(async function () {
|
||||
harness = new ExpressTestHarness()
|
||||
beforeEach(function () {
|
||||
const ServiceClass = redirector({
|
||||
category,
|
||||
route,
|
||||
@@ -74,20 +92,17 @@ describe('Redirector', function () {
|
||||
dateAdded,
|
||||
})
|
||||
ServiceClass.register(
|
||||
{ app: harness.app },
|
||||
{ camp },
|
||||
{ rasterUrl: 'http://raster.example.test' }
|
||||
)
|
||||
await harness.start()
|
||||
})
|
||||
|
||||
afterEach(async function () {
|
||||
await harness.stop()
|
||||
})
|
||||
|
||||
it('should redirect as configured', async function () {
|
||||
const { statusCode, headers } = await harness.get(
|
||||
'/very/old/service/hello-world.svg',
|
||||
{ followRedirect: false }
|
||||
const { statusCode, headers } = await got(
|
||||
`${baseUrl}/very/old/service/hello-world.svg`,
|
||||
{
|
||||
followRedirect: false,
|
||||
}
|
||||
)
|
||||
|
||||
expect(statusCode).to.equal(301)
|
||||
@@ -95,9 +110,11 @@ describe('Redirector', function () {
|
||||
})
|
||||
|
||||
it('should redirect raster extensions to the canonical path as configured', async function () {
|
||||
const { statusCode, headers } = await harness.get(
|
||||
'/very/old/service/hello-world.png',
|
||||
{ followRedirect: false }
|
||||
const { statusCode, headers } = await got(
|
||||
`${baseUrl}/very/old/service/hello-world.png`,
|
||||
{
|
||||
followRedirect: false,
|
||||
}
|
||||
)
|
||||
|
||||
expect(statusCode).to.equal(301)
|
||||
@@ -107,9 +124,11 @@ describe('Redirector', function () {
|
||||
})
|
||||
|
||||
it('should forward the query params', async function () {
|
||||
const { statusCode, headers } = await harness.get(
|
||||
'/very/old/service/hello-world.svg?color=123&style=flat-square',
|
||||
{ followRedirect: false }
|
||||
const { statusCode, headers } = await got(
|
||||
`${baseUrl}/very/old/service/hello-world.svg?color=123&style=flat-square`,
|
||||
{
|
||||
followRedirect: false,
|
||||
}
|
||||
)
|
||||
|
||||
expect(statusCode).to.equal(301)
|
||||
@@ -119,9 +138,11 @@ describe('Redirector', function () {
|
||||
})
|
||||
|
||||
it('should correctly encode the redirect URL', async function () {
|
||||
const { statusCode, headers } = await harness.get(
|
||||
'/very/old/service/hello%0Dworld.svg?foobar=a%0Db',
|
||||
{ followRedirect: false }
|
||||
const { statusCode, headers } = await got(
|
||||
`${baseUrl}/very/old/service/hello%0Dworld.svg?foobar=a%0Db`,
|
||||
{
|
||||
followRedirect: false,
|
||||
}
|
||||
)
|
||||
|
||||
expect(statusCode).to.equal(301)
|
||||
@@ -145,13 +166,15 @@ describe('Redirector', function () {
|
||||
transformQueryParams,
|
||||
dateAdded,
|
||||
})
|
||||
ServiceClass.register({ app: harness.app }, {})
|
||||
ServiceClass.register({ camp }, {})
|
||||
})
|
||||
|
||||
it('should forward the transformed query params', async function () {
|
||||
const { statusCode, headers } = await harness.get(
|
||||
'/another/old/service/token/abc123/hello-world.svg',
|
||||
{ followRedirect: false }
|
||||
const { statusCode, headers } = await got(
|
||||
`${baseUrl}/another/old/service/token/abc123/hello-world.svg`,
|
||||
{
|
||||
followRedirect: false,
|
||||
}
|
||||
)
|
||||
|
||||
expect(statusCode).to.equal(301)
|
||||
@@ -161,9 +184,11 @@ describe('Redirector', function () {
|
||||
})
|
||||
|
||||
it('should forward the specified and transformed query params', async function () {
|
||||
const { statusCode, headers } = await harness.get(
|
||||
'/another/old/service/token/abc123/hello-world.svg?color=123&style=flat-square',
|
||||
{ followRedirect: false }
|
||||
const { statusCode, headers } = await got(
|
||||
`${baseUrl}/another/old/service/token/abc123/hello-world.svg?color=123&style=flat-square`,
|
||||
{
|
||||
followRedirect: false,
|
||||
}
|
||||
)
|
||||
|
||||
expect(statusCode).to.equal(301)
|
||||
@@ -173,9 +198,11 @@ describe('Redirector', function () {
|
||||
})
|
||||
|
||||
it('should use transformed query params on param conflicts by default', async function () {
|
||||
const { statusCode, headers } = await harness.get(
|
||||
'/another/old/service/token/abc123/hello-world.svg?color=123&style=flat-square&token=def456',
|
||||
{ followRedirect: false }
|
||||
const { statusCode, headers } = await got(
|
||||
`${baseUrl}/another/old/service/token/abc123/hello-world.svg?color=123&style=flat-square&token=def456`,
|
||||
{
|
||||
followRedirect: false,
|
||||
}
|
||||
)
|
||||
|
||||
expect(statusCode).to.equal(301)
|
||||
@@ -197,10 +224,12 @@ describe('Redirector', function () {
|
||||
overrideTransformedQueryParams: true,
|
||||
dateAdded,
|
||||
})
|
||||
ServiceClass.register({ app: harness.app }, {})
|
||||
const { statusCode, headers } = await harness.get(
|
||||
'/override/service/token/abc123/hello-world.svg?style=flat-square&token=def456',
|
||||
{ followRedirect: false }
|
||||
ServiceClass.register({ camp }, {})
|
||||
const { statusCode, headers } = await got(
|
||||
`${baseUrl}/override/service/token/abc123/hello-world.svg?style=flat-square&token=def456`,
|
||||
{
|
||||
followRedirect: false,
|
||||
}
|
||||
)
|
||||
|
||||
expect(statusCode).to.equal(301)
|
||||
|
||||
@@ -44,29 +44,23 @@ function prepareRoute({ base, pattern, format, capture, withPng }) {
|
||||
return { regex, captureNames }
|
||||
}
|
||||
|
||||
function paramsForReq(captureNames = [], req, ServiceClass) {
|
||||
// In addition to the parameters declared by the service, we have one match
|
||||
// for the format.
|
||||
const expectedNamedParamCount = Object.keys(req.params).length - 1
|
||||
if (captureNames.length !== expectedNamedParamCount) {
|
||||
function namedParamsForMatch(captureNames = [], match, ServiceClass) {
|
||||
// Assume the last match is the format, and drop match[0], which is the
|
||||
// entire match.
|
||||
const captures = match.slice(1, -1)
|
||||
|
||||
if (captureNames.length !== captures.length) {
|
||||
throw new Error(
|
||||
`Service ${ServiceClass.name} declares incorrect number of named params ` +
|
||||
`(expected ${expectedNamedParamCount}, got ${captureNames.length})`
|
||||
`(expected ${captures.length}, got ${captureNames.length})`
|
||||
)
|
||||
}
|
||||
|
||||
const namedParams = {}
|
||||
const result = {}
|
||||
captureNames.forEach((name, index) => {
|
||||
namedParams[name] = req.params[index]
|
||||
result[name] = captures[index]
|
||||
})
|
||||
|
||||
// The final capture group is the extension.
|
||||
const format = (req.params[expectedNamedParamCount] || '.svg').replace(
|
||||
/^\./,
|
||||
''
|
||||
)
|
||||
|
||||
return { namedParams, format }
|
||||
return result
|
||||
}
|
||||
|
||||
function getQueryParamNames({ queryParamSchema }) {
|
||||
@@ -83,6 +77,6 @@ export {
|
||||
isValidRoute,
|
||||
assertValidRoute,
|
||||
prepareRoute,
|
||||
paramsForReq,
|
||||
namedParamsForMatch,
|
||||
getQueryParamNames,
|
||||
}
|
||||
|
||||
@@ -1,25 +1,13 @@
|
||||
import { expect } from 'chai'
|
||||
import Joi from 'joi'
|
||||
import { test, given } from 'sazerac'
|
||||
import { prepareRoute, paramsForReq, getQueryParamNames } from './route.js'
|
||||
|
||||
function paramsForPath({ regex, captureNames, ServiceClass }, path) {
|
||||
// Prepare a mock express `req` object.
|
||||
const params = {}
|
||||
regex.exec(path).forEach((param, i) => {
|
||||
// regex.exec(path)[0] contains the entire path. We want [1] ... [n].
|
||||
if (i > 0) {
|
||||
params[i - 1] = param
|
||||
}
|
||||
})
|
||||
const req = { params }
|
||||
|
||||
return paramsForReq(captureNames, req, ServiceClass)
|
||||
}
|
||||
import { test, given, forCases } from 'sazerac'
|
||||
import {
|
||||
prepareRoute,
|
||||
namedParamsForMatch,
|
||||
getQueryParamNames,
|
||||
} from './route.js'
|
||||
|
||||
describe('Route helpers', function () {
|
||||
const ServiceClass = { name: 'MyService' }
|
||||
|
||||
context('A `pattern` with a named param is declared', function () {
|
||||
const { regex, captureNames } = prepareRoute({
|
||||
base: 'foo',
|
||||
@@ -27,31 +15,22 @@ describe('Route helpers', function () {
|
||||
queryParamSchema: Joi.object({ queryParamA: Joi.string() }).required(),
|
||||
})
|
||||
|
||||
const regexExec = path => regex.exec(path)
|
||||
const regexExec = str => regex.exec(str)
|
||||
test(regexExec, () => {
|
||||
given('/foo/bar/bar.svg').expect(null)
|
||||
})
|
||||
|
||||
const params = path =>
|
||||
paramsForPath({ regex, captureNames, ServiceClass }, path)
|
||||
test(params, () => {
|
||||
given('/foo/bar.bar.bar.svg').expect({
|
||||
namedParams: { namedParamA: 'bar.bar.bar' },
|
||||
format: 'svg',
|
||||
})
|
||||
given('/foo/bar.bar.bar.json').expect({
|
||||
namedParams: { namedParamA: 'bar.bar.bar' },
|
||||
format: 'json',
|
||||
})
|
||||
const namedParams = str =>
|
||||
namedParamsForMatch(captureNames, regex.exec(str))
|
||||
test(namedParams, () => {
|
||||
forCases([
|
||||
given('/foo/bar.bar.bar.svg'),
|
||||
given('/foo/bar.bar.bar.json'),
|
||||
]).expect({ namedParamA: 'bar.bar.bar' })
|
||||
|
||||
// This pattern catches bugs related to escaping the extension separator.
|
||||
given('/foo/bar.bar.bar_svg').expect({
|
||||
namedParams: { namedParamA: 'bar.bar.bar_svg' },
|
||||
format: 'svg',
|
||||
})
|
||||
given('/foo/bar.bar.bar.zip').expect({
|
||||
namedParams: { namedParamA: 'bar.bar.bar.zip' },
|
||||
format: 'svg',
|
||||
})
|
||||
given('/foo/bar.bar.bar_svg').expect({ namedParamA: 'bar.bar.bar_svg' })
|
||||
given('/foo/bar.bar.bar.zip').expect({ namedParamA: 'bar.bar.bar.zip' })
|
||||
})
|
||||
})
|
||||
|
||||
@@ -67,41 +46,33 @@ describe('Route helpers', function () {
|
||||
given('/foo/bar/bar.svg').expect(null)
|
||||
})
|
||||
|
||||
const params = path =>
|
||||
paramsForPath({ regex, captureNames, ServiceClass }, path)
|
||||
test(params, () => {
|
||||
given('/foo/bar.bar.bar.svg').expect({
|
||||
namedParams: { namedParamA: 'bar.bar.bar' },
|
||||
format: 'svg',
|
||||
})
|
||||
given('/foo/bar.bar.bar.json').expect({
|
||||
namedParams: { namedParamA: 'bar.bar.bar' },
|
||||
format: 'json',
|
||||
})
|
||||
const namedParams = str =>
|
||||
namedParamsForMatch(captureNames, regex.exec(str))
|
||||
test(namedParams, () => {
|
||||
forCases([
|
||||
given('/foo/bar.bar.bar.svg'),
|
||||
given('/foo/bar.bar.bar.json'),
|
||||
]).expect({ namedParamA: 'bar.bar.bar' })
|
||||
|
||||
// This pattern catches bugs related to escaping the extension separator.
|
||||
given('/foo/bar.bar.bar_svg').expect({
|
||||
namedParams: { namedParamA: 'bar.bar.bar_svg' },
|
||||
format: 'svg',
|
||||
})
|
||||
given('/foo/bar.bar.bar.zip').expect({
|
||||
namedParams: { namedParamA: 'bar.bar.bar.zip' },
|
||||
format: 'svg',
|
||||
})
|
||||
given('/foo/bar.bar.bar_svg').expect({ namedParamA: 'bar.bar.bar_svg' })
|
||||
given('/foo/bar.bar.bar.zip').expect({ namedParamA: 'bar.bar.bar.zip' })
|
||||
})
|
||||
})
|
||||
|
||||
context('No named params are declared', function () {
|
||||
const { regex, captureNames } = prepareRoute({
|
||||
base: 'foo',
|
||||
format: '(?:[^/]+?)',
|
||||
format: '(?:[^/]+)',
|
||||
})
|
||||
|
||||
const params = path =>
|
||||
paramsForPath({ regex, captureNames, ServiceClass }, path)
|
||||
test(params, () => {
|
||||
given('/foo/bar.bar.bar.svg').expect({ namedParams: {}, format: 'svg' })
|
||||
given('/foo/bar.bar.bar.json').expect({ namedParams: {}, format: 'json' })
|
||||
const namedParams = str =>
|
||||
namedParamsForMatch(captureNames, regex.exec(str))
|
||||
test(namedParams, () => {
|
||||
forCases([
|
||||
given('/foo/bar.bar.bar.svg'),
|
||||
given('/foo/bar.bar.bar.json'),
|
||||
]).expect({})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -112,13 +83,13 @@ describe('Route helpers', function () {
|
||||
capture: ['namedParamA'],
|
||||
})
|
||||
|
||||
it('Throws the expected error', function () {
|
||||
expect(() =>
|
||||
paramsForPath({ regex, captureNames, ServiceClass }, '/foo/bar/baz.svg')
|
||||
).to.throw(
|
||||
'Service MyService declares incorrect number of named params (expected 2, got 1)'
|
||||
)
|
||||
})
|
||||
expect(() =>
|
||||
namedParamsForMatch(captureNames, regex.exec('/foo/bar/baz.svg'), {
|
||||
name: 'MyService',
|
||||
})
|
||||
).to.throw(
|
||||
'Service MyService declares incorrect number of named params (expected 2, got 1)'
|
||||
)
|
||||
})
|
||||
|
||||
it('getQueryParamNames', function () {
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
import express from 'express'
|
||||
import portfinder from 'portfinder'
|
||||
import got from './got-test-client.js'
|
||||
|
||||
export class ExpressTestHarness {
|
||||
constructor() {
|
||||
this.app = express()
|
||||
}
|
||||
|
||||
async start() {
|
||||
const port = (this.port = await portfinder.getPortPromise())
|
||||
this.baseUrl = `http://127.0.0.1:${port}`
|
||||
await new Promise(resolve => {
|
||||
this.server = this.app.listen({ host: '::', port }, () => resolve())
|
||||
})
|
||||
}
|
||||
|
||||
async stop() {
|
||||
await new Promise(resolve => this.server.close(resolve))
|
||||
}
|
||||
|
||||
ensureStarted() {
|
||||
if (!this.server) {
|
||||
throw Error('Server has not been started')
|
||||
}
|
||||
}
|
||||
|
||||
async get(url, options) {
|
||||
this.ensureStarted()
|
||||
return got.get(`${this.baseUrl}${url}`, options)
|
||||
}
|
||||
|
||||
async post(url, options) {
|
||||
this.ensureStarted()
|
||||
return got.post(`${this.baseUrl}${url}`, options)
|
||||
}
|
||||
}
|
||||
@@ -37,13 +37,12 @@ export default class PrometheusMetrics {
|
||||
})
|
||||
}
|
||||
|
||||
async registerMetricsEndpoint(app) {
|
||||
async registerMetricsEndpoint(server) {
|
||||
const { register } = this
|
||||
|
||||
app.get('/metrics', async (req, res) => {
|
||||
res.setHeader('Content-Type', register.contentType)
|
||||
res.send(await register.metrics())
|
||||
res.end()
|
||||
server.route(/^\/metrics$/, async (data, match, end, ask) => {
|
||||
ask.res.setHeader('Content-Type', register.contentType)
|
||||
ask.res.end(await register.metrics())
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
@@ -1,24 +1,32 @@
|
||||
import { expect } from 'chai'
|
||||
import { ExpressTestHarness } from '../express-test-harness.js'
|
||||
import Camp from '@shields_io/camp'
|
||||
import portfinder from 'portfinder'
|
||||
import got from '../got-test-client.js'
|
||||
import Metrics from './prometheus-metrics.js'
|
||||
|
||||
describe('Prometheus metrics route', function () {
|
||||
let harness, metrics
|
||||
let port, baseUrl, camp, metrics
|
||||
beforeEach(async function () {
|
||||
harness = new ExpressTestHarness()
|
||||
|
||||
metrics = new Metrics()
|
||||
metrics.registerMetricsEndpoint(harness.app)
|
||||
|
||||
await harness.start()
|
||||
port = await portfinder.getPortPromise()
|
||||
baseUrl = `http://127.0.0.1:${port}`
|
||||
camp = Camp.start({ port, hostname: '::' })
|
||||
await new Promise(resolve => camp.on('listening', () => resolve()))
|
||||
})
|
||||
|
||||
afterEach(async function () {
|
||||
await harness.stop()
|
||||
if (metrics) {
|
||||
metrics.stop()
|
||||
}
|
||||
if (camp) {
|
||||
await new Promise(resolve => camp.close(resolve))
|
||||
camp = undefined
|
||||
}
|
||||
})
|
||||
|
||||
it('returns default metrics', async function () {
|
||||
const { statusCode, body } = await harness.get('/metrics')
|
||||
metrics = new Metrics()
|
||||
metrics.registerMetricsEndpoint(camp)
|
||||
|
||||
const { statusCode, body } = await got(`${baseUrl}/metrics`)
|
||||
|
||||
expect(statusCode).to.be.equal(200)
|
||||
expect(body).to.contain('nodejs_version_info')
|
||||
|
||||
66
core/server/public/monitor.html
Normal file
66
core/server/public/monitor.html
Normal file
@@ -0,0 +1,66 @@
|
||||
<!doctype html><meta charset=utf-8>
|
||||
<title> Shields.io Admin Monitoring Interface </title>
|
||||
<style>
|
||||
#monitorPlatform { display: none; }
|
||||
</style>
|
||||
|
||||
<div id=passwordRequest>
|
||||
<p> Please enter your admin secret here:
|
||||
<input type=password id=secretInput>
|
||||
</div>
|
||||
<div id=monitorPlatform>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
(function() {
|
||||
let network;
|
||||
const onLoad = function() {
|
||||
const secretInput = document.getElementById('secretInput');
|
||||
const onSecretChange = function() {
|
||||
const secret = secretInput.value;
|
||||
const authentication = `monitor:${secret}`;
|
||||
const headers = new Headers({
|
||||
Authorization: `Basic ${btoa(authentication)}`
|
||||
})
|
||||
fetch('/sys/network', {headers})
|
||||
.then(res => res.json())
|
||||
.then(networkData => {
|
||||
network = networkData;
|
||||
// Show monitor platform.
|
||||
monitorPlatform.style.display = 'block';
|
||||
passwordRequest.parentNode.removeChild(passwordRequest);
|
||||
|
||||
// Show logs for each server.
|
||||
network.ips.forEach(ip => {
|
||||
const logger = document.createElement('div');
|
||||
const pre = document.createElement('pre');
|
||||
logger.textContent = ip;
|
||||
logger.appendChild(pre);
|
||||
monitorPlatform.appendChild(logger);
|
||||
|
||||
// Set up the websocket.
|
||||
const setUpWebsocket = () => {
|
||||
const websocket = new WebSocket(
|
||||
(window.location.protocol === 'http:' ? 'ws' : 'wss') + '://' +
|
||||
ip + ':' + window.location.port + '/sys/logs');
|
||||
websocket.addEventListener('message', event => {
|
||||
pre.textContent += event.data + '\n';
|
||||
});
|
||||
websocket.addEventListener('close', () => {
|
||||
setTimeout(setUpWebsocket, 100);
|
||||
});
|
||||
websocket.addEventListener('open', () => {
|
||||
websocket.send(JSON.stringify({secret}));
|
||||
});
|
||||
};
|
||||
setUpWebsocket();
|
||||
});
|
||||
})
|
||||
.catch(alert)
|
||||
};
|
||||
secretInput.addEventListener('change', onSecretChange);
|
||||
};
|
||||
|
||||
addEventListener('DOMContentLoaded', onLoad);
|
||||
}());
|
||||
</script>
|
||||
@@ -2,20 +2,19 @@
|
||||
* @module
|
||||
*/
|
||||
|
||||
import http from 'http'
|
||||
import https from 'https'
|
||||
import path from 'path'
|
||||
import url, { fileURLToPath } from 'url'
|
||||
import express from 'express'
|
||||
import { bootstrap } from 'global-agent'
|
||||
import cloudflareMiddleware from 'cloudflare-middleware'
|
||||
import Camp from '@shields_io/camp'
|
||||
import originalJoi from 'joi'
|
||||
import makeBadge from '../../badge-maker/lib/make-badge.js'
|
||||
import GithubConstellation from '../../services/github/github-constellation.js'
|
||||
import LibrariesIoConstellation from '../../services/librariesio/librariesio-constellation.js'
|
||||
import { setRoutes as setSuggestRoutes } from '../../services/suggest.js'
|
||||
import { setRoutes } from '../../services/suggest.js'
|
||||
import { loadServiceClasses } from '../base-service/loader.js'
|
||||
import { makeJsonBadge } from '../base-service/make-json-badge.js'
|
||||
import { makeSend } from '../base-service/legacy-result-sender.js'
|
||||
import { handleRequest } from '../base-service/legacy-request-handler.js'
|
||||
import { clearResourceCache } from '../base-service/resource-cache.js'
|
||||
import { rasterRedirectUrl } from '../badge-urls/make-badge-url.js'
|
||||
import { fileSize, nonNegativeInteger } from '../../services/validators.js'
|
||||
@@ -141,9 +140,7 @@ const publicConfigSchema = Joi.object({
|
||||
weblate: defaultService,
|
||||
trace: Joi.boolean().required(),
|
||||
}).required(),
|
||||
cacheHeaders: Joi.object({
|
||||
defaultCacheLengthSeconds: nonNegativeInteger,
|
||||
}).required(),
|
||||
cacheHeaders: { defaultCacheLengthSeconds: nonNegativeInteger },
|
||||
handleInternalErrors: Joi.boolean().required(),
|
||||
fetchLimit: fileSize,
|
||||
userAgentBase: Joi.string().required(),
|
||||
@@ -200,11 +197,23 @@ const privateMetricsInfluxConfigSchema = privateConfigSchema.append({
|
||||
influx_password: Joi.string().required(),
|
||||
})
|
||||
|
||||
function addHandlerAtIndex(camp, index, handlerFn) {
|
||||
camp.stack.splice(index, 0, handlerFn)
|
||||
}
|
||||
|
||||
function isOnHeroku() {
|
||||
return !!process.env.DYNO
|
||||
}
|
||||
|
||||
function isOnFly() {
|
||||
return !!process.env.FLY_APP_NAME
|
||||
}
|
||||
|
||||
/**
|
||||
* The Server is based on Express. It creates an http server and sets up helpers
|
||||
* for token persistence and monitoring. Then it loads all the services,
|
||||
* injecting dependencies, as it asks each one to register its route with
|
||||
* Express.
|
||||
* The Server is based on the web framework Scoutcamp. It creates
|
||||
* an http server, sets up helpers for token persistence and monitoring.
|
||||
* Then it loads all the services, injecting dependencies as it
|
||||
* asks each one to register its route with Scoutcamp.
|
||||
*/
|
||||
class Server {
|
||||
/**
|
||||
@@ -297,25 +306,43 @@ class Server {
|
||||
|
||||
// See https://www.viget.com/articles/heroku-cloudflare-the-right-way/
|
||||
requireCloudflare() {
|
||||
const { app } = this
|
||||
app.use(cloudflareMiddleware())
|
||||
// Set `req.ip`, which is expected by `cloudflareMiddleware()`. This is set
|
||||
// by Express but not Scoutcamp.
|
||||
addHandlerAtIndex(this.camp, 0, function (req, res, next) {
|
||||
if (isOnHeroku()) {
|
||||
// On Heroku, `req.socket.remoteAddress` is the Heroku router. However,
|
||||
// the router ensures that the last item in the `X-Forwarded-For` header
|
||||
// is the real origin.
|
||||
// https://stackoverflow.com/a/18517550/893113
|
||||
req.ip = req.headers['x-forwarded-for'].split(', ').pop()
|
||||
} else if (isOnFly()) {
|
||||
// On Fly we can use the Fly-Client-IP header
|
||||
// https://fly.io/docs/reference/runtime-environment/#request-headers
|
||||
req.ip = req.headers['fly-client-ip']
|
||||
} else {
|
||||
req.ip = req.socket.remoteAddress
|
||||
}
|
||||
next()
|
||||
})
|
||||
addHandlerAtIndex(this.camp, 1, cloudflareMiddleware())
|
||||
}
|
||||
|
||||
/**
|
||||
* Set up Express routes for 404/not found responses.
|
||||
* Set up Scoutcamp routes for 404/not found responses
|
||||
*/
|
||||
registerErrorHandlers() {
|
||||
const { app, config } = this
|
||||
const { camp, config } = this
|
||||
const {
|
||||
public: { rasterUrl },
|
||||
} = config
|
||||
|
||||
app.get(/\.(gif|jpg)$/, (req, res) => {
|
||||
res.status(410)
|
||||
res.setHeader('Content-Type', 'image/svg+xml;charset=utf-8')
|
||||
|
||||
const format = req.params[0]
|
||||
res.send(
|
||||
camp.route(/\.(gif|jpg)$/, (query, match, end, request) => {
|
||||
const [, format] = match
|
||||
makeSend(
|
||||
'svg',
|
||||
request.res,
|
||||
end
|
||||
)(
|
||||
makeBadge({
|
||||
label: '410',
|
||||
message: `${format} no longer available`,
|
||||
@@ -323,53 +350,41 @@ class Server {
|
||||
format: 'svg',
|
||||
})
|
||||
)
|
||||
|
||||
res.end()
|
||||
})
|
||||
|
||||
if (!rasterUrl) {
|
||||
app.get(/\.png$/, (req, res) => {
|
||||
res.status(404)
|
||||
res.setHeader('Content-Type', 'image/svg+xml;charset=utf-8')
|
||||
res.send(
|
||||
camp.route(/\.png$/, (query, match, end, request) => {
|
||||
makeSend(
|
||||
'svg',
|
||||
request.res,
|
||||
end
|
||||
)(
|
||||
makeBadge({
|
||||
label: '404',
|
||||
message: 'raster badges not available',
|
||||
color: 'lightgray',
|
||||
format: 'svg',
|
||||
})
|
||||
)
|
||||
res.end()
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
registerNotFoundHandlers() {
|
||||
const { app } = this
|
||||
camp.notfound(/(\.svg|\.json|)$/, (query, match, end, request) => {
|
||||
const [, extension] = match
|
||||
const format = (extension || '.svg').replace(/^\./, '')
|
||||
|
||||
app.get(/\.json$/, (req, res) => {
|
||||
res.status(404)
|
||||
res.setHeader('Content-Type', 'application/json')
|
||||
res.json(
|
||||
makeJsonBadge({
|
||||
label: '404',
|
||||
message: 'badge not found',
|
||||
color: 'red',
|
||||
})
|
||||
)
|
||||
res.end()
|
||||
})
|
||||
|
||||
app.get(/(?:\.svg|)$/, (req, res) => {
|
||||
res.status(404)
|
||||
res.setHeader('Content-Type', 'image/svg+xml;charset=utf-8')
|
||||
res.send(
|
||||
makeSend(
|
||||
format,
|
||||
request.res,
|
||||
end
|
||||
)(
|
||||
makeBadge({
|
||||
label: '404',
|
||||
message: 'badge not found',
|
||||
color: 'red',
|
||||
format,
|
||||
})
|
||||
)
|
||||
res.end()
|
||||
})
|
||||
}
|
||||
|
||||
@@ -381,62 +396,54 @@ class Server {
|
||||
* to {@link https://shields.io/} )
|
||||
*/
|
||||
registerRedirects() {
|
||||
const { config, app } = this
|
||||
const { config, camp } = this
|
||||
const {
|
||||
public: { rasterUrl, redirectUrl },
|
||||
} = config
|
||||
|
||||
if (rasterUrl) {
|
||||
// Redirect to the raster server for raster versions of modern badges.
|
||||
app.get(/\.png$/, (req, res) => {
|
||||
res.status(301)
|
||||
res.setHeader('Location', rasterRedirectUrl({ rasterUrl }, req.url))
|
||||
camp.route(/\.png$/, (queryParams, match, end, ask) => {
|
||||
ask.res.statusCode = 301
|
||||
ask.res.setHeader(
|
||||
'Location',
|
||||
rasterRedirectUrl({ rasterUrl }, ask.req.url)
|
||||
)
|
||||
|
||||
const cacheDuration = (30 * 24 * 3600) | 0 // 30 days.
|
||||
res.setHeader('Cache-Control', `max-age=${cacheDuration}`)
|
||||
ask.res.setHeader('Cache-Control', `max-age=${cacheDuration}`)
|
||||
|
||||
res.end()
|
||||
ask.res.end()
|
||||
})
|
||||
}
|
||||
|
||||
if (redirectUrl) {
|
||||
app.get('/', (req, res) => {
|
||||
res.status(302)
|
||||
res.setHeader('Location', redirectUrl)
|
||||
res.end()
|
||||
camp.route(/^\/$/, (data, match, end, ask) => {
|
||||
ask.res.statusCode = 302
|
||||
ask.res.setHeader('Location', redirectUrl)
|
||||
ask.res.end()
|
||||
})
|
||||
}
|
||||
|
||||
/*
|
||||
This is here for legacy reasons. The badge server and frontend used to live
|
||||
on two different servers. When we merged them there was a conflict so we did
|
||||
this to avoid moving the endpoint docs to another URL.
|
||||
|
||||
Never ever do this again.
|
||||
*/
|
||||
app.use('/endpoint', (req, res, next) => {
|
||||
if (Object.keys(req.query).length === 0) {
|
||||
res.status(301)
|
||||
res.setHeader('Location', '/endpoint/')
|
||||
res.end()
|
||||
} else {
|
||||
next()
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* Iterate all the service classes defined in /services,
|
||||
* load each service and register an Express route for each service.
|
||||
* load each service and register a Scoutcamp route for each service.
|
||||
*/
|
||||
async registerServices() {
|
||||
const { app, config, metricInstance } = this
|
||||
const { config, camp, metricInstance } = this
|
||||
const { apiProvider: githubApiProvider } = this.githubConstellation
|
||||
const { apiProvider: librariesIoApiProvider } =
|
||||
this.librariesioConstellation
|
||||
;(await loadServiceClasses()).forEach(serviceClass =>
|
||||
serviceClass.register(
|
||||
{ app, githubApiProvider, librariesIoApiProvider, metricInstance },
|
||||
{
|
||||
camp,
|
||||
handleRequest,
|
||||
githubApiProvider,
|
||||
librariesIoApiProvider,
|
||||
metricInstance,
|
||||
},
|
||||
{
|
||||
handleInternalErrors: config.public.handleInternalErrors,
|
||||
cacheHeaders: config.public.cacheHeaders,
|
||||
@@ -469,14 +476,11 @@ class Server {
|
||||
|
||||
/**
|
||||
* Start the HTTP server:
|
||||
* Bootstrap Express,
|
||||
* Bootstrap Scoutcamp,
|
||||
* Register handlers,
|
||||
* Start listening for requests on this.baseUrl()
|
||||
*
|
||||
* @param {Function} registerExtras Optional function to register additional
|
||||
* routes, used for testing.
|
||||
*/
|
||||
async start(registerExtras) {
|
||||
async start() {
|
||||
const {
|
||||
bind: { port, address: hostname },
|
||||
ssl: { isSecure: secure, cert, key },
|
||||
@@ -488,17 +492,25 @@ class Server {
|
||||
|
||||
log.log(`Server is starting up: ${this.baseUrl}`)
|
||||
|
||||
const app = (this.app = express())
|
||||
const camp = (this.camp = Camp.create({
|
||||
documentRoot: this.config.public.documentRoot,
|
||||
port,
|
||||
hostname,
|
||||
secure,
|
||||
staticMaxAge: 300,
|
||||
cert,
|
||||
key,
|
||||
}))
|
||||
|
||||
if (requireCloudflare) {
|
||||
this.requireCloudflare()
|
||||
}
|
||||
|
||||
const { githubConstellation, metricInstance } = this
|
||||
await githubConstellation.initialize(app)
|
||||
await githubConstellation.initialize(camp)
|
||||
if (metricInstance) {
|
||||
if (this.config.public.metrics.prometheus.endpointEnabled) {
|
||||
metricInstance.registerMetricsEndpoint(app)
|
||||
metricInstance.registerMetricsEndpoint(camp)
|
||||
}
|
||||
if (this.influxMetrics) {
|
||||
this.influxMetrics.startPushingMetrics()
|
||||
@@ -506,47 +518,39 @@ class Server {
|
||||
}
|
||||
|
||||
const { apiProvider: githubApiProvider } = this.githubConstellation
|
||||
setSuggestRoutes(allowedOrigin, githubApiProvider, app)
|
||||
setRoutes(allowedOrigin, githubApiProvider, camp)
|
||||
|
||||
// https://github.com/badges/shields/issues/3273
|
||||
app.use((req, res, next) => {
|
||||
camp.handle((req, res, next) => {
|
||||
res.setHeader('Access-Control-Allow-Origin', '*')
|
||||
next()
|
||||
})
|
||||
|
||||
this.registerErrorHandlers()
|
||||
this.registerRedirects()
|
||||
app.use(
|
||||
express.static(this.config.public.documentRoot, {
|
||||
// Since express's `maxAge` parameter sets `Cache-Control: public`, set
|
||||
// the headers manually insetad.
|
||||
cacheControl: false,
|
||||
setHeaders: res =>
|
||||
res.setHeader('Cache-Control', 'max-age=300, s-maxage=300'),
|
||||
})
|
||||
)
|
||||
await this.registerServices()
|
||||
if (registerExtras) {
|
||||
registerExtras(app)
|
||||
|
||||
camp.timeout = this.config.public.requestTimeoutSeconds * 1000
|
||||
if (this.config.public.requestTimeoutSeconds > 0) {
|
||||
camp.on('timeout', socket => {
|
||||
const maxAge = this.config.public.requestTimeoutMaxAgeSeconds
|
||||
socket.write('HTTP/1.1 408 Request Timeout\r\n')
|
||||
socket.write('Content-Type: text/html; charset=UTF-8\r\n')
|
||||
socket.write('Content-Encoding: UTF-8\r\n')
|
||||
socket.write(`Cache-Control: max-age=${maxAge}, s-maxage=${maxAge}\r\n`)
|
||||
socket.write('Connection: close\r\n\r\n')
|
||||
socket.write('Request Timeout')
|
||||
socket.end()
|
||||
})
|
||||
}
|
||||
this.registerNotFoundHandlers()
|
||||
camp.listenAsConfigured()
|
||||
|
||||
if (secure) {
|
||||
this.server = https.createServer({ hostname, cert, key }, app)
|
||||
} else {
|
||||
this.server = http.createServer({ hostname }, app)
|
||||
}
|
||||
|
||||
this.server.setTimeout(this.config.public.requestTimeoutSeconds * 1000)
|
||||
|
||||
await new Promise(resolve =>
|
||||
this.server.listen({ host: hostname, port }, () => resolve())
|
||||
)
|
||||
await new Promise(resolve => camp.on('listening', () => resolve()))
|
||||
}
|
||||
|
||||
static resetGlobalState() {
|
||||
// TODO: This state should be migrated to instance state. When possible, do
|
||||
// not add new global state.
|
||||
// This state should be migrated to instance state. When possible, do not add new
|
||||
// global state.
|
||||
clearResourceCache()
|
||||
}
|
||||
|
||||
@@ -558,11 +562,10 @@ class Server {
|
||||
* Stop the HTTP server and clean up helpers
|
||||
*/
|
||||
async stop() {
|
||||
if (this.server) {
|
||||
await new Promise(resolve => this.server.close(() => resolve()))
|
||||
this.server = undefined
|
||||
if (this.camp) {
|
||||
await new Promise(resolve => this.camp.close(resolve))
|
||||
this.camp = undefined
|
||||
}
|
||||
this.app = undefined
|
||||
|
||||
if (this.cleanupMonitor) {
|
||||
this.cleanupMonitor()
|
||||
|
||||
@@ -73,7 +73,9 @@ describe('The server', function () {
|
||||
it('should redirect colorscheme PNG badges as configured', async function () {
|
||||
const { statusCode, headers } = await got(
|
||||
`${baseUrl}:fruit-apple-green.png`,
|
||||
{ followRedirect: false }
|
||||
{
|
||||
followRedirect: false,
|
||||
}
|
||||
)
|
||||
expect(statusCode).to.equal(301)
|
||||
expect(headers.location).to.equal(
|
||||
@@ -96,7 +98,7 @@ describe('The server', function () {
|
||||
`${baseUrl}:fruit-apple-green.svg`
|
||||
)
|
||||
expect(statusCode).to.equal(200)
|
||||
expect(headers['content-type']).to.equal('image/svg+xml; charset=utf-8')
|
||||
expect(headers['content-type']).to.equal('image/svg+xml;charset=utf-8')
|
||||
expect(headers['content-length']).to.equal('1130')
|
||||
})
|
||||
|
||||
@@ -110,9 +112,7 @@ describe('The server', function () {
|
||||
`${baseUrl}:fruit-apple-green.json`
|
||||
)
|
||||
expect(statusCode).to.equal(200)
|
||||
expect(headers['content-type']).to.equal(
|
||||
'application/json; charset=utf-8'
|
||||
)
|
||||
expect(headers['content-type']).to.equal('application/json')
|
||||
expect(headers['access-control-allow-origin']).to.equal('*')
|
||||
expect(headers['content-length']).to.equal('92')
|
||||
expect(() => JSON.parse(body)).not.to.throw()
|
||||
@@ -200,12 +200,19 @@ describe('The server', function () {
|
||||
const { statusCode, body } = await got(`${baseUrl}npm/v/express.jpg`, {
|
||||
throwHttpErrors: false,
|
||||
})
|
||||
expect(statusCode).to.equal(410)
|
||||
// TODO It would be nice if this were 404 or 410.
|
||||
expect(statusCode).to.equal(200)
|
||||
expect(body)
|
||||
.to.satisfy(isSvg)
|
||||
.and.to.include('410')
|
||||
.and.to.include('jpg no longer available')
|
||||
})
|
||||
|
||||
it('should return cors header for the request', async function () {
|
||||
const { statusCode, headers } = await got(`${baseUrl}npm/v/express.svg`)
|
||||
expect(statusCode).to.equal(200)
|
||||
expect(headers['access-control-allow-origin']).to.equal('*')
|
||||
})
|
||||
})
|
||||
|
||||
context('`requireCloudflare` is enabled', function () {
|
||||
@@ -238,12 +245,22 @@ describe('The server', function () {
|
||||
|
||||
// configure server to time out requests that take >2 seconds
|
||||
server = await createTestServer({ public: { requestTimeoutSeconds: 2 } })
|
||||
await server.start(app => {
|
||||
// /fast returns a 200 OK after a 1 second delay
|
||||
app.get('/fast', (req, res) => setTimeout(() => res.end(), 1000))
|
||||
await server.start()
|
||||
|
||||
// /slow returns a 200 OK after a 3 second delay
|
||||
app.get('/slow', (req, res) => setTimeout(() => res.end(), 3000))
|
||||
// /fast returns a 200 OK after a 1 second delay
|
||||
server.camp.route(/^\/fast$/, (data, match, end, ask) => {
|
||||
setTimeout(() => {
|
||||
ask.res.statusCode = 200
|
||||
ask.res.end()
|
||||
}, 1000)
|
||||
})
|
||||
|
||||
// /slow returns a 200 OK after a 3 second delay
|
||||
server.camp.route(/^\/slow$/, (data, match, end, ask) => {
|
||||
setTimeout(() => {
|
||||
ask.res.statusCode = 200
|
||||
ask.res.end()
|
||||
}, 3000)
|
||||
})
|
||||
})
|
||||
|
||||
@@ -256,9 +273,11 @@ describe('The server', function () {
|
||||
|
||||
it('should time out slow requests', async function () {
|
||||
this.timeout(10000)
|
||||
await expect(got(`${server.baseUrl}slow`)).to.be.rejectedWith(
|
||||
'socket hang up'
|
||||
)
|
||||
const { statusCode, body } = await got(`${server.baseUrl}slow`, {
|
||||
throwHttpErrors: false,
|
||||
})
|
||||
expect(statusCode).to.be.equal(408)
|
||||
expect(body).to.equal('Request Timeout')
|
||||
})
|
||||
|
||||
it('should not time out fast requests', async function () {
|
||||
|
||||
@@ -80,22 +80,29 @@ test this kind of logic through unit tests (e.g. of `render()` and
|
||||
reporting, loads config, and creates an instance of the server.
|
||||
|
||||
2. The Server, which is defined in
|
||||
[`core/server/server.js`][core/server/server], is based on [Express][].
|
||||
It creates an http server, sets up helpers for token persistence and
|
||||
monitoring. Then it loads all the services, injecting dependencies as it
|
||||
asks each one to register its route with the Express app.
|
||||
[`core/server/server.js`][core/server/server], is based on the web
|
||||
framework [Scoutcamp][]. It creates an http server, sets up helpers for
|
||||
token persistence and monitoring. Then it loads all the services,
|
||||
injecting dependencies as it asks each one to register its route
|
||||
with Scoutcamp.
|
||||
|
||||
3. The service registration continues in `BaseService.register`. From its
|
||||
`route` property, it derives a regular expression to match the route
|
||||
path, and invokes `app.get` with this value.
|
||||
path, and invokes `camp.route` with this value.
|
||||
|
||||
4. TODO: Explain what happens here (i.e. now that we've migrated from Scoutcamp
|
||||
to Express). `BaseService.invoke` instantiates the service and runs
|
||||
`BaseService#handle`.
|
||||
4. At this point the situation gets gnarly and hard to follow. For the
|
||||
purpose of initialization, suffice it to say that `camp.route` invokes a
|
||||
callback with the four parameters `( queryParams, match, end, ask )` which
|
||||
is created in a legacy helper function in
|
||||
[`legacy-request-handler.js`][legacy-request-handler]. This callback
|
||||
delegates to a callback in `BaseService.register` with four different
|
||||
parameters `( queryParams, match, sendBadge )`, which
|
||||
then runs `BaseService.invoke`. `BaseService.invoke` instantiates the
|
||||
service and runs `BaseService#handle`.
|
||||
|
||||
[entrypoint]: https://github.com/badges/shields/blob/master/server.js
|
||||
[core/server/server]: https://github.com/badges/shields/blob/master/core/server/server.js
|
||||
[express]: https://expressjs.com/
|
||||
[scoutcamp]: https://github.com/espadrine/sc
|
||||
[legacy-request-handler]: https://github.com/badges/shields/blob/master/core/base-service/legacy-request-handler.js
|
||||
|
||||
## Downstream caching
|
||||
@@ -112,15 +119,24 @@ test this kind of logic through unit tests (e.g. of `render()` and
|
||||
|
||||
## How the server makes a badge
|
||||
|
||||
1. An HTTPS request arrives. Express inspects the URL path and matches it
|
||||
against all the registered routes until it finds one that matches. (See
|
||||
*Initialization* above for an explanation of how routes are
|
||||
1. An HTTPS request arrives. Scoutcamp inspects the URL path and matches it
|
||||
against the regexes for all the registered routes until it finds one that
|
||||
matches. (See *Initialization* above for an explanation of how routes are
|
||||
registered.)
|
||||
2. Invoke the request handler function, defined in `BaseService.register`,
|
||||
which handles the request. It runs `BaseService.invoke`, which instantiates
|
||||
the service, injects more dependencies, and invokes `BaseService.handle`
|
||||
which is implemented by the service subclass.
|
||||
3. The job of `handle()`, which should be implemented by each service
|
||||
2. Scoutcamp invokes a callback with the four parameters:
|
||||
`( queryParams, match, end, ask )`. This callback is defined in
|
||||
[`legacy-request-handler`][legacy-request-handler]. A timeout is set to
|
||||
handle unresponsive service code and the next callback is invoked: the
|
||||
legacy handler function.
|
||||
3. The legacy handler function receives
|
||||
`( queryParams, match, sendBadge )`. Its job is to extract data
|
||||
from the regex `match` and `queryParams`, and then invoke `sendBadge`
|
||||
with the result.
|
||||
4. The implementation of this function is in `BaseService.register`. It
|
||||
works by running `BaseService.invoke`, which instantiates the service,
|
||||
injects more dependencies, and invokes `BaseService.handle` which is
|
||||
implemented by the service subclass.
|
||||
5. The job of `handle()`, which should be implemented by each service
|
||||
subclass, is to return an object which partially describes a badge or
|
||||
throw one of the handled error classes. "Partially rendered" most
|
||||
commonly means a non-empty message and an optional color. In the case
|
||||
@@ -130,7 +146,7 @@ test this kind of logic through unit tests (e.g. of `render()` and
|
||||
Throwing any other error is a programmer error which will be
|
||||
[reported][error reporting] and described to the user as a **shields
|
||||
internal error**.
|
||||
4. A typical `handle()` function delegates to one or more helpers to
|
||||
6. A typical `handle()` function delegates to one or more helpers to
|
||||
handle stages of the request:
|
||||
1. **fetch**: load the needed data from the upstream service and
|
||||
validate it
|
||||
@@ -138,13 +154,13 @@ test this kind of logic through unit tests (e.g. of `render()` and
|
||||
into a few properties which will be displayed on the badge
|
||||
3. **render**: given a few properties, return a message, optional
|
||||
color, and optional label.
|
||||
5. When an error is thrown, BaseService steps in and converts the error
|
||||
7. When an error is thrown, BaseService steps in and converts the error
|
||||
object to renderable properties: `{ isError, message, color }`.
|
||||
6. The service invokes [`coalesceBadge`][coalescebadge] whose job is to
|
||||
8. The service invokes [`coalesceBadge`][coalescebadge] whose job is to
|
||||
coalesce query string overrides with values from the service and the
|
||||
service’s defaults to produce an object that fully describes the badge to
|
||||
be rendered.
|
||||
7. `sendBadge` is invoked with that object. It does some housekeeping on the
|
||||
9. `sendBadge` is invoked with that object. It does some housekeeping on the
|
||||
timeout. Then it renders the badge to svg or raster and pushes out the
|
||||
result over the HTTPS connection.
|
||||
|
||||
|
||||
2722
package-lock.json
generated
2722
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
55
package.json
55
package.json
@@ -24,7 +24,8 @@
|
||||
"@fontsource/lato": "^4.5.5",
|
||||
"@fontsource/lekton": "^4.5.6",
|
||||
"@renovate/pep440": "^1.0.0",
|
||||
"@sentry/node": "^6.19.6",
|
||||
"@sentry/node": "^6.19.2",
|
||||
"@shields_io/camp": "^18.1.1",
|
||||
"badge-maker": "file:badge-maker",
|
||||
"bytes": "^3.1.2",
|
||||
"camelcase": "^6.3.0",
|
||||
@@ -36,14 +37,13 @@
|
||||
"decamelize": "^3.2.0",
|
||||
"emojic": "^1.1.17",
|
||||
"escape-string-regexp": "^4.0.0",
|
||||
"express": "^4.17.3",
|
||||
"fast-xml-parser": "^4.0.7",
|
||||
"glob": "^8.0.1",
|
||||
"glob": "^7.2.0",
|
||||
"global-agent": "^3.0.0",
|
||||
"got": "^12.0.3",
|
||||
"got": "^12.0.2",
|
||||
"graphql": "^15.6.1",
|
||||
"graphql-tag": "^2.12.6",
|
||||
"ioredis": "5.0.4",
|
||||
"ioredis": "4.28.5",
|
||||
"joi": "17.6.0",
|
||||
"joi-extension-semver": "5.0.0",
|
||||
"js-yaml": "^4.1.0",
|
||||
@@ -51,8 +51,7 @@
|
||||
"lodash.countby": "^4.6.0",
|
||||
"lodash.groupby": "^4.6.0",
|
||||
"lodash.times": "^4.3.2",
|
||||
"moment": "^2.29.2",
|
||||
"multer": "^1.4.4",
|
||||
"moment": "^2.29.1",
|
||||
"node-env-flag": "^0.1.0",
|
||||
"parse-link-header": "^2.0.0",
|
||||
"path-to-regexp": "^6.2.0",
|
||||
@@ -61,8 +60,8 @@
|
||||
"prom-client": "^14.0.1",
|
||||
"qs": "^6.10.3",
|
||||
"query-string": "^7.1.1",
|
||||
"semver": "~7.3.7",
|
||||
"simple-icons": "6.18.0",
|
||||
"semver": "~7.3.5",
|
||||
"simple-icons": "6.15.0",
|
||||
"webextension-store-meta": "^1.0.5",
|
||||
"xmldom": "~0.6.0",
|
||||
"xpath": "~0.0.32"
|
||||
@@ -142,12 +141,12 @@
|
||||
]
|
||||
},
|
||||
"devDependencies": {
|
||||
"@babel/core": "^7.17.9",
|
||||
"@babel/core": "^7.17.8",
|
||||
"@babel/polyfill": "^7.12.1",
|
||||
"@babel/register": "7.17.7",
|
||||
"@istanbuljs/schema": "^0.1.3",
|
||||
"@mapbox/react-click-to-select": "^2.2.1",
|
||||
"@types/chai": "^4.3.1",
|
||||
"@types/chai": "^4.3.0",
|
||||
"@types/lodash.debounce": "^4.0.6",
|
||||
"@types/lodash.groupby": "^4.6.6",
|
||||
"@types/mocha": "^9.1.0",
|
||||
@@ -155,11 +154,11 @@
|
||||
"@types/react-helmet": "^6.1.5",
|
||||
"@types/react-modal": "^3.13.1",
|
||||
"@types/react-select": "^4.0.17",
|
||||
"@types/styled-components": "5.1.25",
|
||||
"@typescript-eslint/eslint-plugin": "^5.19.0",
|
||||
"@types/styled-components": "5.1.24",
|
||||
"@typescript-eslint/eslint-plugin": "^5.16.0",
|
||||
"@typescript-eslint/parser": "^5.15.0",
|
||||
"babel-plugin-inline-react-svg": "^2.0.1",
|
||||
"babel-preset-gatsby": "^2.11.1",
|
||||
"babel-preset-gatsby": "^2.9.0",
|
||||
"c8": "^7.11.0",
|
||||
"caller": "^1.1.0",
|
||||
"chai": "^4.3.6",
|
||||
@@ -168,8 +167,8 @@
|
||||
"chai-string": "^1.4.0",
|
||||
"child-process-promise": "^2.2.1",
|
||||
"clipboard-copy": "^4.0.1",
|
||||
"concurrently": "^7.1.0",
|
||||
"cypress": "^9.5.4",
|
||||
"concurrently": "^7.0.0",
|
||||
"cypress": "^9.5.2",
|
||||
"danger": "^11.0.2",
|
||||
"danger-plugin-no-test-shortcuts": "^2.0.0",
|
||||
"deepmerge": "^4.2.2",
|
||||
@@ -180,31 +179,31 @@
|
||||
"eslint-config-standard-react": "^11.0.1",
|
||||
"eslint-plugin-chai-friendly": "^0.7.2",
|
||||
"eslint-plugin-cypress": "^2.12.1",
|
||||
"eslint-plugin-import": "^2.26.0",
|
||||
"eslint-plugin-jsdoc": "^39.2.7",
|
||||
"eslint-plugin-import": "^2.25.4",
|
||||
"eslint-plugin-jsdoc": "^38.0.6",
|
||||
"eslint-plugin-mocha": "^10.0.3",
|
||||
"eslint-plugin-no-extension-in-require": "^0.2.0",
|
||||
"eslint-plugin-node": "^11.1.0",
|
||||
"eslint-plugin-promise": "^5.2.0",
|
||||
"eslint-plugin-promise": "^6.0.0",
|
||||
"eslint-plugin-react": "^7.29.4",
|
||||
"eslint-plugin-react-hooks": "^4.4.0",
|
||||
"eslint-plugin-react-hooks": "^4.3.0",
|
||||
"eslint-plugin-sort-class-members": "^1.14.1",
|
||||
"fetch-ponyfill": "^7.1.0",
|
||||
"form-data": "^4.0.0",
|
||||
"gatsby": "4.6.2",
|
||||
"gatsby-plugin-catch-links": "^4.11.0",
|
||||
"gatsby-plugin-catch-links": "^4.9.0",
|
||||
"gatsby-plugin-page-creator": "^4.7.0",
|
||||
"gatsby-plugin-react-helmet": "^5.10.0",
|
||||
"gatsby-plugin-remove-trailing-slashes": "^4.9.0",
|
||||
"gatsby-plugin-styled-components": "^5.11.0",
|
||||
"gatsby-plugin-typescript": "^4.11.1",
|
||||
"gatsby-plugin-styled-components": "^5.2.0",
|
||||
"gatsby-plugin-typescript": "^4.9.0",
|
||||
"humanize-string": "^2.1.0",
|
||||
"icedfrisby": "4.0.0",
|
||||
"icedfrisby-nock": "^2.1.0",
|
||||
"is-svg": "^4.3.2",
|
||||
"js-yaml-loader": "^1.2.2",
|
||||
"jsdoc": "^3.6.10",
|
||||
"lint-staged": "^12.3.8",
|
||||
"lint-staged": "^12.3.7",
|
||||
"lodash.debounce": "^4.0.8",
|
||||
"lodash.difference": "^4.5.0",
|
||||
"minimist": "^1.2.6",
|
||||
@@ -218,10 +217,10 @@
|
||||
"npm-run-all": "^4.1.5",
|
||||
"open-cli": "^7.0.1",
|
||||
"portfinder": "^1.0.28",
|
||||
"prettier": "2.6.2",
|
||||
"prettier": "2.6.1",
|
||||
"react": "^17.0.2",
|
||||
"react-dom": "^17.0.2",
|
||||
"react-error-overlay": "^6.0.11",
|
||||
"react-error-overlay": "^6.0.10",
|
||||
"react-helmet": "^6.1.0",
|
||||
"react-modal": "^3.14.4",
|
||||
"react-pose": "^4.0.10",
|
||||
@@ -231,13 +230,13 @@
|
||||
"rimraf": "^3.0.2",
|
||||
"sazerac": "^2.0.0",
|
||||
"simple-git-hooks": "^2.7.0",
|
||||
"sinon": "^13.0.2",
|
||||
"sinon": "^13.0.1",
|
||||
"sinon-chai": "^3.7.0",
|
||||
"snap-shot-it": "^7.9.6",
|
||||
"start-server-and-test": "1.14.0",
|
||||
"styled-components": "^5.3.5",
|
||||
"ts-mocha": "^9.0.2",
|
||||
"tsd": "^0.20.0",
|
||||
"tsd": "^0.19.1",
|
||||
"typescript": "^4.6.3",
|
||||
"url": "^0.11.0"
|
||||
},
|
||||
|
||||
@@ -21,8 +21,8 @@ export default class Bitrise extends BaseJsonService {
|
||||
static examples = [
|
||||
{
|
||||
title: 'Bitrise',
|
||||
namedParams: { appId: '3ff11fe8457bd304', branch: 'master' },
|
||||
queryParams: { token: 'lESRN9rEFFfDq92JtXs_jw' },
|
||||
namedParams: { appId: 'cde737473028420d', branch: 'master' },
|
||||
queryParams: { token: 'GCIdEzacE4GW32jLVrZb7A' },
|
||||
staticPreview: this.render({ status: 'success' }),
|
||||
},
|
||||
]
|
||||
|
||||
@@ -3,14 +3,14 @@ import { createServiceTester } from '../tester.js'
|
||||
export const t = await createServiceTester()
|
||||
|
||||
t.create('deploy status')
|
||||
.get('/3ff11fe8457bd304.json?token=lESRN9rEFFfDq92JtXs_jw')
|
||||
.get('/cde737473028420d.json?token=GCIdEzacE4GW32jLVrZb7A')
|
||||
.expectBadge({
|
||||
label: 'bitrise',
|
||||
message: isBuildStatus,
|
||||
})
|
||||
|
||||
t.create('deploy status with branch')
|
||||
.get('/3ff11fe8457bd304/master.json?token=lESRN9rEFFfDq92JtXs_jw')
|
||||
.get('/cde737473028420d/master.json?token=GCIdEzacE4GW32jLVrZb7A')
|
||||
.expectBadge({
|
||||
label: 'bitrise',
|
||||
message: isBuildStatus,
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import Joi from 'joi'
|
||||
import { floorCount as floorCountColor } from '../color-formatters.js'
|
||||
import { metric } from '../text-formatters.js'
|
||||
import { BaseJsonService } from '../index.js'
|
||||
|
||||
const ownerSchema = Joi.array().required()
|
||||
@@ -21,7 +20,7 @@ export default class GemOwner extends BaseJsonService {
|
||||
|
||||
static render({ count }) {
|
||||
return {
|
||||
message: metric(count),
|
||||
message: count,
|
||||
color: floorCountColor(count, 10, 50, 100),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,13 +1,12 @@
|
||||
import queryString from 'query-string'
|
||||
import multer from 'multer'
|
||||
import { fetch } from '../../../core/base-service/got.js'
|
||||
import log from '../../../core/server/log.js'
|
||||
|
||||
function setRoutes({ app, authHelper, onTokenAccepted }) {
|
||||
function setRoutes({ server, authHelper, onTokenAccepted }) {
|
||||
const baseUrl = process.env.GATSBY_BASE_URL || 'https://img.shields.io'
|
||||
|
||||
app.post('/github-auth', (req, res) => {
|
||||
res.status(302) // Found.
|
||||
server.route(/^\/github-auth$/, (data, match, end, ask) => {
|
||||
ask.res.statusCode = 302 // Found.
|
||||
const query = queryString.stringify({
|
||||
// TODO The `_user` property bypasses security checks in AuthHelper.
|
||||
// (e.g: enforceStrictSsl and shouldAuthenticateRequest).
|
||||
@@ -16,64 +15,56 @@ function setRoutes({ app, authHelper, onTokenAccepted }) {
|
||||
client_id: authHelper._user,
|
||||
redirect_uri: `${baseUrl}/github-auth/done`,
|
||||
})
|
||||
res.setHeader(
|
||||
ask.res.setHeader(
|
||||
'Location',
|
||||
`https://github.com/login/oauth/authorize?${query}`
|
||||
)
|
||||
res.end()
|
||||
end('')
|
||||
})
|
||||
|
||||
app.post('/github-auth/done', multer().none(), async (req, res) => {
|
||||
const code = (req.body ?? {}).code
|
||||
server.route(/^\/github-auth\/done$/, async (data, match, end, ask) => {
|
||||
if (!data.code) {
|
||||
log.log(`GitHub OAuth data: ${JSON.stringify(data)}`)
|
||||
return end('GitHub OAuth authentication failed to provide a code.')
|
||||
}
|
||||
|
||||
if (!code) {
|
||||
log.log(`GitHub OAuth data: ${JSON.stringify(req.body)}`)
|
||||
res.send('GitHub OAuth authentication failed to provide a code.')
|
||||
res.end()
|
||||
return
|
||||
const options = {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-type': 'application/x-www-form-urlencoded;charset=UTF-8',
|
||||
},
|
||||
form: {
|
||||
// TODO The `_user` and `_pass` properties bypass security checks in
|
||||
// AuthHelper (e.g: enforceStrictSsl and shouldAuthenticateRequest).
|
||||
// Do not use them elsewhere. It would be better to clean
|
||||
// this up so it's not setting a bad example.
|
||||
client_id: authHelper._user,
|
||||
client_secret: authHelper._pass,
|
||||
code: data.code,
|
||||
},
|
||||
}
|
||||
|
||||
let resp
|
||||
try {
|
||||
resp = await fetch('https://github.com/login/oauth/access_token', {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-type': 'application/x-www-form-urlencoded;charset=UTF-8',
|
||||
},
|
||||
form: {
|
||||
// TODO The `_user` and `_pass` properties bypass security checks in
|
||||
// AuthHelper (e.g: enforceStrictSsl and shouldAuthenticateRequest).
|
||||
// Do not use them elsewhere. It would be better to clean
|
||||
// this up so it's not setting a bad example.
|
||||
client_id: authHelper._user,
|
||||
client_secret: authHelper._pass,
|
||||
code,
|
||||
},
|
||||
})
|
||||
resp = await fetch('https://github.com/login/oauth/access_token', options)
|
||||
} catch (e) {
|
||||
res.send('The connection to GitHub failed.')
|
||||
res.end()
|
||||
return
|
||||
return end('The connection to GitHub failed.')
|
||||
}
|
||||
|
||||
let content
|
||||
try {
|
||||
content = queryString.parse(resp.buffer)
|
||||
} catch (e) {
|
||||
res.send('The GitHub OAuth token could not be parsed.')
|
||||
res.end()
|
||||
return
|
||||
return end('The GitHub OAuth token could not be parsed.')
|
||||
}
|
||||
|
||||
const { access_token: token } = content
|
||||
if (!token) {
|
||||
res.send('The GitHub OAuth process did not return a user token.')
|
||||
res.end()
|
||||
return
|
||||
return end('The GitHub OAuth process did not return a user token.')
|
||||
}
|
||||
|
||||
res.setHeader('Content-Type', 'text/html')
|
||||
res.send(
|
||||
ask.res.setHeader('Content-Type', 'text/html')
|
||||
end(
|
||||
'<p>Shields.io has received your app-specific GitHub user token. ' +
|
||||
'You can revoke it by going to ' +
|
||||
'<a href="https://github.com/settings/applications">GitHub</a>.</p>' +
|
||||
@@ -84,7 +75,6 @@ function setRoutes({ app, authHelper, onTokenAccepted }) {
|
||||
'everyone!</p>' +
|
||||
'<p><a href="/">Back to the website</a></p>'
|
||||
)
|
||||
res.end()
|
||||
|
||||
onTokenAccepted(token)
|
||||
})
|
||||
|
||||
@@ -1,9 +1,11 @@
|
||||
import { expect } from 'chai'
|
||||
import Camp from '@shields_io/camp'
|
||||
import FormData from 'form-data'
|
||||
import sinon from 'sinon'
|
||||
import portfinder from 'portfinder'
|
||||
import queryString from 'query-string'
|
||||
import nock from 'nock'
|
||||
import { ExpressTestHarness } from '../../../core/express-test-harness.js'
|
||||
import got from '../../../core/got-test-client.js'
|
||||
import GithubConstellation from '../github-constellation.js'
|
||||
import { setRoutes } from './acceptor.js'
|
||||
|
||||
@@ -15,26 +17,36 @@ describe('Github token acceptor', function () {
|
||||
private: { gh_client_id: fakeClientId, gh_client_secret: fakeClientSecret },
|
||||
})
|
||||
|
||||
let harness, onTokenAccepted
|
||||
let port, baseUrl
|
||||
beforeEach(async function () {
|
||||
harness = new ExpressTestHarness()
|
||||
port = await portfinder.getPortPromise()
|
||||
baseUrl = `http://127.0.0.1:${port}`
|
||||
})
|
||||
|
||||
let camp
|
||||
beforeEach(async function () {
|
||||
camp = Camp.start({ port, hostname: '::' })
|
||||
await new Promise(resolve => camp.on('listening', () => resolve()))
|
||||
})
|
||||
afterEach(async function () {
|
||||
if (camp) {
|
||||
await new Promise(resolve => camp.close(resolve))
|
||||
camp = undefined
|
||||
}
|
||||
})
|
||||
|
||||
let onTokenAccepted
|
||||
beforeEach(function () {
|
||||
onTokenAccepted = sinon.stub()
|
||||
setRoutes({
|
||||
app: harness.app,
|
||||
server: camp,
|
||||
authHelper: oauthHelper,
|
||||
onTokenAccepted,
|
||||
})
|
||||
|
||||
await harness.start()
|
||||
})
|
||||
|
||||
afterEach(async function () {
|
||||
await harness.stop()
|
||||
})
|
||||
|
||||
it('should start the OAuth process', async function () {
|
||||
const res = await harness.post('/github-auth', { followRedirect: false })
|
||||
const res = await got(`${baseUrl}/github-auth`, { followRedirect: false })
|
||||
|
||||
expect(res.statusCode).to.equal(302)
|
||||
|
||||
@@ -49,8 +61,8 @@ describe('Github token acceptor', function () {
|
||||
describe('Finishing the OAuth process', function () {
|
||||
context('no code is provided', function () {
|
||||
it('should return an error', async function () {
|
||||
const { body } = await harness.post('/github-auth/done')
|
||||
expect(body).to.equal(
|
||||
const res = await got(`${baseUrl}/github-auth/done`)
|
||||
expect(res.body).to.equal(
|
||||
'GitHub OAuth authentication failed to provide a code.'
|
||||
)
|
||||
})
|
||||
@@ -99,7 +111,9 @@ describe('Github token acceptor', function () {
|
||||
const form = new FormData()
|
||||
form.append('code', fakeCode)
|
||||
|
||||
const res = await harness.post('/github-auth/done', { body: form })
|
||||
const res = await got.post(`${baseUrl}/github-auth/done`, {
|
||||
body: form,
|
||||
})
|
||||
expect(res.body).to.startWith(
|
||||
'<p>Shields.io has received your app-specific GitHub user token.'
|
||||
)
|
||||
|
||||
@@ -50,7 +50,7 @@ class GithubConstellation {
|
||||
}
|
||||
}
|
||||
|
||||
async initialize(app) {
|
||||
async initialize(server) {
|
||||
if (!this.apiProvider.withPooling) {
|
||||
return
|
||||
}
|
||||
@@ -74,7 +74,7 @@ class GithubConstellation {
|
||||
|
||||
if (this.oauthHelper.isConfigured) {
|
||||
setAcceptorRoutes({
|
||||
app,
|
||||
server,
|
||||
authHelper: this.oauthHelper,
|
||||
onTokenAccepted: tokenString => this.onTokenAdded(tokenString),
|
||||
})
|
||||
|
||||
@@ -307,9 +307,7 @@ export default class GithubIssues extends GithubAuthV4Service {
|
||||
|
||||
return {
|
||||
label: `${labelPrefix}${labelText}${labelSuffix}`,
|
||||
message: `${metric(issueCount)}${
|
||||
messageSuffix ? ' ' : ''
|
||||
}${messageSuffix}`,
|
||||
message: `${metric(issueCount)} ${messageSuffix}`,
|
||||
color: issueCount > 0 ? 'yellow' : 'brightgreen',
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
import { metric } from '../text-formatters.js'
|
||||
import { BaseGithubLanguage } from './github-languages-base.js'
|
||||
import { documentation } from './github-helpers.js'
|
||||
|
||||
@@ -21,7 +20,7 @@ export default class GithubLanguageCount extends BaseGithubLanguage {
|
||||
|
||||
static render({ count }) {
|
||||
return {
|
||||
message: metric(count),
|
||||
message: count,
|
||||
color: 'blue',
|
||||
}
|
||||
}
|
||||
|
||||
@@ -75,7 +75,7 @@ export default class GithubMilestoneDetail extends GithubAuthV3Service {
|
||||
}
|
||||
|
||||
return {
|
||||
label: `${milestone.title}${label ? ' ' : ''}${label}`,
|
||||
label: `${milestone.title} ${label}`,
|
||||
message: metric(milestoneMetric),
|
||||
color,
|
||||
}
|
||||
|
||||
@@ -43,7 +43,7 @@ export default class GithubMilestone extends GithubAuthV3Service {
|
||||
static render({ user, repo, variant, milestones }) {
|
||||
const milestoneLength = milestones.length
|
||||
let color
|
||||
let qualifier = ''
|
||||
let label = ''
|
||||
|
||||
switch (variant) {
|
||||
case 'all':
|
||||
@@ -51,16 +51,16 @@ export default class GithubMilestone extends GithubAuthV3Service {
|
||||
break
|
||||
case 'open':
|
||||
color = 'red'
|
||||
qualifier = 'active'
|
||||
label = 'active'
|
||||
break
|
||||
case 'closed':
|
||||
color = 'green'
|
||||
qualifier = 'completed'
|
||||
label = 'completed'
|
||||
break
|
||||
}
|
||||
|
||||
return {
|
||||
label: `${qualifier}${qualifier ? ' ' : ''}milestones`,
|
||||
label: `${label} milestones`,
|
||||
message: metric(milestoneLength),
|
||||
color,
|
||||
}
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
import Joi from 'joi'
|
||||
import { nonNegativeInteger } from '../validators.js'
|
||||
import { BaseJsonService } from '../index.js'
|
||||
import { metric } from '../text-formatters.js'
|
||||
|
||||
// https://developer.opencollective.com/#/api/collectives?id=get-info
|
||||
const collectiveDetailsSchema = Joi.object().keys({
|
||||
@@ -31,11 +30,12 @@ export default class OpencollectiveBase extends BaseJsonService {
|
||||
}
|
||||
|
||||
static render(backersCount, label) {
|
||||
return {
|
||||
label,
|
||||
message: metric(backersCount),
|
||||
const badge = {
|
||||
message: backersCount,
|
||||
color: backersCount > 0 ? 'brightgreen' : 'lightgrey',
|
||||
}
|
||||
if (label) badge.label = label
|
||||
return badge
|
||||
}
|
||||
|
||||
async fetchCollectiveInfo(collective) {
|
||||
|
||||
@@ -1,55 +0,0 @@
|
||||
import Joi from 'joi'
|
||||
import { BaseJsonService } from '../index.js'
|
||||
import { colorScale } from '../color-formatters.js'
|
||||
|
||||
const schema = Joi.object({
|
||||
score: Joi.number().min(0).required(),
|
||||
}).required()
|
||||
|
||||
const ossfScorecardColorScale = colorScale(
|
||||
[2, 5, 8, 10],
|
||||
['red', 'yellow', 'yellowgreen', 'green', 'brightgreen']
|
||||
)
|
||||
|
||||
export default class OSSFScorecard extends BaseJsonService {
|
||||
static category = 'analysis'
|
||||
|
||||
static route = { base: 'ossf-scorecard', pattern: ':host/:orgName/:repoName' }
|
||||
|
||||
static examples = [
|
||||
{
|
||||
title: 'OSSF-Scorecard Score',
|
||||
namedParams: {
|
||||
host: 'github.com',
|
||||
orgName: 'rohankh532',
|
||||
repoName: 'org-workflow-add',
|
||||
},
|
||||
staticPreview: this.render({ score: '7.5' }),
|
||||
},
|
||||
]
|
||||
|
||||
static defaultBadgeData = { label: 'score' }
|
||||
|
||||
static render({ score }) {
|
||||
return {
|
||||
message: score,
|
||||
color: ossfScorecardColorScale(score),
|
||||
}
|
||||
}
|
||||
|
||||
async fetch({ host, orgName, repoName }) {
|
||||
return this._requestJson({
|
||||
schema,
|
||||
url: `https://api.securityscorecards.dev/projects/${host}/${orgName}/${repoName}`,
|
||||
errorMessages: {
|
||||
404: 'invalid repo path',
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
async handle({ host, orgName, repoName }) {
|
||||
const { score } = await this.fetch({ host, orgName, repoName })
|
||||
|
||||
return this.constructor.render({ score })
|
||||
}
|
||||
}
|
||||
@@ -1,25 +0,0 @@
|
||||
import Joi from 'joi'
|
||||
import { createServiceTester } from '../tester.js'
|
||||
export const t = await createServiceTester()
|
||||
|
||||
t.create('score valid')
|
||||
.get('/github.com/rohankh532/org-workflow-add.json')
|
||||
.expectBadge({
|
||||
label: 'score',
|
||||
message: Joi.number().min(0),
|
||||
color: Joi.string().allow(
|
||||
'red',
|
||||
'yellow',
|
||||
'yellowgreen',
|
||||
'green',
|
||||
'brightgreen'
|
||||
),
|
||||
})
|
||||
|
||||
t.create('score ivalid')
|
||||
.get('/github.com/invalid-user/invalid-repo.json')
|
||||
.expectBadge({
|
||||
label: 'score',
|
||||
message: 'invalid repo path',
|
||||
color: 'red',
|
||||
})
|
||||
@@ -12,7 +12,9 @@ export const t = await createServiceTester()
|
||||
// https://docs.sonarqube.org/7.0/MetricDefinitions.html
|
||||
// https://sonarcloud.io/api/measures/component?componentKey=org.sonarsource.sonarqube:sonarqube&metricKeys=public_documented_api_density
|
||||
t.create('Documented API Density (not found)')
|
||||
.get('/brave_brave-core.json?server=https://sonarcloud.io')
|
||||
.get(
|
||||
'/org.sonarsource.sonarqube%3Asonarqube.json?server=https://sonarcloud.io'
|
||||
)
|
||||
.expectBadge({
|
||||
label: 'public documented api density',
|
||||
message: 'metric not found',
|
||||
|
||||
@@ -10,7 +10,7 @@ export const t = await createServiceTester()
|
||||
|
||||
t.create('Tech Debt')
|
||||
.get(
|
||||
'/tech_debt/brave_brave-core.json?server=https://sonarcloud.io&sonarVersion=9.0'
|
||||
'/tech_debt/org.sonarsource.sonarqube%3Asonarqube.json?server=https://sonarcloud.io'
|
||||
)
|
||||
.expectBadge({
|
||||
label: 'tech debt',
|
||||
@@ -18,7 +18,9 @@ t.create('Tech Debt')
|
||||
})
|
||||
|
||||
t.create('Tech Debt (branch)')
|
||||
.get('/tech_debt/brave_brave-core/master.json?server=https://sonarcloud.io')
|
||||
.get(
|
||||
'/tech_debt/org.sonarsource.sonarqube%3Asonarqube/master.json?server=https://sonarcloud.io'
|
||||
)
|
||||
.expectBadge({
|
||||
label: 'tech debt',
|
||||
message: isPercentage,
|
||||
|
||||
@@ -17,7 +17,9 @@ const isViolationsLongFormMetric = Joi.alternatives(
|
||||
|
||||
t.create('Violations')
|
||||
.timeout(10000)
|
||||
.get('/violations/brave_brave-core.json?server=https://sonarcloud.io')
|
||||
.get(
|
||||
'/violations/org.sonarsource.sonarqube%3Asonarqube.json?server=https://sonarcloud.io'
|
||||
)
|
||||
.expectBadge({
|
||||
label: 'violations',
|
||||
message: isMetric,
|
||||
@@ -25,7 +27,9 @@ t.create('Violations')
|
||||
|
||||
t.create('Violations (branch)')
|
||||
.timeout(10000)
|
||||
.get('/violations/brave_brave-core/master.json?server=https://sonarcloud.io')
|
||||
.get(
|
||||
'/violations/org.sonarsource.sonarqube%3Asonarqube/master.json?server=https://sonarcloud.io'
|
||||
)
|
||||
.expectBadge({
|
||||
label: 'violations',
|
||||
message: isMetric,
|
||||
@@ -63,7 +67,7 @@ t.create('Violations (legacy API supported)')
|
||||
t.create('Violations Long Format')
|
||||
.timeout(10000)
|
||||
.get(
|
||||
'/violations/brave_brave-core.json?server=https://sonarcloud.io&format=long'
|
||||
'/violations/org.sonarsource.sonarqube%3Asonarqube.json?server=https://sonarcloud.io&format=long'
|
||||
)
|
||||
.expectBadge({
|
||||
label: 'violations',
|
||||
@@ -122,7 +126,9 @@ t.create('Violations Long Format (legacy API supported)')
|
||||
|
||||
t.create('Blocker Violations')
|
||||
.timeout(10000)
|
||||
.get('/blocker_violations/brave_brave-core.json?server=https://sonarcloud.io')
|
||||
.get(
|
||||
'/blocker_violations/org.sonarsource.sonarqube%3Asonarqube.json?server=https://sonarcloud.io'
|
||||
)
|
||||
.expectBadge({
|
||||
label: 'blocker violations',
|
||||
message: isMetric,
|
||||
@@ -160,7 +166,7 @@ t.create('Blocker Violations (legacy API supported)')
|
||||
t.create('Critical Violations')
|
||||
.timeout(10000)
|
||||
.get(
|
||||
'/critical_violations/brave_brave-core.json?server=https://sonarcloud.io'
|
||||
'/critical_violations/org.sonarsource.sonarqube%3Asonarqube.json?server=https://sonarcloud.io'
|
||||
)
|
||||
.expectBadge({
|
||||
label: 'critical violations',
|
||||
|
||||
@@ -1,10 +1,12 @@
|
||||
import { expect } from 'chai'
|
||||
import Camp from '@shields_io/camp'
|
||||
import portfinder from 'portfinder'
|
||||
import config from 'config'
|
||||
import { ExpressTestHarness } from '../core/express-test-harness.js'
|
||||
import got from '../core/got-test-client.js'
|
||||
import { setRoutes } from './suggest.js'
|
||||
import GithubApiProvider from './github/github-api-provider.js'
|
||||
|
||||
describe('Badge suggestions', function () {
|
||||
describe('Badge suggestions for', function () {
|
||||
const githubApiBaseUrl = process.env.GITHUB_URL || 'https://api.github.com'
|
||||
|
||||
let token, apiProvider
|
||||
@@ -20,27 +22,38 @@ describe('Badge suggestions', function () {
|
||||
})
|
||||
})
|
||||
|
||||
const origin = 'https://example.test'
|
||||
|
||||
let harness
|
||||
let port, baseUrl
|
||||
before(async function () {
|
||||
harness = new ExpressTestHarness()
|
||||
setRoutes([origin], apiProvider, harness.app)
|
||||
await harness.start()
|
||||
port = await portfinder.getPortPromise()
|
||||
baseUrl = `http://127.0.0.1:${port}`
|
||||
})
|
||||
|
||||
let camp
|
||||
before(async function () {
|
||||
camp = Camp.start({ port, hostname: '::' })
|
||||
await new Promise(resolve => camp.on('listening', () => resolve()))
|
||||
})
|
||||
after(async function () {
|
||||
await harness.stop()
|
||||
if (camp) {
|
||||
await new Promise(resolve => camp.close(resolve))
|
||||
camp = undefined
|
||||
}
|
||||
})
|
||||
|
||||
const origin = 'https://example.test'
|
||||
before(function () {
|
||||
setRoutes([origin], apiProvider, camp)
|
||||
})
|
||||
describe('GitHub', function () {
|
||||
context('with an existing project', function () {
|
||||
it('returns the expected suggestions', async function () {
|
||||
const { statusCode, body } = await harness.get(
|
||||
`/$suggest/v1?url=${encodeURIComponent(
|
||||
const { statusCode, body } = await got(
|
||||
`${baseUrl}/$suggest/v1?url=${encodeURIComponent(
|
||||
'https://github.com/atom/atom'
|
||||
)}`,
|
||||
{ responseType: 'json' }
|
||||
{
|
||||
responseType: 'json',
|
||||
}
|
||||
)
|
||||
expect(statusCode).to.equal(200)
|
||||
expect(body).to.deep.equal({
|
||||
@@ -104,11 +117,13 @@ describe('Badge suggestions', function () {
|
||||
it('returns the expected suggestions', async function () {
|
||||
this.timeout(5000)
|
||||
|
||||
const { statusCode, body } = await harness.get(
|
||||
`/$suggest/v1?url=${encodeURIComponent(
|
||||
const { statusCode, body } = await got(
|
||||
`${baseUrl}/$suggest/v1?url=${encodeURIComponent(
|
||||
'https://github.com/badges/not-a-real-project'
|
||||
)}`,
|
||||
{ responseType: 'json' }
|
||||
{
|
||||
responseType: 'json',
|
||||
}
|
||||
)
|
||||
expect(statusCode).to.equal(200)
|
||||
expect(body).to.deep.equal({
|
||||
@@ -172,11 +187,13 @@ describe('Badge suggestions', function () {
|
||||
describe('GitLab', function () {
|
||||
context('with an existing project', function () {
|
||||
it('returns the expected suggestions', async function () {
|
||||
const { statusCode, body } = await harness.get(
|
||||
`/$suggest/v1?url=${encodeURIComponent(
|
||||
const { statusCode, body } = await got(
|
||||
`${baseUrl}/$suggest/v1?url=${encodeURIComponent(
|
||||
'https://gitlab.com/gitlab-org/gitlab'
|
||||
)}`,
|
||||
{ responseType: 'json' }
|
||||
{
|
||||
responseType: 'json',
|
||||
}
|
||||
)
|
||||
expect(statusCode).to.equal(200)
|
||||
expect(body).to.deep.equal({
|
||||
@@ -211,8 +228,8 @@ describe('Badge suggestions', function () {
|
||||
|
||||
context('with an nonexisting project', function () {
|
||||
it('returns the expected suggestions', async function () {
|
||||
const { statusCode, body } = await harness.get(
|
||||
`/$suggest/v1?url=${encodeURIComponent(
|
||||
const { statusCode, body } = await got(
|
||||
`${baseUrl}/$suggest/v1?url=${encodeURIComponent(
|
||||
'https://gitlab.com/gitlab-org/not-gitlab'
|
||||
)}`,
|
||||
{
|
||||
|
||||
@@ -146,8 +146,8 @@ async function findSuggestions(githubApiProvider, url) {
|
||||
// - link: target as a string URL
|
||||
// - preview: object (optional)
|
||||
// - style: string
|
||||
function setRoutes(allowedOrigin, githubApiProvider, app) {
|
||||
app.get('/[$]suggest/v1', (req, res) => {
|
||||
function setRoutes(allowedOrigin, githubApiProvider, server) {
|
||||
server.ajax.on('suggest/v1', (data, end, ask) => {
|
||||
// The typical dev and production setups are cross-origin. However, in
|
||||
// Heroku deploys and some self-hosted deploys these requests may come from
|
||||
// the same host. Chrome does not send an Origin header on same-origin
|
||||
@@ -155,25 +155,23 @@ function setRoutes(allowedOrigin, githubApiProvider, app) {
|
||||
//
|
||||
// It would be better to solve this problem using some well-tested
|
||||
// middleware.
|
||||
const origin = req.headers.origin
|
||||
const origin = ask.req.headers.origin
|
||||
if (origin) {
|
||||
let host
|
||||
try {
|
||||
host = new URL(origin).hostname
|
||||
} catch (e) {
|
||||
res.setHeader('Access-Control-Allow-Origin', 'null')
|
||||
res.json({ err: 'Disallowed' })
|
||||
res.end()
|
||||
ask.res.setHeader('Access-Control-Allow-Origin', 'null')
|
||||
end({ err: 'Disallowed' })
|
||||
return
|
||||
}
|
||||
|
||||
if (host !== req.headers.host) {
|
||||
if (host !== ask.req.headers.host) {
|
||||
if (allowedOrigin.includes(origin)) {
|
||||
res.setHeader('Access-Control-Allow-Origin', origin)
|
||||
ask.res.setHeader('Access-Control-Allow-Origin', origin)
|
||||
} else {
|
||||
res.setHeader('Access-Control-Allow-Origin', 'null')
|
||||
res.json({ err: 'Disallowed' })
|
||||
res.end()
|
||||
ask.res.setHeader('Access-Control-Allow-Origin', 'null')
|
||||
end({ err: 'Disallowed' })
|
||||
return
|
||||
}
|
||||
}
|
||||
@@ -181,10 +179,9 @@ function setRoutes(allowedOrigin, githubApiProvider, app) {
|
||||
|
||||
let url
|
||||
try {
|
||||
url = new URL(req.query.url)
|
||||
url = new URL(data.url)
|
||||
} catch (e) {
|
||||
res.json({ err: `${e}` })
|
||||
res.end()
|
||||
end({ err: `${e}` })
|
||||
return
|
||||
}
|
||||
|
||||
@@ -192,13 +189,11 @@ function setRoutes(allowedOrigin, githubApiProvider, app) {
|
||||
// This interacts with callback code and can't use async/await.
|
||||
// eslint-disable-next-line promise/prefer-await-to-then
|
||||
.then(suggestions => {
|
||||
res.json({ suggestions })
|
||||
res.end()
|
||||
end({ suggestions })
|
||||
})
|
||||
// eslint-disable-next-line promise/prefer-await-to-then
|
||||
.catch(err => {
|
||||
res.json({ suggestions: [], err })
|
||||
res.end()
|
||||
end({ suggestions: [], err })
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
import Camp from '@shields_io/camp'
|
||||
import { expect } from 'chai'
|
||||
import nock from 'nock'
|
||||
import { ExpressTestHarness } from '../core/express-test-harness.js'
|
||||
import portfinder from 'portfinder'
|
||||
import got from '../core/got-test-client.js'
|
||||
import { setRoutes, githubLicense } from './suggest.js'
|
||||
import GithubApiProvider from './github/github-api-provider.js'
|
||||
|
||||
@@ -65,20 +67,28 @@ describe('Badge suggestions', function () {
|
||||
})
|
||||
})
|
||||
|
||||
describe('Express integration', function () {
|
||||
let harness
|
||||
beforeEach(async function () {
|
||||
harness = new ExpressTestHarness()
|
||||
await harness.start()
|
||||
describe('Scoutcamp integration', function () {
|
||||
let port, baseUrl
|
||||
before(async function () {
|
||||
port = await portfinder.getPortPromise()
|
||||
baseUrl = `http://127.0.0.1:${port}`
|
||||
})
|
||||
|
||||
let camp
|
||||
before(async function () {
|
||||
camp = Camp.start({ port, hostname: '::' })
|
||||
await new Promise(resolve => camp.on('listening', () => resolve()))
|
||||
})
|
||||
after(async function () {
|
||||
if (camp) {
|
||||
await new Promise(resolve => camp.close(resolve))
|
||||
camp = undefined
|
||||
}
|
||||
})
|
||||
|
||||
const origin = 'https://example.test'
|
||||
beforeEach(function () {
|
||||
setRoutes([origin], apiProvider, harness.app)
|
||||
})
|
||||
|
||||
afterEach(async function () {
|
||||
await harness.stop()
|
||||
before(function () {
|
||||
setRoutes([origin], apiProvider, camp)
|
||||
})
|
||||
|
||||
context('without an origin header', function () {
|
||||
@@ -96,11 +106,13 @@ describe('Badge suggestions', function () {
|
||||
},
|
||||
})
|
||||
|
||||
const { statusCode, body } = await harness.get(
|
||||
`/$suggest/v1?url=${encodeURIComponent(
|
||||
const { statusCode, body } = await got(
|
||||
`${baseUrl}/$suggest/v1?url=${encodeURIComponent(
|
||||
'https://github.com/atom/atom'
|
||||
)}`,
|
||||
{ responseType: 'json' }
|
||||
{
|
||||
responseType: 'json',
|
||||
}
|
||||
)
|
||||
expect(statusCode).to.equal(200)
|
||||
expect(body).to.deep.equal({
|
||||
|
||||
@@ -69,7 +69,7 @@ export default class SwaggerValidatorService extends BaseJsonService {
|
||||
} else if (valMessages.length === 1) {
|
||||
const { message, level } = valMessages[0]
|
||||
if (level === 'error' && message === `Can't read from file ${specUrl}`) {
|
||||
throw new NotFound({ prettyMessage: 'spec not found or unreadable' })
|
||||
throw new NotFound({ prettyMessage: 'spec not found or unreadable ' })
|
||||
}
|
||||
}
|
||||
if (valMessages.every(msg => msg.level === 'warning')) {
|
||||
|
||||
@@ -1,23 +0,0 @@
|
||||
import { expect } from 'chai'
|
||||
import { versionColorForWordpressVersion } from './wordpress-version-color.js'
|
||||
|
||||
describe('versionColorForWordpressVersion()', function () {
|
||||
it('generates correct colours for given versions', async function () {
|
||||
this.timeout(5e3)
|
||||
|
||||
expect(await versionColorForWordpressVersion('11.2.0')).to.equal(
|
||||
'brightgreen'
|
||||
)
|
||||
expect(await versionColorForWordpressVersion('11.2')).to.equal(
|
||||
'brightgreen'
|
||||
)
|
||||
expect(await versionColorForWordpressVersion('3.2.0')).to.equal('yellow')
|
||||
expect(await versionColorForWordpressVersion('3.2')).to.equal('yellow')
|
||||
expect(await versionColorForWordpressVersion('4.7-beta.3')).to.equal(
|
||||
'yellow'
|
||||
)
|
||||
expect(await versionColorForWordpressVersion('cheese')).to.equal(
|
||||
'lightgrey'
|
||||
)
|
||||
})
|
||||
})
|
||||
@@ -1,5 +1,8 @@
|
||||
import { expect } from 'chai'
|
||||
import { toSemver } from './wordpress-version-color.js'
|
||||
import {
|
||||
toSemver,
|
||||
versionColorForWordpressVersion,
|
||||
} from './wordpress-version-color.js'
|
||||
|
||||
describe('toSemver() function', function () {
|
||||
it('coerces versions', function () {
|
||||
@@ -10,3 +13,24 @@ describe('toSemver() function', function () {
|
||||
expect(toSemver('foobar')).to.equal('foobar')
|
||||
})
|
||||
})
|
||||
|
||||
describe('versionColorForWordpressVersion()', function () {
|
||||
it('generates correct colours for given versions', async function () {
|
||||
this.timeout(5e3)
|
||||
|
||||
expect(await versionColorForWordpressVersion('11.2.0')).to.equal(
|
||||
'brightgreen'
|
||||
)
|
||||
expect(await versionColorForWordpressVersion('11.2')).to.equal(
|
||||
'brightgreen'
|
||||
)
|
||||
expect(await versionColorForWordpressVersion('3.2.0')).to.equal('yellow')
|
||||
expect(await versionColorForWordpressVersion('3.2')).to.equal('yellow')
|
||||
expect(await versionColorForWordpressVersion('4.7-beta.3')).to.equal(
|
||||
'yellow'
|
||||
)
|
||||
expect(await versionColorForWordpressVersion('cheese')).to.equal(
|
||||
'lightgrey'
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
Reference in New Issue
Block a user