Skip to content

Decostructing CONFIGURATION_TO_SAVE tool to improve endpoints and collection generation performance #28

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

Merged
merged 8 commits into from
Sep 15, 2025
Merged

Decostructing CONFIGURATION_TO_SAVE tool to improve endpoints and collection generation performance #28

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2519eb3
handled collections generation
graz-dev Sep 9, 2025
4b46bed
handled endpoints generation
graz-dev Sep 9, 2025
2c74499
*fix lint error
graz-dev Sep 11, 2025
c9c5c36
Update src/tools/descriptions.ts
graz-dev Sep 15, 2025
b8a7128
Update src/apis/client.ts
graz-dev Sep 15, 2025
ed3d0f5
Update src/apis/client.ts
graz-dev Sep 15, 2025
577fec9
Update src/apis/client.ts
graz-dev Sep 15, 2025
fb642a5
Fixed build
graz-dev Sep 15, 2025
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
308 changes: 308 additions & 0 deletions src/apis/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,13 @@ export interface IAPIClient {
marketplaceItemVersion?: string,
description?: string,
): Promise<SaveResponse>
createEndpoints(
projectID: string,
refID: string,
endpointType: 'custom' | 'crud',
endpointName: string,
endpointTarget: string,
): Promise<SaveResponse>
// #endregion

// #region Deploy Methods
Expand Down Expand Up @@ -264,6 +271,24 @@ export class APIClient implements IAPIClient {
})
}

async createEndpoints (
projectID: string,
refID: string,
endpointType: 'custom' | 'crud',
endpointName: string,
endpointTarget: string,
): Promise<SaveResponse> {
const endpointStructure = this.#buildEndpointStructure(endpointType, endpointName, endpointTarget)

const resourcesToCreate: ResourcesToCreate = {
endpoints: {
[endpointName]: endpointStructure,
},
}

return await this.saveConfiguration(projectID, refID, resourcesToCreate)
}

