node_modules ignore

This commit is contained in:
oier committed 2025-05-08 23:43:47 +02:00
1 parent e19d52f172
commit 4574544c9f
65041 files changed
+10593536

No files matched your search

+29
View File
@@ -0,0 +1,29 @@
import { DataTransferError, Severity } from '../errors';
type TransferEngineStep = 'initialization' | 'validation' | 'transfer';
type TransferEngineErrorDetails<P extends TransferEngineStep = TransferEngineStep, U = never> = {
step: P;
} & ([U] extends [never] ? unknown : {
details?: U;
});
declare class TransferEngineError<P extends TransferEngineStep = TransferEngineStep, U = never, T extends TransferEngineErrorDetails<P, U> = TransferEngineErrorDetails<P, U>> extends DataTransferError<T> {
constructor(severity: Severity, message?: string, details?: T | null);
}
declare class TransferEngineInitializationError extends TransferEngineError<'initialization'> {
constructor(message?: string);
}
declare class TransferEngineValidationError<T extends {
check: string;
} = {
check: string;
}> extends TransferEngineError<'validation', T> {
constructor(message?: string, details?: T);
}
declare class TransferEngineTransferError<T extends {
check: string;
} = {
check: string;
}> extends TransferEngineError<'transfer', T> {
constructor(message?: string, details?: T);
}
export { TransferEngineError, TransferEngineInitializationError, TransferEngineValidationError, TransferEngineTransferError, };
//# sourceMappingURL=errors.d.ts.map
@@ -0,0 +1 @@
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/engine/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAgB,MAAM,WAAW,CAAC;AAEtE,KAAK,kBAAkB,GAAG,gBAAgB,GAAG,YAAY,GAAG,UAAU,CAAC;AAEvE,KAAK,0BAA0B,CAAC,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,EAAE,CAAC,GAAG,KAAK,IAAI;IAC9F,IAAI,EAAE,CAAC,CAAC;CACT,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,GAAG;IAAE,OAAO,CAAC,EAAE,CAAC,CAAA;CAAE,CAAC,CAAC;AAEtD,cAAM,mBAAmB,CACvB,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,EACjD,CAAC,GAAG,KAAK,EACT,CAAC,SAAS,0BAA0B,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,0BAA0B,CAAC,CAAC,EAAE,CAAC,CAAC,CAC7E,SAAQ,iBAAiB,CAAC,CAAC,CAAC;gBAChB,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI;CAGrE;AAED,cAAM,iCAAkC,SAAQ,mBAAmB,CAAC,gBAAgB,CAAC;gBACvE,OAAO,CAAC,EAAE,MAAM;CAG7B;AAED,cAAM,6BAA6B,CACjC,CAAC,SAAS;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAC/C,SAAQ,mBAAmB,CAAC,YAAY,EAAE,CAAC,CAAC;gBAChC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;CAG1C;AAED,cAAM,2BAA2B,CAC/B,CAAC,SAAS;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAC/C,SAAQ,mBAAmB,CAAC,UAAU,EAAE,CAAC,CAAC;gBAC9B,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;CAG1C;AAED,OAAO,EACL,mBAAmB,EACnB,iCAAiC,EACjC,6BAA6B,EAC7B,2BAA2B,GAC5B,CAAC"}
+39
View File
@@ -0,0 +1,39 @@
'use strict';
var constants = require('../errors/constants.js');
var base = require('../errors/base.js');
class TransferEngineError extends base.DataTransferError {
constructor(severity, message, details){
super('engine', severity, message, details);
}
}
class TransferEngineInitializationError extends TransferEngineError {
constructor(message){
super(constants.SeverityKind.FATAL, message, {
step: 'initialization'
});
}
}
class TransferEngineValidationError extends TransferEngineError {
constructor(message, details){
super(constants.SeverityKind.FATAL, message, {
step: 'validation',
details
});
}
}
class TransferEngineTransferError extends TransferEngineError {
constructor(message, details){
super(constants.SeverityKind.FATAL, message, {
step: 'transfer',
details
});
}
}
exports.TransferEngineError = TransferEngineError;
exports.TransferEngineInitializationError = TransferEngineInitializationError;
exports.TransferEngineTransferError = TransferEngineTransferError;
exports.TransferEngineValidationError = TransferEngineValidationError;
//# sourceMappingURL=errors.js.map
+1
View File
@@ -0,0 +1 @@
{"version":3,"file":"errors.js","sources":["../../src/engine/errors.ts"],"sourcesContent":["import { DataTransferError, Severity, SeverityKind } from '../errors';\n\ntype TransferEngineStep = 'initialization' | 'validation' | 'transfer';\n\ntype TransferEngineErrorDetails<P extends TransferEngineStep = TransferEngineStep, U = never> = {\n step: P;\n} & ([U] extends [never] ? unknown : { details?: U });\n\nclass TransferEngineError<\n P extends TransferEngineStep = TransferEngineStep,\n U = never,\n T extends TransferEngineErrorDetails<P, U> = TransferEngineErrorDetails<P, U>,\n> extends DataTransferError<T> {\n constructor(severity: Severity, message?: string, details?: T | null) {\n super('engine', severity, message, details);\n }\n}\n\nclass TransferEngineInitializationError extends TransferEngineError<'initialization'> {\n constructor(message?: string) {\n super(SeverityKind.FATAL, message, { step: 'initialization' });\n }\n}\n\nclass TransferEngineValidationError<\n T extends { check: string } = { check: string },\n> extends TransferEngineError<'validation', T> {\n constructor(message?: string, details?: T) {\n super(SeverityKind.FATAL, message, { step: 'validation', details });\n }\n}\n\nclass TransferEngineTransferError<\n T extends { check: string } = { check: string },\n> extends TransferEngineError<'transfer', T> {\n constructor(message?: string, details?: T) {\n super(SeverityKind.FATAL, message, { step: 'transfer', details });\n }\n}\n\nexport {\n TransferEngineError,\n TransferEngineInitializationError,\n TransferEngineValidationError,\n TransferEngineTransferError,\n};\n"],"names":["TransferEngineError","DataTransferError","constructor","severity","message","details","TransferEngineInitializationError","SeverityKind","FATAL","step","TransferEngineValidationError","TransferEngineTransferError"],"mappings":";;;;;AAQA,MAAMA,mBAIIC,SAAAA,sBAAAA,CAAAA;AACRC,IAAAA,WAAAA,CAAYC,QAAkB,EAAEC,OAAgB,EAAEC,OAAkB,CAAE;QACpE,KAAK,CAAC,QAAUF,EAAAA,QAAAA,EAAUC,OAASC,EAAAA,OAAAA,CAAAA;AACrC;AACF;AAEA,MAAMC,iCAA0CN,SAAAA,mBAAAA,CAAAA;AAC9CE,IAAAA,WAAAA,CAAYE,OAAgB,CAAE;AAC5B,QAAA,KAAK,CAACG,sBAAAA,CAAaC,KAAK,EAAEJ,OAAS,EAAA;YAAEK,IAAM,EAAA;AAAiB,SAAA,CAAA;AAC9D;AACF;AAEA,MAAMC,6BAEIV,SAAAA,mBAAAA,CAAAA;IACRE,WAAYE,CAAAA,OAAgB,EAAEC,OAAW,CAAE;AACzC,QAAA,KAAK,CAACE,sBAAAA,CAAaC,KAAK,EAAEJ,OAAS,EAAA;YAAEK,IAAM,EAAA,YAAA;AAAcJ,YAAAA;AAAQ,SAAA,CAAA;AACnE;AACF;AAEA,MAAMM,2BAEIX,SAAAA,mBAAAA,CAAAA;IACRE,WAAYE,CAAAA,OAAgB,EAAEC,OAAW,CAAE;AACzC,QAAA,KAAK,CAACE,sBAAAA,CAAaC,KAAK,EAAEJ,OAAS,EAAA;YAAEK,IAAM,EAAA,UAAA;AAAYJ,YAAAA;AAAQ,SAAA,CAAA;AACjE;AACF;;;;;;;"}
+34
View File
@@ -0,0 +1,34 @@
import { SeverityKind } from '../errors/constants.mjs';
import { DataTransferError } from '../errors/base.mjs';
class TransferEngineError extends DataTransferError {
constructor(severity, message, details){
super('engine', severity, message, details);
}
}
class TransferEngineInitializationError extends TransferEngineError {
constructor(message){
super(SeverityKind.FATAL, message, {
step: 'initialization'
});
}
}
class TransferEngineValidationError extends TransferEngineError {
constructor(message, details){
super(SeverityKind.FATAL, message, {
step: 'validation',
details
});
}
}
class TransferEngineTransferError extends TransferEngineError {
constructor(message, details){
super(SeverityKind.FATAL, message, {
step: 'transfer',
details
});
}
}
export { TransferEngineError, TransferEngineInitializationError, TransferEngineTransferError, TransferEngineValidationError };
//# sourceMappingURL=errors.mjs.map
+1
View File
@@ -0,0 +1 @@
{"version":3,"file":"errors.mjs","sources":["../../src/engine/errors.ts"],"sourcesContent":["import { DataTransferError, Severity, SeverityKind } from '../errors';\n\ntype TransferEngineStep = 'initialization' | 'validation' | 'transfer';\n\ntype TransferEngineErrorDetails<P extends TransferEngineStep = TransferEngineStep, U = never> = {\n step: P;\n} & ([U] extends [never] ? unknown : { details?: U });\n\nclass TransferEngineError<\n P extends TransferEngineStep = TransferEngineStep,\n U = never,\n T extends TransferEngineErrorDetails<P, U> = TransferEngineErrorDetails<P, U>,\n> extends DataTransferError<T> {\n constructor(severity: Severity, message?: string, details?: T | null) {\n super('engine', severity, message, details);\n }\n}\n\nclass TransferEngineInitializationError extends TransferEngineError<'initialization'> {\n constructor(message?: string) {\n super(SeverityKind.FATAL, message, { step: 'initialization' });\n }\n}\n\nclass TransferEngineValidationError<\n T extends { check: string } = { check: string },\n> extends TransferEngineError<'validation', T> {\n constructor(message?: string, details?: T) {\n super(SeverityKind.FATAL, message, { step: 'validation', details });\n }\n}\n\nclass TransferEngineTransferError<\n T extends { check: string } = { check: string },\n> extends TransferEngineError<'transfer', T> {\n constructor(message?: string, details?: T) {\n super(SeverityKind.FATAL, message, { step: 'transfer', details });\n }\n}\n\nexport {\n TransferEngineError,\n TransferEngineInitializationError,\n TransferEngineValidationError,\n TransferEngineTransferError,\n};\n"],"names":["TransferEngineError","DataTransferError","constructor","severity","message","details","TransferEngineInitializationError","SeverityKind","FATAL","step","TransferEngineValidationError","TransferEngineTransferError"],"mappings":";;;AAQA,MAAMA,mBAIIC,SAAAA,iBAAAA,CAAAA;AACRC,IAAAA,WAAAA,CAAYC,QAAkB,EAAEC,OAAgB,EAAEC,OAAkB,CAAE;QACpE,KAAK,CAAC,QAAUF,EAAAA,QAAAA,EAAUC,OAASC,EAAAA,OAAAA,CAAAA;AACrC;AACF;AAEA,MAAMC,iCAA0CN,SAAAA,mBAAAA,CAAAA;AAC9CE,IAAAA,WAAAA,CAAYE,OAAgB,CAAE;AAC5B,QAAA,KAAK,CAACG,YAAAA,CAAaC,KAAK,EAAEJ,OAAS,EAAA;YAAEK,IAAM,EAAA;AAAiB,SAAA,CAAA;AAC9D;AACF;AAEA,MAAMC,6BAEIV,SAAAA,mBAAAA,CAAAA;IACRE,WAAYE,CAAAA,OAAgB,EAAEC,OAAW,CAAE;AACzC,QAAA,KAAK,CAACE,YAAAA,CAAaC,KAAK,EAAEJ,OAAS,EAAA;YAAEK,IAAM,EAAA,YAAA;AAAcJ,YAAAA;AAAQ,SAAA,CAAA;AACnE;AACF;AAEA,MAAMM,2BAEIX,SAAAA,mBAAAA,CAAAA;IACRE,WAAYE,CAAAA,OAAgB,EAAEC,OAAW,CAAE;AACzC,QAAA,KAAK,CAACE,YAAAA,CAAaC,KAAK,EAAEJ,OAAS,EAAA;YAAEK,IAAM,EAAA,UAAA;AAAYJ,YAAAA;AAAQ,SAAA,CAAA;AACjE;AACF;;;;"}
+66
View File
@@ -0,0 +1,66 @@
/// <reference types="node" />
import { PassThrough } from 'stream';
import type { IDestinationProvider, ISourceProvider, ITransferEngine, ITransferEngineOptions, TransferProgress, ITransferResults, TransferStage, TransferFilters, TransferFilterPreset, SchemaDiffHandler, SchemaDiffHandlerContext, ErrorHandler, ErrorHandlerContext, ErrorCode } from '../../types';
import { IDiagnosticReporter, ErrorDiagnosticSeverity } from '../utils/diagnostic';
export declare const TRANSFER_STAGES: ReadonlyArray<TransferStage>;
export type TransferGroupFilter = Record<TransferFilterPreset, TransferFilters>;
/**
* Preset filters for only/exclude options
* */
export declare const TransferGroupPresets: TransferGroupFilter;
export declare const DEFAULT_VERSION_STRATEGY = "ignore";
export declare const DEFAULT_SCHEMA_STRATEGY = "strict";
declare class TransferEngine<S extends ISourceProvider = ISourceProvider, D extends IDestinationProvider = IDestinationProvider> implements ITransferEngine {
#private;
sourceProvider: ISourceProvider;
destinationProvider: IDestinationProvider;
options: ITransferEngineOptions;
progress: {
data: TransferProgress;
stream: PassThrough;
};
diagnostics: IDiagnosticReporter;
onSchemaDiff(handler: SchemaDiffHandler): void;
addErrorHandler(handlerName: ErrorCode, handler: ErrorHandler): void;
attemptResolveError(error: Error): Promise<boolean>;
constructor(sourceProvider: S, destinationProvider: D, options: ITransferEngineOptions);
/**
* Report a fatal error and throw it
*/
panic(error: Error): void;
/**
* Report an error diagnostic
*/
reportError(error: Error, severity: ErrorDiagnosticSeverity): void;
/**
* Report a warning diagnostic
*/
reportWarning(message: string, origin?: string): void;
/**
* Report an info diagnostic
*/
reportInfo(message: string, params?: unknown): void;
shouldSkipStage(stage: TransferStage): boolean;
abortTransfer(): Promise<void>;
init(): Promise<void>;
/**
* Run the bootstrap method in both source and destination providers
*/
bootstrap(): Promise<void>;
/**
* Run the close method in both source and destination providers
*/
close(): Promise<void>;
integrityCheck(): Promise<void>;
transfer(): Promise<ITransferResults<S, D>>;
beforeTransfer(): Promise<void>;
transferSchemas(): Promise<void>;
transferEntities(): Promise<void>;
transferLinks(): Promise<void>;
transferAssets(): Promise<void>;
transferConfiguration(): Promise<void>;
}
export declare const createTransferEngine: <S extends ISourceProvider, D extends IDestinationProvider>(sourceProvider: S, destinationProvider: D, options: ITransferEngineOptions) => TransferEngine<S, D>;
export type { TransferEngine, ITransferEngine, ITransferEngineOptions, ISourceProvider, IDestinationProvider, TransferStage, TransferFilterPreset, ErrorHandlerContext, SchemaDiffHandlerContext, ITransferResults, };
export * as errors from './errors';
//# sourceMappingURL=index.d.ts.map
+1
View File
@@ -0,0 +1 @@
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/engine/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAiC,MAAM,QAAQ,CAAC;AAWpE,OAAO,KAAK,EAEV,oBAAoB,EAIpB,eAAe,EACf,eAAe,EACf,sBAAsB,EACtB,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EAGb,eAAe,EACf,oBAAoB,EAEpB,iBAAiB,EACjB,wBAAwB,EACxB,YAAY,EACZ,mBAAmB,EAEnB,SAAS,EACV,MAAM,aAAa,CAAC;AAMrB,OAAO,EAEL,mBAAmB,EACnB,uBAAuB,EACxB,MAAM,qBAAqB,CAAC;AAK7B,eAAO,MAAM,eAAe,EAAE,aAAa,CAAC,aAAa,CAMvD,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,oBAAoB,EAAE,eAAe,CAAC,CAAC;AAEhF;;KAEK;AACL,eAAO,MAAM,oBAAoB,EAAE,mBAoBlC,CAAC;AAEF,eAAO,MAAM,wBAAwB,WAAW,CAAC;AACjD,eAAO,MAAM,uBAAuB,WAAW,CAAC;AAIhD,cAAM,cAAc,CAClB,CAAC,SAAS,eAAe,GAAG,eAAe,EAC3C,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,CACrD,YAAW,eAAe;;IAE1B,cAAc,EAAE,eAAe,CAAC;IAEhC,mBAAmB,EAAE,oBAAoB,CAAC;IAE1C,OAAO,EAAE,sBAAsB,CAAC;IAOhC,QAAQ,EAAE;QAER,IAAI,EAAE,gBAAgB,CAAC;QAEvB,MAAM,EAAE,WAAW,CAAC;KACrB,CAAC;IAEF,WAAW,EAAE,mBAAmB,CAAC;IAcjC,YAAY,CAAC,OAAO,EAAE,iBAAiB;IAIvC,eAAe,CAAC,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY;IAOvD,mBAAmB,CAAC,KAAK,EAAE,KAAK;gBAa1B,cAAc,EAAE,CAAC,EAAE,mBAAmB,EAAE,CAAC,EAAE,OAAO,EAAE,sBAAsB;IAatF;;OAEG;IACH,KAAK,CAAC,KAAK,EAAE,KAAK;IAMlB;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,uBAAuB;IAa3D;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;IAO9C;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO;IAqR5C,eAAe,CAAC,KAAK,EAAE,aAAa;IAuH9B,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAM9B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAa3B;;OAEG;IACG,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAahC;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAyCtB,cAAc;IAyDd,QAAQ,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAmD3C,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAwB/B,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBhC,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IA6CjC,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAsC9B,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB/B,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;CAc7C;AAED,eAAO,MAAM,oBAAoB,8EACf,CAAC,uBACI,CAAC,WACb,sBAAsB,KAC9B,eAAe,CAAC,EAAE,CAAC,CAErB,CAAC;AAEF,YAAY,EACV,cAAc,EACd,eAAe,EACf,sBAAsB,EACtB,eAAe,EACf,oBAAoB,EACpB,aAAa,EACb,oBAAoB,EACpB,mBAAmB,EACnB,wBAAwB,EACxB,gBAAgB,GACjB,CAAC;AAEF,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC"}
+797
View File
@@ -0,0 +1,797 @@
'use strict';
var stream = require('stream');
var promises = require('stream/promises');
var path = require('path');
var os = require('os');
var streamChain = require('stream-chain');
var fp = require('lodash/fp');
var semver = require('semver');
var index = require('./validation/schemas/index.js');
var provider = require('./validation/provider.js');
var errors = require('./errors.js');
var diagnostic = require('../utils/diagnostic.js');
require('crypto');
var stream$1 = require('../utils/stream.js');
var json = require('../utils/json.js');
require('events');
var middleware = require('../utils/middleware.js');
var providers = require('../errors/providers.js');
function _class_private_field_loose_base(receiver, privateKey) {
if (!Object.prototype.hasOwnProperty.call(receiver, privateKey)) {
throw new TypeError("attempted to use private field on non-instance");
}
return receiver;
}
var id = 0;
function _class_private_field_loose_key(name) {
return "__private_" + id++ + "_" + name;
}
const TRANSFER_STAGES = Object.freeze([
'entities',
'links',
'assets',
'schemas',
'configuration'
]);
/**
* Preset filters for only/exclude options
* */ const TransferGroupPresets = {
content: {
links: true,
entities: true
},
files: {
assets: true
},
config: {
configuration: true
}
};
const DEFAULT_VERSION_STRATEGY = 'ignore';
const DEFAULT_SCHEMA_STRATEGY = 'strict';
var _metadata = /*#__PURE__*/ _class_private_field_loose_key("_metadata"), _schema = /*#__PURE__*/ _class_private_field_loose_key("_schema"), _handlers = /*#__PURE__*/ _class_private_field_loose_key("_handlers"), _currentStreamController = /*#__PURE__*/ _class_private_field_loose_key("_currentStreamController"), _aborted = /*#__PURE__*/ _class_private_field_loose_key("_aborted"), /**
* Create and return a transform stream based on the given stage and options.
*
* Allowed transformations includes 'filter' and 'map'.
*/ _createStageTransformStream = /*#__PURE__*/ _class_private_field_loose_key("_createStageTransformStream"), /**
* Update the Engine's transfer progress data for a given stage.
*
* Providing aggregate options enable custom computation to get the size (bytes) or the aggregate key associated with the data
*/ _updateTransferProgress = /*#__PURE__*/ _class_private_field_loose_key("_updateTransferProgress"), /**
* Create and return a PassThrough stream.
*
* Upon writing data into it, it'll update the Engine's transfer progress data and trigger stage update events.
*/ _progressTracker = /*#__PURE__*/ _class_private_field_loose_key("_progressTracker"), /**
* Shorthand method used to trigger transfer update events to every listeners
*/ _emitTransferUpdate = /*#__PURE__*/ _class_private_field_loose_key("_emitTransferUpdate"), /**
* Shorthand method used to trigger stage update events to every listeners
*/ _emitStageUpdate = /*#__PURE__*/ _class_private_field_loose_key("_emitStageUpdate"), /**
* Run a version check between two strapi version (source and destination) using the strategy given to the engine during initialization.
*
* If there is a mismatch, throws a validation error.
*/ _assertStrapiVersionIntegrity = /*#__PURE__*/ _class_private_field_loose_key("_assertStrapiVersionIntegrity"), /**
* Run a check between two set of schemas (source and destination) using the strategy given to the engine during initialization.
*
* If there are differences and/or incompatibilities between source and destination schemas, then throw a validation error.
*/ _assertSchemasMatching = /*#__PURE__*/ _class_private_field_loose_key("_assertSchemasMatching"), _transferStage = /*#__PURE__*/ _class_private_field_loose_key("_transferStage"), _resolveProviderResource = /*#__PURE__*/ _class_private_field_loose_key("_resolveProviderResource"), _getSchemas = /*#__PURE__*/ _class_private_field_loose_key("_getSchemas");
class TransferEngine {
onSchemaDiff(handler) {
_class_private_field_loose_base(this, _handlers)[_handlers]?.schemaDiff?.push(handler);
}
addErrorHandler(handlerName, handler) {
if (!_class_private_field_loose_base(this, _handlers)[_handlers].errors[handlerName]) {
_class_private_field_loose_base(this, _handlers)[_handlers].errors[handlerName] = [];
}
_class_private_field_loose_base(this, _handlers)[_handlers].errors[handlerName]?.push(handler);
}
async attemptResolveError(error) {
const context = {};
if (error instanceof providers.ProviderTransferError && error.details?.details.code) {
const errorCode = error.details?.details.code;
if (!_class_private_field_loose_base(this, _handlers)[_handlers].errors[errorCode]) {
_class_private_field_loose_base(this, _handlers)[_handlers].errors[errorCode] = [];
}
await middleware.runMiddleware(context ?? {}, _class_private_field_loose_base(this, _handlers)[_handlers].errors[errorCode] ?? []);
}
return !!context.ignore;
}
/**
* Report a fatal error and throw it
*/ panic(error) {
this.reportError(error, 'fatal');
throw error;
}
/**
* Report an error diagnostic
*/ reportError(error, severity) {
this.diagnostics.report({
kind: 'error',
details: {
severity,
createdAt: new Date(),
name: error.name,
message: error.message,
error
}
});
}
/**
* Report a warning diagnostic
*/ reportWarning(message, origin1) {
this.diagnostics.report({
kind: 'warning',
details: {
createdAt: new Date(),
message,
origin: origin1
}
});
}
/**
* Report an info diagnostic
*/ reportInfo(message, params) {
this.diagnostics.report({
kind: 'info',
details: {
createdAt: new Date(),
message,
params,
origin: 'engine'
}
});
}
shouldSkipStage(stage) {
const { exclude, only } = this.options;
// schemas must always be included
if (stage === 'schemas') {
return false;
}
// everything is included by default unless 'only' has been set
let included = fp.isEmpty(only);
if (only && only.length > 0) {
included = only.some((transferGroup)=>{
return TransferGroupPresets[transferGroup][stage];
});
}
if (exclude && exclude.length > 0) {
if (included) {
included = !exclude.some((transferGroup)=>{
return TransferGroupPresets[transferGroup][stage];
});
}
}
return !included;
}
// Cause an ongoing transfer to abort gracefully
async abortTransfer() {
_class_private_field_loose_base(this, _aborted)[_aborted] = true;
_class_private_field_loose_base(this, _currentStreamController)[_currentStreamController]?.abort();
throw new errors.TransferEngineError('fatal', 'Transfer aborted.');
}
async init() {
// Resolve providers' resource and store
// them in the engine's internal state
await _class_private_field_loose_base(this, _resolveProviderResource)[_resolveProviderResource]();
// Update the destination provider's source metadata
const { source: sourceMetadata } = _class_private_field_loose_base(this, _metadata)[_metadata];
if (sourceMetadata) {
this.destinationProvider.setMetadata?.('source', sourceMetadata);
}
}
/**
* Run the bootstrap method in both source and destination providers
*/ async bootstrap() {
const results = await Promise.allSettled([
this.sourceProvider.bootstrap?.(this.diagnostics),
this.destinationProvider.bootstrap?.(this.diagnostics)
]);
results.forEach((result)=>{
if (result.status === 'rejected') {
this.panic(result.reason);
}
});
}
/**
* Run the close method in both source and destination providers
*/ async close() {
const results = await Promise.allSettled([
this.sourceProvider.close?.(),
this.destinationProvider.close?.()
]);
results.forEach((result)=>{
if (result.status === 'rejected') {
this.panic(result.reason);
}
});
}
async integrityCheck() {
const sourceMetadata = await this.sourceProvider.getMetadata();
const destinationMetadata = await this.destinationProvider.getMetadata();
if (sourceMetadata && destinationMetadata) {
_class_private_field_loose_base(this, _assertStrapiVersionIntegrity)[_assertStrapiVersionIntegrity](sourceMetadata?.strapi?.version, destinationMetadata?.strapi?.version);
}
const { sourceSchemas, destinationSchemas } = await _class_private_field_loose_base(this, _getSchemas)[_getSchemas]();
try {
if (sourceSchemas && destinationSchemas) {
_class_private_field_loose_base(this, _assertSchemasMatching)[_assertSchemasMatching](sourceSchemas, destinationSchemas);
}
} catch (error) {
// if this is a schema matching error, allow handlers to resolve it
if (error instanceof errors.TransferEngineValidationError && error.details?.details?.diffs) {
const schemaDiffs = error.details?.details?.diffs;
const context = {
ignoredDiffs: {},
diffs: schemaDiffs,
source: this.sourceProvider,
destination: this.destinationProvider
};
// if we don't have any handlers, throw the original error
if (fp.isEmpty(_class_private_field_loose_base(this, _handlers)[_handlers].schemaDiff)) {
throw error;
}
await middleware.runMiddleware(context, _class_private_field_loose_base(this, _handlers)[_handlers].schemaDiff);
// if there are any remaining diffs that weren't ignored
const unresolvedDiffs = json.diff(context.diffs, context.ignoredDiffs);
if (unresolvedDiffs.length) {
this.panic(new errors.TransferEngineValidationError('Unresolved differences in schema', {
check: 'schema.changes',
unresolvedDiffs
}));
}
return;
}
throw error;
}
}
async transfer() {
// reset data between transfers
this.progress.data = {};
try {
_class_private_field_loose_base(this, _emitTransferUpdate)[_emitTransferUpdate]('init');
await this.bootstrap();
await this.init();
await this.integrityCheck();
_class_private_field_loose_base(this, _emitTransferUpdate)[_emitTransferUpdate]('start');
await this.beforeTransfer();
// Run the transfer stages
await this.transferSchemas();
await this.transferEntities();
await this.transferAssets();
await this.transferLinks();
await this.transferConfiguration();
// Gracefully close the providers
await this.close();
_class_private_field_loose_base(this, _emitTransferUpdate)[_emitTransferUpdate]('finish');
} catch (e) {
_class_private_field_loose_base(this, _emitTransferUpdate)[_emitTransferUpdate]('error', {
error: e
});
const lastDiagnostic = fp.last(this.diagnostics.stack.items);
// Do not report an error diagnostic if the last one reported the same error
if (e instanceof Error && (!lastDiagnostic || lastDiagnostic.kind !== 'error' || lastDiagnostic.details.error !== e)) {
this.reportError(e, e.severity || 'fatal');
}
// Rollback the destination provider if an exception is thrown during the transfer
// Note: This will be configurable in the future
await this.destinationProvider.rollback?.(e);
throw e;
}
return {
source: this.sourceProvider.results,
destination: this.destinationProvider.results,
engine: this.progress.data
};
}
async beforeTransfer() {
const runWithDiagnostic = async (provider)=>{
try {
await provider.beforeTransfer?.();
} catch (error) {
if (error instanceof Error) {
const resolved = await this.attemptResolveError(error);
if (resolved) {
return;
}
this.panic(error);
} else {
this.panic(new Error(`Unknwon error when executing "beforeTransfer" on the ${origin} provider`));
}
}
};
await runWithDiagnostic(this.sourceProvider);
await runWithDiagnostic(this.destinationProvider);
}
async transferSchemas() {
const stage = 'schemas';
if (this.shouldSkipStage(stage)) {
return;
}
const source = await this.sourceProvider.createSchemasReadStream?.();
const destination = await this.destinationProvider.createSchemasWriteStream?.();
const transform = _class_private_field_loose_base(this, _createStageTransformStream)[_createStageTransformStream](stage);
const tracker = _class_private_field_loose_base(this, _progressTracker)[_progressTracker](stage, {
key: (value)=>value.modelType
});
await _class_private_field_loose_base(this, _transferStage)[_transferStage]({
stage,
source,
destination,
transform,
tracker
});
}
async transferEntities() {
const stage = 'entities';
if (this.shouldSkipStage(stage)) {
return;
}
const source = await this.sourceProvider.createEntitiesReadStream?.();
const destination = await this.destinationProvider.createEntitiesWriteStream?.();
const transform = streamChain.chain([
_class_private_field_loose_base(this, _createStageTransformStream)[_createStageTransformStream](stage),
new stream.Transform({
objectMode: true,
transform: async (entity, _encoding, callback)=>{
const { destinationSchemas: schemas } = await _class_private_field_loose_base(this, _getSchemas)[_getSchemas]();
if (!schemas) {
return callback(null, entity);
}
// TODO: this would be safer if we only ignored things in ignoredDiffs, otherwise continue and let an error be thrown
const availableContentTypes = Object.entries(schemas).filter(([, schema])=>schema.modelType === 'contentType').map(([uid])=>uid);
// If the type of the transferred entity doesn't exist in the destination, then discard it
if (!availableContentTypes.includes(entity.type)) {
return callback(null, undefined);
}
const { type, data } = entity;
const attributes = schemas[type].attributes;
const attributesToKeep = Object.keys(attributes).concat('documentId');
const updatedEntity = fp.set('data', fp.pick(attributesToKeep, data), entity);
callback(null, updatedEntity);
}
})
]);
const tracker = _class_private_field_loose_base(this, _progressTracker)[_progressTracker](stage, {
key: (value)=>value.type
});
await _class_private_field_loose_base(this, _transferStage)[_transferStage]({
stage,
source,
destination,
transform,
tracker
});
}
async transferLinks() {
const stage = 'links';
if (this.shouldSkipStage(stage)) {
return;
}
const source = await this.sourceProvider.createLinksReadStream?.();
const destination = await this.destinationProvider.createLinksWriteStream?.();
const transform = streamChain.chain([
_class_private_field_loose_base(this, _createStageTransformStream)[_createStageTransformStream](stage),
new stream.Transform({
objectMode: true,
transform: async (link, _encoding, callback)=>{
const { destinationSchemas: schemas } = await _class_private_field_loose_base(this, _getSchemas)[_getSchemas]();
if (!schemas) {
return callback(null, link);
}
// TODO: this would be safer if we only ignored things in ignoredDiffs, otherwise continue and let an error be thrown
const availableContentTypes = Object.keys(schemas);
const isValidType = (uid)=>availableContentTypes.includes(uid);
if (!isValidType(link.left.type) || !isValidType(link.right.type)) {
return callback(null, undefined); // ignore the link
}
callback(null, link);
}
})
]);
const tracker = _class_private_field_loose_base(this, _progressTracker)[_progressTracker](stage);
await _class_private_field_loose_base(this, _transferStage)[_transferStage]({
stage,
source,
destination,
transform,
tracker
});
}
async transferAssets() {
const stage = 'assets';
if (this.shouldSkipStage(stage)) {
return;
}
const source = await this.sourceProvider.createAssetsReadStream?.();
const destination = await this.destinationProvider.createAssetsWriteStream?.();
const transform = _class_private_field_loose_base(this, _createStageTransformStream)[_createStageTransformStream](stage);
const tracker = _class_private_field_loose_base(this, _progressTracker)[_progressTracker](stage, {
size: (value)=>value.stats.size,
key: (value)=>path.extname(value.filename) || 'No extension'
});
await _class_private_field_loose_base(this, _transferStage)[_transferStage]({
stage,
source,
destination,
transform,
tracker
});
}
async transferConfiguration() {
const stage = 'configuration';
if (this.shouldSkipStage(stage)) {
return;
}
const source = await this.sourceProvider.createConfigurationReadStream?.();
const destination = await this.destinationProvider.createConfigurationWriteStream?.();
const transform = _class_private_field_loose_base(this, _createStageTransformStream)[_createStageTransformStream](stage);
const tracker = _class_private_field_loose_base(this, _progressTracker)[_progressTracker](stage);
await _class_private_field_loose_base(this, _transferStage)[_transferStage]({
stage,
source,
destination,
transform,
tracker
});
}
constructor(sourceProvider, destinationProvider, options){
Object.defineProperty(this, _createStageTransformStream, {
value: createStageTransformStream
});
Object.defineProperty(this, _updateTransferProgress, {
value: updateTransferProgress
});
Object.defineProperty(this, _progressTracker, {
value: progressTracker
});
Object.defineProperty(this, _emitTransferUpdate, {
value: emitTransferUpdate
});
Object.defineProperty(this, _emitStageUpdate, {
value: emitStageUpdate
});
Object.defineProperty(this, _assertStrapiVersionIntegrity, {
value: assertStrapiVersionIntegrity
});
Object.defineProperty(this, _assertSchemasMatching, {
value: assertSchemasMatching
});
Object.defineProperty(this, _transferStage, {
value: transferStage
});
Object.defineProperty(this, _resolveProviderResource, {
value: resolveProviderResource
});
Object.defineProperty(this, _getSchemas, {
value: getSchemas
});
Object.defineProperty(this, _metadata, {
writable: true,
value: void 0
});
Object.defineProperty(this, _schema, {
writable: true,
value: void 0
});
Object.defineProperty(this, _handlers, {
writable: true,
value: void 0
});
Object.defineProperty(this, _currentStreamController, {
writable: true,
value: void 0
});
Object.defineProperty(this, _aborted, {
writable: true,
value: void 0
});
_class_private_field_loose_base(this, _metadata)[_metadata] = {};
_class_private_field_loose_base(this, _schema)[_schema] = {};
_class_private_field_loose_base(this, _handlers)[_handlers] = {
schemaDiff: [],
errors: {}
};
_class_private_field_loose_base(this, _aborted)[_aborted] = false;
this.diagnostics = diagnostic.createDiagnosticReporter();
provider.validateProvider('source', sourceProvider);
provider.validateProvider('destination', destinationProvider);
this.sourceProvider = sourceProvider;
this.destinationProvider = destinationProvider;
this.options = options;
this.progress = {
data: {},
stream: new stream.PassThrough({
objectMode: true
})
};
}
}
function createStageTransformStream(key, options = {}) {
const { includeGlobal = true } = options;
const { throttle } = this.options;
const { global: globalTransforms, [key]: stageTransforms } = this.options?.transforms ?? {};
let stream$2 = new stream.PassThrough({
objectMode: true
});
const applyTransforms = (transforms = [])=>{
const chainTransforms = [];
for (const transform of transforms){
if ('filter' in transform) {
chainTransforms.push(stream$1.filter(transform.filter));
}
if ('map' in transform) {
chainTransforms.push(stream$1.map(transform.map));
}
}
if (chainTransforms.length) {
stream$2 = stream$2.pipe(streamChain.chain(chainTransforms));
}
};
if (includeGlobal) {
applyTransforms(globalTransforms);
}
if (fp.isNumber(throttle) && throttle > 0) {
stream$2 = stream$2.pipe(new stream.PassThrough({
objectMode: true,
async transform (data, _encoding, callback) {
await new Promise((resolve)=>{
setTimeout(resolve, throttle);
});
callback(null, data);
}
}));
}
applyTransforms(stageTransforms);
return stream$2;
}
function updateTransferProgress(stage, data, aggregate) {
if (!this.progress.data[stage]) {
this.progress.data[stage] = {
count: 0,
bytes: 0,
startTime: Date.now()
};
}
const stageProgress = this.progress.data[stage];
if (!stageProgress) {
return;
}
const size = aggregate?.size?.(data) ?? JSON.stringify(data).length;
const key = aggregate?.key?.(data);
stageProgress.count += 1;
stageProgress.bytes += size;
// Handle aggregate updates if necessary
if (key) {
if (!stageProgress.aggregates) {
stageProgress.aggregates = {};
}
const { aggregates } = stageProgress;
if (!aggregates[key]) {
aggregates[key] = {
count: 0,
bytes: 0
};
}
aggregates[key].count += 1;
aggregates[key].bytes += size;
}
}
function progressTracker(stage, aggregate) {
return new stream.PassThrough({
objectMode: true,
transform: (data, _encoding, callback)=>{
_class_private_field_loose_base(this, _updateTransferProgress)[_updateTransferProgress](stage, data, aggregate);
_class_private_field_loose_base(this, _emitStageUpdate)[_emitStageUpdate]('progress', stage);
callback(null, data);
}
});
}
function emitTransferUpdate(type, payload) {
this.progress.stream.emit(`transfer::${type}`, payload);
}
function emitStageUpdate(type, transferStage) {
this.progress.stream.emit(`stage::${type}`, {
data: this.progress.data,
stage: transferStage
});
}
function assertStrapiVersionIntegrity(sourceVersion, destinationVersion) {
const strategy = this.options.versionStrategy || DEFAULT_VERSION_STRATEGY;
const reject = ()=>{
throw new errors.TransferEngineValidationError(`The source and destination provide are targeting incompatible Strapi versions (using the "${strategy}" strategy). The source (${this.sourceProvider.name}) version is ${sourceVersion} and the destination (${this.destinationProvider.name}) version is ${destinationVersion}`, {
check: 'strapi.version',
strategy,
versions: {
source: sourceVersion,
destination: destinationVersion
}
});
};
if (!sourceVersion || !destinationVersion || strategy === 'ignore' || destinationVersion === sourceVersion) {
return;
}
let diff;
try {
diff = semver.diff(sourceVersion, destinationVersion);
} catch {
reject();
}
if (!diff) {
return;
}
const validPatch = [
'prelease',
'build'
];
const validMinor = [
...validPatch,
'patch',
'prepatch'
];
const validMajor = [
...validMinor,
'minor',
'preminor'
];
if (strategy === 'patch' && validPatch.includes(diff)) {
return;
}
if (strategy === 'minor' && validMinor.includes(diff)) {
return;
}
if (strategy === 'major' && validMajor.includes(diff)) {
return;
}
reject();
}
function assertSchemasMatching(sourceSchemas, destinationSchemas) {
const strategy = this.options.schemaStrategy || DEFAULT_SCHEMA_STRATEGY;
if (strategy === 'ignore') {
return;
}
const keys = fp.uniq(Object.keys(sourceSchemas).concat(Object.keys(destinationSchemas)));
const diffs = {};
keys.forEach((key)=>{
const sourceSchema = sourceSchemas[key];
const destinationSchema = destinationSchemas[key];
const schemaDiffs = index.compareSchemas(sourceSchema, destinationSchema, strategy);
if (schemaDiffs.length) {
diffs[key] = schemaDiffs;
}
});
if (!fp.isEmpty(diffs)) {
const formattedDiffs = Object.entries(diffs).map(([uid, ctDiffs])=>{
let msg = `- ${uid}:${os.EOL}`;
msg += ctDiffs.sort((a, b)=>a.kind > b.kind ? -1 : 1).map((diff)=>{
const path = diff.path.join('.');
if (diff.kind === 'added') {
return `${path} exists in destination schema but not in source schema and the data will not be transferred.`;
}
if (diff.kind === 'deleted') {
return `${path} exists in source schema but not in destination schema and the data will not be transferred.`;
}
if (diff.kind === 'modified') {
if (diff.types[0] === diff.types[1]) {
return `Schema value changed at "${path}": "${diff.values[0]}" (${diff.types[0]}) => "${diff.values[1]}" (${diff.types[1]})`;
}
return `Schema has differing data types at "${path}": "${diff.values[0]}" (${diff.types[0]}) => "${diff.values[1]}" (${diff.types[1]})`;
}
throw new errors.TransferEngineValidationError(`Invalid diff found for "${uid}"`, {
check: `schema on ${uid}`
});
}).map((line)=>` - ${line}`).join(os.EOL);
return msg;
}).join(os.EOL);
throw new errors.TransferEngineValidationError(`Invalid schema changes detected during integrity checks (using the ${strategy} strategy). Please find a summary of the changes below:\n${formattedDiffs}`, {
check: 'schema.changes',
strategy,
diffs
});
}
}
async function transferStage(options) {
if (_class_private_field_loose_base(this, _aborted)[_aborted]) {
throw new errors.TransferEngineError('fatal', 'Transfer aborted.');
}
const { stage, source, destination, transform, tracker } = options;
const updateEndTime = ()=>{
const stageData = this.progress.data[stage];
if (stageData) {
stageData.endTime = Date.now();
}
};
if (!source || !destination || this.shouldSkipStage(stage)) {
// Wait until source and destination are closed
const results = await Promise.allSettled([
source,
destination
].map((stream)=>{
// if stream is undefined or already closed, resolve immediately
if (!stream || stream.destroyed) {
return Promise.resolve();
}
// Wait until the close event is produced and then destroy the stream and resolve
return new Promise((resolve, reject)=>{
stream.on('close', resolve).on('error', reject).destroy();
});
}));
results.forEach((state)=>{
if (state.status === 'rejected') {
this.reportWarning(state.reason, `transfer(${stage})`);
}
});
_class_private_field_loose_base(this, _emitStageUpdate)[_emitStageUpdate]('skip', stage);
return;
}
_class_private_field_loose_base(this, _emitStageUpdate)[_emitStageUpdate]('start', stage);
try {
const streams = [
source
];
if (transform) {
streams.push(transform);
}
if (tracker) {
streams.push(tracker);
}
streams.push(destination);
// NOTE: to debug/confirm backpressure issues from misbehaving stream, uncomment the following lines
// source.on('pause', () => console.log(`[${stage}] Source paused due to backpressure`));
// source.on('resume', () => console.log(`[${stage}] Source resumed`));
// destination.on('drain', () =>
// console.log(`[${stage}] Destination drained, resuming data flow`)
// );
// destination.on('error', (err) => console.error(`[${stage}] Destination error:`, err));
const controller = new AbortController();
const { signal } = controller;
// Store the controller so you can cancel later
_class_private_field_loose_base(this, _currentStreamController)[_currentStreamController] = controller;
await promises.pipeline(streams, {
signal
});
_class_private_field_loose_base(this, _emitStageUpdate)[_emitStageUpdate]('finish', stage);
} catch (e) {
updateEndTime();
_class_private_field_loose_base(this, _emitStageUpdate)[_emitStageUpdate]('error', stage);
this.reportError(e, 'error');
if (!destination.destroyed) {
destination.destroy(e);
}
} finally{
updateEndTime();
}
}
async function resolveProviderResource() {
const sourceMetadata = await this.sourceProvider.getMetadata();
const destinationMetadata = await this.destinationProvider.getMetadata();
if (sourceMetadata) {
_class_private_field_loose_base(this, _metadata)[_metadata].source = sourceMetadata;
}
if (destinationMetadata) {
_class_private_field_loose_base(this, _metadata)[_metadata].destination = destinationMetadata;
}
}
async function getSchemas() {
if (!_class_private_field_loose_base(this, _schema)[_schema].source) {
_class_private_field_loose_base(this, _schema)[_schema].source = await this.sourceProvider.getSchemas?.();
}
if (!_class_private_field_loose_base(this, _schema)[_schema].destination) {
_class_private_field_loose_base(this, _schema)[_schema].destination = await this.destinationProvider.getSchemas?.();
}
return {
sourceSchemas: _class_private_field_loose_base(this, _schema)[_schema].source,
destinationSchemas: _class_private_field_loose_base(this, _schema)[_schema].destination
};
}
const createTransferEngine = (sourceProvider, destinationProvider, options)=>{
return new TransferEngine(sourceProvider, destinationProvider, options);
};
exports.errors = errors;
exports.DEFAULT_SCHEMA_STRATEGY = DEFAULT_SCHEMA_STRATEGY;
exports.DEFAULT_VERSION_STRATEGY = DEFAULT_VERSION_STRATEGY;
exports.TRANSFER_STAGES = TRANSFER_STAGES;
exports.TransferGroupPresets = TransferGroupPresets;
exports.createTransferEngine = createTransferEngine;
//# sourceMappingURL=index.js.map
+1
View File
@@ -0,0 +1 @@
{"version":3,"file":"index.js","sources":["../../src/engine/index.ts"],"sourcesContent":["import { PassThrough, Transform, Readable, Writable } from 'stream';\nimport { pipeline } from 'stream/promises';\nimport { extname } from 'path';\nimport { EOL } from 'os';\nimport type Chain from 'stream-chain';\nimport { chain } from 'stream-chain';\nimport { isEmpty, uniq, last, isNumber, set, pick } from 'lodash/fp';\nimport { diff as semverDiff } from 'semver';\n\nimport type { Struct, Utils } from '@strapi/types';\n\nimport type {\n IAsset,\n IDestinationProvider,\n IEntity,\n ILink,\n IMetadata,\n ISourceProvider,\n ITransferEngine,\n ITransferEngineOptions,\n TransferProgress,\n ITransferResults,\n TransferStage,\n TransferTransform,\n IProvider,\n TransferFilters,\n TransferFilterPreset,\n StreamItem,\n SchemaDiffHandler,\n SchemaDiffHandlerContext,\n ErrorHandler,\n ErrorHandlerContext,\n ErrorHandlers,\n ErrorCode,\n} from '../../types';\nimport type { Diff } from '../utils/json';\n\nimport { compareSchemas, validateProvider } from './validation';\n\nimport { TransferEngineError, TransferEngineValidationError } from './errors';\nimport {\n createDiagnosticReporter,\n IDiagnosticReporter,\n ErrorDiagnosticSeverity,\n} from '../utils/diagnostic';\nimport { DataTransferError } from '../errors';\nimport * as utils from '../utils';\nimport { ProviderTransferError } from '../errors/providers';\n\nexport const TRANSFER_STAGES: ReadonlyArray<TransferStage> = Object.freeze([\n 'entities',\n 'links',\n 'assets',\n 'schemas',\n 'configuration',\n]);\n\nexport type TransferGroupFilter = Record<TransferFilterPreset, TransferFilters>;\n\n/**\n * Preset filters for only/exclude options\n * */\nexport const TransferGroupPresets: TransferGroupFilter = {\n content: {\n links: true, // Example: content includes the entire links stage\n entities: true,\n // TODO: If we need to implement filtering on a running stage, it would be done like this, but we still need to implement it\n // [\n // // Example: content processes the entities stage, but filters individual entities\n // {\n // filter(data) {\n // return shouldIncludeThisData(data);\n // },\n // },\n // ],\n },\n files: {\n assets: true,\n },\n config: {\n configuration: true,\n },\n};\n\nexport const DEFAULT_VERSION_STRATEGY = 'ignore';\nexport const DEFAULT_SCHEMA_STRATEGY = 'strict';\n\ntype SchemaMap = Utils.String.Dict<Struct.Schema>;\n\nclass TransferEngine<\n S extends ISourceProvider = ISourceProvider,\n D extends IDestinationProvider = IDestinationProvider,\n> implements ITransferEngine\n{\n sourceProvider: ISourceProvider;\n\n destinationProvider: IDestinationProvider;\n\n options: ITransferEngineOptions;\n\n #metadata: { source?: IMetadata; destination?: IMetadata } = {};\n\n #schema: { source?: SchemaMap; destination?: SchemaMap } = {};\n\n // Progress of the current stage\n progress: {\n // metrics on the progress such as size and record count\n data: TransferProgress;\n // stream that emits events\n stream: PassThrough;\n };\n\n diagnostics: IDiagnosticReporter;\n\n #handlers: {\n schemaDiff: SchemaDiffHandler[];\n errors: Partial<ErrorHandlers>;\n } = {\n schemaDiff: [],\n errors: {},\n };\n\n #currentStreamController?: AbortController;\n\n #aborted: boolean = false;\n\n onSchemaDiff(handler: SchemaDiffHandler) {\n this.#handlers?.schemaDiff?.push(handler);\n }\n\n addErrorHandler(handlerName: ErrorCode, handler: ErrorHandler) {\n if (!this.#handlers.errors[handlerName]) {\n this.#handlers.errors[handlerName] = [];\n }\n this.#handlers.errors[handlerName]?.push(handler);\n }\n\n async attemptResolveError(error: Error) {\n const context: ErrorHandlerContext = {};\n if (error instanceof ProviderTransferError && error.details?.details.code) {\n const errorCode = error.details?.details.code as ErrorCode;\n if (!this.#handlers.errors[errorCode]) {\n this.#handlers.errors[errorCode] = [];\n }\n await utils.middleware.runMiddleware(context ?? {}, this.#handlers.errors[errorCode] ?? []);\n }\n\n return !!context.ignore;\n }\n\n constructor(sourceProvider: S, destinationProvider: D, options: ITransferEngineOptions) {\n this.diagnostics = createDiagnosticReporter();\n\n validateProvider('source', sourceProvider);\n validateProvider('destination', destinationProvider);\n\n this.sourceProvider = sourceProvider;\n this.destinationProvider = destinationProvider;\n this.options = options;\n\n this.progress = { data: {}, stream: new PassThrough({ objectMode: true }) };\n }\n\n /**\n * Report a fatal error and throw it\n */\n panic(error: Error) {\n this.reportError(error, 'fatal');\n\n throw error;\n }\n\n /**\n * Report an error diagnostic\n */\n reportError(error: Error, severity: ErrorDiagnosticSeverity) {\n this.diagnostics.report({Line truncated
+792
View File
@@ -0,0 +1,792 @@
import { Transform, PassThrough } from 'stream';
import { pipeline } from 'stream/promises';
import { extname } from 'path';
import { EOL } from 'os';
import { chain } from 'stream-chain';
import { isEmpty, last, set, pick, isNumber, uniq } from 'lodash/fp';
import { diff as diff$1 } from 'semver';
import { compareSchemas } from './validation/schemas/index.mjs';
import { validateProvider } from './validation/provider.mjs';
import { TransferEngineError, TransferEngineValidationError } from './errors.mjs';
import * as errors from './errors.mjs';
export { errors };
import { createDiagnosticReporter } from '../utils/diagnostic.mjs';
import 'crypto';
import { filter, map } from '../utils/stream.mjs';
import { diff } from '../utils/json.mjs';
import 'events';
import { runMiddleware } from '../utils/middleware.mjs';
import { ProviderTransferError } from '../errors/providers.mjs';
function _class_private_field_loose_base(receiver, privateKey) {
if (!Object.prototype.hasOwnProperty.call(receiver, privateKey)) {
throw new TypeError("attempted to use private field on non-instance");
}
return receiver;
}
var id = 0;
function _class_private_field_loose_key(name) {
return "__private_" + id++ + "_" + name;
}
const TRANSFER_STAGES = Object.freeze([
'entities',
'links',
'assets',
'schemas',
'configuration'
]);
/**
* Preset filters for only/exclude options
* */ const TransferGroupPresets = {
content: {
links: true,
entities: true
},
files: {
assets: true
},
config: {
configuration: true
}
};
const DEFAULT_VERSION_STRATEGY = 'ignore';
const DEFAULT_SCHEMA_STRATEGY = 'strict';
var _metadata = /*#__PURE__*/ _class_private_field_loose_key("_metadata"), _schema = /*#__PURE__*/ _class_private_field_loose_key("_schema"), _handlers = /*#__PURE__*/ _class_private_field_loose_key("_handlers"), _currentStreamController = /*#__PURE__*/ _class_private_field_loose_key("_currentStreamController"), _aborted = /*#__PURE__*/ _class_private_field_loose_key("_aborted"), /**
* Create and return a transform stream based on the given stage and options.
*
* Allowed transformations includes 'filter' and 'map'.
*/ _createStageTransformStream = /*#__PURE__*/ _class_private_field_loose_key("_createStageTransformStream"), /**
* Update the Engine's transfer progress data for a given stage.
*
* Providing aggregate options enable custom computation to get the size (bytes) or the aggregate key associated with the data
*/ _updateTransferProgress = /*#__PURE__*/ _class_private_field_loose_key("_updateTransferProgress"), /**
* Create and return a PassThrough stream.
*
* Upon writing data into it, it'll update the Engine's transfer progress data and trigger stage update events.
*/ _progressTracker = /*#__PURE__*/ _class_private_field_loose_key("_progressTracker"), /**
* Shorthand method used to trigger transfer update events to every listeners
*/ _emitTransferUpdate = /*#__PURE__*/ _class_private_field_loose_key("_emitTransferUpdate"), /**
* Shorthand method used to trigger stage update events to every listeners
*/ _emitStageUpdate = /*#__PURE__*/ _class_private_field_loose_key("_emitStageUpdate"), /**
* Run a version check between two strapi version (source and destination) using the strategy given to the engine during initialization.
*
* If there is a mismatch, throws a validation error.
*/ _assertStrapiVersionIntegrity = /*#__PURE__*/ _class_private_field_loose_key("_assertStrapiVersionIntegrity"), /**
* Run a check between two set of schemas (source and destination) using the strategy given to the engine during initialization.
*
* If there are differences and/or incompatibilities between source and destination schemas, then throw a validation error.
*/ _assertSchemasMatching = /*#__PURE__*/ _class_private_field_loose_key("_assertSchemasMatching"), _transferStage = /*#__PURE__*/ _class_private_field_loose_key("_transferStage"), _resolveProviderResource = /*#__PURE__*/ _class_private_field_loose_key("_resolveProviderResource"), _getSchemas = /*#__PURE__*/ _class_private_field_loose_key("_getSchemas");
class TransferEngine {
onSchemaDiff(handler) {
_class_private_field_loose_base(this, _handlers)[_handlers]?.schemaDiff?.push(handler);
}
addErrorHandler(handlerName, handler) {
if (!_class_private_field_loose_base(this, _handlers)[_handlers].errors[handlerName]) {
_class_private_field_loose_base(this, _handlers)[_handlers].errors[handlerName] = [];
}
_class_private_field_loose_base(this, _handlers)[_handlers].errors[handlerName]?.push(handler);
}
async attemptResolveError(error) {
const context = {};
if (error instanceof ProviderTransferError && error.details?.details.code) {
const errorCode = error.details?.details.code;
if (!_class_private_field_loose_base(this, _handlers)[_handlers].errors[errorCode]) {
_class_private_field_loose_base(this, _handlers)[_handlers].errors[errorCode] = [];
}
await runMiddleware(context ?? {}, _class_private_field_loose_base(this, _handlers)[_handlers].errors[errorCode] ?? []);
}
return !!context.ignore;
}
/**
* Report a fatal error and throw it
*/ panic(error) {
this.reportError(error, 'fatal');
throw error;
}
/**
* Report an error diagnostic
*/ reportError(error, severity) {
this.diagnostics.report({
kind: 'error',
details: {
severity,
createdAt: new Date(),
name: error.name,
message: error.message,
error
}
});
}
/**
* Report a warning diagnostic
*/ reportWarning(message, origin1) {
this.diagnostics.report({
kind: 'warning',
details: {
createdAt: new Date(),
message,
origin: origin1
}
});
}
/**
* Report an info diagnostic
*/ reportInfo(message, params) {
this.diagnostics.report({
kind: 'info',
details: {
createdAt: new Date(),
message,
params,
origin: 'engine'
}
});
}
shouldSkipStage(stage) {
const { exclude, only } = this.options;
// schemas must always be included
if (stage === 'schemas') {
return false;
}
// everything is included by default unless 'only' has been set
let included = isEmpty(only);
if (only && only.length > 0) {
included = only.some((transferGroup)=>{
return TransferGroupPresets[transferGroup][stage];
});
}
if (exclude && exclude.length > 0) {
if (included) {
included = !exclude.some((transferGroup)=>{
return TransferGroupPresets[transferGroup][stage];
});
}
}
return !included;
}
// Cause an ongoing transfer to abort gracefully
async abortTransfer() {
_class_private_field_loose_base(this, _aborted)[_aborted] = true;
_class_private_field_loose_base(this, _currentStreamController)[_currentStreamController]?.abort();
throw new TransferEngineError('fatal', 'Transfer aborted.');
}
async init() {
// Resolve providers' resource and store
// them in the engine's internal state
await _class_private_field_loose_base(this, _resolveProviderResource)[_resolveProviderResource]();
// Update the destination provider's source metadata
const { source: sourceMetadata } = _class_private_field_loose_base(this, _metadata)[_metadata];
if (sourceMetadata) {
this.destinationProvider.setMetadata?.('source', sourceMetadata);
}
}
/**
* Run the bootstrap method in both source and destination providers
*/ async bootstrap() {
const results = await Promise.allSettled([
this.sourceProvider.bootstrap?.(this.diagnostics),
this.destinationProvider.bootstrap?.(this.diagnostics)
]);
results.forEach((result)=>{
if (result.status === 'rejected') {
this.panic(result.reason);
}
});
}
/**
* Run the close method in both source and destination providers
*/ async close() {
const results = await Promise.allSettled([
this.sourceProvider.close?.(),
this.destinationProvider.close?.()
]);
results.forEach((result)=>{
if (result.status === 'rejected') {
this.panic(result.reason);
}
});
}
async integrityCheck() {
const sourceMetadata = await this.sourceProvider.getMetadata();
const destinationMetadata = await this.destinationProvider.getMetadata();
if (sourceMetadata && destinationMetadata) {
_class_private_field_loose_base(this, _assertStrapiVersionIntegrity)[_assertStrapiVersionIntegrity](sourceMetadata?.strapi?.version, destinationMetadata?.strapi?.version);
}
const { sourceSchemas, destinationSchemas } = await _class_private_field_loose_base(this, _getSchemas)[_getSchemas]();
try {
if (sourceSchemas && destinationSchemas) {
_class_private_field_loose_base(this, _assertSchemasMatching)[_assertSchemasMatching](sourceSchemas, destinationSchemas);
}
} catch (error) {
// if this is a schema matching error, allow handlers to resolve it
if (error instanceof TransferEngineValidationError && error.details?.details?.diffs) {
const schemaDiffs = error.details?.details?.diffs;
const context = {
ignoredDiffs: {},
diffs: schemaDiffs,
source: this.sourceProvider,
destination: this.destinationProvider
};
// if we don't have any handlers, throw the original error
if (isEmpty(_class_private_field_loose_base(this, _handlers)[_handlers].schemaDiff)) {
throw error;
}
await runMiddleware(context, _class_private_field_loose_base(this, _handlers)[_handlers].schemaDiff);
// if there are any remaining diffs that weren't ignored
const unresolvedDiffs = diff(context.diffs, context.ignoredDiffs);
if (unresolvedDiffs.length) {
this.panic(new TransferEngineValidationError('Unresolved differences in schema', {
check: 'schema.changes',
unresolvedDiffs
}));
}
return;
}
throw error;
}
}
async transfer() {
// reset data between transfers
this.progress.data = {};
try {
_class_private_field_loose_base(this, _emitTransferUpdate)[_emitTransferUpdate]('init');
await this.bootstrap();
await this.init();
await this.integrityCheck();
_class_private_field_loose_base(this, _emitTransferUpdate)[_emitTransferUpdate]('start');
await this.beforeTransfer();
// Run the transfer stages
await this.transferSchemas();
await this.transferEntities();
await this.transferAssets();
await this.transferLinks();
await this.transferConfiguration();
// Gracefully close the providers
await this.close();
_class_private_field_loose_base(this, _emitTransferUpdate)[_emitTransferUpdate]('finish');
} catch (e) {
_class_private_field_loose_base(this, _emitTransferUpdate)[_emitTransferUpdate]('error', {
error: e
});
const lastDiagnostic = last(this.diagnostics.stack.items);
// Do not report an error diagnostic if the last one reported the same error
if (e instanceof Error && (!lastDiagnostic || lastDiagnostic.kind !== 'error' || lastDiagnostic.details.error !== e)) {
this.reportError(e, e.severity || 'fatal');
}
// Rollback the destination provider if an exception is thrown during the transfer
// Note: This will be configurable in the future
await this.destinationProvider.rollback?.(e);
throw e;
}
return {
source: this.sourceProvider.results,
destination: this.destinationProvider.results,
engine: this.progress.data
};
}
async beforeTransfer() {
const runWithDiagnostic = async (provider)=>{
try {
await provider.beforeTransfer?.();
} catch (error) {
if (error instanceof Error) {
const resolved = await this.attemptResolveError(error);
if (resolved) {
return;
}
this.panic(error);
} else {
this.panic(new Error(`Unknwon error when executing "beforeTransfer" on the ${origin} provider`));
}
}
};
await runWithDiagnostic(this.sourceProvider);
await runWithDiagnostic(this.destinationProvider);
}
async transferSchemas() {
const stage = 'schemas';
if (this.shouldSkipStage(stage)) {
return;
}
const source = await this.sourceProvider.createSchemasReadStream?.();
const destination = await this.destinationProvider.createSchemasWriteStream?.();
const transform = _class_private_field_loose_base(this, _createStageTransformStream)[_createStageTransformStream](stage);
const tracker = _class_private_field_loose_base(this, _progressTracker)[_progressTracker](stage, {
key: (value)=>value.modelType
});
await _class_private_field_loose_base(this, _transferStage)[_transferStage]({
stage,
source,
destination,
transform,
tracker
});
}
async transferEntities() {
const stage = 'entities';
if (this.shouldSkipStage(stage)) {
return;
}
const source = await this.sourceProvider.createEntitiesReadStream?.();
const destination = await this.destinationProvider.createEntitiesWriteStream?.();
const transform = chain([
_class_private_field_loose_base(this, _createStageTransformStream)[_createStageTransformStream](stage),
new Transform({
objectMode: true,
transform: async (entity, _encoding, callback)=>{
const { destinationSchemas: schemas } = await _class_private_field_loose_base(this, _getSchemas)[_getSchemas]();
if (!schemas) {
return callback(null, entity);
}
// TODO: this would be safer if we only ignored things in ignoredDiffs, otherwise continue and let an error be thrown
const availableContentTypes = Object.entries(schemas).filter(([, schema])=>schema.modelType === 'contentType').map(([uid])=>uid);
// If the type of the transferred entity doesn't exist in the destination, then discard it
if (!availableContentTypes.includes(entity.type)) {
return callback(null, undefined);
}
const { type, data } = entity;
const attributes = schemas[type].attributes;
const attributesToKeep = Object.keys(attributes).concat('documentId');
const updatedEntity = set('data', pick(attributesToKeep, data), entity);
callback(null, updatedEntity);
}
})
]);
const tracker = _class_private_field_loose_base(this, _progressTracker)[_progressTracker](stage, {
key: (value)=>value.type
});
await _class_private_field_loose_base(this, _transferStage)[_transferStage]({
stage,
source,
destination,
transform,
tracker
});
}
async transferLinks() {
const stage = 'links';
if (this.shouldSkipStage(stage)) {
return;
}
const source = await this.sourceProvider.createLinksReadStream?.();
const destination = await this.destinationProvider.createLinksWriteStream?.();
const transform = chain([
_class_private_field_loose_base(this, _createStageTransformStream)[_createStageTransformStream](stage),
new Transform({
objectMode: true,
transform: async (link, _encoding, callback)=>{
const { destinationSchemas: schemas } = await _class_private_field_loose_base(this, _getSchemas)[_getSchemas]();
if (!schemas) {
return callback(null, link);
}
// TODO: this would be safer if we only ignored things in ignoredDiffs, otherwise continue and let an error be thrown
const availableContentTypes = Object.keys(schemas);
const isValidType = (uid)=>availableContentTypes.includes(uid);
if (!isValidType(link.left.type) || !isValidType(link.right.type)) {
return callback(null, undefined); // ignore the link
}
callback(null, link);
}
})
]);
const tracker = _class_private_field_loose_base(this, _progressTracker)[_progressTracker](stage);
await _class_private_field_loose_base(this, _transferStage)[_transferStage]({
stage,
source,
destination,
transform,
tracker
});
}
async transferAssets() {
const stage = 'assets';
if (this.shouldSkipStage(stage)) {
return;
}
const source = await this.sourceProvider.createAssetsReadStream?.();
const destination = await this.destinationProvider.createAssetsWriteStream?.();
const transform = _class_private_field_loose_base(this, _createStageTransformStream)[_createStageTransformStream](stage);
const tracker = _class_private_field_loose_base(this, _progressTracker)[_progressTracker](stage, {
size: (value)=>value.stats.size,
key: (value)=>extname(value.filename) || 'No extension'
});
await _class_private_field_loose_base(this, _transferStage)[_transferStage]({
stage,
source,
destination,
transform,
tracker
});
}
async transferConfiguration() {
const stage = 'configuration';
if (this.shouldSkipStage(stage)) {
return;
}
const source = await this.sourceProvider.createConfigurationReadStream?.();
const destination = await this.destinationProvider.createConfigurationWriteStream?.();
const transform = _class_private_field_loose_base(this, _createStageTransformStream)[_createStageTransformStream](stage);
const tracker = _class_private_field_loose_base(this, _progressTracker)[_progressTracker](stage);
await _class_private_field_loose_base(this, _transferStage)[_transferStage]({
stage,
source,
destination,
transform,
tracker
});
}
constructor(sourceProvider, destinationProvider, options){
Object.defineProperty(this, _createStageTransformStream, {
value: createStageTransformStream
});
Object.defineProperty(this, _updateTransferProgress, {
value: updateTransferProgress
});
Object.defineProperty(this, _progressTracker, {
value: progressTracker
});
Object.defineProperty(this, _emitTransferUpdate, {
value: emitTransferUpdate
});
Object.defineProperty(this, _emitStageUpdate, {
value: emitStageUpdate
});
Object.defineProperty(this, _assertStrapiVersionIntegrity, {
value: assertStrapiVersionIntegrity
});
Object.defineProperty(this, _assertSchemasMatching, {
value: assertSchemasMatching
});
Object.defineProperty(this, _transferStage, {
value: transferStage
});
Object.defineProperty(this, _resolveProviderResource, {
value: resolveProviderResource
});
Object.defineProperty(this, _getSchemas, {
value: getSchemas
});
Object.defineProperty(this, _metadata, {
writable: true,
value: void 0
});
Object.defineProperty(this, _schema, {
writable: true,
value: void 0
});
Object.defineProperty(this, _handlers, {
writable: true,
value: void 0
});
Object.defineProperty(this, _currentStreamController, {
writable: true,
value: void 0
});
Object.defineProperty(this, _aborted, {
writable: true,
value: void 0
});
_class_private_field_loose_base(this, _metadata)[_metadata] = {};
_class_private_field_loose_base(this, _schema)[_schema] = {};
_class_private_field_loose_base(this, _handlers)[_handlers] = {
schemaDiff: [],
errors: {}
};
_class_private_field_loose_base(this, _aborted)[_aborted] = false;
this.diagnostics = createDiagnosticReporter();
validateProvider('source', sourceProvider);
validateProvider('destination', destinationProvider);
this.sourceProvider = sourceProvider;
this.destinationProvider = destinationProvider;
this.options = options;
this.progress = {
data: {},
stream: new PassThrough({
objectMode: true
})
};
}
}
function createStageTransformStream(key, options = {}) {
const { includeGlobal = true } = options;
const { throttle } = this.options;
const { global: globalTransforms, [key]: stageTransforms } = this.options?.transforms ?? {};
let stream = new PassThrough({
objectMode: true
});
const applyTransforms = (transforms = [])=>{
const chainTransforms = [];
for (const transform of transforms){
if ('filter' in transform) {
chainTransforms.push(filter(transform.filter));
}
if ('map' in transform) {
chainTransforms.push(map(transform.map));
}
}
if (chainTransforms.length) {
stream = stream.pipe(chain(chainTransforms));
}
};
if (includeGlobal) {
applyTransforms(globalTransforms);
}
if (isNumber(throttle) && throttle > 0) {
stream = stream.pipe(new PassThrough({
objectMode: true,
async transform (data, _encoding, callback) {
await new Promise((resolve)=>{
setTimeout(resolve, throttle);
});
callback(null, data);
}
}));
}
applyTransforms(stageTransforms);
return stream;
}
function updateTransferProgress(stage, data, aggregate) {
if (!this.progress.data[stage]) {
this.progress.data[stage] = {
count: 0,
bytes: 0,
startTime: Date.now()
};
}
const stageProgress = this.progress.data[stage];
if (!stageProgress) {
return;
}
const size = aggregate?.size?.(data) ?? JSON.stringify(data).length;
const key = aggregate?.key?.(data);
stageProgress.count += 1;
stageProgress.bytes += size;
// Handle aggregate updates if necessary
if (key) {
if (!stageProgress.aggregates) {
stageProgress.aggregates = {};
}
const { aggregates } = stageProgress;
if (!aggregates[key]) {
aggregates[key] = {
count: 0,
bytes: 0
};
}
aggregates[key].count += 1;
aggregates[key].bytes += size;
}
}
function progressTracker(stage, aggregate) {
return new PassThrough({
objectMode: true,
transform: (data, _encoding, callback)=>{
_class_private_field_loose_base(this, _updateTransferProgress)[_updateTransferProgress](stage, data, aggregate);
_class_private_field_loose_base(this, _emitStageUpdate)[_emitStageUpdate]('progress', stage);
callback(null, data);
}
});
}
function emitTransferUpdate(type, payload) {
this.progress.stream.emit(`transfer::${type}`, payload);
}
function emitStageUpdate(type, transferStage) {
this.progress.stream.emit(`stage::${type}`, {
data: this.progress.data,
stage: transferStage
});
}
function assertStrapiVersionIntegrity(sourceVersion, destinationVersion) {
const strategy = this.options.versionStrategy || DEFAULT_VERSION_STRATEGY;
const reject = ()=>{
throw new TransferEngineValidationError(`The source and destination provide are targeting incompatible Strapi versions (using the "${strategy}" strategy). The source (${this.sourceProvider.name}) version is ${sourceVersion} and the destination (${this.destinationProvider.name}) version is ${destinationVersion}`, {
check: 'strapi.version',
strategy,
versions: {
source: sourceVersion,
destination: destinationVersion
}
});
};
if (!sourceVersion || !destinationVersion || strategy === 'ignore' || destinationVersion === sourceVersion) {
return;
}
let diff;
try {
diff = diff$1(sourceVersion, destinationVersion);
} catch {
reject();
}
if (!diff) {
return;
}
const validPatch = [
'prelease',
'build'
];
const validMinor = [
...validPatch,
'patch',
'prepatch'
];
const validMajor = [
...validMinor,
'minor',
'preminor'
];
if (strategy === 'patch' && validPatch.includes(diff)) {
return;
}
if (strategy === 'minor' && validMinor.includes(diff)) {
return;
}
if (strategy === 'major' && validMajor.includes(diff)) {
return;
}
reject();
}
function assertSchemasMatching(sourceSchemas, destinationSchemas) {
const strategy = this.options.schemaStrategy || DEFAULT_SCHEMA_STRATEGY;
if (strategy === 'ignore') {
return;
}
const keys = uniq(Object.keys(sourceSchemas).concat(Object.keys(destinationSchemas)));
const diffs = {};
keys.forEach((key)=>{
const sourceSchema = sourceSchemas[key];
const destinationSchema = destinationSchemas[key];
const schemaDiffs = compareSchemas(sourceSchema, destinationSchema, strategy);
if (schemaDiffs.length) {
diffs[key] = schemaDiffs;
}
});
if (!isEmpty(diffs)) {
const formattedDiffs = Object.entries(diffs).map(([uid, ctDiffs])=>{
let msg = `- ${uid}:${EOL}`;
msg += ctDiffs.sort((a, b)=>a.kind > b.kind ? -1 : 1).map((diff)=>{
const path = diff.path.join('.');
if (diff.kind === 'added') {
return `${path} exists in destination schema but not in source schema and the data will not be transferred.`;
}
if (diff.kind === 'deleted') {
return `${path} exists in source schema but not in destination schema and the data will not be transferred.`;
}
if (diff.kind === 'modified') {
if (diff.types[0] === diff.types[1]) {
return `Schema value changed at "${path}": "${diff.values[0]}" (${diff.types[0]}) => "${diff.values[1]}" (${diff.types[1]})`;
}
return `Schema has differing data types at "${path}": "${diff.values[0]}" (${diff.types[0]}) => "${diff.values[1]}" (${diff.types[1]})`;
}
throw new TransferEngineValidationError(`Invalid diff found for "${uid}"`, {
check: `schema on ${uid}`
});
}).map((line)=>` - ${line}`).join(EOL);
return msg;
}).join(EOL);
throw new TransferEngineValidationError(`Invalid schema changes detected during integrity checks (using the ${strategy} strategy). Please find a summary of the changes below:\n${formattedDiffs}`, {
check: 'schema.changes',
strategy,
diffs
});
}
}
async function transferStage(options) {
if (_class_private_field_loose_base(this, _aborted)[_aborted]) {
throw new TransferEngineError('fatal', 'Transfer aborted.');
}
const { stage, source, destination, transform, tracker } = options;
const updateEndTime = ()=>{
const stageData = this.progress.data[stage];
if (stageData) {
stageData.endTime = Date.now();
}
};
if (!source || !destination || this.shouldSkipStage(stage)) {
// Wait until source and destination are closed
const results = await Promise.allSettled([
source,
destination
].map((stream)=>{
// if stream is undefined or already closed, resolve immediately
if (!stream || stream.destroyed) {
return Promise.resolve();
}
// Wait until the close event is produced and then destroy the stream and resolve
return new Promise((resolve, reject)=>{
stream.on('close', resolve).on('error', reject).destroy();
});
}));
results.forEach((state)=>{
if (state.status === 'rejected') {
this.reportWarning(state.reason, `transfer(${stage})`);
}
});
_class_private_field_loose_base(this, _emitStageUpdate)[_emitStageUpdate]('skip', stage);
return;
}
_class_private_field_loose_base(this, _emitStageUpdate)[_emitStageUpdate]('start', stage);
try {
const streams = [
source
];
if (transform) {
streams.push(transform);
}
if (tracker) {
streams.push(tracker);
}
streams.push(destination);
// NOTE: to debug/confirm backpressure issues from misbehaving stream, uncomment the following lines
// source.on('pause', () => console.log(`[${stage}] Source paused due to backpressure`));
// source.on('resume', () => console.log(`[${stage}] Source resumed`));
// destination.on('drain', () =>
// console.log(`[${stage}] Destination drained, resuming data flow`)
// );
// destination.on('error', (err) => console.error(`[${stage}] Destination error:`, err));
const controller = new AbortController();
const { signal } = controller;
// Store the controller so you can cancel later
_class_private_field_loose_base(this, _currentStreamController)[_currentStreamController] = controller;
await pipeline(streams, {
signal
});
_class_private_field_loose_base(this, _emitStageUpdate)[_emitStageUpdate]('finish', stage);
} catch (e) {
updateEndTime();
_class_private_field_loose_base(this, _emitStageUpdate)[_emitStageUpdate]('error', stage);
this.reportError(e, 'error');
if (!destination.destroyed) {
destination.destroy(e);
}
} finally{
updateEndTime();
}
}
async function resolveProviderResource() {
const sourceMetadata = await this.sourceProvider.getMetadata();
const destinationMetadata = await this.destinationProvider.getMetadata();
if (sourceMetadata) {
_class_private_field_loose_base(this, _metadata)[_metadata].source = sourceMetadata;
}
if (destinationMetadata) {
_class_private_field_loose_base(this, _metadata)[_metadata].destination = destinationMetadata;
}
}
async function getSchemas() {
if (!_class_private_field_loose_base(this, _schema)[_schema].source) {
_class_private_field_loose_base(this, _schema)[_schema].source = await this.sourceProvider.getSchemas?.();
}
if (!_class_private_field_loose_base(this, _schema)[_schema].destination) {
_class_private_field_loose_base(this, _schema)[_schema].destination = await this.destinationProvider.getSchemas?.();
}
return {
sourceSchemas: _class_private_field_loose_base(this, _schema)[_schema].source,
destinationSchemas: _class_private_field_loose_base(this, _schema)[_schema].destination
};
}
const createTransferEngine = (sourceProvider, destinationProvider, options)=>{
return new TransferEngine(sourceProvider, destinationProvider, options);
};
export { DEFAULT_SCHEMA_STRATEGY, DEFAULT_VERSION_STRATEGY, TRANSFER_STAGES, TransferGroupPresets, createTransferEngine };
//# sourceMappingURL=index.mjs.map
+1
View File
@@ -0,0 +1 @@
{"version":3,"file":"index.mjs","sources":["../../src/engine/index.ts"],"sourcesContent":["import { PassThrough, Transform, Readable, Writable } from 'stream';\nimport { pipeline } from 'stream/promises';\nimport { extname } from 'path';\nimport { EOL } from 'os';\nimport type Chain from 'stream-chain';\nimport { chain } from 'stream-chain';\nimport { isEmpty, uniq, last, isNumber, set, pick } from 'lodash/fp';\nimport { diff as semverDiff } from 'semver';\n\nimport type { Struct, Utils } from '@strapi/types';\n\nimport type {\n IAsset,\n IDestinationProvider,\n IEntity,\n ILink,\n IMetadata,\n ISourceProvider,\n ITransferEngine,\n ITransferEngineOptions,\n TransferProgress,\n ITransferResults,\n TransferStage,\n TransferTransform,\n IProvider,\n TransferFilters,\n TransferFilterPreset,\n StreamItem,\n SchemaDiffHandler,\n SchemaDiffHandlerContext,\n ErrorHandler,\n ErrorHandlerContext,\n ErrorHandlers,\n ErrorCode,\n} from '../../types';\nimport type { Diff } from '../utils/json';\n\nimport { compareSchemas, validateProvider } from './validation';\n\nimport { TransferEngineError, TransferEngineValidationError } from './errors';\nimport {\n createDiagnosticReporter,\n IDiagnosticReporter,\n ErrorDiagnosticSeverity,\n} from '../utils/diagnostic';\nimport { DataTransferError } from '../errors';\nimport * as utils from '../utils';\nimport { ProviderTransferError } from '../errors/providers';\n\nexport const TRANSFER_STAGES: ReadonlyArray<TransferStage> = Object.freeze([\n 'entities',\n 'links',\n 'assets',\n 'schemas',\n 'configuration',\n]);\n\nexport type TransferGroupFilter = Record<TransferFilterPreset, TransferFilters>;\n\n/**\n * Preset filters for only/exclude options\n * */\nexport const TransferGroupPresets: TransferGroupFilter = {\n content: {\n links: true, // Example: content includes the entire links stage\n entities: true,\n // TODO: If we need to implement filtering on a running stage, it would be done like this, but we still need to implement it\n // [\n // // Example: content processes the entities stage, but filters individual entities\n // {\n // filter(data) {\n // return shouldIncludeThisData(data);\n // },\n // },\n // ],\n },\n files: {\n assets: true,\n },\n config: {\n configuration: true,\n },\n};\n\nexport const DEFAULT_VERSION_STRATEGY = 'ignore';\nexport const DEFAULT_SCHEMA_STRATEGY = 'strict';\n\ntype SchemaMap = Utils.String.Dict<Struct.Schema>;\n\nclass TransferEngine<\n S extends ISourceProvider = ISourceProvider,\n D extends IDestinationProvider = IDestinationProvider,\n> implements ITransferEngine\n{\n sourceProvider: ISourceProvider;\n\n destinationProvider: IDestinationProvider;\n\n options: ITransferEngineOptions;\n\n #metadata: { source?: IMetadata; destination?: IMetadata } = {};\n\n #schema: { source?: SchemaMap; destination?: SchemaMap } = {};\n\n // Progress of the current stage\n progress: {\n // metrics on the progress such as size and record count\n data: TransferProgress;\n // stream that emits events\n stream: PassThrough;\n };\n\n diagnostics: IDiagnosticReporter;\n\n #handlers: {\n schemaDiff: SchemaDiffHandler[];\n errors: Partial<ErrorHandlers>;\n } = {\n schemaDiff: [],\n errors: {},\n };\n\n #currentStreamController?: AbortController;\n\n #aborted: boolean = false;\n\n onSchemaDiff(handler: SchemaDiffHandler) {\n this.#handlers?.schemaDiff?.push(handler);\n }\n\n addErrorHandler(handlerName: ErrorCode, handler: ErrorHandler) {\n if (!this.#handlers.errors[handlerName]) {\n this.#handlers.errors[handlerName] = [];\n }\n this.#handlers.errors[handlerName]?.push(handler);\n }\n\n async attemptResolveError(error: Error) {\n const context: ErrorHandlerContext = {};\n if (error instanceof ProviderTransferError && error.details?.details.code) {\n const errorCode = error.details?.details.code as ErrorCode;\n if (!this.#handlers.errors[errorCode]) {\n this.#handlers.errors[errorCode] = [];\n }\n await utils.middleware.runMiddleware(context ?? {}, this.#handlers.errors[errorCode] ?? []);\n }\n\n return !!context.ignore;\n }\n\n constructor(sourceProvider: S, destinationProvider: D, options: ITransferEngineOptions) {\n this.diagnostics = createDiagnosticReporter();\n\n validateProvider('source', sourceProvider);\n validateProvider('destination', destinationProvider);\n\n this.sourceProvider = sourceProvider;\n this.destinationProvider = destinationProvider;\n this.options = options;\n\n this.progress = { data: {}, stream: new PassThrough({ objectMode: true }) };\n }\n\n /**\n * Report a fatal error and throw it\n */\n panic(error: Error) {\n this.reportError(error, 'fatal');\n\n throw error;\n }\n\n /**\n * Report an error diagnostic\n */\n reportError(error: Error, severity: ErrorDiagnosticSeverity) {\n this.diagnostics.report(Line truncated
@@ -0,0 +1,3 @@
export * from './schemas';
export * from './provider';
//# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/engine/validation/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC"}
@@ -0,0 +1,4 @@
import type { IDestinationProvider, ISourceProvider, ProviderType } from '../../../types';
declare const validateProvider: <T extends ProviderType>(type: ProviderType, provider?: ([T] extends ['source'] ? ISourceProvider : IDestinationProvider) | null) => undefined;
export { validateProvider };
//# sourceMappingURL=provider.d.ts.map
@@ -0,0 +1 @@
{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../../src/engine/validation/provider.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAO1F,QAAA,MAAM,gBAAgB,iCACd,YAAY,aACP,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,eAAe,GAAG,oBAAoB,CAAC,GAAG,IAAI,cAapF,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
@@ -0,0 +1,19 @@
'use strict';
var fp = require('lodash/fp');
var errors = require('../errors.js');
const reject = (reason)=>{
throw new errors.TransferEngineValidationError(`Invalid provider supplied. ${reason}`);
};
const validateProvider = (type, provider)=>{
if (!provider) {
return reject(`Expected an instance of "${fp.capitalize(type)}Provider", but got "${typeof provider}" instead.`);
}
if (provider.type !== type) {
return reject(`Expected the provider to be of type "${type}" but got "${provider.type}" instead.`);
}
};
exports.validateProvider = validateProvider;
//# sourceMappingURL=provider.js.map
@@ -0,0 +1 @@
{"version":3,"file":"provider.js","sources":["../../../src/engine/validation/provider.ts"],"sourcesContent":["import { capitalize } from 'lodash/fp';\n\nimport type { IDestinationProvider, ISourceProvider, ProviderType } from '../../../types';\nimport { TransferEngineValidationError } from '../errors';\n\nconst reject = (reason: string): never => {\n throw new TransferEngineValidationError(`Invalid provider supplied. ${reason}`);\n};\n\nconst validateProvider = <T extends ProviderType>(\n type: ProviderType,\n provider?: ([T] extends ['source'] ? ISourceProvider : IDestinationProvider) | null\n) => {\n if (!provider) {\n return reject(\n `Expected an instance of \"${capitalize(type)}Provider\", but got \"${typeof provider}\" instead.`\n );\n }\n\n if (provider.type !== type) {\n return reject(\n `Expected the provider to be of type \"${type}\" but got \"${provider.type}\" instead.`\n );\n }\n};\n\nexport { validateProvider };\n"],"names":["reject","reason","TransferEngineValidationError","validateProvider","type","provider","capitalize"],"mappings":";;;;;AAKA,MAAMA,SAAS,CAACC,MAAAA,GAAAA;AACd,IAAA,MAAM,IAAIC,oCAA8B,CAAA,CAAC,2BAA2B,EAAED,OAAO,CAAC,CAAA;AAChF,CAAA;AAEME,MAAAA,gBAAAA,GAAmB,CACvBC,IACAC,EAAAA,QAAAA,GAAAA;AAEA,IAAA,IAAI,CAACA,QAAU,EAAA;QACb,OAAOL,MAAAA,CACL,CAAC,yBAAyB,EAAEM,aAAAA,CAAWF,IAAM,CAAA,CAAA,oBAAoB,EAAE,OAAOC,QAAS,CAAA,UAAU,CAAC,CAAA;AAElG;IAEA,IAAIA,QAAAA,CAASD,IAAI,KAAKA,IAAM,EAAA;QAC1B,OAAOJ,MAAAA,CACL,CAAC,qCAAqC,EAAEI,IAAAA,CAAK,WAAW,EAAEC,QAASD,CAAAA,IAAI,CAAC,UAAU,CAAC,CAAA;AAEvF;AACF;;;;"}
@@ -0,0 +1,17 @@
import { capitalize } from 'lodash/fp';
import { TransferEngineValidationError } from '../errors.mjs';
const reject = (reason)=>{
throw new TransferEngineValidationError(`Invalid provider supplied. ${reason}`);
};
const validateProvider = (type, provider)=>{
if (!provider) {
return reject(`Expected an instance of "${capitalize(type)}Provider", but got "${typeof provider}" instead.`);
}
if (provider.type !== type) {
return reject(`Expected the provider to be of type "${type}" but got "${provider.type}" instead.`);
}
};
export { validateProvider };
//# sourceMappingURL=provider.mjs.map
@@ -0,0 +1 @@
{"version":3,"file":"provider.mjs","sources":["../../../src/engine/validation/provider.ts"],"sourcesContent":["import { capitalize } from 'lodash/fp';\n\nimport type { IDestinationProvider, ISourceProvider, ProviderType } from '../../../types';\nimport { TransferEngineValidationError } from '../errors';\n\nconst reject = (reason: string): never => {\n throw new TransferEngineValidationError(`Invalid provider supplied. ${reason}`);\n};\n\nconst validateProvider = <T extends ProviderType>(\n type: ProviderType,\n provider?: ([T] extends ['source'] ? ISourceProvider : IDestinationProvider) | null\n) => {\n if (!provider) {\n return reject(\n `Expected an instance of \"${capitalize(type)}Provider\", but got \"${typeof provider}\" instead.`\n );\n }\n\n if (provider.type !== type) {\n return reject(\n `Expected the provider to be of type \"${type}\" but got \"${provider.type}\" instead.`\n );\n }\n};\n\nexport { validateProvider };\n"],"names":["reject","reason","TransferEngineValidationError","validateProvider","type","provider","capitalize"],"mappings":";;;AAKA,MAAMA,SAAS,CAACC,MAAAA,GAAAA;AACd,IAAA,MAAM,IAAIC,6BAA8B,CAAA,CAAC,2BAA2B,EAAED,OAAO,CAAC,CAAA;AAChF,CAAA;AAEME,MAAAA,gBAAAA,GAAmB,CACvBC,IACAC,EAAAA,QAAAA,GAAAA;AAEA,IAAA,IAAI,CAACA,QAAU,EAAA;QACb,OAAOL,MAAAA,CACL,CAAC,yBAAyB,EAAEM,UAAAA,CAAWF,IAAM,CAAA,CAAA,oBAAoB,EAAE,OAAOC,QAAS,CAAA,UAAU,CAAC,CAAA;AAElG;IAEA,IAAIA,QAAAA,CAASD,IAAI,KAAKA,IAAM,EAAA;QAC1B,OAAOJ,MAAAA,CACL,CAAC,qCAAqC,EAAEI,IAAAA,CAAK,WAAW,EAAEC,QAASD,CAAAA,IAAI,CAAC,UAAU,CAAC,CAAA;AAEvF;AACF;;;;"}
@@ -0,0 +1,8 @@
import type { Diff } from '../../../utils/json';
declare const strategies: {
exact(diffs: Diff[]): Diff[];
strict(diffs: Diff[]): Diff[];
};
declare const compareSchemas: <T, P>(a: T, b: P, strategy: keyof typeof strategies) => Diff[];
export { compareSchemas };
//# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/engine/validation/schemas/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAqChD,QAAA,MAAM,UAAU;iBAED,IAAI,EAAE;kBAOL,IAAI,EAAE;CAGrB,CAAC;AAEF,QAAA,MAAM,cAAc,YAAa,CAAC,KAAK,CAAC,YAAY,MAAM,iBAAiB,WAG1E,CAAC;AAEF,OAAO,EAAE,cAAc,EAAE,CAAC"}
@@ -0,0 +1,57 @@
'use strict';
var fp = require('lodash/fp');
require('crypto');
require('stream');
var json = require('../../../utils/json.js');
require('events');
const OPTIONAL_CONTENT_TYPES = [
'audit-log'
];
const isAttributeIgnorable = (diff)=>{
return diff.path.length === 3 && // Root property must be attributes
diff.path[0] === 'attributes' && // Need a valid string attribute name
typeof diff.path[1] === 'string' && // The diff must be on ignorable attribute properties
[
'private',
'required',
'configurable',
'default'
].includes(diff.path[2]);
};
// TODO: clean up the type checking, which will require cleaning up the typings in utils/json.ts
// exclude admin tables that are not transferable and are optionally available (such as audit logs which are only available in EE)
const isOptionalAdminType = (diff)=>{
// added/deleted
if ('value' in diff && fp.isObject(diff.value)) {
const name = diff?.value?.info?.singularName;
return OPTIONAL_CONTENT_TYPES.includes(name);
}
// modified
if ('values' in diff && fp.isArray(diff.values) && fp.isObject(diff.values[0])) {
const name = diff?.values[0]?.info?.singularName;
return OPTIONAL_CONTENT_TYPES.includes(name);
}
return false;
};
const isIgnorableStrict = (diff)=>isAttributeIgnorable(diff) || isOptionalAdminType(diff);
const strategies = {
// No diffs
exact (diffs) {
return diffs;
},
// Strict: all content types must match except:
// - the property within a content type is an ignorable one
// - those that are (not transferrable and optionally available), for example EE features such as audit logs
strict (diffs) {
return fp.reject(isIgnorableStrict, diffs);
}
};
const compareSchemas = (a, b, strategy)=>{
const diffs = json.diff(a, b);
return strategies[strategy](diffs);
};
exports.compareSchemas = compareSchemas;
//# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
{"version":3,"file":"index.js","sources":["../../../../src/engine/validation/schemas/index.ts"],"sourcesContent":["import type { Struct } from '@strapi/types';\nimport { isArray, isObject, reject } from 'lodash/fp';\nimport type { Diff } from '../../../utils/json';\nimport * as utils from '../../../utils';\n\nconst OPTIONAL_CONTENT_TYPES = ['audit-log'] as const;\n\nconst isAttributeIgnorable = (diff: Diff) => {\n return (\n diff.path.length === 3 &&\n // Root property must be attributes\n diff.path[0] === 'attributes' &&\n // Need a valid string attribute name\n typeof diff.path[1] === 'string' &&\n // The diff must be on ignorable attribute properties\n ['private', 'required', 'configurable', 'default'].includes(diff.path[2])\n );\n};\n\n// TODO: clean up the type checking, which will require cleaning up the typings in utils/json.ts\n// exclude admin tables that are not transferable and are optionally available (such as audit logs which are only available in EE)\nconst isOptionalAdminType = (diff: Diff) => {\n // added/deleted\n if ('value' in diff && isObject(diff.value)) {\n const name = (diff?.value as Struct.ContentTypeSchema)?.info?.singularName;\n return (OPTIONAL_CONTENT_TYPES as ReadonlyArray<string | undefined>).includes(name);\n }\n\n // modified\n if ('values' in diff && isArray(diff.values) && isObject(diff.values[0])) {\n const name = (diff?.values[0] as Struct.ContentTypeSchema)?.info?.singularName;\n return (OPTIONAL_CONTENT_TYPES as ReadonlyArray<string | undefined>).includes(name);\n }\n\n return false;\n};\n\nconst isIgnorableStrict = (diff: Diff) => isAttributeIgnorable(diff) || isOptionalAdminType(diff);\n\nconst strategies = {\n // No diffs\n exact(diffs: Diff[]) {\n return diffs;\n },\n\n // Strict: all content types must match except:\n // - the property within a content type is an ignorable one\n // - those that are (not transferrable and optionally available), for example EE features such as audit logs\n strict(diffs: Diff[]) {\n return reject(isIgnorableStrict, diffs);\n },\n};\n\nconst compareSchemas = <T, P>(a: T, b: P, strategy: keyof typeof strategies) => {\n const diffs = utils.json.diff(a, b);\n return strategies[strategy](diffs);\n};\n\nexport { compareSchemas };\n"],"names":["OPTIONAL_CONTENT_TYPES","isAttributeIgnorable","diff","path","length","includes","isOptionalAdminType","isObject","value","name","info","singularName","isArray","values","isIgnorableStrict","strategies","exact","diffs","strict","reject","compareSchemas","a","b","strategy","utils"],"mappings":";;;;;;;;AAKA,MAAMA,sBAAyB,GAAA;AAAC,IAAA;AAAY,CAAA;AAE5C,MAAMC,uBAAuB,CAACC,IAAAA,GAAAA;AAC5B,IAAA,OACEA,KAAKC,IAAI,CAACC,MAAM,KAAK;AAErBF,IAAAA,IAAAA,CAAKC,IAAI,CAAC,CAAE,CAAA,KAAK;AAEjB,IAAA,OAAOD,KAAKC,IAAI,CAAC,CAAE,CAAA,KAAK;AAExB,IAAA;AAAC,QAAA,SAAA;AAAW,QAAA,UAAA;AAAY,QAAA,cAAA;AAAgB,QAAA;AAAU,KAAA,CAACE,QAAQ,CAACH,IAAKC,CAAAA,IAAI,CAAC,CAAE,CAAA,CAAA;AAE5E,CAAA;AAEA;AACA;AACA,MAAMG,sBAAsB,CAACJ,IAAAA,GAAAA;;AAE3B,IAAA,IAAI,OAAWA,IAAAA,IAAAA,IAAQK,WAASL,CAAAA,IAAAA,CAAKM,KAAK,CAAG,EAAA;QAC3C,MAAMC,IAAAA,GAAQP,IAAMM,EAAAA,KAAAA,EAAoCE,IAAMC,EAAAA,YAAAA;QAC9D,OAAQX,sBAA6DK,CAAAA,QAAQ,CAACI,IAAAA,CAAAA;AAChF;;IAGA,IAAI,QAAA,IAAYP,IAAQU,IAAAA,UAAAA,CAAQV,IAAKW,CAAAA,MAAM,CAAKN,IAAAA,WAAAA,CAASL,IAAKW,CAAAA,MAAM,CAAC,CAAA,CAAE,CAAG,EAAA;AACxE,QAAA,MAAMJ,OAAQP,IAAMW,EAAAA,MAAM,CAAC,CAAA,CAAE,EAA+BH,IAAMC,EAAAA,YAAAA;QAClE,OAAQX,sBAA6DK,CAAAA,QAAQ,CAACI,IAAAA,CAAAA;AAChF;IAEA,OAAO,KAAA;AACT,CAAA;AAEA,MAAMK,iBAAoB,GAAA,CAACZ,IAAeD,GAAAA,oBAAAA,CAAqBC,SAASI,mBAAoBJ,CAAAA,IAAAA,CAAAA;AAE5F,MAAMa,UAAa,GAAA;;AAEjBC,IAAAA,KAAAA,CAAAA,CAAMC,KAAa,EAAA;QACjB,OAAOA,KAAAA;AACT,KAAA;;;;AAKAC,IAAAA,MAAAA,CAAAA,CAAOD,KAAa,EAAA;AAClB,QAAA,OAAOE,UAAOL,iBAAmBG,EAAAA,KAAAA,CAAAA;AACnC;AACF,CAAA;AAEMG,MAAAA,cAAAA,GAAiB,CAAOC,CAAAA,EAAMC,CAAMC,EAAAA,QAAAA,GAAAA;AACxC,IAAA,MAAMN,QAAQO,SAAe,CAACH,CAAGC,EAAAA,CAAAA,CAAAA;IACjC,OAAOP,UAAU,CAACQ,QAAAA,CAAS,CAACN,KAAAA,CAAAA;AAC9B;;;;"}
@@ -0,0 +1,55 @@
import { reject, isObject, isArray } from 'lodash/fp';
import 'crypto';
import 'stream';
import { diff } from '../../../utils/json.mjs';
import 'events';
const OPTIONAL_CONTENT_TYPES = [
'audit-log'
];
const isAttributeIgnorable = (diff)=>{
return diff.path.length === 3 && // Root property must be attributes
diff.path[0] === 'attributes' && // Need a valid string attribute name
typeof diff.path[1] === 'string' && // The diff must be on ignorable attribute properties
[
'private',
'required',
'configurable',
'default'
].includes(diff.path[2]);
};
// TODO: clean up the type checking, which will require cleaning up the typings in utils/json.ts
// exclude admin tables that are not transferable and are optionally available (such as audit logs which are only available in EE)
const isOptionalAdminType = (diff)=>{
// added/deleted
if ('value' in diff && isObject(diff.value)) {
const name = diff?.value?.info?.singularName;
return OPTIONAL_CONTENT_TYPES.includes(name);
}
// modified
if ('values' in diff && isArray(diff.values) && isObject(diff.values[0])) {
const name = diff?.values[0]?.info?.singularName;
return OPTIONAL_CONTENT_TYPES.includes(name);
}
return false;
};
const isIgnorableStrict = (diff)=>isAttributeIgnorable(diff) || isOptionalAdminType(diff);
const strategies = {
// No diffs
exact (diffs) {
return diffs;
},
// Strict: all content types must match except:
// - the property within a content type is an ignorable one
// - those that are (not transferrable and optionally available), for example EE features such as audit logs
strict (diffs) {
return reject(isIgnorableStrict, diffs);
}
};
const compareSchemas = (a, b, strategy)=>{
const diffs = diff(a, b);
return strategies[strategy](diffs);
};
export { compareSchemas };
//# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
{"version":3,"file":"index.mjs","sources":["../../../../src/engine/validation/schemas/index.ts"],"sourcesContent":["import type { Struct } from '@strapi/types';\nimport { isArray, isObject, reject } from 'lodash/fp';\nimport type { Diff } from '../../../utils/json';\nimport * as utils from '../../../utils';\n\nconst OPTIONAL_CONTENT_TYPES = ['audit-log'] as const;\n\nconst isAttributeIgnorable = (diff: Diff) => {\n return (\n diff.path.length === 3 &&\n // Root property must be attributes\n diff.path[0] === 'attributes' &&\n // Need a valid string attribute name\n typeof diff.path[1] === 'string' &&\n // The diff must be on ignorable attribute properties\n ['private', 'required', 'configurable', 'default'].includes(diff.path[2])\n );\n};\n\n// TODO: clean up the type checking, which will require cleaning up the typings in utils/json.ts\n// exclude admin tables that are not transferable and are optionally available (such as audit logs which are only available in EE)\nconst isOptionalAdminType = (diff: Diff) => {\n // added/deleted\n if ('value' in diff && isObject(diff.value)) {\n const name = (diff?.value as Struct.ContentTypeSchema)?.info?.singularName;\n return (OPTIONAL_CONTENT_TYPES as ReadonlyArray<string | undefined>).includes(name);\n }\n\n // modified\n if ('values' in diff && isArray(diff.values) && isObject(diff.values[0])) {\n const name = (diff?.values[0] as Struct.ContentTypeSchema)?.info?.singularName;\n return (OPTIONAL_CONTENT_TYPES as ReadonlyArray<string | undefined>).includes(name);\n }\n\n return false;\n};\n\nconst isIgnorableStrict = (diff: Diff) => isAttributeIgnorable(diff) || isOptionalAdminType(diff);\n\nconst strategies = {\n // No diffs\n exact(diffs: Diff[]) {\n return diffs;\n },\n\n // Strict: all content types must match except:\n // - the property within a content type is an ignorable one\n // - those that are (not transferrable and optionally available), for example EE features such as audit logs\n strict(diffs: Diff[]) {\n return reject(isIgnorableStrict, diffs);\n },\n};\n\nconst compareSchemas = <T, P>(a: T, b: P, strategy: keyof typeof strategies) => {\n const diffs = utils.json.diff(a, b);\n return strategies[strategy](diffs);\n};\n\nexport { compareSchemas };\n"],"names":["OPTIONAL_CONTENT_TYPES","isAttributeIgnorable","diff","path","length","includes","isOptionalAdminType","isObject","value","name","info","singularName","isArray","values","isIgnorableStrict","strategies","exact","diffs","strict","reject","compareSchemas","a","b","strategy","utils"],"mappings":";;;;;;AAKA,MAAMA,sBAAyB,GAAA;AAAC,IAAA;AAAY,CAAA;AAE5C,MAAMC,uBAAuB,CAACC,IAAAA,GAAAA;AAC5B,IAAA,OACEA,KAAKC,IAAI,CAACC,MAAM,KAAK;AAErBF,IAAAA,IAAAA,CAAKC,IAAI,CAAC,CAAE,CAAA,KAAK;AAEjB,IAAA,OAAOD,KAAKC,IAAI,CAAC,CAAE,CAAA,KAAK;AAExB,IAAA;AAAC,QAAA,SAAA;AAAW,QAAA,UAAA;AAAY,QAAA,cAAA;AAAgB,QAAA;AAAU,KAAA,CAACE,QAAQ,CAACH,IAAKC,CAAAA,IAAI,CAAC,CAAE,CAAA,CAAA;AAE5E,CAAA;AAEA;AACA;AACA,MAAMG,sBAAsB,CAACJ,IAAAA,GAAAA;;AAE3B,IAAA,IAAI,OAAWA,IAAAA,IAAAA,IAAQK,QAASL,CAAAA,IAAAA,CAAKM,KAAK,CAAG,EAAA;QAC3C,MAAMC,IAAAA,GAAQP,IAAMM,EAAAA,KAAAA,EAAoCE,IAAMC,EAAAA,YAAAA;QAC9D,OAAQX,sBAA6DK,CAAAA,QAAQ,CAACI,IAAAA,CAAAA;AAChF;;IAGA,IAAI,QAAA,IAAYP,IAAQU,IAAAA,OAAAA,CAAQV,IAAKW,CAAAA,MAAM,CAAKN,IAAAA,QAAAA,CAASL,IAAKW,CAAAA,MAAM,CAAC,CAAA,CAAE,CAAG,EAAA;AACxE,QAAA,MAAMJ,OAAQP,IAAMW,EAAAA,MAAM,CAAC,CAAA,CAAE,EAA+BH,IAAMC,EAAAA,YAAAA;QAClE,OAAQX,sBAA6DK,CAAAA,QAAQ,CAACI,IAAAA,CAAAA;AAChF;IAEA,OAAO,KAAA;AACT,CAAA;AAEA,MAAMK,iBAAoB,GAAA,CAACZ,IAAeD,GAAAA,oBAAAA,CAAqBC,SAASI,mBAAoBJ,CAAAA,IAAAA,CAAAA;AAE5F,MAAMa,UAAa,GAAA;;AAEjBC,IAAAA,KAAAA,CAAAA,CAAMC,KAAa,EAAA;QACjB,OAAOA,KAAAA;AACT,KAAA;;;;AAKAC,IAAAA,MAAAA,CAAAA,CAAOD,KAAa,EAAA;AAClB,QAAA,OAAOE,OAAOL,iBAAmBG,EAAAA,KAAAA,CAAAA;AACnC;AACF,CAAA;AAEMG,MAAAA,cAAAA,GAAiB,CAAOC,CAAAA,EAAMC,CAAMC,EAAAA,QAAAA,GAAAA;AACxC,IAAA,MAAMN,QAAQO,IAAe,CAACH,CAAGC,EAAAA,CAAAA,CAAAA;IACjC,OAAOP,UAAU,CAACQ,QAAAA,CAAS,CAACN,KAAAA,CAAAA;AAC9B;;;;"}