Wrong type of field SearchBlob.id - should be String

[vadipp]

Hello! First of all thank you for all the work on this library!

Here is my issue. I'm using gitlab4j-api version 5.1.0 to make requests against Gitlab version 15.10.0.

The code is as follows:

gitlabApi.getSearchApi().projectSearchStream(projectId, Constants.ProjectSearchScope.BLOBS, query, branch)

Most of the time it works fine, but for some searches I get a crash like this:

com.fasterxml.jackson.databind.exc.InvalidFormatException: Cannot deserialize value of type `java.lang.Long` from String "22ef943c82ed01be9aeb7439ba1d5d41d652e759": not a valid Long value
 at [Source: (org.glassfish.jersey.client.internal.HttpUrlConnector$2); line: 1, column: 1297] (through reference chain: java.util.ArrayList[0]->org.gitlab4j.api.models.SearchBlob["id"])
	at com.fasterxml.jackson.databind.exc.InvalidFormatException.from(InvalidFormatException.java:67)
	at com.fasterxml.jackson.databind.DeserializationContext.weirdStringException(DeserializationContext.java:1702)
	at com.fasterxml.jackson.databind.DeserializationContext.handleWeirdStringValue(DeserializationContext.java:947)
	at com.fasterxml.jackson.databind.deser.std.NumberDeserializers$LongDeserializer._parseLong(NumberDeserializers.java:589)
	at com.fasterxml.jackson.databind.deser.std.NumberDeserializers$LongDeserializer.deserialize(NumberDeserializers.java:562)
	at com.fasterxml.jackson.databind.deser.std.NumberDeserializers$LongDeserializer.deserialize(NumberDeserializers.java:540)
	at com.fasterxml.jackson.databind.deser.impl.MethodProperty.deserializeAndSet(MethodProperty.java:129)
	at com.fasterxml.jackson.databind.deser.BeanDeserializer.vanillaDeserialize(BeanDeserializer.java:293)
	at com.fasterxml.jackson.databind.deser.BeanDeserializer.deserialize(BeanDeserializer.java:156)
	at com.fasterxml.jackson.databind.deser.std.CollectionDeserializer.deserialize(CollectionDeserializer.java:291)
	at com.fasterxml.jackson.databind.deser.std.CollectionDeserializer.deserialize(CollectionDeserializer.java:250)
	at com.fasterxml.jackson.databind.deser.std.CollectionDeserializer.deserialize(CollectionDeserializer.java:27)
	at com.fasterxml.jackson.databind.ObjectMapper._readMapAndClose(ObjectMapper.java:4524)
	at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3519)
	at org.gitlab4j.api.Pager.<init>(Pager.java:95)
	at org.gitlab4j.api.SearchApi.projectSearch(SearchApi.java:326)
	at org.gitlab4j.api.SearchApi.projectSearchStream(SearchApi.java:269)

It turns out that most of the time Gitlab uses null as id field in the response, but in some cases (I don't know exactly which) the id has the form of a string like 22ef943c82ed01be9aeb7439ba1d5d41d652e759.

However, in the SearchBlob class provided by gitlab4j, the id field is of type Long (was Integer in some earlier versions). Hence the error.

I think that either the type of the id field should be changed to String, or the field should be removed entirely, as it's usually null.

[vadipp]

I could make a pull request for this, but a decision needs to be made, how to fix this, see propositions in the last sentence :)

[vadipp]

Oops, forgot to attach the real API response which leads to the error:

