feat: merge keck

.github/workflows/keck.yml

@@ -0,0 +1,67 @@
+name: Build Keck
+
+on:
+    workflow_dispatch:
+    push:
+        branches: [master]
+        paths:
+            - 'apps/keck/**'
+            - '.github/workflows/keck.yml'
+    pull_request:
+        branches: [master]
+        paths:
+            - 'apps/keck/**'
+            - '.github/workflows/keck.yml'
+
+# Cancels all previous workflow runs for pull requests that have not completed.
+# See https://docs.github.com/en/actions/using-jobs/using-concurrency
+concurrency:
+    # The concurrency group contains the workflow name and the branch name for
+    # pull requests or the commit hash for any other events.
+    group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.head_ref || github.sha }}
+    cancel-in-progress: true
+
+env:
+    REGISTRY: ghcr.io
+    NAMESPACE: toeverything
+    KECK_IMAGE_NAME: keck
+    IMAGE_TAG: canary-${{ github.sha }}
+    IMAGE_TAG_LATEST: nightly-latest
+
+jobs:
+    ligo-virgo:
+        runs-on: self-hosted
+        environment: development
+        permissions:
+            contents: read
+            packages: write
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v2
+
+            - name: Log in to the Container registry
+              uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
+              with:
+                  registry: ${{ env.REGISTRY }}
+                  username: ${{ github.actor }}
+                  password: ${{ secrets.GITHUB_TOKEN }}
+
+            - name: Extract metadata (tags, labels) for Docker (keck)
+              id: meta_keck
+              uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
+              with:
+                  images: ${{ env.REGISTRY }}/${{ env.NAMESPACE }}/${{ env.KECK_IMAGE_NAME }}
+                  tags: |
+                      ${{ env.IMAGE_TAG }}
+                      ${{ env.IMAGE_TAG_LATEST }}
+
+            - name: Build and push Docker image (keck)
+              uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+              with:
+                  context: .
+                  file: ./Dockerfile-keck
+                  push: ${{ github.ref == 'refs/heads/field' && true || false }}
+                  tags: ${{ steps.meta_keck.outputs.tags }}
+                  labels: ${{ steps.meta_keck.outputs.labels }}
+                  target: keck

Dockerfile-keck

@@ -0,0 +1,33 @@
+FROM node:16-alpine as builder
+WORKDIR /app
+COPY . .
+RUN apk add g++ make python3 git
+RUN npm i -g pnpm@7 && pnpm i --frozen-lockfile --store=node_modules/.pnpm-store && pnpm run build:keck
+
+FROM node:16-alpine as node_modules
+WORKDIR /app
+COPY --from=builder /app/dist/apps/keck .
+COPY --from=builder /app/apps/keck/package.prod.json ./package.json
+RUN npm i
+
+# =============
+# keck image
+# =============
+FROM node:16-alpine as keck
+WORKDIR /app
+COPY --from=node_modules /app .
+
+ENV FIREBASE_ACCOUNT=
+ENV FIREBASE_CERT=
+ENV FIREBASE_PROJECT=
+ENV HOST=0.0.0.0
+ENV PORT=3000
+
+# 编码相关
+ENV TZ 'Asia/Shanghai'
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US:en
+ENV LC_ALL en_US.UTF-8
+
+EXPOSE 3000
+CMD ["node", "main.js"]

README.md

@@ -67,6 +67,7 @@ Have a look at [the examples to see AFFiNE in action](https://app.affine.pro/).
 -   [how-to-customize-rollup-config.md](docs/how-to-customize-rollup-config.md)
 -   [how-to-auto-download-figma-assets-in-affine.md](docs/how-to-auto-download-figma-assets-in-affine.md)
 -   [affine-icons-user-guide.md](docs/affine-icons-user-guide.md)
+-   [How to develop api server in virgo](./apps/keck/README.md)
 
 ## Community
 

apps/keck/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+    "extends": ["../../.eslintrc.json"],
+    "ignorePatterns": ["!**/*"],
+    "overrides": [
+        {
+            "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+            "rules": {}
+        },
+        {
+            "files": ["*.ts", "*.tsx"],
+            "rules": {}
+        },
+        {
+            "files": ["*.js", "*.jsx"],
+            "rules": {}
+        }
+    ]
+}

apps/keck/jest.config.ts

@@ -0,0 +1,16 @@
+/* eslint-disable */
+export default {
+    displayName: 'keck',
+    preset: '../../jest.preset.js',
+    globals: {
+        'ts-jest': {
+            tsconfig: '<rootDir>/tsconfig.spec.json',
+        },
+    },
+    testEnvironment: 'node',
+    transform: {
+        '^.+\\.[tj]s$': 'ts-jest',
+    },
+    moduleFileExtensions: ['ts', 'js', 'html'],
+    coverageDirectory: '../../coverage/apps/keck',
+};

