Skip to content

Fix JavaScript exception construction implementation (ES6)#3372

Open
antlafarge wants to merge 1 commit intoapache:masterfrom
antlafarge:master
Open

Fix JavaScript exception construction implementation (ES6)#3372
antlafarge wants to merge 1 commit intoapache:masterfrom
antlafarge:master

Conversation

@antlafarge
Copy link
Copy Markdown

@antlafarge antlafarge commented Mar 31, 2026

There is a bug in the JavaScript custom exception constructor implementation.
This thrift custom exception :

exception CustomError {
  1: required ErrorCode code;
}

results to a constructor which takes a single JS Object with custom properties :

const CustomError = module.exports.CustomError = class extends Thrift.TException {
  constructor(args) {
    super(args);
    this.name = "CustomError";
    this.code = null;
    // ...

We can check it in the associated TypeScript typings :

declare class ZaapError extends Thrift.TException {
    public code: ErrorCode;

      constructor(args?: { code: ErrorCode; });
  }

The generated code gives the JS object to the constructor of Thrift.TException.
But the Thrift.TException construction takes a single string argument :

exports.TException = TException;

function TException(message) {
  Error.call(this);
  Error.captureStackTrace(this, this.constructor);
  this.name = this.constructor.name;
  this.message = message;
};
util.inherits(TException, Error);

Giving this custom object to the TException (instead of a string) throws unwanted Thrift exceptions in TBinaryProtocol.prototype.writeStringOrBinary :

Exception has occurred: Error: writeString called without a string/Buffer argument: [object Object]
Thrift-bug

The fix is to give the name of the custom exception to the constructor of the inherited Thrift exception class (TException).

  • Did you create an Apache Jira ticket? (Request account here, not required for trivial changes)
  • If a ticket exists: Does your pull request title follow the pattern "THRIFT-NNNN: describe my issue"?
  • Did you squash your changes to a single commit? (not required, but preferred)
  • Did you do your best to avoid breaking changes? If one was needed, did you label the Jira ticket with "Breaking-Change"?
  • If your change does not involve any code, include [skip ci] anywhere in the commit message to free up build resources.

@mergeable mergeable bot added the compiler label Mar 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants