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

chore: re-use the same client schema for proxy #3251

Merged
merged 2 commits into from Mar 3, 2023
Merged

chore: re-use the same client schema for proxy #3251

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
282f452
chore: re-use the same client schema for proxy
gastonfournier Mar 3, 2023
20b03d5
Remove proxy-metrics-schema in favor of client-metrics-schema
gastonfournier Mar 3, 2023
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
2 changes: 0 additions & 2 deletions src/lib/openapi/index.ts
View file
Open in desktop
Expand Up @@ -82,7 +82,6 @@ import {
proxyClientSchema,
proxyFeatureSchema,
proxyFeaturesSchema,
proxyMetricsSchema,
publicSignupTokenCreateSchema,
projectStatsSchema,
publicSignupTokenSchema,
Expand Down Expand Up @@ -230,7 +229,6 @@ export const schemas = {
proxyClientSchema,
proxyFeatureSchema,
proxyFeaturesSchema,
proxyMetricsSchema,
publicSignupTokenCreateSchema,
publicSignupTokenSchema,
publicSignupTokensSchema,
Expand Down
30 changes: 7 additions & 23 deletions src/lib/openapi/spec/client-metrics-schema.ts
View file
Open in desktop
Expand Up @@ -6,25 +6,15 @@ export const clientMetricsSchema = {
type: 'object',
required: ['appName', 'bucket'],
properties: {
appName: {
type: 'string',
},
instanceId: {
type: 'string',
},
environment: {
type: 'string',
},
appName: { type: 'string' },
instanceId: { type: 'string' },
environment: { type: 'string' },
bucket: {
type: 'object',
required: ['start', 'stop', 'toggles'],
properties: {
start: {
$ref: '#/components/schemas/dateSchema',
},
stop: {
$ref: '#/components/schemas/dateSchema',
},
start: { $ref: '#/components/schemas/dateSchema' },
stop: { $ref: '#/components/schemas/dateSchema' },
toggles: {
type: 'object',
example: {
Expand All @@ -45,14 +35,8 @@ export const clientMetricsSchema = {
additionalProperties: {
type: 'object',
properties: {
yes: {
type: 'integer',
minimum: 0,
},
no: {
type: 'integer',
minimum: 0,
},
yes: { type: 'integer', minimum: 0 },
no: { type: 'integer', minimum: 0 },
variants: {
type: 'object',
additionalProperties: {
Expand Down
1 change: 0 additions & 1 deletion src/lib/openapi/spec/index.ts
View file
Open in desktop
Expand Up @@ -66,7 +66,6 @@ export * from './feature-types-schema';
export * from './feature-usage-schema';
export * from './health-report-schema';
export * from './proxy-feature-schema';
export * from './proxy-metrics-schema';
export * from './search-events-schema';
export * from './set-ui-config-schema';
export * from './client-feature-schema';
Expand Down
55 changes: 0 additions & 55 deletions src/lib/openapi/spec/proxy-metrics-schema.ts
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions src/lib/routes/proxy-api/index.ts
View file
Open in desktop
Expand Up @@ -9,13 +9,13 @@ import {
import { Logger } from '../../logger';
import ApiUser from '../../types/api-user';
import {
ClientMetricsSchema,
createRequestSchema,
createResponseSchema,
emptyResponse,
ProxyClientSchema,
proxyFeaturesSchema,
ProxyFeaturesSchema,
ProxyMetricsSchema,
} from '../../openapi';
import { Context } from 'unleash-client';
import { enrichContextWithIp } from '../../proxy';
Expand Down Expand Up @@ -95,7 +95,7 @@ export default class ProxyController extends Controller {
this.services.openApiService.validPath({
tags: ['Frontend API'],
operationId: 'registerFrontendMetrics',
requestBody: createRequestSchema('proxyMetricsSchema'),
requestBody: createRequestSchema('clientMetricsSchema'),
responses: { 200: emptyResponse },
}),
],
Expand Down Expand Up @@ -168,7 +168,7 @@ export default class ProxyController extends Controller {
}

private async registerProxyMetrics(
req: ApiUserRequest<unknown, unknown, ProxyMetricsSchema>,
req: ApiUserRequest<unknown, unknown, ClientMetricsSchema>,
res: Response,
) {
await this.services.proxyService.registerProxyMetrics(
Expand Down
4 changes: 2 additions & 2 deletions src/lib/services/proxy-service.ts
View file
Open in desktop
@@ -1,6 +1,6 @@
import { IUnleashConfig, IUnleashServices, IUnleashStores } from '../types';
import { Logger } from '../logger';
import { ProxyFeatureSchema, ProxyMetricsSchema } from '../openapi';
import { ClientMetricsSchema, ProxyFeatureSchema } from '../openapi';
import ApiUser from '../types/api-user';
import {
Context,
Expand Down Expand Up @@ -94,7 +94,7 @@ export class ProxyService {

async registerProxyMetrics(
token: ApiUser,
metrics: ProxyMetricsSchema,
metrics: ClientMetricsSchema,
ip: string,
): Promise<void> {
ProxyService.assertExpectedTokenType(token);
Expand Down
75 changes: 0 additions & 75 deletions src/test/e2e/api/openapi/__snapshots__/openapi.e2e.test.ts.snap
View file
Open in desktop
Expand Up @@ -3027,81 +3027,6 @@ Stats are divided into current and previous **windows**.
],
"type": "object",
},
"proxyMetricsSchema": {
"properties": {
"appName": {
"type": "string",
},
"bucket": {
"properties": {
"start": {
"format": "date-time",
"type": "string",
},
"stop": {
"format": "date-time",
"type": "string",
},
"toggles": {
"additionalProperties": {
"properties": {
"no": {
"minimum": 0,
"type": "integer",
},
"variants": {
"additionalProperties": {
"minimum": 0,
"type": "integer",
},
"type": "object",
},
"yes": {
"minimum": 0,
"type": "integer",
},
},
"type": "object",
},
"example": {
"myCoolToggle": {
"no": 42,
"variants": {
"blue": 6,
"green": 15,
"red": 46,
},
"yes": 25,
},
"myOtherToggle": {
"no": 100,
"yes": 0,
},
},
"type": "object",
},
},
"required": [
"start",
"stop",
"toggles",
],
"type": "object",
},
"environment": {
"type": "string",
},
"instanceId": {
"type": "string",
},
},
"required": [
"appName",
"instanceId",
"bucket",
],
"type": "object",
},
"publicSignupTokenCreateSchema": {
"additionalProperties": false,
"properties": {
Expand Down