在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称(OpenSource Name):oliyh/re-graph开源软件地址(OpenSource Url):https://github.com/oliyh/re-graph开源编程语言(OpenSource Language):Clojure 99.3%开源软件介绍(OpenSource Introduction):re-graphre-graph is a graphql client for Clojure and ClojureScript with bindings for re-frame applications. NotesThis library behaves like the popular Apollo client for graphql and as such is compatible with lacinia-pedestal. Features include:
ContentsUsageAdd re-graph to your project's dependencies: This will also pull in If you are only targeting Javascript you do not need either of these libraries. ;; For JDK 11+
[re-graph "x.y.z"]
;; For JDK 10-
[re-graph "x.y.z" :exclusions [re-graph.hato]]
[re-graph.clj-http-gniazdo "x.y.z"]
;; For Javascript only
[re-graph "x.y.z" :exclusions [re-graph.hato]] Vanilla Clojure/ScriptCall the (require '[re-graph.core :as re-graph])
;; initialise re-graph, possibly including configuration options (see below)
(re-graph/init {})
(defn on-thing [{:keys [data errors] :as payload}]
;; do things with data
))
;; start a subscription, with responses sent to the callback-fn provided
(re-graph/subscribe :my-subscription-id ;; this id should uniquely identify this subscription
"{ things { id } }" ;; your graphql query
{:some "variable"} ;; arguments map
on-thing) ;; callback-fn when messages are recieved
;; stop the subscription
(re-graph/unsubscribe :my-subscription-id)
;; perform a query, with the response sent to the callback event provided
(re-graph/query "{ things { id } }" ;; your graphql query
{:some "variable"} ;; arguments map
on-thing) ;; callback event when response is recieved
;; shut re-graph down when finished
(re-graph/destroy) re-frame usersDispatch the (require '[re-graph.core :as re-graph]
'[re-frame.core :as re-frame])
;; initialise re-graph, possibly including configuration options (see below)
(re-frame/dispatch [::re-graph/init {}])
(re-frame/reg-event-db
::on-thing
(fn [db [_ {:keys [data errors] :as payload}]]
;; do things with data e.g. write it into the re-frame database
))
;; start a subscription, with responses sent to the callback event provided
(re-frame/dispatch [::re-graph/subscribe
:my-subscription-id ;; this id should uniquely identify this subscription
"{ things { id } }" ;; your graphql query
{:some "variable"} ;; arguments map
[::on-thing]]) ;; callback event when messages are recieved
;; stop the subscription
(re-frame/dispatch [::re-graph/unsubscribe :my-subscription-id])
;; perform a query, with the response sent to the callback event provided
(re-frame/dispatch [::re-graph/query
:my-query-id ;; unique id for this query
"{ things { id } }" ;; your graphql query
{:some "variable"} ;; arguments map
[::on-thing]]) ;; callback event when response is recieved
;; shut re-graph down when finished
(re-frame/dispatch [::re-graph/destroy]) OptionsOptions can be passed to the init event, with the following possibilities: (re-frame/dispatch
[::re-graph/init
{:ws {:url "wss://foo.io/graphql-ws" ;; override the websocket url (defaults to /graphql-ws, nil to disable)
:sub-protocol "graphql-ws" ;; override the websocket sub-protocol (defaults to "graphql-ws")
:reconnect-timeout 5000 ;; attempt reconnect n milliseconds after disconnect (defaults to 5000, nil to disable)
:resume-subscriptions? true ;; start existing subscriptions again when websocket is reconnected after a disconnect (defaults to true)
:connection-init-payload {} ;; the payload to send in the connection_init message, sent when a websocket connection is made (defaults to {})
:impl {} ;; implementation-specific options (see hato for options, defaults to {}, may be a literal or a function that returns the options)
:supported-operations #{:subscribe ;; declare the operations supported via websocket, defaults to all three
:query ;; if queries/mutations must be done via http set this to #{:subscribe} only
:mutate}
}
:http {:url "http://bar.io/graphql" ;; override the http url (defaults to /graphql)
:impl {} ;; implementation-specific options (see clj-http or hato for options, defaults to {}, may be a literal or a function that returns the options)
:supported-operations #{:query ;; declare the operations supported via http, defaults to :query and :mutate
:mutate}
}
}]) Either Multiple instancesre-graph now supports multiple instances, allowing you to connect to multiple GraphQL services at the same time. All function/event signatures now take an optional instance-name as the first argument to let you address them separately: (require '[re-graph.core :as re-graph])
;; initialise re-graph for service A
(re-graph/init :service-a {:ws-url "wss://a.com/graphql-ws})
;; initialise re-graph for service B
(re-graph/init :service-b {:ws-url "wss://b.net/api/graphql-ws})
(defn on-a-thing [{:keys [data errors] :as payload}]
;; do things with data from service A
))
;; subscribe to service A, events will be sent to the on-a-thing callback
(re-graph/subscribe :service-a ;; the instance-name you want to talk to
:my-subscription-id ;; this id should uniquely identify this subscription for this service
"{ things { a } }"
on-a-thing)
(defn on-b-thing [{:keys [data errors] :as payload}]
;; do things with data from service B
))
;; subscribe to service B, events will be sent to the on-b-thing callback
(re-graph/subscribe :service-b ;; the instance-name you want to talk to
:my-subscription-id
"{ things { b } }"
on-b-thing)
;; stop the subscriptions
(re-graph/unsubscribe :service-a :my-subscription-id)
(re-graph/unsubscribe :service-b :my-subscription-id) AuthenticationThere are several methods of authenticating with the server, with various trade-offs. Most complications relate to the websocket connection from the browser, as the usual method of providing an HeadersThe most conventional way to authenticate is to use HTTP headers on requests to the server and include an authentication token: (re-frame/dispatch
[::re-graph/init
{:ws {:impl {:headers {:Authorization "my-auth-token"}}}
:http {:impl {:headers {:Authorization "my-auth-token"}}}}]) This will work for the following cases:
Note that it will not work for websocket connections from the browser, for which you will have to choose one of the other methods described below. Connection init payloadFor websocket connections, the de-facto Apollo spec defines a (re-frame/dispatch
[::re-graph/init
{:ws {:connection-init-payload {:token "my-auth-token"}}}]) Note that for Hasura, and possibly other Apollo server backed instances, your payload may need to look like CookiesWhen using re-graph within a browser, site cookies are shared between HTTP and WebSocket connection automatically. There's nothing special that needs to be done. When using re-graph with Clojure, however, some configuration is necessary to ensure that the same cookie store is used for both HTTP and WebSocket connections. Before initializing re-graph, create a common HTTP client.
See the hato documentation for all the supported configuration options. When initializing re-graph, configure both the HTTP and WebSocket connections with this client:
In the call, you can provide any supported re-graph or hato options. Be careful though; hato convenience options for the HTTP client will be ignored when using the If you are using lacinia, you probably need to use the Token in query paramYou can put a token in the http and websocket urls and use it to authenticate when handling the request. (re-frame/dispatch
[::re-graph/init
{:http {:url "https://my-server.com/graphql?auth=my-auth-token"}
:ws {:url "wss://my-server.com/graphql-ws?auth=my-auth-token"}}]) Note that query params may be included in the log files of the server. Basic authYou can put basic auth in the http and websocket urls and use it to authenticate when handling the request. (re-frame/dispatch
[::re-graph/init
{:http {:url "https://my-user:[email protected]/graphql"}
:ws {:url "wss://my-user:[email protected]/graphql-ws"}}]) Sub-protocol hackAs mentioned in https://github.com/whatwg/html/issues/3062 it is contentious but possible to smuggle authentication in the websocket sub-protocol, which normally describes the kind of traffic expected over the websocket (the default in re-graph is (re-frame/dispatch
[::re-graph/init
{:ws {:sub-protocol "graphql-ws;my-auth-token"}}]) Re-initialisationWhen initialising re-graph you may have included authorisation tokens e.g. (re-frame/dispatch [::re-graph/init {:http {:url "http://foo.bar/graph-ql"
:impl {:headers {"Authorization" 123}}}
:ws {:connection-init-payload {:token 123}}}]) If those tokens expire you can refresh them using (re-frame/dispatch [::re-graph/re-init {:http {:impl {:headers {"Authorization" 456}}}
:ws {:connection-init-payload {:token 456}}}]) The Development
CLJS tests are available at http://localhost:9500/figwheel-extra-main/auto-testing
You will need to run LicenseCopyright © 2017 oliyh Distributed under the Eclipse Public License either version 1.0 or (at your option) any later version. |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论