improve the subscription life cycle event and add new settings (shurc…

…ooL#82)

* improve the subscription logic and add new settings

.github/workflows/test.yml

@@ -38,7 +38,7 @@ jobs:
           cd ./example/hasura
           docker-compose up -d
       - name: Run Go unit tests
-        run: go test -v -race -coverprofile=coverage.out ./...
+        run: go test -v -race -timeout 3m -coverprofile=coverage.out ./...
       - name: Go coverage format
         run: |
           go get github.com/boumenot/gocover-cobertura

README.md

@@ -585,7 +585,12 @@ client.
 	// max size of response message
 	WithReadLimit(10*1024*1024).
 	// these operation event logs won't be printed
-	WithoutLogTypes(graphql.GQLData, graphql.GQLConnectionKeepAlive)
+	WithoutLogTypes(graphql.GQLData, graphql.GQLConnectionKeepAlive).
+	// the client should exit when all subscriptions were closed, default true
+	WithExitWhenNoSubscription(false).
+	// WithRetryStatusCodes allow retry the subscription connection when receiving one of these codes
+	// the input parameter can be number string or range, e.g 4000-5000 
+	WithRetryStatusCodes("4000", "4000-4050")
 ```
 
 #### Subscription Protocols
@@ -629,6 +634,12 @@ client.OnDisconnected(fn func())
 // If this function is empty, or returns nil, the error is ignored
 // If returns error, the websocket connection will be terminated
 client.OnError(onError func(sc *SubscriptionClient, err error) error)
+
+// OnConnectionAlive event is triggered when the websocket receive a connection alive message (differs per protocol)
+client.OnConnectionAlive(fn func())
+
+// OnSubscriptionComplete event is triggered when the subscription receives a terminated message from the server
+client.OnSubscriptionComplete(fn func(sub Subscription))
 ```
 
 #### Custom HTTP Client

query.go

@@ -88,22 +88,22 @@ func ConstructMutation(v interface{}, variables map[string]interface{}, options
 }
 
 // ConstructSubscription build GraphQL subscription string from struct and variables
-func ConstructSubscription(v interface{}, variables map[string]interface{}, options ...Option) (string, error) {
+func ConstructSubscription(v interface{}, variables map[string]interface{}, options ...Option) (string, string, error) {
 	query, err := query(v)
 	if err != nil {
-		return "", err
+		return "", "", err
 	}
 	optionsOutput, err := constructOptions(options)
 	if err != nil {
-		return "", err
+		return "", "", err
 	}
 	if len(variables) > 0 {
-		return fmt.Sprintf("subscription %s(%s)%s%s", optionsOutput.operationName, queryArguments(variables), optionsOutput.OperationDirectivesString(), query), nil
+		return fmt.Sprintf("subscription %s(%s)%s%s", optionsOutput.operationName, queryArguments(variables), optionsOutput.OperationDirectivesString(), query), optionsOutput.operationName, nil
 	}
 	if optionsOutput.operationName == "" && len(optionsOutput.operationDirectives) == 0 {
-		return "subscription" + query, nil
+		return "subscription" + query, optionsOutput.operationName, nil
 	}
-	return fmt.Sprintf("subscription %s%s%s", optionsOutput.operationName, optionsOutput.OperationDirectivesString(), query), nil
+	return fmt.Sprintf("subscription %s%s%s", optionsOutput.operationName, optionsOutput.OperationDirectivesString(), query), optionsOutput.operationName, nil
 }
 
 // queryArguments constructs a minified arguments string for variables.

query_test.go

@@ -635,11 +635,16 @@ func TestConstructSubscription(t *testing.T) {
 		},
 	}
 	for _, tc := range tests {
-		got, err := ConstructSubscription(tc.inV, tc.inVariables, OperationName(tc.name))
+		got, gotName, err := ConstructSubscription(tc.inV, tc.inVariables, OperationName(tc.name))
 		if err != nil {
 			t.Error(err)
-		} else if got != tc.want {
-			t.Errorf("\ngot:  %q\nwant: %q\n", got, tc.want)
+		} else {
+			if got != tc.want {
+				t.Errorf("\ngot:  %q\nwant: %q\n", got, tc.want)
+			}
+			if gotName != tc.name {
+				t.Errorf("\ninvalid operation name \ngot:  %q\nwant: %q\n", gotName, tc.name)
+			}
 		}
 	}
 }