[JavaScript (with promises)] Bug following $ref in object properties #4973

advance512 · 2017-03-08T01:39:08Z

Description

Generated type file ID contains the following:

  /**
   * Constructs a <code>ID</code> from a plain JavaScript object, optionally creating a new instance.
   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
   * @param {Object} data The plain JavaScript object bearing properties of interest.
   * @param {module:model/ID} obj Optional instance to populate.
   * @return {module:model/ID} The populated <code>ID</code> instance.
   */
  exports.constructFromObject = function(data, obj) {
    if (data) {
      obj = obj || new exports();

    }
    return obj;
  }

data is an integer input. obj is null. Hence, the result is exports() instead of simply data.

Swagger-codegen version

Build package: io.swagger.codegen.languages.JavascriptClientCodegen
v2.2.2

Swagger declaration file content or url

definitions:

  # ===============================================================================
  # Fragments
  # ===============================================================================

  ID:
    description: An entity identifer
    type: integer
    format: int64
    readOnly: true

  # ===========================================================================
  # Users
  # ===========================================================================

  User:
    type: object
    required:
      - emailAddress
    properties:
      id:
        $ref: '#/definitions/ID'
      emailAddress:
        type: string
        format: email
        minLength: 6
        maxLength: 254

Command line used for generation

java -jar swagger-codegen-cli.jar generate -i ../source.yaml -l javascript --additional-properties usePromises=true -o ./javascript/

Steps to reproduce

Use the above definitions in any operation. You'll get a result object with an exports() objects instead of an ID integer.

Related issues

Suggest a Fix

It tempts me to say:

  /**
   * Constructs a <code>ID</code> from a plain JavaScript object, optionally creating a new instance.
   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
   * @param {Object} data The plain JavaScript object bearing properties of interest.
   * @param {module:model/ID} obj Optional instance to populate.
   * @return {module:model/ID} The populated <code>ID</code> instance.
   */
  exports.constructFromObject = function(data, obj) {
    if (data) {
      obj = **data** || new exports();

    }
    return obj;
  }

but I actually think the issue is that swagger-codegen doesn't follow the $ref properly. Not certain

The text was updated successfully, but these errors were encountered:

wing328 · 2017-03-08T09:19:57Z

@advance512 instead of defining id using $ref, what about defining id as integer inline instead?

advance512 · 2017-03-08T16:19:36Z

I wanted to be able to modify the ID type easily, to set it as either a UUID or an Integer in one place for different use-cases.
Also, I liked having it as a different "type" with alternative naming. A bit like a C typedef.

I side stepped the issue for now, but it is definitely not working as expected: the OpenAPI spec says this is valid syntax.

wing328 · 2017-03-08T18:06:56Z

Yup, I think it's a bug with the Swagger Parser. Please report the issue to github.com/swagger-api/swagger-parser.

For the time being, please define id as integer as a workaround.

fehguy · 2017-03-10T07:03:14Z

Eh, I'm committing a test in swagger-parser, but I think it's behaving correctly. Copying the definition right out of here and putting it in this test:

https://github.com/swagger-api/swagger-parser/blob/361d5e834e9dd45d657835ee89d4ef972eaf852b/modules/swagger-parser/src/test/java/io/swagger/parser/RelativeReferenceTest.java#L68

The response is exactly what I'd expect:

{
  "swagger" : "2.0",
  "info" : {
    "description" : "It works.",
    "version" : "1.0.0",
    "title" : "My API"
  },
  "basePath" : "/",
  "schemes" : [ "https" ],
  "produces" : [ "application/json" ],
  "definitions" : {
    "ID" : {
      "type" : "integer",
      "format" : "int64",
      "description" : "An entity identifer"
    },
    "User" : {
      "type" : "object",
      "required" : [ "emailAddress" ],
      "properties" : {
        "id" : {
          "$ref" : "#/definitions/ID"
        },
        "emailAddress" : {
          "type" : "string",
          "format" : "email",
          "minLength" : 6,
          "maxLength" : 254
        }
      }
    }
  }
}

What am I missing?

advance512 · 2017-03-10T12:13:15Z

Thanks a lot for the super quick response, @fehguy.

The output is indeed a valid Swagger schema (formatted as JSON). It includes the $ref external definition that was defined in the source YAML, properly.

Since I'm not familiar with how swagger-codegen constructs its output clients nor how it uses swagger-parser, I'm not sure at what point the external definition dereferencing happens, and whether it is an issue with the former or latter.

You are saying, it seems to me, that the issue is not in swagger-parser but rather in swagger-codegen?

advance512 · 2017-08-04T18:25:06Z

