Skip to content

Generates invalid typings for ServiceExceptions with non primitive param types #217

@Que3216

Description

@Que3216

What happened?

   InvalidTimeIntervals:
        namespace: MyService
        code: INVALID_ARGUMENT
        safe-args:
          invalidTimeIntervals: set<TimeInterval>

Generates the typings:

import { ITimeInterval } from "./timeInterval";
export interface IInvalidTimeIntervals {
    'errorCode': "INVALID_ARGUMENT";
    'errorInstanceId': string;
    'errorName': "MyService:InvalidTimeIntervals";
    'parameters': {
        invalidTimeIntervals: Array<ITimeInterval>;
    };
}
export declare function isInvalidTimeIntervals(arg: any): arg is IInvalidTimeIntervals;

But at runtime generates the value:

{
        "errorCode": "INVALID_ARGUMENT",
        "errorName": "MyService:InvalidTimeIntervals",
        "errorInstanceId": "....",
        "parameters": {
            "invalidTimeIntervals": "[TimeInterval{start: DayTime{day: MONDAY, time: 10:00}, end: DayTime{day: MONDAY, time: 10:01}}]",
        }
    }

Note that invalidTimeIntervals is serialized as a string (not even valid JSON). This mismatch can cause bugs at runtime if the developer does not realize the typings are incorrect.

What did you want to happen?

It to generate typings of:

import { ITimeInterval } from "./timeInterval";
export interface IInvalidTimeIntervals {
    'errorCode': "INVALID_ARGUMENT";
    'errorInstanceId': string;
    'errorName': "MyService:InvalidTimeIntervals";
    'parameters': {
        invalidTimeIntervals: string; // <<<<<
    };
}
export declare function isInvalidTimeIntervals(arg: any): arg is IInvalidTimeIntervals;

Or the Conjure BE to not serialize params, or serialize them to JSON for the FE to parse (though expect this would be a hard to make break).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions