@raclettejs/core 0.1.11 → 0.1.12

package/services/frontend/src/core/lib/data/fetchDataHandler.ts

@@ -1,5 +1,8 @@
 import log from "@racletteCore/lib/logger"
-import { promisifyActionResolve } from "@racletteCore/lib/dataHelper"
+import {
+  promisifyActionResolve,
+  markDataAsModified,
+} from "@racletteCore/lib/dataHelper"
 import { $api, $store } from "@racletteCore"
 import {
   pluginReadOperations,
@@ -10,6 +13,7 @@ import {
   getCacheQueryAndHash,
   isParentResultFresh,
 } from "@racletteCore/store/reducers/queriesCache/queryCacheHelper"
+import { $eventbus } from "@racletteCore"
 
 // to be replaced with actual open search availability state
 let isOnline = true
@@ -63,7 +67,6 @@ const itemDispatcher = async (
   const { actionId, cacheKey } = actionIdentifier
   const { result, backendQueryParams } = resultObj
   const resolveId = actionId + "_resolve"
-
   if (remote) {
     $store.dispatch({
       type: "data/addFromServer",
@@ -81,7 +84,6 @@ const itemDispatcher = async (
       type: "queries/update",
       payload: {
         actionId,
-        cacheKey,
         backend: backendQueryParams,
       },
     })
@@ -124,7 +126,13 @@ const cacheOperations = {
         target,
       },
     })
-
+    await $store.dispatch({
+      type: "queries/setCacheKey",
+      payload: {
+        cacheKey: cachedQuery.hash,
+        actionId,
+      },
+    })
     return { cachedQuery, actionIdentifier }
   },
 
@@ -163,8 +171,12 @@ const finishRemoteQuery = (actionIdentifier, result, params, options) => {
   if (!result.data) {
     return
   }
+  let resultBody = structuredClone(result.data.body)
+  const { type } = result.data
+  if (type === "dataReadModified") {
+    resultBody = markDataAsModified(resultBody)
+  }
 
-  const resultBody = structuredClone(result.data.body)
   const resultObj = {
     result: [],
     backendQueryParams: {},
@@ -225,8 +237,20 @@ const handleRemoteRequest = async (
   try {
     const response =
       method === "GET"
-        ? await $api.axios.get(target, config)
-        : await $api.axios.post(target, params, config)
+        ? await $api.axios.get(target, config).catch((e) => {
+            $eventbus.emit("ui/addToSnackbar", {
+              message: e.response.data.message,
+              color: "error",
+            })
+            throw e
+          })
+        : await $api.axios.post(target, params, config).catch((e) => {
+            $eventbus.emit("ui/addToSnackbar", {
+              message: e.response.data.message,
+              color: "error",
+            })
+            throw e
+          })
 
     return {
       response,
@@ -408,14 +432,16 @@ const executeRoute = async (actionIdentifier, validTarget, params, options) => {
           params,
           options,
           controller.signal,
-        )
+        ).catch((e) => {
+          log.error(e.error, e.message)
+        })
         requestControllerManager.cleanup(actionIdentifier.actionId)
         return result
       } catch (error) {
         requestControllerManager.cleanup(actionIdentifier.actionId)
 
         if (error.name === "AbortError" || error.name === "CanceledError") {
-          console.log(
+          log.api(
             "HTTP request was cancelled for actionId:",
             actionIdentifier.actionId,
           )
@@ -438,29 +464,34 @@ const getData = async (actionId, target, params, options) => {
 
   // Handle plugin routing
   const { validTarget } = await handlePluginReadRoutes(actionId, target, params)
-
-  // Setup cache
-  const { cachedQuery, actionIdentifier } = await cacheOperations.setupCache(
-    actionId,
-    validTarget,
-    params,
-    options,
-  )
-  // Check cache
-  if (cachedQuery?.query) {
-    const cacheResult = await cacheOperations.handleCacheHit(
-      cachedQuery,
-      actionIdentifier,
+  if (options?.useCache !== false) {
+    // Setup cache
+    const { cachedQuery, actionIdentifier } = await cacheOperations.setupCache(
+      actionId,
+      validTarget,
+      params,
+      options,
     )
-    if (cacheResult !== null) {
-      return {
-        response: "cached_" + cachedQuery.hash,
-        result: cacheResult,
+    // Check cache
+    if (cachedQuery?.query) {
+      const cacheResult = await cacheOperations.handleCacheHit(
+        cachedQuery,
+        actionIdentifier,
+      )
+      if (cacheResult !== null) {
+        return {
+          response: "cached_" + cachedQuery.hash,
+          result: cacheResult,
+        }
       }
     }
+
+    // Execute route
+    return executeRoute(actionIdentifier, validTarget, params, options)
   }
+
   // Execute route
-  return executeRoute(actionIdentifier, validTarget, params, options)
+  return executeRoute({ actionId }, validTarget, params, options)
 }
 
 export default getData

package/services/frontend/src/core/lib/data/queryApi.ts

@@ -8,14 +8,16 @@ import type { CustomStoreActionsPayload } from "@racletteCore/types"
 import { BehaviorSubject } from "rxjs"
 import { mergeDeepRight, clone } from "ramda"
 
+const callbacks = {}
 const queryApis = {}
 
 export const $queryApi = (
   actionId: string,
   target = "",
-  { params = {}, options = {} }: CustomStoreActionsPayload = {},
+  { params = {}, options = {}, config = {} }: CustomStoreActionsPayload = {},
 ) => {
   if (queryApis[actionId] && !target.length) {
+    // Early return existing queryApi
     return queryApis[actionId]
   }
   const errorSubject$ = new BehaviorSubject(null)
@@ -24,13 +26,22 @@ export const $queryApi = (
   // check if we have a query fullfilling the needs of the one requested
   // here. If not we will update the one with this actionId
   let actionType = "queries/add"
-
+  if (!options.hasOwnProperty("useCache")) {
+    options.useCache = true
+  }
+  if (options.cb) {
+    // remove callback function to prevent it from tainting the store reducers
+    callbacks[actionId] = options.cb
+    delete options.cb
+  }
   $store.dispatch({
     type: actionType,
     payload: {
       actionId,
       target,
       params: cleanedParams,
+      options,
+      config,
     },
   })
   const queryApi = {
@@ -38,11 +49,21 @@ export const $queryApi = (
     response$: responseSubject$.asObservable(),
     query$: $store.select((state) => state.queries[actionId]),
     uuids$: $store.select((state) => state.queries[actionId].uuids),
-    remove: () => {
-      $store.dispatch({
+    clear: async () => {
+      errorSubject$.next({})
+      responseSubject$.next({})
+      await $store.dispatch({
+        type: "queries/updateItems",
+        payload: { items: {}, actionId },
+      })
+    },
+    remove: async () => {
+      await $store.dispatch({
         type: "queries/remove",
         payload: { actionId },
       })
+      delete callbacks[actionId]
+      responseSubject$.complete()
       errorSubject$.complete()
     },
     execute: async (executeParams = {}) => {
@@ -50,7 +71,7 @@ export const $queryApi = (
       errorSubject$.next(null)
       responseSubject$.next({})
       const queryParams = mergeDeepRight(cleanedParams, _executeParams)
-      $store.dispatch({
+      await $store.dispatch({
         type: "queries/update",
         payload: {
           loading: true,
@@ -69,10 +90,10 @@ export const $queryApi = (
         errorSubject$.next(errorObj)
       })
       responseSubject$.next(resultData?.response)
-      if (options.cb && typeof options.cb === "function") {
-        options.cb(resultData)
+      if (callbacks[actionId] && typeof callbacks[actionId] === "function") {
+        callbacks[actionId](resultData)
       }
-      if (resultData.result) {
+      if (resultData?.result) {
         resultData.result = await resultData.result
       }
       return resultData

package/services/frontend/src/core/lib/data/responseTypeHandler.ts

@@ -4,7 +4,7 @@ import {
   transformOperationResults,
 } from "@racletteCore/lib/dataHelper"
 import * as userNotifier from "@racletteCore/lib/userNotifier"
-import { $store } from "@racletteCore"
+import { $store, markDataAsModified } from "@racletteCore"
 
 const handledRequests = {}
 const hasBeenHandled = (requestId, appRequestCode) => {
@@ -76,16 +76,16 @@ const handler = {
 
     return data.items
   },
-  dataPush: (
+  dataRead: (
     data,
     isOwnRequest,
-    appRequestCode = "dataPush",
+    appRequestCode = "dataRead",
     requestId,
     direct,
     notify,
     isSystemAction,
   ) => {
-    log.api("dataPush", {
+    log.api("dataRead", {
       direct,
       isOwnRequest,
       isSystemAction,
@@ -97,6 +97,29 @@ const handler = {
     $store.dispatch({ type: "data/push", payload: data.items || [] })
     return data.items
   },
+  dataReadModified: (
+    data,
+    isOwnRequest,
+    appRequestCode = "dataReadModified",
+    requestId,
+    direct,
+    notify,
+    isSystemAction,
+  ) => {
+    const modifiedData = markDataAsModified(data)
+
+    log.api("dataReadModified", {
+      direct,
+      isOwnRequest,
+      isSystemAction,
+      appRequestCode,
+      requestId,
+      modifiedData,
+    })
+
+    $store.dispatch({ type: "data/push", payload: modifiedData.items || [] })
+    return data.items
+  },
   dataDelete: (
     data,
     isOwnRequest,

package/services/frontend/src/core/lib/data/writeDataHandler.ts

@@ -29,7 +29,7 @@ const createAxiosConfig = (appRequestCode, pluginItemRequestConfig) => {
 const reportError = (error) => {
   const message = error?.response?.data?.message || false
 
-  $eventbus.emit("ui_addToSnackBar", {
+  $eventbus.emit("ui/addToSnackbar", {
     message,
     i18n: message ? false : "core.error.noConnectionToServer",
     color: "error",

package/services/frontend/src/core/lib/dataHelper.ts

@@ -35,7 +35,13 @@ const handleDataIdPrefixing = (prefix, id) => {
 
   return prefix + id
 }
-
+const markDataAsModified = (data) => {
+  const modifiedData = clone(data)
+  modifiedData?.items.forEach((item) => {
+    item._id = `m_${item._id}`
+  })
+  return modifiedData
+}
 const debounceHelper = (time = 500) => {
   let debounceTimer = false
 
@@ -437,6 +443,7 @@ const promisifyActionResolve = (resolveId: string, callback?: Function) => {
   })
 }
 export {
+  markDataAsModified,
   promisifyActionResolve,
   capitalize,
   handleDataIdPrefixing,

package/services/frontend/src/core/lib/easteregg.ts

@@ -14,7 +14,7 @@ const eggMe = (egg) => {
   }
 
   return eggs[egg](() => {
-    $eventbus.emit("ui_addToSnackBar", {
+    $eventbus.emit("ui/addToSnackbar", {
       i18n: "core.eggcontrols." + egg,
       color: "info",
     })

package/services/frontend/src/core/lib/eventEmitter.ts

@@ -74,6 +74,7 @@ class EventEmitter {
     if (!this.isValid(event)) {
       return false
     }
+    log.event(`Emit sent for ${event}`, args)
     if (typeof this.events[event] === "object") {
       this.events[event].forEach((listener) => listener.apply(this, args))
     }

package/services/frontend/src/core/lib/eventWhitelist.ts

@@ -11,13 +11,23 @@
  * - use speaking event names, even though they are longer
  * - distinguish between a information and request (e.g. store_dispatch is a request to the store)
  */
-const eventWhitelist = [
+const legacyEventWhitelist = [
   "socket_joinRoom",
   "socket_leaveRoom",
   "socket_dataUpdated",
   "ui_setupProject",
   "ui_addToSnackBar",
 ]
+const eventWhitelist = legacyEventWhitelist.concat([
+  "forms/init",
+  "forms/validate",
+  "widgets/reset/workingState",
+  "ui/addToSnackbar",
+  "ui/setupProject",
+  "socket/data/update",
+  "socket/join/room",
+  "socket/leave/room",
+])
 const eventWildcards = [
   "query_deleted",
   "store_actionResolved",

package/services/frontend/src/core/lib/logger.ts

@@ -217,7 +217,7 @@ class Logger {
 
   error(
     title: string,
-    message?: LogMessage,
+    message?: LogMessage | any,
     level: LogLevel = LogLevel.NoLogging,
   ): void {
     this.log(message, "error", title, level)
@@ -247,8 +247,16 @@ class Logger {
    * Create a plugin-specific logger
    */
   plugin(pluginKey: string): PluginLogger {
-    return (title: string, message?: LogMessage, level?: LogLevel): void => {
-      this.log(message, "plugin", `${pluginKey} - ${title}`, level)
+    return (
+      title: string,
+      message?: LogMessage | any,
+      level?: LogLevel,
+    ): void => {
+      if (title === "error") {
+        this.error(`plugin ${pluginKey} - ${message.error}`, message)
+      } else {
+        this.log(message, "plugin", `${pluginKey} - ${title}`, level)
+      }
     }
   }
 }

package/services/frontend/src/core/lib/userNotifier.ts

@@ -35,7 +35,7 @@ const setServerDisconnected = () => {
 const dataCreate = (isAnswerToOwnRequest, isSystemAction, items) => {
   items.forEach((item) => {
     if (isAnswerToOwnRequest) {
-      $eventbus.emit("ui_addToSnackBar", {
+      $eventbus.emit("ui/addToSnackbar", {
         i18n: "core.dataCreate$displayName$type",
         content: { displayName: item._displayName, type: item._type },
         color: "success",
@@ -61,7 +61,7 @@ const dataCreate = (isAnswerToOwnRequest, isSystemAction, items) => {
 const dataUpdate = (isAnswerToOwnRequest, isSystemAction, items) => {
   items.forEach((item) => {
     if (isAnswerToOwnRequest) {
-      $eventbus.emit("ui_addToSnackBar", {
+      $eventbus.emit("ui/addToSnackbar", {
         i18n: "core.dataUpdate$displayName$type",
         content: { displayName: item._displayName, type: item._type },
         color: "success",
@@ -89,7 +89,7 @@ const projectUpdate = (isAnswerToOwnRequest, isSystemAction, items) => {
     const displayValues = item._source
 
     if (isAnswerToOwnRequest) {
-      $eventbus.emit("ui_addToSnackBar", {
+      $eventbus.emit("ui/addToSnackbar", {
         i18n: "core.projectUpdate$shorttitle",
         content: { shorttitle: displayValues.shorttitle },
         color: "success",
@@ -111,20 +111,20 @@ const projectUpdate = (isAnswerToOwnRequest, isSystemAction, items) => {
     }
   })
 
-  $eventbus.emit("ui_addToSnackBar", {
+  $eventbus.emit("ui/addToSnackbar", {
     i18n: "core.reloadPageHint",
     color: "info",
   })
 }
 
 const projectConfigUpdate = (isAnswerToOwnRequest, isSystemAction, items) =>
-  $eventbus.emit("ui_addToSnackBar", {
+  $eventbus.emit("ui/addToSnackbar", {
     i18n: "core.reloadPageHint",
     color: "info",
   })
 
 const userConfigUpdate = (isAnswerToOwnRequest, isSystemAction, items) =>
-  $eventbus.emit("ui_addToSnackBar", {
+  $eventbus.emit("ui/addToSnackbar", {
     i18n: "core.reloadPageHint",
     color: "info",
   })
@@ -132,7 +132,7 @@ const userConfigUpdate = (isAnswerToOwnRequest, isSystemAction, items) =>
 const dataDelete = (isAnswerToOwnRequest, isSystemAction, deletedItems) =>
   deletedItems.forEach((item) => {
     if (isAnswerToOwnRequest) {
-      $eventbus.emit("ui_addToSnackBar", {
+      $eventbus.emit("ui/addToSnackbar", {
         i18n: "core.dataDelete$displayName$type",
         content: { displayName: item._displayName, type: item._type },
         color: "success",
@@ -157,7 +157,7 @@ const dataDelete = (isAnswerToOwnRequest, isSystemAction, deletedItems) =>
 const dataMove = (isAnswerToOwnRequest, isSystemAction, items) => {
   items.forEach((item) => {
     if (isAnswerToOwnRequest) {
-      $eventbus.emit("ui_addToSnackBar", {
+      $eventbus.emit("ui/addToSnackbar", {
         i18n: "core.dataMove$displayName$type",
         content: { displayName: item._displayName, type: item._type },
         color: "success",
@@ -207,7 +207,7 @@ const checkToken = (payload) => {
       },
       color: "green",
     }
-    $eventbus.emit("ui_addToSnackBar", message)
+    $eventbus.emit("ui/addToSnackbar", message)
     $store.dispatch({
       type: "notifications/add",
       payload: {
@@ -222,7 +222,7 @@ const checkToken = (payload) => {
       i18n: "core.authentication." + response.code,
       color: "error",
     }
-    $eventbus.emit("ui_addToSnackBar", message)
+    $eventbus.emit("ui/addToSnackbar", message)
     $store.dispatch({
       type: "notifications/add",
       payload: {
@@ -245,7 +245,7 @@ const checkToken = (payload) => {
         color: "error",
       }
     }
-    $eventbus.emit("ui_addToSnackBar", message)
+    $eventbus.emit("ui/addToSnackbar", message)
     $store.dispatch({
       type: "notifications/add",
       payload: {
@@ -257,7 +257,7 @@ const checkToken = (payload) => {
   }
 }
 const newVersionAvailable = () =>
-  $eventbus.emit("ui_addToSnackBar", {
+  $eventbus.emit("ui/addToSnackbar", {
     i18n: "core.versionUpdate",
     color: "info",
     timeout: -1,
@@ -271,7 +271,7 @@ const dataMergeResponse = (isAnswerToOwnRequest, res) => {
 
     if (currentOperation.failure) {
       Object.keys(currentOperation.failure).forEach((type) =>
-        $eventbus.emit("ui_addToSnackBar", {
+        $eventbus.emit("ui/addToSnackbar", {
           i18n: "core.dataSync." + operation + ".$docCountOf$docTypeHaveFailed",
           content: {
             docCount: currentOperation.failure[type],
@@ -283,7 +283,7 @@ const dataMergeResponse = (isAnswerToOwnRequest, res) => {
     }
     if (currentOperation.success) {
       Object.keys(currentOperation.success).forEach((type) =>
-        $eventbus.emit("ui_addToSnackBar", {
+        $eventbus.emit("ui/addToSnackbar", {
           i18n:
             "core.dataSync." +
             operation +
@@ -306,7 +306,7 @@ const dataMergeResponse = (isAnswerToOwnRequest, res) => {
     res.totals.failed > 0 &&
     res.totals.succeeded > 0
   ) {
-    $eventbus.emit("ui_addToSnackBar", {
+    $eventbus.emit("ui/addToSnackbar", {
       i18n: "core.dataSync.$docCountOf$docTypeHaveFailed$docCount1HaveSucceeded",
       content: {
         docCount: res.totals.failed,
@@ -321,13 +321,13 @@ const dataMergeResponse = (isAnswerToOwnRequest, res) => {
 const add = (message: string | string[], color = "info") => {
   if (Array.isArray(message)) {
     message.forEach((text) =>
-      $eventbus.emit("ui_addToSnackBar", {
+      $eventbus.emit("ui/addToSnackbar", {
         message: text,
         color,
       } satisfies SnackbarMessage),
     )
   } else {
-    $eventbus.emit("ui_addToSnackBar", {
+    $eventbus.emit("ui/addToSnackbar", {
       message,
       color,
     } satisfies SnackbarMessage)

package/services/frontend/src/core/main.ts

@@ -93,10 +93,10 @@ const createRacletteApp = async (
   store.dispatch({ type: "user/set", payload: user })
 
   // does the core really need to communicate with itself via eventbus?
-  eventbus.emit("socket_joinRoom")
+  eventbus.emit("socket/join/room")
 
   return new Promise<CreateAppResponse>(async (resolve, reject) => {
-    eventbus.on("ui_setupProject", (spaceId: string) => {
+    eventbus.on("ui/setupProject", (spaceId: string) => {
       resolve({
         authenticated: true,
         setupComplete: true,
@@ -152,7 +152,7 @@ const generateLoginCallback =
 
         store.dispatch({ type: "user/set", payload: response.data.user })
 
-        eventbus.emit("socket_joinRoom")
+        eventbus.emit("socket/join/room")
 
         // Return success with token & redirect function
         return {

package/services/frontend/src/core/setup/plugin-system/api/wrappers.ts

@@ -27,12 +27,29 @@ export const wrapFileApi = (
 }
 
 export const wrapEventbusApi = (
+  plugin: RegisteredPlugin,
   $eventbus: any,
   pluginApi: Partial<PluginApi>,
 ): any => {
   if ($eventbus && !pluginApi.$eventbus) {
     const $pluginEventbus = new EventEmitter(false, false)
-    $pluginEventbus.global = $eventbus
+    $pluginEventbus.global = {
+      on: (event: string, listener: Function) => {
+        return $eventbus.on(event, listener)
+      },
+      once: (event: string, listener: Function) => {
+        return $eventbus.once(event, listener)
+      },
+      emit: (event: string, payload: object) => {
+        return $eventbus.emit(event, {
+          sender: plugin.pluginKey,
+          data: payload,
+        })
+      },
+      isValid: (event: string) => {
+        return $eventbus.isValid(event)
+      },
+    }
     return $pluginEventbus
   }
   return pluginApi

package/services/frontend/src/core/setup/plugin-system/registration/index.ts

@@ -113,7 +113,7 @@ export const loadAndRegisterPlugin = async (
 
     if (corePluginApi.$eventbus) {
       currentPlugin.initEventbus = () =>
-        wrapEventbusApi(corePluginApi.$eventbus, pluginApi)
+        wrapEventbusApi(plugin, corePluginApi.$eventbus, pluginApi)
     }
 
     const handleOperations = handlePluginOperations(

package/services/frontend/src/core/setup/socketClient.ts

@@ -6,7 +6,7 @@ import log from "@racletteCore/lib/logger"
 import { getUserToken } from "./sessionHandler"
 import configService from "@racletteCore/lib/configService"
 const registerSocketClient = ($socket, $eventbus) => {
-  $eventbus.on("socket_joinRoom", (roomId?: string) => {
+  $eventbus.on("socket/join/room", (roomId?: string) => {
     const { requireAuthentication } = configService.getConfig()?.global ?? {
       requireAuthentication: true,
     }
@@ -25,7 +25,7 @@ const registerSocketClient = ($socket, $eventbus) => {
     $socket.emit("join", { roomId, token })
   })
 
-  $eventbus.on("socket_leaveRoom", (roomId) => {
+  $eventbus.on("socket/leave/room", (roomId) => {
     log.socket("emitLeave", { roomId })
     $socket.emit("leave", roomId)
   })

package/services/frontend/src/core/setup/socketEvents.ts

@@ -206,7 +206,7 @@ const registerSocketEvents = ($socket, $store, $eventbus) => {
         })
         await setupSpace(compositions, interactionLinks, projectConfig)
 
-        $eventbus.emit("ui_setupProject", roomId)
+        $eventbus.emit("ui/setupProject", roomId)
       })
       // Reset all store states which are project dependent.
       $store.dispatch({
@@ -263,7 +263,7 @@ const registerSocketEvents = ($socket, $store, $eventbus) => {
       isOwnRequest: appSessionId === $socket.appSessionId,
     })
     handleServerItem(payload, true, false)
-    $eventbus.emit("socket_dataUpdated", { offline: false, body })
+    $eventbus.emit("socket/data/update", { offline: false, body })
   })
 
   /**

package/services/frontend/src/core/store/reducers/compositions/selectors.ts

@@ -21,8 +21,8 @@ type LocaleObject = {
 // TODO: outsource to a better place
 const getLocalizedName = (localeObject: LocaleObject) => {
   const locale = $store.getState(["ui", "locale"])
-
-  const localeName = localeObject[locale]
+  const localeName =
+    localeObject[locale] || localeObject[locale.split("-")?.[0]]
 
   if (localeName) {
     return localeName

package/services/frontend/src/core/store/reducers/data/index.ts

@@ -6,7 +6,7 @@ import reducerFromMap from "@racletteCore/lib/reducerFromMap"
 const reducerMap = {
   init: reducers.init,
   projectInit: reducers.projectInit,
-  "data/push": reducers.dataPush,
+  "data/push": reducers.dataRead,
   "data/create": reducers.dataCreate,
   "data/update": reducers.dataUpdate,
   "data/deleteFromCache": reducers.deleteFromCache,