This is still broken, even in the latest v3.0.0.

This definition

  ID:
    description: An entity identifer
    type: integer
    format: int64
    readOnly: true

becomes this code:

/**
 *
 * OpenAPI spec version: 0.8.76
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 *
 * Swagger Codegen version: 3.0.0-SNAPSHOT
 *
 * Do not edit the class manually.
 *
 */

(function(root, factory) {
  if (typeof define === 'function' && define.amd) {
    // AMD. Register as an anonymous module.
    define(['ApiClient'], factory);
  } else if (typeof module === 'object' && module.exports) {
    // CommonJS-like environments that support module.exports, like Node.
    module.exports = factory(require('../ApiClient'));
  } else {
    // Browser globals (root is window)
    if (!root.project) {
      root.project = {};
    }
    root.project.ID = factory(root.project.ApiClient);
  }
}(this, function(ApiClient) {
  'use strict';




  /**
   * The ID model module.
   * @module model/ID
   * @version 0.8.76
   */

  /**
   * Constructs a new <code>ID</code>.
   * An entity identifer
   * @alias module:model/ID
   * @class
   */
  var exports = function() {
    var _this = this;

  };

  /**
   * Constructs a <code>ID</code> from a plain JavaScript object, optionally creating a new instance.
   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
   * @param {Object} data The plain JavaScript object bearing properties of interest.
   * @param {module:model/ID} obj Optional instance to populate.
   * @return {module:model/ID} The populated <code>ID</code> instance.
   */
  exports.constructFromObject = function(data, obj) {
    if (data) {
      obj = obj || new exports();

    }
    return obj;
  }

  return exports;
}));

I mean, just look at this function:

exports.constructFromObject = function(data, obj) {
    if (data) {
      obj = obj || new exports();

    }
    return obj;
  }

An example run would have data be 1, and obj undefined. Yet it still returns obj... it makes no sense.

This was built with useES6=false, which I need to do as I am not transpiling the code.

advance512 · 2018-02-04T16:58:19Z

I still see this issue, even with v2.4.0 and v3.0.0.

Here's an example Swagger file, murmur.yml:

swagger: '2.0'
schemes:
  - http
basePath: /murmur
consumes:
  - application/json
produces:
  - application/json

paths:

  /question_sets/{questionSetUuid}/labels:

    parameters:
      - $ref: '#/parameters/questionSetUuid'

    get:
      x-swagger-router-controller: api.question_sets
      operationId: getQuestionSetLabels
      summary: Gets the labels of a QuestionSet
      description: Returns a an array of the labels of a QuestionSet based on its ID.
      responses:
        '200':
          description: A list of QuestionSetLabel objects
          schema:
            $ref: '#/definitions/QuestionSetLabelList'
        '403':
          $ref: '#/responses/Forbidden'
        '404':
          $ref: '#/responses/EntityDoesNotExist'
        '500':
          $ref: '#/responses/InternalServerError'
        default:
          $ref: '#/responses/TotallyUnexpectedResponse'


definitions:

  QuestionSetLabel:
    description: A Label that can mark a QuestionSet
    type: string
    minLength: 3
    maxLength: 100


  QuestionSetLabelList:
    type: object
    required:
      - items
    properties:
      items:
        type: array
        minItems: 0
        maxItems: 1000
        items:
          $ref: '#/definitions/QuestionSetLabel'


responses:

  InternalServerError:
    description: An unexpected error occured.
    schema:
      $ref: '#/definitions/Error'
  BadRequest:
    description: Bad request; could not perform requested operation.
  Forbidden:
    description: The server understood the request but refuses to authorize it.
  EntitySuccessfullyCreated:
    description: Entity successfully created.
  EntitySuccessfullyUpdated:
    description: QuestionSet successfully updated.
  EntitySuccessfullyDeleted:
    description: Entity successfully deleted.
  EntityDoesNotExist:
    description: Entity does not exist.
  TotallyUnexpectedResponse:
    description: A totally unexpected response

parameters:

  questionSetLabel:
    name: questionSetLabel
    in: path
    required: true
    description: A Label that can mark a QuestionSet
    type: string
    minLength: 3
    maxLength: 100

Generating a JavaScript file, for example with 3.0.0:

java -jar swagger-codegen-cli-3.0.0-20180112.231857-20.jar generate -i murmur.yaml -l javascript --additional-properties usePromises=true --additional-properties useES6=false -o ./javascript/

It generates this QuestionSetLabel.js file:

/**
 * Murmur
 * Murmur API, the goal of Murmur is to create, update and manage QuestionSets, as well as to store, update, migrate and query QuestionSet results. 
 *
 * OpenAPI spec version: 0.8.18
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 *
 * Swagger Codegen version: 3.0.0-SNAPSHOT
 *
 * Do not edit the class manually.
 *
 */

