@xwiki/cristal-sharedworker-impl 0.8.0

package/src/components/worker.ts

@@ -0,0 +1,225 @@
+/**
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ *
+ * This file is part of the Cristal Wiki software prototype
+ * @copyright  Copyright (c) 2023 XWiki SAS
+ * @license    http://opensource.org/licenses/AGPL-3.0 AGPL-3.0
+ *
+ **/
+
+import * as Comlink from "comlink";
+import type { MyWorker, QueueWorker } from "@xwiki/cristal-sharedworker-api";
+import type { CristalApp, WrappingStorage } from "@xwiki/cristal-api";
+import { type WikiConfig } from "@xwiki/cristal-api";
+import { CristalLoader } from "@xwiki/cristal-extension-manager";
+import { ComponentInit as StorageComponentInit } from "@xwiki/cristal-storage";
+import type { Container } from "inversify";
+import { WorkerCristalApp } from "./workerCristalApp";
+import WorkerQueueWorker from "./workerQueueWorker";
+
+export class Worker implements MyWorker {
+  private currentNumber: number = 0;
+  private queue: Array<string> = [];
+  private container: Container;
+  private cristal: CristalApp;
+  private configMap: Map<string, object>;
+  private initialized: boolean = false;
+  private fct: (a: string) => void;
+
+  /*
+     Start worker thread 
+    */
+  public async start() {
+    console.log("Starting worker thread");
+    this.initialize();
+    // eslint-disable-next-line no-constant-condition
+    while (true) {
+      await this.sleep(1000);
+      this.checkQueue();
+    }
+  }
+
+  public setPageLoadedCallback(fct: (a: string) => void): void {
+    this.fct = fct;
+  }
+
+  public sleep(ms: number) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+  }
+
+  public async checkQueue(): Promise<void> {
+    // console.log("Checking queue");
+    const size = this.getQueueSize();
+    // console.log("Current queue size is ", size, this.queue);
+    if (size > 0) {
+      if (this.initialized) {
+        const page = this.queue.pop();
+        if (page) {
+          await this.handleQueueItem(page);
+        }
+        await this.checkQueue();
+      } else {
+        console.log(
+          "Worker cristal code not initialized yet. Cannot process queue items.",
+        );
+      }
+    }
+  }
+
+  public async handleQueueItem(page: string): Promise<void> {
+    console.log("Handling queue item code ready to process", page);
+
+    try {
+      let configName = null;
+      let pageName = null;
+      let type = null;
+      const index1 = page.indexOf(":");
+      const index2 = page.lastIndexOf("_");
+      if (index1 != -1 && index2 != -1) {
+        configName = page.substring(0, index1);
+        pageName = page.substring(index1 + 1, index2);
+        type = page.substring(index2 + 1);
+
+        const wikiConfig = this.getWikiConfig(configName);
+        if (wikiConfig == undefined) {
+          console.log("Could not find config for page", page);
+        } else {
+          console.log("Updating page ", pageName, type);
+          const storage = wikiConfig.storage as WrappingStorage;
+          const result = await storage.updatePageContent(pageName, type);
+          if (result) {
+            console.log("Page updated. Calling back to main thread");
+            this.fct(page);
+          }
+        }
+      } else {
+        console.log("Could not process page", page);
+      }
+    } catch (e) {
+      console.log("Exception while trying to load", page, e);
+    }
+  }
+
+  public add(a: number): number {
+    console.log("Worker in add");
+    this.currentNumber += a;
+    return this.currentNumber;
+  }
+
+  public addToQueue(page: string): void {
+    console.log("Worker in addToQueue", page);
+    if (!this.queue.includes(page)) {
+      this.queue.push(page);
+    }
+    return;
+  }
+
+  public getQueueSize(): number {
+    console.log("Worker in getQueueSize");
+    return this.queue.length;
+  }
+
+  public getWikiConfig(configName: string): WikiConfig | undefined {
+    const wikiConfigObject = this.configMap.get(configName);
+    if (wikiConfigObject == null) {
+      console.error("Failed to find wikiConfig for configName", configName);
+      return undefined;
+    }
+    const wikiConfigMap = new Map(Object.entries(wikiConfigObject));
+    const configType = wikiConfigMap.get("configType");
+    console.log(
+      "Looking for wikiConfig for name",
+      configName,
+      "and type",
+      configType,
+    );
+
+    let wikiConfig;
+    try {
+      wikiConfig = this.container.getNamed<WikiConfig>(
+        "WikiConfig",
+        configType,
+      );
+      this.cristal.setWikiConfig(wikiConfig);
+      wikiConfig.setConfigFromObject(wikiConfigObject);
+
+      // Make sure we have initialized this config
+      // This is necessary for offline mode
+      wikiConfig.initialize();
+
+      console.debug(
+        "Found wikiConfig for",
+        configName,
+        "and type",
+        configType,
+        ":",
+        wikiConfig,
+      );
+      return wikiConfig;
+    } catch (e) {
+      console.error(
+        "Failed to find wikiConfig for name",
+        configName,
+        "and type",
+        configType,
+        e,
+      );
+      return undefined;
+    }
+  }
+
+  public async initialize() {
+    console.log("Starting initialize");
+    const extensionList: Array<string> = ["storage"];
+    const response = await fetch("/config.json");
+    const config = await response.json();
+    this.configMap = new Map(Object.entries(config));
+    console.log("Loaded json config", this.configMap);
+    const cristalLoader = new CristalLoader(extensionList);
+    cristalLoader.initializeContainer();
+    this.container = cristalLoader.container;
+    console.log("Container status", this.container);
+    this.container
+      .bind<CristalApp>("CristalApp")
+      .to(WorkerCristalApp)
+      .inSingletonScope();
+    this.container
+      .bind<QueueWorker>("QueueWorker")
+      .to(WorkerQueueWorker)
+      .inSingletonScope();
+    this.cristal = this.container.get<CristalApp>("CristalApp");
+    this.cristal.setContainer(this.container);
+    console.log("Container status", this.container);
+    new StorageComponentInit(cristalLoader.container);
+    console.log("Loading storage components");
+    this.initialized = true;
+    console.log("Finished initialize");
+  }
+}
+
+const worker = new Worker();
+worker.start();
+
+// @ts-expect-error ignore
+// TODO remove use of any
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+onconnect = (e: any) => {
+  Comlink.expose(worker, e.ports[0]);
+};
+console.log("Worker code loaded");

