Examples with ErrorDefinition com.palantir.conjure.spec.ErrorDefinition used on opensource projects

Example 1 with ErrorDefinition

use of com.palantir.conjure.spec.ErrorDefinition in project conjure-java by palantir.

the class ErrorGenerator method generateErrorTypesForNamespace.

private static JavaFile generateErrorTypesForNamespace(TypeMapper typeMapper, String conjurePackage, ErrorNamespace namespace, List<ErrorDefinition> errorTypeDefinitions) {
    ClassName className = errorTypesClassName(conjurePackage, namespace);
    // Generate ErrorType definitions
    List<FieldSpec> fieldSpecs = errorTypeDefinitions.stream().map(errorDef -> {
        CodeBlock initializer = CodeBlock.of("ErrorType.create(ErrorType.Code.$L, \"$L:$L\")", errorDef.getCode().get(), namespace.get(), errorDef.getErrorName().getName());
        FieldSpec.Builder fieldSpecBuilder = FieldSpec.builder(ClassName.get(ErrorType.class), CaseFormat.UPPER_CAMEL.to(CaseFormat.UPPER_UNDERSCORE, errorDef.getErrorName().getName()), Modifier.PUBLIC, Modifier.STATIC, Modifier.FINAL).initializer(initializer);
        errorDef.getDocs().ifPresent(docs -> fieldSpecBuilder.addJavadoc(docs.get()));
        return fieldSpecBuilder.build();
    }).collect(Collectors.toList());
    // Generate ServiceException factory methods
    List<MethodSpec> methodSpecs = errorTypeDefinitions.stream().flatMap(entry -> {
        MethodSpec withoutCause = generateExceptionFactory(typeMapper, entry, false);
        MethodSpec withCause = generateExceptionFactory(typeMapper, entry, true);
        return Stream.of(withoutCause, withCause);
    }).collect(Collectors.toList());
    // Generate ServiceException factory check methods
    List<MethodSpec> checkMethodSpecs = errorTypeDefinitions.stream().map(entry -> {
        String exceptionMethodName = CaseFormat.UPPER_CAMEL.to(CaseFormat.LOWER_CAMEL, entry.getErrorName().getName());
        String methodName = "throwIf" + entry.getErrorName().getName();
        String shouldThrowVar = "shouldThrow";
        MethodSpec.Builder methodBuilder = MethodSpec.methodBuilder(methodName).addModifiers(Modifier.PUBLIC, Modifier.STATIC).addParameter(TypeName.BOOLEAN, shouldThrowVar);
        methodBuilder.addJavadoc("Throws a {@link ServiceException} of type $L when {@code $L} is true.\n", entry.getErrorName().getName(), shouldThrowVar);
        methodBuilder.addJavadoc("@param $L $L\n", shouldThrowVar, "Cause the method to throw when true");
        Streams.concat(entry.getSafeArgs().stream(), entry.getUnsafeArgs().stream()).forEach(arg -> {
            methodBuilder.addParameter(typeMapper.getClassName(arg.getType()), arg.getFieldName().get());
            methodBuilder.addJavadoc("@param $L $L", arg.getFieldName().get(), StringUtils.appendIfMissing(arg.getDocs().map(Javadoc::render).orElse(""), "\n"));
        });
        methodBuilder.addCode("if ($L) {", shouldThrowVar);
        methodBuilder.addCode("throw $L;", Expressions.localMethodCall(exceptionMethodName, Streams.concat(entry.getSafeArgs().stream(), entry.getUnsafeArgs().stream()).map(arg -> arg.getFieldName().get()).collect(Collectors.toList())));
        methodBuilder.addCode("}");
        return methodBuilder.build();
    }).collect(Collectors.toList());
    List<MethodSpec> isRemoteExceptionDefinitions = errorTypeDefinitions.stream().map(entry -> {
        String typeName = CaseFormat.UPPER_CAMEL.to(CaseFormat.UPPER_UNDERSCORE, entry.getErrorName().getName());
        String methodName = "is" + entry.getErrorName().getName();
        return MethodSpec.methodBuilder(methodName).addModifiers(Modifier.PUBLIC, Modifier.STATIC).addParameter(RemoteException.class, REMOTE_EXCEPTION_VAR).returns(TypeName.BOOLEAN).addStatement(Expressions.requireNonNull(REMOTE_EXCEPTION_VAR, "remote exception must not be null")).addStatement("return $N.name().equals($N.getError().errorName())", typeName, REMOTE_EXCEPTION_VAR).addJavadoc("Returns true if the {@link $T} is named $L:$L", RemoteException.class, entry.getNamespace(), entry.getErrorName().getName()).build();
    }).collect(Collectors.toList());
    TypeSpec.Builder typeBuilder = TypeSpec.classBuilder(className).addMethod(privateConstructor()).addModifiers(Modifier.PUBLIC, Modifier.FINAL).addFields(fieldSpecs).addMethods(methodSpecs).addMethods(checkMethodSpecs).addMethods(isRemoteExceptionDefinitions).addAnnotation(ConjureAnnotations.getConjureGeneratedAnnotation(ErrorGenerator.class));
    return JavaFile.builder(conjurePackage, typeBuilder.build()).skipJavaLangImports(true).indent("    ").build();
}

