Merge pull request #11 from superfaceai/feature/play-command

Feature/play command

.eslintrc.js

@@ -23,7 +23,7 @@ module.exports = {
   rules: {
     'newline-before-return': 'error',
     '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
-    'simple-import-sort/sort': 'error',
+    'simple-import-sort/imports': 'error',
     'sort-imports': 'off',
     'import/first': 'error',
     'import/newline-after-import': 'error',

fixtures/playgrounds/.gitignore

@@ -0,0 +1,3 @@
+**/package-lock.json
+**/*.ast.json
+**/*.js

fixtures/playgrounds/invalid/invalid.default.suma

@@ -0,0 +1,6 @@
+profile = "https://example.com/pubs"
+provider = "https://example.com/pubs/Noop"
+
+map PubOpeningHours {
+	return map result []
+}

fixtures/playgrounds/valid/.npmrc

@@ -0,0 +1 @@
+@superfaceai:registry=https://npm.pkg.github.com

fixtures/playgrounds/valid/package.json

@@ -0,0 +1,10 @@
+{
+	"name": "valid",
+	"private": true,
+	"dependencies": {
+		"@superfaceai/sdk": "^0.0.3"
+	},
+	"devDependencies": {
+		"typescript": "^4"
+	}
+}

fixtures/playgrounds/valid/valid.noop.suma

@@ -0,0 +1,6 @@
+profile = "https://example.com/pubs"
+provider = "https://example.com/pubs/Noop"
+
+map PubOpeningHours {
+	return map result []
+}

fixtures/playgrounds/valid/valid.noop.ts

@@ -0,0 +1,42 @@
+import * as fs from 'fs';
+import { promisify, inspect } from 'util';
+import { Provider } from '@superfaceai/sdk';
+
+const readFile = promisify(fs.readFile);
+
+async function main() {
+	const profileAst = JSON.parse(
+		await readFile('valid.supr.ast.json', { encoding: 'utf-8' })
+	);
+	const mapAst = JSON.parse(
+		await readFile('valid.noop.suma.ast.json', { encoding: 'utf-8' })
+	);
+
+	const provider = new Provider(
+		profileAst, mapAst,
+		'PubOpeningHours'
+	);
+
+	const boundProvider = await provider.bind(
+		{
+			// TODO: Add your auth keys here
+		}
+	);
+
+	const result = await boundProvider.perform(
+		{
+			city: "Praha",
+			nameRegex: "Diego"
+		}
+	);
+
+	console.log(
+		"pubs/Noop result:",
+		inspect(result, {
+			depth: 5,
+			colors: true
+		})
+	);
+}
+
+main()

fixtures/playgrounds/valid/valid.osm.suma

@@ -0,0 +1,37 @@
+profile = "https://example.com/pubs"
+provider = "https://example.com/pubs/OSM"
+
+map PubOpeningHours {
+	http POST "/api/interpreter" {
+		request "application/x-www-form-urlencoded" {
+			body {
+				data = call BuildQuery(city = input.city, nameRegex = input.nameRegex)
+			}
+		}
+
+		response 200 {
+			return map error if (body.remarks && body.remarks.includes('Query timed out')) "TIMEOUT"
+
+			return map result body.elements.map(
+				node => {
+					return {
+						name: node.tags.name,
+						openingHours: node.tags.opening_hours
+					}
+				}
+			)
+		}
+	}
+}
+
+operation BuildQuery {
+	regexLine = input.nameRegex ? `node._["name"~"${input.nameRegex}", i];` : '';
+	query = (`[out:json][timeout:10];
+		area[boundary=administrative][admin_level=8][name="${input.city}"];
+		node[amenity="pub"][opening_hours](area);
+		${regexLine}
+
+		out;`);
+
+	return query;
+}

fixtures/playgrounds/valid/valid.osm.ts

@@ -0,0 +1,37 @@
+import * as fs from 'fs';
+import { promisify, inspect } from 'util';
+import { Provider } from '@superfaceai/sdk';
+
+const readFile = promisify(fs.readFile);
+
+async function main() {
+  const profileAst = JSON.parse(
+    await readFile('valid.supr.ast.json', { encoding: 'utf-8' })
+  );
+  const mapAst = JSON.parse(
+    await readFile('valid.osm.suma.ast.json', { encoding: 'utf-8' })
+  );
+
+  const provider = new Provider(profileAst, mapAst, 'https://overpass-api.de');
+
+  const boundProvider = await provider.bind({
+    // TODO: Add your auth keys here
+    // No keys are needed for OSM
+  });
+
+  const result = await boundProvider.perform('PubOpeningHours', {
+    city: 'Praha',
+    nameRegex: 'Diego',
+  });
+
+  console.log(
+    'pubs/OSM result:',
+    inspect(result, {
+      depth: 5,
+      colors: true,
+    })
+  );
+}
+
+main();
+

fixtures/playgrounds/valid/valid.supr

@@ -0,0 +1,20 @@
+profile = "https://example.com/pubs"
+
+"""
+List pub opening hours
+"""
+usecase PubOpeningHours {
+	input {
+		city! string!
+		nameRegex string!
+	}
+
+	result [{ name string, openingHours string }]
+
+	error PubOpeningHoursError
+}
+
+model PubOpeningHoursError enum {
+	TIMEOUT
+}
+

package.json

@@ -5,13 +5,14 @@
   "main": "dist/index.js",
   "repository": "[email protected]:superfaceai/cli.git",
   "author": "Superface Team",
-  "private": true,
+  "private": false,
   "bin": {
-    "superface": "./bin/superface",
-    "sf": "./bin/superface"
+    "superface": "bin/superface",
+    "sf": "bin/superface"
   },
   "files": [
-    "./bin/"
+    "bin/",
+    "dist/"
   ],
   "scripts": {
     "build": "tsc -p tsconfig.release.json --outDir dist",
@@ -23,15 +24,18 @@
     "prepush": "yarn test && yarn lint && yarn format"
   },
   "devDependencies": {
+    "@types/debug": "^4.1.5",
+    "@types/inquirer": "^7.3.1",
     "@types/jest": "^26.0.15",
+    "@types/rimraf": "^3.0.0",
     "@typescript-eslint/eslint-plugin": "^4.7.0",
     "@typescript-eslint/parser": "^4.7.0",
     "eslint": "^7.13.0",
     "eslint-config-prettier": "^6.15.0",
     "eslint-import-resolver-typescript": "^2.3.0",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-jest": "^24.1.2",
-    "eslint-plugin-simple-import-sort": "^5.0.3",
+    "eslint-plugin-simple-import-sort": "^6.0.1",
     "jest": "^26.6.3",
     "prettier": "^2.1.2",
     "stdout-stderr": "TheEdward162/stdout-stderr#fb3e22a",
@@ -41,7 +45,12 @@
   "dependencies": {
     "@oclif/command": "^1.8.0",
     "@oclif/config": "^1.17.0",
-    "@superfaceai/parser": "0.0.6"
+    "@superfaceai/parser": "0.0.6",
+    "chalk": "^4.1.0",
+    "debug": "^4.3.1",
+    "inquirer": "^7.3.3",
+    "inquirer-file-tree-selection-prompt": "^1.0.7",
+    "rimraf": "^3.0.2"
   },
   "oclif": {
     "commands": "./dist/commands",

src/commands/compile.test.ts

@@ -1,6 +1,6 @@
 import { stderr, stdout } from 'stdout-stderr';
 
-import { readFilePromise } from '../common/io';
+import { readFile } from '../common/io';
 import Compile from './compile';
 
 describe('Compile CLI command', () => {
@@ -18,7 +18,7 @@ describe('Compile CLI command', () => {
     it('compiles map', async () => {
       const mapASTFixture = JSON.parse(
         (
-          await readFilePromise('./fixtures/transpiled/testMap.suma.ast.json')
+          await readFile('./fixtures/transpiled/testMap.suma.ast.json')
         ).toString()
       ) as unknown;
       await Compile.run(['./fixtures/testMap.suma', '-o', '-']);
@@ -29,9 +29,7 @@ describe('Compile CLI command', () => {
     it('compiles profile', async () => {
       const profileASTFixture = JSON.parse(
         (
-          await readFilePromise(
-            './fixtures/transpiled/testProfile.supr.ast.json'
-          )
+          await readFile('./fixtures/transpiled/testProfile.supr.ast.json')
         ).toString()
       ) as unknown;
       await Compile.run(['./fixtures/testProfile.supr', '-o', '-2']);
@@ -42,14 +40,12 @@ describe('Compile CLI command', () => {
     it('compiles two files into one stream', async () => {
       const mapASTFixture = JSON.parse(
         (
-          await readFilePromise('./fixtures/transpiled/testMap.suma.ast.json')
+          await readFile('./fixtures/transpiled/testMap.suma.ast.json')
         ).toString()
       ) as unknown;
       const profileASTFixture = JSON.parse(
         (
-          await readFilePromise(
-            './fixtures/transpiled/testProfile.supr.ast.json'
-          )
+          await readFile('./fixtures/transpiled/testProfile.supr.ast.json')
         ).toString()
       ) as unknown;
 

src/commands/compile.ts

@@ -1,5 +1,4 @@
 import { Command, flags } from '@oclif/command';
-import { CLIError } from '@oclif/errors';
 import { Source } from '@superfaceai/parser';
 import * as nodePath from 'path';
 
@@ -8,8 +7,9 @@ import {
   DocumentType,
   inferDocumentTypeWithFlag,
 } from '../common/document';
+import { assertIsIOError, userError } from '../common/error';
 import { DocumentTypeFlag, documentTypeFlag } from '../common/flags';
-import { lstatPromise, OutputStream, readFilePromise } from '../common/io';
+import { lstat, OutputStream, readFile } from '../common/io';
 
 export default class Compile extends Command {
   static description = 'Compiles the given profile or map to AST.';
@@ -53,16 +53,13 @@ export default class Compile extends Command {
     if (outputPath !== undefined) {
       let isDirectory = false;
       try {
-        const lstat = await lstatPromise(outputPath);
-        isDirectory = lstat.isDirectory();
-      } catch (e) {
+        const lstatInfo = await lstat(outputPath);
+        isDirectory = lstatInfo.isDirectory();
+      } catch (err: unknown) {
         // eat ENOENT error and keep isDirectory false
-        if (e !== null && typeof e === 'object' && 'code' in e) {
-          // All the checks done and eslint still complains
-          // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-          if (e.code !== 'ENOENT') {
-            throw e;
-          }
+        assertIsIOError(err);
+        if (err.code !== 'ENOENT') {
+          throw err;
         }
       }
 
@@ -126,11 +123,11 @@ export default class Compile extends Command {
   ): Promise<unknown> {
     const documentType = inferDocumentTypeWithFlag(documentTypeFlag, path);
     if (documentType === DocumentType.UNKNOWN) {
-      throw new CLIError('Could not infer document type', { exit: 1 });
+      throw userError('Could not infer document type', 1);
     }
 
     const parseFunction = DOCUMENT_PARSE_FUNCTION[documentType];
-    const content = (await readFilePromise(path)).toString();
+    const content = (await readFile(path)).toString();
     const source = new Source(content, nodePath.basename(path));
 
     return parseFunction(source);