the code for this has some spaghettiness to it, but here it is for fun anyway, a bot that watches you type in the Glitch editor and edits with you.
and I don’t mean that it programs with you, it’s only an experiment to show how to interact with the live collaboration system, “OT.” here it’s set up so that when you type a comment starting with > , it’ll repeat the comment, starting with < , in uppercase.
As you are working on your bots, let me know what roadblocks you hit, what API endpoints would help you succeed, what kind of bots you’d like to build for the Glitch editor, etc. I think this is super interesting work and love the idea of community-built bots on here!
do I fix conversations wiping when you stop bot.js? and also probably make a README.md on how to use it
this is an awesome project, it’ll make MY work easier that’s for sure.
EDIT: There’s some documentation on how to use it now and I’m making it easier to use by the minute
For those trying to work with this: Your user token is in your cachedUser object inside localStorage, as your persistentToken value. This is neccesary to create the connection to your project. The rest I handle- including getting the project ID, you just have to give the username. Should work with private ones too since I pass in your user token at that point.
Heyyyy! I spent a good few hours working on this and I want to die.
It’s done now though! Go check it out, it’s somewhat easy to integrate now (and once you’ve done it, you can just keep the tab open to integrate ChatGPT with your project)
yo @wh0 you know more than me about this, can you help? I tried to add whitespace support but it sometimes replaces in the wrong spot (I do put in the whitespace length to avoid that but it seems to not be working)
it also has ChatGPT support if you want to test that too
Worked like a charm! A few changes and now it actually respects whitespace. You probably saw the dirty patch I made to fix an indentation issue near the bottom
offsets in your indentation in .html / .svelte cause issues with the bot. trying to figure out the offset generation as we speak but it’s painful
So far I’ve figured out the offsets to make the line appear right BUT now we have the issue of broken bits after, I’m removing part of my code to see if it helps
EDIT: for some reason Glitch injects a SINGLE SPACE whenever the .html offset issue happens. no more auto new lines to mitigate. please tell me if this is the right way to do this
oh it’s better not to use start or end like that after sending the first transaction. every time you await there could have been other edits made that shift things around. you can rely on the transactions to be up to date
the relative offset in [0] looks right, for bringing you to just before the “C” in “Contacting”
the splice length in [1] looks one too many, as Contacting ChatGPT... is 21 characters. you have no guarantees what comes outside the transaction’s splices, so it’s not safe to do 22 there.
edit:
and that if thing that comes later shouldn’t trigger, as long as there are no concurrent edits going on. does it?
it does, the .html offset issue causes it to flip (end no longer equals the value returned in unsubmittedTx2 and that new value breaks things, hence the offset fix
okay after tons of printf debugging, here’s how things were going haywire. don’t blame Glitch, it was a bug in my code.
the Glitch editor, when you press enter on an indented line, as was the case in your HTML use case, creates a new line and indents it appropriately.
when it tells the Glitch OT server about the new indented line, it doesn’t insert it as “newline, space, space, …”. it first inserts just the newline, then in a second operation, it inserts the indentation spaces.
my code would handle an incoming list of operations (an “oplist”) by increasing the version number and then examining each operation in sequence.
when my code examines an operation that finishes one or more lines, it invokes the callback for handling a new line, synchronously. but in this case, it hasn’t even finished processing the oplist.
the synchronous part of the line handler starts sending out a new transaction, mistakenly thinking it is already operating on the new version, as the version number has already been increased.
then my code finally gets to the second part of the incoming oplist, and it incorrectly sees this a something that needs to fix up the outstanding transaction.
so as a result,
an oplist goes out to the OT server that tries to operate on the wrong starting state.
the client’s view of the outstanding transaction incorrectly gets updated, which later causes the successor transaction to be created with the wrong information too
basically everything thereafter goes wrong because of the above
I’ve made the following fixes in the original maple-separated-seal:
Move the version increment to the end of the oplist apply-er:
function opListApply(opList) {
- version = opList.version + 1;
for (const op of opList.ops) {
docsVisitOp(op);
txsVisitOp(op);
readerVisitOp(op);
}
+ version = opList.version + 1;
}
this is a safeguard to make any transactions sent while in the middle of processing an incoming oplist fail on the server. okay and I just realized that I had not settled whether oplist is one word or two words together, as opList.
wait for a microtask at the top of readerVisitLine
function readerVisitLine(docId, unsubmittedTx) {
+ (async () => {
+ try {
+ // wait for a microtask, after we finish processing the whole oplist that
+ // this line appeared in.
+ await Promise.resolve();
+
if (!unsubmittedTx.tx) throw unsubmittedTx.reason;
...
const submitTxPromise = submitUnsubmittedTx(unsubmittedTx);
- (async () => {
- try {
const unsubmittedTx2 = await submitTxPromise;
this prevents us from submitting a transaction until after the whole incoming oplist is processed. note that the first if (!unsubmittedTx) throw is now required, as an oplist may create a line and then disturb it in the same version, before we finish awaiting that Promise.resolve().
Magic spaces were part of the problem. Using your new code:
Magic spacing corresponding to the indent appears! That was part of the problem if you had no indent (Or a lot of unneeded indent), as that spacing can possibly cause issues.
I’ll update my bot to the new code but now I need to add even more code to handle the dumb spaces.
EDIT: New code makes it even harder to work around the dumb space issue >:/
I’m going to stay on the old codebase in order to keep the workaround for now
It would be nice if the indent worked right, currently it only spawns the indent the editor expects (Which often doesn’t work with extra / removed indents)
but there’s a part where it sets the relative offset to end, meaning to insert the text right after the newline. you would instead use end - 1, so that it gets inserted before the newline. and with that, don’t insert any newlines, because that would make it look like the same line has been created again