(function(root, factory) {
  if (typeof define === 'function' && define.amd) {
    // AMD. Register as an anonymous module.
    define(['ApiClient'], factory);
  } else if (typeof module === 'object' && module.exports) {
    // CommonJS-like environments that support module.exports, like Node.
    module.exports = factory(require('../ApiClient'));
  } else {
    // Browser globals (root is window)
    if (!root.Murmur) {
      root.Murmur = {};
    }
    root.Murmur.QuestionSetLabel = factory(root.Murmur.ApiClient);
  }
}(this, function(ApiClient) {
  'use strict';




  /**
   * The QuestionSetLabel model module.
   * @module model/QuestionSetLabel
   * @version 0.8.18
   */

  /**
   * Constructs a new <code>QuestionSetLabel</code>.
   * A Label that can mark a QuestionSet
   * @alias module:model/QuestionSetLabel
   * @class
   */
  var exports = function() {
    var _this = this;

  };

  /**
   * Constructs a <code>QuestionSetLabel</code> from a plain JavaScript object, optionally creating a new instance.
   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
   * @param {Object} data The plain JavaScript object bearing properties of interest.
   * @param {module:model/QuestionSetLabel} obj Optional instance to populate.
   * @return {module:model/QuestionSetLabel} The populated <code>QuestionSetLabel</code> instance.
   */
  exports.constructFromObject = function(data, obj) {
    if (data) {
      obj = obj || new exports();
    }
    return obj;
  }

  return exports;
}));

Have a good look at the constructFromObject() function:

  exports.constructFromObject = function(data, obj) {
    if (data) {
      obj = obj || new exports();
    }
    return obj;
  }

The data parameter is never included in the return value. And obj is always undefined. Hence - we get an exports() object instead of the actual data.

It has been nearly a year. Am I truly the only one that sees this bug?

wing328 · 2018-02-07T16:21:11Z

cc @CodeNinjai @frol @cliffano to see if they can help answer your questions.

advance512 · 2018-02-07T18:52:06Z

Thanks, @wing328 , I'd love to begin a conversation and potentially help solve this issue..

CodeNinjai · 2018-02-12T08:01:44Z

@advance512 I will have a look into it, so we can discuss why this is happening, ok?

advance512 · 2018-02-12T18:44:05Z

Thanks, @CodeNinjai. I am available for any assistance required

advance512 · 2018-03-04T15:40:43Z

Any update, @CodeNinjai ?

advance512 · 2018-04-12T12:58:37Z

I think that PR #7991 might solve this issue.
Here's hoping.

CodeNinjai · 2018-04-12T13:05:49Z

Ok, thanks Alon. Didnt have the time yet, due to private reasons. I will follow up as soon as possible.

…

