Skip to content

Commit

Permalink
refactor(reactive-rpc): 💡 update block RPC command names
Browse files Browse the repository at this point in the history
  • Loading branch information
@streamich
streamich committed Apr 10, 2024
1 parent 89d4851 commit 5be2b24
Show file tree
Hide file tree
Showing 12 changed files with 72 additions and 76 deletions.
10 changes: 5 additions & 5 deletions src/json-crdt-repo/remote/RemoteHistoryDemoServer.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export class RemoteHistoryDemoServer implements RemoteHistory<Cursor, RemoteServ
constructor (protected readonly client: TypedRpcClient<Methods>) {}

public async create(id: string, patches: RemotePatch[]): Promise<void> {
await this.client.call('blocks.create', {
await this.client.call('block.new', {
id,
patches: patches.map((patch, seq) => ({
// TODO: seq and created should be set on server. (And returned back?)
Expand All @@ -36,7 +36,7 @@ export class RemoteHistoryDemoServer implements RemoteHistory<Cursor, RemoteServ
* it might have.
*/
public async read(id: string): Promise<{cursor: Cursor, model: RemoteServerModel, patches: RemoteServerPatch[]}> {
const {block, patches} = await this.client.call('blocks.get', {id});
const {block, patches} = await this.client.call('block.get', {id});
return {
cursor: block.seq,
model: block,
Expand All @@ -46,7 +46,7 @@ export class RemoteHistoryDemoServer implements RemoteHistory<Cursor, RemoteServ

public async scanFwd(id: string, cursor: Cursor): Promise<{cursor: Cursor, patches: RemoteServerPatch[]}> {
const limit = 100;
const res = await this.client.call('blocks.history', {
const res = await this.client.call('block.scan', {
id,
min: cursor,
max: cursor + limit,
Expand All @@ -69,7 +69,7 @@ export class RemoteHistoryDemoServer implements RemoteHistory<Cursor, RemoteServ

public async update(id: string, cursor: Cursor, patches: RemotePatch[]): Promise<{cursor: Cursor, patches: RemoteServerPatch[]}> {

const res = await this.client.call('blocks.edit', {
const res = await this.client.call('block.upd', {
id,
patches: patches.map((patch, seq) => ({
seq,
Expand All @@ -84,7 +84,7 @@ export class RemoteHistoryDemoServer implements RemoteHistory<Cursor, RemoteServ
}

public async delete?(id: string): Promise<void> {
await this.client.call('blocks.remove', {id});
await this.client.call('block.del', {id});
}

/**
Expand Down
2 changes: 1 addition & 1 deletion src/json-crdt-repo/remote/__tests__/RemoteHistoryServer.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ describe('.create()', () => {
const blob = patch.toBinary();
const id = genId();
await remote.create(id, [{blob}]);
const {data} = await caller.call('blocks.get', {id}, {});
const {data} = await caller.call('block.get', {id}, {});
// console.log(data.patches);
const model2 = Model.fromBinary(data.block.blob);
expect(model2.view()).toEqual({foo: 'bar'});
Expand Down
90 changes: 45 additions & 45 deletions src/server/__tests__/blocks.spec.ts → src/server/__tests__/block.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ import {RpcErrorCodes} from '../../reactive-rpc/common/rpc/caller';
import {setup} from './setup';
import {tick, until} from '../../__tests__/util';

describe('blocks.*', () => {
describe('blocks.create', () => {
describe('block.*', () => {
describe('block.new', () => {
test('can create an empty block', async () => {
const {call} = setup();
await call('blocks.create', {id: 'my-block', patches: []});
const {block} = await call('blocks.get', {id: 'my-block'});
await call('block.new', {id: 'my-block', patches: []});
const {block} = await call('block.get', {id: 'my-block'});
expect(block).toMatchObject({
id: 'my-block',
seq: -1,
Expand All @@ -32,7 +32,7 @@ describe('blocks.*', () => {
age: 26,
});
const patch2 = model.api.flush();
await call('blocks.create', {
await call('block.new', {
id: '123412341234',
patches: [
{
Expand All @@ -47,7 +47,7 @@ describe('blocks.*', () => {
},
],
});
const {block} = await call('blocks.get', {id: '123412341234'});
const {block} = await call('block.get', {id: '123412341234'});
expect(block).toMatchObject({
id: '123412341234',
seq: 1,
Expand All @@ -63,23 +63,23 @@ describe('blocks.*', () => {
});
});

describe('blocks.remove', () => {
describe('block.remove', () => {
test('can remove an existing block', async () => {
const {call} = setup();
await call('blocks.create', {id: 'my-block', patches: []});
const {block} = await call('blocks.get', {id: 'my-block'});
await call('block.new', {id: 'my-block', patches: []});
const {block} = await call('block.get', {id: 'my-block'});
expect(block.id).toBe('my-block');
await call('blocks.remove', {id: 'my-block'});
await call('block.del', {id: 'my-block'});
try {
await call('blocks.get', {id: 'my-block'});
await call('block.get', {id: 'my-block'});
throw new Error('not this error');
} catch (err: any) {
expect(err.errno).toBe(RpcErrorCodes.NOT_FOUND);
}
});
});

describe('blocks.edit', () => {
describe('block.upd', () => {
test('can edit a document sequentially', async () => {
const {call} = setup();
const id = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
Expand All @@ -88,7 +88,7 @@ describe('blocks.*', () => {
text: 'Hell',
});
const patch1 = model.api.flush();
await call('blocks.create', {
await call('block.new', {
id,
patches: [
{
Expand All @@ -102,7 +102,7 @@ describe('blocks.*', () => {
const patch2 = model.api.flush();
model.api.str(['text']).ins(5, ' World');
const patch3 = model.api.flush();
await call('blocks.edit', {
await call('block.upd', {
id,
patches: [
{
Expand All @@ -117,15 +117,15 @@ describe('blocks.*', () => {
},
],
});
const block2 = await call('blocks.get', {id});
const block2 = await call('block.get', {id});
expect(Model.fromBinary(block2.block.blob).view()).toStrictEqual({
text: 'Hello World',
});
model.api.str(['text']).del(5, 1).ins(5, ', ');
const patch4 = model.api.flush();
model.api.str(['text']).ins(12, '!');
const patch5 = model.api.flush();
await call('blocks.edit', {
await call('block.upd', {
id,
patches: [
{
Expand All @@ -140,7 +140,7 @@ describe('blocks.*', () => {
},
],
});
const block3 = await call('blocks.get', {id});
const block3 = await call('block.get', {id});
expect(Model.fromBinary(block3.block.blob).view()).toStrictEqual({
text: 'Hello, World!',
});
Expand All @@ -156,7 +156,7 @@ describe('blocks.*', () => {
text: 'Hell',
});
const patch1 = model.api.flush();
await call('blocks.create', {
await call('block.new', {
id,
patches: [
{
Expand All @@ -168,11 +168,11 @@ describe('blocks.*', () => {
});

// User 2
const block2 = await call('blocks.get', {id});
const block2 = await call('block.get', {id});
const model2 = Model.fromBinary(block2.block.blob).fork();
model2.api.str(['text']).ins(4, ' yeah!');
const patch2User2 = model2.api.flush();
await call('blocks.edit', {
await call('block.upd', {
id,
patches: [
{
Expand All @@ -184,7 +184,7 @@ describe('blocks.*', () => {
});
expect(model2.view()).toStrictEqual({text: 'Hell yeah!'});

const block3 = await call('blocks.get', {id});
const block3 = await call('block.get', {id});
const model3 = Model.fromBinary(block3.block.blob).fork();
expect(model3.view()).toStrictEqual({text: 'Hell yeah!'});

Expand All @@ -193,7 +193,7 @@ describe('blocks.*', () => {
const patch2 = model.api.flush();
model.api.str(['text']).ins(5, ' World');
const patch3 = model.api.flush();
const {patches} = await call('blocks.edit', {
const {patches} = await call('block.upd', {
id,
patches: [
{
Expand All @@ -209,7 +209,7 @@ describe('blocks.*', () => {
],
});

const block4 = await call('blocks.get', {id});
const block4 = await call('block.get', {id});
const model4 = Model.fromBinary(block4.block.blob).fork();
expect(model4.view()).not.toStrictEqual({text: 'Hell yeah!'});
});
Expand All @@ -224,7 +224,7 @@ describe('blocks.*', () => {
text: 'Hell',
});
const patch1 = model.api.flush();
await call('blocks.create', {
await call('block.new', {
id,
patches: [
{
Expand All @@ -236,11 +236,11 @@ describe('blocks.*', () => {
});

// User 2
const block2 = await call('blocks.get', {id});
const block2 = await call('block.get', {id});
const model2 = Model.fromBinary(block2.block.blob).fork();
model2.api.str(['text']).ins(4, ' yeah!');
const patch2User2 = model2.api.flush();
await call('blocks.edit', {
await call('block.upd', {
id,
patches: [
{
Expand All @@ -256,7 +256,7 @@ describe('blocks.*', () => {
const patch2 = model.api.flush();
model.api.str(['text']).ins(5, ' World');
const patch3 = model.api.flush();
const {patches} = await call('blocks.edit', {
const {patches} = await call('block.upd', {
id,
patches: [
{
Expand All @@ -280,21 +280,21 @@ describe('blocks.*', () => {
});
});

describe('blocks.listen', () => {
describe('block.listen', () => {
test('can listen for block changes', async () => {
const {client} = setup();
await client.call('blocks.create', {id: 'my-block', patches: []});
await client.call('block.new', {id: 'my-block', patches: []});
await tick(11);
const emits: any[] = [];
client.call$('blocks.listen', {id: 'my-block'}).subscribe((data) => emits.push(data));
client.call$('block.listen', {id: 'my-block'}).subscribe((data) => emits.push(data));
const model = Model.withLogicalClock();
model.api.root({
text: 'Hell',
});
const patch1 = model.api.flush();
await tick(12);
expect(emits.length).toBe(0);
await client.call('blocks.edit', {
await client.call('block.upd', {
id: 'my-block',
patches: [{seq: 0, created: Date.now(), blob: patch1.toBinary()}],
});
Expand All @@ -308,7 +308,7 @@ describe('blocks.*', () => {
const patch2 = model.api.flush();
await tick(12);
expect(emits.length).toBe(1);
await client.call('blocks.edit', {
await client.call('block.upd', {
id: 'my-block',
patches: [{seq: 1, created: Date.now(), blob: patch2.toBinary()}],
});
Expand All @@ -321,15 +321,15 @@ describe('blocks.*', () => {
test('can subscribe before block is created', async () => {
const {client} = setup();
const emits: any[] = [];
client.call$('blocks.listen', {id: 'my-block'}).subscribe((data) => emits.push(data));
client.call$('block.listen', {id: 'my-block'}).subscribe((data) => emits.push(data));
const model = Model.withLogicalClock();
model.api.root({
text: 'Hell',
});
const patch1 = model.api.flush();
await tick(12);
expect(emits.length).toBe(0);
await client.call('blocks.create', {
await client.call('block.new', {
id: 'my-block',
patches: [
{
Expand All @@ -349,26 +349,26 @@ describe('blocks.*', () => {
test('can receive deletion events', async () => {
const {client} = setup();
const emits: any[] = [];
client.call$('blocks.listen', {id: 'my-block'}).subscribe((data) => emits.push(data));
await client.call('blocks.create', {id: 'my-block', patches: []});
client.call$('block.listen', {id: 'my-block'}).subscribe((data) => emits.push(data));
await client.call('block.new', {id: 'my-block', patches: []});
await until(() => emits.length === 1);
expect(emits[0].block.seq).toBe(-1);
await tick(3);
await client.call('blocks.remove', {id: 'my-block'});
await client.call('block.del', {id: 'my-block'});
await until(() => emits.length === 2);
expect(emits[1].deleted).toBe(true);
});
});

describe('blocks.history', () => {
describe('block.history', () => {
test('can retrieve change history', async () => {
const {client} = setup();
const model = Model.withLogicalClock();
model.api.root({
text: 'Hell',
});
const patch1 = model.api.flush();
await client.call('blocks.create', {
await client.call('block.new', {
id: 'my-block',
patches: [
{
Expand All @@ -385,7 +385,7 @@ describe('blocks.*', () => {
age: 26,
});
const patch3 = model.api.flush();
await client.call('blocks.edit', {
await client.call('block.upd', {
id: 'my-block',
patches: [
{
Expand All @@ -400,7 +400,7 @@ describe('blocks.*', () => {
},
],
});
const history = await client.call('blocks.history', {id: 'my-block', min: 0, max: 2});
const history = await client.call('block.scan', {id: 'my-block', min: 0, max: 2});
expect(history).toMatchObject({
patches: [
{
Expand All @@ -423,15 +423,15 @@ describe('blocks.*', () => {
});
});

describe('blocks.get', () => {
describe('block.get', () => {
test('returns whole history when block is loaded', async () => {
const {client} = setup();
const model = Model.withLogicalClock();
model.api.root({
text: 'Hell',
});
const patch1 = model.api.flush();
await client.call('blocks.create', {
await client.call('block.new', {
id: 'my-block',
patches: [
{
Expand All @@ -447,7 +447,7 @@ describe('blocks.*', () => {
age: 26,
});
const patch3 = model.api.flush();
await client.call('blocks.edit', {
await client.call('block.upd', {
id: 'my-block',
patches: [
{
Expand All @@ -462,7 +462,7 @@ describe('blocks.*', () => {
},
],
});
const result = await client.call('blocks.get', {id: 'my-block'});
const result = await client.call('block.get', {id: 'my-block'});
expect(result).toMatchObject({
block: expect.any(Object),
patches: [
Expand Down
Loading

0 comments on commit 5be2b24

Please sign in to comment.