Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use own implementation of defer #188

Merged
merged 2 commits into from
Aug 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/188.bugfix
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix bluebird defer warnings by using our own defer implementation.
4 changes: 3 additions & 1 deletion spec/integ/bridge.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ var RemoteRoom = require("../..").RemoteRoom;
var AppServiceRegistration = require("matrix-appservice").AppServiceRegistration;
var Bridge = require("../..").Bridge;

const deferPromise = require("../../lib/utils/promiseutil").defer;

describe("Bridge", function() {
var bridge, bridgeCtrl, appService, clientFactory, appServiceRegistration;
var roomStore, userStore, clients;
Expand Down Expand Up @@ -80,7 +82,7 @@ describe("Bridge", function() {
});

function loadDatabase(path, Cls) {
var defer = Promise.defer();
const defer = deferPromise();
var db = new Datastore({
filename: path,
autoload: true,
Expand Down
3 changes: 2 additions & 1 deletion src/bridge.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ const RoomUpgradeHandler = require("./components/room-upgrade-handler");
const EventNotHandledError = require("./errors").EventNotHandledError;
const InternalError = require("./errors").InternalError;
const EventQueue = require("./components/event-queue").EventQueue;
const defer = require("./utils/promiseutil").defer;

const log = require("./components/logging").get("bridge");

Expand Down Expand Up @@ -1009,7 +1010,7 @@ Bridge.prototype.requestCheckToken = function(req) {
}

function loadDatabase(path, Cls) {
var defer = Promise.defer();
const defer = defer();
var db = new Datastore({
filename: path,
autoload: true,
Expand Down
13 changes: 7 additions & 6 deletions src/components/bridge-store.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ limitations under the License.
*/

const Promise = require("bluebird");
const deferPromise = require("../utils/promiseutil").defer;

// wrapper to use promises
var callbackFn = function(d, err, result) {
Expand Down Expand Up @@ -42,7 +43,7 @@ function BridgeStore(db) {
* @return {Promise}
*/
BridgeStore.prototype.insert = function(objects, defer) {
defer = defer || new Promise.defer();
defer = defer || deferPromise();
this.db.insert(objects, function(err, result) {
callbackFn(defer, err, result);
});
Expand All @@ -57,7 +58,7 @@ BridgeStore.prototype.insert = function(objects, defer) {
* @return {Promise}
*/
BridgeStore.prototype.upsert = function(query, updateVals, defer) {
defer = defer || new Promise.defer();
defer = defer || deferPromise();
this.db.update(query, updateVals, {upsert: true}, function(err, result) {
callbackFn(defer, err, result);
});
Expand Down Expand Up @@ -89,7 +90,7 @@ BridgeStore.prototype.insertIfNotExists = function(query, insertObj) {
* @return {Promise}
*/
BridgeStore.prototype.update = function(query, updateVals, defer) {
defer = defer || new Promise.defer();
defer = defer || deferPromise();
this.db.update(query, updateVals, {upsert: false}, function(err, result) {
callbackFn(defer, err, result);
});
Expand All @@ -103,7 +104,7 @@ BridgeStore.prototype.update = function(query, updateVals, defer) {
* @return {Promise}
*/
BridgeStore.prototype.delete = function(query, defer) {
defer = defer || new Promise.defer();
defer = defer || deferPromise();
this.db.remove(query, {multi: true}, function(err, result) {
callbackFn(defer, err, result);
});
Expand All @@ -118,7 +119,7 @@ BridgeStore.prototype.delete = function(query, defer) {
* @return {Promise}
*/
BridgeStore.prototype.selectOne = function(query, transformFn, defer) {
defer = defer || new Promise.defer();
defer = defer || deferPromise();
this.db.findOne(query, function(err, doc) {
callbackFn(defer, err, transformFn ? transformFn(doc) : doc);
});
Expand All @@ -133,7 +134,7 @@ BridgeStore.prototype.selectOne = function(query, transformFn, defer) {
* @return {Promise}
*/
BridgeStore.prototype.select = function(query, transformFn, defer) {
defer = defer || new Promise.defer();
defer = defer || deferPromise();
this.db.find(query, function(err, docs) {
callbackFn(defer, err, transformFn ? transformFn(docs) : docs);
});
Expand Down
3 changes: 2 additions & 1 deletion src/components/intent.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ const MatrixUser = require("../models/users/matrix");
const MatrixEvent = require("matrix-js-sdk").MatrixEvent;
const RoomMember = require("matrix-js-sdk").RoomMember;
const ClientRequestCache = require("./client-request-cache");
const defer = require("../utils/promiseutil").defer;

const STATE_EVENT_TYPES = [
"m.room.name", "m.room.topic", "m.room.power_levels", "m.room.member",
Expand Down Expand Up @@ -695,7 +696,7 @@ Intent.prototype._ensureJoined = async function(
FAIL (bot can't get into the room)
*/

const deferredPromise = new Promise.defer();
const deferredPromise = new defer();

const mark = (r, state) => {
this.opts.backingStore.setMembership(r, userId, state);
Expand Down
4 changes: 2 additions & 2 deletions src/components/request.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/

var Promise = require("bluebird");
const defer = require("../utils/promiseutil").defer;

function generateRequestId() {
return (Math.random() * 1e20).toString(36);
Expand All @@ -32,7 +32,7 @@ function Request(opts) {
this.id = opts.id || generateRequestId();
this.data = opts.data;
this.startTs = Date.now();
this.defer = new Promise.defer();
this.defer = new defer();
}

/**
Expand Down
37 changes: 37 additions & 0 deletions src/utils/promiseutil.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/*
Copyright 2019 The Matrix.org Foundation C.I.C.

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.
*/

import Bluebird from "bluebird";

export interface Defer<T> {
resolve: (value?: T) => void;
reject: (err?: unknown) => void;
promise: Bluebird<T>;
}

export function defer<T>(): Defer<T> {
let resolve!: (value?: T) => void;
let reject!: (err?: unknown) => void;
const promise = new Bluebird((res, rej) => {
resolve = res;
reject = rej
});
return {
resolve: resolve,
reject: reject,
promise: promise as Bluebird<T>
};
}