Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add dummy for FileLogger, ConnectionOptionsReaders, and update gulpfile #6763

Merged
merged 1 commit into from Sep 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
32 changes: 6 additions & 26 deletions gulpfile.ts
Expand Up @@ -64,38 +64,18 @@ export class Gulpfile {
"!./src/commands/*.ts",
"!./src/cli.ts",
"!./src/typeorm.ts",
"!./src/typeorm-model-shim.ts",
"!./src/platform/PlatformTools.ts"
"!./src/typeorm-model-shim.ts"
])
.pipe(gulp.dest("./build/browser/src"));
}

/**
* Replaces PlatformTools with browser-specific implementation called BrowserPlatformTools.
* Copies templates for compilation
*/
@Task()
browserCopyDirectoryExportedClassesLoader() {
return gulp.src("./src/platform/BrowserDirectoryExportedClassesLoader.template")
.pipe(rename("BrowserDirectoryExportedClassesLoader.ts"))
.pipe(gulp.dest("./build/browser/src/platform"));
}
/**
* Replaces PlatformTools with browser-specific implementation called BrowserPlatformTools.
*/
@Task()
browserCopyPlatformTools() {
return gulp.src("./src/platform/BrowserPlatformTools.template")
.pipe(rename("PlatformTools.ts"))
.pipe(gulp.dest("./build/browser/src/platform"));
}

