Compare commits

..

1 Commits

Author SHA1 Message Date
Kevin Jahns
47bcec8bc7 Deploy v11.2.6 (hot fix for #54) 2016-09-28 13:33:50 +02:00
11 changed files with 215 additions and 208 deletions

View File

@@ -43,7 +43,9 @@ Y({
// call drawLine every time an array is appended // call drawLine every time an array is appended
y.share.drawing.observe(function (event) { y.share.drawing.observe(function (event) {
if (event.type === 'insert') { if (event.type === 'insert') {
event.values.forEach(drawLine) event.values().then(function (values) {
values.forEach(drawLine)
})
} else { } else {
// just remove all elements (thats what we do anyway) // just remove all elements (thats what we do anyway)
svg.selectAll('path').remove() svg.selectAll('path').remove()
@@ -51,7 +53,7 @@ Y({
}) })
// draw all existing content // draw all existing content
for (var i = 0; i < drawing.length; i++) { for (var i = 0; i < drawing.length; i++) {
drawLine(drawing.get(i)) drawing.get(i).then(drawLine)
} }
// clear canvas on request // clear canvas on request
@@ -62,7 +64,9 @@ Y({
var sharedLine = null var sharedLine = null
function dragstart () { function dragstart () {
drawing.insert(drawing.length, [Y.Array]) drawing.insert(drawing.length, [Y.Array])
sharedLine = drawing.get(drawing.length - 1) drawing.get(drawing.length - 1).then(function (array) {
sharedLine = array
})
} }
// After one dragged event is recognized, we ignore them for 33ms. // After one dragged event is recognized, we ignore them for 33ms.

View File

@@ -1,9 +1,7 @@
<!DOCTYPE html> <!DOCTYPE html>
<html> <html>
<head> <head>
<!-- quill does not include dist files! We are using the hosted version instead --> <link rel="stylesheet" href="../bower_components/quill/dist/quill.snow.css" />
<!--link rel="stylesheet" href="../bower_components/quill/dist/quill.snow.css" /-->
<link href="https://cdn.quilljs.com/1.0.4/quill.snow.css" rel="stylesheet">
<link href="//cdnjs.cloudflare.com/ajax/libs/KaTeX/0.5.1/katex.min.css" rel="stylesheet"> <link href="//cdnjs.cloudflare.com/ajax/libs/KaTeX/0.5.1/katex.min.css" rel="stylesheet">
<link href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.2.0/styles/monokai-sublime.min.css" rel="stylesheet"> <link href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.2.0/styles/monokai-sublime.min.css" rel="stylesheet">
<style> <style>
@@ -19,12 +17,10 @@
</div> </div>
</div> </div>
<!-- Include the Quill library -->
<script src="//cdnjs.cloudflare.com/ajax/libs/KaTeX/0.5.1/katex.min.js" type="text/javascript"></script> <script src="//cdnjs.cloudflare.com/ajax/libs/KaTeX/0.5.1/katex.min.js" type="text/javascript"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.2.0/highlight.min.js" type="text/javascript"></script> <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.2.0/highlight.min.js" type="text/javascript"></script>
<script src="https://cdn.quilljs.com/1.0.4/quill.js"></script>
<!-- quill does not include dist files! We are using the hosted version instead (see above)
<script src="../bower_components/quill/dist/quill.js"></script> <script src="../bower_components/quill/dist/quill.js"></script>
-->
<script src="../bower_components/yjs/y.es6"></script> <script src="../bower_components/yjs/y.es6"></script>
<script src="./index.js"></script> <script src="./index.js"></script>
</body> </body>

View File

@@ -7,8 +7,8 @@ Y({
name: 'memory' name: 'memory'
}, },
connector: { connector: {
name: 'websockets-client', name: 'webrtc',
room: 'richtext-example-quill-1.0' room: 'richtext-example-quill-beta'
}, },
sourceDir: '/bower_components', sourceDir: '/bower_components',
share: { share: {

View File

@@ -16,6 +16,8 @@ Y({
}).then(function (y) { }).then(function (y) {
window.yXml = y window.yXml = y
// bind xml type to a dom, and put it in body // bind xml type to a dom, and put it in body
window.sharedDom = y.share.xml.getDom() y.share.xml.getDom().then(function (dom) {
document.body.appendChild(window.sharedDom) window.sharedDom = dom
document.body.appendChild(dom)
})
}) })

View File

@@ -19,7 +19,7 @@
"y-text": "latest", "y-text": "latest",
"y-indexeddb": "latest", "y-indexeddb": "latest",
"y-xml": "latest", "y-xml": "latest",
"quill": "^1.0.0-rc.2", "quill": "~0.20.1",
"ace": "~1.2.3", "ace": "~1.2.3",
"ace-builds": "~1.2.3", "ace-builds": "~1.2.3",
"jquery": "~2.2.2", "jquery": "~2.2.2",

189
README.md
View File

@@ -1,124 +1,98 @@
# ![Yjs](http://y-js.org/images/yjs.png) # ![Yjs](http://y-js.org/images/yjs.png)
Yjs is a framework for p2p shared editing on structured data like (rich-)text, json, and XML. Yjs is a framework for optimistic concurrency control and automatic conflict resolution on shared data.
It is similar to [ShareJs] and [OpenCoweb], but easy to use. The framework provides similar functionality as [ShareJs] and [OpenCoweb], but supports peer-to-peer
For additional information, demos, and tutorials visit [y-js.org](http://y-js.org/). communication protocols by default. Yjs was designed to handle concurrent actions on arbitrary data
like Text, Json, and XML. We also provide support for storing and manipulating your shared data offline.
For more information and demo applications visit our [homepage](http://y-js.org/).
### Extensions You can create you own shared types easily.
Yjs only knows how to resolve conflicts on shared data. You have to choose a .. Therefore, you can design the structure of your custom type,
* *Connector* - a communication protocol that propagates changes to the clients and ensure data validity, while Yjs ensures data consistency (everyone will eventually end up with the same data).
* *Database* - a database to store your changes We already provide abstract data types for
* one or more *Types* - that represent the shared data
Connectors, Databases, and Types are available as modules that extend Yjs. Here is a list of the modules we know of:
##### Connectors
|Name | Description |
|----------------|-----------------------------------|
|[webrtc](https://github.com/y-js/y-webrtc) | Propagate updates Browser2Browser via WebRTC|
|[websockets](https://github.com/y-js/y-websockets-client) | Set up [a central server](https://github.com/y-js/y-websockets-client), and connect to it via websockets |
|[xmpp](https://github.com/y-js/y-xmpp) | Propagate updates in a XMPP multi-user-chat room ([XEP-0045](http://xmpp.org/extensions/xep-0045.html))|
|[test](https://github.com/y-js/y-test) | A Connector for testing purposes. It is designed to simulate delays that happen in worst case scenarios|
##### Database adapters
|Name | Description |
|----------------|-----------------------------------|
|[memory](https://github.com/y-js/y-memory) | In-memory storage. |
|[indexeddb](https://github.com/y-js/y-indexeddb) | Offline storage for the browser |
|[leveldb](https://github.com/y-js/y-leveldb) | Persistent storage for node apps |
##### Types
| Name | Description | | Name | Description |
|----------|-------------------| |----------|-------------------|
|[map](https://github.com/y-js/y-map) | A shared Map implementation. Maps from text to any stringify-able object | |[map](https://github.com/y-js/y-map) | A shared Map implementation. Maps from text to any stringify-able object |
|[array](https://github.com/y-js/y-array) | A shared Array implementation | |[array](https://github.com/y-js/y-array) | A shared Array implementation |
|[xml](https://github.com/y-js/y-xml) | An implementation of the DOM. You can create a two way binding to Browser DOM objects | |[xml](https://github.com/y-js/y-xml) | An implementation of the DOM. You can create a two way binding to Browser DOM objects |
|[text](https://github.com/y-js/y-text) | Collaborate on text. Supports two way binding to the [Ace Editor](https://ace.c9.io), textareas, input elements, and HTML elements (e.g. <*h1*>, or <*p*>) | |[text](https://github.com/y-js/y-text) | Collaborate on text. Supports two way binding to textareas, input elements, or HTML elements (e.g. <*h1*>, or <*p*>). Also supports the [Ace Editor](https://ace.c9.io) |
|[richtext](https://github.com/y-js/y-richtext) | Collaborate on rich text. Supports two way binding to the [Quill Rich Text Editor](http://quilljs.com/)| |[richtext](https://github.com/y-js/y-richtext) | Collaborate on rich text. Supports two way binding to the [Quill Rich Text Editor](http://quilljs.com/)|
## Use it! Yjs supports P2P message propagation, and is not bound to a specific communication protocol. Therefore, Yjs is extremely scalable and can be used in a wide range of application scenarios.
Install Yjs, and its modules with [bower](http://bower.io/), or [npm](https://www.npmjs.org/package/yjs).
We support several communication protocols as so called *Connectors*.
You can create your own connector too - read [this wiki page](https://github.com/y-js/yjs/wiki/Custom-Connectors).
Currently, we support the following communication protocols:
|Name | Description |
|----------------|-----------------------------------|
|[xmpp](https://github.com/y-js/y-xmpp) | Propagate updates in a XMPP multi-user-chat room ([XEP-0045](http://xmpp.org/extensions/xep-0045.html))|
|[webrtc](https://github.com/y-js/y-webrtc) | Propagate updates Browser2Browser via WebRTC|
|[websockets](https://github.com/y-js/y-websockets-client) | Exchange updates efficiently in the classical client-server model |
|[test](https://github.com/y-js/y-test) | A Connector for testing purposes. It is designed to simulate delays that happen in worst case scenarios|
You are not limited to use a specific database to store the shared data. We provide the following database adapters:
|Name | Description |
|----------------|-----------------------------------|
|[memory](https://github.com/y-js/y-memory) | In-memory storage. |
|[indexeddb](https://github.com/y-js/y-indexeddb) | Offline storage for the browser |
The advantages over similar frameworks are support for
* .. P2P message propagation and arbitrary communication protocols
* .. share any type of data. The types provide a convenient interface
* .. offline support: Changes are stored persistently and only relevant changes are propagated on rejoin
* .. Intention Preservation: When working on Text, the intention of your changes are preserved. This is particularily important when working offline. Every type has a notion on how we define Intention Preservation on it.
## Use it!
Install yjs and its modules with [bower](http://bower.io/), or with [npm](https://www.npmjs.org/package/yjs).
### Bower ### Bower
``` ```
bower install --save yjs y-array % add all y-* modules you want to use bower install yjs --save
``` ```
You only need to include the `y.js` file. Yjs is able to automatically require missing modules. Then you include the libraries directly from the installation folder.
``` ```
<script src="./bower_components/yjs/y.js"></script> <script src="./bower_components/yjs/y.js"></script>
``` ```
### Npm ### Npm
``` ```
npm install --save yjs % add all y-* modules you want to use npm install yjs --save
``` ```
If you don't include via script tag, you have to explicitly include all modules! (Same goes for other module systems) And use it like this with *npm*:
``` ```
var Y = require('yjs') Y = require("yjs");
require('y-array')(Y) // add the y-array type to Yjs
require('y-websockets-client')(Y)
require('y-memory')(Y)
require('y-array')(Y)
require('y-map')(Y)
require('y-text')(Y)
// ..
// do the same for all modules you want to use
``` ```
# Text editing example # Text editing example
Install dependencies
``` ```
bower i yjs y-memory y-webrtc y-array y-text Y({
db: {
name: 'memory' // store in memory.
// name: 'indexeddb'
},
connector: {
name: 'websockets-client', // choose the websockets connector
// name: 'webrtc'
// name: 'xmpp'
room: 'Textarea-example-dev'
},
sourceDir: '/bower_components', // location of the y-* modules
share: {
textarea: 'Text' // y.share.textarea is of type Y.Text
}
// types: ['Richtext', 'Array'] // optional list of types you want to import
}).then(function (y) {
// bind the textarea to a shared text element
y.share.textarea.bind(document.getElementById('textfield'))
}
``` ```
Here is a simple example of a shared textarea # Api
```
<!DOCTYPE html>
<html>
<body>
<script src="./bower_components/yjs/y.js"></script>
<script>
Y({
db: {
name: 'memory' // use memory database adapter.
// name: 'indexeddb'
// name: 'leveldb'
},
connector: {
name: 'webrtc', // use webrtc connector
// name: 'websockets-client'
// name: 'xmpp'
room: 'my-room' // clients connecting to the same room share data
},
sourceDir: '/bower_components', // location of the y-* modules (browser only)
share: {
textarea: 'Text' // y.share.textarea is of type y-text
}
}).then(function (y) {
// The Yjs instance `y` is available
// y.share.* contains the shared types
// Bind the textarea to y.share.textarea
y.share.textarea.bind(document.querySelector('textarea'))
}
</script>
<textarea></textarea>
</body>
</html>
```
## Get Help & Give Help
There are some friendly people on [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/y-js/yjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) who are eager to help, and answer questions. Please join!
Report _any_ issues to the [Github issue page](https://github.com/y-js/yjs/issues)! I try to fix them very soon, if possible.
# API
### Y(options) ### Y(options)
* options.db * options.db
@@ -130,14 +104,14 @@ Report _any_ issues to the [Github issue page](https://github.com/y-js/yjs/issue
* All of our connectors specify an `url` property that defines the connection endpoint of the used connector. * All of our connectors specify an `url` property that defines the connection endpoint of the used connector.
* All of our connectors also have a default connection endpoint that you can use for development. * All of our connectors also have a default connection endpoint that you can use for development.
* Have a look at the used connector repository to see all available options. * Have a look at the used connector repository to see all available options.
* options.sourceDir (browser only) * options.sourceDir
* Path where all y-* modules are stored * Path where all y-* modules are stored.
* Defaults to `/bower_components` * Defaults to `/bower_components`
* Not required when running on `nodejs` / `iojs` * Not required when running on `nodejs` / `iojs`
* When using nodejs you need to manually extend Yjs: * When using browserify you can specify all used modules like this:
``` ```
var Y = require('yjs') var Y = require('yjs')
// you have to require a db, connector, and *all* types you use! // you need to require the db, connector, and *all* types you use!
require('y-memory')(Y) require('y-memory')(Y)
require('y-webrtc')(Y) require('y-webrtc')(Y)
require('y-map')(Y) require('y-map')(Y)
@@ -145,13 +119,13 @@ require('y-map')(Y)
``` ```
* options.share * options.share
* Specify on `options.share[arbitraryName]` types that are shared among all users. * Specify on `options.share[arbitraryName]` types that are shared among all users.
* E.g. Specify `options.share[arbitraryName] = 'Array'` to require y-array and create an y-array type on `y.share[arbitraryName]`. * E.g. Specify `options.share[arbitraryName] = 'Array'` to require y-array and create an Y.Array type on `y.share[arbitraryName]`.
* If userA doesn't specify `options.share[arbitraryName]`, it won't be available for userA. * If userA doesn't specify `options.share[arbitraryName]`, it won't be available for userA.
* If userB specifies `options.share[arbitraryName]`, it still won't be available for userA. But all the updates are send from userB to userA. * If userB specifies `options.share[arbitraryName]`, it still won't be available for userA. But all the updates are send from userB to userA.
* In contrast to y-map, types on `y.share.*` cannot be overwritten or deleted. Instead, they are merged among all users. This feature is only available on `y.share.*` * In contrast to Y.Map, types on `y.share.*` cannot be overwritten or deleted. Instead, they are merged among all users. This feature is only available on `y.share.*`
* Weird behavior: It is supported that two users specify different types with the same property name. * Weird behavior: It is supported that two users specify different types with the same property name.
E.g. userA specifies `options.share.x = 'Array'`, and userB specifies `options.share.x = 'Text'`. But they only share data if they specified the same type with the same property name E.g. userA specifies `options.share.x = 'Array'`, and userB specifies `options.share.x = 'Text'`. But they'll only share data if they specified the same type with the same property name
* options.type (browser only) * options.type
* Array of modules that Yjs needs to require, before instantiating a shared type. * Array of modules that Yjs needs to require, before instantiating a shared type.
* By default Yjs requires the specified database adapter, the specified connector, and all modules that are used in `options.share.*` * By default Yjs requires the specified database adapter, the specified connector, and all modules that are used in `options.share.*`
* Put all types here that you intend to use, but are not used in y.share.* * Put all types here that you intend to use, but are not used in y.share.*
@@ -196,19 +170,18 @@ The promise returns an instance of Y. We denote it with a lower case `y`.
* y.db.userId :: String * y.db.userId :: String
* The used user id for this client. **Never overwrite this** * The used user id for this client. **Never overwrite this**
## Changelog ## Get help
There are some friendly people on [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/y-js/yjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) who may help you with your problem, and answer your questions.
### 12.0.0 Please report _any_ issues to the [Github issue page](https://github.com/y-js/yjs/issues)! I try to fix them very soon, if possible.
* **Types are synchronous and never return a promise (except explicitly stated)** If you want to see an issue fixed, please subscribe to the thread (or remind me via gitter).
* `y.share.map.get('map type') // => returns a y-map instead of a promise`
* The event property `oldValues`, and `values` contain a list of values (without wrapper)
* Support for the [y-leveldb](https://github.com/y-js/y-leveldb) database adapter ## Changelog
* [y-richtext](https://github.com/y-js/y-richtext) supports Quill@1.0.0-rc.2
* Only the types are affected by this release. You have to upgrade y-array@10.0.0, y-map@10.0.0, y-richtext@9.0.0, and y-xml@10.0.0
### 11.0.0 ### 11.0.0
* **All types return a single event instead of list of events** * **All types now return a single event instead of list of events**
* Insert events contain a list of values * Insert events contain a list of values
* Improved performance for large insertions & deletions * Improved performance for large insertions & deletions
* Several bugfixes (offline editing related) * Several bugfixes (offline editing related)
@@ -222,7 +195,7 @@ The promise returns an instance of Y. We denote it with a lower case `y`.
### 9.0.0 ### 9.0.0
There were several rolling updates from 0.6 to 0.8. We consider Yjs stable since a long time, There were several rolling updates from 0.6 to 0.8. We consider Yjs stable since a long time,
and intend to continue stable releases. From this release forward y-* modules will implement peer-dependencies for npm, and dependencies for bower. and intend to continue stable releases. From this release forward y-* modules will implement peer-dependencies for npm, and dependencies for bower.
Furthermore, incompatible yjs instances throw errors now when syncing - this feature was influenced by #48. The versioning jump was influenced by react (see [here](https://facebook.github.io/react/blog/2016/02/19/new-versioning-scheme.html)) Furthermore, incompatible yjs instances will now throw errors when syncing - this feature was influenced by #48. The versioning jump was influenced by react (see [here](https://facebook.github.io/react/blog/2016/02/19/new-versioning-scheme.html))
### 0.6.0 ### 0.6.0

View File

@@ -1,6 +1,6 @@
{ {
"name": "yjs", "name": "yjs",
"version": "12.0.0", "version": "11.2.6",
"homepage": "y-js.org", "homepage": "y-js.org",
"authors": [ "authors": [
"Kevin Jahns <kevin.jahns@rwth-aachen.de>" "Kevin Jahns <kevin.jahns@rwth-aachen.de>"

192
y.es6
View File

@@ -67,6 +67,16 @@ module.exports = function (Y/* :any */) {
this.whenSyncedListeners = [] this.whenSyncedListeners = []
return this.y.db.stopGarbageCollector() return this.y.db.stopGarbageCollector()
} }
repair () {
console.info('Repairing the state of Yjs. This can happen if messages get lost, and Yjs detects that something is wrong. If this happens often, please report an issue here: https://github.com/y-js/yjs/issues')
for (var name in this.connections) {
this.connections[name].isSynced = false
}
this.isSynced = false
this.currentSyncTarget = null
this.broadcastedHB = false
this.findNextSyncTarget()
}
setUserId (userId) { setUserId (userId) {
if (this.userId == null) { if (this.userId == null) {
this.userId = userId this.userId = userId
@@ -696,6 +706,41 @@ module.exports = function (Y /* :any */) {
if (this.gcTimeout > 0) { if (this.gcTimeout > 0) {
garbageCollect() garbageCollect()
} }
this.repairCheckInterval = !opts.repairCheckInterval ? 6000 : opts.repairCheckInterval
this.opsReceivedTimestamp = new Date()
this.startRepairCheck()
}
startRepairCheck () {
var os = this
if (this.repairCheckInterval > 0) {
this.repairCheckIntervalHandler = setInterval(function repairOnMissingOperations () {
/*
Case 1. No ops have been received in a while (new Date() - os.opsReceivedTimestamp > os.repairCheckInterval)
- 1.1 os.listenersById is empty. Then the state was correct the whole time. -> Nothing to do (nor to update)
- 1.2 os.listenersById is not empty.
* Then the state was incorrect for at least {os.repairCheckInterval} seconds.
* -> Remove everything in os.listenersById and sync again (connector.repair())
Case 2. An op has been received in the last {os.repairCheckInterval } seconds.
It is not yet necessary to check for faulty behavior. Everything can still resolve itself. Wait for more messages.
If nothing was received for a while and os.listenersById is still not emty, we are in case 1.2
-> Do nothing
Baseline here is: we really only have to catch case 1.2..
*/
if (
new Date() - os.opsReceivedTimestamp > os.repairCheckInterval &&
Object.keys(os.listenersById).length > 0 // os.listenersById is not empty
) {
// haven't received operations for over {os.repairCheckInterval} seconds, resend state vector
os.listenersById = {}
os.opsReceivedTimestamp = new Date() // update so you don't send repair several times in a row
os.y.connector.repair()
}
}, this.repairCheckInterval)
}
}
stopRepairCheck () {
clearInterval(this.repairCheckIntervalHandler)
} }
queueGarbageCollector (id) { queueGarbageCollector (id) {
if (this.y.isConnected()) { if (this.y.isConnected()) {
@@ -791,6 +836,7 @@ module.exports = function (Y /* :any */) {
* destroy () { * destroy () {
clearInterval(this.gcInterval) clearInterval(this.gcInterval)
this.gcInterval = null this.gcInterval = null
this.stopRepairCheck()
for (var key in this.initializedTypes) { for (var key in this.initializedTypes) {
var type = this.initializedTypes[key] var type = this.initializedTypes[key]
if (type._destroy != null) { if (type._destroy != null) {
@@ -830,12 +876,14 @@ module.exports = function (Y /* :any */) {
/* /*
Apply a list of operations. Apply a list of operations.
* we save a timestamp, because we received new operations that could resolve ops in this.listenersById (see this.startRepairCheck)
* get a transaction * get a transaction
* check whether all Struct.*.requiredOps are in the OS * check whether all Struct.*.requiredOps are in the OS
* check if it is an expected op (otherwise wait for it) * check if it is an expected op (otherwise wait for it)
* check if was deleted, apply a delete operation after op was applied * check if was deleted, apply a delete operation after op was applied
*/ */
apply (ops) { apply (ops) {
this.opsReceivedTimestamp = new Date()
for (var i = 0; i < ops.length; i++) { for (var i = 0; i < ops.length; i++) {
var o = ops[i] var o = ops[i]
if (o.id == null || o.id[0] !== this.y.connector.userId) { if (o.id == null || o.id[0] !== this.y.connector.userId) {
@@ -1089,48 +1137,6 @@ module.exports = function (Y /* :any */) {
}, 0) }, 0)
} }
} }
/*
Get a created/initialized type.
*/
getType (id) {
return this.initializedTypes[JSON.stringify(id)]
}
/*
Init type. This is called when a remote operation is retrieved, and transformed to a type
TODO: delete type from store.initializedTypes[id] when corresponding id was deleted!
*/
* initType (id, args) {
var sid = JSON.stringify(id)
var t = this.store.initializedTypes[sid]
if (t == null) {
var op/* :MapStruct | ListStruct */ = yield* this.getOperation(id)
if (op != null) {
t = yield* Y[op.type].typeDefinition.initType.call(this, this.store, op, args)
this.store.initializedTypes[sid] = t
}
}
return t
}
/*
Create type. This is called when the local user creates a type (which is a synchronous action)
*/
createType (typedefinition, id) {
var structname = typedefinition[0].struct
id = id || this.getNextOpId(1)
var op = Y.Struct[structname].create(id)
op.type = typedefinition[0].name
this.requestTransaction(function * () {
if (op.id[0] === '_') {
yield* this.setOperation(op)
} else {
yield* this.applyCreatedOperations([op])
}
})
var t = Y[op.type].typeDefinition.createType(this, op, typedefinition[1])
this.initializedTypes[JSON.stringify(op.id)] = t
return t
}
} }
Y.AbstractDatabase = AbstractDatabase Y.AbstractDatabase = AbstractDatabase
} }
@@ -1632,6 +1638,57 @@ module.exports = function (Y/* :any */) {
os: Store; os: Store;
ss: Store; ss: Store;
*/ */
/*
Get a type based on the id of its model.
If it does not exist yes, create it.
TODO: delete type from store.initializedTypes[id] when corresponding id was deleted!
*/
* getType (id, args) {
var sid = JSON.stringify(id)
var t = this.store.initializedTypes[sid]
if (t == null) {
var op/* :MapStruct | ListStruct */ = yield* this.getOperation(id)
if (op != null) {
t = yield* Y[op.type].typeDefinition.initType.call(this, this.store, op, args)
this.store.initializedTypes[sid] = t
}
}
return t
}
* createType (typedefinition, id) {
var structname = typedefinition[0].struct
id = id || this.store.getNextOpId(1)
var op
if (id[0] === '_') {
op = yield* this.getOperation(id)
} else {
op = Y.Struct[structname].create(id)
op.type = typedefinition[0].name
}
if (typedefinition[0].appendAdditionalInfo != null) {
yield* typedefinition[0].appendAdditionalInfo.call(this, op, typedefinition[1])
}
if (op[0] === '_') {
yield* this.setOperation(op)
} else {
yield* this.applyCreatedOperations([op])
}
return yield* this.getType(id, typedefinition[1])
}
/* createType (typedefinition, id) {
var structname = typedefinition[0].struct
id = id || this.store.getNextOpId(1)
var op = Y.Struct[structname].create(id)
op.type = typedefinition[0].name
if (typedefinition[0].appendAdditionalInfo != null) {
yield* typedefinition[0].appendAdditionalInfo.call(this, op, typedefinition[1])
}
// yield* this.applyCreatedOperations([op])
yield* Y.Struct[op.struct].execute.call(this, op)
yield* this.addOperation(op)
yield* this.store.operationAdded(this, op)
return yield* this.getType(id, typedefinition[1])
}*/
/* /*
Apply operations that this user created (no remote ones!) Apply operations that this user created (no remote ones!)
* does not check for Struct.*.requiredOps() * does not check for Struct.*.requiredOps()
@@ -2834,13 +2891,7 @@ module.exports = function (Y /* : any*/) {
// finished with remaining operations // finished with remaining operations
self.waiting.push(d) self.waiting.push(d)
} }
if (op.key == null) { checkDelete(op)
// deletes in list
checkDelete(op)
} else {
// deletes in map
this.waiting.push(op)
}
} else { } else {
this.waiting.push(op) this.waiting.push(op)
} }
@@ -2889,11 +2940,7 @@ module.exports = function (Y /* : any*/) {
var o = this.waiting[i] var o = this.waiting[i]
if (o.struct === 'Insert') { if (o.struct === 'Insert') {
var _o = yield* transaction.getInsertion(o.id) var _o = yield* transaction.getInsertion(o.id)
if (_o.parentSub != null && _o.left != null) { if (!Y.utils.compareIds(_o.id, o.id)) {
// if o is an insertion of a map struc (parentSub is defined), then it shouldn't be necessary to compute left
this.waiting.splice(i, 1)
i-- // update index
} else if (!Y.utils.compareIds(_o.id, o.id)) {
// o got extended // o got extended
o.left = [o.id[0], o.id[1] - 1] o.left = [o.id[0], o.id[1] - 1]
} else if (_o.left == null) { } else if (_o.left == null) {
@@ -3053,14 +3100,6 @@ module.exports = function (Y /* : any*/) {
} }
Y.utils.EventHandler = EventHandler Y.utils.EventHandler = EventHandler
/*
Default class of custom types!
*/
class CustomType {
}
Y.utils.CustomType = CustomType
/* /*
A wrapper for the definition of a custom type. A wrapper for the definition of a custom type.
Every custom type must have three properties: Every custom type must have three properties:
@@ -3072,7 +3111,7 @@ module.exports = function (Y /* : any*/) {
* class * class
- the constructor of the custom type (e.g. in order to inherit from a type) - the constructor of the custom type (e.g. in order to inherit from a type)
*/ */
class CustomTypeDefinition { // eslint-disable-line class CustomType { // eslint-disable-line
/* :: /* ::
struct: any; struct: any;
initType: any; initType: any;
@@ -3083,14 +3122,12 @@ module.exports = function (Y /* : any*/) {
if (def.struct == null || if (def.struct == null ||
def.initType == null || def.initType == null ||
def.class == null || def.class == null ||
def.name == null || def.name == null
def.createType == null
) { ) {
throw new Error('Custom type was not initialized correctly!') throw new Error('Custom type was not initialized correctly!')
} }
this.struct = def.struct this.struct = def.struct
this.initType = def.initType this.initType = def.initType
this.createType = def.createType
this.class = def.class this.class = def.class
this.name = def.name this.name = def.name
if (def.appendAdditionalInfo != null) { if (def.appendAdditionalInfo != null) {
@@ -3102,13 +3139,13 @@ module.exports = function (Y /* : any*/) {
this.parseArguments.typeDefinition = this this.parseArguments.typeDefinition = this
} }
} }
Y.utils.CustomTypeDefinition = CustomTypeDefinition Y.utils.CustomType = CustomType
Y.utils.isTypeDefinition = function isTypeDefinition (v) { Y.utils.isTypeDefinition = function isTypeDefinition (v) {
if (v != null) { if (v != null) {
if (v instanceof Y.utils.CustomTypeDefinition) return [v] if (v instanceof Y.utils.CustomType) return [v]
else if (v.constructor === Array && v[0] instanceof Y.utils.CustomTypeDefinition) return v else if (v.constructor === Array && v[0] instanceof Y.utils.CustomType) return v
else if (v instanceof Function && v.typeDefinition instanceof Y.utils.CustomTypeDefinition) return [v.typeDefinition] else if (v instanceof Function && v.typeDefinition instanceof Y.utils.CustomType) return [v.typeDefinition]
} }
return false return false
} }
@@ -3368,7 +3405,7 @@ module.exports = Y
Y.requiringModules = requiringModules Y.requiringModules = requiringModules
Y.extend = function (name, value) { Y.extend = function (name, value) {
if (value instanceof Y.utils.CustomTypeDefinition) { if (value instanceof Y.utils.CustomType) {
Y[name] = value.parseArguments Y[name] = value.parseArguments
} else { } else {
Y[name] = value Y[name] = value
@@ -3494,9 +3531,6 @@ class YConfig {
for (var propertyname in opts.share) { for (var propertyname in opts.share) {
var typeConstructor = opts.share[propertyname].split('(') var typeConstructor = opts.share[propertyname].split('(')
var typeName = typeConstructor.splice(0, 1) var typeName = typeConstructor.splice(0, 1)
var type = Y[typeName]
var typedef = type.typeDefinition
var id = ['_', typedef.struct + '_' + typeName + '_' + propertyname + '_' + typeConstructor]
var args = [] var args = []
if (typeConstructor.length === 1) { if (typeConstructor.length === 1) {
try { try {
@@ -3504,13 +3538,11 @@ class YConfig {
} catch (e) { } catch (e) {
throw new Error('Was not able to parse type definition! (share.' + propertyname + ')') throw new Error('Was not able to parse type definition! (share.' + propertyname + ')')
} }
if (type.typeDefinition.parseArguments == null) {
throw new Error(typeName + ' does not expect arguments!')
} else {
args = typedef.parseArguments(args[0])[1]
}
} }
share[propertyname] = yield* this.store.initType.call(this, id, args) var type = Y[typeName]
var typedef = type.typeDefinition
var id = ['_', typedef.struct + '_' + typeName + '_' + propertyname + '_' + typeConstructor]
share[propertyname] = yield* this.createType(type.apply(typedef, args), id)
} }
this.store.whenTransactionsFinished() this.store.whenTransactionsFinished()
.then(callback) .then(callback)

File diff suppressed because one or more lines are too long

6
y.js

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long