Hello!
My backend app uses subscriptions-transport-ws protocol for the GraphQL subscriptions.
With this protocol server periodically sends messages with type="ka" (keep-alive messages).
Seems like Tyk does not support this protocol as it issues the following errors:
expected connection_ack, got: ka
Is it possible to add a support of subscriptions-transport-ws protocol?
My API definition:
{
"name": "Subscriptions GraphQL API",
"expiration": "2099-12-31 23:59",
"slug": "",
"listen_port": 0,
"protocol": "",
"enable_proxy_protocol": false,
"api_id": "service-subscriptions",
"org_id": "",
"use_keyless": false,
"use_oauth2": false,
"use_openid": false,
"openid_options": {
"providers": null,
"segregate_by_client": false
},
"oauth_meta": {
"allowed_access_types": null,
"allowed_authorize_types": null,
"auth_login_redirect": ""
},
"auth": {
"name": "",
"use_param": false,
"param_name": "",
"use_cookie": false,
"cookie_name": "",
"disable_header": false,
"auth_header_name": "Authorization",
"use_certificate": false,
"validate_signature": false,
"signature": {
"algorithm": "",
"header": "",
"use_param": false,
"param_name": "",
"secret": "",
"allowed_clock_skew": 0,
"error_code": 0,
"error_message": ""
}
},
"auth_configs": {
"authToken": {
"name": "",
"use_param": false,
"param_name": "",
"use_cookie": false,
"cookie_name": "",
"disable_header": false,
"auth_header_name": "Authorization",
"use_certificate": false,
"validate_signature": false,
"signature": {
"algorithm": "",
"header": "",
"use_param": false,
"param_name": "",
"secret": "",
"allowed_clock_skew": 0,
"error_code": 0,
"error_message": ""
}
}
},
"use_basic_auth": false,
"basic_auth": {
"disable_caching": false,
"cache_ttl": 0,
"extract_from_body": false,
"body_user_regexp": "",
"body_password_regexp": ""
},
"use_mutual_tls_auth": false,
"client_certificates": null,
"upstream_certificates": null,
"pinned_public_keys": null,
"enable_jwt": true,
"use_standard_auth": false,
"use_go_plugin_auth": false,
"enable_coprocess_auth": false,
"jwt_signing_method": "hmac",
"jwt_source": "",
"jwt_identity_base_field": "",
"jwt_client_base_field": "",
"jwt_policy_field_name": "",
"jwt_default_policies": [
"graphql-default"
],
"jwt_issued_at_validation_skew": 0,
"jwt_expires_at_validation_skew": 0,
"jwt_not_before_validation_skew": 0,
"jwt_skip_kid": false,
"scopes": {
"jwt": {
"scope_claim_name": "",
"scope_to_policy": null
},
"oidc": {
"scope_claim_name": "",
"scope_to_policy": null
}
},
"jwt_scope_to_policy_mapping": {},
"jwt_scope_claim_name": "sub",
"notifications": {
"shared_secret": "",
"oauth_on_keychange_url": ""
},
"enable_signature_checking": false,
"hmac_allowed_clock_skew": 0,
"hmac_allowed_algorithms": null,
"request_signing": {
"is_enabled": false,
"secret": "",
"key_id": "",
"algorithm": "",
"header_list": null,
"certificate_id": "",
"signature_header": ""
},
"base_identity_provided_by": "",
"definition": {
"enabled": false,
"name": "",
"default": "",
"location": "",
"key": "",
"strip_path": false,
"strip_versioning_data": false,
"versions": null
},
"version_data": {
"not_versioned": true,
"default_version": "",
"versions": {
"Default": {
"name": "Default",
"expires": "",
"paths": {
"ignored": null,
"white_list": null,
"black_list": null
},
"use_extended_paths": true,
"extended_paths": {},
"global_headers": null,
"global_headers_remove": null,
"global_response_headers": null,
"global_response_headers_remove": null,
"ignore_endpoint_case": false,
"global_size_limit": 0,
"override_target": ""
}
}
},
"uptime_tests": {
"check_list": null,
"config": {
"expire_utime_after": 0,
"service_discovery": {
"use_discovery_service": false,
"query_endpoint": "",
"use_nested_query": false,
"parent_data_path": "",
"data_path": "",
"port_data_path": "",
"target_path": "",
"use_target_list": false,
"cache_timeout": 0,
"endpoint_returns_list": false
},
"recheck_wait": 0
}
},
"proxy": {
"preserve_host_header": false,
"listen_path": "/api/subscriptions",
"target_url": "http://my-service/subscriptions",
"disable_strip_slash": false,
"strip_listen_path": true,
"enable_load_balancing": false,
"target_list": null,
"check_host_against_uptime_tests": false,
"service_discovery": {
"use_discovery_service": false,
"query_endpoint": "",
"use_nested_query": false,
"parent_data_path": "",
"data_path": "",
"port_data_path": "",
"target_path": "",
"use_target_list": false,
"cache_timeout": 0,
"endpoint_returns_list": false
},
"transport": {
"ssl_insecure_skip_verify": false,
"ssl_ciphers": null,
"ssl_min_version": 0,
"ssl_max_version": 0,
"ssl_force_common_name_check": false,
"proxy_url": ""
}
},
"disable_rate_limit": false,
"disable_quota": false,
"cache_options": {
"cache_timeout": 0,
"enable_cache": false,
"cache_all_safe_requests": false,
"cache_response_codes": null,
"enable_upstream_cache_control": false,
"cache_control_ttl_header": "",
"cache_by_headers": null
},
"session_lifetime": 0,
"active": true,
"internal": false,
"auth_provider": {
"name": "",
"storage_engine": "",
"meta": null
},
"session_provider": {
"name": "",
"storage_engine": "",
"meta": null
},
"event_handlers": {
"events": null
},
"enable_batch_request_support": false,
"enable_ip_whitelisting": false,
"allowed_ips": null,
"enable_ip_blacklisting": false,
"blacklisted_ips": null,
"dont_set_quota_on_create": false,
"expire_analytics_after": 0,
"response_processors": null,
"CORS": {
"enable": true,
"allowed_origins": [
"*"
],
"allowed_methods": [
"POST"
],
"allowed_headers": [
"Origin",
"Content-Type",
"Accept",
"Authorization"
],
"exposed_headers": [],
"allow_credentials": false,
"max_age": 3600,
"options_passthrough": false,
"debug": false
},
"domain": "",
"certificates": null,
"do_not_track": false,
"tags": null,
"enable_context_vars": false,
"config_data": null,
"tag_headers": null,
"global_rate_limit": {
"rate": 0,
"per": 0
},
"strip_auth_data": false,
"enable_detailed_recording": false,
"graphql": {
"schema": "type Subscription { mySubscription: String! }",
"enabled": true,
"engine": {
"field_configs": [],
"data_sources": []
},
"type_field_configurations": [],
"execution_mode": "proxyOnly",
"proxy": {
"auth_headers": {
"Authorization": "{{.request.headers.Authorization}}"
}
},
"subgraph": {
"sdl": ""
},
"playground": {
"enabled": true,
"path": "/playground"
},
"last_schema_update": "2022-03-11T16:08:13.774Z"
}
}
tyk.conf:
{
"listen_port": 8080,
"secret": "a secret",
"template_path": "/opt/tyk-gateway/templates",
"tyk_js_path": "/opt/tyk-gateway/js/tyk.js",
"middleware_path": "/opt/tyk-gateway/middleware",
"use_db_app_configs": false,
"app_path": "/opt/tyk-gateway/apps/",
"storage": {
"type": "redis",
"host": "redis",
"port": 6379,
"username": "",
"password": "",
"database": 0,
"optimisation_max_idle": 2000,
"optimisation_max_active": 4000
},
"enable_analytics": false,
"analytics_config": {
"type": "csv",
"csv_dir": "/tmp",
"mongo_url": "",
"mongo_db_name": "",
"mongo_collection": "",
"purge_delay": -1,
"ignored_ips": []
},
"health_check": {
"enable_health_checks": false
},
"optimisations_use_async_session_write": true,
"enable_non_transactional_rate_limiter": true,
"enable_sentinel_rate_limiter": false,
"enable_redis_rolling_limiter": false,
"allow_master_keys": false,
"policies": {
"policy_source": "mongo",
"policy_path": "/opt/tyk-gateway/policies"
},
"hash_keys": true,
"close_connections": false,
"http_server_options": {
"enable_websockets": true
},
"allow_insecure_configs": false,
"coprocess_options": {
"enable_coprocess": true,
"python_path_prefix": "/opt/tyk-gateway",
"coprocess_grpc_server": ""
},
"enable_bundle_downloader": true,
"bundle_base_url": "http://tyk-gateway-mw-bundles/",
"global_session_lifetime": 100,
"force_global_session_lifetime": false,
"max_idle_connections_per_host": 500,
"control_api_port": 8081
}
Tyk OSS v4.1.0-rc18