apps/keck/package.json

@@ -0,0 +1,22 @@
+{
+    "name": "@toeverything/keck",
+    "version": "0.0.1",
+    "license": "MIT",
+    "author": "DarkSky <darksky2048@gmail.com>",
+    "main": "jest.config.ts",
+    "dependencies": {
+        "authing-js-sdk": "^4.23.33",
+        "firebase-admin": "^11.0.0",
+        "lib0": "^0.2.51",
+        "lru-cache": "^7.13.0",
+        "nanoid": "^4.0.0",
+        "readable-stream": "^4.1.0",
+        "ws": "^8.8.0",
+        "y-protocols": "^1.0.5",
+        "yjs": "^13.5.39"
+    },
+    "devDependencies": {
+        "@types/readable-stream": "^2.3.13",
+        "@types/ws": "^8.5.3"
+    }
+}

apps/keck/package.prod.json

@@ -0,0 +1,9 @@
+{
+    "name": "@toeverything/keck",
+    "license": "MIT",
+    "version": "0.0.1",
+    "dependencies": {
+        "level": "^8.0.0",
+        "level-read-stream": "1.1.0"
+    }
+}

apps/keck/project.json

@@ -0,0 +1,52 @@
+{
+    "$schema": "../../node_modules/nx/schemas/project-schema.json",
+    "sourceRoot": "apps/keck/src",
+    "projectType": "application",
+    "targets": {
+        "build": {
+            "executor": "@nrwl/node:webpack",
+            "outputs": ["{options.outputPath}"],
+            "options": {
+                "outputPath": "dist/apps/keck",
+                "main": "apps/keck/src/index.ts",
+                "tsConfig": "apps/keck/tsconfig.app.json",
+                "assets": []
+            },
+            "configurations": {
+                "production": {
+                    "optimization": true,
+                    "extractLicenses": true,
+                    "inspect": false,
+                    "fileReplacements": [
+                        {
+                            "replace": "apps/keck/src/environments/environment.ts",
+                            "with": "apps/keck/src/environments/environment.prod.ts"
+                        }
+                    ]
+                }
+            }
+        },
+        "serve": {
+            "executor": "@nrwl/node:node",
+            "options": {
+                "buildTarget": "keck:build"
+            }
+        },
+        "lint": {
+            "executor": "@nrwl/linter:eslint",
+            "outputs": ["{options.outputFile}"],
+            "options": {
+                "lintFilePatterns": ["apps/keck/**/*.ts"]
+            }
+        },
+        "test": {
+            "executor": "@nrwl/jest:jest",
+            "outputs": ["coverage/apps/keck"],
+            "options": {
+                "jestConfig": "apps/keck/jest.config.ts",
+                "passWithNoTests": true
+            }
+        }
+    },
+    "tags": []
+}

apps/keck/src/environments/environment.prod.ts

@@ -0,0 +1,3 @@
+export const environment = {
+    production: true,
+};

apps/keck/src/environments/environment.ts

@@ -0,0 +1,3 @@
+export const environment = {
+    production: false,
+};

apps/keck/src/index.ts

