Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Async API changes may break plugins

See original GitHub issue

Most of the exported functions from the Etherpad internals will no longer take callback parameters in Etherpad 1.8+ (see #3540) and return Promises instead. This may break plugins that rely on those functions.

If backwards compatibility is required one solution may be to use the nodeify module to conditionally wrap the invocations of those exported functions.

Issue Analytics

State:
Created 5 years ago
Comments:15 (14 by maintainers)

Top GitHub Comments

2reactions

raybelliscommented, Feb 28, 2019

We should probably add some sort of Etherpad API versioning to the internal modules (collectively, not per module) so that the /admin page can indicate which plugins are compatible.

0reactions

muxatorcommented, Apr 21, 2020

We can close this issue, now that the first point release (1.8.3) after the async rewrite (1.8.0) is ready to be released, and the few actively maintained plugins have been adapted.

Thanks.

Top Results From Across the Web

Overview | AsyncAPI Initiative for event-driven APIs

Diff is a library that compares two AsyncAPI documents and provides information about the differences by pointing out explicitly information like breaking ......

Async afterEach hook breaks ready and doneEach hooks #449

Async afterEach hooks such as: $docsify.plugins = [].concat(install, $docsify.plugins) ... But even if we make doneEach async, that might break something.

CoffeeScript

The structure and properties of CoffeeScript's AST are not final and may undergo breaking changes between CoffeeScript versions; please open an issue if...

Create and use Custom APIs (Microsoft Dataverse)

A Custom API may include logic implemented with a plug-in. ... Such changes could break code written for the original definition of the ......

Node.js v19.3.0 Documentation

new AsyncLocalStorage([options]); asyncLocalStorage.disable(); asyncLocalStorage. ... Bugs or behavior changes may surprise users when Experimental API ...