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 serverurl in openapi docs for self hosted instance #4390

Merged
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions packages/twenty-docs/src/components/token-form.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,13 @@ const TokenForm = ({
await submitToken(event.target.value);
};

const updateBaseUrl = (baseUrl) => {
setBaseUrl(baseUrl);
submitBaseUrl?.(baseUrl);
localStorage.setItem('baseUrl', JSON.stringify({ baseUrl: baseUrl }));
const updateBaseUrl = (baseUrl: string) => {
const url = baseUrl?.endsWith('/')
? baseUrl.substring(0, baseUrl.length - 1)
: baseUrl;
setBaseUrl(url);
submitBaseUrl?.(url);
localStorage.setItem('baseUrl', JSON.stringify({ baseUrl: url }));
};

const validateToken = (openApiJson) => {
Expand Down
4 changes: 1 addition & 3 deletions packages/twenty-server/src/core/api-rest/api-rest.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@ export class ApiRestService {
request: Request,
data: ApiRestQuery,
): Promise<ApiRestResponse> {
const baseUrl =
this.environmentService.getServerUrl() ||
`${request.protocol}://${request.get('host')}`;
const baseUrl = this.environmentService.getBaseUrl(request);

try {
return await this.httpService.axiosRef.post(`${baseUrl}/graphql`, data, {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@ export class ApiRestMetadataService {
) {}

async callMetadata(request, data: ApiRestQuery) {
const baseUrl =
this.environmentService.getServerUrl() ||
`${request.protocol}://${request.get('host')}`;
const baseUrl = this.environmentService.getBaseUrl(request);

try {
return await this.httpService.axiosRef.post(`${baseUrl}/metadata`, data, {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export class OpenApiController {
@Req() request: Request,
@Res() res: Response,
) {
const data = await this.openApiService.generateMetaDataSchema();
const data = await this.openApiService.generateMetaDataSchema(request);

res.send(data);
}
Expand Down
15 changes: 11 additions & 4 deletions packages/twenty-server/src/core/open-api/open-api.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,20 @@ import {
getSingleResultSuccessResponse,
} from 'src/core/open-api/utils/responses.utils';
import { getRequestBody } from 'src/core/open-api/utils/request-body.utils';
import { EnvironmentService } from 'src/integrations/environment/environment.service';

@Injectable()
export class OpenApiService {
constructor(
private readonly tokenService: TokenService,
private readonly environmentService: EnvironmentService,
private readonly objectMetadataService: ObjectMetadataService,
) {}

async generateCoreSchema(request: Request): Promise<OpenAPIV3_1.Document> {
const schema = baseSchema('core');
const baseUrl = this.environmentService.getBaseUrl(request);

const schema = baseSchema('core', baseUrl);

let objectMetadataItems;

Expand Down Expand Up @@ -86,9 +90,12 @@ export class OpenApiService {
return schema;
}

async generateMetaDataSchema(): Promise<OpenAPIV3_1.Document> {
//TODO Add once Rest MetaData api is ready
const schema = baseSchema('metadata');
async generateMetaDataSchema(
request: Request,
): Promise<OpenAPIV3_1.Document> {
const baseUrl = this.environmentService.getBaseUrl(request);

const schema = baseSchema('metadata', baseUrl);

schema.tags = [{ name: 'placeholder' }];

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { computeOpenApiPath } from 'src/core/open-api/utils/path.utils';

export const baseSchema = (
schemaName: 'core' | 'metadata',
serverUrl: string,
): OpenAPIV3_1.Document => {
return {
openapi: '3.0.3',
Expand All @@ -23,9 +24,7 @@ export const baseSchema = (
// Testing purposes
servers: [
{
url: `https://api.twenty.com/rest/${
schemaName !== 'core' ? schemaName : ''
}`,
url: `${serverUrl}/rest/${schemaName !== 'core' ? schemaName : ''}`,
description: 'Production Development',
},
],
Expand All @@ -49,6 +48,6 @@ export const baseSchema = (
description: 'Find out more about **Twenty**',
url: 'https://twenty.com',
},
paths: { [`/open-api/${schemaName}`]: computeOpenApiPath() },
paths: { [`/open-api/${schemaName}`]: computeOpenApiPath(serverUrl) },
};
};
6 changes: 4 additions & 2 deletions packages/twenty-server/src/core/open-api/utils/path.utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -95,15 +95,17 @@ export const computeSingleResultPath = (
} as OpenAPIV3_1.PathItemObject;
};

export const computeOpenApiPath = (): OpenAPIV3_1.PathItemObject => {
export const computeOpenApiPath = (
serverUrl: string,
): OpenAPIV3_1.PathItemObject => {
return {
get: {
tags: ['General'],
summary: 'Get Open Api Schema',
operationId: 'GetOpenApiSchema',
servers: [
{
url: 'https://api.twenty.com/',
url: serverUrl,
},
],
responses: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
import { Injectable, LogLevel } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';

import { Request } from 'express';

import { EmailDriver } from 'src/integrations/email/interfaces/email.interface';

import { LoggerDriverType } from 'src/integrations/logger/interfaces';
Expand Down Expand Up @@ -86,7 +88,19 @@ export class EnvironmentService {
}

getServerUrl(): string {
return this.configService.get<string>('SERVER_URL')!;
const url = this.configService.get<string>('SERVER_URL')!;

if (url?.endsWith('/')) {
return url.substring(0, url.length - 1);
}

return url;
}

getBaseUrl(request: Request): string {
return (
this.getServerUrl() || `${request.protocol}://${request.get('host')}`
);
}

getAccessTokenSecret(): string {
Expand Down
Loading