https://github.com/aj-foster/absinthe-socket-transport

NetworkTransport implementation for using Phoenix + Absinthe with Apollo's Swift library
https://github.com/aj-foster/absinthe-socket-transport

absinthe apollo elixir phoenix swift

Last synced: 24 days ago
JSON representation

NetworkTransport implementation for using Phoenix + Absinthe with Apollo's Swift library

• Host: GitHub
• URL: https://github.com/aj-foster/absinthe-socket-transport
• Owner: aj-foster
• License: mit
• Created: 2021-02-20T08:16:52.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-12-14T05:15:41.000Z (about 3 years ago)
• Last Synced: 2024-05-02T06:16:22.884Z (8 months ago)
• Topics: absinthe, apollo, elixir, phoenix, swift
• Language: Swift
• Homepage:
• Size: 31.3 KB
• Stars: 6
• Watchers: 4
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Absinthe Socket Transport

A `NetworkTransport` implementation for using Phoenix + Absinthe with Apollo's Swift library.

**Warning**: This library is experimental, and developed by a _beginner_ in Swift. Contributions are welcome.

---

### When would you use this package?

* You use the [Absinthe](https://github.com/absinthe-graphql/absinthe) GraphQL implementation for the [Elixir](https://elixir-lang.org/) language

* You expose Absinthe in a [Phoenix](https://phoenixframework.org/) app using [Absinthe.Phoenix](https://github.com/absinthe-graphql/absinthe_phoenix)

* You use websockets (via Phoenix channels) to run GraphQL subscriptions (and optionally regular queries + mutations)

* You wish to connect to this GraphQL server from a Swift application using [Apollo iOS](https://github.com/apollographql/apollo-ios) (which also serves macOS, etc.)

The Apollo iOS library uses `NetworkTransport`s to implement sending/receiving GraphQL operations. This package provides `AbsintheSocketTransport`, an implementation of `NetworkTransport` that communicates via websockets in a Phoenix/Absinthe-friendly way. Use this library if you would prefer not to modify the server using something like [absinthe_apollo_sockets](https://github.com/easco/absinthe_apollo_sockets).

---

### Installation

This package was created using Swift Package Manager. If you require the use of a different package manager, please help me to implement any requirements.

```

.package(url: "https://github.com/aj-foster/absinthe-socket-transport.git", .upToNextMinor(from: "0.0.1"))

```

Note that this package has fairly strict version dependencies on `SwiftPhoenixClient` and `Apollo`. If you require the use of different versions, please help me to test those packages.

### Usage

To use this package, add the following import statement:

```swift

import AbsintheSocketTransport

```

Then, use the `AbsintheSocketTransport` class as a `NetworkTransport` when setting up the client:

```swift

let transport = AbsintheSocketTransport(endpoint, params: ["token": token])

let client = ApolloClient(networkTransport: transport, store: ApolloStore.init())

```

Although untested, this transport might also work as part of a `SplitNetworkTransport`.

For debugging purposes, you can enable a printout of all socket messages (including keepalives):

```swift

transport.enableDebug()

```

### Contributing

As noted above, contributions are welcome. If you propose code changes, please help by also explaining any relevant best practices and including links to documentation where appropriate. For more information, please see [the contribution guidelines](CONTRIBUTING.md).