feat: add ability to resolve remote or relative schema $refs (#8293)

* bundle schemas when initializing project * update input type options * remove extraneous config * filter out equalExpression before making options
microsoft · Jul 8, 2021 · 86f05c3 · 86f05c3
1 parent 06897d0
commit 86f05c3
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 37 deletions.
diff --git a/Composer/packages/server/package.json b/Composer/packages/server/package.json
@@ -66,6 +66,7 @@
     "ts-node": "^8.4.1"
   },
   "dependencies": {
+    "@apidevtools/json-schema-ref-parser": "^9.0.9",
     "@azure/cognitiveservices-qnamaker": "^3.2.0",
     "@bfc/client": "*",
     "@bfc/extension": "*",

diff --git a/Composer/packages/server/src/models/bot/botProject.ts b/Composer/packages/server/src/models/bot/botProject.ts
@@ -32,6 +32,7 @@ import { DefaultSettingManager } from '../settings/defaultSettingManager';
 import log from '../../logger';
 import { BotProjectService } from '../../services/project';
 import AssetService from '../../services/asset';
+import { bundleSchema } from '../utilities/bundleSchema';
 
 import {
   BotStructureFilesPatterns,
@@ -202,6 +203,8 @@ export class BotProject implements IBotProject {
     this.settings = await this.getEnvSettings(false);
     this.files = await this._getFiles();
     this.readme = await this._getReadme();
+
+    await this._bundleSchemas();
   };
 
   public getProject = () => {
@@ -1099,4 +1102,25 @@ export class BotProject implements IBotProject {
       }
     }
   };
+
+  private _bundleSchemas = async () => {
+    const schemas: FileInfo[] = [];
+    this.files.forEach((file) => {
+      if (file.name.endsWith('.schema')) {
+        schemas.push(file);
+      }
+    });
+
+    debug('Bundling %d schemas.', schemas.length);
+
+    await Promise.all(
+      schemas.map(async (s) => {
+        const bundled = await bundleSchema(s.path);
+
+        if (bundled) {
+          s.content = bundled;
+        }
+      })
+    );
+  };
 }
