Situation that defaultResolver did not meet my need

1

Recently I needed to return an custom error to my API requester but to do it I needed to implement my own resolver, the problem here is that my resolver is identical to defaultResolver, the unique difference is the error handler

2

I would like to return the error in my own pattern, e.g { message, code, stacktrace }, but i cant do it with defaultResolver because it forces to return a fix error format (result.err only)

Problem

In defaultResolver we are returning an userInputError every time the usecase return an Err, buuuuut my usecase can return an Err for many reasons that not includes the user input

defaultResolver.js

[...]
        const request = args2request(args, uc)
        const response = await uc.run(request)

        // eslint-disable-next-line no-console
        console.info(uc.auditTrail)

        /* I dont have another option to return an Err to my api-requester */
        if (response.isErr) throw new UserInputError(null, { invalidArgs: response.err })
        return response.ok
[...]

solution

defaultResolver.js

function defaultResolver(usecase, errorHandler) {
[...]
        const request = args2request(args, uc)
        const response = await uc.run(request)

        // eslint-disable-next-line no-console
        console.info(uc.auditTrail)

        /* using the await because if this function be async, we dont will problem with  */
        if(response.isErr && errorCallback) return await errorHandler(response.err)
         // I still believe we can remove this UserInputError but i'm not sure if this can broke others apps
        if (response.isErr) throw new UserInputError(null, { invalidArgs: response.err })
        return response.ok
[...]

my gql app

// it can be async or not
function errorHandler(err) {
     // here I'm free to handler MYYY errors like I need
      return new ApolloError(err.message, err.code, err.stackTrace)
}
const mutations = usecases.map(usecase => usecase2mutation(usecase, defaultResolver(usecase, errorHandler)))

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Problem

I'm trying to use usecase2mutation with an usecase that don't needs a response, but the usecase2mutation requires it

my usecase:

const useCase = ({ profileRepository }) =>
  usecase('Delete Profile', {
    request: { indexer: String },
 
    'Update the Profile': step(async ctx => {
      await profileRepository.delete(ctx.req.indexer)
      return Ok()
    })
  })

when I transform it usingusecase2mutation(usecase, defaultResolver(usecase) I got this error:

> [email protected] start /Users/italojs/dev/herbjs/herbs-cli/lab
> node src/index.js

/Users/italojs/dev/herbjs/herbs-cli/lab/node_modules/herbs2gql/src/usecase2type.js:14
        throw error
        ^

InvalidUseCase: {"response":[{"cantBeEmpty":true},{"cantBeNull":true}]}
    at usecase2type (/Users/italojs/dev/herbjs/herbs-cli/lab/node_modules/herbs2gql/src/usecase2type.js:10:23)
    at usecase2mutation (/Users/italojs/dev/herbjs/herbs-cli/lab/node_modules/herbs2gql/src/usecase2mutation.js:4:12)
    at /Users/italojs/dev/herbjs/herbs-cli/lab/src/infra/api/graphql/mutations.js:5:47
    at Array.map (<anonymous>)
    at Object.factory (/Users/italojs/dev/herbjs/herbs-cli/lab/src/infra/api/graphql/mutations.js:5:32)
    at Object.<anonymous> (/Users/italojs/dev/herbjs/herbs-cli/lab/src/infra/api/graphql/index.js:29:75)
    at Module._compile (internal/modules/cjs/loader.js:1063:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1092:10)
    at Module.load (internal/modules/cjs/loader.js:928:32)
    at Function.Module._load (internal/modules/cjs/loader.js:769:14) {
  invalidArgs: { response: [ { cantBeEmpty: true }, { cantBeNull: true } ] }
}

it says that my usecase needs an response type,I tried use null but I got the same error.

Solution

I believe we can create an scalar Void type by default into the default schema, so we can use it when a usecase return nothing.

Inside useCaseValidator we can remove the line 16 const responseValidation = validate(useCase.responseSchema, defaultValidator). So when we get a usecase without response type into usecaseResponse2gql we can return Void

the final result will be somethinkg like

type Mutation {
  deleteProfile(indexer: string): Void
}

here we have an clear explanation about the solution https://stackoverflow.com/a/61714123

With the new release of Herbarium, herbs2gql can generate mutations, queries and types using it.

Instead of custom files (ex: mutations.js, queries.js, types.js) on the project, using Herbarium will be much simpler since it is a standardized way to access Herbs objects.

Instead of:
queries

const { usecase2query, defaultResolver } = require('@herbsjs/herbs2gql')
const { herbarium } = require('@herbsjs/herbarium')

const usecases = herbarium.usecases
    .findBy({ operation: [herbarium.crud.read, herbarium.crud.readAll] })
    .map(e => e.usecase)

const queries = usecases.map(usecase => usecase2query(usecase(), defaultResolver(usecase)))

/* Custom Queries */
// queries.push(require('./custom/getItems'))

module.exports = queries

it could be something like:

herbs2gql(herbarium)   // where `herbarium` constains all Herbs objects and its metadatas.

Is your feature request related to a problem? Please describe.
Improve Known Errors support for use case return.

Describe the solution you'd like
Handle Err.xxxx, aka known erros, and return the proper GQL error.

An issue has been identified with the function "requestFieldType2gql". This function takes an entity as a parameter, and if that entity extends BaseEntity, we append the string "Input" to the property type in GraphQL. For example:

mutation createUser(name: String, age: Number, Address: EntityAddressInput)

The relevant line of code can be found here.

However, when attempting to execute this operation, GraphQL fails to find the "Input" type, resulting in the following error:

Error: Unknown type "CustomerSubscriptionInput". Did you mean "CustomerSubscription"?

A preliminary solution could be to create Inputs for entities and also create an Input for request objects within usecases. However, this might not be the best approach, as we might end up creating Inputs that aren't necessary or that don't necessarily fit what's expected in a usecase's "request" field.

usecase('create user'
[...]
request: { 
 name: String
 age: Number,
 address: AddressEntity
}
[...]

For instance, in the usecase create user, where the request includes an entity-based field (e.g., address: AddressEntity), creating an Input for it solves the problem, but this Input would also include an "ID" field. This is a potential issue as we don't want the ID in the address field during user creation.

My proposed solution works for most scenarios, but not all. The suggestion is to proceed with this preliminary solution for the beta release and open up a discussion for a more definitive solution.

Problem:
In the application of VxNotification of resolvers' names are written in the format where the first letter of each word is capitalized, the first letter every word
SendWebHook
Herbal2gql returns in a sendWebHook camel case, this way we will have to change several applications that consume the notification

Proposed Solution
The solution at first would be to be able to optionally provide the name that could be returned together, or keep writing and not perform a conversion for the camel case

An error is currently occurring when converting an entity and your name has spaces.
For exemple:

Gotu entity:

Error:

Entity Converted:

Describe the bug
When I use a entity as a field of another entity, for some reason it threw an Unknow type error.

To Reproduce
Create an entity
Import this entity into another entity
Use this imported entity as a field

example:

const { field, entity } = require('@herbsjs/herbs')
const B = require('../entities')

const A = entity("A", {
    B: field(B)
})

module.exports = A

Update the entities index

example:

module.exports = {
    A: require('./A'),
    B: require('./B')
}

Check the log when you run the application

Expected behavior
Graphql should create type and input without error

Screenshots

Apollo Server 3 has significant changes in the implementation of graphql api structure.

Is your feature request related to a problem? Please describe.
Since the new version of graphql was released, should be good to maintain the library up-to-date with this dependency

Additional context
16.x is has a few breaking changes, so a full test run should occur (https://github.com/graphql/graphql-js/releases/tag/v16.0.0)

Is your feature request related to a problem? Please describe.
Some dependencies of the lib like ( graphql, apollo etc) are listed as devDependencies, but are a peerDependencies as well (https://nodejs.org/es/blog/npm/peer-dependencies/) and should be added in this section too

Describe the solution you'd like
Like herbs2knex(https://github.com/herbsjs/herbs2knex/blob/master/package.json) the lib should list the peer dependency