o ^i.@srdZddlmZddlZddlZddlZddlZddlZddlZddl m Z m Z m Z ddl mZddlmZddlmZddlmZmZmZdd lmZdd lmZmZdd lmZmZdd lm Z d dl!m"Z"m#Z#d dl$m%Z%ddl&m'Z'ej(de)d de*e+ddZ,Gdddee#Z-Gddde Z.Gddde"Z/d dl0m1Z1d dl2m3Z3de1e-fde3e/fgZ4dS) zGateway API handlers.) annotationsN)AnyOptionalcast)Session)web)Future) json_decode url_escapeutf8) HTTPRequest)IOLoopPeriodicCallback)WebSocketHandlerwebsocket_connect)LoggingConfigurable) APIHandlerJupyterHandler) url_path_join) GatewayClientzhThe jupyter_server.gateway.handlers module is deprecated and will not be supported in Jupyter Server 3.0) stacklevelGATEWAY_WS_PING_INTERVAL_SECS30cseZdZdZdZdZdZdZdddZddZ ddZ d d Z d d Z fd dZ ddZddZddZdfdd ZfddZeddZZS)WebSocketChannelsHandlerz$Gateway web socket channels handler.NcCs t||S)zCheck origin for the socket.)r check_origin)selforiginrZ/home/ubuntu/hpml_nyu/venv/lib/python3.10/site-packages/jupyter_server/gateway/handlers.pyr/ z%WebSocketChannelsHandler.check_origincCsdS)zVUndo the set_default_headers in JupyterHandler which doesn't make sense for websocketsNrrrrr set_default_headers3sz,WebSocketChannelsHandler.set_default_headerscCsiS)z+Get the compression options for the socket.rr"rrr get_compression_options6sz0WebSocketChannelsHandler.get_compression_optionscCs\|jdur|jdtd|ddr&|jdusJ|d|j_dS|jddS)zRun before finishing the GET request Extend this method to add logic that should fire before the websocket finishes completing. Nz*Couldn't authenticate WebSocket connectioni session_idzNo session ID specified) current_userlogwarningr HTTPError get_argumentsessionr"rrr authenticate;s    z%WebSocketChannelsHandler.authenticatecCs6|jd|jjt|jd|_tt j d|_ dS)zInitialize the socket.z$Initializing websocket connection %s)config) gateway_urlN) r'debugrequestpathrr-r+GatewayWebSocketClientrinstanceurlgatewayr"rrr initializeLsz#WebSocketChannelsHandler.initializecs4|||_||d<tj|i|IdHdS)zGet the socket. kernel_idN)r,r7supergetrr7argskwargs __class__rr r9Rs zWebSocketChannelsHandler.getcCs0|jdur|jdur|jdS|ddS)zSend a ping to the socket.N) ws_connection ping_callbackstoppingr"rrr send_pingYs z"WebSocketChannelsHandler.send_pingcOsFt|jtd|_|j|jdusJ|jj||j|ddS)z_Handle web socket connection open to notebook server and delegate to gateway web socket handleriN)r7message_callbackcompression_options) rrDrrAstartr5on_open write_messager$r:rrr openas  zWebSocketChannelsHandler.opencCs|jdusJ|j|dS)z.Forward message to gateway web socket handler.N)r5 on_message)rmessagerrr rKmsz#WebSocketChannelsHandler.on_messageFcsb|jrt|tr d}tj||ddS|jtjr/t t t |}|j d|dSdS)zdSend message back to notebook client. This is called via callback from self.gateway._read_messages.T)binaryz?Notebook client closed websocket connection - message dropped: N)r@ isinstancebytesr8rIr' isEnabledForloggingDEBUGr_get_message_summaryr r r/)rrLrM msg_summaryr=rr rIrs z&WebSocketChannelsHandler.write_messagecs8|jd|jj|jdusJ|jtdS)zHandle a closing socket.zClosing websocket connection %sN)r'r/r0r1r5on_closer8r"r=rr rU~s z!WebSocketChannelsHandler.on_closecCsg}|d}|d||dkr|d|ddn |dkr:|d|dd |dd |dd n|d d |S)zGet a summary of a message.msg_typeztype: statusz , state: {}contentexecution_stateerrorz , {}:{}:{}enameevalue tracebackz, ...)appendformatjoin)rLsummary message_typerrr rSs     z-WebSocketChannelsHandler._get_message_summaryN)F)__name__ __module__ __qualname____doc__r+r5r7rArr#r$r,r6r9rDrJrKrIrU staticmethodrS __classcell__rrr=r r's&    rcs`eZdZdZfddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ Z S)r2z;Proxy web socket connection to a kernel/enterprise gateway.c s.td|_d|_t|_d|_d|_dS)z)Initialize the gateway web socket client.NFr)r8__init__r7wsr ws_future disconnectedretry)rr<r=rr rks  zGatewayWebSocketClient.__init__csd_|_t}|jdusJt|j|jt|d}j d|i}|j di|}t |fi|}t dt |_jjt}|jfdddS)zConnect to the socket.NchannelszConnecting to z Future[Any]c Srd)_read_messagesfuturerErrr  z1GatewayWebSocketClient._connect..r)rlr7rr3ws_urlrkernels_endpointr r'infoload_connection_argsr rrrmadd_done_callback_connection_doner current add_future)rr7rEclientrxr<r0looprrur _connects&zGatewayWebSocketClient._connectcCs^|js|dur||_d|_|jd|jdS|jd|jdt j dS)zHandle a finished connection.NrzConnection is ready: ws: z]Websocket connection has been closed via client disconnect or due to error. Kernel with ID 'z*' may not be terminated on GatewayClient: ) rn exceptionresultrlror'r/r(r7rr3r4)rfutrrr r}s  z'GatewayWebSocketClient._connection_donecCsNd|_|jdur|jdS|js%|j|jd|jdSdS)zHandle a disconnect.TNz-_disconnect: future cancelled, disconnected: )rnrlclosermdonecancelr'r/r"rrr _disconnects   z"GatewayWebSocketClient._disconnectc sH|jdurNd}|jsHz |jIdH}Wnty0}z|jd|WYd}~nd}~ww|durC|jsB|jd|jn ||nn|jdus|js|jt j krt ddd}tt jd|jt j|}|jd7_|jd ||jt j |jt|IdHt}||j|j|dSdSdS) z"Read messages from gateway server.Nz*Exception reading message from websocket: zLost connection to Gateway: dg{Gz?rrzKAttempting to re-establish the connection to Gateway in %s secs (%s/%s): %s)rlrn read_message Exceptionr'rZr(r7rorr3gateway_retry_maxrandomrandintmingateway_retry_intervalgateway_retry_interval_maxrzasynciosleepr r~spawn_callbackr)rcallbackrLejitterretry_intervalrrrr rrsT  z%GatewayWebSocketClient._read_messagescKst}||j||dS)z2Web socket connection open against gateway server.N)r r~rr)rr7rEr<rrrr rHszGatewayWebSocketClient.on_opencs<jdurt}|jfdddSdS)Send message to gateway server.Ncrqrd)_write_messagersrLrrr rvrwz3GatewayWebSocketClient.on_message..)rlr r~rrmr)rrLrrrr rK s z!GatewayWebSocketClient.on_messagec Cshz|js|jdur|j|WdSWdSWdSty3}z|jd|WYd}~dSd}~ww)rNz(Exception writing message to websocket: )rnrlrIrr'rZ)rrLrrrr rs  z%GatewayWebSocketClient._write_messagecCs |dS)zWeb socket closed event.N)rr"rrr rUr!zGatewayWebSocketClient.on_close)rerfrgrhrkrr}rrrrHrKrrUrjrrr=r r2s   +r2c@s eZdZdZejdddZdS)GatewayResourceHandlerzWRetrieves resources for specific kernelspec definitions from kernel/enterprise gateway.Tcsfd}|j}|||IdH}|dur!|jd|d|dn t|dp)d}|j||ddS)z(Get a gateway resource by name and path.NzKernelspec resource 'z' for 'z7' not found. Gateway may not support resource serving.rz text/plain)set_content_type)kernel_spec_managerget_kernel_spec_resourcer'r( mimetypes guess_typefinish)r kernel_namer1 include_bodymimetypeksmkernel_spec_resrrr r9"s zGatewayResourceHandler.getN)T)rerfrgrhr authenticatedr9rrrr rsr)_kernel_id_regex)kernel_name_regexz/api/kernels/%s/channelsz/kernelspecs/%s/(?P.*))5rh __future__rrrQrosrwarningstypingrrrjupyter_client.sessionrtornadortornado.concurrentrtornado.escaper r r tornado.httpclientr tornado.ioloopr rtornado.websocketrrtraitlets.config.configurabler base.handlersrrutilsrgateway_clientrwarnDeprecationWarningintgetenvrrr2rservices.kernels.handlersrservices.kernelspecs.handlersrdefault_handlersrrrr sF        u