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.

Sign up for GitHub

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

Jump to bottom

Stage #7782

Merged
merged 2 commits into from
Apr 29, 2024
Merged

Stage #7782

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3fb80d
fix: detect correctly that API server is running in Desktop Server app
evereq Apr 29, 2024
e9d4332
Merge pull request #7781 from ever-co/develop
evereq Apr 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 23 additions & 26 deletions packages/core/src/bootstrap/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ export async function bootstrap(pluginConfig?: Partial<ApplicationPluginConfig>)
// Create the NestJS application
const app = await NestFactory.create<NestExpressApplication>(BootstrapModule, {
logger: ['log', 'error', 'warn', 'debug', 'verbose'], // Set logging levels
bufferLogs: true, // Buffer logs to avoid loss during startup
bufferLogs: true // Buffer logs to avoid loss during startup
});

// Register custom entity fields for Mikro ORM
Expand Down Expand Up @@ -106,7 +106,8 @@ export async function bootstrap(pluginConfig?: Partial<ApplicationPluginConfig>)
origin: '*',
methods: 'GET,HEAD,PUT,PATCH,POST,DELETE,OPTIONS',
credentials: true,
allowedHeaders: 'Authorization, Language, Tenant-Id, Organization-Id, X-Requested-With, X-Auth-Token, X-HTTP-Method-Override, Content-Type, Content-Language, Accept, Accept-Language, Observe'
allowedHeaders:
'Authorization, Language, Tenant-Id, Organization-Id, X-Requested-With, X-Auth-Token, X-HTTP-Method-Override, Content-Type, Content-Language, Accept, Accept-Language, Observe'
});

// TODO: enable csurf is not good idea because it was deprecated.
Expand Down Expand Up @@ -262,11 +263,16 @@ export async function bootstrap(pluginConfig?: Partial<ApplicationPluginConfig>)

