research-virtualfortknox / msb-client-websocket-csharp

The c# client library to connect to the websocket interface of the MSB (Manufacturing Service Bus)

MSB websocket client library for C#

Compatibility Matrix

Client version compatibility to MSB versions:

	1.5.x-RELEASE	1.6.x-RELEASE
1.0.x	x	x

Welcome

• If you want to contribute, please read the Contribution Guidelines.

• If you want to test this client, see the sample projects in the samples directory.

• If you want to know how to use this client in your own project, read how to use.

msb-client-websocket-csharp's Issues

Configuration parameters should be saved persistently and loaded after restart

I'm submitting a ...

• bug report
• feature request
• other

Current behavior:

Configuration parameters are lost after the client restarted.

Expected behavior:

Configuration parameters should be saved persistently and loaded after restart.

MSB client version: 1.5.6

MSB server version: 1.5.6-RELEASE

Support Gateway service type

The MSB supports, besides the two service types offered by this project (SmartObject, Application), the service type Gateway. This allows to register a service with sub services managed by it and to handle their communication.

This feature is already supported by the msb-client-websocket-java lib.

Coverage report is not generated for test projects with failing test(s)

I'm submitting a ...

• bug report
• feature request
• other

Current behavior:

If any test fails the wohle test project is not considered in the coverage report and the coverage drops down.

Expected behavior:

Coverage report should be generated even if a test fails.

Steps to reproduce:

Execute tests with coverage with a failing test.

MSB client version: 1.0.0

MSB server version: 1.5.6-RELEASE

Anything else:

Issue in coverlet

Possible solution:
Use coverlet.console to execute tests.

application.properties incomplete in "How To"

Describe the bug
"application.properties" given in the How To (https://github.com/research-virtualfortknox/msb-client-websocket-csharp/blob/master/docs/HOW_TO_USE.md#alternative-1---by-applicationproperties) is incomplete and does not lead to a startable client. The 'msb.url Tag is missing.

To Reproduce
Steps to reproduce the behavior:

1. create a application.properties file with the following content: (Copied from How To)
   msb.uuid=76499d88-34cf-4836-8cc1-7e0d9c54dacx
   msb.name=YourSmartObjectName
   msb.description=YourSmartObjectDesc
   msb.token=5e0d9c54dacx
   msb.type=SmartObject
2. call "ApplicationProperties myApplicationProperties = ApplicationProperties.Read();"
3. an exception is thrown:
   Der angegebene Schlüssel war nicht im Wörterbuch angegeben. bei System.Collections.Generic.Dictionary`2.get_Item(TKey key)
   bei Fraunhofer.IPA.MSB.Client.API.Configuration.ApplicationProperties.Read()

Expected behavior
The How To should lead to a valid client. A better error message (i.e. "Tag 'msb.url' is missing") would have been great, too.

Environment (please complete the following information):

• MSB client version: 1.0.1

Add possibility to send no response event for functions with response events

Is your feature request related to a problem? Please describe.
There is no option to not send an response event when a response event has been definiend for a function.

Describe the solution you'd like
Add EventData which can be returned when no response event should be send.

Convertion Exception, if client uses Int32 as Parameter in a Function

Describe the bug
The call of a function with Int32 parameter on a c# based client seems to crash the client application.

To Reproduce
Steps to reproduce the behavior:

1. Follow the steps from the How To and define a class like the attached one
   MSBFunctionCode.txt
2. create an instance and add it as function handler to the application
3. connect, register and verify the application
4. Call the function via web interface (screenshot further below)
5. The client crashs with exception
   Exception.txt

Expected behavior
No crash, but a successful call.

Screenshots
If applicable, add screenshots to help explain your problem.
Screenshot of used call:

Environment (please complete the following information):

• MSB client version: 1.0.0
• MSB version: don't know (https://gui.msb.343.edu.cell.vfk.fraunhofer.de)

Data format for arrays of primitive types is generated incorrectly

Describe the bug
Data format for arrays of primitive types is generated incorrectly.

[MsbFunctionParameter(Name = "arrayOfPrimitiveType")] int[] arrayOfPrimitiveType

leads to the following data format

"dataFormat":{
  "arrayOfPrimitiveType":{
    "$ref":"#/definitions/Int32"
  },
  "Int32":{
    "type":"array",
    "items":{
      "type":"integer",
      "format":"int32"
    }
  }
}

To Reproduce
Create function with array of primtive type as parameter

Expected behavior
[MsbFunctionParameter(Name = "arrayOfPrimitiveType")] int[] arrayOfPrimitiveType

should generate the following data format:

"dataFormat":{
  "arrayOfPrimitiveType":{
    "type":"array",
    "items":{
      "type":"integer",
      "format":"int32"
    }
  }
}

Environment:

• MSB client version: 1.0.1
• MSB version: 1.5.7-RELEASE

Additional context
Causes System.ArgumentException "An item the same key has already been added..." when two parameters are an array of a primitive type.

Reconnection fails

Describe the bug
Reconnection fails for several hours in a row, while the server is properly working and reachable.

To Reproduce
Steps to reproduce the behavior:

1. Connect the client
2. Disconnect and reconnect network for 15s

Expected behavior
The connection should be re-established at the first reconnect.

Environment (please complete the following information):

• MSB client version v1.0.7
• MSB version 1.6.0-RELEASE

Replace LibLog

LibLog ist deprecated (see Deprecating LibLog #270) and should be replaced by Microsoft.Exentions.Logging.