feat: http response explorer for RunIt #800

jkaster · 2021-08-13T00:15:55Z

ResponseExplorer adds to the RunIt Response tab:

collapsible body section
collapsible header table
copy to clipboard for SDK calls view via new CodeCopy component
also fixes the spinner behavior for the default Response tab
Login and Configure options are only needed for OAuth
ConfigForm also shows OAuth client configuration information
When Save is clicked on the config form, API specifications are reloaded from the configured server
If values are filled out for RunIt before Login is clicked, when OAuth returns, RunIt is re-opened and the entered values are restored in the Request form
added yarn scripts
- yarn dev:apix
- yarn dev:xapix

New PR because old one was blocked by CLA requirements

bryans99

Move a little bit of code

package.json

packages/run-it/src/components/CopyClipboardIconButton/CopyClipboardIconButton.tsx

resolved

josephaxisa

this is looking great! 👏

josephaxisa · 2021-08-17T13:18:23Z

packages/extension-api-explorer/src/ExtensionApiExplorer.tsx

+              specs={specs}
+              envAdaptor={extensionEnvAdaptor}
+              setVersionsUrl={runItNoSet}
+              // TODO We need expand/collapse side nav for the headless extension before we enabled this


is there a ticket for this?

Not yet. Wanted to discuss with you and @bryans99

and @jhardy

I'm in favor of the expand/collapse sidebar hamburger alternative. Created a ticket yet?

josephaxisa · 2021-08-17T13:18:53Z

packages/run-it/src/RunIt.tsx


 export type RunItHttpMethod = 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE'

 /**
 * Generic collection
 */
-export type RunItValues = { [key: string]: any }
+export type RunItValues = Record<string, any>


much cleaner :)

packages/run-it/src/components/ResponseExplorer/ResponseExplorer.spec.tsx

josephaxisa · 2021-08-17T13:25:50Z

packages/run-it/src/components/ResponseExplorer/ResponseExplorer.tsx

+  // TODO make a badge for the verb.
+  // Once we are satisfied with the badge in the api-explorer package it should be moved here


do we have a ticket for this?

This was an existing comment, and I did try method badge but it looked wonky. Want to give @jhardy a chance to look at it.

Dont forget the ticket

josephaxisa · 2021-08-17T13:26:54Z

packages/run-it/src/components/ResponseExplorer/ResponseExplorer.tsx

+const getHeaders = (response: ResponseContent): HeaderTable => {
+  if (!response?.headers) return []
+  const result: HeaderTable = []
+  Object.entries(response.headers).forEach(([key, val]) =>
+    result.push([key, val])
+  )
+  return result
+}
+
+const getBodySize = (response: ResponseContent): string => {
+  const size =
+    !response || !response.body
+      ? 0
+      : response?.body instanceof Blob
+      ? response?.body.size
+      : response?.body.toString().length
+
+  return `${size} bytes`
+}
+
+export const NoWrap = styled(Span)`
+  display: inline-block;
+  direction: rtl;
+  white-space: nowrap;
+  overflow: hidden;
+`


did you consider putting these into a separate utils file? Are there any related unit tests?

I can't think of a need for them outside of this component so I left them in this file.

packages/run-it/src/components/ResponseExplorer/ResponseExplorer.tsx

google-cla · 2021-08-17T15:54:00Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

google-cla · 2021-08-17T15:54:08Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

google-cla · 2021-08-17T15:54:15Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

google-cla · 2021-08-17T15:54:15Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

googlebot · 2021-08-17T16:37:46Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

josephaxisa · 2021-08-17T17:41:14Z

@googlebot I fixed it.

- added yarn scripts to the root `package.json`: - `yarn dev:apix` for stand-alone API Explorer - `yarn dev:apixx` for extension API Explorer - added `CodeCopy` component which is a wrapper for `CodeDisplay` and the clipboard UI - copy to clipboard works both stand-alone and in extension - ConfigForm.tsx `Verify` button no longer clears stored config. Only remove or save change the stored config. - WIP on CopyClipboardIconButton.tsx but it's not working yet

- `yarn:xapix` - code cleanup, but `CopyClipboardIconButton` doesn't work yet

- Login returns and reopens the RunIt form with whatever values are set ... if values *have* been set - Removed CopyClipboardIconButton.tsx because it does not pass A11y and is not mobile friendly

google-cla · 2021-08-17T18:41:02Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

github-actions · 2021-08-17T18:47:36Z

APIX Tests

    1 files   77 suites 2m 15s ⏱️
288 tests 275 ✔️ 13 💤 0 ❌
307 runs 294 ✔️ 13 💤 0 ❌

Results for commit 68716e4.

google-cla · 2021-08-17T21:29:17Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

github-actions · 2021-08-17T21:36:09Z

APIX Tests

    1 files   77 suites 2m 22s ⏱️
288 tests 275 ✔️ 13 💤 0 ❌
307 runs 294 ✔️ 13 💤 0 ❌

Results for commit 73bbd66.

google-cla · 2021-08-17T23:10:37Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

github-actions · 2021-08-17T23:17:34Z

APIX Tests

    1 files   77 suites 2m 22s ⏱️
288 tests 275 ✔️ 13 💤 0 ❌
307 runs 294 ✔️ 13 💤 0 ❌

Results for commit 6d9001b.

github-actions · 2021-08-17T23:23:33Z

Typescript Tests

    6 files   75 suites 2m 51s ⏱️
164 tests 160 ✔️   4 💤 0 ❌
546 runs 534 ✔️ 12 💤 0 ❌

Results for commit 6d9001b.

google-cla · 2021-08-17T23:39:32Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

google-cla · 2021-08-17T23:40:59Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

