move constants to enums

Author: Tony Crisci

index.js

@@ -41,162 +41,6 @@ module.exports.sessionBus = function(opts) {
   return createClient(opts);
 };
 
-/**
- * A flag for {@link MessageBus#requestName} to indicate this name allows other
- * clients to replace it as the name owner on request.
- *
- * @see {@link https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-request-name}
- * @constant DBUS_NAME_FLAG_ALLOW_REPLACEMENT
- */
-module.exports.DBUS_NAME_FLAG_ALLOW_REPLACEMENT = constants.DBUS_NAME_FLAG_ALLOW_REPLACEMENT;
-
-/**
- * A flag for {@link MessageBus#requestName} to indicate this request should
- * replace an existing name if that name allows replacement.
- *
- * @see {@link https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-request-name}
- * @constant DBUS_NAME_FLAG_REPLACE_EXISTING
- */
-module.exports.DBUS_NAME_FLAG_REPLACE_EXISTING = constants.DBUS_NAME_FLAG_REPLACE_EXISTING;
-
-/**
- * A flag for {@link MessageBus#requestName} to indicate this request should
- * not enter the queue of clients requesting this name if it is taken.
- *
- * @see {@link https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-request-name}
- * @constant DBUS_NAME_FLAG_DO_NOT_QUEUE
- */
-module.exports.DBUS_NAME_FLAG_DO_NOT_QUEUE = constants.DBUS_NAME_FLAG_DO_NOT_QUEUE;
-
-/**
- * An enum for the return value of {@link MessageBus#requestName} to indicate
- * the caller is now the primary owner of the name, replacing any previous
- * owner.
- *
- * @see {@link https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-request-name}
- * @constant DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER
- */
-module.exports.DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER = constants.DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER;
-
-/**
- * An enum for the return value of {@link MessageBus#requestName} to indicate
- * the name already had an owner, `DBUS_NAME_FLAG_DO_NOT_QUEUE` was not
- * specified, and either the current owner did not specify
- * `DBUS_NAME_FLAG_ALLOW_REPLACEMENT` or the requesting application did not
- * specify `DBUS_NAME_FLAG_REPLACE_EXISTING`.
- *
- * @see {@link https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-request-name}
- * @constant DBUS_REQUEST_NAME_REPLY_IN_QUEUE
- */
-module.exports.DBUS_REQUEST_NAME_REPLY_IN_QUEUE = constants.DBUS_REQUEST_NAME_REPLY_IN_QUEUE;
-
-/**
- * An enum for the return value of {@link MessageBus#requestName} to indicate
- * the name already has an owner, `DBUS_NAME_FLAG_DO_NOT_QUEUE` was specified,
- * and either `DBUS_NAME_FLAG_ALLOW_REPLACEMENT` was not specified by the
- * current owner, or `DBUS_NAME_FLAG_REPLACE_EXISTING` was not specified by the
- * requesting application.
- *
- * @see {@link https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-request-name}
- * @constant DBUS_REQUEST_NAME_REPLY_EXISTS
- */
-module.exports.DBUS_REQUEST_NAME_REPLY_EXISTS = constants.DBUS_REQUEST_NAME_REPLY_EXISTS;
-
-/**
- * An enum for the return value of {@link MessageBus#requestName} to indicate
- * the application trying to request ownership of a name is already the owner
- * of it.
- *
- * @see {@link https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-request-name}
- * @constant DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER
- */
-module.exports.DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER = constants.DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER;
-
-/**
- * An enumn for the return value of {@link MessageBus#releaseName} to indicate
- * the caller has released his claim on the given name. Either the caller was
- * the primary owner of the name, and the name is now unused or taken by
- * somebody waiting in the queue for the name, or the caller was waiting in the
- * queue for the name and has now been removed from the queue.
- *
- * @see {@link https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-release-name}
- * @constant DBUS_RELEASE_NAME_REPLY_RELEASED
- */
-module.exports.DBUS_RELEASE_NAME_REPLY_RELEASED = constants.DBUS_RELEASE_NAME_REPLY_RELEASED;
-
-/**
- * An enumn for the return value of {@link MessageBus#releaseName} to indicate
- * the given name does not exist on this bus.
- *
- * @see {@link https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-release-name}
- * @constant DBUS_RELEASE_NAME_REPLY_NON_EXISTENT
- */
-module.exports.DBUS_RELEASE_NAME_REPLY_NON_EXISTENT = constants.DBUS_RELEASE_NAME_REPLY_NON_EXISTENT;
-
-/**
- * An enumn for the return value of {@link MessageBus#releaseName} to indicate
- * the caller was not the primary owner of this name, and was also not waiting
- * in the queue to own this name.
- *
- * @see {@link https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-release-name}
- * @constant DBUS_RELEASE_NAME_REPLY_NOT_OWNER
- */
-module.exports.DBUS_RELEASE_NAME_REPLY_NOT_OWNER = constants.DBUS_RELEASE_NAME_REPLY_NOT_OWNER;
-
-/**
- * An enum value for the {@link Message} `type` member to indicate the message
- * is a method call.
- *
- * @see https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol
- * @constant MESSAGE_TYPE_METHOD_CALL
- */
-module.exports.MESSAGE_TYPE_METHOD_CALL = constants.messageType.METHOD_CALL;
-
-/**
- * An enum value for the {@link Message} `type` member to indicate the message
- * is a method return.
- *
- * @see https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol
- * @constant MESSAGE_TYPE_METHOD_RETURN
- */
-module.exports.MESSAGE_TYPE_METHOD_RETURN = constants.messageType.METHOD_RETURN;
-
-/**
- * An enum value for the {@link Message} `type` member to indicate the message
- * is a signal.
- *
- * @see https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol
- * @constant MESSAGE_TYPE_SIGNAL
- */
-module.exports.MESSAGE_TYPE_SIGNAL = constants.messageType.SIGNAL;
-
-/**
- * An enum value for the {@link Message} `type` member to indicate the message
- * is an error reply.
- *
- * @see https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol
- * @constant MESSAGE_TYPE_ERROR
- */
-module.exports.MESSAGE_TYPE_ERROR = constants.messageType.ERROR;
-
-/**
- * A flag for the {@link Message} `flags` member to indicate no reply is
- * expected from this message.
- *
- * @see https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol
- * @constant MESSAGE_FLAG_NO_REPLY_EXPECTED
- */
-module.exports.MESSAGE_FLAG_NO_REPLY_EXPECTED = constants.flags.noReplyExpected;
-
-/**
- * A flag for the {@link Message} `flags` member to indicate this message
- * should not autostart a service.
- *
- * @see https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol
- * @constant MESSAGE_FLAG_NO_AUTO_START
- */
-module.exports.MESSAGE_FLAG_NO_AUTO_START = constants.flags.noAutoStart;
-
 /**
  * Use JSBI as a polyfill for long integer types ('x' and 't') in the client
  * and the service. This is required for Node verisons that do not support the
@@ -208,6 +52,12 @@ module.exports.MESSAGE_FLAG_NO_AUTO_START = constants.flags.noAutoStart;
  */
 module.exports.setBigIntCompat = require('./lib/library-options').setBigIntCompat
 
