fix(schema-engine): Ignore views for MongoDB Schemas

[christianledgard]

Related to #18424 and #17006 issues.

Proposed trivial approach: While iterating the collections, if we detect a View, we continue to the next collection.

[CLAassistant]

All committers have signed the CLA.

[codspeed-hq]

CodSpeed Performance Report

Merging #4167 will not alter performance

_{Comparing christianledgard:fix-schema-engine-mongodb-views (1edbbdc) with main (f957933)}

Summary

✅ 11 untouched benchmarks

[Jolg42]

Blocking this because I tried it and while the error message is gone it brings unexpected changes

I ran PRISMA_SCHEMA_ENGINE_BINARY=/Users/j42/Dev/prisma-engines/target/debug/schema-engine npx prisma db pull --force which ran successfully.

Though check the output

generator client {
  provider = "prisma-client-js"
}

datasource db {
  provider = "mongodb"
  url      = "mongodb://root:prisma@localhost:27018/hey?authSource=admin"
}

type System.viewsPipeline {
lookup System.viewsPipeline$lookup? @map("$lookup")
project System.viewsPipeline$project? @map("$project")
unwind String? @map("$unwind")
}

type System.viewsPipeline$lookup {
as String
foreignField String
from String
localField String
}

type System.viewsPipeline$project {
id Int @map("_id")
bio String
email Int
name Int
}

model Plan {
  id String @id @default(auto()) @map("_id") @db.ObjectId
}

model ho {
  id String @id @default(auto()) @map("_id") @db.ObjectId
}

model system_views {
  id     String @id @map("_id")
  pipeline System.viewsPipeline[]
  viewOn String

  @@map("system.views")
}

The type System.* are unexpected (and also not valid syntax, no period is allowed in the name).
So it looks like some logic needs to be adapted to ignore introspecting the system collection itself?

[Jolg42]

I first ran npx prisma db push, then,
I ran in mongosh shell (inside MongoDB Compass)

use hey

db.createView('UserInfo', 'User', [
  {
    $lookup: {
      from: 'Profile',
      localField: '_id',
      foreignField: 'userId',
      as: 'ProfileData',
    },
  },
  {
    $project: {
      _id: 1,
      email: 1,
      name: 1,
      bio: '$ProfileData.bio',
    },
  },
  { $unwind: '$bio' },
])

db.getCollectionInfos()

(where hey is my improvised database name 😄)

It returned

[
  {
    name: 'myModel',
    type: 'collection',
    options: {},
    info: {
      readOnly: false,
      uuid: new UUID("2c070c30-bdf1-4f9d-abfd-5120d56132a0")
    },
    idIndex: { v: 2, key: [Object], name: '_id_' }
  },
  {
    name: 'system.views',
    type: 'collection',
    options: {},
    info: {
      readOnly: false,
      uuid: new UUID("d3d65bdb-d7e1-42a4-9083-b605926b321d")
    },
    idIndex: { v: 2, key: [Object], name: '_id_' }
  },
  {
    name: 'UserInfo',
    type: 'view',
    options: { viewOn: 'User', pipeline: [Array] },
    info: { readOnly: true }
  }
]

Based on the docs, it makes sense that the system.views collection makes an appearance inside my hey database:

The .system.views collection contains information about each view in the database.
https://www.mongodb.com/docs/manual/reference/system-collections/#mongodb-data--database-.system.views

[Jolg42]

I pushed a fix. I'll ask a colleague about how we want to test this.

[Jolg42]

Note: I verified that the test was not working before and showed the same issues before the fix.

[Jolg42]

I'm not sure why Clippy errors on unrelated files?

[janpio]

I'm not sure why Clippy errors on unrelated files?

That's that clippy usually does 😄

[aqrln]

I'm not sure why Clippy errors on unrelated files?

Rust 1.72 was released yesterday so probably was now updated on CI.

[tomhoule]

The fixes and test look good 💯

[tomhoule]

Do these show up because we have a view? That's a bit mysterious.

[Jolg42]

Yes, when there is a view inside the database MongoDB stores some information inside that same database as a system.views (invisible in GUI) collection

[Jolg42]

I'll wait for the clippy PR to be merged before merging this

[Jolg42]

Note: this is now available in 5.3.0-dev.9 if you want to try it out.
It will be released in the official 5.3.0 version on Tuesday, September, 12th.