async getConfiguration (prjID: string, refID: string): Promise<RetrievedConfiguration> {
const ft = await this.#featureFlagsClient.getToggles(prjID, [ ENABLE_ENVIRONMENT_BASED_CONFIGURATION_MANAGEMENT ])
if (ft[ENABLE_ENVIRONMENT_BASED_CONFIGURATION_MANAGEMENT] || false) {
Expand Down Expand Up @@ -409,6 +434,274 @@ export class APIClient implements IAPIClient {
return resourcesToCreate
}

#buildEndpointStructure (
endpointType: 'custom' | 'crud',
endpointName: string,
endpointTarget: string,
): Record<string, unknown> {
if (endpointType === 'custom') {
return {
basePath: `/${endpointName}`,
type: 'custom',
public: false,
showInDocumentation: true,
secreted: false,
acl: 'true',
service: endpointTarget,
port: '80',
pathRewrite: '/',
description: `Endpoint /${endpointName}`,
tags: [ endpointTarget ],
backofficeAcl: {
inherited: true,
},
allowUnknownRequestContentType: false,
allowUnknownResponseContentType: false,
forceMicroserviceGatewayProxy: false,
listeners: {
frontend: true,
},
useDownstreamProtocol: true,
}
} else {
// CRUD endpoint
return {
basePath: `/${endpointName}`,
pathName: '/',
pathRewrite: `/${endpointName}`,
type: 'crud',
tags: [ 'crud' ],
description: `Endpoint /${endpointTarget}`,
collectionId: endpointTarget,
public: true,
secreted: false,
showInDocumentation: true,
acl: 'true',
backofficeAcl: {
inherited: true,
},
allowUnknownRequestContentType: false,
allowUnknownResponseContentType: false,
forceMicroserviceGatewayProxy: false,
routes: {
'GET/': {
id: 'GET/',
verb: 'GET',
path: '/',
public: { inherited: true },
secreted: { inherited: true },
showInDocumentation: { inherited: true },
acl: { inherited: true },
backofficeAcl: { inherited: true },
rateLimit: { inherited: true },
allowUnknownRequestContentType: { inherited: true },
allowUnknownResponseContentType: { inherited: true },
preDecorators: [],
postDecorators: [],
},
'POST/': {
id: 'POST/',
verb: 'POST',
path: '/',
public: { inherited: true },
secreted: { inherited: true },
showInDocumentation: { inherited: true },
acl: { inherited: true },
backofficeAcl: { inherited: true },
rateLimit: { inherited: true },
allowUnknownRequestContentType: { inherited: true },
allowUnknownResponseContentType: { inherited: true },
preDecorators: [],
postDecorators: [],
},
'GET/export': {
id: 'GET/export',
verb: 'GET',
path: '/export',
public: { inherited: true },
secreted: { inherited: true },
showInDocumentation: { inherited: true },
acl: { inherited: true },
backofficeAcl: { inherited: true },
rateLimit: { inherited: true },
allowUnknownRequestContentType: { inherited: true },
allowUnknownResponseContentType: { inherited: false, value: true },
preDecorators: [],
postDecorators: [],
},
'GET/:id': {
id: 'GET/:id',
verb: 'GET',
path: '/:id',
public: { inherited: true },
secreted: { inherited: true },
showInDocumentation: { inherited: true },
acl: { inherited: true },
backofficeAcl: { inherited: true },
rateLimit: { inherited: true },
allowUnknownRequestContentType: { inherited: true },
allowUnknownResponseContentType: { inherited: true },
preDecorators: [],
postDecorators: [],
},
'DELETE/:id': {
id: 'DELETE/:id',
verb: 'DELETE',
path: '/:id',
public: { inherited: true },
secreted: { inherited: true },
showInDocumentation: { inherited: true },
acl: { inherited: true },
backofficeAcl: { inherited: true },
rateLimit: { inherited: true },
allowUnknownRequestContentType: { inherited: true },
allowUnknownResponseContentType: { inherited: true },
preDecorators: [],
postDecorators: [],
},
'DELETE/': {
id: 'DELETE/',
verb: 'DELETE',
path: '/',
public: { inherited: true },
secreted: { inherited: true },
showInDocumentation: { inherited: true },
acl: { inherited: true },
backofficeAcl: { inherited: true },
rateLimit: { inherited: true },
allowUnknownRequestContentType: { inherited: true },
allowUnknownResponseContentType: { inherited: true },
preDecorators: [],
postDecorators: [],
},
'PATCH/:id': {
id: 'PATCH/:id',
verb: 'PATCH',
path: '/:id',
public: { inherited: true },
secreted: { inherited: true },
showInDocumentation: { inherited: true },
acl: { inherited: true },
backofficeAcl: { inherited: true },
rateLimit: { inherited: true },
allowUnknownRequestContentType: { inherited: true },
allowUnknownResponseContentType: { inherited: true },
preDecorators: [],
postDecorators: [],
},
'PATCH/': {
id: 'PATCH/',
verb: 'PATCH',
path: '/',
public: { inherited: true },
secreted: { inherited: true },
showInDocumentation: { inherited: true },
acl: { inherited: true },
backofficeAcl: { inherited: true },
rateLimit: { inherited: true },
allowUnknownRequestContentType: { inherited: true },
allowUnknownResponseContentType: { inherited: true },
preDecorators: [],
postDecorators: [],
},
'GET/count': {
id: 'GET/count',
verb: 'GET',
path: '/count',
public: { inherited: true },
secreted: { inherited: true },
showInDocumentation: { inherited: true },
acl: { inherited: true },
backofficeAcl: { inherited: true },
rateLimit: { inherited: true },
allowUnknownRequestContentType: { inherited: true },
allowUnknownResponseContentType: { inherited: true },
preDecorators: [],
postDecorators: [],
},
'POST/bulk': {
id: 'POST/bulk',
verb: 'POST',
path: '/bulk',
public: { inherited: true },
secreted: { inherited: true },
showInDocumentation: { inherited: true },
acl: { inherited: true },
backofficeAcl: { inherited: true },
rateLimit: { inherited: true },
allowUnknownRequestContentType: { inherited: true },
allowUnknownResponseContentType: { inherited: true },
preDecorators: [],
postDecorators: [],
},
'POST/upsert-one': {
id: 'POST/upsert-one',
verb: 'POST',
path: '/upsert-one',
public: { inherited: true },
secreted: { inherited: true },
showInDocumentation: { inherited: true },
acl: { inherited: true },
backofficeAcl: { inherited: true },
rateLimit: { inherited: true },
allowUnknownRequestContentType: { inherited: true },
allowUnknownResponseContentType: { inherited: true },
preDecorators: [],
postDecorators: [],
},
'PATCH/bulk': {
id: 'PATCH/bulk',
verb: 'PATCH',
path: '/bulk',
public: { inherited: true },
secreted: { inherited: true },
showInDocumentation: { inherited: true },
acl: { inherited: true },
backofficeAcl: { inherited: true },
rateLimit: { inherited: true },
allowUnknownRequestContentType: { inherited: true },
allowUnknownResponseContentType: { inherited: true },
preDecorators: [],
postDecorators: [],
},
'POST/:id/state': {
id: 'POST/:id/state',
verb: 'POST',
path: '/:id/state',
public: { inherited: true },
secreted: { inherited: true },
showInDocumentation: { inherited: true },
acl: { inherited: true },
backofficeAcl: { inherited: true },
rateLimit: { inherited: true },
allowUnknownRequestContentType: { inherited: true },
allowUnknownResponseContentType: { inherited: true },
preDecorators: [],
postDecorators: [],
},
'POST/state': {
id: 'POST/state',
verb: 'POST',
path: '/state',
public: { inherited: true },
secreted: { inherited: true },
showInDocumentation: { inherited: true },
acl: { inherited: true },
backofficeAcl: { inherited: true },
rateLimit: { inherited: true },
allowUnknownRequestContentType: { inherited: true },
allowUnknownResponseContentType: { inherited: true },
preDecorators: [],
postDecorators: [],
},
},
listeners: {
frontend: true,
},
}
}
}

async #serviceGitGroupPath (projectID: string, projectGitPath: string): Promise<string> {
const projectGroups = await this.#backendClient.projectGitProviderGroups(projectID, path.dirname(projectGitPath))
let groupName: string | undefined
Expand Down Expand Up @@ -505,6 +798,7 @@ export interface APIClientMockFunctions {
getConfigurationMockFn?: (projectId: string, refId: string) => Promise<RetrievedConfiguration>
saveConfigurationMockFn?: (projectId: string) => Promise<SaveResponse>
createServiceFromMarketplaceItemMockFn?: (projectID: string) => Promise<SaveResponse>
createEndpointsMockFn?: (projectID: string) => Promise<SaveResponse>
// #endregion

// #region Deploy Methods
Expand Down Expand Up @@ -673,6 +967,20 @@ export class APIClientMock implements IAPIClient {
return this.mocks.createServiceFromMarketplaceItemMockFn(projectID)
}

async createEndpoints (
projectID: string,
_refID: string,
_endpointType: 'custom' | 'crud',
_endpointName: string,
_endpointTarget: string,
): Promise<SaveResponse> {
if (!this.mocks.createEndpointsMockFn) {
throw new Error('createEndpointsMockFn not mocked')
}

return this.mocks.createEndpointsMockFn(projectID)
}

// #endregion

// #region Deploy Methods
Expand Down
Loading