Thanks to visit codestin.com
Credit goes to github.com

Skip to content

generate error sets #57

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

Merged
merged 6 commits into from
Sep 18, 2023
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
2 changes: 1 addition & 1 deletion conformance/ts/src/conformanceApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/* eslint-disable */

import { HttpClientUtility, IServiceResult, IHttpClientOptions } from 'facility-core';
import { IConformanceApi, IGetApiInfoRequest, IGetApiInfoResponse, IGetWidgetsRequest, IGetWidgetsResponse, ICreateWidgetRequest, ICreateWidgetResponse, IGetWidgetRequest, IGetWidgetResponse, IDeleteWidgetRequest, IDeleteWidgetResponse, IGetWidgetBatchRequest, IGetWidgetBatchResponse, IMirrorFieldsRequest, IMirrorFieldsResponse, ICheckQueryRequest, ICheckQueryResponse, ICheckPathRequest, ICheckPathResponse, IMirrorHeadersRequest, IMirrorHeadersResponse, IMixedRequest, IMixedResponse, IRequiredRequest, IRequiredResponse, IMirrorBytesRequest, IMirrorBytesResponse, IMirrorTextRequest, IMirrorTextResponse, IBodyTypesRequest, IBodyTypesResponse, IWidget, IAny, IAnyArray, IAnyMap, IAnyResult, IAnyNullable, IHasWidget, Answer } from './conformanceApiTypes';
import { IConformanceApi, IGetApiInfoRequest, IGetApiInfoResponse, IGetWidgetsRequest, IGetWidgetsResponse, ICreateWidgetRequest, ICreateWidgetResponse, IGetWidgetRequest, IGetWidgetResponse, IDeleteWidgetRequest, IDeleteWidgetResponse, IGetWidgetBatchRequest, IGetWidgetBatchResponse, IMirrorFieldsRequest, IMirrorFieldsResponse, ICheckQueryRequest, ICheckQueryResponse, ICheckPathRequest, ICheckPathResponse, IMirrorHeadersRequest, IMirrorHeadersResponse, IMixedRequest, IMixedResponse, IRequiredRequest, IRequiredResponse, IMirrorBytesRequest, IMirrorBytesResponse, IMirrorTextRequest, IMirrorTextResponse, IBodyTypesRequest, IBodyTypesResponse, IWidget, IAny, IAnyArray, IAnyMap, IAnyResult, IAnyNullable, IHasWidget, Answer, ApiErrors } from './conformanceApiTypes';
export * from './conformanceApiTypes';

/** Provides access to ConformanceApi over HTTP via fetch. */
Expand Down
9 changes: 9 additions & 0 deletions conformance/ts/src/conformanceApiTypes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -515,3 +515,12 @@ export enum Answer {
maybe = 'maybe',
}

/** Custom errors. */
export enum ApiErrors {
/** The user is not an administrator. */
NotAdmin = 'NotAdmin',

/** I'm "too" 😄! */
TooHappy = 'TooHappy',
}

1 change: 1 addition & 0 deletions example/js/exampleApiServer.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ const standardErrorCodes = {
'TooManyRequests': 429,
'InternalError': 500,
'ServiceUnavailable': 503,
'NotAdmin': 403,
};

