Merge branch 'master' into quarkus-websocket

Author: ssala034

CONTRIBUTING.md

@@ -18,13 +18,14 @@ We use [All Contributors](https://allcontributors.org/docs/en/specification) spe
 
 ## Few tips for effective contributions
 
-1. Understanding how the Generator works is key to making valuable contributions. You can start by actively following along and executing the steps given in the [generator template tutorial](https://www.asyncapi.com/docs/tools/generator/generator-template). Hands-on practice will provide you with a comprehensive understanding of how the Generator processes templates and allow you to experiment with customization.
-2. **PATIENCE** is crucial. Focus on creating meaningful contributions rather than rushing to submit a PR that adds little or no value to the project.
-3. Adding entirely new features might be challenging because most features are already well-established. You may need to spend more time understanding the repository to identify areas for improvement.
-4. You should research on Google regarding the @asyncapi/generator and related repositories (e.g., @asyncapi/parser or any of the template repositories) to identify potential improvements. AI can be a helpful assistant, but always double-check the information it provides with Google or StackOverflow.
-5. Follow **Issue First, PR Later** - Always check if there’s an existing issue before creating a new one, and raise your PR once the issue is confirmed/approved by any of the maintainers.
-6. Keep **PRs small and focused** – A small PR with a well-defined scope is easier to review and merge. Avoid bundling multiple changes into one PR.
-7. Collaborate with Other Contributors – If someone else has already raised an issue and you are interested in contributing to it, please communicate with them and collaborate instead of raising a separate PR independently. Working together leads to better contributions and avoids duplication of efforts. Open source is driven by **collaboration, not competition**.
+1. **Join the AsyncAPI Slack Workspace** - Connect with maintainers and fellow contributors in the `#generator` channel on [AsyncAPI Slack](https://www.asyncapi.com/slack-invite) to ask questions, share ideas, and get help.  Also, consider attending the **weekly Knowledge Sharing meetings held every Wednesday**; details are shared in the channel.
+2. Understanding how the Generator works is key to making valuable contributions. You can start by actively following along and executing the steps given in the [generator template tutorial](https://www.asyncapi.com/docs/tools/generator/generator-template). Hands-on practice will provide you with a comprehensive understanding of how the Generator processes templates and allow you to experiment with customization.
+3. **PATIENCE** is crucial. Focus on creating meaningful contributions rather than rushing to submit a PR that adds little or no value to the project.
+4. Adding entirely new features might be challenging because most features are already well-established. You may need to spend more time understanding the repository to identify areas for improvement.
+5. You should research on Google regarding the @asyncapi/generator and related repositories (e.g., @asyncapi/parser or any of the template repositories) to identify potential improvements. AI can be a helpful assistant, but always double-check the information it provides with Google or StackOverflow.
+6. Follow **Issue First, PR Later** - Always check if there’s an existing issue before creating a new one, and raise your PR once the issue is confirmed/approved by any of the maintainers.
+7. Keep **PRs small and focused** – A small PR with a well-defined scope is easier to review and merge. Avoid bundling multiple changes into one PR.
+8. Collaborate with Other Contributors – If someone else has already raised an issue and you are interested in contributing to it, please communicate with them and collaborate instead of raising a separate PR independently. Working together leads to better contributions and avoids duplication of efforts. Open source is driven by **collaboration, not competition**.
 
 ## Summary of the contribution flow
 

apps/generator/package.json

@@ -16,7 +16,7 @@
     "test:unit": "jest --coverage --testPathIgnorePatterns=integration --testPathIgnorePatterns=test-project",
     "test:dev": "npm run test:unit -- --watchAll",
     "test:integration": "npm run test:cleanup && jest --testPathPattern=integration --modulePathIgnorePatterns='./__mocks__(?!\\/loglevel\\.js$)'",
-    "test:integration:update": "jest --updateSnapshot --testPathPattern=integration --modulePathIgnorePatterns='./__mocks__(?!\\/loglevel\\.js$)'",
+    "test:integration:update": "npm run test:integration -- -u",
     "test:cleanup": "rimraf \"test/temp\"",
     "docs": "jsdoc2md --partial docs/jsdoc2md-handlebars/custom-sig-name.hbs docs/jsdoc2md-handlebars/main.hbs docs/jsdoc2md-handlebars/docs.hbs docs/jsdoc2md-handlebars/header.hbs docs/jsdoc2md-handlebars/defaultvalue.hbs docs/jsdoc2md-handlebars/link.hbs docs/jsdoc2md-handlebars/params-table.hbs --files lib/generator.js > docs/api.md",
     "docker:build": "docker build -t asyncapi/generator:latest .",

package.json

@@ -31,7 +31,8 @@
     "helpers:lint": "turbo run lint --filter=@asyncapi/generator-helpers",
     "templates:test": "turbo run test --filter=@asyncapi/template*",
     "packages:test": "turbo run test --filter=./packages/** --only",
-    "hooks:test": "turbo run test --filter=@asyncapi/generator-hooks"
+    "hooks:test": "turbo run test --filter=@asyncapi/generator-hooks",
+    "test:update": "turbo run test -- -u"
   },
   "devDependencies": {
     "markdown-toc": "^1.2.0",

packages/components/package.json

@@ -4,7 +4,7 @@
   "description": "Package with reusable components for generation using React render engine",
   "scripts": {
     "test": "npm run build && jest --coverage",
-    "test:update": "jest --updateSnapshot",
+    "test:update": "npm run test -- -u",
     "build": "babel src --out-dir lib",
     "prepublishOnly": "npm run build",
     "lint": "eslint --max-warnings 0 --config ../../.eslintrc --ignore-path ../../.eslintignore .",

packages/helpers/src/bindings.js

@@ -18,14 +18,14 @@ function getQueryParams(channels) {
 
   const queryMap = new Map();
 
-  const hasWsBinding = channel?.bindings?.().has('ws');
+  const bindings = channel?.bindings?.();
+  const hasWsBinding = bindings?.has('ws');
 
   if (!hasWsBinding) {
     return null;
   }
 
-  const wsBinding = channel.bindings().get('ws');
-
+  const wsBinding = bindings.get('ws');
   const query = wsBinding.value()?.query;
   //we do not throw error, as user do not have to use query params, we just exit with null as it doesn't make sense to continue with query building
   if (!query) {

packages/helpers/test/__fixtures__/asyncapi-websocket-query.yml

@@ -74,6 +74,19 @@ channels:
             payload: false
           - name: number
             payload: 123
+  wsBindingNoQuery:
+    address: '/no-query'
+    bindings:
+      ws:
+        bindingVersion: 0.1.0
+  wsBindingEmptyQuery:
+    address: '/empty-query'
+    bindings:
+      ws:
+        bindingVersion: 0.1.0
+        query:
+          type: object
+
   emptyChannel: {}
 
   marketDataV1NoBinding:

packages/helpers/test/bindings.test.js

@@ -0,0 +1,80 @@
+const path = require('path');
+const { Parser, fromFile } = require('@asyncapi/parser');
+const { getQueryParams } = require('@asyncapi/generator-helpers');
+const parser = new Parser();
+const asyncapi_v3_path = path.resolve(__dirname, './__fixtures__/asyncapi-websocket-query.yml');
+
+function createChannelsWithOnly(keysToKeep, originalChannels) {
+  // Create a copy to avoid mutating the original channels map - 
+  // other tests need the original data intact
+  const channelsMap = new Map(originalChannels.all());  
+  for (const key of channelsMap.keys()) {
+    if (!keysToKeep.includes(key)) {
+      channelsMap.delete(key);
+    }
+  }
+  return channelsMap;
+}
+
+describe('getQueryParams integration test with AsyncAPI', () => {
+  let parsedAsyncAPIDocument;
+
+  beforeAll(async () => {
+    const parseResult = await fromFile(parser, asyncapi_v3_path).parse();
+    parsedAsyncAPIDocument = parseResult.document;
+  });
+
+  // Helper function to create filtered channels and get query params
+  const getQueryParamsForChannels = (channelNames) => {
+    const channels = parsedAsyncAPIDocument.channels();
+    const filteredChannelsMap = createChannelsWithOnly(channelNames, channels);
+    // Mock the channels interface that getQueryParams() expects - it needs
+    // isEmpty() and all() methods, not direct Map access
+    return getQueryParams({
+      isEmpty: () => filteredChannelsMap.size === 0,
+      all: () => filteredChannelsMap
+    });
+  };
+
+  it('should extract query parameters from WebSocket binding with properties', () => {
+    const channels = parsedAsyncAPIDocument.channels();
+    const params = getQueryParams(channels);
+
+    expect(params).not.toBeNull();
+    expect(params.get('heartbeat')).toBe('false');
+    expect(params.get('top_of_book')).toBe('false');
+    expect(params.get('bids')).toBe('true');
+    expect(params.get('offers')).toBe('');
+  });
+
+  it('should return null for channel without WebSocket binding', () => {
+    const params = getQueryParamsForChannels(['marketDataV1NoBinding']);
+    expect(params).toBeNull();
+  });
+
+  it('should return null for empty channels map', () => {
+    // Mock channels object to simulate empty state - getQueryParams() expects 
+    // channels with isEmpty() and all() methods, not a plain Map
+    const emptyChannels = {
+      isEmpty: () => true,
+      all: () => new Map()
+    };
+    const params = getQueryParams(emptyChannels);
+    expect(params).toBeNull();
+  });
+
+  it('should return null for channel with empty binding', () => {
+    const params = getQueryParamsForChannels(['emptyChannel']);
+    expect(params).toBeNull();
+  });
+
+  it('should return null if WebSocket binding exists but has no query parameters', () => {
+    const params = getQueryParamsForChannels(['wsBindingNoQuery']);
+    expect(params).toBeNull();
+  });
+
+  it('should return null if WebSocket binding query exists but has no properties', () => {
+    const params = getQueryParamsForChannels(['wsBindingEmptyQuery']);
+    expect(params).toBeNull();
+  });
+});

packages/helpers/test/utils.test.js

@@ -1,6 +1,7 @@
 const path = require('path');
 const { Parser, fromFile } = require('@asyncapi/parser');
-const { getClientName, getInfo, getTitle, toSnakeCase } = require('@asyncapi/generator-helpers');
+const { getClientName, getInfo, getTitle, toSnakeCase, listFiles } = require('@asyncapi/generator-helpers');
+const fs = require('fs/promises');
 
 const parser = new Parser();
 const asyncapi_v3_path = path.resolve(__dirname, './__fixtures__/asyncapi-websocket-query.yml');
@@ -153,4 +154,35 @@ describe('toSnakeCase integration test with AsyncAPI', () => {
     const expectedOperationId = '';
     expect(actualOperationId).toBe(expectedOperationId);
   });
-});
+});
+
+jest.mock('fs/promises');
+describe('listFiles', () => {
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('should return only file names from the directory', async () => {
+    const mockDirents = [
+      { name: 'file1.txt', isFile: () => true },
+      { name: 'file2.js', isFile: () => true },
+      { name: 'subdir', isFile: () => false },
+    ];
+
+    fs.readdir.mockResolvedValue(mockDirents);
+    const mockPath = '/mock/path';
+
+    const result = await listFiles(mockPath);
+    expect(fs.readdir).toHaveBeenCalledWith(mockPath, { withFileTypes: true });
+    expect(result).toEqual(['file1.txt', 'file2.js']);
+  });
+
+  it('should return an empty array if no files exist', async () => {
+    fs.readdir.mockResolvedValue([
+      { name: 'folder', isFile: () => false },
+    ]);
+    const mockPath = '/mock/path';
+    const result = await listFiles(mockPath);
+    expect(result).toEqual([]);
+  });
+});

packages/templates/clients/websocket/dart/package.json

@@ -4,7 +4,7 @@
   "description": "This is a template generating Dart websocket client",
   "scripts": {
     "test": "npm run test:cleanup && jest  --coverage",
-    "test:update": "jest --updateSnapshot",
+    "test:update": "npm run test -- -u",
     "test:cleanup": "rimraf \"test/temp\"",
     "lint": "eslint --max-warnings 0 --config ../../../../../.eslintrc --ignore-path ../../../../../.eslintignore .",
     "lint:fix": "eslint --fix --max-warnings 0 --config ../../../../../.eslintrc --ignore-path ../../../../../.eslintignore ."

packages/templates/clients/websocket/javascript/README.md

@@ -6,4 +6,4 @@ You can test this template:
 3. Install with `npm install` and run test with `npm run test`
 4. Start example script that uses a client library generated by the test: `node example.js`
 
-> By default this is testing against Hoppscotch echo service. You can modify `packages/templates/clients/websocket/javascript/example.js` and change first line to `const WSClient = require('./tests/temp/snapshotTestResult/client-postman.js');` and run `node example.js` again. You will see example still works but now it is using a different API. This is possible since both AsyncAPI documents define the same name of operation for sending messages: `sendEchoMessage` so each client generated has the same API.
+> By default this is testing against Hoppscotch echo service. You can modify `packages/templates/clients/websocket/javascript/example.js` and change first line to `const WSClient = require('./tests/temp/snapshotTestResult/client_postman/client.js');` and run `node example.js` again. You will see example still works but now it is using a different API. This is possible since both AsyncAPI documents define the same name of operation for sending messages: `sendEchoMessage` so each client generated has the same API.

packages/templates/clients/websocket/javascript/example.js

@@ -1,4 +1,4 @@
-const WSClient = require('./test/temp/snapshotTestResult/custom-client-hoppscotch.js');
+const WSClient = require('./test/temp/snapshotTestResult/custom_client_hoppscotch/client.js');
 // Example usage
 const wsClient = new WSClient();