begin rework

Author: jkaster

packages/run-it/src/RunIt.spec.tsx

@@ -68,7 +68,7 @@ describe('RunIt', () => {
       jest.clearAllMocks()
     })
 
-    test('it renders endpoint, request and response tabs, and form inputs', () => {
+    it('it renders endpoint, request and response tabs, and form inputs', () => {
       renderRunIt()
       // TODO fix this
       // expect(screen.getByRole('heading')).toHaveTextContent(
@@ -93,7 +93,7 @@ describe('RunIt', () => {
       ).not.toBeInTheDocument()
     })
 
-    test('the form submit handler invokes the request callback on submit', async () => {
+    it('the form submit handler invokes the request callback on submit', async () => {
       renderRunIt(api, api.methods.me)
       const defaultRequestCallback = jest
         .spyOn(sdk.authSession.transport, 'rawRequest')
@@ -108,13 +108,13 @@ describe('RunIt', () => {
         ).toBeInTheDocument()
         expect(
           screen.getByRole('heading', {
-            name: 'GET https://self-signed.looker.com:19999/user',
+            name: 'GET https://self-signed.looker.com:19999/api/4.0/user',
           })
         ).toBeInTheDocument()
       })
     })
 
-    test('run_inline_query has required body parameters', async () => {
+    it('run_inline_query has required body parameters', async () => {
       renderRunIt()
       const defaultRequestCallback = jest
         .spyOn(sdk.authSession.transport, 'rawRequest')
@@ -140,7 +140,7 @@ describe('RunIt', () => {
       })
     })
 
-    test('it has Configure button', () => {
+    it('it has Configure button', () => {
       renderRunIt()
       expect(
         screen.getByRole('button', { name: 'Configure' })
@@ -163,7 +163,7 @@ describe('RunIt', () => {
       })
     })
 
-    test('it has Login button', () => {
+    it('it has Login button', () => {
       renderRunIt()
       expect(screen.getByRole('button', { name: 'Login' })).toBeInTheDocument()
       expect(

packages/run-it/src/RunIt.tsx

@@ -108,6 +108,10 @@ interface RunItProps {
   sdkLanguage?: string
 }
 
+// interface SpecParams {
+//   specKey: string
+// }
+
 /**
  * Given an array of inputs, a method, and an api model it renders a REST request form
  * which on submit performs a REST request and renders the response with the appropriate MIME type handler
@@ -118,6 +122,7 @@ export const RunIt: FC<RunItProps> = ({
   setVersionsUrl = runItNoSet,
   sdkLanguage = 'All',
 }) => {
+  // const { specKey } = useParams<SpecParams>()
   const httpMethod = method.httpMethod as RunItHttpMethod
   const endpoint = method.endpoint
   const { sdk, configurator } = useContext(RunItContext)
@@ -206,6 +211,9 @@ export const RunIt: FC<RunItProps> = ({
 
   // No SDK, no RunIt for you!
   if (!sdk) return <></>
+  const baseUrl = isExtension
+    ? 'need extension callback' // `${getExtensionSDK().lookerHostData?.hostUrl}/api/${specKey}`
+    : sdk.authSession.transport.options.base_url
 
   return (
     <Box bg="background" py="large" height="100%">
@@ -240,7 +248,7 @@ export const RunIt: FC<RunItProps> = ({
           <Loading
             loading={loading}
             message={`${httpMethod} ${fullRequestUrl(
-              sdk.authSession.transport,
+              baseUrl,
               endpoint,
               activeParams.path,
               activeParams.query
@@ -250,7 +258,7 @@ export const RunIt: FC<RunItProps> = ({
             response={responseContent}
             verb={httpMethod}
             path={fullRequestUrl(
-              sdk.authSession.transport,
+              baseUrl,
               endpoint,
               activeParams.path,
               activeParams.query

packages/run-it/src/utils/RunItSDK.ts

@@ -38,7 +38,7 @@ import { RunItConfigKey } from '../components'
 // https://docs.looker.com/reference/api-and-integration/api-cors
 const settings = {
   ...DefaultSettings(),
-  base_url: 'https://self-signed.looker.com:19999',
+  base_url: 'https://self-signed.looker.com:19999/api/4.0',
   agentTag: 'RunIt 0.8',
 } as IApiSettings
 

packages/run-it/src/utils/requestUtils.spec.ts

@@ -23,6 +23,7 @@
  SOFTWARE.
 
  */
+
 import type { RunItInput } from '../RunIt'
 import { testJsonResponse, api } from '../test-data'
 import { defaultConfigurator, StandaloneConfigurator } from '../components'
@@ -32,6 +33,7 @@ import {
   runRequest,
   createInputs,
   initRequestContent,
+  fullRequestUrl,
 } from './requestUtils'
 import { initRunItSdk } from './RunItSDK'
 
@@ -43,12 +45,12 @@ describe('requestUtils', () => {
   })
 
   describe('pathify', () => {
-    test('it returns unchanged path if no path params are specified', () => {
+    it('returns unchanged path if no path params are specified', () => {
       const actual = pathify('/logout')
       expect(actual).toEqual('/logout')
     })
 
-    test('it works path params', () => {
+    it('works path params', () => {
       const pathParams = {
         query_id: 1,
         result_format: 'json',
@@ -61,6 +63,45 @@ describe('requestUtils', () => {
     })
   })
 
+  describe('fullRequestUrl', () => {
+    it('has full path', () => {
+      const path = '/queries/{query_id}/run/{result_format}'
+      const pathParams = {
+        query_id: 1,
+        result_format: 'json',
+      }
+      const actual = fullRequestUrl(
+        sdk.authSession.transport.options.base_url,
+        path,
+        pathParams
+      )
+      expect(actual).toEqual(
+        'https://self-signed.looker.com:19999/api/4.0/queries/1/run/json'
+      )
+    })
+
+    it('has escaped query params', () => {
+      const path = '/dashboards/{dashboard_id}/search'
+      const pathParams = {
+        dashboard_id: 1,
+      }
+      const queryParams = {
+        title: 'SDK%',
+        description: '%dashboard&',
+        limit: 4,
+        offset: 10,
+      }
+      const actual = fullRequestUrl(
+        sdk.authSession.transport.options.base_url,
+        path,
+        pathParams,
+        queryParams
+      )
+      expect(actual).toEqual(
+        'https://self-signed.looker.com:19999/api/4.0/dashboards/1/search?title=SDK%25&description=%25dashboard%26&limit=4&offset=10'
+      )
+    })
+  })
   describe('createRequestParams', () => {
     const inputs: RunItInput[] = [
       {
@@ -107,7 +148,7 @@ describe('requestUtils', () => {
       body: '{}',
     }
 
-    test('empty json body is not removed', () => {
+    it('does not remove empty json body', () => {
       const [pathParams, queryParams, body] = createRequestParams(
         inputs,
         noBody
@@ -121,7 +162,7 @@ describe('requestUtils', () => {
       expect(body).toEqual({})
     })
 
-    test('it correctly identifies requestContent params location', () => {
+    it('correctly identifies requestContent params location', () => {
       const [pathParams, queryParams, body] = createRequestParams(
         inputs,
         requestContent
@@ -135,7 +176,7 @@ describe('requestUtils', () => {
       expect(body).toEqual(JSON.parse(requestContent.body))
     })
 
-    test('non JSON parsable strings are treated as x-www-form-urlencoded strings', () => {
+    it('treats non JSON parsable strings as x-www-form-urlencoded strings', () => {
       const urlParams = 'key1=value1&key2=value2'
       const [, , body] = createRequestParams(
         [
@@ -156,15 +197,14 @@ describe('requestUtils', () => {
   })
 
   describe('defaultRunItCallback', () => {
-    test('it makes a request', async () => {
+    it('makes a request', async () => {
       const spy = jest
         .spyOn(sdk.authSession.transport, 'rawRequest')
         .mockResolvedValueOnce(testJsonResponse)
       jest.spyOn(sdk.authSession, 'isAuthenticated').mockReturnValue(true)
 
       const resp = await runRequest(
         sdk,
-        '/api/3.1',
         'POST',
         '/queries/run/{result_format}',
         { result_format: 'json' },
@@ -174,7 +214,7 @@ describe('requestUtils', () => {
 
       expect(spy).toHaveBeenCalledWith(
         'POST',
-        '/api/3.1/queries/run/json',
+        'https://self-signed.looker.com:19999/api/4.0/queries/run/json',
         {
           fields: 'first_name, last_name',
         },
@@ -190,7 +230,7 @@ describe('requestUtils', () => {
   })
 
   describe('createInputs', () => {
-    test('converts delimarray to string', () => {
+    it('converts delimarray to string', () => {
       const method = api.methods.all_users
       const actual = createInputs(api, method)
       expect(actual).toHaveLength(method.allParams.length)
@@ -203,7 +243,7 @@ describe('requestUtils', () => {
       })
     })
 
-    test('converts enums in body to string', () => {
+    it('converts enums in body to string', () => {
       const method = api.methods.create_query_task
       const actual = createInputs(api, method)
       expect(actual).toHaveLength(method.allParams.length)
@@ -223,7 +263,7 @@ describe('requestUtils', () => {
       })
     })
 
-    test('works with various param types', () => {
+    it('works with various param types', () => {
       const method = api.methods.run_inline_query
       const actual = createInputs(api, method)
       expect(actual).toHaveLength(method.allParams.length)
@@ -288,7 +328,7 @@ describe('requestUtils', () => {
   })
 
   describe('request content initialization', () => {
-    test('it initialzies body params with default values', () => {
+    it('it initialzies body params with default values', () => {
       const inputs = createInputs(api, api.methods.run_inline_query)
       const actual = initRequestContent(defaultConfigurator, inputs, {})
       expect(actual).toEqual({
@@ -317,7 +357,7 @@ describe('requestUtils', () => {
       })
     })
 
-    test('it contains default-empty body params', () => {
+    it('it contains default-empty body params', () => {
       const inputs = createInputs(api, api.methods.fetch_integration_form)
       const bodyInput = inputs.find((i) => i.location === 'body')!
       expect(bodyInput.name).toEqual('body')
@@ -332,7 +372,7 @@ describe('requestUtils', () => {
   describe('createRequestParams', () => {
     const inputs = createInputs(api, api.methods.run_inline_query)
 
-    test('removes empties for path, query and body params', () => {
+    it('removes empties for path, query and body params', () => {
       const requestContent = initRequestContent(defaultConfigurator, inputs)
       const [pathParams, queryParams, body] = createRequestParams(
         inputs,
@@ -346,7 +386,7 @@ describe('requestUtils', () => {
       })
     })
 
-    test('does mot remove empty bodies', () => {
+    it('does mot remove empty bodies', () => {
       const requestContent = { body: {} }
       const [pathParams, queryParams, body] = createRequestParams(
         inputs,

packages/run-it/src/utils/requestUtils.ts

@@ -24,7 +24,7 @@
 
  */
 
-import type { ITransport, IAPIMethods, IRawResponse } from '@looker/sdk-rtl'
+import type { IAPIMethods, IRawResponse } from '@looker/sdk-rtl'
 import cloneDeep from 'lodash/cloneDeep'
 import { isEmpty } from 'lodash'
 import type { IApiModel, IMethod, IType } from '@looker/sdk-codegen'
@@ -174,21 +174,20 @@ export const createRequestParams = (
 
 /**
  * Construct the full request URL
- * @param transport to get server's host url
+ * @param baseUrl full path to the API server version
  * @param path to REST server
  * @param pathParams path parameters
  * @param queryParams collection
  */
 export const fullRequestUrl = (
-  transport: ITransport,
+  baseUrl: string,
   path: string,
   pathParams: RunItValues,
   queryParams?: RunItValues
 ) => {
-  const base = transport.options.base_url
   path = pathify(path, pathParams)
   if (!path.match(/^(http:\/\/|https:\/\/)/gi)) {
-    path = `${base}${path}` // path was relative
+    path = `${baseUrl}${path}` // path was relative
   }
   path = addQueryParams(path, queryParams)
   return path
@@ -214,7 +213,11 @@ export const runRequest = async (
   if (!sdk.authSession.isAuthenticated()) {
     await sdk.ok(sdk.authSession.login())
   }
-  const url = fullRequestUrl(sdk.authSession.transport, endpoint, pathParams)
+  const url = fullRequestUrl(
+    sdk.authSession.transport.options.base_url,
+    endpoint,
+    pathParams
+  )
   const raw = await sdk.authSession.transport.rawRequest(
     httpMethod,
     url,

packages/sdk-rtl/src/extensionTransport.ts

@@ -71,8 +71,8 @@ export class ExtensionTransport implements ITransport {
     readonly options: ITransportSettings,
     private hostConnection: IHostConnection
   ) {
-    this.options = options
     this.hostConnection = hostConnection
+    this.options = options
   }
 
   observer: RawObserver | undefined