await app.listen(port, host, () => {
console.timeEnd('Application Bootstrap Time'); // End timing
console.log(chalk.magenta(`Server listening at http://${host}:${port}/${globalPrefix}`));

// Note: do not change this prefix because we may use it to detect the success message from the running server!
const successMessagePrefix = 'Listening at http';

const message = `${successMessagePrefix}://${host}:${port}/${globalPrefix}`;
console.log(chalk.magenta(message));

// Send message to parent process (desktop app)
if (process.send) {
process.send(`Server started at http://${host}:${port}/${globalPrefix}`);
process.send(message);
}

if (env.demo) {
Expand Down Expand Up @@ -303,9 +309,7 @@ function handleUnhandledRejection(reason: any, promise: Promise<any>) {
* @param config - The partial application configuration to be pre-bootstrapped.
* @returns A promise that resolves to the pre-bootstrapped application configuration.
*/
export async function registerPluginConfig(
config: Partial<ApplicationPluginConfig>
): Promise<ApplicationPluginConfig> {
export async function registerPluginConfig(config: Partial<ApplicationPluginConfig>): Promise<ApplicationPluginConfig> {
// Apply pre-bootstrap operations and return the updated configuration
return await preBootstrapApplicationConfig(config);
}
Expand All @@ -318,9 +322,7 @@ export async function registerPluginConfig(
* @param applicationConfig - The initial application configuration.
* @returns A promise that resolves to the final application configuration after pre-bootstrap operations.
*/
export async function preBootstrapApplicationConfig(
applicationConfig: Partial<ApplicationPluginConfig>
) {
export async function preBootstrapApplicationConfig(applicationConfig: Partial<ApplicationPluginConfig>) {
if (Object.keys(applicationConfig).length > 0) {
// Set initial configuration if any properties are provided
setConfig(applicationConfig);
Expand All @@ -329,8 +331,8 @@ export async function preBootstrapApplicationConfig(
// Configure migration settings
setConfig({
dbConnectionOptions: {
...getMigrationsSetting(),
},
...getMigrationsSetting()
}
});

// Log the current database configuration (for debugging or informational purposes)
Expand All @@ -344,12 +346,12 @@ export async function preBootstrapApplicationConfig(
setConfig({
dbConnectionOptions: {
entities: entities as Array<Type<any>>, // Core and plugin entities
subscribers: subscribers as Array<Type<EntitySubscriberInterface>>, // Core and plugin subscribers
subscribers: subscribers as Array<Type<EntitySubscriberInterface>> // Core and plugin subscribers
},
dbMikroOrmConnectionOptions: {
entities: entities as Array<Type<any>>, // MikroORM entities
subscribers: subscribers as Array<EventSubscriber>, // MikroORM subscribers
},
subscribers: subscribers as Array<EventSubscriber> // MikroORM subscribers
}
});

// Apply additional plugin configurations
Expand All @@ -369,9 +371,7 @@ export async function preBootstrapApplicationConfig(
* @param config - The initial application configuration to be modified.
* @returns A promise that resolves to the updated application configuration.
*/
async function preBootstrapPluginConfigurations(
config: ApplicationPluginConfig
): Promise<ApplicationPluginConfig> {
async function preBootstrapPluginConfigurations(config: ApplicationPluginConfig): Promise<ApplicationPluginConfig> {
// Retrieve a list of plugin configuration functions based on the provided config
const pluginConfigurations = getPluginConfigurations(config.plugins);

Expand All @@ -395,9 +395,7 @@ async function preBootstrapPluginConfigurations(
* @param config - Plugin configuration containing plugin entities.
* @returns A promise that resolves to an array of registered entity types.
*/
async function preBootstrapRegisterEntities(
config: Partial<ApplicationPluginConfig>
): Promise<Array<Type<any>>> {
async function preBootstrapRegisterEntities(config: Partial<ApplicationPluginConfig>): Promise<Array<Type<any>>> {
try {
// Retrieve the list of core entities
const coreEntitiesList = coreEntities as Array<Type<any>>;
Expand All @@ -412,7 +410,7 @@ async function preBootstrapRegisterEntities(
// If a core entity has the same name as a plugin entity, throw a conflict exception
if (coreEntitiesList.some((entity) => entity.name === entityName)) {
throw new ConflictException({
message: `Error: ${entityName} conflicts with default entities.`,
message: `Error: ${entityName} conflicts with default entities.`
});
}

Expand Down Expand Up @@ -453,7 +451,7 @@ async function preBootstrapRegisterSubscribers(
if (subscribers.some((subscriber) => subscriber.name === subscriberName)) {
// Throw an exception if there's a conflict
throw new ConflictException({
message: `Error: ${subscriberName} conflicts with default subscribers.`,
message: `Error: ${subscriberName} conflicts with default subscribers.`
});
} else {
// Add the new plugin subscriber to the list if no conflict
Expand All @@ -469,7 +467,6 @@ async function preBootstrapRegisterSubscribers(
}
}


/**
* Gets the migrations directory and CLI migration paths.
*
Expand All @@ -489,7 +486,7 @@ export function getMigrationsSetting() {
return {
migrations: [migrationsPath], // An array of migration file paths
cli: {
migrationsDir: cliMigrationsDir, // Directory for CLI migrations
},
migrationsDir: cliMigrationsDir // Directory for CLI migrations
}
};
}
7 changes: 5 additions & 2 deletions packages/desktop-api/src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ async function bootstrap() {
origin: '*',
methods: 'GET,HEAD,PUT,PATCH,POST,DELETE,OPTIONS',
credentials: true,
allowedHeaders: 'Authorization, Language, Tenant-Id, Organization-Id, X-Requested-With, X-Auth-Token, X-HTTP-Method-Override, Content-Type, Content-Language, Accept, Accept-Language, Observe'
allowedHeaders:
'Authorization, Language, Tenant-Id, Organization-Id, X-Requested-With, X-Auth-Token, X-HTTP-Method-Override, Content-Type, Content-Language, Accept, Accept-Language, Observe'
});

const globalPrefix = 'api';
Expand All @@ -22,7 +23,9 @@ async function bootstrap() {
const port = environment.DESKTOP_API_DEFAULT_PORT;

await app.listen(port, () => {
const message = 'Internal API listening at http://localhost:' + port + '/' + globalPrefix;
// Note: do not change this prefix because we may use it to detect the success message from the running server!
const successMessagePrefix = 'Listening at http';
const message = `${successMessagePrefix}://localhost:${port}/${globalPrefix}`;
Logger.log(message);
});
}
Expand Down
4 changes: 4 additions & 0 deletions packages/desktop-libs/src/lib/server/service/api-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,12 @@ export class ApiService extends ServerTask {
readonly signal: AbortSignal
) {
const args = { ...env, serviceName: 'api' };

// Note: do not change this prefix because we may use it to detect the success message from the running server!
const successMessage = 'Listening at http';

const errorMessage = 'Error running API server:';

super(path, args, window, successMessage, errorMessage, signal);
}

Expand Down
Loading