@@ -0,0 +1,118 @@
+import WebSocket = require('ws');
+import http = require('http');
+
+// import authing = require('authing-js-sdk');
+import firebaseApp = require('firebase-admin/app');
+import firebaseAuth = require('firebase-admin/auth');
+import LRUCache = require('lru-cache');
+import nanoid = require('nanoid');
+
+import { handleConnection } from './utils';
+import { URL } from 'url';
+
+if (process.env.NODE_ENV !== 'development') {
+    firebaseApp.initializeApp({
+        credential: firebaseApp.cert({
+            clientEmail: process.env.FIREBASE_ACCOUNT,
+            privateKey: process.env.FIREBASE_CERT,
+            projectId: process.env.FIREBASE_PROJECT,
+        }),
+        projectId: process.env.FIREBASE_PROJECT,
+    });
+}
+
+const _getWorkspace = (path: string) => {
+    const [_, part1] = path.split('/collaboration/');
+    const [workspace] = part1?.split('/') || [];
+    return workspace;
+};
+
+const AFFINE_COMMON_WORKSPACE = 'affine2vin277tcmafwq';
+
+const _checkAuth = async (
+    request: http.IncomingMessage,
+    response: http.ServerResponse,
+    callback: (response: http.OutgoingMessage, workspace: string) => boolean
+) => {
+    if (process.env.NODE_ENV === 'development') {
+        const url = new URL(request.url, `http://${request.headers.host}`);
+        const workspace = _getWorkspace(url.pathname);
+        if (workspace) return callback(response, workspace);
+        return false;
+    } else {
+        try {
+            const decodedToken = await firebaseAuth
+                .getAuth()
+                .verifyIdToken(request.headers.token as string);
+            const allowWorkspace = [AFFINE_COMMON_WORKSPACE, decodedToken.uid];
+            const url = new URL(request.url, `http://${request.headers.host}`);
+            const workspace = _getWorkspace(url.pathname);
+            if (allowWorkspace.includes(workspace)) {
+                return callback(response, workspace);
+            }
+        } catch (error) {
+            console.log(error);
+        }
+        return false;
+    }
+};
+
+const HOST = process.env.HOST || 'localhost';
+const PORT = process.env.PORT || 3000;
+
+const _tokens = new LRUCache<string, string>({
+    max: 10240,
+    ttl: 1000 * 60 * 5,
+});
+
+const _server = http.createServer((request, response) => {
+    if (
+        request.method === 'POST' &&
+        typeof request.headers.token === 'string'
+    ) {
+        _checkAuth(request, response, (response, workspace) => {
+            const protocol = nanoid.nanoid(16);
+            _tokens.set(protocol, workspace);
+            response.end(JSON.stringify({ protocol }));
+            return true;
+        })
+            .then(responded => {
+                if (!responded) {
+                    response.writeHead(401).end();
+                }
+            })
+            .catch(error => {
+                console.log(error);
+                response.writeHead(401).end();
+            });
+        return;
+    }
+    response.writeHead(200, { 'Content-Type': 'text/plain' });
+    response.end('okay');
+});
+
+const _websocketServer = new WebSocket.Server({ noServer: true });
+_websocketServer.on('connection', handleConnection);
+
+_server.on('upgrade', (request, socket, head) => {
+    // You may check auth of request here..
+    // See https://github.com/websockets/ws#client-authentication
+    const protocol = request.headers['sec-websocket-protocol'];
+    if (typeof protocol === 'string' && _tokens.get(protocol)) {
+        _websocketServer.handleUpgrade(request, socket, head, ws => {
+            _websocketServer.emit(
+                'connection',
+                ws,
+                request,
+                _tokens.get(protocol)
+            );
+        });
+    } else {
+        socket.write('HTTP/1.1 401 Unauthorized');
+        socket.destroy();
+    }
+});
+
+_server.listen(PORT, () => {
+    console.log(`running at '${HOST}' on port ${PORT}`);
+});

apps/keck/src/utils.ts

