Incorrect code generation: String instead of Int #23

nikola-mladenovic · 2016-11-18T18:44:16Z

Steps to reproduce:

The resulting API.swift that was generated using apollo-ios version 0.4 and apollo-codegen version 0.9 contains: public let centAmount: String (MoneyDetails struct property). The actual type from the schema:

{
"name": "centAmount",
"type": {
  "kind": "NON_NULL",
  "name": null,
  "ofType": {
    "kind": "SCALAR",
    "name": "Long",
    "ofType": null
  }
}

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

martijnwalraven · 2016-11-18T19:47:28Z

According to the GraphQL spec, Long is not a built-in scalar, so it is treated as a custom scalar. Right now in Apollo iOS, all custom scalars are mapped to string (which is also how they are encoded in JSON).

I would definitely like to add better support for custom scalars, which should give you the opportunity to define your own mapping.

But in this case, do you really need Long here, or would Int suffice?

martijnwalraven · 2016-11-19T06:42:19Z

thanks @martijnwalraven! judging by the nature of centAmount field, I think the value can be pretty high in some cases
the current workaround could be manually altering the local schema file; is there anything better you’d suggest?

I hope to add better support for custom scalars soon, but in the meantime there is a temporary apollo-codegen option --passthrough-custom-scalars that doesn't attempt to map custom scalars to string but keeps them as is. That means you're responsible for defining the type and making sure it is JSONDecodable and JSONEncodable.

I haven't tested it, but something like this should work:

typealias Long = Int64

extension Int64: JSONDecodable, JSONEncodable {
  public init(jsonValue value: JSONValue) throws {
    guard let string = value as? String else {
      throw JSONDecodingError.couldNotConvert(value: value, to: String.self)
    }
    guard let number = Int64(string) else {
      throw JSONDecodingError.couldNotConvert(value: value, to: Int64.self)
    }

    self = number
  }

  public var jsonValue: JSONValue {
    return String(self)
  }
}

AnandWalvekar · 2017-09-04T11:40:52Z

Hi @martijnwalraven
I am getting an error on iOS client

Error
"Error at path "history.itemid": couldNotConvert(value: 1100025, to: Swift.String)"

System Info

apollo-codegen version : 0.16.5
Apollo Client SDK version : (0.6.2)
schema.json type
{ "defaultValue": null, "name": "itemId", "description": null, "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Long", "ofType": null } } }

What I tried
Tried extension you have mentioned and updated the build generation script in Xcode -> Build Phases -> Ran Script
$APOLLO_FRAMEWORK_PATH/check-and-run-apollo-codegen.sh generate $(find . -name '*.graphql') --schema schema.json --output API.swift --passthrough-custom-scalars

Please let me know if I am going wrong somewhere

martijnwalraven · 2017-09-04T11:46:14Z

@AnandWalvekar: Does the generated API code reference Long? Where are you including typealias Long = Int64 and the extension?

AnandWalvekar · 2017-09-04T12:07:25Z

@martijnwalraven
Yes it is having Long
public var itemId: Long
I have included both typealias & extension in a new file in my project as
import Apollo
public typealias Long = Int64

But still getting the same error

martijnwalraven · 2017-09-04T12:10:51Z

@AnandWalvekar: That is surprising. Can you check if the generated API code includes a typealias Long = String by any chance? (It shouldn't, because you specify --passthrough-custom-scalars. But then even if it doesn't pick up your typealias Long, it should fail with a compiler error.)

AnandWalvekar · 2017-09-04T12:20:39Z

@martijnwalraven
It works if I write like below
guard let long = value as? Long else { throw JSONDecodingError.couldNotConvert(value: value, to: String.self) } self = long

Is this the solution?

martijnwalraven · 2017-09-04T12:25:44Z

@AnandWalvekar: Ah, so you're encoding Long as a JSON number instead of a string! If that's the case, something like your code would work (although you may want to change the error message as well).

Note that numbers in JavaScript can't represent 64-bit integers however, so unless you're sure the value will never exceed Number.MAX_SAFE_INTEGER (2^53 - 1), that might lead to unexpected problems.

AnandWalvekar · 2017-09-04T12:37:00Z

@martijnwalraven
Understood. Thank you very much for your quick support.

NiltiakSivad · 2018-08-20T13:48:55Z

@martijnwalraven suggestion worked fine for me originally, but the latest Apollo code generation script installation changes does not accept the --passthrough-custom-scalars option. Worked with check-and-run-apollo-codegen.sh (Apollo 0.8) but does not work with the new check-and-run-apollo-cli.sh (Apollo 0.9.2).

szantogab · 2018-08-20T17:29:01Z

