I haven't witnessed any bad behavior because of this except for confusing logs, and maybe some unnecessary state transitions.
I found this while investigating a CBS auth failure that turned out to be a problem with our service. I had some momentary confusion because, at one point, the C code called on_cbs_open_complete passing CBS_OPEN_OK, which the C code has defined as 1. Then, inside cbs.pyx, the code assumed that 1 was CBS_OPEN_ERROR, so it set self.state to AUTH_STATE_FAILURE.
Fortunately, our service finishes the put_token quickly enough that the CBS operation can complete successfully, so no harm was actually done.
I have mixed feelings about this change. On the one hand, the code is very clearly incorrect, but, on the other hand, the code appears to work just fine with the incorrect values. I can't say if this change would break code that was tuned to work around these invalid values. I can say that our limited testing (focused on sending IoTHub cloud-to-device messages) passes with this change.
…d instead of 0 based.
I haven't witnessed any bad behavior because of this except for confusing logs, and maybe some unnecessary state transitions.
I found this while investigating a CBS auth failure that turned out to be a problem with our service. I had some momentary confusion because, at one point, the C code called
on_cbs_open_completepassingCBS_OPEN_OK, which the C code has defined as1. Then, insidecbs.pyx, the code assumed that1wasCBS_OPEN_ERROR, so it setself.statetoAUTH_STATE_FAILURE.Fortunately, our service finishes the put_token quickly enough that the CBS operation can complete successfully, so no harm was actually done.
I have mixed feelings about this change. On the one hand, the code is very clearly incorrect, but, on the other hand, the code appears to work just fine with the incorrect values. I can't say if this change would break code that was tuned to work around these invalid values. I can say that our limited testing (focused on sending IoTHub cloud-to-device messages) passes with this change.