diff --git a/Composer/packages/server/src/models/utilities/bundleSchema.ts b/Composer/packages/server/src/models/utilities/bundleSchema.ts
@@ -0,0 +1,19 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import $RefParser from '@apidevtools/json-schema-ref-parser';
+
+import logger from '../../logger';
+
+const log = logger.extend('schema');
+
+export async function bundleSchema(schemaPath: string) {
+  try {
+    const parser = new $RefParser();
+    const bundled = await parser.bundle(schemaPath);
+    return JSON.stringify(bundled);
+  } catch (err) {
+    log('Error while bundling schema at %s', schemaPath);
+    log('%O', err);
+  }
+}
diff --git a/Composer/packages/ui-plugins/schema-editor/src/Fields/ValueRefField.tsx b/Composer/packages/ui-plugins/schema-editor/src/Fields/ValueRefField.tsx
@@ -11,10 +11,12 @@ import { valueTypeDefinitions } from '../schema';
 
 export const ValueRefField: React.FC<FieldProps> = ({ description, id, label, value, required, onChange }) => {
   const options = useMemo<IDropdownOption[]>(() => {
-    return Object.entries(valueTypeDefinitions || {}).map(([key, value]) => ({
-      key: `#/definitions/${key}`,
-      text: value?.title || startCase(key),
-    }));
+    return Object.entries(valueTypeDefinitions || {})
+      .filter(([key]) => key !== 'equalsExpression') // a value must be a type, not just an expression
+      .map(([key, value]) => ({
+        key: `#/definitions/${key}`,
+        text: value?.title || startCase(key),
+      }));
   }, []);
 
   const handleChange = (_: React.FormEvent<HTMLDivElement>, option?: IDropdownOption) => {

diff --git a/Composer/packages/ui-plugins/schema-editor/src/schema.ts b/Composer/packages/ui-plugins/schema-editor/src/schema.ts
@@ -52,14 +52,6 @@ export const schema = (): JSONSchema7 => ({
 });
 
 export const valueTypeDefinitions: { [key: string]: JSONSchema7 } = {
-  expression: {
-    $role: 'expression',
-    type: 'string',
-    title: formatMessage('Expression'),
-    description: formatMessage('Expression to evaluate.'),
-    pattern: '^.*\\S.*',
-    examples: ['user.age > 13'],
-  },
   equalsExpression: {
     $role: 'expression',
     type: 'string',
@@ -68,26 +60,9 @@ export const valueTypeDefinitions: { [key: string]: JSONSchema7 } = {
     pattern: '^=.*\\S.*',
     examples: ['=user.name'],
   },
-  condition: {
-    $role: 'expression',
-    title: formatMessage('Boolean condition'),
-    description: formatMessage('Boolean constant or expression to evaluate.'),
-    oneOf: [
-      {
-        $ref: '#/definitions/expression',
-      },
-      {
-        type: 'boolean',
-        title: formatMessage('Boolean'),
-        description: formatMessage('Boolean value.'),
-        default: true,
-        examples: [false],
-      },
-    ],
-  },
   booleanExpression: {
     $role: 'expression',
-    title: formatMessage('Boolean or expression'),
+    title: formatMessage('Boolean'),
     description: formatMessage('Boolean constant or expression to evaluate.'),
     oneOf: [
       {
@@ -105,7 +80,7 @@ export const valueTypeDefinitions: { [key: string]: JSONSchema7 } = {
   },
   numberExpression: {
     $role: 'expression',
-    title: formatMessage('Number or expression'),
+    title: formatMessage('Number'),
     description: formatMessage('Number constant or expression to evaluate.'),
     oneOf: [
       {
@@ -123,7 +98,7 @@ export const valueTypeDefinitions: { [key: string]: JSONSchema7 } = {
   },
   integerExpression: {
     $role: 'expression',
-    title: formatMessage('Integer or expression'),
+    title: formatMessage('Integer'),
     description: formatMessage('Integer constant or expression to evaluate.'),
     oneOf: [
       {
@@ -141,7 +116,7 @@ export const valueTypeDefinitions: { [key: string]: JSONSchema7 } = {
   },
   stringExpression: {
     $role: 'expression',
-    title: formatMessage('String or expression'),
+    title: formatMessage('String'),
     description: formatMessage('Interpolated string or expression to evaluate.'),
     oneOf: [
       {
@@ -159,7 +134,7 @@ export const valueTypeDefinitions: { [key: string]: JSONSchema7 } = {
   },
   arrayExpression: {
     $role: 'expression',
-    title: formatMessage('Array or expression'),
+    title: formatMessage('Array'),
     description: formatMessage('Array or expression to evaluate.'),
     oneOf: [
       {
@@ -174,7 +149,7 @@ export const valueTypeDefinitions: { [key: string]: JSONSchema7 } = {
   },
   objectExpression: {
     $role: 'expression',
-    title: formatMessage('Object or expression'),
+    title: formatMessage('Object'),
     description: formatMessage('Object or expression to evaluate.'),
     oneOf: [
       {
@@ -189,7 +164,7 @@ export const valueTypeDefinitions: { [key: string]: JSONSchema7 } = {
   },
   valueExpression: {
     $role: 'expression',
-    title: formatMessage('Any or expression'),
+    title: formatMessage('Any'),
     description: formatMessage('Any constant or expression to evaluate.'),
     oneOf: [
       {

diff --git a/Composer/yarn.lock b/Composer/yarn.lock
@@ -30,6 +30,16 @@
     call-me-maybe "^1.0.1"
     js-yaml "^3.13.1"
 
+"@apidevtools/json-schema-ref-parser@^9.0.9":
+  version "9.0.9"
+  resolved "https://registry.yarnpkg.com/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-9.0.9.tgz#d720f9256e3609621280584f2b47ae165359268b"
+  integrity sha512-GBD2Le9w2+lVFoc4vswGI/TjkNIZSVp7+9xPf+X3uidBfWnAeUWmquteSyt0+VCrhNMWj/FTABISQrD3Z/YA+w==
+  dependencies:
+    "@jsdevtools/ono" "^7.1.3"
+    "@types/json-schema" "^7.0.6"
+    call-me-maybe "^1.0.1"
+    js-yaml "^4.1.0"
+
 "@apidevtools/openapi-schemas@^2.0.4":
   version "2.1.0"
   resolved "https://botbuilder.myget.org/F/botframework-cli/npm/@apidevtools/openapi-schemas/-/@apidevtools/openapi-schemas-2.1.0.tgz#9fa08017fb59d80538812f03fc7cac5992caaa17"
@@ -5214,7 +5224,7 @@
     jest-diff "^26.0.0"
     pretty-format "^26.0.0"
 
-"@types/json-schema@*":
+"@types/json-schema@*", "@types/json-schema@^7.0.6":
   version "7.0.7"
   resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.7.tgz#98a993516c859eb0d5c4c8f098317a9ea68db9ad"
   integrity sha512-cxWFQVseBm6O9Gbw1IWb8r6OS4OhSt3hPZLkFApLjM8TEXROBuQGLAH2i2gZpcXdLBIrpXuTDhH7Vbm1iXmNGA==
@@ -15455,6 +15465,13 @@ js-yaml@^3.13.1:
     argparse "^1.0.7"
     esprima "^4.0.0"
 
+js-yaml@^4.1.0:
+  version "4.1.0"
+  resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.1.0.tgz#c1fb65f8f5017901cdd2c951864ba18458a10602"
+  integrity sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==
+  dependencies:
+    argparse "^2.0.1"
+
 jsbn@~0.1.0:
   version "0.1.1"
   resolved "https://registry.yarnpkg.com/jsbn/-/jsbn-0.1.1.tgz#a5e654c2e5a2deb5f201d96cefbca80c0ef2f513"