Exposing ErrorCode API in Tree bindings

[imskr]

Exposing our DS_ErrorCodeToErrorMessage API to our tree bindings

Closes #2773

[community-tc-integration]

No Taskcluster jobs started for this pull request

The `allowPullRequests` configuration for this repository (in `.taskcluster.yml` on the
default branch) does not allow starting tasks for this pull request.

[imskr]

@kdavis-mozilla @reuben Am I doing the right way?

[imskr]

For .NET in nativeimp.cs do i add this for DS_ErrorCodeToErrorMessage?

[DllImport("libdeepspeech.so", CallingConvention = CallingConvention.Cdecl)]
        internal unsafe static extern ErrorCodes DS_ErrorCodeToErrorMessage(int aErrorCode,
                   ref IntPtr** pint);

[carlfm01]

@imskr
Should be something like :

[DllImport("libdeepspeech.so", CallingConvention = CallingConvention.Cdecl)]
        internal unsafe static extern IntPtr DS_ErrorCodeToErrorMessage(int aErrorCode);

then when you call DS_ErrorCodeToErrorMessage :

return DS_ErrorCodeToErrorMessage(erroCode).IntPtrToString();

[imskr]

@carlfm01 @reuben Please review!

[imskr]

@lissyx Thanks I will make the changes.

[lissyx]

@imskr I'm not sure we should do that in this bug or file a followup to address, but once this is live, we might want to take the opportunity to update all docs references of "return zero on success non-zero on failure" to refer to error code structure.

[imskr]

Yes. I think we can make the necessary changes and for docs make another PR maybe.

[imskr]

@lissyx Where should I make changes for the doc? And should I open new PR for the doc?

[lissyx]

@lissyx Where should I make changes for the doc? And should I open new PR for the doc?

Which doc changes ?

Those ?:

@imskr I'm not sure we should do that in this bug or file a followup to address, but once this is live, we might want to take the opportunity to update all docs references of "return zero on success non-zero on failure" to refer to error code structure.

[imskr]

@lissyx Where should I make changes for the doc? And should I open new PR for the doc?

Which doc changes ?

Those ?:

@imskr I'm not sure we should do that in this bug or file a followup to address, but once this is live, we might want to take the opportunity to update all docs references of "return zero on success non-zero on failure" to refer to error code structure.

Yes

[imskr]

@carlfm01 Is it good now?

[carlfm01]

LGTM, thanks!

[imskr]

@lissyx Where should I make changes for the doc? And should I open new PR for the doc?

Which doc changes ?
Those ?:

@imskr I'm not sure we should do that in this bug or file a followup to address, but once this is live, we might want to take the opportunity to update all docs references of "return zero on success non-zero on failure" to refer to error code structure.

Yes

@lissyx Doc updation?

[lissyx]

@lissyx Where should I make changes for the doc? And should I open new PR for the doc?

Which doc changes ?
Those ?:

@imskr I'm not sure we should do that in this bug or file a followup to address, but once this is live, we might want to take the opportunity to update all docs references of "return zero on success non-zero on failure" to refer to error code structure.

Yes

@lissyx Doc updation?

Sorry but I still dont know what you are referring to. Please be precise, there are many context-dependant discussions around doc her.

[imskr]

@lissyx sorry for the confusion. You mentioned earlier to update all docs references of "return zero on success non-zero on failure" to refer to error code structure. So this PR is good according to the issue. I was asking should I create new PR for docs reference?

[lissyx]

@lissyx sorry for the confusion. You mentioned earlier to update all docs references of "return zero on success non-zero on failure" to refer to error code structure. So this PR is good according to the issue. I was asking should I create new PR for docs reference?

Yes, please.

[imskr]

@lissyx docs where I will make changes are in doc directory right?

[lissyx]

@lissyx docs where I will make changes are in doc directory right?

Yeah, but you might want to verify everywhere, just in case.

[lissyx]

@imskr Please have a look at the Community-TC task group, there are Windows builds failures such as: https://community-tc.services.mozilla.com/tasks/RHRIhwl4R4aL6w_hnG_LAw/runs/0/logs/https%3A%2F%2Fcommunity-tc.services.mozilla.com%2Fapi%2Fqueue%2Fv1%2Ftask%2FRHRIhwl4R4aL6w_hnG_LAw%2Fruns%2F0%2Fartifacts%2Fpublic%2Flogs%2Flive.log#L7776

[lissyx]

DeepSpeech.cs(94,82): error CS1503: Argument 1: cannot convert from 'DeepSpeechClient.Enums.ErrorCodes' to 'int' [C:\builds\tc-workdir\DeepSpeech\ds\native_client\dotnet\DeepSpeechClient\DeepSpeechClient.csproj]

[lissyx]

There's also a warning:

  DeepSpeech.cs(114,20): warning CS0219: The variable 'exceptionMessage' is assigned but its value is never used [C:\builds\tc-workdir\DeepSpeech\ds\native_client\dotnet\DeepSpeechClient\DeepSpeechClient.csproj]

[imskr]

@lissyx Should I delete line causing warning DeepSpeech.cs(114,20): warning CS0219: The variable 'exceptionMessage' is assigned but its value is never used [C:\builds\tc-workdir\DeepSpeech\ds\native_client\dotnet\DeepSpeechClient\DeepSpeechClient.csproj] ?

I think we can ignore this warning

[lissyx]

@lissyx Should I delete line causing warning DeepSpeech.cs(114,20): warning CS0219: The variable 'exceptionMessage' is assigned but its value is never used [C:\builds\tc-workdir\DeepSpeech\ds\native_client\dotnet\DeepSpeechClient\DeepSpeechClient.csproj] ?

I think we can ignore this warning

That'd be my guess, but @carlfm01 is the real source of truth here.

[imskr]

@lissyx For warning DeepSpeech.cs(94,82): error CS1503: Argument 1: cannot convert from 'DeepSpeechClient.Enums.ErrorCodes' to 'int' [C:\builds\tc-workdir\DeepSpeech\ds\native_client\dotnet\DeepSpeechClient\DeepSpeechClient.csproj]

I think we are converting it to NativeImp.DS_ErrorCodeToErrorMessage(resultCode).IntPtrToString()

[imskr]

@carlfm01 How should I get rid of that error?

[carlfm01]

@lissyx Should I delete line causing warning DeepSpeech.cs(114,20): warning CS0219: The variable 'exceptionMessage' is assigned but its value is never used [C:\builds\tc-workdir\DeepSpeech\ds\native_client\dotnet\DeepSpeechClient\DeepSpeechClient.csproj] ?
I think we can ignore this warning

That'd be my guess, but @carlfm01 is the real source of truth here.

Yes, this is no longer required.

And to convert Enums into ints please use (int)errorCodes. https://stackoverflow.com/questions/943398/get-int-value-from-enum-in-c-sharp

Please debug and make sure that the parsed errorCode is still the desired.

[reuben]

Thanks!

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.