Everything breaks after upgrading to version 1.0.0 #456

albertodiazdorado · 2023-11-08T09:51:30Z

Describe the bug

yarn upgrade @asyncapi/[email protected]
yarn build # works
yarn serve # works

yarn upgrade @asyncapi/html-template@latest
yarn add react@^17.0.2 # peer dependency
yarn build # works?
yarn serve # blank page

I think that the problem is that the generated index.html looks like this (notice shema = undefined):

    <body>
      <div id="root"></div>
  
      <script src="js/asyncapi-ui.min.js" type="application/javascript"></script>
  
      <script>
        const schema = undefined;
        const config = {"show":{"sidebar":true},"sidebar":{"showOperations":"byDefault"}};
        AsyncApiStandalone.hydrate({ schema, config }, document.getElementById("root"));
      </script>
    </body>

I use the generator like this:

import Generator from "@asyncapi/generator"; // Version 1.14.1

const main = async () => {
  const generator = new Generator(
    "@asyncapi/html-template",
    path.resolve(process.cwd(), `./dist`),
  );
  const yamlFile = await fsPromises.readFile(
    path.resolve(__dirname, "./api-config.yaml"),
    "utf-8",
  );
  await generator.generate(yamlFile);
};

main();

Do you have any idea on how to fix? Or how to migrate from version 0.x to 1.x? I could not find any migration guide.

The text was updated successfully, but these errors were encountered:

github-actions · 2023-11-08T09:51:46Z

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Traderjoe95 · 2023-11-09T12:51:25Z

I am experiencing the same issue when calling the generator through the asyncapi CLI

henhal · 2023-11-13T10:55:56Z

Same here. This was my first ever use of asyncapi, and it took me some time to realize that my HTML being blank wasn't due to me being an idiot. Even rendering the hello world sample resulted in a blank page.

I guess I had bad luck, getting my first impression of this tool from a completely broken version. 🤷
Works fine when I use @0.28.4.

zschumacher · 2023-11-14T21:12:21Z

Same for me, had to pin to 0.28.4

jonaslagoni · 2023-11-14T22:04:43Z

Can you folks provide the AsyncAPI document (or a way for us to reproduce it) that fails to be generated to html?

zschumacher · 2023-11-14T22:58:18Z

I cannot because it is proprietary but I can try to give some more info.

async api version -> 2.6.0
command to install cli -> npm install -g @asyncapi/cli
command to generate html -> asyncapi generate fromTemplate async-api.yml @asyncapi/html-template -o async_api_docs --force-write -p singleFile=true
my spec includes info, channels, channels/subscribe, channels/parameters, components, components/schemas, components/messages

henhal · 2023-11-15T06:17:13Z

@jonaslagoni I provided one in the linked issue - but even your own hello world from the docs can reproduce the issue. It's any document as far as I see.

jonaslagoni · 2023-11-15T20:45:20Z

What version of the CLI/generator do you folks use?

With CLI 0.60.1 and even 0.59.0 with the following AsyncAPI document: https://github.com/asyncapi/html-template/blob/master/test/spec/asyncapi_v2.yml It correctly generates the docs for me.

I tried with both local template and remote template, here is the commands I ran:

$ asyncapi generate fromTemplate ./test/spec/asyncapi_v2.yml ./ -o test/output --force-write
$ asyncapi generate fromTemplate ./test/spec/asyncapi_v2.yml @asyncapi/html-template -o test/output --force-write
$ asyncapi generate fromTemplate ./html-template/test/spec/asyncapi_v2.yml @asyncapi/html-template -o ./html-template/output --force-write

$ asyncapi --help
All in one CLI for all AsyncAPI tools

VERSION
  @asyncapi/cli/0.59.0 darwin-x64 node-v18.17.0

USAGE
  $ asyncapi [COMMAND]

TOPICS
  config    CLI config settings
  generate  Generate models and template
  new       Creates a new asyncapi file
  start     Start asyncapi studio