Example 2 with ErrorDefinition

use of com.palantir.conjure.spec.ErrorDefinition in project conjure by palantir.

the class ConjureParserUtils method parseConjureDef.

static ConjureDefinition parseConjureDef(Map<String, AnnotatedConjureSourceFile> annotatedParsedDefs) {
    ImmutableList.Builder<ServiceDefinition> servicesBuilder = ImmutableList.builder();
    ImmutableList.Builder<ErrorDefinition> errorsBuilder = ImmutableList.builder();
    ImmutableList.Builder<TypeDefinition> typesBuilder = ImmutableList.builder();
    annotatedParsedDefs.values().forEach(annotatedParsed -> {
        ConjureSourceFile parsed = annotatedParsed.conjureSourceFile();
        try {
            ConjureTypeParserVisitor.ReferenceTypeResolver typeResolver = new ConjureTypeParserVisitor.ByParsedRepresentationTypeNameResolver(parsed.types(), annotatedParsed.importProviders(), annotatedParsedDefs);
            // Resolve objects first, so we can use them in service validations
            Map<TypeName, TypeDefinition> objects = parseObjects(parsed.types(), typeResolver);
            Map<TypeName, TypeDefinition> importedObjects = parseImportObjects(parsed.types().conjureImports(), annotatedParsedDefs);
            Map<TypeName, TypeDefinition> allObjects = new HashMap<>();
            allObjects.putAll(objects);
            allObjects.putAll(importedObjects);
            DealiasingTypeVisitor dealiasingVisitor = new DealiasingTypeVisitor(allObjects);
            parsed.services().forEach((serviceName, service) -> {
                servicesBuilder.add(parseService(service, TypeName.of(serviceName.name(), parseConjurePackage(service.conjurePackage())), typeResolver, dealiasingVisitor));
            });
            typesBuilder.addAll(objects.values());
            errorsBuilder.addAll(parseErrors(parsed.types().definitions(), typeResolver));
        } catch (RuntimeException e) {
            throw new ConjureRuntimeException(String.format("Encountered error trying to parse file '%s'", annotatedParsed.sourceFile()), e);
        }
    });
    ConjureDefinition definition = ConjureDefinition.builder().version(Conjure.SUPPORTED_IR_VERSION).types(typesBuilder.build()).errors(errorsBuilder.build()).services(servicesBuilder.build()).build();
    ConjureDefinitionValidator.validateAll(definition);
    return definition;
}

Example 3 with ErrorDefinition

use of com.palantir.conjure.spec.ErrorDefinition in project conjure by palantir.

the class ConjureParserUtils method parseErrorType.