@@ -0,0 +1,239 @@
+import WebSocket = require('ws');
+import http = require('http');
+import Y = require('yjs');
+import lib0 = require('lib0');
+import awarenessProtocol = require('y-protocols/awareness');
+import syncProtocol = require('y-protocols/sync');
+// import { getPersistenceStorage } from './persistence';
+
+const { encoding, decoding, mutex, map } = lib0;
+
+const wsReadyStateConnecting = 0;
+const wsReadyStateOpen = 1;
+
+// disable gc when using snapshots!
+const gcEnabled = process.env.GC !== 'false' && process.env.GC !== '0';
+
+type Persistence =
+    | ((arg0: string, arg1: WSSharedDoc) => Promise<any>)
+    | undefined;
+const persistence: Persistence = null; // getPersistenceStorage('./affine');
+
+const docs: Map<string, WSSharedDoc> = new Map();
+
+const messageSync = 0;
+const messageAwareness = 1;
+// const messageAuth = 2
+
+const updateHandler = (update: Uint8Array, origin: any, doc: WSSharedDoc) => {
+    const encoder = encoding.createEncoder();
+    encoding.writeVarUint(encoder, messageSync);
+    syncProtocol.writeUpdate(encoder, update);
+    const message = encoding.toUint8Array(encoder);
+    doc.conns.forEach((_, conn) => send(doc, conn, message));
+};
+
+type AwarenessEvent = {
+    added: Array<number>;
+    updated: Array<number>;
+    removed: Array<number>;
+};
+
+export class WSSharedDoc extends Y.Doc {
+    name: string;
+    mux: lib0.mutex.mutex;
+    conns: Map<any, any>;
+    awareness: awarenessProtocol.Awareness;
+    /**
+     * @param {string} name
+     */
+    constructor(name: string) {
+        super({ gc: gcEnabled });
+        this.name = name;
+        this.mux = mutex.createMutex();
+        /**
+         * Maps from conn to set of controlled user ids. Delete all user ids from awareness when this conn is closed
+         * @type {Map<Object, Set<number>>}
+         */
+        this.conns = new Map();
+        /**
+         * @type {awarenessProtocol.Awareness}
+         */
+        this.awareness = new awarenessProtocol.Awareness(this);
+        this.awareness.setLocalState(null);
+
+        const awarenessChangeHandler = (
+            { added, updated, removed }: AwarenessEvent,
+            conn: object | null
+        ) => {
+            const changedClients = added.concat(updated, removed);
+            if (conn !== null) {
+                const connControlledIds: Set<number> = this.conns.get(conn);
+                if (connControlledIds !== undefined) {
+                    added.forEach(clientId => {
+                        connControlledIds.add(clientId);
+                    });
+                    removed.forEach(clientId => {
+                        connControlledIds.delete(clientId);
+                    });
+                }
+            }
+            // broadcast awareness update
+            const encoder = encoding.createEncoder();
+            encoding.writeVarUint(encoder, messageAwareness);
+            encoding.writeVarUint8Array(
+                encoder,
+                awarenessProtocol.encodeAwarenessUpdate(
+                    this.awareness,
+                    changedClients
+                )
+            );
+            const buff = encoding.toUint8Array(encoder);
+            this.conns.forEach((_, c) => {
+                send(this, c, buff);
+            });
+        };
+        this.awareness.on('update', awarenessChangeHandler);
+        this.on('update', updateHandler);
+    }
+}
+
+// Gets a Y.Doc by name, whether in memory or on disk
+const getYDoc = (docname: string, gc = true): WSSharedDoc =>
+    map.setIfUndefined(docs, docname, () => {
+        const doc = new WSSharedDoc(docname);
+        doc.gc = gc;
+        if (persistence !== null) {
+            persistence(docname, doc);
+        }
+        docs.set(docname, doc);
+        return doc;
+    });
+
+const messageListener = (conn: any, doc: WSSharedDoc, message: Uint8Array) => {
+    try {
+        const encoder = encoding.createEncoder();
+        const decoder = decoding.createDecoder(message);
+        const messageType = decoding.readVarUint(decoder);
+        switch (messageType) {
+            case messageSync:
+                encoding.writeVarUint(encoder, messageSync);
+                syncProtocol.readSyncMessage(decoder, encoder, doc, null);
+                if (encoding.length(encoder) > 1) {
+                    send(doc, conn, encoding.toUint8Array(encoder));
+                }
+                break;
+            case messageAwareness: {
+                awarenessProtocol.applyAwarenessUpdate(
+                    doc.awareness,
+                    decoding.readVarUint8Array(decoder),
+                    conn
+                );
+                break;
+            }
+        }
+    } catch (err) {
+        console.error(err);
+        doc.emit('error', [err]);
+    }
+};
+
+const closeConn = (doc: WSSharedDoc, conn: any) => {
+    if (doc.conns.has(conn)) {
+        const controlledIds: Set<number> = doc.conns.get(conn);
+        doc.conns.delete(conn);
+        awarenessProtocol.removeAwarenessStates(
+            doc.awareness,
+            Array.from(controlledIds),
+            null
+        );
+        if (doc.conns.size === 0 && persistence !== null) {
+            // if persisted, we store state and destroy ydocument
+            persistence(doc.name, doc).then(() => {
+                doc.destroy();
+            });
+            docs.delete(doc.name);
+        }
+    }
+    conn.close();
+};
+
+const send = (doc: WSSharedDoc, conn: any, m: Uint8Array) => {
+    if (
+        conn.readyState !== wsReadyStateConnecting &&
+        conn.readyState !== wsReadyStateOpen
+    ) {
+        closeConn(doc, conn);
+    }
+    try {
+        conn.send(m, (/** @param {any} err */ err: any) => {
+            err != null && closeConn(doc, conn);
+        });
+    } catch (e) {
+        closeConn(doc, conn);
+    }
+};
+
+export const handleConnection = (
+    socket: WebSocket.WebSocket,
+    request: http.IncomingMessage,
+    docName: string
+) => {
+    const gc = true;
+    socket.binaryType = 'arraybuffer';
+    // get doc, initialize if it does not exist yet
+    const doc = getYDoc(docName, gc);
+    doc.conns.set(socket, new Set());
+    // listen and reply to events
+    socket.on('message', (message: ArrayBuffer) =>
+        messageListener(socket, doc, new Uint8Array(message))
+    );
+
+    // Check if connection is still alive
+    let pongReceived = true;
+    const pingInterval = setInterval(() => {
+        if (!pongReceived) {
+            if (doc.conns.has(socket)) {
+                closeConn(doc, socket);
+            }
+            clearInterval(pingInterval);
+        } else if (doc.conns.has(socket)) {
+            pongReceived = false;
+            try {
+                socket.ping();
+            } catch (e) {
+                closeConn(doc, socket);
+                clearInterval(pingInterval);
+            }
+        }
+    }, 30 * 1000);
+    socket.on('close', () => {
+        closeConn(doc, socket);
+        clearInterval(pingInterval);
+    });
+    socket.on('pong', () => {
+        pongReceived = true;
+    });
+    // put the following in a variables in a block so the interval handlers don't keep in in
+    // scope
+    {
+        // send sync step 1
+        const encoder = encoding.createEncoder();
+        encoding.writeVarUint(encoder, messageSync);
+        syncProtocol.writeSyncStep1(encoder, doc);
+        send(doc, socket, encoding.toUint8Array(encoder));
+        const awarenessStates = doc.awareness.getStates();
+        if (awarenessStates.size > 0) {
+            const encoder = encoding.createEncoder();
+            encoding.writeVarUint(encoder, messageAwareness);
+            encoding.writeVarUint8Array(
+                encoder,
+                awarenessProtocol.encodeAwarenessUpdate(
+                    doc.awareness,
+                    Array.from(awarenessStates.keys())
+                )
+            );
+            send(doc, socket, encoding.toUint8Array(encoder));
+        }
+    }
+};

