@strapi/database 4.6.0-alpha.0 → 4.6.0-alpha.1

package/lib/index.d.ts

@@ -31,7 +31,8 @@ type AttributeOperators<T, K extends keyof T> = {
 
 export type WhereParams<T> = {
   [K in keyof T]?: T[K] | T[K][] | AttributeOperators<T, K>;
-} & LogicalOperators<T>;
+} &
+  LogicalOperators<T>;
 
 type Sortables<T> = {
   // check sortable
@@ -157,7 +158,6 @@ export interface Database {
   lifecycles: LifecycleProvider;
   migrations: MigrationProvider;
   entityManager: EntityManager;
-  queryBuilder: any;
 
   query<T extends keyof AllTypes>(uid: T): QueryFromContentType<T>;
 }

package/lib/metadata/relations.js

@@ -411,7 +411,7 @@ const createJoinTable = (metadata, { attributeName, attribute, meta }) => {
   let inverseOrderColumnName = _.snakeCase(`${meta.singularName}_order`);
 
   // if relation is self referencing
-  if (attribute.relation === 'manyToMany' && joinColumnName === inverseJoinColumnName) {
+  if (attribute.relation === 'manyToMany' && orderColumnName === inverseOrderColumnName) {
     inverseOrderColumnName = `inv_${inverseOrderColumnName}`;
   }
 

package/lib/query/helpers/index.js

@@ -7,5 +7,4 @@ module.exports = {
   ...require('./populate'),
   ...require('./where'),
   ...require('./transform'),
-  ...require('./streams'),
 };

package/lib/query/helpers/populate/apply.js

@@ -446,6 +446,11 @@ const morphToMany = async (input, ctx) => {
     .where({
       [joinColumn.name]: referencedValues,
       ...(joinTable.on || {}),
+      // If the populateValue contains an "on" property,
+      // only populate the types defined in it
+      ...('on' in populateValue
+        ? { [morphColumn.typeColumn.name]: Object.keys(populateValue.on) }
+        : {}),
     })
     .orderBy([joinColumn.name, 'order'])
     .execute({ mapResults: false });
@@ -470,6 +475,8 @@ const morphToMany = async (input, ctx) => {
   }, {});
 
   const map = {};
+  const { on, ...typePopulate } = populateValue;
+
   for (const type of Object.keys(idsByType)) {
     const ids = idsByType[type];
 
@@ -483,7 +490,7 @@ const morphToMany = async (input, ctx) => {
     const qb = db.entityManager.createQueryBuilder(type);
 
     const rows = await qb
-      .init(populateValue)
+      .init(on?.[type] ?? typePopulate)
       .addSelect(`${qb.alias}.${idColumn.referencedColumn}`)
       .where({ [idColumn.referencedColumn]: ids })
       .execute({ mapResults: false });
@@ -540,6 +547,8 @@ const morphToOne = async (input, ctx) => {
   }, {});
 
   const map = {};
+  const { on, ...typePopulate } = populateValue;
+
   for (const type of Object.keys(idsByType)) {
     const ids = idsByType[type];
 
@@ -552,7 +561,7 @@ const morphToOne = async (input, ctx) => {
     const qb = db.entityManager.createQueryBuilder(type);
 
     const rows = await qb
-      .init(populateValue)
+      .init(on?.[type] ?? typePopulate)
       .addSelect(`${qb.alias}.${idColumn.referencedColumn}`)
       .where({ [idColumn.referencedColumn]: ids })
       .execute({ mapResults: false });
@@ -579,7 +588,16 @@ const morphToOne = async (input, ctx) => {
 
 //  TODO: Omit limit & offset to avoid needing a query per result to avoid making too many queries
 const pickPopulateParams = (populate) => {
-  const fieldsToPick = ['select', 'count', 'where', 'populate', 'orderBy', 'filters', 'ordering'];
+  const fieldsToPick = [
+    'select',
+    'count',
+    'where',
+    'populate',
+    'orderBy',
+    'filters',
+    'ordering',
+    'on',
+  ];
 
   if (populate.count !== true) {
     fieldsToPick.push('limit', 'offset');

package/lib/query/query-builder.js

@@ -2,7 +2,6 @@
 
 const _ = require('lodash/fp');
 
-const { DatabaseError } = require('../errors');
 const helpers = require('./helpers');
 
 const createQueryBuilder = (uid, db, initialState = {}) => {
@@ -489,16 +488,6 @@ const createQueryBuilder = (uid, db, initialState = {}) => {
         db.dialect.transformErrors(error);
       }
     },
-
-    stream({ mapResults = true } = {}) {
-      if (state.type === 'select') {
-        return new helpers.ReadableQuery({ qb: this, db, uid, mapResults });
-      }
-
-      throw new DatabaseError(
-        `query-builder.stream() has been called with an unsupported query type: "${state.type}"`
-      );
-    },
   };
 };
 

package/lib/schema/index.d.ts

@@ -46,4 +46,4 @@ export interface SchemaProvider {
   drop(): Promise<void>;
 }
 
-export default function (db: Database): SchemaProvider;
+export default function(db: Database): SchemaProvider;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/database",
-  "version": "4.6.0-alpha.0",
+  "version": "4.6.0-alpha.1",
   "description": "Strapi's database layer",
   "homepage": "https://strapi.io",
   "bugs": {
@@ -43,5 +43,5 @@
     "node": ">=14.19.1 <=18.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "b7a87dcffc6f44e18eedef92e354096ffe32ce0c"
+  "gitHead": "9171c48104548f5f6da21abf2a8098009f1a40e9"
 }

package/lib/query/helpers/streams/index.js

@@ -1,5 +0,0 @@
-'use strict';
-
-module.exports = {
-  ReadableQuery: require('./readable'),
-};

package/lib/query/helpers/streams/readable.js

@@ -1,174 +0,0 @@
-'use strict';
-
-const { Readable } = require('stream');
-const { isFinite } = require('lodash/fp');
-
-const { applyPopulate } = require('../populate');
-const { fromRow } = require('../transform');
-
-const knexQueryDone = Symbol('knexQueryDone');
-const knexPerformingQuery = Symbol('knexPerformingQuery');
-
-class ReadableStrapiQuery extends Readable {
-  /**
-   * @param {object} options
-   * @param {ReturnType<typeof import('../../query-builder')>} options.qb The strapi query builder instance
-   * @param {string} options.uid The model uid
-   * @param {import('../../../index').Database} options.db The Database instance
-   * @param {boolean} [options.mapResults] The maximum number of entities to fetch per query
-   * @param {number} [options.batchSize] The maximum number of entities to fetch per query
-   */
-  constructor({ qb, db, uid, mapResults = true, batchSize = 500 }) {
-    super({ objectMode: true, highWaterMark: batchSize });
-
-    // Extract offset & limit from the query-builder's state
-    const { offset, limit } = qb.state;
-
-    // Original offset value
-    this._offset = isFinite(offset) ? offset : 0;
-
-    // Max amount of entities to fetch, force null as undefined value
-    this._limit = isFinite(limit) ? limit : null;
-
-    // Total amount of entities fetched
-    this._fetched = 0;
-
-    /**
-     * Original query
-     * @type {import('knex').Knex}
-     */
-    this._query = qb.getKnexQuery();
-
-    // Query Builder instance
-    this._qb = qb;
-
-    // Database related properties
-    this._db = db;
-    this._uid = uid;
-    this._meta = db.metadata.get(uid);
-
-    // Stream params
-    this._batchSize = batchSize;
-    this._mapResults = mapResults;
-
-    // States
-    this[knexPerformingQuery] = false;
-  }
-
-  _destroy(err, cb) {
-    // If the stream is destroyed while a query is being made, then wait for a
-    // kQueryDone event to be emitted before actually destroying the stream
-    if (this[knexPerformingQuery]) {
-      this.once(knexQueryDone, (er) => cb(err || er));
-    } else {
-      cb(err);
-    }
-  }
-
-  /**
-   * Custom ._read() implementation
-   *
-   *  NOTE: Here "size" means the number of entities to be read from the database.
-   *  Not the actual byte size, as it would means that we need to return partial entities.
-   *
-   * @param {number} size
-   */
-  async _read(size) {
-    const query = this._query;
-
-    // Remove the original offset & limit properties from the query
-    // Theoretically, they would be replaced by calling them again, but this is just to be sure
-    query.clear('limit').clear('offset');
-
-    // Define the maximum read size based on the limit and the requested size
-    // NOTE: size is equal to _batchSize by default. Since we want to allow customizing it on
-    // the fly, we need to use its value instead of batchSize when computing the maxReadSize value
-    const maxReadSize =
-      // if no limit is defined in the query, use the given size,
-      // otherwise, use the smallest value between the two
-      this._limit === null ? size : Math.min(size, this._limit);
-
-    // Compute the limit for the next query
-    const limit =
-      // If a limit is defined
-      this._limit !== null &&
-      // And reading `maxReadSize` would fetch too many entities (> _limit)
-      this._fetched + maxReadSize > this._limit
-        ? // Then adjust the limit so that it only get the remaining entities
-          this._limit - this._fetched
-        : // Else, use the max read size
-          maxReadSize;
-
-    // If we don't have anything left to read (_limit === _fetched),
-    // don't bother making the query and end the stream by pushing null
-    if (limit <= 0) {
-      this.push(null);
-      return;
-    }
-
-    // Compute the offset (base offset + number of entities already fetched)
-    const offset = this._offset + this._fetched;
-
-    // Update the query with the new values (offset + limit)
-    query.offset(offset).limit(limit);
-
-    // Lock the ._destroy()
-    this[knexPerformingQuery] = true;
-
-    let results;
-    let count;
-    let err;
-
-    try {
-      // Execute the query and store the results & count
-      results = await query;
-
-      const { populate } = this._qb.state;
-
-      // Apply populate if needed
-      if (populate) {
-        await applyPopulate(results, populate, { qb: this._qb, uid: this._uid, db: this._db });
-      }
-
-      // Map results if asked to
-      if (this._mapResults) {
-        results = fromRow(this._meta, results);
-      }
-
-      count = results.length;
-    } catch (e) {
-      err = e;
-    }
-
-    // Unlock the ._destroy()
-    this[knexPerformingQuery] = false;
-
-    // Tell ._destroy() that it's now safe to close the db connection
-    if (this.destroyed) {
-      this.emit(knexQueryDone);
-      return;
-    }
-
-    // If there is an error, destroy with the given error
-    if (err) {
-      this.destroy(err);
-      return;
-    }
-
-    // Update the amount of fetched entities
-    this._fetched += count;
-
-    // While there is at least one value to unpack
-    for (const result of results) {
-      this.push(result);
-    }
-
-    // If the amount of fetched entities is smaller than the
-    // maximum read size, Then push null to close the stream
-    if (this._fetched === this._limit || count < this._batchSize) {
-      this.push(null);
-    }
-  }
-}
-
-module.exports = ReadableStrapiQuery;