CreateRelease asserting on auth error.

[bsutton]

I'm trying to use the CreateRelease class.

During my first test my code failed due to an auth error.

The problem is that the github library returned a secondary error masking the root cause of the problem.

repos_service: 993 - Failed assertion: boolean expression must not be null

Tracing through the code I believe the problem is caused in the github.requestJson method.

This method calls github.request with a 'null' statusCode.

In the request method I see the following code:

 _updateRateLimit(response.headers);
    if (statusCode != null && statusCode != response.statusCode) {
      if (fail != null) {
        fail(response);
      }
      handleStatusCode(response);
    } else {
      return response;
    }

My reading of this method is that if the statusCode is null then error is ignore.
The requestJson method then tries to decode the response as a CreateRelease object which of course its not.

I think the problem here is that the call to handleStatusCode is only called if a statusCode is passed in.

I would think that the handleStatusCode method should be called even if a statusCode is not passed in.

So I think the code should read:

 _updateRateLimit(response.headers);

      // handle expected status codes.
     if (statusCode != null && statusCode == response.statusCode) {
        return response;
    }
    /// should we consider any 2XX code to be an OK?
    if (response.statusCode != 200)
    {
        if (fail != null) {
           fail(response);
        handleStatusCode(response);
    } else {
      return response;
    }

[github-actions]

Thanks for submitting an issue! @robrbecker will take a look soon!

[bsutton]

I had a bit more of a play with the code and tried adding a statusCode to the createRelease method:

 Future<Release> createRelease(
    RepositorySlug slug,
    CreateRelease createRelease, {
    bool getIfExists = true,
  }) async {
    ArgumentError.checkNotNull(slug);
    ArgumentError.checkNotNull(createRelease);
    final release = await github.postJSON<Map<String, dynamic>, Release>('/repos/${slug.fullName}/releases',
        convert: (i) => Release.fromJson(i),
        body: GitHubJson.encode(createRelease.toJson()),
        statusCode: StatusCodes.OK);

I then got the expected error (Requested Resource was Not Found).

This however seems problematic.

The code seems to currently be written that if an expected statusCode isn't passed in then the code should just ignore statusCodes.

I would have thought that either passing a statusCode was required or an error was thrown regardless.
The currently logic seems to be 'lets just ignore errors and not pass them up in a meaningful manner'.

Perhaps the simplest solution is to default the statusCode to StatusCode.OK if its not explicitly passed.

Of course this may be a breach of the current contract. But then the documentation on the current behaviour is rather ambiguous:

[bsutton]

@robrbecker are you still actively maintaining this project?

[robrbecker]

Hey sorry for the slow response. I was on PTO and then busy getting back to work. I picked up maintenance of this project a while back but only get to it periodically. Thanks for filing issues and putting up PRs. I appreciate all the help I can get.

I think you might be right about defaulting to StatusCodes.OK. I'll have to dig into that to see if that breaks anything.

[bsutton]

@robrbecker just checking that you saw my response to your review.