@W-17701711@ Generate isomorphic SDK from OAS #194
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json", | ||
| "spaces": 2, | ||
| "generator-cli": { | ||
| "version": "7.13.0" | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,202 @@ | ||
| /* | ||
| * Copyright (c) 2025, Salesforce, Inc. | ||
| * All rights reserved. | ||
| * SPDX-License-Identifier: BSD-3-Clause | ||
| * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause | ||
| */ | ||
| import fs from 'fs-extra'; | ||
| import path from 'path'; | ||
| import {generateFromOas} from '@commerce-apps/raml-toolkit'; | ||
| import Handlebars from 'handlebars'; | ||
| import { | ||
| resolveApiName, | ||
| getAPIDetailsFromExchange, | ||
| generateSDKs, | ||
| generateIndex, | ||
| main, | ||
| generateVersionFile, | ||
| } from './generate-oas'; | ||
|
|
||
| // Mock dependencies | ||
| jest.mock('fs-extra'); | ||
|
|
||
| jest.mock('@commerce-apps/raml-toolkit', () => ({ | ||
| generateFromOas: { | ||
| generateFromOas: jest.fn(), | ||
| }, | ||
| })); | ||
|
|
||
| describe('generate-oas', () => { | ||
| const mockApiDirectory = '/mock/api/directory'; | ||
| let handlebarsSpy: jest.SpyInstance; | ||
|
|
||
| beforeEach(() => { | ||
| // Reset all mocks before each test | ||
| jest.clearAllMocks(); | ||
|
|
||
| // Set up Handlebars spy | ||
| handlebarsSpy = jest.spyOn(Handlebars, 'compile'); | ||
|
|
||
| // Mock fs-extra methods | ||
| (fs.existsSync as jest.Mock).mockReturnValue(true); | ||
| (fs.readJSONSync as jest.Mock).mockReturnValue({ | ||
| main: 'api.yaml', | ||
| assetId: 'shopper-orders-oas', | ||
| name: 'Shopper orders OAS', | ||
| }); | ||
| (fs.statSync as jest.Mock).mockReturnValue({isFile: () => true}); | ||
| (fs.readdir as jest.Mock).mockImplementation((dir, callback) => { | ||
| // eslint-disable-next-line @typescript-eslint/no-unsafe-call | ||
| callback(null, ['shopper-orders']); | ||
| }); | ||
| (fs.readFileSync as jest.Mock).mockReturnValue('template content'); | ||
| // eslint-disable-next-line @typescript-eslint/no-empty-function | ||
| (fs.writeFileSync as jest.Mock).mockImplementation(() => {}); | ||
| // eslint-disable-next-line @typescript-eslint/no-empty-function | ||
| (fs.copySync as jest.Mock).mockImplementation(() => {}); | ||
| (fs.lstatSync as jest.Mock).mockReturnValue({isDirectory: () => true}); | ||
| }); | ||
|
|
||
| describe('Main execution', () => { | ||
| it('should process all API directories and generate SDKs', () => { | ||
| process.env.COMMERCE_SDK_INPUT_DIR = mockApiDirectory; | ||
| process.env.PACKAGE_VERSION = '1.0.0'; | ||
|
|
||
| main(); | ||
|
|
||
| expect(fs.copySync).toHaveBeenCalledWith( | ||
| path.join(__dirname, '../src/static'), | ||
| path.join(__dirname, '../src/lib'), | ||
| // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment | ||
| {filter: expect.any(Function)} | ||
| ); | ||
| expect(fs.readdir).toHaveBeenCalledWith( | ||
| mockApiDirectory, | ||
| expect.any(Function) | ||
| ); | ||
| }); | ||
| }); | ||
|
|
||
| describe('resolveApiName', () => { | ||
| it('should handle special case for Shopper orders OAS', () => { | ||
| const result = resolveApiName('Shopper orders OAS'); | ||
| expect(result).toBe('ShopperOrders'); | ||
| }); | ||
|
|
||
| it('should handle special case for Shopper Seo OAS', () => { | ||
| const result = resolveApiName('Shopper Seo OAS'); | ||
| expect(result).toBe('ShopperSEO'); | ||
| }); | ||
|
|
||
| it('should handle regular API names', () => { | ||
| const result = resolveApiName('Shopper Baskets OAS'); | ||
| expect(result).toBe('ShopperBaskets'); | ||
| }); | ||
| }); | ||
|
|
||
| describe('getAPIDetailsFromExchange', () => { | ||
| it('should return correct API details from exchange.json', () => { | ||
| const result = getAPIDetailsFromExchange( | ||
| path.join(mockApiDirectory, 'shopperOrders') | ||
| ); | ||
| expect(result).toEqual({ | ||
| filepath: path.join(mockApiDirectory, 'shopperOrders', 'api.yaml'), | ||
| filename: 'api.yaml', | ||
| directoryName: 'shopperOrders', | ||
| name: 'Shopper orders OAS', | ||
| apiName: 'ShopperOrders', | ||
| }); | ||
| }); | ||
|
|
||
| it('should throw error when exchange.json does not exist', () => { | ||
| (fs.existsSync as jest.Mock).mockReturnValueOnce(false); | ||
| expect(() => getAPIDetailsFromExchange('nonexistent')).toThrow( | ||
| 'Exchange file does not exist' | ||
| ); | ||
| }); | ||
| }); | ||
|
|
||
| describe('generateSDKs', () => { | ||
| it('should generate SDK for shopper API', () => { | ||
| const apiSpecDetail = { | ||
| filepath: '/path/to/shopper/api.yaml', | ||
| filename: 'api.yaml', | ||
| name: 'Test API', | ||
| directoryName: 'test-api', | ||
| apiName: 'TestAPI', | ||
| }; | ||
|
|
||
| generateSDKs(apiSpecDetail); | ||
|
|
||
| expect(generateFromOas.generateFromOas).toHaveBeenCalledWith({ | ||
| inputSpec: '/path/to/shopper/api.yaml', | ||
| outputDir: path.join(__dirname, '../src/lib/test-api'), | ||
| templateDir: path.join(__dirname, '../templatesOas'), | ||
| skipValidateSpec: true, | ||
| }); | ||
| }); | ||
|
|
||
| it('should not generate SDK for non-api files', () => { | ||
| const apiSpecDetail = { | ||
| filepath: '/path/to/shopper/not-api.yaml', | ||
| filename: '/not-api.yaml', | ||
| name: 'Not API', | ||
| directoryName: 'none', | ||
| apiName: 'NotAPI', | ||
| }; | ||
|
|
||
| (fs.statSync as jest.Mock).mockReturnValueOnce({isFile: () => false}); | ||
| generateSDKs(apiSpecDetail); | ||
|
|
||
| expect(generateFromOas.generateFromOas).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('should not generate SDK for non-shopper API', () => { | ||
| const apiSpecDetail = { | ||
| filepath: '/path/to/non/api.yaml', | ||
| filename: 'api.yaml', | ||
| name: 'Non Shopper API', | ||
| directoryName: 'none', | ||
| apiName: 'NonShopper', | ||
| }; | ||
|
|
||
| (fs.statSync as jest.Mock).mockReturnValueOnce({isFile: () => true}); | ||
| generateSDKs(apiSpecDetail); | ||
|
|
||
| expect(generateFromOas.generateFromOas).not.toHaveBeenCalled(); | ||
| }); | ||
| }); | ||
|
|
||
| describe('generateIndex', () => { | ||
| it('should generate index file with correct context', () => { | ||
| const context = { | ||
| children: [ | ||
| { | ||
| name: 'Test API', | ||
| apiName: 'TestAPI', | ||
| }, | ||
| ], | ||
| }; | ||
|
|
||
| generateIndex(context); | ||
|
|
||
| expect(fs.writeFileSync).toHaveBeenCalledWith( | ||
| path.join(__dirname, '../src/lib/index.ts'), | ||
| expect.any(String) | ||
| ); | ||
| }); | ||
| }); | ||
|
|
||
| describe('generateVersionFile', () => { | ||
| it('should generate version file', () => { | ||
| process.env.PACKAGE_VERSION = '1.0.0'; | ||
|
|
||
| generateVersionFile(); | ||
|
|
||
| expect(fs.writeFileSync).toHaveBeenCalledWith( | ||
| path.join(__dirname, '../src/lib/version.ts'), | ||
| expect.any(String) | ||
| ); | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need this file here? Will it not use from raml-toolkit?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good question. I just tried generating the sdk again using the raml-toolkit command after deleting it and it didn't return.
This was probably an artifact from when I ran openapi-generator directly in the sdk. I'll delete it.