From f5e41237123aed4c8637ddec4674f9705442587c Mon Sep 17 00:00:00 2001 From: PyvesB Date: Mon, 19 Apr 2021 20:43:21 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=208ef8b?= =?UTF-8?q?76d8d87ac586e268684a04432ad176c36df=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- badge-maker_lib_index.js.html | 4 +- core_base-service_base-graphql.js.html | 4 +- core_base-service_base-json.js.html | 4 +- core_base-service_base-svg-scraping.js.html | 4 +- core_base-service_base-xml.js.html | 4 +- core_base-service_base-yaml.js.html | 4 +- core_base-service_base.js.html | 4 +- core_base-service_errors.js.html | 4 +- core_base-service_graphql.js.html | 4 +- core_server_prometheus-metrics.js.html | 4 +- core_server_server.js.html | 4 +- ...-test-runner_create-service-tester.js.html | 4 +- ...ice-test-runner_icedfrisby-shields.js.html | 4 +- ...ice-test-runner_infer-pull-request.js.html | 4 +- core_service-test-runner_runner.js.html | 4 +- ...service-test-runner_service-tester.js.html | 4 +- ...ice-test-runner_services-for-title.js.html | 4 +- core_token-pooling_token-pool.js.html | 4 +- global.html | 4 +- index.html | 4 +- module-badge-maker.html | 4 +- ...le-core_base-service_base-BaseService.html | 4 +- ...rvice_base-graphql-BaseGraphqlService.html | 4 +- module-core_base-service_base-graphql.html | 4 +- ...ase-service_base-json-BaseJsonService.html | 4 +- module-core_base-service_base-json.html | 4 +- ...e-svg-scraping-BaseSvgScrapingService.html | 4 +- ...e-core_base-service_base-svg-scraping.html | 4 +- ..._base-service_base-xml-BaseXmlService.html | 4 +- module-core_base-service_base-xml.html | 4 +- ...ase-service_base-yaml-BaseYamlService.html | 4 +- module-core_base-service_base-yaml.html | 4 +- module-core_base-service_base.html | 4 +- ...e-core_base-service_errors-Deprecated.html | 4 +- ...e-service_errors-ImproperlyConfigured.html | 4 +- ...core_base-service_errors-Inaccessible.html | 4 +- ..._base-service_errors-InvalidParameter.html | 4 +- ...e_base-service_errors-InvalidResponse.html | 4 +- module-core_base-service_errors-NotFound.html | 4 +- ...se-service_errors-ShieldsRuntimeError.html | 4 +- module-core_base-service_errors.html | 4 +- module-core_base-service_graphql.html | 4 +- module-core_server_server-Server.html | 4 +- module-core_server_server.html | 4 +- ...ice-test-runner_create-service-tester.html | 4 +- ...ervice-test-runner_icedfrisby-shields.html | 4 +- ...ervice-test-runner_infer-pull-request.html | 4 +- ...ore_service-test-runner_runner-Runner.html | 4 +- module-core_service-test-runner_runner.html | 4 +- ...t-runner_service-tester-ServiceTester.html | 4 +- ...re_service-test-runner_service-tester.html | 4 +- ...ervice-test-runner_services-for-title.html | 4 +- ...e-core_token-pooling_token-pool-Token.html | 4 +- ...re_token-pooling_token-pool-TokenPool.html | 4 +- module-core_token-pooling_token-pool.html | 4 +- module-services_dynamic_json-path.html | 4 +- ...ervices_steam_steam-base-BaseSteamAPI.html | 4 +- module-services_steam_steam-base.html | 4 +- module.exports.html | 4 +- services_criterion_criterion.service.js.html | 4 +- services_dynamic_json-path.js.html | 4 +- ...s_github_github-total-star.service.js.html | 4 +- ..._osslifecycle_osslifecycle.service.js.html | 4 +- services_packagist_packagist-base.js.html | 4 +- services_steam_steam-base.js.html | 4 +- tutorial-TUTORIAL.html | 4 +- tutorial-badge-urls.html | 4 +- tutorial-code-walkthrough.html | 4 +- tutorial-deprecating-badges.html | 4 +- tutorial-input-validation.html | 4 +- tutorial-json-format.html | 4 +- tutorial-logos.html | 4 +- tutorial-performance-testing.html | 4 +- tutorial-production-hosting.html | 4 +- tutorial-releases.html | 4 +- tutorial-rewriting-services.html | 320 ------------------ tutorial-self-hosting.html | 4 +- tutorial-server-secrets.html | 4 +- tutorial-service-tests.html | 4 +- 79 files changed, 156 insertions(+), 476 deletions(-) delete mode 100644 tutorial-rewriting-services.html diff --git a/badge-maker_lib_index.js.html b/badge-maker_lib_index.js.html index 197b9c184d..7015ff6dce 100644 --- a/badge-maker_lib_index.js.html +++ b/badge-maker_lib_index.js.html @@ -117,13 +117,13 @@ module.exports = {
diff --git a/core_base-service_base-graphql.js.html b/core_base-service_base-graphql.js.html index a3cf7bba43..aed84e9f8b 100644 --- a/core_base-service_base-graphql.js.html +++ b/core_base-service_base-graphql.js.html @@ -132,13 +132,13 @@ module.exports = BaseGraphqlService
diff --git a/core_base-service_base-json.js.html b/core_base-service_base-json.js.html index 4771dffb09..782763dc2d 100644 --- a/core_base-service_base-json.js.html +++ b/core_base-service_base-json.js.html @@ -93,13 +93,13 @@ module.exports = BaseJsonService
diff --git a/core_base-service_base-svg-scraping.js.html b/core_base-service_base-svg-scraping.js.html index d8d0f83ebc..e52d55743c 100644 --- a/core_base-service_base-svg-scraping.js.html +++ b/core_base-service_base-svg-scraping.js.html @@ -129,13 +129,13 @@ module.exports = BaseSvgScrapingService
diff --git a/core_base-service_base-xml.js.html b/core_base-service_base-xml.js.html index e78d54a36d..fecb4b2a9e 100644 --- a/core_base-service_base-xml.js.html +++ b/core_base-service_base-xml.js.html @@ -107,13 +107,13 @@ module.exports = BaseXmlService
diff --git a/core_base-service_base-yaml.js.html b/core_base-service_base-yaml.js.html index 3df77325f8..bc77b4a609 100644 --- a/core_base-service_base-yaml.js.html +++ b/core_base-service_base-yaml.js.html @@ -111,13 +111,13 @@ module.exports = BaseYamlService
diff --git a/core_base-service_base.js.html b/core_base-service_base.js.html index f4fd74a58b..7774f20c5b 100644 --- a/core_base-service_base.js.html +++ b/core_base-service_base.js.html @@ -602,13 +602,13 @@ module.exports = BaseService
diff --git a/core_base-service_errors.js.html b/core_base-service_errors.js.html index c789bf0823..3c5c9850ce 100644 --- a/core_base-service_errors.js.html +++ b/core_base-service_errors.js.html @@ -257,13 +257,13 @@ module.exports = {
diff --git a/core_base-service_graphql.js.html b/core_base-service_graphql.js.html index 4780d1f26b..5849657fe7 100644 --- a/core_base-service_graphql.js.html +++ b/core_base-service_graphql.js.html @@ -88,13 +88,13 @@ module.exports = { mergeQueries }
diff --git a/core_server_prometheus-metrics.js.html b/core_server_prometheus-metrics.js.html index fe885ca732..c93ec8b18b 100644 --- a/core_server_prometheus-metrics.js.html +++ b/core_server_prometheus-metrics.js.html @@ -161,13 +161,13 @@ module.exports = class PrometheusMetrics {
diff --git a/core_server_server.js.html b/core_server_server.js.html index 412a63db60..d1b4c0ec0a 100644 --- a/core_server_server.js.html +++ b/core_server_server.js.html @@ -572,13 +572,13 @@ module.exports = Server
diff --git a/core_service-test-runner_create-service-tester.js.html b/core_service-test-runner_create-service-tester.js.html index 9a3c1529ad..2b5f9c45b2 100644 --- a/core_service-test-runner_create-service-tester.js.html +++ b/core_service-test-runner_create-service-tester.js.html @@ -69,13 +69,13 @@ module.exports = createServiceTester
diff --git a/core_service-test-runner_icedfrisby-shields.js.html b/core_service-test-runner_icedfrisby-shields.js.html index 6739d6d868..cd27fd4476 100644 --- a/core_service-test-runner_icedfrisby-shields.js.html +++ b/core_service-test-runner_icedfrisby-shields.js.html @@ -124,13 +124,13 @@ module.exports = factory
diff --git a/core_service-test-runner_infer-pull-request.js.html b/core_service-test-runner_infer-pull-request.js.html index 58432886cf..4de066515a 100644 --- a/core_service-test-runner_infer-pull-request.js.html +++ b/core_service-test-runner_infer-pull-request.js.html @@ -141,13 +141,13 @@ module.exports = {
diff --git a/core_service-test-runner_runner.js.html b/core_service-test-runner_runner.js.html index 340f55c8ab..973b7c340f 100644 --- a/core_service-test-runner_runner.js.html +++ b/core_service-test-runner_runner.js.html @@ -111,13 +111,13 @@ module.exports = Runner
diff --git a/core_service-test-runner_service-tester.js.html b/core_service-test-runner_service-tester.js.html index 398c1c63fb..885d6fc8c8 100644 --- a/core_service-test-runner_service-tester.js.html +++ b/core_service-test-runner_service-tester.js.html @@ -179,13 +179,13 @@ module.exports = ServiceTester
diff --git a/core_service-test-runner_services-for-title.js.html b/core_service-test-runner_services-for-title.js.html index 3631b1af4b..5583f5952d 100644 --- a/core_service-test-runner_services-for-title.js.html +++ b/core_service-test-runner_services-for-title.js.html @@ -70,13 +70,13 @@ module.exports = servicesForTitle
diff --git a/core_token-pooling_token-pool.js.html b/core_token-pooling_token-pool.js.html index 81e4e880ac..97684e796c 100644 --- a/core_token-pooling_token-pool.js.html +++ b/core_token-pooling_token-pool.js.html @@ -397,13 +397,13 @@ module.exports = {
diff --git a/global.html b/global.html index cdef5e81c2..338ebd27db 100644 --- a/global.html +++ b/global.html @@ -455,13 +455,13 @@
diff --git a/index.html b/index.html index 1dfdb33aa9..67583bf2dc 100644 --- a/index.html +++ b/index.html @@ -213,13 +213,13 @@ under their terms and license.


diff --git a/module-badge-maker.html b/module-badge-maker.html index 196d4fd943..3f6552b6ab 100644 --- a/module-badge-maker.html +++ b/module-badge-maker.html @@ -381,13 +381,13 @@
diff --git a/module-core_base-service_base-BaseService.html b/module-core_base-service_base-BaseService.html index 0efec8989f..68d4ff1610 100644 --- a/module-core_base-service_base-BaseService.html +++ b/module-core_base-service_base-BaseService.html @@ -737,13 +737,13 @@ defined in this.route.pattern or this.route.capture


diff --git a/module-core_base-service_base-graphql-BaseGraphqlService.html b/module-core_base-service_base-graphql-BaseGraphqlService.html index 439a0f185a..37e51649b9 100644 --- a/module-core_base-service_base-graphql-BaseGraphqlService.html +++ b/module-core_base-service_base-graphql-BaseGraphqlService.html @@ -823,13 +823,13 @@ an InvalidResponse.


diff --git a/module-core_base-service_base-graphql.html b/module-core_base-service_base-graphql.html index 2de572b6b9..928a084f7e 100644 --- a/module-core_base-service_base-graphql.html +++ b/module-core_base-service_base-graphql.html @@ -77,13 +77,13 @@
diff --git a/module-core_base-service_base-json-BaseJsonService.html b/module-core_base-service_base-json-BaseJsonService.html index 6b6c2aaefa..7300934f90 100644 --- a/module-core_base-service_base-json-BaseJsonService.html +++ b/module-core_base-service_base-json-BaseJsonService.html @@ -668,13 +668,13 @@ This can be used to extend or override the
diff --git a/module-core_base-service_base-json.html b/module-core_base-service_base-json.html index f10eb44209..182159ce67 100644 --- a/module-core_base-service_base-json.html +++ b/module-core_base-service_base-json.html @@ -77,13 +77,13 @@
diff --git a/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html b/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html index 799c245b45..a267a7f951 100644 --- a/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html +++ b/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html @@ -759,13 +759,13 @@ This can be used to extend or override the
diff --git a/module-core_base-service_base-svg-scraping.html b/module-core_base-service_base-svg-scraping.html index 5090af7eb2..f2e6d25064 100644 --- a/module-core_base-service_base-svg-scraping.html +++ b/module-core_base-service_base-svg-scraping.html @@ -77,13 +77,13 @@
diff --git a/module-core_base-service_base-xml-BaseXmlService.html b/module-core_base-service_base-xml-BaseXmlService.html index de874db77e..2156cd6cd8 100644 --- a/module-core_base-service_base-xml-BaseXmlService.html +++ b/module-core_base-service_base-xml-BaseXmlService.html @@ -551,13 +551,13 @@ This can be used to extend or override the
diff --git a/module-core_base-service_base-xml.html b/module-core_base-service_base-xml.html index 488c3c1ea1..5128038a29 100644 --- a/module-core_base-service_base-xml.html +++ b/module-core_base-service_base-xml.html @@ -77,13 +77,13 @@
diff --git a/module-core_base-service_base-yaml-BaseYamlService.html b/module-core_base-service_base-yaml-BaseYamlService.html index b39e43786d..c934d22f99 100644 --- a/module-core_base-service_base-yaml-BaseYamlService.html +++ b/module-core_base-service_base-yaml-BaseYamlService.html @@ -548,13 +548,13 @@ This can be used to extend or override the
diff --git a/module-core_base-service_base-yaml.html b/module-core_base-service_base-yaml.html index 46e673164d..6571293686 100644 --- a/module-core_base-service_base-yaml.html +++ b/module-core_base-service_base-yaml.html @@ -77,13 +77,13 @@
diff --git a/module-core_base-service_base.html b/module-core_base-service_base.html index a6236e16bd..d308f9e5e3 100644 --- a/module-core_base-service_base.html +++ b/module-core_base-service_base.html @@ -1160,13 +1160,13 @@ when the parameter is absent. (Note that in,
diff --git a/module-core_base-service_errors-Deprecated.html b/module-core_base-service_errors-Deprecated.html index 8aaf5df721..da91bd1b61 100644 --- a/module-core_base-service_errors-Deprecated.html +++ b/module-core_base-service_errors-Deprecated.html @@ -205,13 +205,13 @@
diff --git a/module-core_base-service_errors-ImproperlyConfigured.html b/module-core_base-service_errors-ImproperlyConfigured.html index 9830f3824b..ca09cf2c3c 100644 --- a/module-core_base-service_errors-ImproperlyConfigured.html +++ b/module-core_base-service_errors-ImproperlyConfigured.html @@ -205,13 +205,13 @@
diff --git a/module-core_base-service_errors-Inaccessible.html b/module-core_base-service_errors-Inaccessible.html index b5e7ac6884..063b0bb9bd 100644 --- a/module-core_base-service_errors-Inaccessible.html +++ b/module-core_base-service_errors-Inaccessible.html @@ -206,13 +206,13 @@ or to wrap a 5XX response


diff --git a/module-core_base-service_errors-InvalidParameter.html b/module-core_base-service_errors-InvalidParameter.html index 1d896ee014..5d8ef017fc 100644 --- a/module-core_base-service_errors-InvalidParameter.html +++ b/module-core_base-service_errors-InvalidParameter.html @@ -206,13 +206,13 @@ is invalid or unexpected


diff --git a/module-core_base-service_errors-InvalidResponse.html b/module-core_base-service_errors-InvalidResponse.html index 07f8bce94a..0e84bcadf6 100644 --- a/module-core_base-service_errors-InvalidResponse.html +++ b/module-core_base-service_errors-InvalidResponse.html @@ -205,13 +205,13 @@
diff --git a/module-core_base-service_errors-NotFound.html b/module-core_base-service_errors-NotFound.html index 69508415bd..b4a7361cf1 100644 --- a/module-core_base-service_errors-NotFound.html +++ b/module-core_base-service_errors-NotFound.html @@ -205,13 +205,13 @@
diff --git a/module-core_base-service_errors-ShieldsRuntimeError.html b/module-core_base-service_errors-ShieldsRuntimeError.html index 3bfeb93f97..da7a5290b9 100644 --- a/module-core_base-service_errors-ShieldsRuntimeError.html +++ b/module-core_base-service_errors-ShieldsRuntimeError.html @@ -378,13 +378,13 @@ should override this method.


diff --git a/module-core_base-service_errors.html b/module-core_base-service_errors.html index 8d44e07aef..eafa62630a 100644 --- a/module-core_base-service_errors.html +++ b/module-core_base-service_errors.html @@ -348,13 +348,13 @@ badge when we catch and render the exception (Optional)


diff --git a/module-core_base-service_graphql.html b/module-core_base-service_graphql.html index f22cd57c4b..e61b09a1fe 100644 --- a/module-core_base-service_graphql.html +++ b/module-core_base-service_graphql.html @@ -248,13 +248,13 @@ but can't use that due to incorrect packaging.


diff --git a/module-core_server_server-Server.html b/module-core_server_server-Server.html index fc3c6e4a3c..5f078a3d1e 100644 --- a/module-core_server_server-Server.html +++ b/module-core_server_server-Server.html @@ -675,13 +675,13 @@ Start listening for requests on this.baseUrl()


diff --git a/module-core_server_server.html b/module-core_server_server.html index 4864955be2..02a62b3bec 100644 --- a/module-core_server_server.html +++ b/module-core_server_server.html @@ -77,13 +77,13 @@
diff --git a/module-core_service-test-runner_create-service-tester.html b/module-core_service-test-runner_create-service-tester.html index caa1339a37..82b5f77984 100644 --- a/module-core_service-test-runner_create-service-tester.html +++ b/module-core_service-test-runner_create-service-tester.html @@ -188,13 +188,13 @@ service.


diff --git a/module-core_service-test-runner_icedfrisby-shields.html b/module-core_service-test-runner_icedfrisby-shields.html index 365892e475..ca7c22b709 100644 --- a/module-core_service-test-runner_icedfrisby-shields.html +++ b/module-core_service-test-runner_icedfrisby-shields.html @@ -244,13 +244,13 @@
diff --git a/module-core_service-test-runner_infer-pull-request.html b/module-core_service-test-runner_infer-pull-request.html index 45dcba6d41..fb0add5aa9 100644 --- a/module-core_service-test-runner_infer-pull-request.html +++ b/module-core_service-test-runner_infer-pull-request.html @@ -464,13 +464,13 @@ of a pull request from the environment variables.


diff --git a/module-core_service-test-runner_runner-Runner.html b/module-core_service-test-runner_runner-Runner.html index a6c1167afd..9bb457e1b2 100644 --- a/module-core_service-test-runner_runner-Runner.html +++ b/module-core_service-test-runner_runner-Runner.html @@ -562,13 +562,13 @@ overridden on instances.


diff --git a/module-core_service-test-runner_runner.html b/module-core_service-test-runner_runner.html index 12be535233..77452b3a1d 100644 --- a/module-core_service-test-runner_runner.html +++ b/module-core_service-test-runner_runner.html @@ -77,13 +77,13 @@
diff --git a/module-core_service-test-runner_service-tester-ServiceTester.html b/module-core_service-test-runner_service-tester-ServiceTester.html index 883b8af498..52b65fb949 100644 --- a/module-core_service-test-runner_service-tester-ServiceTester.html +++ b/module-core_service-test-runner_service-tester-ServiceTester.html @@ -1120,13 +1120,13 @@ the CLI, or directly on the tester.


diff --git a/module-core_service-test-runner_service-tester.html b/module-core_service-test-runner_service-tester.html index 5892d54901..e003380e2a 100644 --- a/module-core_service-test-runner_service-tester.html +++ b/module-core_service-test-runner_service-tester.html @@ -77,13 +77,13 @@
diff --git a/module-core_service-test-runner_services-for-title.html b/module-core_service-test-runner_services-for-title.html index c871b16640..079296f115 100644 --- a/module-core_service-test-runner_services-for-title.html +++ b/module-core_service-test-runner_services-for-title.html @@ -236,13 +236,13 @@ as an array of strings.


diff --git a/module-core_token-pooling_token-pool-Token.html b/module-core_token-pooling_token-pool-Token.html index ebd0abb4ae..fc0301d06a 100644 --- a/module-core_token-pooling_token-pool-Token.html +++ b/module-core_token-pooling_token-pool-Token.html @@ -709,13 +709,13 @@ stable ordering for a valid priority queue.


diff --git a/module-core_token-pooling_token-pool-TokenPool.html b/module-core_token-pooling_token-pool-TokenPool.html index fbd1cf62d6..03347ed1c2 100644 --- a/module-core_token-pooling_token-pool-TokenPool.html +++ b/module-core_token-pooling_token-pool-TokenPool.html @@ -893,13 +893,13 @@ indicate it should not be reused.


diff --git a/module-core_token-pooling_token-pool.html b/module-core_token-pooling_token-pool.html index 6f0220f437..7b448d3c88 100644 --- a/module-core_token-pooling_token-pool.html +++ b/module-core_token-pooling_token-pool.html @@ -243,13 +243,13 @@
diff --git a/module-services_dynamic_json-path.html b/module-services_dynamic_json-path.html index f6cb9b969c..0f8e496f19 100644 --- a/module-services_dynamic_json-path.html +++ b/module-services_dynamic_json-path.html @@ -536,13 +536,13 @@ This can be used to extend or override the
diff --git a/module-services_steam_steam-base-BaseSteamAPI.html b/module-services_steam_steam-base-BaseSteamAPI.html index 2a11a9cb02..2f14269878 100644 --- a/module-services_steam_steam-base-BaseSteamAPI.html +++ b/module-services_steam_steam-base-BaseSteamAPI.html @@ -374,13 +374,13 @@
diff --git a/module-services_steam_steam-base.html b/module-services_steam_steam-base.html index 8a6c8f65b6..e40b6e3368 100644 --- a/module-services_steam_steam-base.html +++ b/module-services_steam_steam-base.html @@ -77,13 +77,13 @@
diff --git a/module.exports.html b/module.exports.html index 740993efb0..a832d8222c 100644 --- a/module.exports.html +++ b/module.exports.html @@ -628,13 +628,13 @@ Other keywords are possible, but will appear in grey.


diff --git a/services_criterion_criterion.service.js.html b/services_criterion_criterion.service.js.html index ee75cc6d5c..78f1577fa6 100644 --- a/services_criterion_criterion.service.js.html +++ b/services_criterion_criterion.service.js.html @@ -104,13 +104,13 @@ module.exports = class Criterion extends BaseJsonService {
diff --git a/services_dynamic_json-path.js.html b/services_dynamic_json-path.js.html index 7ce6879166..3644fafa1c 100644 --- a/services_dynamic_json-path.js.html +++ b/services_dynamic_json-path.js.html @@ -116,13 +116,13 @@ module.exports = superclass =>
diff --git a/services_github_github-total-star.service.js.html b/services_github_github-total-star.service.js.html index 670854ff91..dfa8f30f79 100644 --- a/services_github_github-total-star.service.js.html +++ b/services_github_github-total-star.service.js.html @@ -282,13 +282,13 @@ module.exports = class GithubTotalStarService extends GithubAuthV4Service {
diff --git a/services_osslifecycle_osslifecycle.service.js.html b/services_osslifecycle_osslifecycle.service.js.html index d25b8faf9d..42844ba428 100644 --- a/services_osslifecycle_osslifecycle.service.js.html +++ b/services_osslifecycle_osslifecycle.service.js.html @@ -135,13 +135,13 @@ module.exports = class OssTracker extends BaseService {
diff --git a/services_packagist_packagist-base.js.html b/services_packagist_packagist-base.js.html index 56f406e73e..107f871b58 100644 --- a/services_packagist_packagist-base.js.html +++ b/services_packagist_packagist-base.js.html @@ -146,13 +146,13 @@ module.exports = {
diff --git a/services_steam_steam-base.js.html b/services_steam_steam-base.js.html index 98b84e7b7e..d3c09f64fa 100644 --- a/services_steam_steam-base.js.html +++ b/services_steam_steam-base.js.html @@ -93,13 +93,13 @@ module.exports = BaseSteamAPI
diff --git a/tutorial-TUTORIAL.html b/tutorial-TUTORIAL.html index 9b050e6111..06bc41df77 100644 --- a/tutorial-TUTORIAL.html +++ b/tutorial-TUTORIAL.html @@ -380,13 +380,13 @@ will review your contribution.
diff --git a/tutorial-badge-urls.html b/tutorial-badge-urls.html index 6852ba41bd..0930f6d5e0 100644 --- a/tutorial-badge-urls.html +++ b/tutorial-badge-urls.html @@ -71,13 +71,13 @@ badge is for issues, and the parameters are :user/:repo.
diff --git a/tutorial-code-walkthrough.html b/tutorial-code-walkthrough.html index aa5d0e1c4f..4728a420c4 100644 --- a/tutorial-code-walkthrough.html +++ b/tutorial-code-walkthrough.html @@ -234,13 +234,13 @@ result over the HTTPS connection.
diff --git a/tutorial-deprecating-badges.html b/tutorial-deprecating-badges.html index 4cc9dba183..d7549e8c36 100644 --- a/tutorial-deprecating-badges.html +++ b/tutorial-deprecating-badges.html @@ -110,13 +110,13 @@ t.create('no longer available (previously number of layers)')
diff --git a/tutorial-input-validation.html b/tutorial-input-validation.html index 806b5c8538..75b1c2061c 100644 --- a/tutorial-input-validation.html +++ b/tutorial-input-validation.html @@ -97,13 +97,13 @@
diff --git a/tutorial-json-format.html b/tutorial-json-format.html index 138e5a6c34..8a013c69cf 100644 --- a/tutorial-json-format.html +++ b/tutorial-json-format.html @@ -54,13 +54,13 @@ if you have any queries regarding the JSON format.


diff --git a/tutorial-logos.html b/tutorial-logos.html index 56ea63dd6f..64e084e02d 100644 --- a/tutorial-logos.html +++ b/tutorial-logos.html @@ -89,13 +89,13 @@
diff --git a/tutorial-performance-testing.html b/tutorial-performance-testing.html index 6334876289..7390c83735 100644 --- a/tutorial-performance-testing.html +++ b/tutorial-performance-testing.html @@ -70,13 +70,13 @@ node --prof-process --preprocess -j isolate-00000244AB6ED3B0-11920-v8.log | flam
diff --git a/tutorial-production-hosting.html b/tutorial-production-hosting.html index 8ff2b09b7d..6388a407a8 100644 --- a/tutorial-production-hosting.html +++ b/tutorial-production-hosting.html @@ -237,13 +237,13 @@ the server. It's generously donated by Sent
diff --git a/tutorial-releases.html b/tutorial-releases.html index 2a2a870296..c56cf5a0aa 100644 --- a/tutorial-releases.html +++ b/tutorial-releases.html @@ -73,13 +73,13 @@
diff --git a/tutorial-rewriting-services.html b/tutorial-rewriting-services.html deleted file mode 100644 index 788a5ca3d8..0000000000 --- a/tutorial-rewriting-services.html +++ /dev/null @@ -1,320 +0,0 @@ - - - - - JSDoc: Tutorial: rewriting-services - - - - - - - - - - -
- -

Tutorial: rewriting-services

- -
- -
- - -

rewriting-services

-
- -
-

WARNING: all legacy services have been rewritten, this document may contain outdated information.

-

Tips for rewriting legacy services

-

Background

-

The services are in the process of being rewritten to use our new service -framework (#1358). -Meanwhile, the legacy services extend from an abstract -adapter called LegacyService which provides a place to put the -camp.route() invocation. The wrapper extends from BaseService, so it -supports badge examples via category, examples, and route. Setting route -also enables createServiceTester() to infer a service's base path, reducing -boilerplate for creating the tester.

-

Legacy services look like:

-
module.exports = class ExampleService extends LegacyService {
-  static category = 'build'
-
-  static registerLegacyRouteHandler({ camp, cache }) {
-    camp.route(
-      /^\/example\/([^\/]+)\/([^\/]+)\.(svg|png|gif|jpg|json)$/,
-      cache(function (data, match, sendBadge, request) {
-        var first = match[1]
-        var second = match[2]
-        var format = match[3]
-        var badgeData = getBadgeData('X' + first + 'X', data)
-        badgeData.text[1] = second
-        badgeData.colorscheme = 'blue'
-        badgeData.colorB = '#008bb8'
-        sendBadge(format, badgeData)
-      })
-    )
-  }
-}
-
-

References:

- -

First, write some tests

-

If service tests don’t exist for the legacy service, stop and write them first. -It’s recommended to PR these separately. If there’s some test coverage, it’s -probably fine to move right ahead and add more in the process. Make sure the -tests are passing, though.

-

Organization

-
    -
  1. When there’s a single legacy service that handles lots of different things -(e.g. version, license, and downloads), it should be split into three separate -service classes and placed in three separate files, e.g.:
    2. -
-
    -
  • example-version.service.js
    • -
  • example-license.service.js
    • -
  • example-downloads.service.js
    • -
-
    -
  1. -

    When a badge offers different variants of basically the same thing, it’s okay -to put them in the same service class. For example, daily/weekly/monthly/total -downloads can go in one badge, and star rating vs point rating vs rating count -can go in one badge, and same with various kinds of detail about a pull request. -The hard limit (as of now anyway) is one category per service class.

    -
    2. -
  2. -

    If the tests haven’t been split up, split them up too and make sure they -still pass.

    -
    3. -
-

Get the route working

-
    -
  1. -

    Disable the legacy service by adding a return at the top of -registerLegacyRouteHandler().

    -
    2. -
  2. -

    Set up the route for one of the badges. First determine if you can express -the route using a pattern. A pattern (e.g. pattern: ':param1/:param2') is -the simplest way to declare the route, also the most readable, and will be -useful for displaying a badge builder with fields in the front end and -generating badge URLs programmatically.

    -
    3. -
  3. -

    When creating the initial route, you can stub out the service. A minimal -service extends BaseJsonService (or BaseService, or one of the others), and -defines route() and handle(). defaultBadgeData is optional but suggested:

    -
    4. -
-
const BaseJsonService = require('../base-json')
-
-class ExampleDownloads extends BaseJsonService {
-  static route = { base: 'example/d', pattern: ':param1/:param2' }
-
-  static defaultBadgeData() {
-    return { label: 'downloads' } // or whatever
-  }
-
-  async handle({ param1, param2 }) {
-    return { message: 'hello' }
-  }
-}
-
-
    -
  1. We don’t have really good tools for debugging matches, so the best you can do -is run a subset of your tests. To run a single service test, add .only() -somewhere in the chain, and run npm run test:services:trace -- --only=example.
    2. -
-
t.create('build status')
-  .get('/pip.json')
-  .only() // Prevent this ServiceTester from running its other tests.
-  .expectBadge(
-    label: 'docs',
-    message: Joi.alternatives().try(isBuildStatus, Joi.equal('unknown')),
-  )
-
-
    -
  1. -

    Presumably the test will fail, though by examining the copious output, you -can confirm the route was matched and the named parameters mapped successfully. -Since you'll have just run the tests on the old code (right?) you'll know you -haven't inadvertently changed the route (an easy mistake to make).

    -
    2. -
  2. -

    If the legacy service had a base URL and you've changed it, you’ll need to -update the tests and the examples. Take care to do that.

    -
    3. -
-

Implement render() and handle()

-

Once the route is working, fill out render() and handle().

-
    -
  1. If there’s a single service, you can implement fetch as a method or a -function at the top of the file. If there are more than one service which share -fetching code, you can put the fetch function in example-common.js like this -one for github:
    2. -
-
-
const Joi = require('joi')
-const { errorMessagesFor } = require('./github-helpers')
-
-const issueSchema = Joi.object({
-  head: Joi.object({
-    sha: Joi.string().required(),
-  }).required(),
-}).required()
-
-async function fetchIssue(serviceInstance, { user, repo, number }) {
-  return serviceInstance._requestJson({
-    schema: issueSchema,
-    url: `/repos/${user}/${repo}/pulls/${number}`,
-    errorMessages: errorMessagesFor('pull request or repo not found'),
-  })
-}
-
-module.exports = {
-  fetchIssue,
-}
-
-
-

or create an abstract superclass like PypiBase:

-
-
const Joi = require('joi')
-const BaseJsonService = require('../base-json')
-
-const schema = Joi.object({
-  info: Joi.object({
-    ...
-  }).required()
-}).required()
-
-module.exports = class PypiBase extends BaseJsonService {
-  static buildRoute(base) {
-    return {
-      base,
-      pattern: ':egg*',
-    }
-  }
-
-  async fetch({ egg }) {
-    return this._requestJson({
-      schema,
-      url: `https://pypi.org/pypi/${egg}/json`,
-      errorMessages: { 404: 'package or version not found' },
-    })
-  }
-}
-
-
-
    -
  1. -

    Validation should be handled using Joi. Save this for last. While you're -getting things working, you can use const schema = Joi.any(), which matches -anything.

    -
    2. -
  2. -

    Substitution of default values should also be handled by Joi, using -.default().

    -
    3. -
  3. -

    To keep with the design pattern of render(), formatting concerns, including -concatenation and color computation, should be dealt with inside render(). -This helps avoid static examples falling out of sync with the implementation.

    -
    4. -
-

Error handling

-

BaseService includes built-in runtime error handling. Error classes are defined -in services/errors.js. Request code and validation code will throw a runtime -error, which will then bubble up to BaseService, which then renders an error -badge. The cases covered by built-in error handling need not be tested in each -service, and existing tests should be removed.

-
    -
  1. -

    If an external server can't be reached or returns a 5xx status code, -_requestJson() along with code in lib/error-helper.js will bubble up an -Inaccessible error.

    -
    2. -
  2. -

    If a response does not match the schema, validate() will bubble up an -InvalidResponse error which will display invalid response data.

    -
    3. -
-

Error handling can also be customized by the service. Alternate messages -corresponding to HTTP status codes can be specified in the errorMessages -parameter to _requestJson() etc.

-

For the not found case, a service test should establish that the API is doing -what we expect. If the API returns a 404 error, code in lib/error-helper.js -will automatically throw a NotFound error. The error message can, and -generally should be customized to display something more specific like -package not found or room not found.

-

Not all services return a 404 response in the not found case. Sometimes a -different status code is returned.

-

Sometimes a 200 response must be examined to distinguish the not found case from a success case. This can be handled in either of two ways:

-
    -
  • Write a schema which accommodates both the success and error cases.
    • -
  • Write the schema for the success case. Pass schema: Joi.any() to -_requestJson(). Manually check for the error case, then invoke -_validate() with the success-case schema.
    • -
-

In either case, the service should throw e.g -new NotFound({ prettyMessage: 'package not found' }).

-

Convert the examples

-
    -
  1. -

    Convert all the examples to pattern, namedParams, and staticExample. In some cases you can use the pattern inherited from route, though in other cases you may need to specify a pattern in the example. For example, when showing download badges for several periods, you may want to render the example with an explicit dt instead of :which. You will also need to specify a pattern for badges that use a format regex in the route.

    -
    2. -
  2. -

    Open the frontend and check that the static preview badges look good. -Remember, none of them are live.

    -
    3. -
  3. -

    Open up the prepared example URLs in their own tabs, and make sure they work correctly.

    -
    4. -
-

Validation

-

When it's time to add the schema, refer to the Joi API docs: -https://github.com/hapijs/joi/blob/master/API.md

-

Housekeeping

-

Switch to createServiceTester:

-
const t = (module.exports = require('../tester').createServiceTester())
-
-

This may require updating the URLs, which will be relative to the service's base -URL. When using createServiceTester, services need to be specified using -the non-case-sensitive service class name, or a leading substring (e.g. -AppveyorTests or appveyor).

-

Do this last. Since it involves changing test URLs, and you don't want to -accidentally change them.

-
- -
- -
- - - -
- - - - - - - \ No newline at end of file diff --git a/tutorial-self-hosting.html b/tutorial-self-hosting.html index 38d21698d2..87496f3714 100644 --- a/tutorial-self-hosting.html +++ b/tutorial-self-hosting.html @@ -175,13 +175,13 @@ Set public.requireCloudflare: true.


diff --git a/tutorial-server-secrets.html b/tutorial-server-secrets.html index d3d018c856..d64e6f5776 100644 --- a/tutorial-server-secrets.html +++ b/tutorial-server-secrets.html @@ -238,13 +238,13 @@ and create an API key for the YouTube Data API v3.


diff --git a/tutorial-service-tests.html b/tutorial-service-tests.html index 2d83a0ebbe..cc186ed86d 100644 --- a/tutorial-service-tests.html +++ b/tutorial-service-tests.html @@ -240,13 +240,13 @@ comment there instead.