Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Data Loading Patterns with JSON API
Search
Balint Erdi
March 28, 2017
Technology
5
1.2k
Data Loading Patterns with JSON API
The talk I gave at EmberConf 2017, on 03/28/2017
Balint Erdi
March 28, 2017
Tweet
Share
More Decks by Balint Erdi
See All by Balint Erdi
Why you should consider Ember.js for your next project
balint
4
240
Data Loading Patterns in Ember
balint
1
180
Auth* in Ember apps with Torii
balint
1
280
(Somewhat) Complex Component Design – Ember.BP, 2015/02/11
balint
1
85
Complex Component Design in Ember
balint
0
350
Don't call me back - How Ember uses promises and how you can, too
balint
5
10k
Acceptance testing in Ember.js
balint
1
510
Unit testing in Ember.js
balint
0
64
Introduction to ember-data
balint
0
150
Other Decks in Technology
See All in Technology
事前準備が肝!AI活用のための業務改革
layerx
PRO
1
400
学術機関におけるID連携とOpenID Connect
fujie
0
320
自作Cコンパイラ 8時間の奮闘
soukouki
0
860
Next.js のページ遷移を全力で止める
ypresto
9
3.6k
AI前提のサービス運用ってなんだろう?
ryuichi1208
3
1.1k
GC24 Recap: Interface Internals
task4233
0
280
o1のAPIで実験してみたが 制限きつすぎて辛かった話
pharma_x_tech
0
230
2024年のナビゲーション・フォーカス対応:Composeでキーボード・ナビゲーションをサポートしよう
tahia910
0
110
不動産 x AIことはじめ~データの真価を拓くために
estie
0
130
プロダクトエンジニアを支えるための開発生産性向上施策
tsukakei
0
150
「家族アルバム みてね」における運用管理・ オブザーバビリティの全貌 / Overview of Operation Management and Observability in FamilyAlbum
isaoshimizu
4
170
内製化を目指す事業会社が、システム開発会社と共に進める「開発生産性改善」の取り組み事例 #devsumi
yuwji
1
150
Featured
See All Featured
Put a Button on it: Removing Barriers to Going Fast.
kastner
58
3.4k
Speed Design
sergeychernyshev
22
430
How to name files
jennybc
75
98k
Documentation Writing (for coders)
carmenintech
65
4.3k
Dealing with People You Can't Stand - Big Design 2015
cassininazir
363
22k
Templates, Plugins, & Blocks: Oh My! Creating the theme that thinks of everything
marktimemedia
26
2k
Art, The Web, and Tiny UX
lynnandtonic
294
20k
CSS Pre-Processors: Stylus, Less & Sass
bermonpainter
354
29k
Pencils Down: Stop Designing & Start Developing
hursman
119
11k
Automating Front-end Workflow
addyosmani
1365
200k
Faster Mobile Websites
deanohume
304
30k
Designing for humans not robots
tammielis
248
25k
Transcript
Data Loading Patterns EmberConf 2017, Portland 03/28/2017
Data Loading Patterns with JSON API EmberConf 2017, Portland 03/28/2017
This talk is going to be … • A series
of prevalent use cases • Rich in code examples • Packed with actionable advice
Why JSON API?
What kind of API? • Backend dev: “What kind of
API are we going to use?” • Me: “JSON API” • We: “Let’s start working then”
CoC for APIs
Covering The Basics
Covering the basics (ED) • store.findRecord(‘band’, 1) • if the
record is in the store => returns it, and re-fetches it in the background • if the record is not in the store => returns a promise
Covering the basics (ED) • store.findAll(‘band’) • if >= 1
record in the store => returns them and triggers a refetch in the bg. • if there is no record in the store => returns a promise to fetch all of them
Covering the basics (ED) • store.peekRecord(‘band’, 1) • never triggers
a reload • returns the record if it’s in the store • returns null if it’s not
Covering the basics (ED) • store.peekAll(‘band’) • never triggers a
reload • returns the records already in the store
Covering the basics (ED) • shouldBackgroundReloadRecord • shouldBackgroundReloadAll • configurable
on the adapter
Covering the basics (Ember) • The model hooks are resolved
top-down • A child route is not entered before the hooks are run for its parent
Covering the basics (Ember) • Returning a promise in the
model hook “blocks” rendering the page • `findRecord`, `findAll`, `query` all return promises
The app
application bands bands.band.songs bands.band
Balint Erdi @baaz balinterdi.com Ember.js consultant
Case Studies
Fetching Relationship Data
Lazy Fetching
None
None
Pros & cons • Simple, works out of the box
• On-demand data fetching • Might trigger N requests • Disturbing flicker
Pre-loading the relationship
None
None
Move relationship data fetching to the route’s model hook if
you want to block rendering
Pros & cons • Better UX than the lazy fetching
scenario • Might still trigger N requests • RSVP.hash in the model hook is considered an anti-pattern
Side-loading
“An endpoint MAY also support an include request parameter to
allow the client to customize which related resources should be returned.”
None
None
None
None
Why is there a flicker? Shouldn’t the songs be side-loaded
and only then the page rendered?
None
None
None
Pros & cons • We leverage JSON:API • Explicit control
over fetching relationship data • Delays the rendering of the band template
Honorable mention: References API (ED 2.5)
Data loading strategy should be part of the design process
Searching on the Backend
“The filter query parameter is reserved for filtering data. Servers
and clients SHOULD use this key for filtering operations.”
None
None
Does a global search
None
None
Use a JSON API filter and query the relationship
Sorting
“An endpoint MAY support requests to sort the primary data
with a sort query parameter. The value for sort MUST represent sort fields.”
“The sort order for each sort field MUST be ascending
unless it is prefixed with a minus (U+002D HYPHEN-MINUS, “-“), in which case it MUST be descending.”
None
None
None
Use the JSON API `sort` parameter without transform
Pagination
“A server MAY choose to limit the number of resources
returned in a response to a subset (“page”) of the whole set available.”
“Note: JSON API is agnostic about the pagination strategy used
by a server. (…) The page query parameter can be used as a basis for any of these strategies.”
“Where specified, a meta member can be used to include
non-standard meta- information. The value of each meta member MUST be an object (a “meta object”).”
None
None
None
None
Use JSON API’s `page` parameters and pagination meta data
Indicating ongoing background record fetching
None
None
None
None
None
Eager return
None
None
Deconstruct the background data fetching process to have more control
over the loading process
Use ember-concurrency
None
No manual loading flag setting, run loop scheduling and reload
option setting
https://balinterdi.com/ emberconf
None
References • Rock and Roll with Ember book • {json:api}
specification • JSONAPI::Resources docs site • ember-concurrency or How I Learned to Stop Worrying and Love the Task on LinkedIn Enginnering • Lessons learned from four years with Ember by Ryan Toronto