@looker/api-explorer 0.9.18 → 0.9.24

package/CHANGELOG.md

@@ -5,6 +5,147 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+### [0.9.24](https://www.github.com/looker-open-source/sdk-codegen/compare/api-explorer-v0.9.23...api-explorer-v0.9.24) (2021-12-06)
+
+
+### Features
+
+* OAuthConfigProvider ([209f399](https://www.github.com/looker-open-source/sdk-codegen/commit/209f399a089beb28405a178d3dc8f769478ae97b))
+
+
+### Bug Fixes
+
+* enum naming and registration ([#918](https://www.github.com/looker-open-source/sdk-codegen/issues/918)) ([9d4a6cb](https://www.github.com/looker-open-source/sdk-codegen/commit/9d4a6cbfac5defad3a35389e2d46947d2135d349))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @looker/extension-utils bumped from ^0.1.0 to ^0.1.1
+    * @looker/code-editor bumped from ^0.1.14 to ^0.1.15
+    * @looker/run-it bumped from ^0.9.23 to ^0.9.24
+    * @looker/sdk-codegen bumped from ^21.2.0 to ^21.2.1
+  * devDependencies
+    * @looker/sdk-codegen-scripts bumped from ^21.1.3 to ^21.1.4
+
+### [0.9.23](https://www.github.com/looker-open-source/sdk-codegen/compare/api-explorer-v0.9.22...api-explorer-v0.9.23) (2021-11-10)
+
+
+### Features
+
+* create @looker/extension-utils ([#886](https://www.github.com/looker-open-source/sdk-codegen/issues/886)) ([9d1720d](https://www.github.com/looker-open-source/sdk-codegen/commit/9d1720d9a4cec00c45195dd9c716d9a2a929264f))
+
+
+### Bug Fixes
+
+* api explorer initialization  ([#885](https://www.github.com/looker-open-source/sdk-codegen/issues/885)) ([b08b08e](https://www.github.com/looker-open-source/sdk-codegen/commit/b08b08e9767725e19a573bac0385320bb903490d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @looker/code-editor bumped from ^0.1.13 to ^0.1.14
+    * @looker/run-it bumped from ^0.9.22 to ^0.9.23
+    * @looker/sdk bumped from ^21.18.1 to ^21.20.0
+    * @looker/sdk-codegen bumped from ^21.1.1 to ^21.2.0
+    * @looker/sdk-rtl bumped from ^21.1.1 to ^21.2.0
+  * devDependencies
+    * @looker/sdk-codegen-scripts bumped from ^21.1.2 to ^21.1.3
+    * @looker/sdk-node bumped from ^21.18.1 to ^21.20.0
+
+### [0.9.22](https://www.github.com/looker-open-source/sdk-codegen/compare/api-explorer-v0.9.21...api-explorer-v0.9.22) (2021-10-27)
+
+
+### Bug Fixes
+
+* another TS SDK error handling tweak ([#873](https://www.github.com/looker-open-source/sdk-codegen/issues/873)) ([1c04952](https://www.github.com/looker-open-source/sdk-codegen/commit/1c049527e22926fa7fe0ae011ab4595520005e2f))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @looker/code-editor bumped from ^0.1.12 to ^0.1.13
+    * @looker/run-it bumped from ^0.9.21 to ^0.9.22
+    * @looker/sdk bumped from ^21.18.0 to ^21.18.1
+    * @looker/sdk-codegen bumped from ^21.1.0 to ^21.1.1
+    * @looker/sdk-rtl bumped from ^21.1.0 to ^21.1.1
+  * devDependencies
+    * @looker/sdk-codegen-scripts bumped from ^21.1.1 to ^21.1.2
+    * @looker/sdk-node bumped from ^21.18.0 to ^21.18.1
+
+### [0.9.21](https://www.github.com/looker-open-source/sdk-codegen/compare/api-explorer-v0.9.20...api-explorer-v0.9.21) (2021-10-24)
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @looker/code-editor bumped from ^0.1.11 to ^0.1.12
+    * @looker/run-it bumped from ^0.9.20 to ^0.9.21
+    * @looker/sdk bumped from ^21.16.0 to ^21.18.0
+  * devDependencies
+    * @looker/sdk-codegen-scripts bumped from ^21.1.0 to ^21.1.1
+    * @looker/sdk-node bumped from ^21.16.0 to ^21.18.0
+
+### [0.9.20](https://www.github.com/looker-open-source/sdk-codegen/compare/api-explorer-v0.9.19...api-explorer-v0.9.20) (2021-10-19)
+
+
+### Features
+
+* closest path match for API Explorer ([#811](https://www.github.com/looker-open-source/sdk-codegen/issues/811)) ([45fd26f](https://www.github.com/looker-open-source/sdk-codegen/commit/45fd26fb0f325fa90edfec72f835ed3a79b9afeb))
+* headless nav toggle ([#860](https://www.github.com/looker-open-source/sdk-codegen/issues/860)) ([8e66d1b](https://www.github.com/looker-open-source/sdk-codegen/commit/8e66d1bed84cdcf91b92dccdb5cdbb87be5c3f4a))
+* lots of RunIt form cleanup ([#814](https://www.github.com/looker-open-source/sdk-codegen/issues/814)) ([e92eae8](https://www.github.com/looker-open-source/sdk-codegen/commit/e92eae8fc127a0aa99545ca9c577152c08d59000))
+* makeTheCall for Kotlin and type tagging ([#833](https://www.github.com/looker-open-source/sdk-codegen/issues/833)) ([2ca950e](https://www.github.com/looker-open-source/sdk-codegen/commit/2ca950e16c9c172d3e67de58261df16e424efaa3))
+* Use agenda data for the Hackathon home page ([#842](https://www.github.com/looker-open-source/sdk-codegen/issues/842)) ([0da2523](https://www.github.com/looker-open-source/sdk-codegen/commit/0da25239c3f108cb684309818c33c91c2a7c3278))
+
+
+### Bug Fixes
+
+* Extension Api Explorer markdown link clicks ([#830](https://www.github.com/looker-open-source/sdk-codegen/issues/830)) ([dd8a3f0](https://www.github.com/looker-open-source/sdk-codegen/commit/dd8a3f03b8ea03858271bf55307c7d359631455a))
+* request content initialization and filtering for RunIt requests ([#852](https://www.github.com/looker-open-source/sdk-codegen/issues/852)) ([474ee93](https://www.github.com/looker-open-source/sdk-codegen/commit/474ee9365dafe6549826a9f627ac0a79dc0e9a56))
+* Sidenav selection ([#831](https://www.github.com/looker-open-source/sdk-codegen/issues/831)) ([52e3ef3](https://www.github.com/looker-open-source/sdk-codegen/commit/52e3ef31a6157a6a544bf712a73d118d22913583))
+* type issues, tests and bin/deploy ([#844](https://www.github.com/looker-open-source/sdk-codegen/issues/844)) ([9e4a141](https://www.github.com/looker-open-source/sdk-codegen/commit/9e4a1413d4b6267805c0514dac1def93f5a56cb6))
+* typo with error boundary ([#851](https://www.github.com/looker-open-source/sdk-codegen/issues/851)) ([bb08f25](https://www.github.com/looker-open-source/sdk-codegen/commit/bb08f258354bb6439f08d29f340b1f396841ab12))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @looker/code-editor bumped from ^0.1.10 to ^0.1.11
+    * @looker/run-it bumped from ^0.9.19 to ^0.9.20
+    * @looker/sdk bumped from ^21.14.0 to ^21.16.0
+    * @looker/sdk-codegen bumped from ^21.0.25 to ^21.1.0
+    * @looker/sdk-rtl bumped from ^21.0.20 to ^21.1.0
+  * devDependencies
+    * @looker/sdk-codegen-scripts bumped from ^21.0.27 to ^21.1.0
+    * @looker/sdk-node bumped from ^21.14.0 to ^21.16.0
+
+### [0.9.19](https://www.github.com/looker-open-source/sdk-codegen/compare/api-explorer-v0.9.18...api-explorer-v0.9.19) (2021-09-01)
+
+
+### Features
+
+* http response explorer for RunIt ([#800](https://www.github.com/looker-open-source/sdk-codegen/issues/800)) ([3f273ea](https://www.github.com/looker-open-source/sdk-codegen/commit/3f273ea7f849dafece8f4f5f60558021ecd41705))
+* new configuration UI for API Explorer ([#803](https://www.github.com/looker-open-source/sdk-codegen/issues/803)) ([e6c67d1](https://www.github.com/looker-open-source/sdk-codegen/commit/e6c67d1211b412d4ce83127c9f7a8f091e3cf27f))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @looker/code-editor bumped from ^0.1.9 to ^0.1.10
+    * @looker/run-it bumped from ^0.9.18 to ^0.9.19
+    * @looker/sdk bumped from ^21.12.0 to ^21.14.0
+    * @looker/sdk-codegen bumped from ^21.0.24 to ^21.0.25
+    * @looker/sdk-rtl bumped from ^21.0.19 to ^21.0.20
+  * devDependencies
+    * @looker/sdk-codegen-scripts bumped from ^21.0.26 to ^21.0.27
+    * @looker/sdk-node bumped from ^21.12.0 to ^21.14.0
+
 ### [0.9.18](https://www.github.com/looker-open-source/sdk-codegen/compare/api-explorer-v0.9.17...api-explorer-v0.9.18) (2021-08-11)
 
 

package/e2e/e2e.spec.ts

@@ -0,0 +1,242 @@
+/*
+
+ MIT License
+
+ Copyright (c) 2021 Looker Data Sciences, Inc.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.
+
+ */
+import '@testing-library/jest-dom'
+
+import { goToPage, pageReload } from './helpers'
+
+// https://github.com/smooth-code/jest-puppeteer/tree/master/packages/expect-puppeteer
+// https://github.com/puppeteer/puppeteer/blob/main/docs/api.md
+
+jest.setTimeout(120000)
+
+const BASE_URL = 'https://localhost:8080'
+const v31 = `${BASE_URL}/3.1`
+const v40 = `${BASE_URL}/4.0`
+
+describe('API Explorer', () => {
+  beforeEach(async () => {
+    await jestPuppeteer.resetBrowser()
+  })
+
+  describe('general', () => {
+    beforeEach(async () => {
+      await goToPage(v31)
+    })
+
+    it('renders a method page', async () => {
+      await expect(page).toClick('h4', { text: 'Dashboard' })
+      await Promise.all([
+        page.waitForNavigation(),
+        expect(page).toClick('a', { text: 'Get All Dashboards' }),
+      ])
+      await expect(page.url()).toEqual(
+        `${v31}/methods/Dashboard/all_dashboards`
+      )
+
+      // title
+      await expect(page).toMatchElement('h2', { text: 'Get All Dashboards' })
+
+      // markdown
+      await expect(page).toMatchElement('div', {
+        text: 'Get information about all active dashboards',
+      })
+
+      // sdk declaration
+      await expect(page).toMatchElement('h3', { text: 'Python Declaration' })
+
+      // sdk examples
+      await expect(page).toMatchElement('h3', { text: 'SDK Examples' })
+      const examples = await page.$$(
+        'table[aria-label="SDK Examples"] > tbody > tr'
+      )
+      expect(examples.length).toBeGreaterThan(0)
+
+      // type references
+      await expect(page).toMatchElement('h3', { text: 'References' })
+      const docLinks = await page.$$('.doc-link')
+      expect(docLinks.length).toBeGreaterThan(0)
+      await docLinks[0].click()
+      const typeName = await page.evaluate((e) => e.innerText, docLinks[0])
+      await expect(page).toMatchElement('h2', { text: typeName })
+      await page.goBack()
+
+      // response models
+      await expect(page).toMatchElement('h3', { text: 'Response Models' })
+
+      // original schema
+      await expect(page).toMatchElement('h3', { text: 'Original Schema' })
+    })
+
+    it('renders a type page', async () => {
+      await expect(page).toClick('button', { text: /^Types/ })
+      await expect(page).toClick('h4', { text: 'ApiAuth' })
+      await expect(page).toClick('a', { text: 'AccessToken' })
+
+      // title
+      await expect(page).toMatchElement('h2', { text: 'AccessToken' })
+
+      // references
+      await expect(page).toMatchElement('h3', { text: 'References' })
+      const docLinks = await page.$$('.doc-link')
+      expect(docLinks.length).toBeGreaterThan(0)
+
+      // sdk declaration
+      await expect(page).toMatchElement('h3', { text: 'Python Declaration' })
+
+      // original schema
+      await expect(page).toMatchElement('h3', { text: 'Original Schema' })
+    })
+
+    it('renders a tag scene and filters by operation', async () => {
+      await expect(page).toClick('h4', { text: 'ApiAuth' })
+      await expect(page).toMatchElement('h2', {
+        text: 'ApiAuth: API Authentication',
+      })
+      await expect(page.url()).toMatch(`${v31}/methods/ApiAuth`)
+
+      await expect(page).toMatchElement(
+        'button[value="ALL"][aria-pressed=true]'
+      )
+      await expect(page).toMatchElement('div[type="DELETE"]')
+      await expect(page).toMatchElement('div[type="POST"]')
+
+      await page.click('button[value="POST"]')
+      await expect(page).not.toMatchElement('div[type="DELETE"]')
+      await expect(page).toMatchElement('div[type="POST"]')
+
+      await page.click('button[value="DELETE"]')
+      await expect(page).toMatchElement('div[type="DELETE"]')
+      await expect(page).not.toMatchElement('div[type="POST"]')
+    })
+
+    it('toggles sidenav', async () => {
+      const searchSelector = 'input[aria-label="Search"]'
+      const navToggleSelector = 'button[aria-label="nav toggle"]'
+      await expect(page).toMatchElement(searchSelector)
+      await expect(page).toClick(navToggleSelector)
+      await expect(page).not.toMatchElement(searchSelector)
+      await expect(page).toClick(navToggleSelector)
+      await expect(page).toMatchElement(searchSelector)
+    })
+
+    it('remembers the chosen language', async () => {
+      const selector = 'input[aria-label="sdk language selector"]'
+      let languageHandle = await page.$(`${selector}[value="Python"]`)
+      expect(languageHandle).not.toBeNull()
+      expect(await page.evaluate((x) => x.value, languageHandle)).toEqual(
+        'Python'
+      )
+      await expect(page).toClick('h4', { text: 'Dashboard' })
+      await expect(page).toClick('a', { text: 'Get All Dashboards' })
+      await expect(page).toMatchElement('h3', { text: 'Python Declaration' })
+
+      await languageHandle?.click()
+      await expect(page).toClick('li', { text: 'Kotlin' })
+      await pageReload()
+      languageHandle = await page.$(`${selector}[value="Kotlin"]`)
+      expect(languageHandle).not.toBeNull()
+      expect(await page.evaluate((x) => x.value, languageHandle)).toEqual(
+        'Kotlin'
+      )
+      await expect(page).toMatchElement('h3', { text: 'Kotlin Declaration' })
+    })
+
+    it('changes specs', async () => {
+      await expect(page).toMatchElement('h2', {
+        text: 'Looker API 3.1 Reference',
+      })
+      await expect(page).toClick('input[value="3.1"]')
+      await expect(page).toClick(
+        'ul[aria-label="spec selector"] > li:last-child'
+      )
+      await expect(page).toMatchElement('h2', {
+        text: 'Looker API 4.0 (Experimental) Reference',
+      })
+    })
+  })
+
+  describe('navigation', () => {
+    it('should be able to navigate directly to a spec home', async () => {
+      await goToPage(v31)
+      await expect(page).toMatchElement('h2', {
+        text: 'Looker API 3.1 Reference',
+      })
+      await expect(page).toMatchElement('input[value="3.1"]')
+    })
+
+    it('should be able to navigate directly to a tag scene', async () => {
+      await goToPage(`${v31}/methods/Dashboard`)
+      await expect(page).toMatchElement('h2', {
+        text: 'Dashboard: Manage Dashboards',
+      })
+    })
+
+    it('should be able to navigate directly to a method', async () => {
+      await goToPage(`${v40}/methods/Dashboard/all_dashboards`)
+      await expect(page).toMatchElement('h2', { text: 'Get All Dashboards' })
+      await expect(page).toMatchElement('div', {
+        text: 'Get information about all active dashboards',
+      })
+    })
+
+    it('should be able to navigate directly to a type', async () => {
+      await goToPage(`${v31}/types/Query/Query`)
+      await expect(page).toMatchElement('h2', { text: 'Query' })
+      await expect(page).toMatchElement('button', { text: 'Query' })
+    })
+  })
+
+  describe('search', () => {
+    beforeEach(async () => {
+      await goToPage(v31)
+    })
+
+    it('searches methods', async () => {
+      await expect(page).toFill('input[aria-label="Search"]', 'get workspace')
+      // TODO: find a better way to avoid the scenario where L215 executes before search returns
+      await page.waitForTimeout(250)
+      await expect(page).toMatchElement('button', {
+        text: 'Methods (1)',
+      })
+      await expect(page).toMatchElement('button', { text: 'Types (0)' })
+      await expect(page).toClick('a', { text: 'Get Workspace' })
+      await expect(page).toMatchElement('h2', { text: 'Get Workspace' })
+      await expect(page.url()).toEqual(`${v31}/methods/Workspace/workspace`)
+    })
+
+    it('searches types', async () => {
+      await expect(page).toFill('input[aria-label="Search"]', 'writetheme')
+      await page.waitForTimeout(250)
+      await expect(page).toMatchElement('button', {
+        text: 'Methods (0)',
+      })
+      await expect(page).toClick('button', { text: 'Types (1)' })
+      await expect(page).toClick('a', { text: 'WriteTheme' })
+      await expect(page).toMatchElement('h2', { text: 'WriteTheme' })
+      await expect(page.url()).toEqual(`${v31}/types/Theme/WriteTheme`)
+    })
+  })
+})

package/{src/reducers/search/reducer.ts → e2e/helpers.ts}

@@ -23,44 +23,29 @@
  SOFTWARE.
 
  */
-
-import {
-  SearchCriterionTerm,
-  SearchAll,
-  SetToCriteria,
-} from '@looker/sdk-codegen'
-
-export interface SearchState {
-  pattern: string
-  criteria: SearchCriterionTerm[]
-}
-
-export interface SearchAction {
-  type: string
-  payload: Partial<SearchState>
+/**
+ * Reloads the page, waiting for for the DomContentLoaded event before resolving
+ */
+export const pageReload = async (): Promise<void> => {
+  await page.reload({ waitUntil: ['domcontentloaded', 'networkidle0'] })
 }
 
-export const defaultSearchState: SearchState = {
-  criteria: SetToCriteria(SearchAll) as SearchCriterionTerm[],
-  pattern: '',
+/**
+ * Navigates to the given url, waiting for the DomContentLoaded event before resolving
+ * @param url url to navigate to
+ */
+export const goToPage = async (url: string): Promise<void> => {
+  await page.goto(url, {
+    waitUntil: ['domcontentloaded', 'networkidle0'],
+    timeout: 60000,
+  })
 }
 
-export const searchReducer = (
-  state: SearchState = defaultSearchState,
-  action: SearchAction
-): SearchState => {
-  switch (action.type) {
-    case 'SET_PATTERN':
-      return {
-        ...state,
-        pattern: action.payload.pattern!,
-      }
-    case 'SET_CRITERIA':
-      return {
-        ...state,
-        criteria: action.payload.criteria!,
-      }
-    default:
-      return state
-  }
+/**
+ * Gets the key of the selected spec
+ */
+export const getSpecKey = async (): Promise<string> => {
+  const specSelectorHandle = await page.$('input[aria-label="spec selector"]')
+  const specKey = await page.evaluate((e) => e.value, specSelectorHandle)
+  return specKey
 }

package/{src/reducers/search/actions.ts → jest-puppeteer.config.js}

@@ -23,20 +23,22 @@
  SOFTWARE.
 
  */
-
-import { SearchCriterionTerm } from '@looker/sdk-codegen'
-import { SearchAction } from './reducer'
-
-export const setPattern = (pattern: string): SearchAction => ({
-  type: 'SET_PATTERN',
-  payload: {
-    pattern,
+module.exports = {
+  launch: {
+    headless: true,
+    args: ['--ignore-certificate-errors'],
+    product: 'chrome',
+    devtools: true,
+    defaultViewport: {
+      // override default 800x600 pixel browser setting
+      width: 1024,
+      height: 768,
+    },
   },
-})
-
-export const setCriteria = (criteria: SearchCriterionTerm[]): SearchAction => ({
-  type: 'SET_CRITERIA',
-  payload: {
-    criteria,
+  browserContext: 'default',
+  server: {
+    command: 'yarn develop',
+    port: 8080,
+    launchTimeout: 50000,
   },
-})
+}

package/jest.config.js

@@ -29,5 +29,7 @@ module.exports = {
   displayName: packageName,
   name: packageName,
   rootDir: '../..',
+  preset: 'jest-puppeteer',
+  setupFilesAfterEnv: ['expect-puppeteer'],
   testMatch: [`<rootDir>/packages/${packageName}/**/*.(spec|test).(ts|js)?(x)`],
 }

package/lib/ApiExplorer.d.ts

@@ -1,16 +1,13 @@
-import React, { FC } from 'react';
-import { Looker40SDK, Looker31SDK } from '@looker/sdk';
-import { SpecList } from '@looker/sdk-codegen';
-import { IApixEnvAdaptor } from './utils';
+import type { FC } from 'react';
+import type { SpecList } from '@looker/sdk-codegen';
+import type { RunItSetter } from '@looker/run-it';
+import type { IEnvironmentAdaptor } from '@looker/extension-utils';
 export interface ApiExplorerProps {
     specs: SpecList;
-    sdk?: Looker31SDK | Looker40SDK;
-    exampleLodeUrl?: string;
+    adaptor: IEnvironmentAdaptor;
+    setVersionsUrl: RunItSetter;
+    examplesLodeUrl?: string;
     declarationsLodeUrl?: string;
-    envAdaptor: IApixEnvAdaptor;
     headless?: boolean;
 }
-export declare const BodyOverride: import("styled-components").GlobalStyleComponent<{}, import("styled-components").DefaultTheme>;
-declare const ApiExplorer: FC<ApiExplorerProps>;
-export declare const AsideBorder: import("styled-components").StyledComponent<React.ForwardRefExoticComponent<import("@looker/components").AsideProps & React.RefAttributes<HTMLDivElement>>, import("styled-components").DefaultTheme, import("@looker/components").AsideProps, never>;
-export default ApiExplorer;
+export declare const ApiExplorer: FC<ApiExplorerProps>;