41cff6d436
### What?
Adds four more arguments to the `mongooseAdapter`:
```typescript
useJoinAggregations?: boolean /* The big one */
useAlternativeDropDatabase?: boolean
useBigIntForNumberIDs?: boolean
usePipelineInSortLookup?: boolean
```
Also export a new `compatabilityOptions` object from
`@payloadcms/db-mongodb` where each key is a mongo-compatible database
and the value is the recommended `mongooseAdapter` settings for
compatability.
### Why?
When using firestore and visiting
`/admin/collections/media/payload-folders`, we get:
```
MongoServerError: invalid field(s) in lookup: [let, pipeline], only lookup(from, localField, foreignField, as) is supported
```
Firestore doesn't support the full MongoDB aggregation API used by
Payload which gets used when building aggregations for populating join
fields.
There are several other compatability issues with Firestore:
- The invalid `pipeline` property is used in the `$lookup` aggregation
in `buildSortParams`
- Firestore only supports number IDs of type `Long`, but Mongoose
converts custom ID fields of type number to `Double`
- Firestore does not support the `dropDatabase` command
- Firestore does not support the `createIndex` command (not addressed in
this PR)
### How?
```typescript
useJoinAggregations?: boolean /* The big one */
```
When this is `false` we skip the `buildJoinAggregation()` pipeline and resolve the join fields through multiple queries. This can potentially be used with AWS DocumentDB and Azure Cosmos DB to support join fields, but I have not tested with either of these databases.
```typescript
useAlternativeDropDatabase?: boolean
```
When `true`, monkey-patch (replace) the `dropDatabase` function so that
it calls `collection.deleteMany({})` on every collection instead of
sending a single `dropDatabase` command to the database
```typescript
useBigIntForNumberIDs?: boolean
```
When `true`, use `mongoose.Schema.Types.BigInt` for custom ID fields of type `number` which converts to a firestore `Long` behind the scenes
```typescript
usePipelineInSortLookup?: boolean
```
When `false`, modify the sortAggregation pipeline in `buildSortParams()` so that we don't use the `pipeline` property in the `$lookup` aggregation. Results in slightly worse performance when sorting by relationship properties.
### Limitations
This PR does not add support for transactions or creating indexes in firestore.
### Fixes
Fixed a bug (and added a test) where you weren't able to sort by multiple properties on a relationship field.
### Future work
1. Firestore supports simple `$lookup` aggregations but other databases might not. Could add a `useSortAggregations` property which can be used to disable aggregations in sorting.
---------
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Sasha <64744993+r1tsuu@users.noreply.github.com>
49 lines
1.4 KiB
TypeScript
49 lines
1.4 KiB
TypeScript
import path from 'path'
|
|
import { getPayload, type SanitizedConfig } from 'payload'
|
|
import { fileURLToPath } from 'url'
|
|
|
|
import { generateDatabaseAdapter } from './generateDatabaseAdapter.js'
|
|
import { setTestEnvPaths } from './helpers/setTestEnvPaths.js'
|
|
|
|
const [testConfigDir] = process.argv.slice(2)
|
|
|
|
const filename = fileURLToPath(import.meta.url)
|
|
const dirname = path.dirname(filename)
|
|
|
|
const writeDBAdapter = process.env.WRITE_DB_ADAPTER !== 'false'
|
|
process.env.PAYLOAD_DROP_DATABASE = process.env.PAYLOAD_DROP_DATABASE || 'true'
|
|
|
|
if (process.env.PAYLOAD_DATABASE === 'mongodb' || process.env.PAYLOAD_DATABASE === 'firestore') {
|
|
throw new Error('Not supported')
|
|
}
|
|
|
|
if (writeDBAdapter) {
|
|
generateDatabaseAdapter(process.env.PAYLOAD_DATABASE || 'postgres')
|
|
process.env.WRITE_DB_ADAPTER = 'false'
|
|
}
|
|
|
|
const loadConfig = async (configPath: string): Promise<SanitizedConfig> => {
|
|
return await (
|
|
await import(configPath)
|
|
).default
|
|
}
|
|
|
|
if (!testConfigDir) {
|
|
throw new Error('Yo must Specify testConfigDir')
|
|
}
|
|
|
|
const testDir = path.resolve(dirname, testConfigDir)
|
|
const config = await loadConfig(path.resolve(testDir, 'config.ts'))
|
|
|
|
setTestEnvPaths(testDir)
|
|
|
|
const payload = await getPayload({ config })
|
|
|
|
// await payload.db.dropDatabase({ adapter: payload.db })
|
|
|
|
await payload.db.generateSchema({
|
|
outputFile: path.resolve(testDir, 'payload-generated-schema.ts'),
|
|
})
|
|
|
|
process.exit(0)
|