Feature - Add option to select transport type #53

Saaka · 2017-05-16T23:55:07Z

Add option to select transport type: specify one transport or ordered fallback list.

HNeukermans

Awesome PR. @Saaka.
Valueable feature you have added there.
I've carefully reviewed you code.
If you can fix the remarks I've made I will be very happy to merge it in :-)

HNeukermans · 2017-05-17T06:38:59Z

src/services/signalr.ts

@@ -25,13 +25,15 @@ export class SignalR {
            let configuration = this.merge(options ? options : {});

            try {
-                let serialized = JSON.stringify(configuration.qs);
+                let serializedQs = JSON.stringify(configuration.qs);
+                let serializedTransport = JSON.stringify(configuration.transport);


no need to serialize since it is just a string

It is serialized, because it is string or array of strings.

HNeukermans · 2017-05-17T06:38:59Z

src/services/signalr.ts


                if (configuration.logging) {
                    console.log(`Connecting with...`);
                    console.log(`configuration:[url: '${configuration.url}'] ...`);
                    console.log(`configuration:[hubName: '${configuration.hubName}'] ...`);
-                    console.log(`configuration:[qs: '${serialized}'] ...`);
+                    console.log(`configuration:[qs: '${serializedQs}'] ...`);
+                    console.log(`configuration:[transport: '${serializedTransport}'] ...`);


you can change this to console.log(configuration:[transport: '${configuration.transport}'] ...); ?

HNeukermans · 2017-05-17T06:38:59Z

src/services/signalr.configuration.ts

@@ -19,13 +19,17 @@ export class SignalRConfiguration {
     /** Allows withCredentials. This flag can be used to suppport CORS */
    public withCredentials: boolean;

+    /**Allows you to specify transport. You can specify a fallback order if you wan't to try specific transports in order. */
+    public transport?: any;


Is this of type string? array of strings? Can you explain the possible values you are expecting

This is either a string or array of strings. I can change it to array of TransportConnection objects, and change it to string or array of strings before passing it to connect function. This way user wont be able to pass invalid parameters.

@Saaka
great idea. great minds think alike :-)
make it ConnectionTransport[] then , agree?

HNeukermans · 2017-05-17T06:38:59Z

src/services/connection/connection.transport.ts

@@ -0,0 +1,6 @@
+export class ConnectionTransport {


Could you design your ConnectionTransport as a 'value' object. You can use ConnectionStatus/ConnectionStatuses as a example. I use this design because signalr connection status is basically a string that has only limited range of values. This design prevents the api user from filling in something random

Also make sure to test your ConnectionTransports & Connectiontransport object. You can use
connection.statuses.spec.ts & connection.status.spec.ts as an example.

HNeukermans · 2017-05-17T06:38:59Z

tests/services/signalr.configuration.spec.ts

@@ -8,6 +8,7 @@ describe('SignalRConfiguration', () => {
        expect(configuration.hubName).toBe(null);
        expect(configuration.qs).toBe(null);
        expect(configuration.url).toBe(null);
+        expect(configuration.transport).toBe(null, 'transport should be null');


then make this an empty array instead of null

HNeukermans · 2017-05-17T06:38:59Z

src/services/connection/connection.options.ts

@@ -14,4 +14,7 @@ export interface IConnectionOptions {

    /** Allows withCredentials */
    withCredentials?: boolean;
+
+    /**Allows you to specify transport. You can specify a fallback order if you wan't to try specific transports in order. */


to keep linter happy please a space:
instead of /**XXXX do /** XXX

HNeukermans

Nice works @Saaka,

Keep in mind to create these files:
TransportConnection.ts equivalent to ConnectionStatus
TransportConnections.ts equivalent to ConnectionStatuses
TransportConnection.spec.ts equivalent to ConnectionStatus.spec.ts
TransportConnections.spec.ts equivalent to ConnectionStatuses.spec.ts

Let me know if thing are unclear.

HNeukermans · 2017-05-17T13:51:22Z

src/services/signalr.configuration.ts

    constructor() {
       this.hubName = null;
       this.logging = false;
       this.qs  = null;
       this.url = null;
       this.jsonp = false;
       this.withCredentials = false;
+       this.transport = null;


this.transport = [];

HNeukermans · 2017-05-17T13:51:22Z

README.md


 // <= v1.0.9
 const config = new SignalRConfiguration();
 config.hubName = 'Ng2SignalRHub';  //default
 config.qs = { user: 'donald' };
 config.url = 'http://ng2-signalr-backend.azurewebsites.net/';
+// Specify one Transport: config.transport = ConnectionTransport.LONG_POLLING; or fallback options with order like below.
+config.transport = [ConnectionTransport.WEB_SOCKETS, ConnectionTransport.LONG_POLLING];


can you makes this config.transport = [ConnectionTransports.webSockets, ConnectionTransports.longPolling]

HNeukermans · 2017-05-17T13:51:22Z

src/services/signalr.ts

@@ -65,6 +65,17 @@ export class SignalR {

        return $promise;
    }
+
+	private getConnectionStartParams(withCredentials: boolean, jsonp: boolean, transport: any) : any {


let jTransports = convertTransports(configuration.transports);

jConnection.start({ withCredentials: configuration.withCredentials, jsonp: configuration.jsonp, transport: jTransports })

convertTransports(Transports ) {
return transports.map((t) => t.name); ...
}

Saaka · 2017-05-17T22:07:50Z

I have made transport as follows:
public transport: ConnectionTransport | ConnectionTransport[];
I did not like it to be array, because even if you want to specify one, you still need array. I also made change to the default value based on the jquery lib. Now it defaults to "auto", same as in base library.

HNeukermans · 2017-05-18T07:03:34Z

allright @Saaka,
you are a Pro !! :-)
I will do a git clone of your repo, run the unit test & do some E2E tests and then merge the PR, if everything is ok.

Saaka added 2 commits May 16, 2017

Feature - Add option to select transport type.

9beb52b

Feature - Add option to select transport type. Check transport for null.

Loading status checks…

4dd316d

HNeukermans reviewed May 17, 2017

View changes

Feature - Add option to select transport type - pull request fixes.

Loading status checks…

a75e066

HNeukermans merged commit 4c30691 into HNeukermans:master May 21, 2017
1 check passed

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

HNeukermans / ng2-signalr

Feature - Add option to select transport type #53

Feature - Add option to select transport type #53

Saaka commented May 16, 2017

HNeukermans left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

HNeukermans left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Saaka commented May 17, 2017 •

edited

HNeukermans commented May 18, 2017 •

edited

HNeukermans / ng2-signalr

Feature - Add option to select transport type #53

Feature - Add option to select transport type #53

Conversation

Saaka commented May 16, 2017

HNeukermans left a comment

This comment has been minimized.

HNeukermans May 17, 2017 Owner

This comment has been minimized.

Saaka May 17, 2017 Author Contributor

This comment has been minimized.

HNeukermans May 17, 2017 Owner

This comment has been minimized.

HNeukermans May 17, 2017 Owner

This comment has been minimized.

Saaka May 17, 2017 Author Contributor

This comment has been minimized.

HNeukermans May 17, 2017 • edited Owner

This comment has been minimized.

HNeukermans May 17, 2017 Owner

This comment has been minimized.

HNeukermans May 17, 2017 Owner

This comment has been minimized.

HNeukermans May 17, 2017 Owner

This comment has been minimized.

HNeukermans May 17, 2017 Owner

This comment has been minimized.

HNeukermans May 17, 2017 Owner

HNeukermans left a comment

This comment has been minimized.

HNeukermans May 17, 2017 Owner

This comment has been minimized.

HNeukermans May 17, 2017 Owner

This comment has been minimized.

HNeukermans May 17, 2017 Owner

Saaka commented May 17, 2017 • edited

HNeukermans commented May 18, 2017 • edited

HNeukermans May 17, 2017
Owner

Saaka May 17, 2017
Author Contributor

HNeukermans May 17, 2017
Owner

HNeukermans May 17, 2017
Owner

Saaka May 17, 2017
Author Contributor

HNeukermans May 17, 2017 •

edited

Owner

HNeukermans May 17, 2017
Owner

HNeukermans May 17, 2017
Owner

HNeukermans May 17, 2017
Owner

HNeukermans May 17, 2017
Owner

HNeukermans May 17, 2017
Owner

HNeukermans May 17, 2017
Owner

HNeukermans May 17, 2017
Owner

HNeukermans May 17, 2017
Owner

Saaka commented May 17, 2017 •

edited

HNeukermans commented May 18, 2017 •

edited