COMMANDS
  bundle    bundle one or multiple asyncapi documents and their references together.
  config    CLI config settings
  convert   Convert asyncapi documents older to newer versions
  diff      Find diff between two asyncapi files
  generate  Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates.
  new       Creates a new asyncapi file
  optimize  optimize asyncapi specification file
  start     Start asyncapi studio
  validate  validate asyncapi file

$ node -v
v18.17.0

smoya · 2023-11-16T10:51:01Z

I created a new repository that confirms something doesn't work as expected.

https://github.com/smoya/asyncapi-test-generation

Just clone the repo, run npm i && npm run start and you will have the output of both template versions in out/1.0.0 and out/0.28.4.
I confirm that opening the out/1.0.0/index.html shows a blank page. However the one from out/0.28.4 shows the documentation.

Traderjoe95 · 2023-11-16T16:32:58Z

AsyncAPI CLI 0.60.0 on Node 21.1.0/Windows

> asyncapi --help
All in one CLI for all AsyncAPI tools

VERSION
  @asyncapi/cli/0.60.0 win32-x64 node-v21.1.0

USAGE
  $ asyncapi [COMMAND]

TOPICS
  config    CLI config settings
  generate  Generate models and template
  new       Creates a new asyncapi file
  start     Start asyncapi studio

COMMANDS
  bundle    bundle one or multiple asyncapi documents and their references together.
  config    CLI config settings
  convert   Convert asyncapi documents older to newer versions
  diff      Find diff between two asyncapi files
  generate  Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates.  new       Creates a new asyncapi file
  optimize  optimize asyncapi specification file
  start     Start asyncapi studio
  validate  validate asyncapi file

It generates an empty page for me with https://github.com/asyncapi/html-template/blob/master/test/spec/asyncapi_v2.yml. The problem remains after updating to 0.60.1.

derberg · 2023-11-16T17:20:19Z

@jonaslagoni when you run generation (you are the only one where it works) can you do it with debug flag, it will clarify what html template version you're using in generation process

hntirgeam · 2023-11-16T17:44:14Z

Same behavior here even on 0.28.4

ag <...>.yaml /app/html-template -o <...> --force-write --debug

Remember that your local template must have its own node_modules installed first, "npm install" is not triggered by the generator.
Template sources taken from /app/html-template.
Version of used template is 0.28.4.
[BABEL] Note: The code generator has deoptimised the styling of <...>/asyncapi-ui.min.js as it exceeds the max of 500KB.
File <...>/index.html.js couldn't be found. Error: ENOENT: no such file or directory, stat '<...>/index.html.js'


Done! ✨
Check out your shiny new generated files at <...>

And then:

    <script>
      const schema = undefined;
      const config = {"show":{"sidebar":true},"sidebar":{"showOperations":"byDefault"}};
      AsyncApiStandalone.hydrate({ schema, config }, document.getElementById("root"));
    </script>
  </body>
</html>

generator version:

ag --version
1.14.1

jonaslagoni · 2023-11-16T18:59:02Z

Yeah, gonna try to reproduce it on a clean slate.

Pretty sure I know the cause, but why it's the cause I don't understand 😅 Last time this happened during development it was a mismatch between parser versions...

Gonna see if I can dig it up.

jonaslagoni · 2023-11-16T22:35:42Z

So yeah, this was a multitude of bugs... But the TL;DR; is that it's a parser dependency mismatch that caused it, more specifically after asyncapi/parser-js#892 was introduced the dependencies and implementation started to drift across implementations because it was a breaking change and was introduced on a pre-release branch meaning all dependant libraries started using it...

I could hot-fix it here as well, but does not make much sense to introduce as each fix elsewhere will break it again... Here is the list of PRs that need to be merged before it is fully fixed:

Sorry for the inconvenience folks... 🙃

derberg · 2023-12-18T15:52:49Z

Can anyone confirm if issue is still there?

From @jonaslagoni list of issues I see all are merged

albertodiazdorado · 2023-12-20T15:14:13Z

@derberg works like a charm, I can confirm. I am closing this issue :D