function parseBoolean(value) {
Expand Down
2 changes: 1 addition & 1 deletion example/ts/src/exampleApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/* eslint-disable */

import { HttpClientUtility, IServiceResult, IHttpClientOptions } from 'facility-core';
import { IExampleApi, IGetWidgetsRequest, IGetWidgetsResponse, ICreateWidgetRequest, ICreateWidgetResponse, IGetWidgetRequest, IGetWidgetResponse, IDeleteWidgetRequest, IDeleteWidgetResponse, IEditWidgetRequest, IEditWidgetResponse, IGetWidgetBatchRequest, IGetWidgetBatchResponse, IGetWidgetWeightRequest, IGetWidgetWeightResponse, IGetPreferenceRequest, IGetPreferenceResponse, ISetPreferenceRequest, ISetPreferenceResponse, IGetInfoRequest, IGetInfoResponse, INotRestfulRequest, INotRestfulResponse, IKitchenRequest, IKitchenResponse, IWidget, IWidgetJob, IPreference, IObsoleteData, IKitchenSink, WidgetField, ObsoleteEnum } from './exampleApiTypes';
import { IExampleApi, IGetWidgetsRequest, IGetWidgetsResponse, ICreateWidgetRequest, ICreateWidgetResponse, IGetWidgetRequest, IGetWidgetResponse, IDeleteWidgetRequest, IDeleteWidgetResponse, IEditWidgetRequest, IEditWidgetResponse, IGetWidgetBatchRequest, IGetWidgetBatchResponse, IGetWidgetWeightRequest, IGetWidgetWeightResponse, IGetPreferenceRequest, IGetPreferenceResponse, ISetPreferenceRequest, ISetPreferenceResponse, IGetInfoRequest, IGetInfoResponse, INotRestfulRequest, INotRestfulResponse, IKitchenRequest, IKitchenResponse, IWidget, IWidgetJob, IPreference, IObsoleteData, IKitchenSink, WidgetField, ObsoleteEnum, ExampleApiErrors } from './exampleApiTypes';
export * from './exampleApiTypes';

/** Provides access to ExampleApi over HTTP via fetch. */
Expand Down
3 changes: 2 additions & 1 deletion example/ts/src/exampleApiServer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import * as bodyParser from 'body-parser';
import * as express from 'express';
import { IServiceResult } from 'facility-core';
import { IExampleApi, IGetWidgetsRequest, IGetWidgetsResponse, ICreateWidgetRequest, ICreateWidgetResponse, IGetWidgetRequest, IGetWidgetResponse, IDeleteWidgetRequest, IDeleteWidgetResponse, IEditWidgetRequest, IEditWidgetResponse, IGetWidgetBatchRequest, IGetWidgetBatchResponse, IGetWidgetWeightRequest, IGetWidgetWeightResponse, IGetPreferenceRequest, IGetPreferenceResponse, ISetPreferenceRequest, ISetPreferenceResponse, IGetInfoRequest, IGetInfoResponse, INotRestfulRequest, INotRestfulResponse, IKitchenRequest, IKitchenResponse, IWidget, IWidgetJob, IPreference, IObsoleteData, IKitchenSink, WidgetField, ObsoleteEnum } from './exampleApiTypes';
import { IExampleApi, IGetWidgetsRequest, IGetWidgetsResponse, ICreateWidgetRequest, ICreateWidgetResponse, IGetWidgetRequest, IGetWidgetResponse, IDeleteWidgetRequest, IDeleteWidgetResponse, IEditWidgetRequest, IEditWidgetResponse, IGetWidgetBatchRequest, IGetWidgetBatchResponse, IGetWidgetWeightRequest, IGetWidgetWeightResponse, IGetPreferenceRequest, IGetPreferenceResponse, ISetPreferenceRequest, ISetPreferenceResponse, IGetInfoRequest, IGetInfoResponse, INotRestfulRequest, INotRestfulResponse, IKitchenRequest, IKitchenResponse, IWidget, IWidgetJob, IPreference, IObsoleteData, IKitchenSink, WidgetField, ObsoleteEnum, ExampleApiErrors } from './exampleApiTypes';
export * from './exampleApiTypes';

const standardErrorCodes: { [code: string]: number } = {
Expand All @@ -18,6 +18,7 @@ const standardErrorCodes: { [code: string]: number } = {
'TooManyRequests': 429,
'InternalError': 500,
'ServiceUnavailable': 503,
'NotAdmin': 403,
};

function parseBoolean(value: string | undefined) {
Expand Down
6 changes: 6 additions & 0 deletions example/ts/src/exampleApiTypes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -350,3 +350,9 @@ export enum ObsoleteEnum {
unused = 'unused',
}

/** Custom errors. */
export enum ExampleApiErrors {
/** The user is not an administrator. */
NotAdmin = 'NotAdmin',
}

24 changes: 24 additions & 0 deletions src/Facility.CodeGen.JavaScript/JavaScriptGenerator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,22 @@ public override CodeGenOutput GenerateOutput(ServiceInfo service)
}
}

foreach (var errorSetInfo in service.ErrorSets)
{
typeNames.Add(errorSetInfo.Name);
code.WriteLine();
WriteJsDoc(code, errorSetInfo);
using (code.Block($"export enum {errorSetInfo.Name} {{", "}"))
{
foreach (var error in errorSetInfo.Errors)
{
code.WriteLineSkipOnce();
WriteJsDoc(code, error);
code.WriteLine($"{error.Name} = '{error.Name}',");
}
}
}

code.WriteLine();
}));
}
Expand Down Expand Up @@ -440,6 +456,14 @@ public override CodeGenOutput GenerateOutput(ServiceInfo service)
code.WriteLine("'TooManyRequests': 429,");
code.WriteLine("'InternalError': 500,");
code.WriteLine("'ServiceUnavailable': 503,");

foreach (var errorSetInfo in httpServiceInfo.ErrorSets)
{
foreach (var error in errorSetInfo.Errors)
{
code.WriteLine($"'{error.ServiceError.Name}': {(int) error.StatusCode},");
}
}
}

// TODO: export this from facility-core?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,37 @@ public void GenerateExampleApiTypeScript_ExternEnumNameIsSameAsAlias()
StringAssert.Contains("thing?: Thing;", typesFile.Text);
}

[Test]
public void GenerateExampleApiTypeScript_IncludesErrorSets()
{
ServiceInfo service;
const string fileName = "Facility.CodeGen.JavaScript.UnitTests.ExampleApi.fsd";
var parser = new FsdParser();
var stream = GetType().GetTypeInfo().Assembly.GetManifestResourceStream(fileName)!;
Assert.IsNotNull(stream);
using (var reader = new StreamReader(stream))
service = parser.ParseDefinition(new ServiceDefinitionText(Path.GetFileName(fileName), reader.ReadToEnd()));

var generator = new JavaScriptGenerator
{
GeneratorName = "JavaScriptGeneratorTests",
TypeScript = true,
NewLine = "\n",
};
var result = generator.GenerateOutput(service);
Assert.IsNotNull(result);

var typesFile = result.Files.Single(f => f.Name == "exampleApiTypes.ts");
const string expectedErrorSet = """
/** Custom errors. */
export enum ExampleApiErrors {
/** The user is not an administrator. */
NotAdmin = 'NotAdmin',
}
""";
Assert.That(typesFile.Text, Contains.Substring(expectedErrorSet));
}

private void ThrowsServiceDefinitionException(string definition, string message)
{
var parser = new FsdParser();
Expand Down