________________________________ Von: Alon Diamant <notifications@github.com> Gesendet: Donnerstag, 12. April 2018 14:59 An: swagger-api/swagger-codegen Cc: CodeNinja; Mention Betreff: Re: [swagger-api/swagger-codegen] [JavaScript (with promises)] Bug following $ref in object properties (#4973) I think that PR #7991<https://nam03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fswagger-api%2Fswagger-codegen%2Fpull%2F7991&data=02%7C01%7C%7Ca37fab23267446f20f6608d5a07529be%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636591347422901987&sdata=21w%2FjhHn8sqDYZ7tIP4Z1AxCry36%2F%2BWLy8dORMXDR2Y%3D&reserved=0> might solve this issue. Here's hoping. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<https://nam03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fswagger-api%2Fswagger-codegen%2Fissues%2F4973%23issuecomment-380795992&data=02%7C01%7C%7Ca37fab23267446f20f6608d5a07529be%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636591347422901987&sdata=J9ldNbcJrxC4SSX7mjuaorSvgEjVC7kMnMARu%2BYTQ6I%3D&reserved=0>, or mute the thread<https://nam03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAWBvOlEcdXT4ZALKf5Z2Q8lZdNiY4nJ_ks5tn0-TgaJpZM4MWQkG&data=02%7C01%7C%7Ca37fab23267446f20f6608d5a07529be%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636591347422901987&sdata=II0CAeRm0MP9eJfk5h5HEeVQN7anVwH5d7RXYk36W6E%3D&reserved=0>.

advance512 · 2018-04-15T10:41:06Z

@CodeNinjai
After talking to the person who implemented #7991, I think that it does indeed solve this issue.
I'd love to test this.

advance512 · 2018-04-16T07:14:59Z

@CodeNinjai
This was merged to master, we should verify it fixed it.

CodeNinjai · 2018-04-16T08:25:32Z

Ok Can you test it ? Am 16.04.2018 um 08:15 schrieb Alon Diamant <notifications@github.com<mailto:notifications@github.com>>: @CodeNinjai<https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FCodeNinjai&data=02%7C01%7C%7Cf7a5b740ec4040a2aa8e08d5a369d665%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636594597312294501&sdata=fS9jNj1UxW5bgEXzOhxyk2MNHxJRTeDFCCtVPZZZPWg%3D&reserved=0> This was merged to master, we should verify it fixed it. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fswagger-api%2Fswagger-codegen%2Fissues%2F4973%23issuecomment-381502113&data=02%7C01%7C%7Cf7a5b740ec4040a2aa8e08d5a369d665%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636594597312294501&sdata=VdleLGVCaSnR1oNHny31rN6QfPs75eda9Ih32fTQ5ck%3D&reserved=0>, or mute the thread<https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAWBvOkJ_VLKGSg97BWQb20pzUtaZyl6Jks5tpEUQgaJpZM4MWQkG&data=02%7C01%7C%7Cf7a5b740ec4040a2aa8e08d5a369d665%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636594597312294501&sdata=2vsTCbIpFF8dB1UVWy1JDzxNcvefNNCuDNFRkNZbmpY%3D&reserved=0>.

advance512 · 2018-04-16T14:17:35Z

When will I be able to download a binary (JAR file) that includes this fix? (Based on latest master)

advance512 · 2018-04-29T12:02:54Z

@CodeNinjai
any update?

advance512 · 2018-07-29T20:09:48Z

@wing328 @CodeNinjai

Any update on this? This has been open for nearly 1.5 years.
Can I sponsor this being fixed?

Thanks.

advance512 · 2018-11-13T19:36:56Z

This seems fixed in swagger-codegen-cli-2.4.0-20181113.142213-347.jar

advance512 · 2018-12-10T14:41:02Z

Seems that a new issue has been introduced in swagger-codegen-cli-2.4.0-20181113.142213-347.jar or before.

Code of this format:

definitions:
  LoginResponse:
    type: object
    properties:
      userId:
        type: integer
        format: int64
      userUuid:
        type: string
        format: uuid
      userIdByRef:
        $ref: '#/definitions/ID'
      userUuidByRef:
        $ref: '#/definitions/UUID'

  ID:
    description: An entity identifier
    type: integer
    format: int64
    readOnly: true

  UUID:
    description: The unique universal identifier of this entity
    type: string
    format: uuid
    readOnly: true

generates JavaScript client code like this:

/**
 * OpenAPI spec version: 0.8.222
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 *
 * Swagger Codegen version: 2.4.0-SNAPSHOT
 *
 * Do not edit the class manually.
 *
 */

(function(root, factory) {

   ...
   ...
   ...

  /**
   * The LoginResponse model module.
   * @module model/LoginResponse
   * @version 0.8.222
   */

  /**
   * Constructs a new <code>LoginResponse</code>.
   * @alias module:model/LoginResponse
   * @class
   */
  var exports = function() {
    var _this = this;
  };

  /**
   * Constructs a <code>LoginResponse</code> from a plain JavaScript object, optionally creating a new instance.
   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
   * @param {Object} data The plain JavaScript object bearing properties of interest.
   * @param {module:model/LoginResponse} obj Optional instance to populate.
   * @return {module:model/LoginResponse} The populated <code>LoginResponse</code> instance.
   */
  exports.constructFromObject = function(data, obj) {
    if (data) {
      obj = obj || new exports();

      if (data.hasOwnProperty('userId')) {
        obj['userId'] = ApiClient.convertToType(data['userId'], 'Number');
      }
      if (data.hasOwnProperty('userUuid')) {
        obj['userUuid'] = ApiClient.convertToType(data['userUuid'], 'String');
      }
      if (data.hasOwnProperty('userIdByRef')) {
        obj['userIdByRef'] = ID.constructFromObject(data['userIdByRef']);
      }
      if (data.hasOwnProperty('userUuidByRef')) {
        obj['userUuidByRef'] = 'String'.constructFromObject(data['userUuidByRef']);
      }
    }
    return obj;
  }

  /**
   * comment comment
   * @member {Number} userId
   */
  exports.prototype['userId'] = undefined;
  /**
   * @member {String} userUuid
   */
  exports.prototype['userUuid'] = undefined;

   ...
   ...
   ...

  return exports;
}));

You will notice this line specifically is obviously broken:

   obj['userUuidByRef'] = 'String'.constructFromObject(data['userUuidByRef']);

