From 3caa24a48087f429f1975edd15a6aa7ef83940ca Mon Sep 17 00:00:00 2001 From: Gregor Martynus Date: Sun, 26 Jan 2020 16:15:19 -0800 Subject: [PATCH] feat: accessing `response.data[namespacekey]` in `.paginate(options, mapFn)` map function now logs a deprecation --- plugins/pagination/index.js | 6 +- plugins/pagination/iterator.js | 34 ----- .../normalize-paginated-list-response.js | 116 ------------------ plugins/pagination/paginate.js | 40 ------ 4 files changed, 2 insertions(+), 194 deletions(-) delete mode 100644 plugins/pagination/iterator.js delete mode 100644 plugins/pagination/normalize-paginated-list-response.js delete mode 100644 plugins/pagination/paginate.js diff --git a/plugins/pagination/index.js b/plugins/pagination/index.js index e7673bc7..f5a3f7bc 100644 --- a/plugins/pagination/index.js +++ b/plugins/pagination/index.js @@ -1,9 +1,7 @@ module.exports = paginatePlugin; -const iterator = require("./iterator"); -const paginate = require("./paginate"); +const { paginateRest } = require("@octokit/plugin-paginate-rest"); function paginatePlugin(octokit) { - octokit.paginate = paginate.bind(null, octokit); - octokit.paginate.iterator = iterator.bind(null, octokit); + Object.assign(octokit, paginateRest(octokit)); } diff --git a/plugins/pagination/iterator.js b/plugins/pagination/iterator.js deleted file mode 100644 index 00ea8ebb..00000000 --- a/plugins/pagination/iterator.js +++ /dev/null @@ -1,34 +0,0 @@ -module.exports = iterator; - -const normalizePaginatedListResponse = require("./normalize-paginated-list-response"); - -function iterator(octokit, options) { - const headers = options.headers; - let url = octokit.request.endpoint(options).url; - - return { - [Symbol.asyncIterator]: () => ({ - next() { - if (!url) { - return Promise.resolve({ done: true }); - } - - return octokit - .request({ url, headers }) - - .then(response => { - normalizePaginatedListResponse(octokit, url, response); - - // `response.headers.link` format: - // '; rel="next", ; rel="last"' - // sets `url` to undefined if "next" URL is not present or `link` header is not set - url = ((response.headers.link || "").match( - /<([^>]+)>;\s*rel="next"/ - ) || [])[1]; - - return { value: response }; - }); - } - }) - }; -} diff --git a/plugins/pagination/normalize-paginated-list-response.js b/plugins/pagination/normalize-paginated-list-response.js deleted file mode 100644 index e664142a..00000000 --- a/plugins/pagination/normalize-paginated-list-response.js +++ /dev/null @@ -1,116 +0,0 @@ -/** - * Some “list” response that can be paginated have a different response structure - * - * They have a `total_count` key in the response (search also has `incomplete_results`, - * /installation/repositories also has `repository_selection`), as well as a key with - * the list of the items which name varies from endpoint to endpoint: - * - * - https://developer.github.com/v3/search/#example (key `items`) - * - https://developer.github.com/v3/checks/runs/#response-3 (key: `check_runs`) - * - https://developer.github.com/v3/checks/suites/#response-1 (key: `check_suites`) - * - https://developer.github.com/v3/apps/installations/#list-repositories (key: `repositories`) - * - https://developer.github.com/v3/apps/installations/#list-installations-for-a-user (key `installations`) - * - https://developer.github.com/v3/orgs/#list-installations-for-an-organization (key `installations`) - * - * Octokit normalizes these responses so that paginated results are always returned following - * the same structure. One challenge is that if the list response has only one page, no Link - * header is provided, so this header alone is not sufficient to check wether a response is - * paginated or not. For the exceptions with the namespace, a fallback check for the route - * paths has to be added in order to normalize the response. We cannot check for the total_count - * property because it also exists in the response of Get the combined status for a specific ref. - */ - -module.exports = normalizePaginatedListResponse; - -const { Deprecation } = require("deprecation"); -const once = require("once"); - -const deprecateIncompleteResults = once((log, deprecation) => - log.warn(deprecation) -); -const deprecateTotalCount = once((log, deprecation) => log.warn(deprecation)); -const deprecateNamespace = once((log, deprecation) => log.warn(deprecation)); - -const REGEX_IS_SEARCH_PATH = /^\/search\//; -const REGEX_IS_CHECKS_PATH = /^\/repos\/[^/]+\/[^/]+\/commits\/[^/]+\/(check-runs|check-suites)/; -const REGEX_IS_INSTALLATION_REPOSITORIES_PATH = /^\/installation\/repositories/; -const REGEX_IS_USER_INSTALLATIONS_PATH = /^\/user\/installations/; -const REGEX_IS_ORG_INSTALLATIONS_PATH = /^\/orgs\/[^/]+\/installations/; - -function normalizePaginatedListResponse(octokit, url, response) { - const path = url.replace(octokit.request.endpoint.DEFAULTS.baseUrl, ""); - if ( - !REGEX_IS_SEARCH_PATH.test(path) && - !REGEX_IS_CHECKS_PATH.test(path) && - !REGEX_IS_INSTALLATION_REPOSITORIES_PATH.test(path) && - !REGEX_IS_USER_INSTALLATIONS_PATH.test(path) && - !REGEX_IS_ORG_INSTALLATIONS_PATH.test(path) - ) { - return; - } - - // keep the additional properties intact to avoid a breaking change, - // but log a deprecation warning when accessed - const incompleteResults = response.data.incomplete_results; - const repositorySelection = response.data.repository_selection; - const totalCount = response.data.total_count; - delete response.data.incomplete_results; - delete response.data.repository_selection; - delete response.data.total_count; - - const namespaceKey = Object.keys(response.data)[0]; - - response.data = response.data[namespaceKey]; - - Object.defineProperty(response.data, namespaceKey, { - get() { - deprecateNamespace( - octokit.log, - new Deprecation( - `[@octokit/rest] "result.data.${namespaceKey}" is deprecated. Use "result.data" instead` - ) - ); - return response.data; - } - }); - - if (typeof incompleteResults !== "undefined") { - Object.defineProperty(response.data, "incomplete_results", { - get() { - deprecateIncompleteResults( - octokit.log, - new Deprecation( - '[@octokit/rest] "result.data.incomplete_results" is deprecated.' - ) - ); - return incompleteResults; - } - }); - } - - if (typeof repositorySelection !== "undefined") { - Object.defineProperty(response.data, "repository_selection", { - get() { - deprecateTotalCount( - octokit.log, - new Deprecation( - '[@octokit/rest] "result.data.repository_selection" is deprecated.' - ) - ); - return repositorySelection; - } - }); - } - - Object.defineProperty(response.data, "total_count", { - get() { - deprecateTotalCount( - octokit.log, - new Deprecation( - '[@octokit/rest] "result.data.total_count" is deprecated.' - ) - ); - return totalCount; - } - }); -} diff --git a/plugins/pagination/paginate.js b/plugins/pagination/paginate.js deleted file mode 100644 index db4752b4..00000000 --- a/plugins/pagination/paginate.js +++ /dev/null @@ -1,40 +0,0 @@ -module.exports = paginate; - -const iterator = require("./iterator"); - -function paginate(octokit, route, options, mapFn) { - if (typeof options === "function") { - mapFn = options; - options = undefined; - } - options = octokit.request.endpoint.merge(route, options); - return gather( - octokit, - [], - iterator(octokit, options)[Symbol.asyncIterator](), - mapFn - ); -} - -function gather(octokit, results, iterator, mapFn) { - return iterator.next().then(result => { - if (result.done) { - return results; - } - - let earlyExit = false; - function done() { - earlyExit = true; - } - - results = results.concat( - mapFn ? mapFn(result.value, done) : result.value.data - ); - - if (earlyExit) { - return results; - } - - return gather(octokit, results, iterator, mapFn); - }); -}