All files / src/classes CoreDBCon.ts

74.15% Statements 66/89
61.53% Branches 24/39
86.95% Functions 20/23
75% Lines 66/88

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392                                                                                                                        2x 2x 2x 2x 2x 2x 2x 2x 2x       3x             5x 1x 1x   4x 4x       7x       4x 4x           9x 1x   8x       3x 3x 6x         3x       2x 2x 1x 1x   1x 1x 2x 1x           4x 4x 2x   2x       3x 3x       1x 1x 1x 1x             3x       2x       2x       2x     2x 2x 2x 2x 3x 3x 3x   3x     2x                                                                                                                                                                                                                                                                     1x 1x 1x                                               1x 1x                                                                 5x 1x   4x             2x             2x      
import type {
  ConfigType,
  IBaseDBUpdate,
  ICoreCache,
  ICoreClient,
  ICoreKernel,
  ICoreKernelModule,
  ICorePresenter,
  IDataBase,
  PopulatedResult,
  QInterfaceSearch,
  QueryInterface,
  RawQuery,
  RawQueryResult,
} from '../lib';
import CoreEntity from './CoreEntity';
import CoreEntityWrapper from './CoreEntityWrapper';
import CoreElement from './CoreElement';
import {
  type ColumnPropMap,
  type EntityConfig,
  type EUpDateProperties,
  getColumnMeta,
  type IEntity,
  validateEntity,
} from './annotation';
import { XUtil } from '../utils';
 