it should be:

   obj['userUuidByRef'] = UUID.constructFromObject(data['userUuidByRef']);

Or at least:

   obj['userUuidByRef'] = ApiClient.convertToType(data['userUuidByRef'], 'String');

This seems like a regression.

HugoMario · 2018-12-18T05:45:42Z

hey @advance512
i just merged some changes to get the expected output. Can you please check that and share feedback?

HugoMario · 2019-01-26T17:43:12Z

closing issue, but please let me know if issue is still present and i'll work on asap.

advance512 · 2019-01-28T17:09:38Z

Hi @HugoMario,

We actually moved to cpenAPI-generator, as the swagger-codegen seemed unmaintained.

If I get some time the coming weeks, I'll try to see what swagger-codegen outputs.

wing328 added the Swagger-Parser label Mar 8, 2017

wing328 added this to the v2.2.3 milestone Mar 8, 2017

wing328 added the Issue: Bug label Mar 8, 2017

advance512 mentioned this issue Mar 8, 2017

Issue following $ref in object properties swagger-api/swagger-parser#409

Closed

advance512 mentioned this issue Mar 30, 2017

Javascript client produces a wrong object for a string enum type that is used with $ref #4819

Open

wing328 modified the milestones: Future, v2.2.3 Jul 16, 2017

This was referenced Apr 9, 2018

Added vendorExtensions.x-isPrimitive. #7991

Merged

[Javascript] Undeclared properties in the Object Model #7994

Open

advance512 mentioned this issue Nov 13, 2018

[JavaScript (with promises)] Bug following $ref in object properties OpenAPITools/openapi-generator#1431

Open

advance512 closed this as completed Nov 13, 2018

advance512 reopened this Dec 10, 2018

HugoMario mentioned this issue Dec 18, 2018

check if type declaration for ref property in order to fix regression… #8999

Merged

HugoMario closed this as completed Jan 26, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JavaScript (with promises)] Bug following $ref in object properties #4973

[JavaScript (with promises)] Bug following $ref in object properties #4973

advance512 commented Mar 8, 2017

wing328 commented Mar 8, 2017

advance512 commented Mar 8, 2017 •

edited

Loading

wing328 commented Mar 8, 2017

fehguy commented Mar 10, 2017

advance512 commented Mar 10, 2017

advance512 commented Aug 4, 2017

advance512 commented Feb 4, 2018

wing328 commented Feb 7, 2018

advance512 commented Feb 7, 2018

CodeNinjai commented Feb 12, 2018

advance512 commented Feb 12, 2018

advance512 commented Mar 4, 2018

advance512 commented Apr 12, 2018

CodeNinjai commented Apr 12, 2018 via email

advance512 commented Apr 15, 2018

advance512 commented Apr 16, 2018

CodeNinjai commented Apr 16, 2018 via email

advance512 commented Apr 16, 2018

advance512 commented Apr 29, 2018

advance512 commented Jul 29, 2018

advance512 commented Nov 13, 2018

advance512 commented Dec 10, 2018

HugoMario commented Dec 18, 2018

HugoMario commented Jan 26, 2019

advance512 commented Jan 28, 2019

[JavaScript (with promises)] Bug following $ref in object properties #4973

[JavaScript (with promises)] Bug following $ref in object properties #4973

Comments

advance512 commented Mar 8, 2017

Description

Swagger-codegen version

Swagger declaration file content or url

Command line used for generation

Steps to reproduce

Related issues

Suggest a Fix

wing328 commented Mar 8, 2017

advance512 commented Mar 8, 2017 • edited Loading

wing328 commented Mar 8, 2017

fehguy commented Mar 10, 2017

advance512 commented Mar 10, 2017

advance512 commented Aug 4, 2017

advance512 commented Feb 4, 2018

wing328 commented Feb 7, 2018

advance512 commented Feb 7, 2018

CodeNinjai commented Feb 12, 2018

advance512 commented Feb 12, 2018

advance512 commented Mar 4, 2018

advance512 commented Apr 12, 2018

CodeNinjai commented Apr 12, 2018 via email

advance512 commented Apr 15, 2018

advance512 commented Apr 16, 2018

CodeNinjai commented Apr 16, 2018 via email

advance512 commented Apr 16, 2018

advance512 commented Apr 29, 2018

advance512 commented Jul 29, 2018

advance512 commented Nov 13, 2018

advance512 commented Dec 10, 2018

HugoMario commented Dec 18, 2018

HugoMario commented Jan 26, 2019

advance512 commented Jan 28, 2019

advance512 commented Mar 8, 2017 •

edited

Loading