Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

StimulusReflex introduces adapters - refactor accordingly. #15

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 76 additions & 63 deletions javascript/stimulus-websocket/index.js
Original file line number Diff line number Diff line change
@@ -1,30 +1,7 @@
import StimulusReflex from "stimulus_reflex"
import ReconnectingWebSocket from "reconnecting-websocket"
import CableReady from "cable_ready"

// read up on the default options that actioncable has for websockets.

const options = {
maxRetries: 3,
debug: true
}

function createWebSocketURL(url) {
if (typeof url === "function") {
url = url()
}

if (url && !/^wss?:/i.test(url)) {
const a = document.createElement("a")
a.href = url
// Fix populating Location properties in IE. Otherwise, protocol will be blank.
a.href = a.href
a.protocol = a.protocol.replace("http", "ws")
return a.href
} else {
return url
}
}

const extend = function(object, properties) {
if (properties != null) {
for (let key in properties) {
Expand Down Expand Up @@ -80,47 +57,83 @@ class Subscriptions {
}
}

export default class WebsocketConsumer {
constructor(url) {
this._url = url
this.subscriptions = new Subscriptions(this)

this.connection = new ReconnectingWebSocket(url, [], options)
this.connection.isOpen = function open() {
return this.readyState === ReconnectingWebSocket.OPEN;
}

this.connection.addEventListener("message", (event) => {
let data = JSON.parse(event.data)
if (!data.cableReady) return
if (!data.operations.morph || !data.operations.morph.length) return
const urls = Array.from(
new Set(data.operations.morph.map(m => m.stimulusReflex.url))
)
if (urls.length !== 1 || urls[0] !== (location.href)) return
CableReady.perform(data.operations)
})

this.connection.addEventListener("message", (event) => {
let data = JSON.parse(event.data)
if (data.meta_type !== 'cookie') return
document.cookie = `${data.key}=${data.value||""}; max-age=${data.max_age}; path=/`;
})
}

get url() {
return createWebSocketURL(this._url)
}
class Consumer {
constructor(url, options) {
this.connection = new ReconnectingWebSocket(url, [], options || {})
this.subscriptions = new Subscriptions(this)
}

send(data) {
return this.connection.send(JSON.stringify(data))
}
send(data) {
this.connection.send(data)
}
}

connect() {
return this.connection.open()
}
const getConsumer = (url) => {
// read up on the default options that actioncable has for websockets.
let options = {
maxRetries: 3,
debug: true
}

disconnect() {
return this.connection.close()
}
return new Consumer(url, options)
}

const AbstractConsumerAdapter = StimulusReflex.getAbstractClass()

class WebsocketConsumer extends AbstractConsumerAdapter{
constructor(consumer) {
super(consumer)

this.consumer.connection.addEventListener("message", (event) => {
let data = JSON.parse(event.data)
if (!data.cableReady) return
if (!data.operations.morph || !data.operations.morph.length) return

const urls = Array.from(
new Set(data.operations.morph.map(m => m.stimulusReflex.url))
)

if (urls.length !== 1 || urls[0] !== (location.href)) return
CableReady.perform(data.operations)
})

this.consumer.connection.addEventListener("message", (event) => {
let data = JSON.parse(event.data)
if (data.meta_type !== "cookie") return
document.cookie = `${data.key}=${data.value||""}; max-age=${data.max_age}; path=/`
})
}

find_subscription(identifier) {
return this.consumer.subscriptions.findAll(identifier)[0]
}

create_subscription(channel) {
this.consumer.subscriptions.create(channel)
}

connect() {
return this.consumer.connection.open()
}

disconnect() {
return this.consumer.connection.close()
}

isConnected() {
return this.consumer.connection.readyState == ReconnectingWebSocket.OPEN
}

send(identifier, data, options) {
let subscription = this.find_subscription(identifier)
subscription.send(JSON.stringify(data))
// return this.consumer.connection.send(JSON.stringify(data))
}

}

export {
WebsocketConsumer,
getConsumer
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@
"rollup-plugin-babel": "^4.4.0",
"rollup-plugin-terser": "^5.3.0",
"stimulus": ">=1.1",
"stimulus_reflex": ">=3.1.4",
"webpack": "^4.43.0",
"webpack-bundle-analyzer": "^3.7.0",
"webpack-cli": "^3.3.11"
},
"dependencies": {
"stimulus_reflex": "file:./stimulus_reflex/javascript",
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this would need to get changed.

"reconnecting-websocket": "^4.4.0",
"cable_ready": ">=4.0"
},
Expand Down
11 changes: 6 additions & 5 deletions tests/example/javascript/example.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
import { Application } from 'stimulus'
import StimulusReflex from 'stimulus_reflex'
import { Application } from "stimulus"
import StimulusReflex from "stimulus_reflex"
// because travis had issues with 'sockpuppet-js' we had to do this.
import WebsocketConsumer from '../../../javascript/stimulus-websocket/index'
import ExampleController from './controllers/example_controller'
import { WebsocketConsumer, getConsumer } from "../../../javascript/stimulus-websocket/index"
import ExampleController from "./controllers/example_controller"

const application = Application.start()
const consumer = new WebsocketConsumer('ws://localhost:8000/ws/sockpuppet-sync')
const realConsumer = getConsumer("ws://localhost:8000/ws/sockpuppet-sync")
const consumer = new WebsocketConsumer(realConsumer)

application.register("example", ExampleController)
StimulusReflex.initialize(application, { consumer })
3 changes: 3 additions & 0 deletions webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ module.exports = function(env, argv) {
path: __dirname + '/jsdist/js',
filename: '[name].js'
},
optimization: {
minimize: false
},
plugins: []
}

Expand Down