Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

lifecycle-contract.ts

223 lines5.5 KB

1import {
2 QueryClient,
3 QueryClientProvider,
4 createQueryController,
5} from '@tanstack/lit-query'
6import { LitElement, html } from 'lit'
7​
8type ContractProbeData = {
9 provider: 'provider-a' | 'provider-b'
10 payload: string
12​
13type ContractTarget = 'orphan' | 'provider-a' | 'provider-b'
14​
15const contractQueryKey = ['lifecycle-contract', 'provider-binding'] as const
16let contractConsumerInstanceCount = 0
17​
18function createContractClient(data: ContractProbeData): QueryClient {
19 const client = new QueryClient({
20 defaultOptions: {
21 queries: {
22 retry: false,
23 staleTime: Number.POSITIVE_INFINITY,
24 },
25 },
26 })
27​
28 client.setQueryData(contractQueryKey, data)
29 return client
31​
32const contractClientA = createContractClient({
33 provider: 'provider-a',
34 payload: 'provider-a cache',
35})
36​
37const contractClientB = createContractClient({
38 provider: 'provider-b',
39 payload: 'provider-b cache',
40})
41​
42class ContractProviderA extends QueryClientProvider {
43 constructor() {
44 super()
45 this.client = contractClientA
46 }
47​
48 protected override createRenderRoot(): HTMLElement | DocumentFragment {
49 return this
50 }
52​
53if (!customElements.get('contract-provider-a')) {
54 customElements.define('contract-provider-a', ContractProviderA)
56​
57class ContractProviderB extends QueryClientProvider {
58 constructor() {
59 super()
60 this.client = contractClientB
61 }
62​
63 protected override createRenderRoot(): HTMLElement | DocumentFragment {
64 return this
65 }
67​
68if (!customElements.get('contract-provider-b')) {
69 customElements.define('contract-provider-b', ContractProviderB)
71​
72class LifecycleContractConsumer extends LitElement {
73 private readonly instanceId = ++contractConsumerInstanceCount
74​
75 private readonly query = createQueryController<ContractProbeData, Error>(
76 this,
77 {
78 queryKey: contractQueryKey,
79 queryFn: () => {
80 throw new Error(
81 'Lifecycle contract fixture unexpectedly fetched from queryFn.',
82 )
83 },
84 retry: false,
85 staleTime: Number.POSITIVE_INFINITY,
86 },
87 )
88​
89 protected override createRenderRoot(): HTMLElement | DocumentFragment {
90 return this
91 }
92​
93 private renderQueryState() {
94 try {
95 const query = this.query()
96​
97 return html`
98 <div data-testid="contract-query-status">query: ${query.status}</div>
99 <div data-testid="contract-provider-value">
100 provider: ${query.data?.provider ?? 'none'}
101 </div>
102 <div data-testid="contract-payload">
103 payload: ${query.data?.payload ?? 'none'}
104 </div>
105 <div data-testid="contract-error">
106 error: ${query.error ? query.error.message : 'none'}
107 </div>
108 `
109 } catch (error) {
110 const message = error instanceof Error ? error.message : String(error)
111​
112 return html`
113 <div data-testid="contract-query-status">query: missing-client</div>
114 <div data-testid="contract-provider-value">provider: none</div>
115 <div data-testid="contract-payload">payload: none</div>
116 <div data-testid="contract-error">error: ${message}</div>
117 `
118 }
119 }
120​
121 render() {
122 return html`
123 <div data-testid="contract-instance-id">instance: ${this.instanceId}</div>
124 ${this.renderQueryState()}
125 `
126 }
128​
129if (!customElements.get('lifecycle-contract-consumer')) {
130 customElements.define(
131 'lifecycle-contract-consumer',
132 LifecycleContractConsumer,
133 )
135​
136class LifecycleContractRoot extends LitElement {
137 static properties = {
138 currentTarget: { state: true },
139 }
140​
141 private currentTarget: ContractTarget = 'orphan'
142​
143 protected override createRenderRoot(): HTMLElement | DocumentFragment {
144 return this
145 }
146​
147 override firstUpdated(): void {
148 this.moveConsumerTo('orphan')
149 }
150​
151 moveConsumerTo(target: ContractTarget): void {
152 const consumer = this.ensureConsumer()
153 const destination = this.getContainer(target)
154 destination.appendChild(consumer)
155 this.currentTarget = target
156 this.requestUpdate()
157 }
158​
159 private ensureConsumer(): LifecycleContractConsumer {
160 const existing = this.querySelector<LifecycleContractConsumer>(
161 'lifecycle-contract-consumer',
162 )
163 if (existing) {
164 return existing
165 }
166​
167 return document.createElement(
168 'lifecycle-contract-consumer',
169 ) as LifecycleContractConsumer
170 }
171​
172 private getContainer(target: ContractTarget): HTMLElement {
173 const selector =
174 target === 'orphan'
175 ? '[data-contract-slot="orphan"]'
176 : target === 'provider-a'
177 ? 'contract-provider-a'
178 : 'contract-provider-b'
179​
180 const container = this.querySelector(selector)
181 if (!(container instanceof HTMLElement)) {
182 throw new Error(
183 `Lifecycle contract container not found for target "${target}".`,
184 )
185 }
186​
187 return container
188 }
189​
190 render() {
191 return html`
192 <main>
193 <h1>Lifecycle Contract Fixture</h1>
194 <p>
195 Exercises the same consumer across missing-provider and provider
196 switching flows.
197 </p>
198 <div data-testid="contract-location">
199 location: ${this.currentTarget}
200 </div>
201​
202 <section>
203 <h2>Orphan Zone</h2>
204 <div data-contract-slot="orphan"></div>
205 </section>
206​
207 <section>
208 <h2>Provider A</h2>
209 <contract-provider-a></contract-provider-a>
210 </section>
211​
212 <section>
213 <h2>Provider B</h2>
214 <contract-provider-b></contract-provider-b>
215 </section>
216 </main>
217 `
218 }
220​
221if (!customElements.get('lifecycle-contract-root')) {
222 customElements.define('lifecycle-contract-root', LifecycleContractRoot)