[RFC] [reference] Introduce Query Params #1579

harshithpabbati · 2020-06-11T18:17:36Z

This PR introduces Query Params

Todo

Pass query, variables through URI
Parse through the URI to get query, variables

acao · 2020-06-20T13:30:20Z

packages/graphiql/src/api/providers/GraphiQLBrowserProvider.tsx

+  );
+
+  React.useEffect(() => {
+    updateQueryStringURL(state.queryStringParams);


instead of doing the parsing here, the parsing should happen in the reducer. just to keep all the processing happening in one place, on a per-action basis

harshithpabbati · 2020-06-20T15:44:18Z

Also, @acao looks like main branch is not configured in netlify for preview URL's

acao · 2020-06-20T18:35:08Z

@harshithpabbati fixed! this was supposed to be changed programatically in netlify.toml but it didn't seem to work. should be good now!

acao · 2020-06-21T14:33:08Z

packages/graphiql/src/components/VariableEditor.tsx

@@ -89,6 +92,7 @@ export function VariableEditor(props: VariableEditorProps) {
      if (!ignoreChangeEvent) {
        cachedValueRef.current = editor.getValue();
        session.changeVariables(cachedValueRef.current);
+        browser.changeQueryStringParams('variables', cachedValueRef.current);


exactly what i was hoping for! excellent work @harshithpabbati !

acao · 2021-02-01T18:41:24Z

@harshithpabbati idea: make this a utility in @graphiql/toolkit, that only graphql cdn.ts imports that is implemented using props somehow

harshithpabbati · 2021-02-03T03:17:28Z

sure, will do 👍

changeset-bot · 2021-02-05T05:28:04Z

⚠️ No Changeset found

Latest commit: b00c488

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

codecov · 2021-02-05T05:31:28Z

Codecov Report

Merging #1579 (4fefbb7) into main (9223806) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1579   +/-   ##
=======================================
  Coverage   65.66%   65.66%           
=======================================
  Files          85       85           
  Lines        5115     5115           
  Branches     1624     1624           
=======================================
  Hits         3359     3359           
  Misses       1752     1752           
  Partials        4        4

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9223806...2774415. Read the comment docs.

acao · 2021-02-06T16:39:47Z

@harshithpabbati thanks for implementing this in the RFC as well!

* Migrated codemirror-graphql to typescript * Migrated codemirror-graphql tests to typescript * Cleaned up codemirror-graphql package.json set build output to root (to align with current behavior) * ignore generated __tests__ folder from eslint * Updated codemirror typing * Updated codemirror typing * Updated ci-e2e script * Exclude babel and jest config from npm files

Fixes graphql#899

Co-authored-by: Samuel <samuelimolo4real@gmail.com> Co-authored-by: Rikki <rikki.schulte@gmail.com>

imolorhe · 2021-02-19T01:05:07Z

packages/graphiql-2-rfc-context/src/api/providers/GraphiQLBrowserProvider.tsx

+    variables: parseQueryStringURL(window.location.search).variables,
+    operationName: parseQueryStringURL(window.location.search).operationName,
+  },
+  queryStringParamsURL: '',


I'm not sure I understand why we need to have both queryStringParams and queryStringParamsURL. If I understand it correctly, they both contain the same data, just formatted differently.

imolorhe · 2021-02-19T01:08:22Z

packages/graphiql-2-rfc-context/src/components/VariableEditor.tsx

@@ -89,6 +92,7 @@ export function VariableEditor(props: VariableEditorProps) {
      if (!ignoreChangeEvent) {
        cachedValueRef.current = editor.getValue();
        session.changeVariables(cachedValueRef.current);
+        browser.changeQueryStringParams('variables', cachedValueRef.current);


@acao question: should the browser context util be separated from the session context util? From what I can see, we seem to also be setting session whenever we are changing the query string. So perhaps the session context util can simply update the browser context as well? Or is there another reason why we have them separate that I'm not aware of?

Session here refers to the current tab, incidentally haha. Maybe EditorSession would be more explicit?

either way, all of this will be replaced. excellent points to consider in the next state management iteration.

acao · 2022-07-28T17:11:34Z

@thomasheyenbrock @jonathanawesome I think this one is really important to address in 2.0.0!

Users have long requested a configurable and safe way to handle query params, but most in their implementations are left up to them. The expectation of query, variables and a few other safe parameters (http request url is safe now) to come with GraphiQL is quite standard now, but it's not actually implemented!

acao changed the base branch from master to main June 19, 2020 14:37

acao reviewed Jun 20, 2020

View reviewed changes

harshithpabbati force-pushed the feat/query-params branch from c40b524 to 3d2fdfe Compare June 20, 2020 15:43

harshithpabbati force-pushed the feat/query-params branch 2 times, most recently from 0b790ea to eda6d26 Compare June 21, 2020 12:13

acao reviewed Jun 21, 2020

View reviewed changes

acao force-pushed the main branch 6 times, most recently from 4fa9ca3 to 1c11938 Compare February 1, 2021 18:22

harshithpabbati force-pushed the feat/query-params branch from eda6d26 to 93b618e Compare February 5, 2021 05:28

harshithpabbati force-pushed the feat/query-params branch from 93b618e to 3662456 Compare February 5, 2021 05:29

feat: [RFC] Introduce Query Params

ef36640

harshithpabbati force-pushed the feat/query-params branch from 3662456 to ef36640 Compare February 6, 2021 18:38

imolorhe and others added 7 commits February 9, 2021 08:59

added regression test for state.rule bug (graphql#1789)

ba4c56b

Fixes graphql#899

chore: remove lockfile from example (graphql#1767)

237c7ab

Move @graphiql/create-fetcher to @graphiql/toolkit (graphql#1788)

8cb4107

Co-authored-by: Samuel <samuelimolo4real@gmail.com> Co-authored-by: Rikki <rikki.schulte@gmail.com>

use github changeset config (graphql#1793)

86054b8

use GITHUB_TOKEN properly (graphql#1794)

7cbf791

use github changelog preset (graphql#1795)

3b86d55

acao added 2 commits February 9, 2021 23:30

changelog preset config (graphql#1796)

3286b9c

Merge branch 'main' into feat/query-params

e7f3344

acao force-pushed the main branch from b846951 to d9d1fb2 Compare February 12, 2021 04:11

Merge branch 'main' into feat/query-params

2774415

imolorhe reviewed Feb 19, 2021

View reviewed changes

Merge branch 'main' into feat/query-params

b00c488

acao force-pushed the main branch from f5265c7 to 7e98c6f Compare November 23, 2021 18:42

acao added the graphiql@2 label Dec 23, 2021

acao assigned thomasheyenbrock Jul 28, 2022

acao changed the title ~~feat: [RFC] Introduce Query Params~~ [RFC] [reference] Introduce Query Params Jul 30, 2022

acao added graphiql and removed graphiql@2 labels Nov 13, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[RFC] [reference] Introduce Query Params #1579

[RFC] [reference] Introduce Query Params #1579

harshithpabbati commented Jun 11, 2020

acao Jun 20, 2020

harshithpabbati commented Jun 20, 2020

acao commented Jun 20, 2020

acao Jun 21, 2020

acao commented Feb 1, 2021

harshithpabbati commented Feb 3, 2021

changeset-bot bot commented Feb 5, 2021 •

edited

Loading

codecov bot commented Feb 5, 2021 •

edited

Loading

acao commented Feb 6, 2021

imolorhe Feb 19, 2021

imolorhe Feb 19, 2021

acao Apr 5, 2021

acao Apr 18, 2021

acao commented Jul 28, 2022 •

edited

Loading

[RFC] [reference] Introduce Query Params #1579

Are you sure you want to change the base?

[RFC] [reference] Introduce Query Params #1579

Conversation

harshithpabbati commented Jun 11, 2020

acao Jun 20, 2020

Choose a reason for hiding this comment

harshithpabbati commented Jun 20, 2020

acao commented Jun 20, 2020

acao Jun 21, 2020

Choose a reason for hiding this comment

acao commented Feb 1, 2021

harshithpabbati commented Feb 3, 2021

changeset-bot bot commented Feb 5, 2021 • edited Loading

⚠️ No Changeset found

codecov bot commented Feb 5, 2021 • edited Loading

Codecov Report

acao commented Feb 6, 2021

imolorhe Feb 19, 2021

Choose a reason for hiding this comment

imolorhe Feb 19, 2021

Choose a reason for hiding this comment

acao Apr 5, 2021

Choose a reason for hiding this comment

acao Apr 18, 2021

Choose a reason for hiding this comment

acao commented Jul 28, 2022 • edited Loading

changeset-bot bot commented Feb 5, 2021 •

edited

Loading

codecov bot commented Feb 5, 2021 •

edited

Loading

acao commented Jul 28, 2022 •

edited

Loading