prostgles-server 4.2.157 → 4.2.159

package/lib/DboBuilder/insertNestedRecords.ts

@@ -1,355 +0,0 @@
-import { AnyObject, getKeys, InsertParams, isDefined, isObject } from "prostgles-types";
-import { LocalParams, TableHandlers } from "./DboBuilder";
-import { TableRule } from "../PublishParser/PublishParser";
-import { omitKeys } from "../PubSubManager/PubSubManager";
-import { TableHandler } from "./TableHandler/TableHandler";
-
-type InsertNestedRecordsArgs = {
-  data: (AnyObject | AnyObject[]);
-  param2?: InsertParams;
-  tableRules?: TableRule;
-  localParams?: LocalParams;
-};
-
-/**
- * Referenced inserts within a single transaction
- */
-export async function insertNestedRecords(
-  this: TableHandler,
-  {
-    data,
-    param2, 
-    tableRules,
-    localParams = {},
-  }: InsertNestedRecordsArgs
-): Promise<{
-  data?: AnyObject | AnyObject[];
-  insertResult?: AnyObject | AnyObject[];
-}> { 
-  const MEDIA_COL_NAMES = ["data", "name"];
-
-  const getExtraKeys = (row: AnyObject) => getKeys(row).filter(fieldName => {
-    /* If media then use file insert columns */
-    if (this.is_media) {
-      return !this.column_names.concat(MEDIA_COL_NAMES).includes(fieldName)
-    } else if (!this.columns.find(c => c.name === fieldName)) {
-      if (!isObject(row[fieldName]) && !Array.isArray(row[fieldName])) {
-        throw new Error("Invalid/Dissalowed field in data: " + fieldName)
-      } else if (!this.dboBuilder.dbo[fieldName]) {
-        return false;
-        // throw new Error("Invalid/Dissalowed nested insert table name in data: " + fieldName)
-      }
-      return true;
-    }
-    return false;
-  });
-
-
-  /**
-   * True when: nested table data is provided within
-   *    [nestedTable] property key
-   *    OR
-   *    [referencing_column] property key
-   * If true then will do the full insert within this function
-   * Nested insert is not allowed for the file table 
-   * */
-  const isMultiInsert = Array.isArray(data);
-  const hasNestedInserts = this.is_media ? false : (isMultiInsert ? data : [data]).some(d => getExtraKeys(d).length || getReferenceColumnInserts(this, d).length);
-
-  /**
-   * Make sure nested insert uses a transaction
-   */
-  const dbTX = this.getFinalDBtx(localParams);
-  const t = localParams?.tx?.t || this.tx?.t;
-  if (hasNestedInserts && (!dbTX || !t)) {
-    return {
-      insertResult: await this.dboBuilder.getTX((dbTX, _t) =>
-        (dbTX[this.name] as TableHandler).insert(
-          data,
-          param2,
-          undefined,
-          tableRules,
-          { tx: { dbTX, t: _t }, ...localParams }
-        )
-      )
-    }
-  }
- 
-
-  const _data = await Promise.all((isMultiInsert ? data : [data]).map(async row => {
-    // const { preValidate, validate } = tableRules?.insert ?? {};
-    // const { tableConfigurator } = this.dboBuilder.prostgles;
-    // if(!tableConfigurator) throw "tableConfigurator missing";
-    // let row = await tableConfigurator.getPreInsertRow(this, { dbx: this.getFinalDbo(localParams), validate, localParams, row: _row })
-    // if (preValidate) {
-    //   row = await preValidate({ row, dbx: this.tx?.dbTX || this.dboBuilder.dbo, localParams });
-    // }
-
-    /* Potentially a nested join */
-    if (hasNestedInserts) {
-      const extraKeys = getExtraKeys(row);
-      const colInserts = getReferenceColumnInserts(this, row);
-      
-      /* Ensure we're using the same transaction */
-      const _this = this.tx ? this : dbTX![this.name] as TableHandler;
-
-      const omitedKeys = extraKeys.concat(colInserts.map(c => c.col));
-
-      const rootData: AnyObject = omitKeys(row, omitedKeys);
-
-      let insertedChildren: AnyObject[];
-      let targetTableRules: TableRule;
-
-      const colInsertsResult = colInserts.map(ci => ({
-        ...ci,
-        inserted: undefined as AnyObject[] | undefined
-      }));
-      /** Insert referenced first and then populate root data with referenced keys */
-      if (colInserts.length) {
-        for await (const colInsert of colInsertsResult) {
-          const newLocalParams: LocalParams = {
-            ...(localParams ?? {}),
-            nestedInsert: {
-              depth: (localParams.nestedInsert?.depth ?? 0) + 1,
-              previousData: rootData,
-              previousTable: this.name,
-              referencingColumn: colInsert.col
-            }
-          }
-          const colRows = await referencedInsert(_this, dbTX, newLocalParams, colInsert.tableName, row[colInsert.col]);
-          if (!Array.isArray(colRows) || colRows.length !== 1 || [null, undefined].includes(colRows[0]![colInsert.fcol])) {
-            throw new Error("Could not do nested column insert: Unexpected return " + JSON.stringify(colRows))
-          }
-          colInsert.inserted = colRows;
-
-          const foreignKey = colRows[0]![colInsert.fcol];
-          rootData[colInsert.col] = foreignKey;
-        }
-      }
-
-      const fullRootResult = await _this.insert(rootData, { returning: "*" }, undefined, tableRules, localParams);
-      let returnData: AnyObject | undefined;
-      const returning = param2?.returning;
-      if (returning) {
-        returnData = {}
-        const returningItems = await this.prepareReturning(returning, this.parseFieldFilter(tableRules?.insert?.returningFields));
-        returningItems.filter(s => s.selected).map(rs => {
-          const colInsertResult = colInsertsResult.find(({ col }) => col === rs.columnName);
-          const inserted = colInsertResult?.singleInsert? colInsertResult.inserted?.[0] : colInsertResult?.inserted;
-          returnData![rs.alias] = inserted ?? fullRootResult[rs.alias];
-        })
-      }
-
-      await Promise.all(extraKeys.map(async targetTable => {
-        const childDataItems = Array.isArray(row[targetTable]) ? row[targetTable] : [row[targetTable]];
-
-        const childInsert = async (cdata: AnyObject | AnyObject[], tableName: string) => {
-
-          return referencedInsert(this, dbTX, localParams, tableName, cdata);
-        }
-
-        const joinPath = await getJoinPath(this, targetTable);
-
-        const { path } = joinPath;
-        const [tbl1, tbl2, tbl3] = path;
-        targetTableRules = await getInsertTableRules(this, targetTable, localParams);   //  tbl3
-
-        const cols2 = this.dboBuilder.dbo[tbl2!]!.columns || [];
-        if (!this.dboBuilder.dbo[tbl2!]) throw "Invalid/disallowed table: " + tbl2;
-        const colsRefT1 = cols2?.filter(c => c.references?.some(rc => rc.cols.length === 1 && rc.ftable === tbl1));
-
-
-        if (!path.length) {
-          throw "Nested inserts join path not found for " + [this.name, targetTable];
-        } else if (path.length === 2) {
-          if (targetTable !== tbl2) throw "Did not expect this";
-
-          if (!colsRefT1.length) {
-            throw `Target table ${tbl2} does not reference any columns from the root table ${this.name}. Cannot insert nested data`;
-          }
- 
-          insertedChildren = await childInsert(
-            childDataItems.map((d: AnyObject) => {
-              const result = { ...d };
-              colsRefT1.map(col => {
-                result[col.references![0]!.cols[0]!] = fullRootResult[col.references![0]!.fcols[0]!]
-              })
-              return result;
-            }),
-            targetTable
-          ); 
-
-        } else if (path.length === 3) {
-          if (targetTable !== tbl3) throw "Did not expect this";
-          const colsRefT3 = cols2?.filter(c => c.references?.some(rc => rc.cols.length === 1 && rc.ftable === tbl3));
-          if (!colsRefT1.length || !colsRefT3.length) throw "Incorrectly referenced or missing columns for nested insert";
-
-          const fileTable = this.dboBuilder.prostgles.fileManager?.tableName;
-          if (targetTable !== fileTable) {
-            throw "Only media allowed to have nested inserts more than 2 tables apart"
-          }
-
-          /* We expect tbl2 to have only 2 columns (media_id and foreign_id) */
-          if (!cols2 || !(
-            cols2.filter(c => c.references?.[0]?.ftable === fileTable).length === 1 &&
-            cols2.filter(c => c.references?.[0]?.ftable === _this.name).length === 1
-          )) {
-            console.log({ tbl1, tbl2, tbl3, name: _this.name, tthisName: this.name })
-            throw "Second joining table (" + tbl2 + ")  not of expected format. Must contain exactly one reference column for each table (file table and target table)  ";
-          }
-
-          insertedChildren = await childInsert(childDataItems, targetTable);
-
-          /* Insert in key_lookup table */
-          await Promise.all(insertedChildren.map(async t3Child => {
-            const tbl2Row: AnyObject = {};
-
-            colsRefT3.map(col => {
-              tbl2Row[col.name] = t3Child[col.references![0]!.fcols[0]!];
-            })
-            colsRefT1.map(col => {
-              tbl2Row[col.name] = fullRootResult[col.references![0]!.fcols[0]!];
-            })
-
-            await childInsert(tbl2Row, tbl2!);//.then(() => {});
-          }));
-
-        } else {
-          console.error(JSON.stringify({ path, thisTable: this.name, targetTable }, null, 2));
-          throw "Unexpected path for Nested inserts";
-        }
-
-        /* Return also the nested inserted data */
-        if (targetTableRules && insertedChildren?.length && returning) {
-          const targetTableHandler = dbTX![targetTable] as TableHandler;
-          const targetReturning = await targetTableHandler.prepareReturning("*", targetTableHandler.parseFieldFilter(targetTableRules?.insert?.returningFields));
-          const clientTargetInserts = insertedChildren.map(d => {
-            const _d = { ...d };
-            const res: AnyObject = {};
-            targetReturning.map(r => {
-              res[r.alias] = _d[r.alias]
-            });
-            return res;
-          });
-
-          returnData![targetTable] = clientTargetInserts.length === 1 ? clientTargetInserts[0] : clientTargetInserts;
-        }
-      }));
-
-      return returnData
-    }
-
-    return row;
-  }));
-
-  const result = isMultiInsert ? _data : _data[0];
-  const res = hasNestedInserts ?
-    { insertResult: result } :
-    { data: result };
-
-  return res;
-}
-
-/* Must be allowed to insert into referenced table */
-export const getInsertTableRules = async (tableHandler: TableHandler, targetTable: string, localParams: LocalParams) => {
-  const childRules = await tableHandler.dboBuilder.publishParser?.getValidatedRequestRuleWusr({ tableName: targetTable, command: "insert", localParams });
-  if (!childRules || !childRules.insert) throw "Dissallowed nested insert into table " + childRules;
-  return childRules;
-}
-
-const getJoinPath = async (tableHandler: TableHandler, targetTable: string): Promise<{
-  t1: string;
-  t2: string;
-  path: string[];
-}> => {
-
-  const jp = tableHandler.dboBuilder.getShortestJoinPath(tableHandler, targetTable);
-  if (!jp) {
-    const pref = tableHandler.dboBuilder.prostgles.opts.joins !== "inferred" ? "Joins are not inferred! " : ""
-    throw new Error(`${pref}Could not find a single join path for the nested data ( sourceTable: ${tableHandler.name} targetTable: ${targetTable} ) `);
-  }
-  return jp;
-}
-
-const referencedInsert = async (tableHandler: TableHandler, dbTX: TableHandlers | undefined, localParams: LocalParams, targetTable: string, targetData: AnyObject | AnyObject[]): Promise<AnyObject[]> => {
-
-
-  // const thisInfo = await tableHandler.getInfo();
-  await getJoinPath(tableHandler, targetTable);
-
-  if (!targetData || !dbTX?.[targetTable] || !("insert" in dbTX[targetTable]!)) {
-    throw new Error("childInsertErr: Table handler missing for referenced table: " + targetTable);
-  }
-
-  const childRules = await getInsertTableRules(tableHandler, targetTable, localParams);
-
-  // if (thisInfo.has_media === "one" && thisInfo.media_table_name === targetTable && Array.isArray(targetData) && targetData.length > 1) {
-  //   throw "Constraint check fail: Cannot insert more than one record into " + JSON.stringify(targetTable);
-  // }
-  return Promise.all(
-    (Array.isArray(targetData) ? targetData : [targetData])
-      .map(m => (dbTX![targetTable] as TableHandler)
-        .insert(m, { returning: "*" }, undefined, childRules, localParams)
-        .catch(e => {
-          return Promise.reject(e); 
-        })
-      )
-  );
-
-}
-
-type ReferenceColumnInsert<ExpectSingleInsert> = {
-  tableName: string;
-  col: string;
-  fcol: string;
-  singleInsert: boolean;
-  data: ExpectSingleInsert extends true? AnyObject : (AnyObject | AnyObject[]);
-}
-
-/**
- * Insert through the reference column. e.g.:
- *  {
- *    root_field: "data",
- *    fkey_column: { ...referenced_table_data }
- *  }
- */
-export const getReferenceColumnInserts = <ExpectSingleInsert extends boolean>(tableHandler: TableHandler, parentRow: AnyObject, expectSingleInsert?: ExpectSingleInsert): ReferenceColumnInsert<ExpectSingleInsert>[] => { 
-  return Object.entries(parentRow)
-    .map(([insertedFieldName, insertedFieldValue]) => {
-      if(insertedFieldValue && isObject(insertedFieldValue)){
-        const insertedRefCol = tableHandler.columns.find(c => c.name === insertedFieldName && c.references?.length);
-        if(!insertedRefCol) return undefined;
-        return {
-          insertedRefCol,
-          insertedRefColRef: insertedRefCol.references!
-        }
-      }
-    
-      return undefined;
-    })
-    .filter(isDefined)
-    .map(({ insertedRefCol, insertedRefColRef }) => {
-
-      if(insertedRefColRef.length !== 1){
-        throw "Cannot do a nested insert on column that references multiple tables"
-      }
-      
-      const referencesMultipleColumns = insertedRefColRef?.some(refs => refs.fcols.length !== 1);
-      if(referencesMultipleColumns){
-        throw "Cannot do a nested insert on multi-column foreign key reference"
-      }
-
-      const singleInsert = !Array.isArray(parentRow[insertedRefCol.name]);
-      if(expectSingleInsert && !singleInsert){
-        throw "Expected singleInsert";
-      }
-      const res = {
-        tableName: insertedRefCol.references![0]!.ftable!,
-        col: insertedRefCol.name,
-        fcol: insertedRefCol.references![0]!.fcols[0]!,
-        singleInsert,
-        data: parentRow[insertedRefCol.name],
-      }
-      return res;
-    }).filter(isDefined);
-}