google-cla · 2021-08-17T23:41:31Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

github-actions · 2021-08-17T23:49:52Z

APIX Tests

    1 files   77 suites 3m 1s ⏱️
288 tests 275 ✔️ 13 💤 0 ❌
307 runs 294 ✔️ 13 💤 0 ❌

Results for commit c723df5.

github-actions · 2021-08-17T23:53:54Z

Typescript Tests

    6 files   75 suites 2m 52s ⏱️
164 tests 160 ✔️   4 💤 0 ❌
546 runs 534 ✔️ 12 💤 0 ❌

Results for commit c723df5.

bryans99

LGTM - there are a couple of items that could be cleaned up (they bug me :D ) but I'm okay without them.

There are a couple of buganizer tickets to write as well.

packages/api-explorer/src/ApiExplorer.tsx

bryans99 · 2021-08-18T00:14:43Z

packages/extension-api-explorer/src/ExtensionApiExplorer.tsx

+              specs={specs}
+              envAdaptor={extensionEnvAdaptor}
+              setVersionsUrl={runItNoSet}
+              // TODO We need expand/collapse side nav for the headless extension before we enabled this


I'm in favor of the expand/collapse sidebar hamburger alternative. Created a ticket yet?

bryans99 · 2021-08-18T00:18:39Z

packages/run-it/src/components/ResponseExplorer/ResponseExplorer.tsx

+  // TODO make a badge for the verb.
+  // Once we are satisfied with the badge in the api-explorer package it should be moved here


Dont forget the ticket

google-cla · 2021-08-18T00:52:51Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

github-actions · 2021-08-18T01:00:53Z

APIX Tests

    1 files   77 suites 2m 57s ⏱️
288 tests 275 ✔️ 13 💤 0 ❌
307 runs 294 ✔️ 13 💤 0 ❌

Results for commit 5991eac.

github-actions · 2021-08-18T01:04:16Z

Typescript Tests

    6 files   75 suites 2m 40s ⏱️
164 tests 160 ✔️   4 💤 0 ❌
546 runs 534 ✔️ 12 💤 0 ❌

Results for commit 5991eac.

bryans99

LGTM

jkaster requested review from jhardy, bryans99 and josephaxisa August 13, 2021 00:15

google-cla bot added the cla: yes label Aug 13, 2021

This comment has been minimized.

Sign in to view

jkaster changed the title ~~Response explorer implementation~~ feat: http response explorer for RunIt Aug 13, 2021

This comment has been minimized.

Sign in to view

bryans99 previously requested changes Aug 13, 2021

View reviewed changes

jkaster requested a review from bryans99 August 13, 2021 22:24

This comment has been minimized.

Sign in to view

josephaxisa reviewed Aug 17, 2021

View reviewed changes

google-cla bot added cla: no and removed cla: yes labels Aug 17, 2021

This comment has been minimized.

Sign in to view

jkaster added 6 commits August 17, 2021 17:50

New branch due to CLA blockage

452776a

PR feedback

865e498

- `yarn:xapix` - code cleanup, but `CopyClipboardIconButton` doesn't work yet

Login now remembers request form values

a641385

- Login returns and reopens the RunIt form with whatever values are set ... if values *have* been set - Removed CopyClipboardIconButton.tsx because it does not pass A11y and is not mobile friendly

API specs reload when Config is saved

bf32edd

Some PR feedback

405d2f5

fix some await issues in ApiExplorer.tsx

68716e4

some debug statements

73bbd66

oauth return fix

6d9001b

debug cleanup

bc227f2

cleanup ApiExplorerProps

16c266c

whoops missed one

c723df5

bryans99 previously approved these changes Aug 18, 2021

View reviewed changes

ignoring lint complaints for useEffect

5991eac

jkaster dismissed bryans99’s stale review via 5991eac August 18, 2021 00:52

bryans99 approved these changes Aug 18, 2021

View reviewed changes

jkaster merged commit 3f273ea into main Aug 18, 2021

jkaster deleted the jk/resp_exp_2 branch August 18, 2021 03:33

This comment has been minimized.

Sign in to view

		// TODO make a badge for the verb.
		// Once we are satisfied with the badge in the api-explorer package it should be moved here

feat: http response explorer for RunIt #800

feat: http response explorer for RunIt #800

Conversation

jkaster commented Aug 13, 2021 • edited Loading

This comment has been minimized.

This comment has been minimized.

bryans99 left a comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

josephaxisa left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

google-cla bot commented Aug 17, 2021

google-cla bot commented Aug 17, 2021

google-cla bot commented Aug 17, 2021

google-cla bot commented Aug 17, 2021

This comment has been minimized.

This comment has been minimized.

googlebot commented Aug 17, 2021

josephaxisa commented Aug 17, 2021

google-cla bot commented Aug 17, 2021

github-actions bot commented Aug 17, 2021

APIX Tests

google-cla bot commented Aug 17, 2021

github-actions bot commented Aug 17, 2021

APIX Tests

google-cla bot commented Aug 17, 2021

github-actions bot commented Aug 17, 2021

APIX Tests

github-actions bot commented Aug 17, 2021

Typescript Tests

google-cla bot commented Aug 17, 2021

google-cla bot commented Aug 17, 2021

google-cla bot commented Aug 17, 2021

github-actions bot commented Aug 17, 2021

APIX Tests

github-actions bot commented Aug 17, 2021

Typescript Tests

bryans99 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

google-cla bot commented Aug 18, 2021

github-actions bot commented Aug 18, 2021

APIX Tests

github-actions bot commented Aug 18, 2021

Typescript Tests

bryans99 left a comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

jkaster commented Aug 13, 2021 •

edited

Loading