[
  {
    "basename": "src/main/resources/img/operators/10829",
    "data": "PNG\r\n\u001a\n\rIHDRP\b\u0002ʄCA\u0019tEXtSoftwareAdobe ImageReadyqe\u003c\u0003\"iTXtXML:com.adobe.xmp\u003c?xpacket begin=\"\" id=\"W5M0MpCehiHzreSzNTczkc9d\"?\u003e \u003cx:xmpmeta xmlns:x=\"adobe:ns:meta/\" x:xmptk=\"Adobe XMP Core 5.0-c060 61.134777, 2010/02/12-17:32:00        \"\u003e \u003crdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"\u003e \u003crdf:Description rdf:about=\"\" xmlns:xmp=\"http://ns.adobe.com/xap/1.0/\" xmlns:xmpMM=\"http://ns.adobe.com/xap/1.0/mm/\" xmlns:stRef=\"http://ns.adobe.com/xap/1.0/sType/ResourceRef#\" xmp:CreatorTool=\"Adobe Photoshop CS5 Macintosh\" xmpMM:InstanceID=\"xmp.iid:AD0804F96C7311E298B4ABBC1AAE7381\" xmpMM:DocumentID=\"xmp.did:AD0804FA6C7311E298B4ABBC1AAE7381\"\u003e \u003cxmpMM:DerivedFrom stRef:instanceID=\"xmp.iid:AD0804F76C7311E298B4ABBC1AAE7381\" stRef:documentID=\"xmp.did:AD0804F86C7311E298B4ABBC1AAE7381\"/\u003e \u003c/rdf:Description\u003e \u003c/rdf:RDF\u003e \u003c/x:xmpmeta\u003e \u003c?xpacket end=\"r\"?\u003eW:=IDATx\u0007\\ga.ާH+\u0017K\"wlcv'%@BH @\u00027pM\u000b\u0018CBbll6%YkW\u003eҽy'7Dή4sΞ=o*d6V�FWWXZ]UU2\u001e",
    "path": "src/main/resources/img/operators/10829.png",
    "filename": "src/main/resources/img/operators/10829.png",
    "id": "22ef943c82ed01be9aeb7439ba1d5d41d652e759",
    "ref": "master",
    "startline": 1,
    "project_id": 174
  },
  {
    "basename": "src/main/resources/img/operators/11829",
    "data": "PNG\r\n\u001a\n\rIHDRP\b\u0006E\u0016\u0019tEXtSoftwareAdobe ImageReadyqe\u003c\u0003iTXtXML:com.adobe.xmp\u003c?xpacket begin=\"\" id=\"W5M0MpCehiHzreSzNTczkc9d\"?\u003e \u003cx:xmpmeta xmlns:x=\"adobe:ns:meta/\" x:xmptk=\"Adobe XMP Core 5.6-c145 79.163499, 2018/08/13-16:40:22        \"\u003e \u003crdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"\u003e \u003crdf:Description rdf:about=\"\" xmlns:xmpMM=\"http://ns.adobe.com/xap/1.0/mm/\" xmlns:stRef=\"http://ns.adobe.com/xap/1.0/sType/ResourceRef#\" xmlns:xmp=\"http://ns.adobe.com/xap/1.0/\" xmpMM:OriginalDocumentID=\"xmp.did:78a9aa48-e950-154e-a30d-e3fb4bf63d6b\" xmpMM:DocumentID=\"xmp.did:04759395A6E011E9B94FE5E49B0B2284\" xmpMM:InstanceID=\"xmp.iid:04759394A6E011E9B94FE5E49B0B2284\" xmp:CreatorTool=\"Adobe Photoshop CC 2014 (Windows)\"\u003e \u003cxmpMM:DerivedFrom stRef:instanceID=\"xmp.iid:d8670a46-8356-3a4c-a731-11a86ae01748\" stRef:documentID=\"adobe:docid:photoshop:fa9b42ec-6bd9-4849-a010-416a183e6b3a\"/\u003e \u003c/rdf:Description\u003e \u003c/rdf:RDF\u003e \u003c/x:xmpmeta\u003e \u003c?xpacket end=\"r\"?\u003e2\b+IDATxyl\u0014U\u001cǿ娢\b\u001e\u001cE#\u001a\u00111\u001e\u00151*",
    "path": "src/main/resources/img/operators/11829.png",
    "filename": "src/main/resources/img/operators/11829.png",
    "id": "a0b24fa71d6d8cef7393e877c608496f91ded0f6",
    "ref": "master",
    "startline": 1,
    "project_id": 174
  }
]

[jmini]

Personal opinion:

For me this can be changed to String, together with an update of the example file:

gitlab4j-api/src/test/resources/org/gitlab4j/api/wiki-blobs.json

Line 6 in dc0f9f2

"id": 123,

I would approve a PR doing this change.

The documentation does not really help with the examples where this is null:

• https://docs.gitlab.com/ee/api/search.html#scope-blobs-premium-2
• https://docs.gitlab.com/ee/api/search.html#scope-wiki_blobs

[vadipp]

Hello @jmini! Thanks for your feedback. I've created a pull request with the proposed changes. Can you please review and proceed to merge it?

[gedeffe]

Hello
@vadipp , Thanks for this fix, just when I need it ;-)
@jmini could it be possible to merge this fix into branch 6.x too ?