apps/keck/tsconfig.app.json

@@ -0,0 +1,10 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "outDir": "../../dist/out-tsc",
+        "module": "commonjs",
+        "types": ["node"]
+    },
+    "exclude": ["jest.config.ts", "**/*.spec.ts", "**/*.test.ts"],
+    "include": ["**/*.ts"]
+}

apps/keck/tsconfig.json

@@ -0,0 +1,13 @@
+{
+    "extends": "../../tsconfig.base.json",
+    "files": [],
+    "include": [],
+    "references": [
+        {
+            "path": "./tsconfig.app.json"
+        },
+        {
+            "path": "./tsconfig.spec.json"
+        }
+    ]
+}

apps/keck/tsconfig.spec.json

@@ -0,0 +1,9 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "outDir": "../../dist/out-tsc",
+        "module": "commonjs",
+        "types": ["jest", "node"]
+    },
+    "include": ["jest.config.ts", "**/*.test.ts", "**/*.spec.ts", "**/*.d.ts"]
+}

libs/datasource/remote-kv/src/aws/aws-attachment.ts

@@ -1,4 +1,3 @@
-
 import * as AWS from 'aws-sdk';
 import type { Credentials } from 'aws-sdk';
 import type { ManagedUpload } from 'aws-sdk/lib/s3/managed_upload';

package.json

@@ -6,7 +6,9 @@
     "scripts": {
         "start": "nx serve ligo-virgo",
         "start:free": "env-cmd -f .free.env nx serve ligo-virgo",
+        "start:keck": "nx serve keck",
         "build": "nx build ligo-virgo",
+        "build:keck": "nx build keck",
         "build:analytic": "cross-env BUNDLE_ANALYZER=true nx build --skip-nx-cache",
         "test": "nx run-many --target test --all",
         "check": "nx run-many --target check --all",
@@ -15,8 +17,8 @@
         "add:framework": "nx generate @nrwl/react:library --style=none --directory=framework --buildable --no-component --no-routing --tags=framework",
         "add:library": "nx generate @nrwl/react:library --style=none --buildable --no-component --no-routing --tags=library",
         "notify": "node --experimental-modules tools/notify.mjs",
-        "lint": "nx run-many --target=lint --all --fix --skip-nx-cache --exclude=components-common,theme",
-        "lint:with-cache": "nx run-many --target=lint --all --exclude=components-common,theme",
+        "lint": "nx run-many --target=lint --all --fix --skip-nx-cache --exclude=components-common,keck,theme",
+        "lint:with-cache": "nx run-many --target=lint --all --exclude=components-common,keck,theme",
         "format": "nx format",
         "format:ci": "nx format:check",
         "type:check": "nx build ligo-virgo",

workspace.json

@@ -26,6 +26,7 @@
         "datasource-remote-kv": "libs/datasource/remote-kv",
         "datasource-state": "libs/datasource/state",
         "framework-virgo": "libs/framework/virgo",
+        "keck": "apps/keck",
         "ligo-virgo": "apps/ligo-virgo",
         "utils": "libs/utils"
     }