Git Product home page Git Product logo

Comments (8)

JP-Ellis avatar JP-Ellis commented on August 14, 2024 1

Isn't this the counterpart of the PactSpecification enum defined in pact.h?

/**
 * Enum defining the pact specification versions supported by the library
 */
typedef enum PactSpecification {
  /**
   * Unknown or unsupported specification version
   */
  PactSpecification_Unknown,
  /**
   * First version of the pact specification
   */
  PactSpecification_V1,
  /**
   * Second version of the pact specification 
   */
  PactSpecification_V1_1,
  /**
   * Version two of the pact specification
   */
  PactSpecification_V2,
  /**
   * Version three of the pact specification 
   */
  PactSpecification_V3,
  /**
   * Version four of the pact specification
   */
  PactSpecification_V4,
} PactSpecification;

In which case V4 does correctly correspond to int 5.

from pact-js.

rholshausen avatar rholshausen commented on August 14, 2024

No, the issue is that PactV3Options has

  /**
   * Specification version to use
   */
  spec?: SpecificationVersion;

https://github.com/pact-foundation/pact-js/blob/master/src/v3/types.ts#L102

If you try use that enum value SPECIFICATION_VERSION_V4 , you get that error.

from pact-js.

JP-Ellis avatar JP-Ellis commented on August 14, 2024

It seems correct to me to use spec?: SpecificationVersion with an enum. I'm guessing then that the num is incorrectly handled elsewhere and is converted to an integer in a somewhat naive way? Or perhaps some confusion between ints and enum values in:

export const numberToSpec = (
spec?: number,
defaultSpec: SpecificationVersion = SpecificationVersion.SPECIFICATION_VERSION_V2
): SpecificationVersion => {
if (!spec) {
return defaultSpec;
}
switch (spec) {
case 2:
return SpecificationVersion.SPECIFICATION_VERSION_V2;
case 3:
return SpecificationVersion.SPECIFICATION_VERSION_V3;
case 4:
return SpecificationVersion.SPECIFICATION_VERSION_V4;
default:
throw new Error(`invalid pact specification version supplied: ${spec}`);
}
};

from pact-js.

mefellows avatar mefellows commented on August 14, 2024

Can you please show the MessageConsumerPact constructor you used (i.e. the setup code)?

from pact-js.

mefellows avatar mefellows commented on August 14, 2024

I can see the problem, I think. The type MessageConsumerOptions does not take the enum, it takes an integer (it predates the later interfaces which accept the enum because that would have broken the backwards-compatibility of the API): https://github.com/pact-foundation/pact-js/blob/master/src/dsl/options.ts#L104

It accepts an integer that maps logically to each version (1 = spec version 1, 2 = spec version 2 etc.). When you pass in the enum, the value is mapped to the core (as Josh has noted). Due to the zero indexing and the support for 1.1, Spec Version 4 maps to the integer 5.

In any case, it's an unfortunate inconsistency in the interface. There is not yet a V4 version of Asynchronous Messages that aligns with the most recent DSL.

TL;DR - use 4 instead of the enum.

No, the issue is that PactV3Options has...

Where are you getting that type for? That's only used in the PactV3 type, not the messaging type.

from pact-js.

rholshausen avatar rholshausen commented on August 14, 2024

Ah, you are correct.

  // Specification Version (should be 3 for messages)
  spec?: number;

This is confusing. Also not having V4 support for asynchronous messages.

from pact-js.

mefellows avatar mefellows commented on August 14, 2024

Yeah, I have an open branch with partial support for the updated asynchronous interface (this was the original one that supported the Ruby messaging API, and doesn't support plugins etc.).

I'll update the comment for now.

from pact-js.

mefellows avatar mefellows commented on August 14, 2024

I'll close this and open a feature request for Async Messages

from pact-js.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.