From 6fd8018baf3d0b00c2a081e47a73fec4d2dd8be5 Mon Sep 17 00:00:00 2001 From: Andrey Sobolev Date: Wed, 25 Sep 2024 11:27:45 +0700 Subject: [PATCH] UBERF-8259: Do not store system model into DB (#6716) Signed-off-by: Andrey Sobolev --- .vscode/launch.json | 2 +- dev/tool/src/index.ts | 4 +- dev/tool/src/markup.ts | 4 +- pods/backup/package.json | 3 +- pods/backup/src/index.ts | 11 ++- pods/server/package.json | 3 +- pods/server/src/server.ts | 10 ++- server/middleware/src/model.ts | 44 ++++++++-- server/mongo/src/storage.ts | 6 +- server/mongo/src/utils.ts | 1 + server/server-pipeline/src/pipeline.ts | 9 ++- server/tool/src/index.ts | 81 +++++++++---------- server/workspace-service/src/ws-operations.ts | 3 +- 13 files changed, 117 insertions(+), 64 deletions(-) diff --git a/.vscode/launch.json b/.vscode/launch.json index 212b10d824..e7ef0632d5 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -129,7 +129,7 @@ "MINIO_ACCESS_KEY": "minioadmin", "MINIO_SECRET_KEY": "minioadmin", "MINIO_ENDPOINT": "localhost", - "MODEL_VERSION": "v0.6.286" + "MODEL_VERSION": "v0.6.287" // "INIT_SCRIPT_URL": "https://raw.githubusercontent.com/hcengineering/init/main/script.yaml", // "INIT_WORKSPACE": "onboarding", }, diff --git a/dev/tool/src/index.ts b/dev/tool/src/index.ts index 5c54f9f4d9..6f98eac8e7 100644 --- a/dev/tool/src/index.ts +++ b/dev/tool/src/index.ts @@ -1503,7 +1503,7 @@ export function devTool ( .option('-w, --workspace ', 'Selected workspace only', '') .option('-c, --concurrency ', 'Number of documents being processed concurrently', '10') .action(async (cmd: { workspace: string, concurrency: string }) => { - const { mongodbUri, dbUrl } = prepareTools() + const { mongodbUri, dbUrl, txes } = prepareTools() await withDatabase(mongodbUri, async (db, client) => { await withStorage(mongodbUri, async (adapter) => { const workspaces = await listWorkspacesPure(db) @@ -1521,7 +1521,7 @@ export function devTool ( workspaceUrl: workspace.workspaceUrl ?? '' } - const { pipeline } = await getServerPipeline(toolCtx, mongodbUri, dbUrl, wsUrl) + const { pipeline } = await getServerPipeline(toolCtx, txes, mongodbUri, dbUrl, wsUrl) await migrateMarkup(toolCtx, adapter, wsId, client, pipeline, parseInt(cmd.concurrency)) diff --git a/dev/tool/src/markup.ts b/dev/tool/src/markup.ts index 48f79b1131..837a0cb7f9 100644 --- a/dev/tool/src/markup.ts +++ b/dev/tool/src/markup.ts @@ -15,7 +15,7 @@ import core, { } from '@hcengineering/core' import { getMongoClient, getWorkspaceDB } from '@hcengineering/mongo' import { type Pipeline, type StorageAdapter } from '@hcengineering/server-core' -import { connect, fetchModel } from '@hcengineering/server-tool' +import { connect } from '@hcengineering/server-tool' import { jsonToText, markupToYDoc } from '@hcengineering/text' import { type Db, type FindCursor, type MongoClient } from 'mongodb' @@ -123,7 +123,7 @@ export async function migrateMarkup ( pipeline: Pipeline, concurrency: number ): Promise { - const { hierarchy } = await fetchModel(ctx, pipeline) + const hierarchy = pipeline.context.hierarchy const workspaceDb = client.db(workspaceId.name) diff --git a/pods/backup/package.json b/pods/backup/package.json index f3c10469ef..98fe4a9746 100644 --- a/pods/backup/package.json +++ b/pods/backup/package.json @@ -57,6 +57,7 @@ "dotenv": "~16.0.0", "@hcengineering/backup-service": "^0.6.0", "@hcengineering/analytics": "^0.6.0", - "@hcengineering/analytics-service": "^0.6.0" + "@hcengineering/analytics-service": "^0.6.0", + "@hcengineering/model-all": "^0.6.0" } } diff --git a/pods/backup/src/index.ts b/pods/backup/src/index.ts index c2ec43a82e..e746f59e23 100644 --- a/pods/backup/src/index.ts +++ b/pods/backup/src/index.ts @@ -16,12 +16,19 @@ import { Analytics } from '@hcengineering/analytics' import { configureAnalytics, SplitLogger } from '@hcengineering/analytics-service' import { startBackup } from '@hcengineering/backup-service' -import { MeasureMetricsContext, metricsToString, newMetrics } from '@hcengineering/core' +import { MeasureMetricsContext, metricsToString, newMetrics, type Tx } from '@hcengineering/core' import { type PipelineFactory } from '@hcengineering/server-core' import { createBackupPipeline, getConfig } from '@hcengineering/server-pipeline' import { writeFile } from 'fs/promises' import { join } from 'path' +import builder from '@hcengineering/model-all' + +const enabled = (process.env.MODEL_ENABLED ?? '*').split(',').map((it) => it.trim()) +const disabled = (process.env.MODEL_DISABLED ?? '').split(',').map((it) => it.trim()) + +const model = JSON.parse(JSON.stringify(builder(enabled, disabled).getTxes())) as Tx[] + const metricsContext = new MeasureMetricsContext( 'backup', {}, @@ -58,7 +65,7 @@ const onClose = (): void => { startBackup( metricsContext, (mongoUrl, storageAdapter) => { - const factory: PipelineFactory = createBackupPipeline(metricsContext, mongoUrl, { + const factory: PipelineFactory = createBackupPipeline(metricsContext, mongoUrl, model, { externalStorage: storageAdapter, usePassedCtx: true }) diff --git a/pods/server/package.json b/pods/server/package.json index 5832863572..0eca82cf0b 100644 --- a/pods/server/package.json +++ b/pods/server/package.json @@ -72,6 +72,7 @@ "@hcengineering/server-telegram": "^0.6.0", "@hcengineering/pod-telegram-bot": "^0.6.0", "@hcengineering/server-ai-bot": "^0.6.0", - "@hcengineering/server-ai-bot-resources": "^0.6.0" + "@hcengineering/server-ai-bot-resources": "^0.6.0", + "@hcengineering/model-all": "^0.6.0" } } diff --git a/pods/server/src/server.ts b/pods/server/src/server.ts index 69204afc3f..4a71e2921a 100644 --- a/pods/server/src/server.ts +++ b/pods/server/src/server.ts @@ -14,7 +14,7 @@ // limitations under the License. // -import { type Branding, type BrandingMap, type WorkspaceIdWithUrl } from '@hcengineering/core' +import { type Branding, type BrandingMap, type Tx, type WorkspaceIdWithUrl } from '@hcengineering/core' import { buildStorageFromConfig, getMetricsContext } from '@hcengineering/server' import { ClientSession, startSessionManager, type ServerFactory, type Session } from '@hcengineering/server' @@ -25,6 +25,13 @@ import { serverAiBotId } from '@hcengineering/server-ai-bot' import { createAIBotAdapter } from '@hcengineering/server-ai-bot-resources' import { createServerPipeline, registerServerPlugins, registerStringLoaders } from '@hcengineering/server-pipeline' +import builder from '@hcengineering/model-all' + +const enabled = (process.env.MODEL_ENABLED ?? '*').split(',').map((it) => it.trim()) +const disabled = (process.env.MODEL_DISABLED ?? '').split(',').map((it) => it.trim()) + +const model = JSON.parse(JSON.stringify(builder(enabled, disabled).getTxes())) as Tx[] + registerStringLoaders() /** @@ -64,6 +71,7 @@ export function start ( const pipelineFactory = createServerPipeline( metrics, dbUrls, + model, { ...opt, externalStorage, adapterSecurity: rawDbUrl !== undefined }, { serviceAdapters: { diff --git a/server/middleware/src/model.ts b/server/middleware/src/model.ts index 546c94017e..100b472c88 100644 --- a/server/middleware/src/model.ts +++ b/server/middleware/src/model.ts @@ -14,14 +14,22 @@ // import core, { + type Doc, type LoadModelResponse, type MeasureContext, type Timestamp, type Tx, + type TxCUD, DOMAIN_TX } from '@hcengineering/core' import { PlatformError, unknownError } from '@hcengineering/platform' -import type { Middleware, PipelineContext, TxAdapter, TxMiddlewareResult } from '@hcengineering/server-core' +import type { + Middleware, + MiddlewareCreator, + PipelineContext, + TxAdapter, + TxMiddlewareResult +} from '@hcengineering/server-core' import { BaseMiddleware } from '@hcengineering/server-core' import crypto from 'node:crypto' @@ -34,20 +42,46 @@ export class ModelMiddleware extends BaseMiddleware implements Middleware { lastHashResponse!: Promise model!: Tx[] - static async create (ctx: MeasureContext, context: PipelineContext, next?: Middleware): Promise { - const middleware = new ModelMiddleware(context, next) + constructor ( + context: PipelineContext, + next: Middleware | undefined, + readonly systemTx: Tx[] + ) { + super(context, next) + } + + static async doCreate ( + ctx: MeasureContext, + context: PipelineContext, + next: Middleware | undefined, + systemTx: Tx[] + ): Promise { + const middleware = new ModelMiddleware(context, next, systemTx) await middleware.init(ctx) return middleware } + static create (tx: Tx[]): MiddlewareCreator { + return (ctx, context, next) => { + return this.doCreate(ctx, context, next, tx) + } + } + async init (ctx: MeasureContext): Promise { if (this.context.adapterManager == null) { throw new PlatformError(unknownError('Adapter manager should be configured')) } const txAdapter = this.context.adapterManager.getAdapter(DOMAIN_TX, true) as TxAdapter + const isUserTx = (it: Tx): boolean => + it.modifiedBy !== core.account.System || + (it as TxCUD).objectClass === 'contact:class:Person' || + (it as TxCUD).objectClass === 'contact:class:PersonAccount' + this.model = await ctx.with('get-model', {}, async (ctx) => { - const model = await ctx.with('fetch-model', {}, (ctx) => txAdapter.getModel(ctx)) + const allUserTxes = await ctx.with('fetch-model', {}, (ctx) => txAdapter.getModel(ctx)) + const userTxes = allUserTxes.filter((it) => isUserTx(it)) + const model = this.systemTx.concat(userTxes) for (const tx of model) { try { this.context.hierarchy.tx(tx) @@ -55,7 +89,7 @@ export class ModelMiddleware extends BaseMiddleware implements Middleware { ctx.warn('failed to apply model transaction, skipping', { tx: JSON.stringify(tx), err }) } } - this.context.modelDb.addTxes(ctx, model, false) + this.context.modelDb.addTxes(ctx, model, true) return model }) diff --git a/server/mongo/src/storage.ts b/server/mongo/src/storage.ts index 35adf636f6..0d858d3160 100644 --- a/server/mongo/src/storage.ts +++ b/server/mongo/src/storage.ts @@ -1174,7 +1174,9 @@ abstract class MongoAdapterBase implements DbAdapter { async clean (ctx: MeasureContext, domain: Domain, docs: Ref[]): Promise { await ctx.with('clean', {}, async () => { - await this.db.collection(domain).deleteMany({ _id: { $in: docs } }) + if (docs.length > 0) { + await this.db.collection(domain).deleteMany({ _id: { $in: docs } }) + } }) } } @@ -1693,7 +1695,7 @@ class MongoTxAdapter extends MongoAdapterBase implements TxAdapter { ) } model.forEach((tx) => (tx.modifiedBy === core.account.System && !isPersonAccount(tx) ? systemTx : userTx).push(tx)) - return systemTx.concat(userTx) + return this.stripHash(systemTx.concat(userTx)) as Tx[] } } diff --git a/server/mongo/src/utils.ts b/server/mongo/src/utils.ts index 6292bf003a..f6cba52b5b 100644 --- a/server/mongo/src/utils.ts +++ b/server/mongo/src/utils.ts @@ -169,6 +169,7 @@ export class DBCollectionHelper implements DomainHelperOperations { } async init (domain?: Domain): Promise { + // Check and create DB if missin if (domain === undefined) { // Init existing collecfions for (const c of (await this.db.listCollections({}, { nameOnly: true }).toArray()).map((it) => it.name)) { diff --git a/server/server-pipeline/src/pipeline.ts b/server/server-pipeline/src/pipeline.ts index 2b060de2f4..c6b7bc0116 100644 --- a/server/server-pipeline/src/pipeline.ts +++ b/server/server-pipeline/src/pipeline.ts @@ -10,6 +10,7 @@ import { ModelDb, type Branding, type MeasureContext, + type Tx, type WorkspaceIdWithUrl } from '@hcengineering/core' import { createElasticAdapter, createElasticBackupDataAdapter } from '@hcengineering/elastic' @@ -100,6 +101,7 @@ export function getTxAdapterFactory ( export function createServerPipeline ( metrics: MeasureContext, dbUrls: string, + model: Tx[], opt: { fullTextUrl: string rekoniUrl: string @@ -139,7 +141,7 @@ export function createServerPipeline ( DomainFindMiddleware.create, DomainTxMiddleware.create, DBAdapterInitMiddleware.create, - ModelMiddleware.create, + ModelMiddleware.create(model), DBAdapterMiddleware.create(conf), // Configure DB adapters BroadcastMiddleware.create(broadcast) ] @@ -164,6 +166,7 @@ export function createServerPipeline ( export function createBackupPipeline ( metrics: MeasureContext, dbUrls: string, + systemTx: Tx[], opt: { usePassedCtx?: boolean adapterSecurity?: boolean @@ -208,7 +211,7 @@ export function createBackupPipeline ( ContextNameMiddleware.create, DomainFindMiddleware.create, DBAdapterInitMiddleware.create, - ModelMiddleware.create, + ModelMiddleware.create(systemTx), DBAdapterMiddleware.create(conf) ] @@ -227,6 +230,7 @@ export function createBackupPipeline ( export async function getServerPipeline ( ctx: MeasureContext, + model: Tx[], mongodbUri: string, dbUrl: string | undefined, wsUrl: WorkspaceIdWithUrl @@ -242,6 +246,7 @@ export async function getServerPipeline ( const pipelineFactory = createServerPipeline( ctx, dbUrls, + model, { externalStorage: storageAdapter, fullTextUrl: 'http://localhost:9200', diff --git a/server/tool/src/index.ts b/server/tool/src/index.ts index 23aefeba97..0f162b6bc3 100644 --- a/server/tool/src/index.ts +++ b/server/tool/src/index.ts @@ -36,15 +36,16 @@ import core, { WorkspaceId, WorkspaceIdWithUrl, type Doc, + type Ref, type TxCUD } from '@hcengineering/core' import { consoleModelLogger, MigrateOperation, ModelLogger, tryMigrate } from '@hcengineering/model' import { AggregatorStorageAdapter, - DbAdapter, DomainIndexHelperImpl, Pipeline, - StorageAdapter + StorageAdapter, + type DbAdapter } from '@hcengineering/server-core' import { connect } from './connect' import { InitScript, WorkspaceInitializer } from './initializer' @@ -141,9 +142,16 @@ export async function initModel ( logger.log('transactions deleted.', { workspaceId: workspaceId.name }) } - logger.log('creating model...', workspaceId) - await adapter.upload(ctx, DOMAIN_TX, txes) - logger.log('model transactions inserted.', { count: txes.length }) + logger.log('creating database...', workspaceId) + await adapter.upload(ctx, DOMAIN_TX, [ + { + _class: core.class.Tx, + _id: 'first-tx' as Ref, + modifiedBy: core.account.System, + modifiedOn: Date.now(), + space: core.space.DerivedTx + } + ]) await progress(30) @@ -264,11 +272,14 @@ export async function upgradeModel ( throw Error('Model txes must target only core.space.Model') } - const prevModel = await fetchModel(ctx, pipeline) + const newModelRes = await ctx.with('load-model', {}, (ctx) => pipeline.loadModel(ctx, 0)) + const newModel = Array.isArray(newModelRes) ? newModelRes : newModelRes.transactions + + const { hierarchy, modelDb, model } = await buildModel(ctx, newModel) const { migrateClient: preMigrateClient } = await prepareMigrationClient( pipeline, - prevModel.hierarchy, - prevModel.modelDb, + hierarchy, + modelDb, logger, storageAdapter, workspaceId @@ -305,36 +316,9 @@ export async function upgradeModel ( } logger.log('removing model...', { workspaceId: workspaceId.name }) await progress(10) - const toRemove = await pipeline.findAll(ctx, core.class.Tx, { - objectSpace: core.space.Model, - modifiedBy: core.account.System, - objectClass: { $nin: [contact.class.PersonAccount, 'contact:class:EmployeeAccount'] } - }) - await pipeline.context.lowLevelStorage.clean( - ctx, - DOMAIN_TX, - toRemove.map((p) => p._id) - ) - logger.log('transactions deleted.', { workspaceId: workspaceId.name, count: toRemove.length }) - logger.log('creating model...', { workspaceId: workspaceId.name }) - await pipeline.context.lowLevelStorage.upload(ctx, DOMAIN_TX, txes) - logger.log('model transactions inserted.', { workspaceId: workspaceId.name, count: txes.length }) await progress(20) } - const newModel = [ - ...txes, - ...Array.from( - prevModel.model.filter( - (it) => - it.modifiedBy !== core.account.System || - (it as TxCUD).objectClass === contact.class.Person || - (it as TxCUD).objectClass === 'contact:class:PersonAccount' - ) - ) - ] - - const { hierarchy, modelDb, model } = await fetchModel(ctx, pipeline, newModel) const { migrateClient, migrateState } = await prepareMigrationClient( pipeline, hierarchy, @@ -383,6 +367,21 @@ export async function upgradeModel ( { state: 'indexes-v4', func: upgradeIndexes + }, + { + state: 'delete-model', + func: async (client) => { + const model = await client.find(DOMAIN_TX, { objectSpace: core.space.Model }) + + // Ignore Employee accounts. + const isUserTx = (it: Tx): boolean => + it.modifiedBy !== core.account.System || + (it as TxCUD).objectClass === 'contact:class:Person' || + (it as TxCUD).objectClass === 'contact:class:PersonAccount' + + const toDelete = model.filter((it) => !isUserTx(it)).map((it) => it._id) + await client.deleteMany(DOMAIN_TX, { _id: { $in: toDelete } }) + } } ]) }) @@ -463,26 +462,20 @@ async function prepareMigrationClient ( return { migrateClient, migrateState } } -export async function fetchModel ( +export async function buildModel ( ctx: MeasureContext, - pipeline: Pipeline, - model?: Tx[] + model: Tx[] ): Promise<{ hierarchy: Hierarchy, modelDb: ModelDb, model: Tx[] }> { const hierarchy = new Hierarchy() const modelDb = new ModelDb(hierarchy) - if (model === undefined) { - const res = await ctx.with('load-model', {}, (ctx) => pipeline.loadModel(ctx, 0)) - model = Array.isArray(res) ? res : res.transactions - } - ctx.withSync('build local model', {}, () => { for (const tx of model ?? []) { try { hierarchy.tx(tx) } catch (err: any) {} } - modelDb.addTxes(ctx, model as Tx[], false) + modelDb.addTxes(ctx, model, false) }) return { hierarchy, modelDb, model: model ?? [] } } diff --git a/server/workspace-service/src/ws-operations.ts b/server/workspace-service/src/ws-operations.ts index cc32f0066e..06636e5123 100644 --- a/server/workspace-service/src/ws-operations.ts +++ b/server/workspace-service/src/ws-operations.ts @@ -163,6 +163,7 @@ export async function createWorkspace ( const factory: PipelineFactory = createServerPipeline( ctx, dbUrls, + txes, { externalStorage: storageAdapter, fullTextUrl: 'http://localhost:9200', @@ -288,7 +289,7 @@ export async function upgradeWorkspace ( let pipeline: Pipeline | undefined let storageAdapter: StorageAdapter | undefined try { - ;({ pipeline, storageAdapter } = await getServerPipeline(ctx, mongodbUri, dbUrl, wsUrl)) + ;({ pipeline, storageAdapter } = await getServerPipeline(ctx, txes, mongodbUri, dbUrl, wsUrl)) const contextData = new SessionDataImpl( systemAccountEmail, 'backup',