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.4k
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
280
Data Loading Patterns in Ember
balint
1
190
Auth* in Ember apps with Torii
balint
1
290
(Somewhat) Complex Component Design – Ember.BP, 2015/02/11
balint
1
90
Complex Component Design in Ember
balint
0
370
Don't call me back - How Ember uses promises and how you can, too
balint
5
10k
Acceptance testing in Ember.js
balint
1
520
Unit testing in Ember.js
balint
0
73
Introduction to ember-data
balint
0
150
Other Decks in Technology
See All in Technology
フルカイテン株式会社 エンジニア向け採用資料
fullkaiten
0
5.5k
Azure Maps Visual in PowerBIで分析しよう
nakasho
0
190
企業が押さえるべきMCPの未来
takaakikakei
1
410
ここはMCPの夜明けまえ
nwiizo
32
13k
Aspire をカスタマイズしよう & Aspire 9.2
nenonaninu
0
370
Azure × MCP 入門
ry0y4n
7
960
10分で学ぶ、RAGの仕組みと実践
supermarimobros
0
830
Twelve-Factor-Appから学ぶECS設計プラクティス/ECS practice for Twelve-Factor-App
ozawa
3
160
AWSを利用する上で知っておきたい名前解決の話
nagisa53
6
590
本当に必要なのは「QAという技術」だった!試行錯誤から生まれた、品質とデリバリーの両取りアプローチ / Turns Out, "QA as a Discipline" Was the Key!
ar_tama
8
2k
Как мы автоматизировали интеграционное тестирование с Gonkey и не пожалели. Паша Егорычев, Кирилл Поляков
lamodatech
0
1.9k
Ninno LT
kawaguti
PRO
1
100
Featured
See All Featured
Chrome DevTools: State of the Union 2024 - Debugging React & Beyond
addyosmani
5
590
Helping Users Find Their Own Way: Creating Modern Search Experiences
danielanewman
29
2.6k
The Cult of Friendly URLs
andyhume
78
6.3k
Designing for Performance
lara
608
69k
Building Flexible Design Systems
yeseniaperezcruz
329
39k
Responsive Adventures: Dirty Tricks From The Dark Corners of Front-End
smashingmag
251
21k
Fantastic passwords and where to find them - at NoRuKo
philnash
51
3.2k
A designer walks into a library…
pauljervisheath
205
24k
Let's Do A Bunch of Simple Stuff to Make Websites Faster
chriscoyier
507
140k
Fireside Chat
paigeccino
37
3.4k
Raft: Consensus for Rubyists
vanstee
137
6.9k
Typedesign – Prime Four
hannesfritz
41
2.6k
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