Merge branch 'feat/cloud-sync-saika' into feat/datacenter

This commit is contained in:
DiamondThree
2023-01-10 16:51:02 +08:00
14 changed files with 114 additions and 67 deletions
+31 -28
View File
@@ -1,23 +1,25 @@
import { Workspaces } from './workspaces'; import { WorkspaceMetaCollection } from './workspace-meta-collection.js';
import type { WorkspacesChangeEvent } from './workspaces'; import type { WorkspaceMetaCollectionChangeEvent } from './workspace-meta-collection';
import { Workspace as BlocksuiteWorkspace } from '@blocksuite/store'; import { Workspace as BlocksuiteWorkspace } from '@blocksuite/store';
import { BaseProvider } from './provider/base'; import { BaseProvider } from './provider/base';
import { LocalProvider } from './provider/local/local'; import { LocalProvider } from './provider/local/local';
import { AffineProvider } from './provider'; import { AffineProvider } from './provider';
import type { WorkspaceMeta } from './types'; import type { Message, WorkspaceMeta } from './types';
import assert from 'assert'; import assert from 'assert';
import { getLogger } from './logger'; import { getLogger } from './logger';
import { applyUpdate, encodeStateAsUpdate } from 'yjs'; import { applyUpdate, encodeStateAsUpdate } from 'yjs';
import { createBlocksuiteWorkspace } from './utils/index.js'; import { createBlocksuiteWorkspace } from './utils/index.js';
import { MessageCenter } from './message/message';
/** /**
* @class DataCenter * @class DataCenter
* @classdesc Data center is made for managing different providers for business * @classdesc Data center is made for managing different providers for business
*/ */
export class DataCenter { export class DataCenter {
private readonly _workspaces = new Workspaces(); private readonly _workspaceMetaCollection = new WorkspaceMetaCollection();
private readonly _logger = getLogger('dc'); private readonly _logger = getLogger('dc');
private _workspaceInstances: Map<string, BlocksuiteWorkspace> = new Map(); private _workspaceInstances: Map<string, BlocksuiteWorkspace> = new Map();
private _messageCenter = new MessageCenter();
/** /**
* A mainProvider must exist as the only data trustworthy source. * A mainProvider must exist as the only data trustworthy source.
*/ */
@@ -30,19 +32,16 @@ export class DataCenter {
static async init(debug: boolean): Promise<DataCenter> { static async init(debug: boolean): Promise<DataCenter> {
const dc = new DataCenter(debug); const dc = new DataCenter(debug);
const getInitParams = () => {
return {
logger: dc._logger,
workspaces: dc._workspaceMetaCollection.createScope(),
messageCenter: dc._messageCenter,
};
};
// TODO: switch different provider // TODO: switch different provider
dc.registerProvider( dc.registerProvider(new LocalProvider(getInitParams()));
new LocalProvider({ dc.registerProvider(new AffineProvider(getInitParams()));
logger: dc._logger,
workspaces: dc._workspaces.createScope(),
})
);
dc.registerProvider(
new AffineProvider({
logger: dc._logger,
workspaces: dc._workspaces.createScope(),
})
);
return dc; return dc;
} }
@@ -69,7 +68,7 @@ export class DataCenter {
} }
public get workspaces() { public get workspaces() {
return this._workspaces.workspaces; return this._workspaceMetaCollection.workspaces;
} }
public async refreshWorkspaces() { public async refreshWorkspaces() {
@@ -104,7 +103,7 @@ export class DataCenter {
* @param {string} workspaceId workspace id * @param {string} workspaceId workspace id
*/ */
public async deleteWorkspace(workspaceId: string) { public async deleteWorkspace(workspaceId: string) {
const workspaceInfo = this._workspaces.find(workspaceId); const workspaceInfo = this._workspaceMetaCollection.find(workspaceId);
assert(workspaceInfo, 'Workspace not found'); assert(workspaceInfo, 'Workspace not found');
const provider = this.providerMap.get(workspaceInfo.provider); const provider = this.providerMap.get(workspaceInfo.provider);
assert(provider, `Workspace exists, but we couldn't find its provider.`); assert(provider, `Workspace exists, but we couldn't find its provider.`);
@@ -116,7 +115,7 @@ export class DataCenter {
* @param {string} workspaceId workspace id * @param {string} workspaceId workspace id
*/ */
private _getBlocksuiteWorkspace(workspaceId: string) { private _getBlocksuiteWorkspace(workspaceId: string) {
const workspaceInfo = this._workspaces.find(workspaceId); const workspaceInfo = this._workspaceMetaCollection.find(workspaceId);
assert(workspaceInfo, 'Workspace not found'); assert(workspaceInfo, 'Workspace not found');
return ( return (
this._workspaceInstances.get(workspaceId) || this._workspaceInstances.get(workspaceId) ||
@@ -150,7 +149,7 @@ export class DataCenter {
* @returns {Promise<BlocksuiteWorkspace>} * @returns {Promise<BlocksuiteWorkspace>}
*/ */
public async loadWorkspace(workspaceId: string) { public async loadWorkspace(workspaceId: string) {
const workspaceInfo = this._workspaces.find(workspaceId); const workspaceInfo = this._workspaceMetaCollection.find(workspaceId);
assert(workspaceInfo, 'Workspace not found'); assert(workspaceInfo, 'Workspace not found');
const currentProvider = this.providerMap.get(workspaceInfo.provider); const currentProvider = this.providerMap.get(workspaceInfo.provider);
if (currentProvider) { if (currentProvider) {
@@ -181,9 +180,9 @@ export class DataCenter {
* @param {Function} callback callback function * @param {Function} callback callback function
*/ */
public async onWorkspacesChange( public async onWorkspacesChange(
callback: (workspaces: WorkspacesChangeEvent) => void callback: (workspaces: WorkspaceMetaCollectionChangeEvent) => void
) { ) {
this._workspaces.on('change', callback); this._workspaceMetaCollection.on('change', callback);
} }
/** /**
@@ -206,7 +205,7 @@ export class DataCenter {
update.avatar = avatar; update.avatar = avatar;
} }
// may run for change workspace meta // may run for change workspace meta
const workspaceInfo = this._workspaces.find(workspace.room); const workspaceInfo = this._workspaceMetaCollection.find(workspace.room);
assert(workspaceInfo, 'Workspace not found'); assert(workspaceInfo, 'Workspace not found');
const provider = this.providerMap.get(workspaceInfo.provider); const provider = this.providerMap.get(workspaceInfo.provider);
provider?.updateWorkspaceMeta(workspace.room, update); provider?.updateWorkspaceMeta(workspace.room, update);
@@ -218,7 +217,7 @@ export class DataCenter {
* @param id workspace id * @param id workspace id
*/ */
public async leaveWorkspace(workspaceId: string) { public async leaveWorkspace(workspaceId: string) {
const workspaceInfo = this._workspaces.find(workspaceId); const workspaceInfo = this._workspaceMetaCollection.find(workspaceId);
assert(workspaceInfo, 'Workspace not found'); assert(workspaceInfo, 'Workspace not found');
const provider = this.providerMap.get(workspaceInfo.provider); const provider = this.providerMap.get(workspaceInfo.provider);
if (provider) { if (provider) {
@@ -228,7 +227,7 @@ export class DataCenter {
} }
public async setWorkspacePublish(workspaceId: string, isPublish: boolean) { public async setWorkspacePublish(workspaceId: string, isPublish: boolean) {
const workspaceInfo = this._workspaces.find(workspaceId); const workspaceInfo = this._workspaceMetaCollection.find(workspaceId);
assert(workspaceInfo, 'Workspace not found'); assert(workspaceInfo, 'Workspace not found');
const provider = this.providerMap.get(workspaceInfo.provider); const provider = this.providerMap.get(workspaceInfo.provider);
if (provider) { if (provider) {
@@ -237,7 +236,7 @@ export class DataCenter {
} }
public async inviteMember(id: string, email: string) { public async inviteMember(id: string, email: string) {
const workspaceInfo = this._workspaces.find(id); const workspaceInfo = this._workspaceMetaCollection.find(id);
assert(workspaceInfo, 'Workspace not found'); assert(workspaceInfo, 'Workspace not found');
const provider = this.providerMap.get(workspaceInfo.provider); const provider = this.providerMap.get(workspaceInfo.provider);
if (provider) { if (provider) {
@@ -250,7 +249,7 @@ export class DataCenter {
* @param {number} permissionId permission id * @param {number} permissionId permission id
*/ */
public async removeMember(workspaceId: string, permissionId: number) { public async removeMember(workspaceId: string, permissionId: number) {
const workspaceInfo = this._workspaces.find(workspaceId); const workspaceInfo = this._workspaceMetaCollection.find(workspaceId);
assert(workspaceInfo, 'Workspace not found'); assert(workspaceInfo, 'Workspace not found');
const provider = this.providerMap.get(workspaceInfo.provider); const provider = this.providerMap.get(workspaceInfo.provider);
if (provider) { if (provider) {
@@ -281,7 +280,7 @@ export class DataCenter {
providerId: string providerId: string
) { ) {
assert(workspace.room, 'No workspace id'); assert(workspace.room, 'No workspace id');
const workspaceInfo = this._workspaces.find(workspace.room); const workspaceInfo = this._workspaceMetaCollection.find(workspace.room);
assert(workspaceInfo, 'Workspace not found'); assert(workspaceInfo, 'Workspace not found');
if (workspaceInfo.provider === providerId) { if (workspaceInfo.provider === providerId) {
this._logger('Workspace provider is same'); this._logger('Workspace provider is same');
@@ -371,4 +370,8 @@ export class DataCenter {
const blobStorage = await workspace.blobs; const blobStorage = await workspace.blobs;
return (await blobStorage?.set(blob)) || ''; return (await blobStorage?.set(blob)) || '';
} }
onMessage(cb: (message: Message) => void) {
return this._messageCenter.onMessage(cb);
}
} }
+1
View File
@@ -29,3 +29,4 @@ export type { DataCenter };
export type { AccessTokenMessage } from './provider/affine/apis'; export type { AccessTokenMessage } from './provider/affine/apis';
export * from './types'; export * from './types';
export { getLogger } from './logger'; export { getLogger } from './logger';
export * from './message';
+3
View File
@@ -0,0 +1,3 @@
export enum MessageCode {
loginError,
}
@@ -0,0 +1,2 @@
export { MessageCenter } from './message';
export { MessageCode } from './code';
@@ -0,0 +1,24 @@
import { Observable } from 'lib0/observable';
import { Message } from 'src/types';
import { MessageCode } from './code';
export class MessageCenter extends Observable<string> {
constructor() {
super();
}
public send(message: MessageCode) {
this.emit('message', [message]);
}
public onMessage(callback: (message: Message) => void) {
this.on('message', callback);
}
private messages: Record<number, Message> = {
[MessageCode.loginError]: {
code: MessageCode.loginError,
message: 'Login failed',
},
};
}
@@ -1,6 +1,6 @@
import { test, expect } from '@playwright/test'; import { test, expect } from '@playwright/test';
import { AffineProvider } from '../affine.js'; import { AffineProvider } from '../affine.js';
import { Workspaces } from '../../../workspaces/index.js'; // import { Workspaces } from '../../../workspaces/index.js';
import { apis } from './mock-apis.js'; import { apis } from './mock-apis.js';
import 'fake-indexeddb/auto'; import 'fake-indexeddb/auto';
@@ -11,6 +11,7 @@ import { WebsocketProvider } from './sync.js';
import { getApis } from './apis/index.js'; import { getApis } from './apis/index.js';
import type { Apis, WorkspaceDetail, Callback } from './apis'; import type { Apis, WorkspaceDetail, Callback } from './apis';
import { setDefaultAvatar } from '../utils.js'; import { setDefaultAvatar } from '../utils.js';
import { MessageCode } from 'src/message/code.js';
export interface AffineProviderConstructorParams export interface AffineProviderConstructorParams
extends ProviderConstructorParams { extends ProviderConstructorParams {
@@ -196,7 +197,10 @@ export class AffineProvider extends BaseProvider {
return; return;
} }
} }
await this._apis.signInWithGoogle?.(); const user = await this._apis.signInWithGoogle?.();
if (!user) {
this._messageCenter.send(MessageCode.loginError);
}
} }
public override async getUserInfo(): Promise<User | undefined> { public override async getUserInfo(): Promise<User | undefined> {
+12 -4
View File
@@ -1,6 +1,7 @@
import { Workspace as BlocksuiteWorkspace, uuidv4 } from '@blocksuite/store'; import { Workspace as BlocksuiteWorkspace, uuidv4 } from '@blocksuite/store';
import { MessageCenter } from 'src/message';
import { Logger, User, WorkspaceInfo, WorkspaceMeta } from '../types'; import { Logger, User, WorkspaceInfo, WorkspaceMeta } from '../types';
import type { WorkspacesScope } from '../workspaces'; import type { WorkspaceMetaCollectionScope } from '../workspace-meta-collection';
const defaultLogger = () => { const defaultLogger = () => {
return; return;
@@ -8,17 +9,24 @@ const defaultLogger = () => {
export interface ProviderConstructorParams { export interface ProviderConstructorParams {
logger?: Logger; logger?: Logger;
workspaces: WorkspacesScope; workspaces: WorkspaceMetaCollectionScope;
messageCenter: MessageCenter;
} }
export class BaseProvider { export class BaseProvider {
public readonly id: string = 'base'; public readonly id: string = 'base';
protected _workspaces!: WorkspacesScope; protected _workspaces!: WorkspaceMetaCollectionScope;
protected _logger!: Logger; protected _logger!: Logger;
protected _messageCenter!: MessageCenter;
public constructor({ logger, workspaces }: ProviderConstructorParams) { public constructor({
logger,
workspaces,
messageCenter,
}: ProviderConstructorParams) {
this._logger = (logger || defaultLogger) as Logger; this._logger = (logger || defaultLogger) as Logger;
this._workspaces = workspaces; this._workspaces = workspaces;
this._messageCenter = messageCenter;
} }
/** /**
@@ -1,13 +1,13 @@
import { test, expect } from '@playwright/test'; import { test, expect } from '@playwright/test';
import { Workspaces } from '../../workspaces/index.js'; import { WorkspaceMetaCollection } from '../../workspace-meta-collection.js';
import { LocalProvider } from './local.js'; import { LocalProvider } from './local.js';
import { createBlocksuiteWorkspace } from '../../utils/index.js'; import { createBlocksuiteWorkspace } from '../../utils/index.js';
import 'fake-indexeddb/auto'; import 'fake-indexeddb/auto';
test.describe.serial('local provider', () => { test.describe.serial('local provider', () => {
const workspaces = new Workspaces(); const workspaceMetaCollection = new WorkspaceMetaCollection();
const provider = new LocalProvider({ const provider = new LocalProvider({
workspaces: workspaces.createScope(), workspaces: workspaceMetaCollection.createScope(),
}); });
const workspaceName = 'workspace-test'; const workspaceName = 'workspace-test';
@@ -25,30 +25,30 @@ test.describe.serial('local provider', () => {
avatar: 'avatar-url-test', avatar: 'avatar-url-test',
}); });
expect(workspaces.workspaces.length).toEqual(1); expect(workspaceMetaCollection.workspaces.length).toEqual(1);
expect(workspaces.workspaces[0].name).toEqual(workspaceName); expect(workspaceMetaCollection.workspaces[0].name).toEqual(workspaceName);
}); });
test('workspace list cache', async () => { test('workspace list cache', async () => {
const workspaces1 = new Workspaces(); const workspacesMetaCollection1 = new WorkspaceMetaCollection();
const provider1 = new LocalProvider({ const provider1 = new LocalProvider({
workspaces: workspaces1.createScope(), workspaces: workspacesMetaCollection1.createScope(),
}); });
await provider1.loadWorkspaces(); await provider1.loadWorkspaces();
expect(workspaces1.workspaces.length).toEqual(1); expect(workspacesMetaCollection1.workspaces.length).toEqual(1);
expect(workspaces1.workspaces[0].name).toEqual(workspaceName); expect(workspacesMetaCollection1.workspaces[0].name).toEqual(workspaceName);
expect(workspaces1.workspaces[0].id).toEqual(workspaceId); expect(workspacesMetaCollection1.workspaces[0].id).toEqual(workspaceId);
}); });
test('update workspace', async () => { test('update workspace', async () => {
await provider.updateWorkspaceMeta(workspaceId!, { await provider.updateWorkspaceMeta(workspaceId!, {
name: '1111', name: '1111',
}); });
expect(workspaces.workspaces[0].name).toEqual('1111'); expect(workspaceMetaCollection.workspaces[0].name).toEqual('1111');
}); });
test('delete workspace', async () => { test('delete workspace', async () => {
expect(workspaces.workspaces.length).toEqual(1); expect(workspaceMetaCollection.workspaces.length).toEqual(1);
/** /**
* FIXME * FIXME
* If we don't wrap setTimeout, * If we don't wrap setTimeout,
@@ -56,8 +56,8 @@ test.describe.serial('local provider', () => {
* InvalidStateError: An operation was called on an object on which it is not allowed or at a time when it is not allowed. Also occurs if a request is made on a source object that has been deleted or removed. Use TransactionInactiveError or ReadOnlyError when possible, as they are more specific variations of InvalidStateError. * InvalidStateError: An operation was called on an object on which it is not allowed or at a time when it is not allowed. Also occurs if a request is made on a source object that has been deleted or removed. Use TransactionInactiveError or ReadOnlyError when possible, as they are more specific variations of InvalidStateError.
* */ * */
setTimeout(async () => { setTimeout(async () => {
await provider.deleteWorkspace(workspaces.workspaces[0].id); await provider.deleteWorkspace(workspaceMetaCollection.workspaces[0].id);
expect(workspaces.workspaces.length).toEqual(0); expect(workspaceMetaCollection.workspaces.length).toEqual(0);
}, 10); }, 10);
}); });
}); });
+1 -2
View File
@@ -8,8 +8,7 @@ export const setDefaultAvatar = async (
const blob = await getDefaultHeadImgBlob(blocksuiteWorkspace.meta.name); const blob = await getDefaultHeadImgBlob(blocksuiteWorkspace.meta.name);
const blobStorage = await blocksuiteWorkspace.blobs; const blobStorage = await blocksuiteWorkspace.blobs;
assert(blobStorage, 'No blob storage'); assert(blobStorage, 'No blob storage');
const blobId = await blobStorage.set(blob); const avatar = await blobStorage.set(blob);
const avatar = await blobStorage.get(blobId);
if (avatar) { if (avatar) {
blocksuiteWorkspace.meta.setAvatar(avatar); blocksuiteWorkspace.meta.setAvatar(avatar);
} }
+5
View File
@@ -21,3 +21,8 @@ export type User = {
export type WorkspaceMeta = Pick<WorkspaceInfo, 'name' | 'avatar'>; export type WorkspaceMeta = Pick<WorkspaceInfo, 'name' | 'avatar'>;
export type Logger = ReturnType<typeof getLogger>; export type Logger = ReturnType<typeof getLogger>;
export type Message = {
code: number;
message: string;
};
@@ -1,14 +1,14 @@
import { test, expect } from '@playwright/test'; import { test, expect } from '@playwright/test';
import { Workspaces } from './workspaces.js'; import { WorkspaceMetaCollection } from './workspace-meta-collection.js';
import type { WorkspacesChangeEvent } from './workspaces'; import type { WorkspaceMetaCollectionChangeEvent } from './workspace-meta-collection';
test.describe.serial('workspaces observable', () => { test.describe.serial('workspace meta collection observable', () => {
const workspaces = new Workspaces(); const workspaces = new WorkspaceMetaCollection();
const scope = workspaces.createScope(); const scope = workspaces.createScope();
test('add workspace', () => { test('add workspace', () => {
workspaces.once('change', (event: WorkspacesChangeEvent) => { workspaces.once('change', (event: WorkspaceMetaCollectionChangeEvent) => {
expect(event.added?.id).toEqual('123'); expect(event.added?.id).toEqual('123');
}); });
scope.add({ scope.add({
@@ -30,7 +30,7 @@ test.describe.serial('workspaces observable', () => {
}); });
test('update workspace', () => { test('update workspace', () => {
workspaces.once('change', (event: WorkspacesChangeEvent) => { workspaces.once('change', (event: WorkspaceMetaCollectionChangeEvent) => {
expect(event.updated?.name).toEqual('demo'); expect(event.updated?.name).toEqual('demo');
}); });
scope.update('123', { name: 'demo' }); scope.update('123', { name: 'demo' });
@@ -42,7 +42,7 @@ test.describe.serial('workspaces observable', () => {
}); });
test('delete workspace', () => { test('delete workspace', () => {
workspaces.once('change', (event: WorkspacesChangeEvent) => { workspaces.once('change', (event: WorkspaceMetaCollectionChangeEvent) => {
expect(event.deleted?.id).toEqual('123'); expect(event.deleted?.id).toEqual('123');
}); });
scope.remove('123'); scope.remove('123');
@@ -1,7 +1,7 @@
import { Observable } from 'lib0/observable'; import { Observable } from 'lib0/observable';
import type { WorkspaceInfo, WorkspaceMeta } from '../types'; import type { WorkspaceInfo, WorkspaceMeta } from './types';
export interface WorkspacesScope { export interface WorkspaceMetaCollectionScope {
get: (workspaceId: string) => WorkspaceInfo | undefined; get: (workspaceId: string) => WorkspaceInfo | undefined;
list: () => WorkspaceInfo[]; list: () => WorkspaceInfo[];
add: (workspace: WorkspaceInfo) => void; add: (workspace: WorkspaceInfo) => void;
@@ -10,13 +10,13 @@ export interface WorkspacesScope {
update: (workspaceId: string, workspaceMeta: Partial<WorkspaceMeta>) => void; update: (workspaceId: string, workspaceMeta: Partial<WorkspaceMeta>) => void;
} }
export interface WorkspacesChangeEvent { export interface WorkspaceMetaCollectionChangeEvent {
added?: WorkspaceInfo; added?: WorkspaceInfo;
deleted?: WorkspaceInfo; deleted?: WorkspaceInfo;
updated?: WorkspaceInfo; updated?: WorkspaceInfo;
} }
export class Workspaces extends Observable<'change'> { export class WorkspaceMetaCollection extends Observable<'change'> {
private _workspacesMap = new Map<string, WorkspaceInfo>(); private _workspacesMap = new Map<string, WorkspaceInfo>();
get workspaces(): WorkspaceInfo[] { get workspaces(): WorkspaceInfo[] {
@@ -27,7 +27,7 @@ export class Workspaces extends Observable<'change'> {
return this._workspacesMap.get(workspaceId); return this._workspacesMap.get(workspaceId);
} }
createScope(): WorkspacesScope { createScope(): WorkspaceMetaCollectionScope {
const scopedWorkspaceIds = new Set<string>(); const scopedWorkspaceIds = new Set<string>();
const get = (workspaceId: string) => { const get = (workspaceId: string) => {
@@ -47,7 +47,7 @@ export class Workspaces extends Observable<'change'> {
this.emit('change', [ this.emit('change', [
{ {
added: workspace, added: workspace,
} as WorkspacesChangeEvent, } as WorkspaceMetaCollectionChangeEvent,
]); ]);
}; };
@@ -69,7 +69,7 @@ export class Workspaces extends Observable<'change'> {
this.emit('change', [ this.emit('change', [
{ {
deleted: workspace, deleted: workspace,
} as WorkspacesChangeEvent, } as WorkspaceMetaCollectionChangeEvent,
]); ]);
} }
return true; return true;
@@ -99,7 +99,7 @@ export class Workspaces extends Observable<'change'> {
this.emit('change', [ this.emit('change', [
{ {
updated: this._workspacesMap.get(workspaceId), updated: this._workspacesMap.get(workspaceId),
} as WorkspacesChangeEvent, } as WorkspaceMetaCollectionChangeEvent,
]); ]);
}; };
@@ -1,2 +0,0 @@
export { Workspaces } from './workspaces.js';
export type { WorkspacesScope, WorkspacesChangeEvent } from './workspaces';