Bug: incorrect import path generation

[Boorj]

In writers/SingleMode.ts there's a part producing incorrect relative schemas path
Code here https://github.com/anymaniax/orval/blob/master/src/core/writers/singleMode.ts#L43

export const writeSingleMode = (...) {

// (1)
 const { path, dirname } = getFileInfo(
     join(workspace, targetedPath),
    camel(info.title),
  );

// (2)
const schemasPath = relative(dirname || '', output.schemas); // ←—— This line

What are the steps to reproduce this issue?

1. setup output with relative parts:

mode    : 'single',
target  : `../../openapi/orval-build/endpoints/openapi.ts`,
schemas : `../../openapi/orval-build/model`,

2. run build

What happens?

endpoints/openapi.ts output file will get incorrect import path:

from '..\..\..\..\..\openapi\orval-build\model'

What were you expecting to happen?

but expected to get from '../model';

Any other comments?

So we are getting 2 problems:

1. inverted slashes (OS separators could be straight or back slashes, but imports must not be backslash).
2. incorrect relative part.

The solution.

1. Slashes direction could be easily solved by adding .replace(/\\/g, '/');
2. When using relative(dirname || '', output.schemas);, dirname is already absolute path, processed with path.join ((1)). But output.schemas is still dirty input from config file (2). So the result is incorrect.
   Fix could look this way:

relative(dirname, join(workspace, output.schemas)).replace(/\\/g, '/');

---

What versions are you using?

Operating System: Win10
Node 14

[Boorj]

Btw, the same issue with slashes happens in project with relative paths in several places.
For example here: https://github.com/anymaniax/orval/blob/master/src/core/generators/mutator.ts#L13

[anymaniax]

Should be fixed with the 5.3.2. Thanks for the issue 🎉

[Boorj]

@anymaniax
btw, i will not create additional issue, but this line produces incorrect code if definition is undefined

https://github.com/anymaniax/orval/blob/master/src/core/generators/react-query.ts#L82

// fails
<Data extends unknown ? ${  response.definition  } : Data>

// better
const typing = response.definition 
    ? "<Data extends unknown ? " + response.definition + " : Data>" 
    : '';

[anymaniax]

Can you do a pull request to fix it please?

[anymaniax]

And if response.definition is falsy the value should be Data to have the generic type

[anymaniax]

If you don't have time I will do it tomorrow

[Boorj]

Sure, PR is on the run) Sorry, timezones lag )
Probably in next versions you can make some functions to do those name extractions consistently.

[Boorj]

Done. Also i feel like project heavily needs some refactoring to keep DRY-principle and consistency.
There's an utility here : https://github.com/anymaniax/orval/blob/master/src/utils/path.ts#L10 which provides safe relative path. I think that could be used consistently in all places. Also, all imports should be unified to correct slash, and it's missing in code, as i see (haven't check, how dependent utilities from import work).

[Boorj]

btw,

i'm re-writing some code at my side.

Looks like optional type of input and output brought tons of redundant code (typechecks, etc).
Isn't it easier to normalize type on start?

[anymaniax]

Be careful, it seems that you are not up to date with master

[anymaniax]

But otherwise, it's a good idea

[anymaniax]

For the relativeSafe util, it's used everywhere normally in the v5

[anymaniax]

And please, if you do some refactoring try to do small pull request. Like that we can easily discuss it.

[Boorj]

Sure (about tiny commits). And indeed, version was obsolete, sorry

[Boorj]

@anymaniax Also, Victor, some notes, non related

1. Library generates msw mocks based on faker, and then you can use them in browser as service worker with interceptor. Also node js could use the same interceptor. Actually, i haven't seen libraries for nodejs+openapi that provide customizable responses. Only based on type. Orval has at least regexp generator for customization. And, actually, that could be quite enough.
   How do you find next idea: generate mocks not as import {rest} from 'msw';, but to tweak output for use as configuration of express/koa/hapi server? You already have a parser, express uses almost the same signature.

2. Why don't you use templating? this code looks very neat.

[anymaniax]

@Boorj I already thought about it and it could be a really good feature. Maybe open a new issue first this one.

For point 2 at the beginning, this project was inspired by restful-react and he wasn't using templates. I also already thought about it but it's a big refactor. I maintain this in my free time and don't have a lot of time for this one. I always thought that there were more important changes to do than that one.

[anymaniax]

@Boorj can we close this one?

[Boorj]

@anymaniax yeah, sure. relativeSafe with 'upath' does the job. Thank you!

[Boorj]

Opening again. Encountered error:
https://github.com/anymaniax/orval/blob/master/src/core/generators/api.ts#L17

Getting specKey with forward slashes, and specs object has key with filename, containing backslashes.

like

specKey === 'c:/path/foo.json'
specs === { 'c:\path\foo.json\': ...}

[Vylda]

well, v. 6.11.0 has the same problem

[anymaniax]

Hello @Vylda, I am currently on it. it's the same as this one #725

[anymaniax]

Hello @Vylda, can you try if 6.11.1-alpha.1 is working for you

[Vylda]

Hello @anymaniax ,
I cant run orval correctly:
`npx orval --config orval.config.ts

🍻 Start orval v6.11.1-alpha.1 - A swagger client generator for typescript
node:internal/process/promises:279
triggerUncaughtException(err, true /* fromPromise */);
^

[UnhandledPromiseRejection: This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason "failed to load from C:/www/studentagency/orval.config.ts => TypeError: n is not a function".] {
code: 'ERR_UNHANDLED_REJECTION'
}`

[anymaniax]

check here #725 did an other alpha version to fix that

[Vylda]

6.11.1-alpha.2 looks fine, thank you.