public static ErrorDefinition parseErrorType(TypeName name, com.palantir.conjure.parser.types.complex.ErrorTypeDefinition def, ConjureTypeParserVisitor.ReferenceTypeResolver typeResolver) {
    ErrorDefinition errorType = ErrorDefinition.builder().errorName(name).namespace(ErrorNamespace.of(def.namespace().name())).code(def.code().asSpecErrorCode()).safeArgs(parseField(def.safeArgs(), typeResolver)).unsafeArgs(parseField(def.unsafeArgs(), typeResolver)).docs(def.docs().map(Documentation::of)).build();
    ErrorDefinitionValidator.validate(errorType);
    return errorType;
}

Example 4 with ErrorDefinition

use of com.palantir.conjure.spec.ErrorDefinition in project conjure by palantir.

the class ConjureParserUtils method parseErrors.

static List<ErrorDefinition> parseErrors(NamedTypesDefinition defs, ConjureTypeParserVisitor.ReferenceTypeResolver typeResolver) {
    Optional<String> defaultPackage = defs.defaultConjurePackage().map(ConjurePackage::name);
    ImmutableList.Builder<ErrorDefinition> errorsBuidler = ImmutableList.builder();
    errorsBuidler.addAll(defs.errors().entrySet().stream().map(entry -> {
        TypeName typeName = TypeName.of(entry.getKey().name(), parsePackageOrElseThrow(entry.getValue().conjurePackage(), defaultPackage));
        return parseErrorType(typeName, entry.getValue(), typeResolver);
    }).collect(Collectors.toList()));
    return errorsBuidler.build();
}

Example 5 with ErrorDefinition

use of com.palantir.conjure.spec.ErrorDefinition in project conjure by palantir.

the class ConjureParserUtils method parseConjureDef.

static ConjureDefinition parseConjureDef(Map<String, AnnotatedConjureSourceFile> annotatedParsedDefs, SafetyDeclarationRequirements safetyDeclarations) {
    ImmutableList.Builder<ServiceDefinition> servicesBuilder = ImmutableList.builder();
    ImmutableList.Builder<ErrorDefinition> errorsBuilder = ImmutableList.builder();
    ImmutableList.Builder<TypeDefinition> typesBuilder = ImmutableList.builder();
    annotatedParsedDefs.values().forEach(annotatedParsed -> {
        ConjureSourceFile parsed = annotatedParsed.conjureSourceFile();
        try {
            ConjureTypeParserVisitor.ReferenceTypeResolver typeResolver = new ConjureTypeParserVisitor.ByParsedRepresentationTypeNameResolver(parsed.types(), annotatedParsed.importProviders(), annotatedParsedDefs);
            // Resolve objects first, so we can use them in service validations
            Map<TypeName, TypeDefinition> objects = parseObjects(parsed.types(), typeResolver);
            Map<TypeName, TypeDefinition> importedObjects = parseImportObjects(parsed.types().conjureImports(), annotatedParsedDefs);
            Map<TypeName, TypeDefinition> allObjects = new HashMap<>();
            allObjects.putAll(objects);
            allObjects.putAll(importedObjects);
            DealiasingTypeVisitor dealiasingVisitor = new DealiasingTypeVisitor(allObjects);
            parsed.services().forEach((serviceName, service) -> {
                servicesBuilder.add(parseService(service, TypeName.of(serviceName.name(), parseConjurePackage(service.conjurePackage())), typeResolver, dealiasingVisitor));
            });
            typesBuilder.addAll(objects.values());
            errorsBuilder.addAll(parseErrors(parsed.types().definitions(), typeResolver));
        } catch (RuntimeException e) {
            throw new ConjureRuntimeException(String.format("Encountered error trying to parse file '%s'", annotatedParsed.sourceFile()), e);
        }
    });
    ConjureDefinition definition = ConjureDefinition.builder().version(Conjure.SUPPORTED_IR_VERSION).types(typesBuilder.build()).errors(errorsBuilder.build()).services(servicesBuilder.build()).build();
    ConjureDefinitionValidator.validateAll(definition, safetyDeclarations);
    return definition;
}