+module.exports.NameFlag = constants.NameFlag;
+module.exports.RequestNameReply = constants.RequestNameReply;
+module.exports.ReleaseNameReply = constants.ReleaseNameReply;
+module.exports.MessageType = constants.MessageType;
+module.exports.MessageFlag = constants.MessageFlag;
+
 module.exports.interface = iface;
 module.exports.Variant = Variant;
 module.exports.Message = Message;

lib/bus.js

@@ -6,14 +6,25 @@ const {Message} = require('./message-type');
 const ServiceObject = require('./service/object');
 const xml2js = require('xml2js');
 
-let {
+const {
+  METHOD_CALL,
+  METHOD_RETURN,
+  ERROR,
+  SIGNAL,
+} = constants.MessageType;
+
+const {
+  NO_REPLY_EXPECTED
+} = constants.MessageFlag;
+
+const {
   assertBusNameValid,
   assertObjectPathValid,
   assertInterfaceNameValid,
 } = require('./validators');
 
-let ProxyObject = require('./client/proxy-object');
-let { Interface } = require('./service/interface');
+const ProxyObject = require('./client/proxy-object');
+const { Interface } = require('./service/interface');
 
 const xmlHeader = `<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">\n`
 
@@ -67,14 +78,14 @@ class MessageBus extends EventEmitter {
     this.name = null;
 
     let handleMessage = (msg) => {
-      if (msg.type === constants.messageType.METHOD_RETURN ||
-        msg.type === constants.messageType.ERROR) {
+      if (msg.type === METHOD_RETURN ||
+        msg.type === ERROR) {
         let handler = this._methodReturnHandlers[msg.replySerial];
         if (handler) {
           delete this._methodReturnHandlers[msg.replySerial];
           handler(msg);
         }
-      } else if (msg.type === constants.messageType.SIGNAL) {
+      } else if (msg.type === SIGNAL) {
         // if this is a name owner changed message, cache the new name owner
         let {sender, path, iface, member} = msg;
         if (sender === 'org.freedesktop.DBus' &&
@@ -171,8 +182,8 @@ class MessageBus extends EventEmitter {
    * @see {@link https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-request-name}
    *
    * @param name {string} - the well-known name on the bus to request.
-   * @param flags {NameFlags} - DBus name flags which affect the behavior of taking the name.
-   * @returns {Promise} - a Promise that resolves with the `RequestNameReply`.
+   * @param flags {NameFlag} - DBus name flags which affect the behavior of taking the name.
+   * @returns {Promise} - a Promise that resolves with the {@link RequestNameReply}.
    */
   requestName(name, flags) {
     flags = flags || 0;
@@ -200,7 +211,7 @@ class MessageBus extends EventEmitter {
    * Release this name. Requests that the name should no longer be owned by the
    * {@link MessageBus}.
    *
-   * @returns {Promise} A Promise that will resolve with the `ReleaseNameReply`.
+   * @returns {Promise} A Promise that will resolve with the {@link ReleaseNameReply}.
    */
   releaseName(name) {
     return new Promise((resolve, reject) => {
@@ -241,8 +252,7 @@ class MessageBus extends EventEmitter {
   }
 
   /**
-   * A function to call when a message of type {@link
-   * MESSAGE_TYPE_METHOD_RETURN} is received. User handlers are run before
+   * A function to call when a message of type {@link MessageType.METHOD_RETURN} is received. User handlers are run before
    * default handlers.
    *
    * @callback methodHandler
@@ -256,7 +266,7 @@ class MessageBus extends EventEmitter {
    * MessageBus#removeMethodHandler}
    *
    * @param {methodHandler} - A function to handle a {@link Message} of type
-   * {@link MESSAGE_TYPE_METHOD_RETURN}. Takes the `Message` as the first
+   * {@link MessageType.METHOD_RETURN}. Takes the `Message` as the first
     * argument. Return `true` if the method is handled and no further handlers
     * will run.
    */
@@ -268,7 +278,7 @@ class MessageBus extends EventEmitter {
    * Remove a user method return handler that was previously added with {@link
    * MessageBus#addMethodHandler}.
    *
-   * @param {methodHandler} - A function that was previously added as a method handler with {@link 
+   * @param {methodHandler} - A function that was previously added as a method handler.
    */
   removeMethodHandler(fn) {
     for (let i = 0; i < this._methodHandlers.length; ++i) {
@@ -279,7 +289,7 @@ class MessageBus extends EventEmitter {
   }
 
   /**
-   * Send a {@link Message} of type {@link MESSAGE_TYPE_METHOD_CALL} to the bus
+   * Send a {@link Message} of type {@link MessageType.METHOD_CALL} to the bus
    * and wait for the reply.
    *
    * @example
@@ -291,28 +301,28 @@ class MessageBus extends EventEmitter {
    * });
    * let reply = await bus.call(message);
    *
-   * @param {Message} msg - The message to send. Must be a METHOD_CALL.
-   * @returns {Promise} reply - A `Promise` that resolves to the `Message`
-   * which is a reply to the call.
+   * @param {Message} msg - The message to send.
+   * @returns {Promise} reply - A `Promise` that resolves to the {@link
+   * Message} which is a reply to the call.
    */
   call(msg) {
     return new Promise((resolve, reject) => {
       if (!(msg instanceof Message)) {
         throw new Error('The call() method takes a Message class as the first argument.');
       }
-      if (msg.type !== constants.messageType.METHOD_CALL) {
+      if (msg.type !== METHOD_CALL) {
         throw new Error('Only messages of type METHOD_CALL can expect a call reply.');
       }
       if (msg.serial === null || msg._sent) {
         msg.serial = this.newSerial();
       }
       msg._sent = true;
-      if (msg.flags & constants.flags.noReplyExpected) {
+      if (msg.flags & NO_REPLY_EXPECTED) {
         resolve(null);
       } else {
         this._methodReturnHandlers[msg.serial] = (reply) => {
           this._nameOwners[msg.destination] = reply.sender;
-          if (reply.type === constants.messageType.ERROR) {
+          if (reply.type === ERROR) {
             return reject(new DBusError(reply.errorName, reply.body[0], reply));
           } else {
             return resolve(reply);