albertodiazdorado · 2023-12-20T15:14:38Z

Thanks @jonaslagoni

nilkanth987 · 2024-02-02T10:35:58Z

@jonaslagoni , This is still happing for me.
Here is my configs

node: 17.8.0
"@asyncapi/generator": "^1.17.4",
"@asyncapi/html-template": "^2.1.5",

Can anyone tell me how to fix it?

albertodiazdorado added the bug Something isn't working label Nov 8, 2023

henhal mentioned this issue Nov 13, 2023

Renders empty HTML asyncapi/spec#989

Closed

jonaslagoni mentioned this issue Nov 16, 2023

[Docs Bug 🐞 report]: blank html page #460

Closed

1 task

This was referenced Nov 16, 2023

fix: wrong parserAPI number being checked asyncapi/parser-js#902

Merged

feat!: add support for parser API v3 smoya/multi-parser-js#5

Merged

feat: add parser API v3 support asyncapi/generator#1066

Merged

This was referenced Nov 16, 2023

feat!: update to parser API v3 #461

Closed

feat!: update to parser API v3 #459

Merged

Blank page when generating html doc asyncapi/generator#1063

Closed

hguidetti mentioned this issue Nov 24, 2023

Shared avro model results in incorrect AsyncAPI document asyncapi/generator#1075

Closed

albertodiazdorado closed this as completed Dec 20, 2023

serkmen mentioned this issue Dec 28, 2023

github-action-for-generator: Error: Found non-callable @@iterator asyncapi/github-action-for-cli#368

Closed

nilkanth987 mentioned this issue Feb 6, 2024

Error: ENOENT: no such file or directory index.html.js #526

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Everything breaks after upgrading to version 1.0.0 #456

Everything breaks after upgrading to version 1.0.0 #456

albertodiazdorado commented Nov 8, 2023

github-actions bot commented Nov 8, 2023

Traderjoe95 commented Nov 9, 2023

henhal commented Nov 13, 2023

zschumacher commented Nov 14, 2023

jonaslagoni commented Nov 14, 2023

zschumacher commented Nov 14, 2023

henhal commented Nov 15, 2023

jonaslagoni commented Nov 15, 2023 •

edited

Loading

smoya commented Nov 16, 2023

Traderjoe95 commented Nov 16, 2023

derberg commented Nov 16, 2023

hntirgeam commented Nov 16, 2023 •

edited

Loading

jonaslagoni commented Nov 16, 2023 •

edited

Loading

jonaslagoni commented Nov 16, 2023

derberg commented Dec 18, 2023

albertodiazdorado commented Dec 20, 2023

albertodiazdorado commented Dec 20, 2023

nilkanth987 commented Feb 2, 2024

Everything breaks after upgrading to version 1.0.0 #456

Everything breaks after upgrading to version 1.0.0 #456

Comments

albertodiazdorado commented Nov 8, 2023

Describe the bug

github-actions bot commented Nov 8, 2023

Traderjoe95 commented Nov 9, 2023

henhal commented Nov 13, 2023

zschumacher commented Nov 14, 2023

jonaslagoni commented Nov 14, 2023

zschumacher commented Nov 14, 2023

henhal commented Nov 15, 2023

jonaslagoni commented Nov 15, 2023 • edited Loading

smoya commented Nov 16, 2023

Traderjoe95 commented Nov 16, 2023

derberg commented Nov 16, 2023

hntirgeam commented Nov 16, 2023 • edited Loading

jonaslagoni commented Nov 16, 2023 • edited Loading

jonaslagoni commented Nov 16, 2023

derberg commented Dec 18, 2023

albertodiazdorado commented Dec 20, 2023

albertodiazdorado commented Dec 20, 2023

nilkanth987 commented Feb 2, 2024

jonaslagoni commented Nov 15, 2023 •

edited

Loading

hntirgeam commented Nov 16, 2023 •

edited

Loading

jonaslagoni commented Nov 16, 2023 •

edited

Loading