package/lib/DboBuilder/parseUpdateRules.ts

@@ -1,187 +0,0 @@
-import { AnyObject, FieldFilter, isDefined, UpdateParams } from "prostgles-types";
-import { Filter, LocalParams } from "./DboBuilder";
-import { TableRule, UpdateRule, ValidateRowBasic, ValidateUpdateRowBasic } from "../PublishParser/PublishParser";
-import { TableHandler } from "./TableHandler/TableHandler";
-import { prepareNewData } from "./TableHandler/DataValidator";
-
-/**
- * 1) Check if publish is valid
- * 2) Retrieve allowed update cols for a specific request
- */
-export async function parseUpdateRules(
-  this: TableHandler,
-  filter: Filter,
-  params?: UpdateParams,
-  tableRules?: TableRule,
-  localParams?: LocalParams
-): Promise<{
-  fields: string[];
-  validateRow?: ValidateRowBasic;
-  finalUpdateFilter: AnyObject;
-  forcedData?: AnyObject;
-  forcedFilter?: AnyObject;
-  returningFields: FieldFilter;
-  filterFields?: FieldFilter;
-}> {
-  const { testRule = false } = localParams ?? {};
-  if (!testRule) {
-    this.checkFilter(filter);
-  }
-
-  let forcedFilter: AnyObject | undefined = {},
-    forcedData: AnyObject | undefined = {},
-    validate: ValidateUpdateRowBasic | undefined,
-    returningFields: FieldFilter = "*",
-    filterFields: FieldFilter | undefined = "*",
-    fields: FieldFilter = "*";
-
-  let finalUpdateFilter = { ...filter };
-
-  if (tableRules) {
-    if (!tableRules.update) throw "update rules missing for " + this.name;
-    ({ forcedFilter, forcedData, fields, filterFields, validate } = tableRules.update);
-
-    returningFields = tableRules.update.returningFields ?? tableRules?.select?.fields ?? "";
-
-    if (!returningFields && params?.returning) {
-      throw "You are not allowed to return any fields from the update"
-    }
-
-    if (!fields) {
-      throw ` Invalid update rule fo r ${this.name}. fields missing `;
-    }
-    finalUpdateFilter = (await this.prepareWhere({ 
-      select: undefined,
-      filter, 
-      forcedFilter, 
-      filterFields, 
-      localParams, 
-      tableRule: tableRules 
-    })).filter;
-    if (tableRules.update.dynamicFields?.length) {
-      /**
-       * dynamicFields.fields used to allow a custom list of fields for specific records
-       * dynamicFields.filter cannot overlap each other
-       * updates must target records from a specific dynamicFields.filter or not match any dynamicFields.filter
-       */
-      if (testRule) {
-        for await (const [dfIndex, dfRule] of tableRules.update.dynamicFields.entries()) {
-
-          /**
-           * Validated filter and fields
-           */
-          const condition = await this.prepareWhere({
-            select: undefined, 
-            filterFields: this.column_names, 
-            filter: dfRule.filter, 
-            localParams, 
-            tableRule: tableRules 
-          });
-          if (!condition.where) {
-            throw "dynamicFields.filter cannot be empty: " + JSON.stringify(dfRule);
-          }
-          await this.validateViewRules({ 
-            fields: dfRule.fields, 
-            filterFields, 
-            returningFields, 
-            forcedFilter, 
-            dynamicFields: tableRules.update.dynamicFields, 
-            rule: "update" 
-          });
-
-
-          await this.find(dfRule.filter, { limit: 0 });
-
-          /** Ensure dynamicFields filters do not overlap */
-          for await (const [_dfIndex, _dfRule] of tableRules.update.dynamicFields.entries()) {
-            if (dfIndex !== _dfIndex) {
-              if (await this.findOne({ $and: [dfRule.filter, _dfRule.filter] }, { select: "" })) {
-                throw `dynamicFields.filter cannot overlap each other. \n
-                                Overlapping dynamicFields rules:
-                                    ${JSON.stringify(dfRule)} 
-                                    AND
-                                    ${JSON.stringify(_dfRule)} 
-                                `;
-              }
-            }
-          }
-        }
-      }
-
-      /** Pick dynamicFields.fields if matching filter */
-      let matchedRule: Required<UpdateRule>["dynamicFields"][number] | undefined;
-      for await (const dfRule of tableRules.update.dynamicFields) {
-        const match = await this.findOne({ $and: ([finalUpdateFilter, dfRule.filter]  as AnyObject[]).filter(isDefined) });
-
-        if (match) {
-
-          /** Ensure it doesn't overlap with other dynamicFields.filter */
-          if (matchedRule && !testRule) {
-            throw "Your update is targeting multiple tableRules.update.dynamicFields. Restrict update filter to only target one rule";
-          }
-
-          matchedRule = dfRule;
-          fields = dfRule.fields;
-        }
-      }
-    }
-
-    /* Safely test publish rules */
-    if (testRule) {
-      await this.validateViewRules({ fields, filterFields, returningFields, forcedFilter, dynamicFields: tableRules.update.dynamicFields, rule: "update" });
-      if (forcedData) {
-        try {
-          const { data, allowedCols } = await prepareNewData({ 
-            row: forcedData, 
-            forcedData: undefined, 
-            allowedFields: "*", 
-            tableRules, 
-            fixIssues: false, 
-            tableConfigurator: this.dboBuilder.prostgles.tableConfigurator,
-            tableHandler: this,
-          });
-          let updateValidate: ValidateRowBasic | undefined;
-          if(validate){
-            if(!localParams) throw "localParams missing";
-            updateValidate = (args) => validate!({ update: args.row, filter: {}, dbx: this.getFinalDbo(localParams), localParams })
-          }
-          const updateQ = (await this.dataValidator.parse({
-            command: "update",
-            rows: [data],
-            allowedCols,
-            dbTx: this.tx?.dbTX || this.dboBuilder.dbo,
-            validationOptions: { 
-              validate: updateValidate,
-              localParams,
-            }
-          })).getQuery();
-          const query = updateQ + " WHERE FALSE ";
-          await this.db.any("EXPLAIN " + query);
-        } catch (e) {
-          throw " issue with forcedData: \nVALUE: " + JSON.stringify(forcedData, null, 2) + "\nERROR: " + e;
-        }
-      }
-
-      return true as unknown as any;
-    }
-  }
-
-  /* Update all allowed fields (fields) except the forcedFilter (so that the user cannot change the forced filter values) */
-  const _fields = this.parseFieldFilter(fields);
-
-  let validateRow: ValidateRowBasic | undefined;
-  if(validate){
-    if(!localParams) throw "localParams missing";
-    validateRow = ({ row }) => validate!({ update: row, filter: finalUpdateFilter, localParams, dbx: this.getFinalDbo(localParams) });
-  }
-
-  return {
-    fields: _fields,
-    validateRow,
-    finalUpdateFilter,
-    forcedData,
-    forcedFilter,
-    returningFields,
-    filterFields,
-  }
-}