/**
* Adds dummy classes for disabled drivers (replacement is done via browser entry point in package.json)
*/
@Task()
browserCopyDisabledDriversDummy() {
return gulp.src("./src/platform/BrowserDisabledDriversDummy.template")
.pipe(rename("BrowserDisabledDriversDummy.ts"))
browserCopyTemplates() {
return gulp.src("./src/platform/*.template")
.pipe(rename((p: any) => { p.extname = '.ts'; }))
.pipe(gulp.dest("./build/browser/src/platform"));
}

Expand Down Expand Up @@ -242,7 +222,7 @@ export class Gulpfile {
package() {
return [
"clean",
["browserCopySources", "browserCopyPlatformTools", "browserCopyDisabledDriversDummy", "browserCopyDirectoryExportedClassesLoader"],
["browserCopySources", "browserCopyTemplates"],
["packageCompile", "browserCompile"],
"packageMoveCompiledFiles",
[
Expand Down
5 changes: 5 additions & 0 deletions package.json
Expand Up @@ -25,6 +25,11 @@
"./browser/driver/sqlite/SqliteDriver.js": "./browser/platform/BrowserDisabledDriversDummy.js",
"./browser/driver/better-sqlite3/BetterSqlite3Driver.js": "./browser/platform/BrowserDisabledDriversDummy.js",
"./browser/util/DirectoryExportedClassesLoader.js": "./browser/platform/BrowserDirectoryExportedClassesLoader.js",
"./browser/logger/FileLogger.js": "./browser/platform/BrowserFileLoggerDummy.js",
"./browser/connection/ConnectionOptionsReader.js": "./browser/platform/BrowserConnectionOptionsReaderDummy.js",
"./browser/connection/options-reader/ConnectionOptionsXmlReader.js": "./browser/platform/BrowserConnectionOptionsReaderDummy.js",
"./browser/connection/options-reader/ConnectionOptionsYmlReader.js": "./browser/platform/BrowserConnectionOptionsReaderDummy.js",
"./browser/platform/PlatformTools.js": "./browser/platform/BrowserPlatformTools.js",
"./index.js": "./browser/index.js"
},
"repository": {
Expand Down
8 changes: 4 additions & 4 deletions src/connection/ConnectionOptionsReader.ts
Expand Up @@ -103,8 +103,8 @@ export class ConnectionOptionsReader {
const configFile = fileExtension ? this.baseFilePath : this.baseFilePath + "." + foundFileFormat;

// try to find connection options from any of available sources of configuration
if (PlatformTools.getEnvVariable("TYPEORM_CONNECTION") || PlatformTools.getEnvVariable("TYPEORM_URL")) {
connectionOptions = new ConnectionOptionsEnvReader().read();
if (PlatformTools.getEnvVariable("TYPEORM_CONNECTION") || PlatformTools.getEnvVariable("TYPEORM_URL")) {
connectionOptions = await new ConnectionOptionsEnvReader().read();

} else if (foundFileFormat === "js" || foundFileFormat === "cjs") {
connectionOptions = await require(configFile);
Expand All @@ -116,10 +116,10 @@ export class ConnectionOptionsReader {
connectionOptions = require(configFile);

} else if (foundFileFormat === "yml") {
connectionOptions = new ConnectionOptionsYmlReader().read(configFile);
connectionOptions = await new ConnectionOptionsYmlReader().read(configFile);

} else if (foundFileFormat === "yaml") {
connectionOptions = new ConnectionOptionsYmlReader().read(configFile);
connectionOptions = await new ConnectionOptionsYmlReader().read(configFile);

} else if (foundFileFormat === "xml") {
connectionOptions = await new ConnectionOptionsXmlReader().read(configFile);
Expand Down
6 changes: 3 additions & 3 deletions src/connection/options-reader/ConnectionOptionsEnvReader.ts
Expand Up @@ -16,8 +16,8 @@ export class ConnectionOptionsEnvReader {
/**
* Reads connection options from environment variables.
*/
read(): ConnectionOptions {
return {
async read(): Promise<ConnectionOptions[]> {
return [{
type: PlatformTools.getEnvVariable("TYPEORM_CONNECTION") || (PlatformTools.getEnvVariable("TYPEORM_URL") ? PlatformTools.getEnvVariable("TYPEORM_URL").split("://")[0] : undefined),
url: PlatformTools.getEnvVariable("TYPEORM_URL"),
host: PlatformTools.getEnvVariable("TYPEORM_HOST"),
Expand Down Expand Up @@ -47,7 +47,7 @@ export class ConnectionOptionsEnvReader {
},
cache: this.transformCaching(),
uuidExtension: PlatformTools.getEnvVariable("TYPEORM_UUID_EXTENSION")
};
}];
}

// -------------------------------------------------------------------------
Expand Down
Expand Up @@ -14,7 +14,7 @@ export class ConnectionOptionsYmlReader {
/**
* Reads connection options from given yml file.
*/
read(path: string): ConnectionOptions[] {
async read(path: string): Promise<ConnectionOptions[]> {
const contentsBuffer = PlatformTools.readFileSync(path);
const contents = contentsBuffer.toString();

Expand Down
55 changes: 55 additions & 0 deletions src/platform/BrowserConnectionOptionsReaderDummy.template
@@ -0,0 +1,55 @@
/**
* Dummy class for replacement via `package.json` in browser builds.
*
* If we don't include these functions typeorm will throw an error on runtime
* as well as during webpack builds.
*/
export class ConnectionOptionsEnvReader {
async read() {
throw new Error(`Cannot read connection options in a browser context.`);
}
}

/**
* Dummy class for replacement via `package.json` in browser builds.
*
* If we don't include these functions typeorm will throw an error on runtime
* as well as during webpack builds.
*/
export class ConnectionOptionsXmlReader {
async read(path: string) {
throw new Error(`Cannot read connection options in a browser context.`);
}
}

/**
* Dummy class for replacement via `package.json` in browser builds.
*
* If we don't include these functions typeorm will throw an error on runtime
* as well as during webpack builds.
*/
export class ConnectionOptionsYmlReader {
async read(path: string) {
throw new Error(`Cannot read connection options in a browser context.`);
}
}

/**
* Dummy class for replacement via `package.json` in browser builds.
*
* If we don't include these functions typeorm will throw an error on runtime
* as well as during webpack builds.
*/
export class ConnectionOptionsReader {
async all() {
throw new Error(`Cannot read connection options in a browser context.`);
}

async get() {
throw new Error(`Cannot read connection options in a browser context.`);
}

async has() {
throw new Error(`Cannot read connection options in a browser context.`);
}
}
50 changes: 50 additions & 0 deletions src/platform/BrowserFileLoggerDummy.template
@@ -0,0 +1,50 @@
/**
* Performs logging of the events in TypeORM.
* This version of logger logs everything into ormlogs.log file.
*/
export class DummyLogger {
/**
* Logs query and parameters used in it.
*/
logQuery() {
throw new Error('This logger is not applicable in a browser context');
}

/**
* Logs query that is failed.
*/
logQueryError() {
throw new Error('This logger is not applicable in a browser context');
}

/**
* Logs query that is slow.
*/
logQuerySlow() {
throw new Error('This logger is not applicable in a browser context');
}

/**
* Logs events from the schema build process.
*/
logSchemaBuild() {
throw new Error('This logger is not applicable in a browser context');
}

/**
* Logs events from the migrations run process.
*/
logMigration() {
throw new Error('This logger is not applicable in a browser context');
}

/**
* Perform logging using given logger, or by default to the console.
* Log has its own level and message.
*/
log() {
throw new Error('This logger is not applicable in a browser context');
}
}

export class FileLogger extends DummyLogger {}