@NiltiakSivad same problem here.. :(

NiltiakSivad · 2018-08-20T18:36:53Z

@szantogab I re-read martijnwalraven's post and he does mention it's a "temporary" flag. I'm not sure if anything is mentioned about its removal and future plans in another issue/merge request, I need to investigate more, if I find anything I'll post here.

szantogab · 2018-08-22T09:54:11Z

@NiltiakSivad I dug a little deeper, and I found that Apollo CLI now expects the parameter this way: --passthroughCustomScalars.

You can check out Apollo CLI's other parameters here:
https://github.com/apollographql/apollo-cli#apollo-codegengenerate-output

Hope this helps you :)

daksharma · 2018-10-16T20:48:54Z

Hi @martijnwalraven
It seems like the typealias was a viable solution for many people. I tried the typealias Long = Int64 and the extension that you have posted above.
When generating the API.swift file I am using the ----passthroughCustomScalars flag, when building the project Xcode/Swift complains about Property cannot be declared public because its type uses an internal type.

I am using Apollo through Cocoapods and the Apollo cli (not apollo-codegen) as well as the script provided in the installation process of the apollo ios website.
I tried both Swift 4 and Swift 4.2 in the build settings. but the error persists.

This error is in the API.swift file. No typealias is declared in the generated file.

Since API.swift should not be modified, any idea on how this can be resolved.

EDIT: Solved :)

jtoce · 2018-11-06T02:10:00Z

Since API.swift should not be modified, any idea on how this can be resolved.

EDIT: Solved :)

I copy the code into Long.swift and then changed the line to read public typealias Long = Int64.

john1452 · 2018-11-29T07:44:31Z

Hi @martijnwalraven

Is there a workaround to use "Any" as custom type?
One of the API i am consuming returns "Object" type which can contain Int Decimal or a string value.

I tried the following but it will not work.

public typealias Object = Any
extension Object : JSONDecodable, JSONEncodable { }

Any help is appreciated

Thanks!

daoseng33 · 2019-01-16T10:08:02Z