export default abstract class CoreDBCon<
    D,
    R = any,
    M = any,
    K extends ICoreKernel<any> = ICoreKernel<any>,
    X extends IDataBase<any, any> | null = any,
    P extends ICoreClient | null = any,
    C extends ICoreCache | null = any,
    Y extends ICorePresenter<any> | null = any,
  >
  extends CoreElement<K, X, P, C, Y>
  implements IDataBase<D>
{
  dbVersion: string;
 
  updater: IBaseDBUpdate | null;
 
  public schemaName: string;
 
  private connected: boolean;
 
  private cacheEnabled: boolean;
 
  private wrapperMap: Map<string, CoreEntityWrapper<any>>;
 
  private isNew: boolean;
 
  protected constructor(
    dbVersion: string,
    schemaName: string,
    module: ICoreKernelModule<K, X, P, C, Y>,
  ) {
    super(`db${module.getName()}`, module);
    this.wrapperMap = new Map<string, CoreEntityWrapper<any>>();
    this.connected = false;
    this.dbVersion = dbVersion;
    this.updater = null;
    this.schemaName = schemaName;
    this.isNew = false;
    this.cacheEnabled = false;
    this.debug = this.debug.bind(this);
  }
 
  setEntityCache(status: boolean) {
    this.cacheEnabled = status;
  }
 
  registerEntity<E extends CoreEntity>(
    ent: E,
    noCache = false,
  ): CoreEntityWrapper<E> {
    if (!validateEntity(ent)) {
      this.error(`Invalid Entity: ${ent.constructor.name}`);
      throw this.lError('Invalid Entity');
    }
    const cName = XUtil.getEntityNames(ent);
    const wrapper = new CoreEntityWrapper(
      this,
      cName.tableName,
      () => {
        return ent;
      },
      noCache,
    );
    this.wrapperMap.set(cName.className, wrapper);
    return wrapper;
  }
 
  getEntityWrapper<E extends CoreEntity>(
    className: string,
  ): CoreEntityWrapper<E> {
    if (!this.wrapperMap.has(className)) {
      throw this.lError(`Entity not registered: ${className}`);
    }
    return this.wrapperMap.get(className)!;
  }
 
  getEntityMeta() {
    const out: { key: string; meta: ColumnPropMap<any> }[] = [];
    this.wrapperMap.forEach((value, key) => {
      out.push({
        key,
        meta: value.getPropMap(),
      });
    });
    return out;
  }
 
  setUpdateChain(...chain: IBaseDBUpdate[]): void {
    const [first] = chain;
    if (!first) {
      this.error('No element in update chain');
      return;
    }
    this.updater = first;
    chain.forEach((el, index) => {
      if (index < chain.length - 1) {
        el.setNext(chain[index + 1]);
      }
    });
  }
 
  async canUpdate(): Promise<boolean> {
    const version = await this.getConfig('dbversion');
    if (version) {
      return version.c_value !== this.dbVersion;
    }
    return false;
  }
 
  async getCurrenDBVersion(): Promise<string> {
    const version = await this.getConfig('dbversion');
    return version?.c_value ?? '';
  }
 
  async update(): Promise<boolean> {
    Eif (this.updater && (await this.canUpdate())) {
      const update = this.updater.find(await this.getCurrenDBVersion());
      Eif (update) {
        return update.update();
      }
    }
    return true;
  }
 
  isConnected(): boolean {
    return this.connected;
  }
 
  setConnected(): void {
    this.connected = true;
  }
 
  async start(): Promise<void> {
    Iif (!(await this.connect())) {
      this.error('Cant connect to Database');
      process.exit(3);
    }
    Iif (await this.canUpdate()) {
      await this.update();
    }
    Eif (this.isNew) {
      const keys = this.wrapperMap.keys();
      let key = keys.next().value;
      while (key) {
        const wrapper = this.wrapperMap.get(key);
        Eif (wrapper) {
          await wrapper.init();
        }
        key = keys.next().value;
      }
 
      await this.initNewDB();
    }
  }
 
  abstract disconnect(): Promise<boolean>;
 
  abstract connect(): Promise<boolean>;
 
  abstract runScripts(...list: RawQuery[]): Promise<R[]>;
 
  abstract queryScript<E>(query: RawQuery): Promise<RawQueryResult<E, M>>;
 
  abstract getConfig(key: string): Promise<ConfigType | undefined>;
 
  abstract setConfig(key: string, value: string): Promise<boolean>;
 
  abstract configExist(key: string): Promise<boolean>;
 
  abstract removeConfig(key: string): Promise<void>;
 
  abstract getRawDBObject(): D | null;
 
  abstract initNewDB(): Promise<void>;
 
  /**
   * Create new Entity object
   * @param config
   * @param entity
   */
  abstract createEntity<E extends CoreEntity>(
    config: EntityConfig<E>,
    entity: E,
  ): Promise<E>;
 
  /**
   * Update Entity object
   * @param config
   * @param e_id
   * @param entity
   */
  abstract updateEntity<E extends CoreEntity>(
    config: EntityConfig<E>,
    e_id: string,
    entity: EUpDateProperties<E>,
  ): Promise<boolean>;
 
  /**
   * Update Entity objects
   * @param config
   * @param e_id
   * @param entity
   */
  abstract updateBulkEntity<E extends IEntity>(
    config: EntityConfig<E>,
    e_id: string[],
    entity: EUpDateProperties<E>,
  ): Promise<boolean>;
 
  /**
   * Get Entity object by ID
   * @param config
   * @param e_id
   */
  abstract getEntityById<E extends CoreEntity>(
    config: EntityConfig<E>,
    e_id: string,
  ): Promise<E | null>;
  /**
   * Get Entity object by ID
   * @param config
   * @param e_id
   */
  abstract getEntityBulkById<E extends CoreEntity>(
    config: EntityConfig<E>,
    e_id: string[],
  ): Promise<E[]>;
 
  /**
   * Delete Entity object by ID
   * @param className
   * @param id
   */
  abstract deleteEntityById(className: string, e_id: string): Promise<boolean>;
 
  /**
   * Delete Entity objects by ID
   * @param className
   * @param e_id
   */
  abstract deleteEntityBulkById(
    className: string,
    e_id: string[],
  ): Promise<boolean>;
 
  /**
   * Get Entity object list
   * @param query search query config
   */
  abstract getEntityList<E extends CoreEntity>(
    query: QueryInterface<E>,
  ): Promise<E[]>;
 
  /**
   * Get Entity object list
   * @param config
   * @param search
   */
  abstract findEntity<E extends CoreEntity>(
    config: EntityConfig<E>,
    search: QInterfaceSearch<E>,
  ): Promise<E | null>;
 
  /**
   * Init Entity object list
   * @param className
   * @param entity
   */
  abstract initEntity<E extends CoreEntity>(
    className: string,
    entity: E,
  ): Promise<boolean>;
  abstract countEntity<E extends IEntity>(
    config: EntityConfig<E>,
    search: QInterfaceSearch<E>,
  ): Promise<number>;
 
  async populate<
    E extends CoreEntity,
    EK extends keyof E,
    Z extends CoreEntity,
  >(entity: E, field: EK): Promise<PopulatedResult<E, EK, Z>> {
    const meta = getColumnMeta(entity, field);
    Eif (!meta?.foreignKey) {
      throw this.lError(
        `No foreignKey relation metadata found for field "${String(field)}"`,
      );
    }
    if (meta.foreignKey.schema) {
      throw this.lError(
        `Cross schema relations are not supported for field "${String(field)}"`,
      );
    }
    const targetWrapper = this.getEntityWrapper<Z>(meta.foreignKey.relation);
 
    const search: QInterfaceSearch<Z> = {};
    (search as any)[meta.foreignKey.key] = entity[field];
    return {
      ...entity,
      [field]: (await targetWrapper.findObj(search))!,
    };
  }
 
  async populateMany<
    E extends CoreEntity,
    EK extends keyof E,
    Z extends CoreEntity,
  >(entity: E[], field: EK): Promise<PopulatedResult<E, EK, Z>[]> {
    Eif (entity.length === 0) {
      return [];
    }
    const meta = getColumnMeta(entity[0], field);
    if (!meta?.foreignKey) {
      throw this.lError(
        `No foreignKey relation metadata found for field "${String(field)}"`,
      );
    }
    if (meta.foreignKey.schema) {
      throw this.lError(
        `Cross schema relations are not supported for field "${String(field)}"`,
      );
    }
    const targetWrapper = this.getEntityWrapper<Z>(meta.foreignKey.relation);
 
    const search: QInterfaceSearch<Z> = {};
    (search as any)[meta.foreignKey.key] = {
      mode: 'in',
      value: entity.map((e) => e[field]),
    };
 
    const result = await targetWrapper.getObjList({ search });
 
    return entity.map<PopulatedResult<E, EK, Z>>((e) => ({
      ...e,
      [field]: result.find(
        (x) =>
          (x as Record<string, unknown>)[meta.foreignKey!.key] === e[field],
      )!,
    }));
  }
 
  getCache(): C | null {
    if (!this.cacheEnabled) {
      return null;
    }
    return this.getModule().getCache();
  }
 
  /**
   * get the db trigger value
   */
  getNew(): boolean {
    return this.isNew;
  }
 
  /**
   * trigger the db init
   */
  protected setNew(val: boolean): void {
    this.isNew = val;
  }
}