-
Notifications
You must be signed in to change notification settings - Fork 76
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix nullable property generation #2076
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
7d17499
Fixes for model generation
joheredi d476300
Update lock
joheredi 160ff63
fix lint
joheredi 6e91f86
add test typespec
joheredi 6792e11
Update logic
joheredi d62f92b
Abstract nullability logic
joheredi e12fa08
Address pr comments
joheredi bc57cbe
fix lint
joheredi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains 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 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
11 changes: 11 additions & 0 deletions
11
packages/typespec-test/test/openai_generic/generated/typespec-ts/.eslintrc.json
This file contains 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,11 @@ | ||
{ | ||
"plugins": ["@azure/azure-sdk"], | ||
"extends": ["plugin:@azure/azure-sdk/azure-sdk-base"], | ||
"rules": { | ||
"@azure/azure-sdk/ts-modules-only-named": "warn", | ||
"@azure/azure-sdk/ts-apiextractor-json-types": "warn", | ||
"@azure/azure-sdk/ts-package-json-types": "warn", | ||
"@azure/azure-sdk/ts-package-json-engine-is-present": "warn", | ||
"tsdoc/syntax": "warn" | ||
} | ||
} |
56 changes: 56 additions & 0 deletions
56
packages/typespec-test/test/openai_generic/generated/typespec-ts/README.md
This file contains 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,56 @@ | ||
# OpenAI REST client library for JavaScript | ||
|
||
The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details. | ||
|
||
**Please rely heavily on our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library** | ||
|
||
Key links: | ||
|
||
- [Package (NPM)](https://www.npmjs.com/package/@msinternal/openai-generic) | ||
|
||
## Getting started | ||
|
||
### Currently supported environments | ||
|
||
- LTS versions of Node.js | ||
|
||
### Prerequisites | ||
|
||
- You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package. | ||
|
||
### Install the `@msinternal/openai-generic` package | ||
|
||
Install the OpenAI REST client REST client library for JavaScript with `npm`: | ||
|
||
```bash | ||
npm install @msinternal/openai-generic | ||
``` | ||
|
||
### Create and authenticate a `OpenAIClient` | ||
|
||
To use an [Azure Active Directory (AAD) token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token), | ||
provide an instance of the desired credential type obtained from the | ||
[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library. | ||
|
||
To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) | ||
|
||
After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use. | ||
As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential) | ||
can be used to authenticate the client. | ||
|
||
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: | ||
AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET | ||
|
||
## Troubleshooting | ||
|
||
### Logging | ||
|
||
Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`: | ||
|
||
```javascript | ||
const { setLogLevel } = require("@azure/logger"); | ||
|
||
setLogLevel("info"); | ||
``` | ||
|
||
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger). |
18 changes: 18 additions & 0 deletions
18
packages/typespec-test/test/openai_generic/generated/typespec-ts/api-extractor.json
This file contains 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,18 @@ | ||
{ | ||
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", | ||
"mainEntryPointFilePath": "./types/src/index.d.ts", | ||
"docModel": { "enabled": true }, | ||
"apiReport": { "enabled": true, "reportFolder": "./review" }, | ||
"dtsRollup": { | ||
"enabled": true, | ||
"untrimmedFilePath": "", | ||
"publicTrimmedFilePath": "./types/openai-generic.d.ts" | ||
}, | ||
"messages": { | ||
"tsdocMessageReporting": { "default": { "logLevel": "none" } }, | ||
"extractorMessageReporting": { | ||
"ae-missing-release-tag": { "logLevel": "none" }, | ||
"ae-unresolved-link": { "logLevel": "none" } | ||
} | ||
} | ||
} |
133 changes: 133 additions & 0 deletions
133
packages/typespec-test/test/openai_generic/generated/typespec-ts/karma.conf.js
This file contains 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,133 @@ | ||
// Copyright (c) Microsoft Corporation. | ||
// Licensed under the MIT license. | ||
|
||
// https://github.com/karma-runner/karma-chrome-launcher | ||
process.env.CHROME_BIN = require("puppeteer").executablePath(); | ||
require("dotenv").config(); | ||
const { relativeRecordingsPath } = require("@azure-tools/test-recorder"); | ||
process.env.RECORDINGS_RELATIVE_PATH = relativeRecordingsPath(); | ||
|
||
module.exports = function (config) { | ||
config.set({ | ||
// base path that will be used to resolve all patterns (eg. files, exclude) | ||
basePath: "./", | ||
|
||
// frameworks to use | ||
// available frameworks: https://npmjs.org/browse/keyword/karma-adapter | ||
frameworks: ["source-map-support", "mocha"], | ||
|
||
plugins: [ | ||
"karma-mocha", | ||
"karma-mocha-reporter", | ||
"karma-chrome-launcher", | ||
"karma-firefox-launcher", | ||
"karma-env-preprocessor", | ||
"karma-coverage", | ||
"karma-sourcemap-loader", | ||
"karma-junit-reporter", | ||
"karma-source-map-support", | ||
], | ||
|
||
// list of files / patterns to load in the browser | ||
files: [ | ||
"dist-test/index.browser.js", | ||
{ | ||
pattern: "dist-test/index.browser.js.map", | ||
type: "html", | ||
included: false, | ||
served: true, | ||
}, | ||
], | ||
|
||
// list of files / patterns to exclude | ||
exclude: [], | ||
|
||
// preprocess matching files before serving them to the browser | ||
// available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor | ||
preprocessors: { | ||
"**/*.js": ["sourcemap", "env"], | ||
// IMPORTANT: COMMENT following line if you want to debug in your browsers!! | ||
// Preprocess source file to calculate code coverage, however this will make source file unreadable | ||
// "dist-test/index.js": ["coverage"] | ||
}, | ||
|
||
envPreprocessor: [ | ||
"TEST_MODE", | ||
"ENDPOINT", | ||
"AZURE_CLIENT_SECRET", | ||
"AZURE_CLIENT_ID", | ||
"AZURE_TENANT_ID", | ||
"SUBSCRIPTION_ID", | ||
"RECORDINGS_RELATIVE_PATH", | ||
], | ||
|
||
// test results reporter to use | ||
// possible values: 'dots', 'progress' | ||
// available reporters: https://npmjs.org/browse/keyword/karma-reporter | ||
reporters: ["mocha", "coverage", "junit"], | ||
|
||
coverageReporter: { | ||
// specify a common output directory | ||
dir: "coverage-browser/", | ||
reporters: [ | ||
{ type: "json", subdir: ".", file: "coverage.json" }, | ||
{ type: "lcovonly", subdir: ".", file: "lcov.info" }, | ||
{ type: "html", subdir: "html" }, | ||
{ type: "cobertura", subdir: ".", file: "cobertura-coverage.xml" }, | ||
], | ||
}, | ||
|
||
junitReporter: { | ||
outputDir: "", // results will be saved as $outputDir/$browserName.xml | ||
outputFile: "test-results.browser.xml", // if included, results will be saved as $outputDir/$browserName/$outputFile | ||
suite: "", // suite will become the package name attribute in xml testsuite element | ||
useBrowserName: false, // add browser name to report and classes names | ||
nameFormatter: undefined, // function (browser, result) to customize the name attribute in xml testcase element | ||
classNameFormatter: undefined, // function (browser, result) to customize the classname attribute in xml testcase element | ||
properties: {}, // key value pair of properties to add to the <properties> section of the report | ||
}, | ||
|
||
// web server port | ||
port: 9876, | ||
|
||
// enable / disable colors in the output (reporters and logs) | ||
colors: true, | ||
|
||
// level of logging | ||
// possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG | ||
logLevel: config.LOG_INFO, | ||
|
||
// enable / disable watching file and executing tests whenever any file changes | ||
autoWatch: false, | ||
|
||
// --no-sandbox allows our tests to run in Linux without having to change the system. | ||
// --disable-web-security allows us to authenticate from the browser without having to write tests using interactive auth, which would be far more complex. | ||
browsers: ["ChromeHeadlessNoSandbox"], | ||
customLaunchers: { | ||
ChromeHeadlessNoSandbox: { | ||
base: "ChromeHeadless", | ||
flags: ["--no-sandbox", "--disable-web-security"], | ||
}, | ||
}, | ||
|
||
// Continuous Integration mode | ||
// if true, Karma captures browsers, runs the tests and exits | ||
singleRun: false, | ||
|
||
// Concurrency level | ||
// how many browser should be started simultaneous | ||
concurrency: 1, | ||
|
||
browserNoActivityTimeout: 60000000, | ||
browserDisconnectTimeout: 10000, | ||
browserDisconnectTolerance: 3, | ||
|
||
client: { | ||
mocha: { | ||
// change Karma's debug.html to the mocha web reporter | ||
reporter: "html", | ||
timeout: "600000", | ||
}, | ||
}, | ||
}); | ||
}; |
125 changes: 125 additions & 0 deletions
125
packages/typespec-test/test/openai_generic/generated/typespec-ts/package.json
This file contains 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,125 @@ | ||
{ | ||
"name": "@msinternal/openai-generic", | ||
"sdk-type": "client", | ||
"author": "Microsoft Corporation", | ||
"version": "1.0.0-beta.1", | ||
"description": "OpenAI", | ||
"keywords": ["node", "azure", "cloud", "typescript", "browser", "isomorphic"], | ||
"license": "MIT", | ||
"type": "module", | ||
"main": "dist/index.js", | ||
"module": "./dist-esm/src/index.js", | ||
"types": "./types/openai-generic.d.ts", | ||
"exports": { | ||
".": { | ||
"types": "./types/src/index.d.ts", | ||
"require": "./dist/index.cjs", | ||
"import": "./dist-esm/src/index.js" | ||
}, | ||
"./api": { | ||
"types": "./types/src/api/index.d.ts", | ||
"import": "./dist-esm/src/api/index.js" | ||
}, | ||
"./models": { | ||
"types": "./types/src/models/index.d.ts", | ||
"import": "./dist-esm/src/models/index.js" | ||
} | ||
}, | ||
"repository": "github:Azure/azure-sdk-for-js", | ||
"bugs": { "url": "https://github.com/Azure/azure-sdk-for-js/issues" }, | ||
"files": [ | ||
"dist/", | ||
"dist-esm/src/", | ||
"types/openai-generic.d.ts", | ||
"README.md", | ||
"LICENSE", | ||
"review/*" | ||
], | ||
"engines": { "node": ">=16.0.0" }, | ||
"scripts": { | ||
"audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit", | ||
"build:browser": "tsc -p . && cross-env ONLY_BROWSER=true rollup -c 2>&1", | ||
"build:node": "tsc -p . && cross-env ONLY_NODE=true rollup -c 2>&1", | ||
"build:samples": "echo skipped.", | ||
"build:test": "tsc -p . && rollup -c 2>&1", | ||
"build:debug": "echo skipped.", | ||
"check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"*.{js,json}\" \"test/**/*.ts\"", | ||
"clean": "rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log", | ||
"execute:samples": "echo skipped", | ||
"extract-api": "rimraf review && mkdirp ./review && api-extractor run --local", | ||
"format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"*.{js,json}\" \"test/**/*.ts\"", | ||
"generate:client": "echo skipped", | ||
"integration-test:browser": "karma start --single-run", | ||
"integration-test:node": "nyc mocha --require source-map-support/register.js --timeout 5000000 --full-trace \"dist-esm/test/{,!(browser)/**/}*.spec.js\"", | ||
"integration-test": "npm run integration-test:node && npm run integration-test:browser", | ||
"lint:fix": "eslint package.json api-extractor.json src test --ext .ts --fix --fix-type [problem,suggestion]", | ||
"lint": "eslint package.json api-extractor.json src test --ext .ts", | ||
"pack": "npm pack 2>&1", | ||
"test:browser": "npm run clean && npm run build:test && npm run unit-test:browser", | ||
"test:node": "npm run clean && npm run build:test && npm run unit-test:node", | ||
"test": "npm run clean && npm run build:test && npm run unit-test", | ||
"unit-test": "npm run unit-test:node && npm run unit-test:browser", | ||
"unit-test:node": "mocha --full-trace \"test/{,!(browser)/**/}*.spec.ts\"", | ||
"unit-test:browser": "karma start --single-run", | ||
"build": "npm run clean && tsc && rollup -c 2>&1 && npm run minify && mkdirp ./review && npm run extract-api", | ||
"minify": "uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js" | ||
}, | ||
"sideEffects": false, | ||
"autoPublish": false, | ||
"dependencies": { | ||
"@azure/core-auth": "^1.3.0", | ||
"@azure-rest/core-client": "^1.1.4", | ||
"@azure/core-rest-pipeline": "^1.12.0", | ||
"@azure/logger": "^1.0.0", | ||
"tslib": "^2.2.0", | ||
"@azure/core-util": "^1.4.0" | ||
}, | ||
"devDependencies": { | ||
"@microsoft/api-extractor": "^7.31.1", | ||
"autorest": "latest", | ||
"@types/node": "^16.0.0", | ||
"dotenv": "^16.0.0", | ||
"eslint": "^8.0.0", | ||
"mkdirp": "^2.1.2", | ||
"prettier": "^2.5.1", | ||
"rimraf": "^5.0.0", | ||
"source-map-support": "^0.5.9", | ||
"typescript": "~5.2.0", | ||
"@rollup/plugin-commonjs": "^24.0.0", | ||
"@rollup/plugin-json": "^6.0.0", | ||
"@rollup/plugin-multi-entry": "^6.0.0", | ||
"@rollup/plugin-node-resolve": "^13.1.3", | ||
"rollup": "^2.66.1", | ||
"rollup-plugin-sourcemaps": "^0.6.3", | ||
"uglify-js": "^3.4.9", | ||
"@azure-tools/test-credential": "^1.0.0", | ||
"@azure/identity": "^3.3.0", | ||
"@azure-tools/test-recorder": "^3.0.0", | ||
"mocha": "^10.0.0", | ||
"@types/mocha": "^10.0.0", | ||
"mocha-junit-reporter": "^1.18.0", | ||
"cross-env": "^7.0.2", | ||
"@types/chai": "^4.2.8", | ||
"chai": "^4.2.0", | ||
"karma-chrome-launcher": "^3.0.0", | ||
"karma-coverage": "^2.0.0", | ||
"karma-env-preprocessor": "^0.1.1", | ||
"karma-firefox-launcher": "^2.1.2", | ||
"karma-junit-reporter": "^2.0.1", | ||
"karma-mocha-reporter": "^2.2.5", | ||
"karma-mocha": "^2.0.1", | ||
"karma-source-map-support": "~1.4.0", | ||
"karma-sourcemap-loader": "^0.4.0", | ||
"karma": "^6.2.0", | ||
"nyc": "^15.0.0", | ||
"ts-node": "^10.0.0" | ||
}, | ||
"browser": { | ||
"./dist-esm/test/public/utils/env.js": "./dist-esm/test/public/utils/env.browser.js" | ||
}, | ||
"mocha": { | ||
"extension": ["ts"], | ||
"timeout": "1200000", | ||
"loader": "ts-node/esm" | ||
} | ||
} |
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.
I remember we treat unknown as any in the RLC output model ? And in Modular, we don't have the output and input models separated, Is it okay to use unknown here ?
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.
This is a good point, lets park it and have a discussion.
Filed: #2078