@eventvisor/sdk 0.0.2

package/src/modulesManager.ts

@@ -0,0 +1,276 @@
+import type {
+  Value,
+  Effect,
+  Step,
+  EventName,
+  DestinationName,
+  EffectName,
+  EventLevel,
+} from "@eventvisor/types";
+
+import type { Logger } from "./logger";
+import type { DatafileReader } from "./datafileReader";
+import type { SourceResolver } from "./sourceResolver";
+
+export type ModuleName = string;
+
+export interface LookupOptions {
+  key: string;
+}
+
+// export interface TransformOptions {
+//   key: string;
+//   value: Value;
+// }
+
+export interface HandleOptions {
+  effectName: EffectName;
+  effect: Effect;
+  step: Step;
+  payload: Value;
+}
+
+export interface TransportOptions {
+  destinationName: DestinationName;
+  eventName: EventName;
+  eventLevel?: EventLevel;
+  payload: Value; // @TODO: rename to body?
+}
+
+export interface ReadFromStorageOptions {
+  key: string;
+}
+
+export interface WriteToStorageOptions {
+  key: string;
+  value: Value;
+}
+
+export interface RemoveFromStorageOptions {
+  key: string;
+}
+
+export interface ModuleDependencies {
+  datafileReader: DatafileReader;
+  logger: Logger;
+  sourceResolver: SourceResolver;
+}
+
+export interface Module {
+  name: ModuleName;
+
+  // initialize?
+
+  lookup?: (options: LookupOptions, deps: ModuleDependencies) => Promise<Value>;
+
+  // transform?: (options: TransformOptions, deps: ModuleDependencies) => Promise<Value>;
+
+  handle?: (options: HandleOptions, deps: ModuleDependencies) => Promise<void>;
+
+  transport?: (options: TransportOptions, deps: ModuleDependencies) => Promise<void>;
+
+  readFromStorage?: (options: ReadFromStorageOptions, deps: ModuleDependencies) => Promise<Value>;
+  writeToStorage?: (options: WriteToStorageOptions, deps: ModuleDependencies) => Promise<void>;
+  removeFromStorage?: (
+    options: RemoveFromStorageOptions,
+    deps: ModuleDependencies,
+  ) => Promise<void>;
+}
+
+export interface ModulesManagerOptions {
+  logger: Logger;
+  getDatafileReader: () => DatafileReader;
+  getSourceResolver: () => SourceResolver;
+}
+
+export class ModulesManager {
+  private logger: Logger;
+  private getDatafileReader: () => DatafileReader;
+  private getSourceResolver: () => SourceResolver;
+
+  // @TODO: can be optimized further by keeping only array of names, but keeping actual modules in an object
+  private modules: Module[];
+
+  constructor(options: ModulesManagerOptions) {
+    const { logger, getDatafileReader, getSourceResolver } = options;
+
+    this.logger = logger;
+    this.getDatafileReader = getDatafileReader;
+    this.getSourceResolver = getSourceResolver;
+    this.modules = [];
+  }
+
+  registerModule(module: Module) {
+    if (this.modules.find((m) => m.name === module.name)) {
+      this.logger.error(`Module ${module.name} already registered`);
+
+      return;
+    }
+
+    this.modules.push(module);
+  }
+
+  getModule(name: string) {
+    return this.modules.find((module) => module.name === name);
+  }
+
+  removeModule(name: string) {
+    const module = this.getModule(name);
+
+    if (!module) {
+      this.logger.error(`Module ${name} not found`);
+
+      return;
+    }
+
+    this.modules = this.modules.filter((module) => module.name !== name);
+  }
+
+  getModuleDependencies(): ModuleDependencies {
+    return {
+      datafileReader: this.getDatafileReader(),
+      logger: this.logger,
+      sourceResolver: this.getSourceResolver(),
+    };
+  }
+
+  async lookup(fullKey: string): Promise<Value> {
+    const [moduleName, ...keyParts] = fullKey.split(".");
+    const key = keyParts.join(".");
+
+    const moduleInstance = this.getModule(moduleName);
+
+    if (moduleInstance && moduleInstance.lookup) {
+      try {
+        return await moduleInstance.lookup({ key }, this.getModuleDependencies());
+      } catch (error) {
+        this.logger.error(`Error in lookup`, { moduleName, key, error });
+
+        return null;
+      }
+    }
+
+    this.logger.error(`Module "${moduleName}" not found with "lookup" function`);
+
+    return null;
+  }
+
+  async handle(
+    fullKey: string,
+    effectName: EffectName,
+    effect: Effect,
+    step: Step,
+    payload: Value,
+  ): Promise<void> {
+    const [moduleName, key] = fullKey.split("."); // eslint-disable-line
+
+    const moduleInstance = this.getModule(moduleName);
+
+    if (moduleInstance && moduleInstance.handle) {
+      try {
+        return await moduleInstance.handle(
+          { effectName, effect, step, payload },
+          this.getModuleDependencies(),
+        );
+      } catch (error) {
+        this.logger.error(`Error in handle`, { moduleName, effectName, error });
+
+        return;
+      }
+    }
+
+    this.logger.error(`Module "${moduleName}" not found with "handle" function`);
+
+    return;
+  }
+
+  transportExists(fullKey: string): boolean {
+    const [moduleName, key] = fullKey.split("."); // eslint-disable-line
+
+    const moduleInstance = this.getModule(moduleName);
+
+    return !!(moduleInstance && moduleInstance.transport);
+  }
+
+  // @TODO: change multiple args to single options object
+  async transport(
+    fullKey: string,
+    destinationName: DestinationName,
+    eventName: EventName,
+    payload: Value,
+    eventLevel?: EventLevel,
+  ): Promise<void> {
+    const [moduleName, key] = fullKey.split("."); // eslint-disable-line
+
+    const moduleInstance = this.getModule(moduleName);
+
+    if (moduleInstance && moduleInstance.transport) {
+      try {
+        return await moduleInstance.transport(
+          { destinationName, eventName, eventLevel, payload },
+          this.getModuleDependencies(),
+        );
+      } catch (error) {
+        this.logger.error(`Error in transport`, { moduleName, destinationName, eventName, error });
+
+        return;
+      }
+    }
+
+    this.logger.error(`Module "${moduleName}" not found with "transport" function`);
+  }
+
+  async readFromStorage(moduleName: ModuleName, key: string): Promise<Value> {
+    const moduleInstance = this.getModule(moduleName);
+
+    if (moduleInstance && moduleInstance.readFromStorage) {
+      try {
+        return await moduleInstance.readFromStorage({ key }, this.getModuleDependencies());
+      } catch (error) {
+        this.logger.error(`Error in readFromStorage`, { moduleName, key, error });
+
+        return null;
+      }
+    }
+
+    this.logger.error(`Module "${moduleName}" not found with "readFromStorage" function`);
+
+    return null;
+  }
+
+  async writeToStorage(moduleName: ModuleName, key: string, value: Value): Promise<void> {
+    const moduleInstance = this.getModule(moduleName);
+
+    if (moduleInstance && moduleInstance.writeToStorage) {
+      try {
+        return await moduleInstance.writeToStorage({ key, value }, this.getModuleDependencies());
+      } catch (error) {
+        this.logger.error(`Error in writeToStorage`, { moduleName, key, value, error });
+
+        return;
+      }
+    }
+
+    this.logger.error(`Module "${moduleName}" not found with "writeToStorage" function`);
+
+    return;
+  }
+
+  async removeFromStorage(moduleName: ModuleName, key: string): Promise<void> {
+    const moduleInstance = this.getModule(moduleName);
+
+    if (moduleInstance && moduleInstance.removeFromStorage) {
+      try {
+        return await moduleInstance.removeFromStorage({ key }, this.getModuleDependencies());
+      } catch (error) {
+        this.logger.error(`Error in removeFromStorage`, { moduleName, key, error });
+
+        return;
+      }
+    }
+
+    this.logger.error(`Module "${moduleName}" not found with "removeFromStorage" function`);
+
+    return;
+  }
+}

