(#6157) - move debug() to separate module Fixes #6157
diff --git a/docs/_includes/api/debug_mode.html b/docs/_includes/api/debug_mode.html index ef6c380..c246c89 100644 --- a/docs/_includes/api/debug_mode.html +++ b/docs/_includes/api/debug_mode.html
@@ -2,6 +2,15 @@ PouchDB uses the [debug](https://www.npmjs.org/package/debug) module for fine-grained debug output. + +{% include alert/start.html variant="warning"%} +{% markdown %} + +This `debug()` API is currently part of PouchDB core. However, in PouchDB v7.0.0 it will be moved to a separate plugin. + +{% endmarkdown %} +{% include alert/end.html%} + To enable debug mode, just call: {% highlight js %}
diff --git a/packages/node_modules/pouchdb-adapter-http/src/index.js b/packages/node_modules/pouchdb-adapter-http/src/index.js index 4a86ce0..cd73cef 100644 --- a/packages/node_modules/pouchdb-adapter-http/src/index.js +++ b/packages/node_modules/pouchdb-adapter-http/src/index.js
@@ -29,9 +29,6 @@ import pool from './promise-pool'; import { createError, BAD_ARG } from 'pouchdb-errors'; -import debug from 'debug'; - -var log = debug('pouchdb:http'); function readAttachmentsAsBlobOrBuffer(row) { var atts = row.doc && row.doc._attachments; @@ -172,7 +169,10 @@ var defaultHeaders = clone(ajaxOpts.headers || {}); reqOpts.headers = assign(defaultHeaders, reqAjax.headers, options.headers || {}); - log(reqOpts.method + ' ' + reqOpts.url); + /* istanbul ignore if */ + if (api.constructor.listeners('debug').length) { + api.constructor.emit('debug', ['http', reqOpts.method, reqOpts.url]); + } return api._ajax(reqOpts, callback); }
diff --git a/packages/node_modules/pouchdb-core/src/constructor.js b/packages/node_modules/pouchdb-core/src/constructor.js index 8c0bda6..2f463ea 100644 --- a/packages/node_modules/pouchdb-core/src/constructor.js +++ b/packages/node_modules/pouchdb-core/src/constructor.js
@@ -1,4 +1,3 @@ -import debug from 'debug'; import inherits from 'inherits'; import Adapter from './adapter'; import TaskQueue from './taskqueue'; @@ -79,7 +78,7 @@ self.name = name; self._adapter = opts.adapter; - debug('pouchdb:adapter')('Picked adapter: ' + opts.adapter); + PouchDB.emit('debug', ['adapter', 'Picked adapter: ', opts.adapter]); if (!PouchDB.adapters[opts.adapter] || !PouchDB.adapters[opts.adapter].valid()) { @@ -104,6 +103,4 @@ } -PouchDB.debug = debug; - export default PouchDB;
diff --git a/packages/node_modules/pouchdb-core/src/index.js b/packages/node_modules/pouchdb-core/src/index.js index fbeebac..080cc0e 100644 --- a/packages/node_modules/pouchdb-core/src/index.js +++ b/packages/node_modules/pouchdb-core/src/index.js
@@ -1,5 +1,9 @@ import PouchDB from './setup'; import version from './version'; +import pouchDebug from 'pouchdb-debug'; + +// TODO: remove from pouchdb-core (breaking) +PouchDB.plugin(pouchDebug); PouchDB.version = version;
diff --git a/packages/node_modules/pouchdb-debug/LICENSE b/packages/node_modules/pouchdb-debug/LICENSE new file mode 100644 index 0000000..f6cd2bc --- /dev/null +++ b/packages/node_modules/pouchdb-debug/LICENSE
@@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License.
diff --git a/packages/node_modules/pouchdb-debug/README.md b/packages/node_modules/pouchdb-debug/README.md new file mode 100644 index 0000000..60acc15 --- /dev/null +++ b/packages/node_modules/pouchdb-debug/README.md
@@ -0,0 +1,58 @@ +pouchdb-debug +====== + +`PouchDB.debug()` API as a standalone module. Provides direct access to [debug](https://github.com/visionmedia/debug) which can be used for debugging PouchDB's internal operations. + +**_This module is currently part of PouchDB core; you don't need to do anything to use it. However, in PouchDB v7.0.0 the `debug()` API will be moved to a separate plugin._** + +### Usage + +```bash +npm install pouchdb-debug +``` + +Then attach it to `PouchDB`: + +```js +var pouchdbDebug = require('pouchdb-debug'); +PouchDB.plugin(pouchdbDebug); +``` + +To enable debug mode, just call: + +```js +PouchDB.debug.enable('*'); +``` + +Then look in your browser console. + +In Node.js, you can also set a command-line flag: + +```js +DEBUG=pouchdb:* node myscript.js +``` + +You can also enable debugging of specific modules. Currently we only have `pouchb:api` (API-level calls) and `pouchdb:http` (HTTP requests): + +```js +PouchDB.debug.enable('pouchdb:api'); // or +PouchDB.debug.enable('pouchdb:http'); +``` + +These settings are saved to the browser's LocalStorage. So to disable them, you must call: + +```js +PouchDB.debug.disable(); +``` + +Your users won't see debug output unless you explicitly call `PouchDB.debug.enable()` within your application code. + +For full API documentation and guides on PouchDB, see [PouchDB.com](http://pouchdb.com/). For details on PouchDB sub-packages, see the [Custom Builds documentation](http://pouchdb.com/custom.html). + +### Source + +PouchDB and its sub-packages are distributed as a [monorepo](https://github.com/babel/babel/blob/master/doc/design/monorepo.md). + +For a full list of packages, see [the GitHub source](https://github.com/pouchdb/pouchdb/tree/master/packages). + +
diff --git a/packages/node_modules/pouchdb-debug/package.json b/packages/node_modules/pouchdb-debug/package.json new file mode 100644 index 0000000..dced724 --- /dev/null +++ b/packages/node_modules/pouchdb-debug/package.json
@@ -0,0 +1,18 @@ +{ + "name": "pouchdb-debug", + "version": "6.2.0-prerelease", + "description": "PouchDB.debug() API to debug PouchDB operations", + "main": "./lib/index.js", + "keywords": [], + "author": "Dale Harvey <dale@arandomurl.com>", + "license": "Apache-2.0", + "repository": "https://github.com/pouchdb/pouchdb", + "jsnext:main": "./src/index.js", + "files": [ + "lib", + "src" + ], + "browser": { + "./lib/index.js": "./lib/index-browser.js" + } +}
diff --git a/packages/node_modules/pouchdb-debug/src/index.js b/packages/node_modules/pouchdb-debug/src/index.js new file mode 100644 index 0000000..fcfc494 --- /dev/null +++ b/packages/node_modules/pouchdb-debug/src/index.js
@@ -0,0 +1,22 @@ +import debug from 'debug'; + +function debugPouch(PouchDB) { + PouchDB.debug = debug; + var logs = {}; + /* istanbul ignore next */ + PouchDB.on('debug', function (args) { + // first argument is log identifier + var logId = args[0]; + // rest should be passed verbatim to debug module + var logArgs = args.slice(1); + if (!logs[logId]) { + logs[logId] = debug('pouchdb:' + logId); + } + logs[logId].apply(null, logArgs); + }); +} + +// TODO: add a window.PouchDB.plugin() call for the benefit of <script> users before we +// release this as a separate plugin in PouchDB 7.0.0. + +export default debugPouch; \ No newline at end of file
diff --git a/packages/node_modules/pouchdb-utils/src/adapterFun.js b/packages/node_modules/pouchdb-utils/src/adapterFun.js index 03fb867..184d410 100644 --- a/packages/node_modules/pouchdb-utils/src/adapterFun.js +++ b/packages/node_modules/pouchdb-utils/src/adapterFun.js
@@ -1,32 +1,30 @@ import Promise from 'pouchdb-promise'; import toPromise from './toPromise'; import getArguments from 'argsarray'; -import debug from 'debug'; -var log = debug('pouchdb:api'); + +function logApiCall(self, name, args) { + /* istanbul ignore if */ + if (self.constructor.listeners('debug').length) { + var logArgs = ['api', self.name, name]; + for (var i = 0; i < args.length - 1; i++) { + logArgs.push(args[i]); + } + self.constructor.emit('debug', logArgs); + + // override the callback itself to log the response + var origCallback = args[args.length - 1]; + args[args.length - 1] = function (err, res) { + var responseArgs = ['api', self.name, name]; + responseArgs = responseArgs.concat( + err ? ['error', err] : ['success', res] + ); + self.constructor.emit('debug', responseArgs); + origCallback(err, res); + }; + } +} function adapterFun(name, callback) { - function logApiCall(self, name, args) { - /* istanbul ignore if */ - if (log.enabled) { - var logArgs = [self.name, name]; - for (var i = 0; i < args.length - 1; i++) { - logArgs.push(args[i]); - } - log.apply(null, logArgs); - - // override the callback itself to log the response - var origCallback = args[args.length - 1]; - args[args.length - 1] = function (err, res) { - var responseArgs = [self.name, name]; - responseArgs = responseArgs.concat( - err ? ['error', err] : ['success', res] - ); - log.apply(null, responseArgs); - origCallback(err, res); - }; - } - } - return toPromise(getArguments(function (args) { if (this._closed) { return Promise.reject(new Error('database is closed'));