package/src/components/workerCristalApp.ts

@@ -0,0 +1,146 @@
+/**
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ *
+ * This file is part of the Cristal Wiki software prototype
+ * @copyright  Copyright (c) 2023 XWiki SAS
+ * @license    http://opensource.org/licenses/AGPL-3.0 AGPL-3.0
+ *
+ **/
+
+import type {
+  CristalApp as CristalApp,
+  Logger,
+  LoggerConfig,
+  PageData,
+  SkinManager,
+  WikiConfig,
+} from "@xwiki/cristal-api";
+import type { Container } from "inversify";
+import { injectable } from "inversify";
+import type { App, Component } from "vue";
+import type { Router } from "vue-router";
+
+@injectable()
+export class WorkerCristalApp implements CristalApp {
+  private wikiConfig: WikiConfig;
+  private container: Container;
+  private availableConfigurations: Map<string, WikiConfig>;
+
+  public constructor() {
+    this.availableConfigurations = new Map<string, WikiConfig>();
+  }
+
+  getApp(): App {
+    throw new Error("Method not implemented.");
+  }
+  getRouter(): Router {
+    throw new Error("Method not implemented.");
+  }
+  getContainer(): Container {
+    return this.container;
+  }
+
+  setContainer(container: Container): void {
+    this.container = container;
+  }
+
+  getWikiConfig(): WikiConfig {
+    return this.wikiConfig;
+  }
+  setWikiConfig(wikiConfig: WikiConfig): void {
+    this.wikiConfig = wikiConfig;
+  }
+
+  getSkinManager(): SkinManager {
+    throw new Error("Method not implemented.");
+  }
+
+  switchConfig(): void {}
+
+  // TODO remove use of any
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  setAvailableConfigurations(config: Map<string, any>) {
+    console.log(config);
+    // TODO remove use of any
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    config.forEach((wikiConfigObject: any, key: string) => {
+      const configType = wikiConfigObject?.configType;
+
+      if (wikiConfigObject) {
+        const wikiConfig = this.container.getNamed<WikiConfig>(
+          "WikiConfig",
+          configType,
+        );
+        wikiConfig.setConfigFromObject(wikiConfigObject);
+        this.availableConfigurations.set(key, wikiConfig);
+      }
+    });
+  }
+
+  getAvailableConfigurations(): Map<string, WikiConfig> {
+    return this.availableConfigurations;
+  }
+
+  run(): Promise<void> {
+    throw new Error("Method not implemented.");
+  }
+  getUIXTemplates(): Component[] {
+    throw new Error("Method not implemented.");
+  }
+  getMenuEntries(): string[] {
+    throw new Error("Method not implemented.");
+  }
+  getCurrentPage(): string {
+    throw new Error("Method not implemented.");
+  }
+  getCurrentContent(): string {
+    throw new Error("Method not implemented.");
+  }
+  getCurrentSource(): string {
+    throw new Error("Method not implemented.");
+  }
+  getCurrentSyntax(): string {
+    throw new Error("Method not implemented.");
+  }
+  setCurrentPage(): void {
+    throw new Error("Method not implemented.");
+  }
+  setContentRef(): void {
+    throw new Error("Method not implemented.");
+  }
+  loadPageFromURL(): Promise<void> {
+    throw new Error("Method not implemented.");
+  }
+  loadPage(): Promise<void> {
+    throw new Error("Method not implemented.");
+  }
+  getPage(): Promise<PageData> {
+    throw new Error("Method not implemented.");
+  }
+  getLogger(): Logger {
+    throw new Error("Method not implemented.");
+  }
+  getLoggerConfig(): LoggerConfig {
+    throw new Error("Method not implemented.");
+  }
+
+  renderContent(): Promise<string> {
+    throw new Error("Method not implemented.");
+  }
+}