Remember to import Apollo and conform "JSONDecodable", not inherit "JSONDecoder"...
(I'm stuck for this for an hour... such a fool)

niraj1991 · 2019-03-28T06:36:33Z

Hi @martijnwalraven

I am getting an error on iOS client. Incorrect code generation: String instead of Array.

The resulting API.swift that was generated using apollo-ios

GraphQLField("reactiondata", type: .scalar(String.self)),

 public var reactiondata: String? {
        get {
          return resultMap["reactiondata"] as? String
        }
        set {
          resultMap.updateValue(newValue, forKey: "reactiondata")
        }
      }

The actual type from the schema file:

{ "name": "reactiondata", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Array", "ofType": null }, "isDeprecated": false, "deprecationReason": null },

If I am try with --passthroughCustomScalars Also I am geting error.

The resulting API.swift that was generated with --passthroughCustomScalars

public typealias Array = [AnyObject]

GraphQLField("reactiondata", type: .scalar(Array.self)),

public var reactiondata: Array? { get { return resultMap["reactiondata"] as? Array } set { resultMap.updateValue(newValue, forKey: "reactiondata") } }

I am geting following error.


`# Type a script or drag a script file from your workspace to insert its path.
APOLLO_FRAMEWORK_PATH="$(eval find $FRAMEWORK_SEARCH_PATHS -name "Apollo.framework" -maxdepth 1)"

if [ -z "$APOLLO_FRAMEWORK_PATH" ]; then
echo "error: Couldn't find Apollo.framework in FRAMEWORK_SEARCH_PATHS; make sure to add the framework to your project."
exit 1
fi

cd "${SRCROOT}/${TARGET_NAME}"
$APOLLO_FRAMEWORK_PATH/check-and-run-apollo-cli.sh codegen:generate --queries="$(find . -name '*.graphql')" --passthroughCustomScalars --schema=schema.json API.swift

Please let me know if I am going wrong somewhere

martijnwalraven · 2019-03-28T06:40:09Z

@niraj1991 The type in the schema you posted seems to be a custom scalar called Array, not an actual GraphQL list type. If reactiondata is meant to be represented as an array, you should change the type in the schema.

niraj1991 · 2019-03-28T06:48:26Z

@martijnwalraven Thanks for writing to me.
I am updating my above post. can you please check again?

martijnwalraven · 2019-03-28T07:02:25Z

@niraj1991 You'll have to change reactiondata to be an actual list in your schema, not a scalar. You can't generate a scalar with the name Array and expect it to map to a Swift Array.

niraj1991 · 2019-03-28T10:22:48Z

@martijnwalraven I changed the schema file like below.

{ "name": "details", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Json", "ofType": null }, "isDeprecated": false, "deprecationReason": null }

But I am Getting below error.

`Error at path "posts.0.reactiondata": couldNotConvert(value: <__NSArray0 0x600002408050>(
)
, to: Swift.Dictionary<Swift.String, Swift.Optional<Any>>)`

The resulting API.swift that was generated like below.

 public static let selections: [GraphQLSelection] = [
        GraphQLField("reactiondata", type: .scalar(Json.self)),
      ]

public var reactiondata: Json? {
        get {
          return resultMap["reactiondata"] as? Json
        }
        set {
          resultMap.updateValue(newValue, forKey: "reactiondata")
        }
      }

Also I am creating typealias like below.

public typealias Json = [String : Any?]

Let me know if you need any other details, I would be happy to share you.

Please let me know if I am going wrong somewhere.

Thanks in advance.

martijnwalraven · 2019-03-28T10:33:17Z

@niraj1991 It seems you're returning an array from the server and trying to map this to a SwiftDictionary ([String : Any?]). If you need to use a JSON type (as opposed to changing the schema to something more specific), you'll have to use public typealias JSON = Any.

niraj1991 · 2019-03-28T13:06:05Z

@martijnwalraven if I am writing public typealias Json = Any Then I get the below error.
public typealias Json = Any

Here is schema file.

       {
            "name": "reactiondata",
            "description": null,
            "args": [],
            "type": {
              "kind": "SCALAR",
              "name": "Json",
              "ofType": null
            },
            "isDeprecated": false,
            "deprecationReason": null
          },

Please let me know if I need to change anything.

martijnwalraven · 2019-03-28T20:17:54Z

@niraj1991 Ah, my mistake, I don't think Any is supported as a custom scalar type. Honestly, this doesn't seem like a great use case for custom scalars, you should really give reactiondata a proper type.

JakeTorres · 2019-08-04T05:20:34Z

Sript phase: SCRIPT_PATH="${PODS_ROOT}/Apollo/scripts"
cd "${SRCROOT}/${TARGET_NAME}"
"${SCRIPT_PATH}"/check-and-run-apollo-cli.sh codegen:generate --target=swift --includes=./**/*.graphql --passthroughCustomScalars --localSchemaFile="schema.json" API.swift

I do it in: JSONStandardTypeConversions
typealias Long = Int64
extension Long: JSONDecodable, JSONEncodable {
public init(jsonValue value: JSONValue) throws {
guard let number = value as? NSNumber else {
throw JSONDecodingError.couldNotConvert(value: value, to: Int64.self)
}
self = number.int64Value
}

public var jsonValue: JSONValue {
    return self
}

}

but run API.Swift get an error: Use of unresolved identifier 'Long'

who can tell me what wrong with that?

designatednerd · 2019-08-07T20:25:58Z

Int support for custom scalars has (finally) shipped in 0.14.0.

@JakeTorres Can you please take your question to our Spectrum chat? it's not quite related to this issue. Thank you!

git-subtree-dir: apollo-ios git-subtree-mainline: 335653a git-subtree-split: 7426485

git-subtree-dir: apollo-ios-codegen git-subtree-mainline: 97618d5 git-subtree-split: 48b6461c7a4868c960fd82d4935327361b4350f4

nikola-mladenovic mentioned this issue Nov 21, 2016

Closes #94 Product overview using GraphQL endpoint commercetools/commercetools-sunrise-ios#112

Closed

idris mentioned this issue Jan 3, 2017

JSON Scalar throws JSONDecondingError.couldNotConvert #36

Closed

IvanGoncharov mentioned this issue Jun 16, 2017

Add support for Scalar aliases graphql/graphql-spec#308

Closed

martijnwalraven mentioned this issue Sep 5, 2017

How to define the rules for type convert #94

Closed

IvanGoncharov mentioned this issue Nov 29, 2017

RFC: Scalar serialize as built-in scalar type graphql/graphql-spec#326

Closed

martijnwalraven mentioned this issue Mar 3, 2018

GraphQLResultError(path: ["idp", "authenticate", "userId"], underlying: Apollo.JSONDecodingError.couldNotConvert(value: 27, to: Swift.String)) #218

Closed

cadizjavier mentioned this issue Nov 6, 2018

Cast Int as String if the jsonValue is of type Int. (Custom Scalars better compatibility) #402

Merged

designatednerd added the codegen Issues related to or arising from code generation label Jul 10, 2019

designatednerd added this to the 0.14.0 milestone Aug 5, 2019

designatednerd closed this as completed Aug 7, 2019

ttrznadel mentioned this issue Jun 24, 2020

"Optional is only JSONEncodable if Wrapped is" fatal error occurs on Optional #1271

Closed

Renish-Development mentioned this issue Oct 5, 2020

Using a custom Date scalar #1435

Closed

Trupti-nayak mentioned this issue Nov 17, 2020

Error decoding Array while using custom scalars in iOS swift #1523

Closed

RavikanthManneMize mentioned this issue Mar 1, 2022

JSON Scalar throws JSONDecondingError.couldNotConvert in iOS #2181

Closed

BobaFetters pushed a commit that referenced this issue Sep 12, 2023

split: apollo-ios - PR #23 - Updating contributing guides

97618d5

git-subtree-dir: apollo-ios git-subtree-mainline: 335653a git-subtree-split: 7426485

BobaFetters pushed a commit that referenced this issue Sep 12, 2023

split: apollo-ios-codegen - PR #23 - Updating contributing guides

4115729

git-subtree-dir: apollo-ios-codegen git-subtree-mainline: 97618d5 git-subtree-split: 48b6461c7a4868c960fd82d4935327361b4350f4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Incorrect code generation: String instead of Int #23

Incorrect code generation: String instead of Int #23

nikola-mladenovic commented Nov 18, 2016 •

edited

Loading

martijnwalraven commented Nov 18, 2016

martijnwalraven commented Nov 19, 2016

AnandWalvekar commented Sep 4, 2017

martijnwalraven commented Sep 4, 2017

AnandWalvekar commented Sep 4, 2017

martijnwalraven commented Sep 4, 2017

AnandWalvekar commented Sep 4, 2017

martijnwalraven commented Sep 4, 2017 •

edited

Loading

AnandWalvekar commented Sep 4, 2017 •

edited

Loading

NiltiakSivad commented Aug 20, 2018 •

edited

Loading

szantogab commented Aug 20, 2018

NiltiakSivad commented Aug 20, 2018

szantogab commented Aug 22, 2018

daksharma commented Oct 16, 2018 •

edited

Loading

jtoce commented Nov 6, 2018 •

edited

Loading

john1452 commented Nov 29, 2018

daoseng33 commented Jan 16, 2019 •

edited

Loading

niraj1991 commented Mar 28, 2019 •

edited

Loading

martijnwalraven commented Mar 28, 2019

niraj1991 commented Mar 28, 2019

martijnwalraven commented Mar 28, 2019

niraj1991 commented Mar 28, 2019

martijnwalraven commented Mar 28, 2019

niraj1991 commented Mar 28, 2019

martijnwalraven commented Mar 28, 2019

JakeTorres commented Aug 4, 2019

designatednerd commented Aug 7, 2019

Incorrect code generation: String instead of Int #23

Incorrect code generation: String instead of Int #23

Comments

nikola-mladenovic commented Nov 18, 2016 • edited Loading

martijnwalraven commented Nov 18, 2016

martijnwalraven commented Nov 19, 2016

AnandWalvekar commented Sep 4, 2017

martijnwalraven commented Sep 4, 2017

AnandWalvekar commented Sep 4, 2017

martijnwalraven commented Sep 4, 2017

AnandWalvekar commented Sep 4, 2017

martijnwalraven commented Sep 4, 2017 • edited Loading

AnandWalvekar commented Sep 4, 2017 • edited Loading

NiltiakSivad commented Aug 20, 2018 • edited Loading

szantogab commented Aug 20, 2018

NiltiakSivad commented Aug 20, 2018

szantogab commented Aug 22, 2018

daksharma commented Oct 16, 2018 • edited Loading

jtoce commented Nov 6, 2018 • edited Loading

john1452 commented Nov 29, 2018

daoseng33 commented Jan 16, 2019 • edited Loading

niraj1991 commented Mar 28, 2019 • edited Loading

martijnwalraven commented Mar 28, 2019

niraj1991 commented Mar 28, 2019

martijnwalraven commented Mar 28, 2019

niraj1991 commented Mar 28, 2019

martijnwalraven commented Mar 28, 2019

niraj1991 commented Mar 28, 2019

martijnwalraven commented Mar 28, 2019

JakeTorres commented Aug 4, 2019

designatednerd commented Aug 7, 2019

nikola-mladenovic commented Nov 18, 2016 •

edited

Loading

martijnwalraven commented Sep 4, 2017 •

edited

Loading

AnandWalvekar commented Sep 4, 2017 •

edited

Loading

NiltiakSivad commented Aug 20, 2018 •

edited

Loading

daksharma commented Oct 16, 2018 •

edited

Loading

jtoce commented Nov 6, 2018 •

edited

Loading

daoseng33 commented Jan 16, 2019 •

edited

Loading

niraj1991 commented Mar 28, 2019 •

edited

Loading