package/src/murmurhash.ts

@@ -0,0 +1,71 @@
+// v3 function taken from: https://github.com/perezd/node-murmurhash
+// this has been done to avoid loading v2 function which is not used in the SDK
+
+/**
+ * Copyright (c) 2020 Gary Court, Derek Perez
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+const createBuffer = (val) => new TextEncoder().encode(val);
+
+export function MurmurHashV3(key, seed) {
+  if (typeof key === "string") key = createBuffer(key);
+
+  let remainder, bytes, h1, h1b, c1, c2, k1, i;
+
+  remainder = key.length & 3; // key.length % 4
+  bytes = key.length - remainder;
+  h1 = seed;
+  c1 = 0xcc9e2d51;
+  c2 = 0x1b873593;
+  i = 0;
+
+  while (i < bytes) {
+    k1 =
+      (key[i] & 0xff) |
+      ((key[++i] & 0xff) << 8) |
+      ((key[++i] & 0xff) << 16) |
+      ((key[++i] & 0xff) << 24);
+    ++i;
+
+    k1 = ((k1 & 0xffff) * c1 + ((((k1 >>> 16) * c1) & 0xffff) << 16)) & 0xffffffff;
+    k1 = (k1 << 15) | (k1 >>> 17);
+    k1 = ((k1 & 0xffff) * c2 + ((((k1 >>> 16) * c2) & 0xffff) << 16)) & 0xffffffff;
+
+    h1 ^= k1;
+    h1 = (h1 << 13) | (h1 >>> 19);
+    h1b = ((h1 & 0xffff) * 5 + ((((h1 >>> 16) * 5) & 0xffff) << 16)) & 0xffffffff;
+    h1 = (h1b & 0xffff) + 0x6b64 + ((((h1b >>> 16) + 0xe654) & 0xffff) << 16);
+  }
+
+  k1 = 0;
+
+  switch (remainder) {
+    case 3:
+      k1 ^= (key[i + 2] & 0xff) << 16;
+    case 2:
+      k1 ^= (key[i + 1] & 0xff) << 8;
+    case 1:
+      k1 ^= key[i] & 0xff;
+
+      k1 = ((k1 & 0xffff) * c1 + ((((k1 >>> 16) * c1) & 0xffff) << 16)) & 0xffffffff;
+      k1 = (k1 << 15) | (k1 >>> 17);
+      k1 = ((k1 & 0xffff) * c2 + ((((k1 >>> 16) * c2) & 0xffff) << 16)) & 0xffffffff;
+      h1 ^= k1;
+  }
+
+  h1 ^= key.length;
+
+  h1 ^= h1 >>> 16;
+  h1 = ((h1 & 0xffff) * 0x85ebca6b + ((((h1 >>> 16) * 0x85ebca6b) & 0xffff) << 16)) & 0xffffffff;
+  h1 ^= h1 >>> 13;
+  h1 = ((h1 & 0xffff) * 0xc2b2ae35 + ((((h1 >>> 16) * 0xc2b2ae35) & 0xffff) << 16)) & 0xffffffff;
+  h1 ^= h1 >>> 16;
+
+  return h1 >>> 0;
+}

package/src/persister.ts

@@ -0,0 +1,162 @@
+import type { Attribute, Effect, Value, ComplexPersist } from "@eventvisor/types";
+import type { DatafileReader } from "./datafileReader";
+import type { ConditionsChecker } from "./conditions";
+import type { ModulesManager } from "./modulesManager";
+
+export type EntityMap = Record<string, Value>;
+
+export interface InitializeFromStorageOptions {
+  datafileReader: DatafileReader;
+  conditionsChecker: ConditionsChecker;
+  modulesManager: ModulesManager;
+  storageKeyPrefix: string;
+  getEntityNames: () => string[];
+  getEntity: (entityName: string) => Attribute | Effect | undefined;
+}
+
+export interface FindPersistOptions {
+  persists: ComplexPersist[];
+  entityName: string;
+  conditionsChecker: ConditionsChecker;
+  payload: Value;
+}
+
+export async function findPersist(
+  options: FindPersistOptions,
+): Promise<ComplexPersist | undefined> {
+  const { persists, entityName, conditionsChecker, payload } = options;
+
+  for (const persist of persists) {
+    if (!persist.conditions) {
+      return persist;
+    }
+
+    const isMatched = await conditionsChecker.allAreMatched(persist.conditions, {
+      attributeName: entityName,
+      effectName: entityName,
+      payload,
+    });
+
+    if (isMatched) {
+      return persist;
+    }
+  }
+}
+
+export async function initializeFromStorage({
+  datafileReader,
+  conditionsChecker,
+  modulesManager,
+  storageKeyPrefix,
+  getEntityNames,
+  getEntity,
+}: InitializeFromStorageOptions): Promise<EntityMap> {
+  const entityNames = getEntityNames();
+  const entityMap: EntityMap = {};
+
+  for (const entityName of entityNames) {
+    const schema = getEntity(entityName);
+
+    if (!schema) {
+      continue;
+    }
+
+    const persists = datafileReader.getPersists(schema);
+
+    if (!persists) {
+      continue;
+    }
+
+    const persist = await findPersist({ persists, entityName, conditionsChecker, payload: {} });
+
+    if (!persist) {
+      continue;
+    }
+
+    // read from storage
+    const value = await modulesManager.readFromStorage(
+      persist.storage,
+      `${storageKeyPrefix}${entityName}`,
+    );
+
+    if (value !== null && value !== undefined) {
+      entityMap[entityName] = value;
+    }
+  }
+
+  return entityMap;
+}
+
+export interface PersistEntityOptions {
+  datafileReader: DatafileReader;
+  conditionsChecker: ConditionsChecker;
+  modulesManager: ModulesManager;
+  storageKeyPrefix: string;
+  entityName: string;
+  entity: Attribute | Effect | undefined;
+  value: Value;
+}
+
+export async function persistEntity({
+  datafileReader,
+  conditionsChecker,
+  modulesManager,
+  storageKeyPrefix,
+  entityName,
+  entity,
+  value,
+}: PersistEntityOptions) {
+  if (!entity) {
+    return;
+  }
+
+  const persists = datafileReader.getPersists(entity);
+
+  if (!persists) {
+    return;
+  }
+
+  const persist = await findPersist({ persists, entityName, conditionsChecker, payload: value });
+
+  if (!persist) {
+    return;
+  }
+
+  await modulesManager.writeToStorage(persist.storage, `${storageKeyPrefix}${entityName}`, value);
+}
+
+export interface RemoveEntityOptions {
+  datafileReader: DatafileReader;
+  conditionsChecker: ConditionsChecker;
+  modulesManager: ModulesManager;
+  storageKeyPrefix: string;
+  entityName: string;
+  entity: Attribute | Effect | undefined;
+}
+
+export async function removeEntity({
+  datafileReader,
+  conditionsChecker,
+  modulesManager,
+  storageKeyPrefix,
+  entityName,
+  entity,
+}: RemoveEntityOptions) {
+  if (!entity) {
+    return;
+  }
+
+  const persists = datafileReader.getPersists(entity);
+
+  if (!persists) {
+    return;
+  }
+
+  const persist = await findPersist({ persists, entityName, conditionsChecker, payload: {} });
+
+  if (!persist) {
+    return;
+  }
+
+  await modulesManager.removeFromStorage(persist.storage, `${storageKeyPrefix}${entityName}`);
+}