POC: Spike GraphQL query management and merging strategy (DONT MERGE) #30814
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fmontes
reviewed
Nov 29, 2024
| contentQueries: string; | ||
| }) => ` | ||
| fragment DotCMSPage on DotPage { | ||
| _map |
There was a problem hiding this comment.
Nope, we can define the props we need.
Comment on lines
+48
to
+53
| viewAs { | ||
| visitor { | ||
| persona { | ||
| name | ||
| } | ||
| } |
| page: { | ||
| url: params?.slug?.join('/'), | ||
| language: searchParams?.language_id, | ||
| mode: 'EDIT_MODE', |
There was a problem hiding this comment.
We need to control this, should be optional for them.
Comment on lines
-1
to
+20
| "use client"; | ||
| 'use client'; | ||
|
|
||
| import WebPageContent from "./content-types/webPageContent"; | ||
| import Banner from "./content-types/banner"; | ||
| import Blog from "./content-types/blog"; | ||
| import Activity from "./content-types/activity"; | ||
| import CallToAction from "./content-types/callToAction"; | ||
| import CalendarEvent from "./content-types/calendarEvent"; | ||
| import Product from "./content-types/product"; | ||
| import ImageComponent from "./content-types/image"; | ||
| import WebPageContent from './content-types/webPageContent'; | ||
| import Banner from './content-types/banner'; | ||
| import Blog from './content-types/blog'; | ||
| import Activity from './content-types/activity'; | ||
| import CallToAction from './content-types/callToAction'; | ||
| import CalendarEvent from './content-types/calendarEvent'; | ||
| import Product from './content-types/product'; | ||
| import ImageComponent from './content-types/image'; | ||
|
|
||
| import Header from "./layout/header/header"; | ||
| import Footer from "./layout/footer/footer"; | ||
| import Navigation from "./layout/navigation"; | ||
| import { usePathname, useRouter } from "next/navigation"; | ||
| import { DotcmsLayout } from "@dotcms/react"; | ||
| import { withExperiments } from "@dotcms/experiments"; | ||
| import { CustomNoComponent } from "./content-types/empty"; | ||
| import Header from './layout/header/header'; | ||
| import Footer from './layout/footer/footer'; | ||
| import Navigation from './layout/navigation'; | ||
| import { usePathname, useRouter } from 'next/navigation'; | ||
| import { DotcmsLayout } from '@dotcms/react'; | ||
| import { withExperiments } from '@dotcms/experiments'; | ||
| import { CustomNoComponent } from './content-types/empty'; | ||
|
|
||
| import { usePageAsset } from "../hooks/usePageAsset"; | ||
| import NotFound from "@/app/not-found"; | ||
| import { usePageAsset } from '../hooks/usePageAsset'; |
There was a problem hiding this comment.
My global prettier is configured for single quotes and maybe someone else in the team uses double quotes in their IDE, the examples does not have prettier
|
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This POC makes use of GraphQL Fragments in order to merge queries. Also makes use of the proposed API that we selected in the planning stage.
This way the developer should only write a
Fragmentto extend the Page API response and also can write as much queries as they want inside thecontentobject.In this case all limitations, errors, query depth, cache handling and implications will be inherited naturally from how the GraphQL API works, since we are using a native way of merge queries and should not require any extra work from our side apart from exposing a simple way of using dotCMS API with GQL Queries and adapt our current architecture to make it editable inside UVE (which changes can be seen in this PR in a simple version of how it should be).
Content Editing with this POC on UVE
Screen.Recording.2024-11-29.at.3.08.43.PM-1.mov
This POC is just a proof of how this can be achieved and not a final design of how this will work or the architecture of it, we still have to make some work to make this as clean, easy and reuse as much code as we can (building the queries inside content, at least the Lucene Query, can be done with an existing API).