package/src/components/workerQueueWorker.ts

@@ -0,0 +1,50 @@
+/**
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ *
+ * This file is part of the Cristal Wiki software prototype
+ * @copyright  Copyright (c) 2023 XWiki SAS
+ * @license    http://opensource.org/licenses/AGPL-3.0 AGPL-3.0
+ *
+ **/
+
+import { injectable } from "inversify";
+import type { QueueWorker } from "@xwiki/cristal-sharedworker-api";
+
+@injectable()
+export default class WorkerQueueWorker implements QueueWorker {
+  public constructor() {
+    this.initialize();
+  }
+
+  public initialize() {}
+
+  public getStatus(): boolean {
+    return true;
+  }
+
+  public async increment(): Promise<number> {
+    return 0;
+  }
+
+  public async addToQueue(): Promise<void> {}
+
+  public async getQueueSize(): Promise<number> {
+    return 0;
+  }
+}

package/src/index.ts

@@ -0,0 +1,29 @@
+/**
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ *
+ * This file is part of the Cristal Wiki software prototype
+ * @copyright  Copyright (c) 2023 XWiki SAS
+ * @license    http://opensource.org/licenses/AGPL-3.0 AGPL-3.0
+ *
+ **/
+
+import ComponentInit from "./components/componentsInit";
+import type { QueueWorker } from "@xwiki/cristal-sharedworker-api";
+export type { QueueWorker };
+export { ComponentInit };

package/src/vite-env.d.ts

@@ -0,0 +1,27 @@
+/**
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ *
+ * This file is part of the Cristal Wiki software prototype
+ * @copyright  Copyright (c) 2023 XWiki SAS
+ * @license    http://opensource.org/licenses/AGPL-3.0 AGPL-3.0
+ *
+ **/
+
+/// <reference types="vite-plugin-comlink/client" />
+// eslint-disable-line

package/src/vue.d.ts

@@ -0,0 +1,32 @@
+/**
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ *
+ * This file is part of the Cristal Wiki software prototype
+ * @copyright  Copyright (c) 2023 XWiki SAS
+ * @license    http://opensource.org/licenses/AGPL-3.0 AGPL-3.0
+ *
+ **/
+
+// vue.d.ts
+declare module "*.vue" {
+  import type { DefineComponent } from "vue";
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/ban-types
+  const component: DefineComponent<{}, {}, any>;
+  export default component;
+}

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+    "compilerOptions": {
+        "rootDir" : "src",
+        "outDir" : "dist",
+        "resolveJsonModule": true,
+        "types": ["vite/client"]
+    },
+    "extends": "./../../tsconfig.json",
+    "include": ["./src/index.ts", "./src/**/*"]
+}

package/vite-env.d.ts

@@ -0,0 +1,26 @@
+/**
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ *
+ * This file is part of the Cristal Wiki software prototype
+ * @copyright  Copyright (c) 2023 XWiki SAS
+ * @license    http://opensource.org/licenses/AGPL-3.0 AGPL-3.0
+ *
+ **/
+
+/// <reference types="vite-plugin-comlink/client" />

package/vite.config.ts

@@ -0,0 +1,38 @@
+/**
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ *
+ * This file is part of the Cristal Wiki software prototype
+ * @copyright  Copyright (c) 2023 XWiki SAS
+ * @license    http://opensource.org/licenses/AGPL-3.0 AGPL-3.0
+ *
+ **/
+
+import { generateConfig } from "../../vite.config";
+import { mergeConfig, defineConfig } from "vite";
+import comlink from "vite-plugin-comlink";
+
+export default mergeConfig(
+  generateConfig(import.meta.url),
+  defineConfig({
+    plugins: [comlink()],
+    worker: {
+      plugins: () => [comlink()],
+    },
+  }),
+);