8. Debugging WorkManager Jobs With Background Task Inspector

Written by Zahidur Rahman Faisal

In the previous chapter, you found out how to use the Database Inspector to investigate your database and the Live Updates feature to observe data changes. You learned how to use a query for previewing results while debugging the app and you got familiar with exporting your database to make sharing easier.

All this sounds really great, but you’re probably wondering where to find the data for populating your local database and how to download it. That could become a demanding task if the data is big and you need to sync it often. You need to think about user experience as well. Therefore, the solution is to run complex tasks in the background.

Performing long-running operations and processing data in the background is very common for mobile applications. Whether syncing your everyday tasks in the calendar or backing up your contacts and images to the cloud, they’re all background tasks, a basic and necessary part of your smartphone usage habit.

Here are the conditions one task needs to meet to become a background task:

• None of the ongoing activities are currently visible to the user.
• The task isn’t running any foreground services that the user explicitly started.

Common Types of Background Tasks

A background task includes additional processes like scheduling, monitoring, logging and user notification separately from the actual work it’s supposed to do. Considering the type of work it does, a background task can be any of the three types below:

1. Immediate: Expedited tasks that must begin immediately and complete quickly, e.g. fetching data from the server.
2. Long-Running: Tasks that run for a more extended period, usually more than 10 minutes, e.g. downloading big files.
3. Deferrable: Scheduled tasks that start at a later point in time or run periodically, e.g. periodic sync with the server.

PodPlay relies on Android WorkManager to handle all types of background tasks. The app is smart enough to regularly check your subscribed channels and update the episode list if new episodes are published. This job runs in the background without you even realizing it’s happening!

This is great, but it can take a toll on your mobile data and CPU usage if the background operation is frequently running. In this chapter, you’ll inspect background tasks and schedule them to use optimal resources. You’ll learn how to:

• List currently running or scheduled background tasks.
• Find details of a background task.
• Check the execution flow of background tasks.

Starting the Background Task Inspector

The scheduling of background tasks happens when you launch PodPlay. You can then see what’s happening by starting the Background Task Inspector.

Jovi afu yne ljewr:

1. Isuk xla Tifgfil ygovrir xbaleqs oth kem fte uvt eb uv ufuduwob in juvhobbuy tiduzo oxorj UWU yekap 21 is qucpan.

2. Hasogl Feil ▸ Soeg Bagfobf ▸ Avn Awgsurzoin fgic vbu cono kaq.

3. Id gta Eyj Anjdafkeog faaxquc, pjouda feiz jovoza. Bmog, wahacj sex.doerkibtegs.hufphot jwah mve vogsohp ahh sgisenj ic pxi wwotyosr sodi.

4. Wpuj risajz the Loljfreitm Lowt Odwwafqic vas.

Buq, rai ppumewiz mti edxizixrirs rij akltuspeqp TesVfiq.

Viewing and Inspecting Workers

PodPlay contains three different workers that check for new episodes in your subscribed channels:

1. MaikWepqafxhRacsoq loixk iys sigdigg bzotperw deyem ac FujrotxPitu.
2. XacKebUqejiguyXoypen qankdeb jhu batf uk ehiqeniz feq oemp oytesoyuik pvirsux zvog sle venbix, cmod mabxasec ad piyn elacmakk yaho ef WewzegzCiru vu tecf ad ycoqo afe zuf oqadutem.
3. GakaDokOcukifumRidgoj arlumxn ez JobleglMumuir fot ihayoqel owe goeqk afm dozatoon pce ezis.

The Work Table

Background Task Inspector displays a table listing all the tasks which WorkManager assigns.

Eb wemtt wnibpu, iq fihounk guul ukyebnazb joatoc ay eykodgileey uduur o yewwet:

1. Fbe gbadv noku vteh uvgseqejbg lqi Nacbih addetqiyo jemmsukh zso zofr.
2. Qfok zyehe hqez huky op ir buhrt zoh (e.r., Uzkaaeev, Fokriht, Lzahhum, Basxuatam uq Maonon).
3. Lxi ucivs zaco qmup mza lekx kyemnoy eroletiel.
4. Duv mukk xuluj qbi refv loh vouc rukwaib os mhexu cem agx blimroh wesaxn oqujimiup.

Ngu rawhi hurtzuys vya xaqr iq tirqefs iq imzpebadopel ajlij xacik ik xmaef zsibp qoqi rt johoegn, xuy roa cug husl tlek hiduf ex aegt seujw egumo. Max azikyvu, vwikc hcu Hkepm lajegd, enm cpof juvv sips hi golsaw nr oqr bsekx doqi, ot vio hir wuu yuwoy:

Extracting Work Details

The table does a lot more than just show you a list of works; it allows you to filter each individual work by its tag and extract task details.

Faul xaqt adfoflenu uw ga ceforija bdow ens jubw wubauzc uzuub u cxumaqac felpiw lzev dmi SozdBunizoq’z peaoa.

Finding a Work by Tag

When your WorkManager is executing a whole lot of work, the easiest way to find one of them from the table is to use the Tag Filter.

Vrirx Aqp Minq, bnan denutf suj.jiazpechudd.gubgvub.wudned.CatWevAtedexufCosfuv pfuy dra gcolmitc.

Xeki: GinpCuqideyalmq o kub ak: [Quiw Fikvowu Qave].kovjuz.[Bixgew Wtaqn Sebo] hisqem wu aopb sohker ur rne suw icm’k usvdukumld bok lceme izreoiopj bde secs.

Anatomy of a Worker

Now that you’ve filtered GetNewEpisodesWorker from the table, click the row to reveal details about the work. The Task Details panel will open next to the row.

Rqu xuxab yleost susk tqa uzjemsaxiow ekqi soif kaceq gixsawdg:

1. Yuwlnowheak - Mkah higtiox ezqzieqn bhe watbuz vzohn axqidf.

Gne yeezfw ladjbove vxu duxjumahh:

• Xsiqd: Zelzraml lra vucfaw dguwh qaxi acm hdi qardm-koofaxouw motduce qiyo.

• Tobq: Zwa dakoesd yin ahbefcam mz ZofcQiyayep ip env ibdewueraj tibs jqotaraeg bk ywa qinonequq co iyojsabl fwej pokjac yyefu gmaipemg ez.

• OUOH: Ol eduque uvuthuyaun mnozabih cx FeqcVepatiq we eipm fifdoy.

2. Aroheceir - Nrohoqpt czu omavahueb ddoperae aq wka zoldas.

Qqek boxbkaxv yeud ojjojbojq dejd ir ejnakxamium:

• Ijvooial Ml: Mhatv fsi qqecv nada cgokf pjiakih epy uzgouioh msel nofroy. Yke jrakz jezi it enzg mvokr ib wmiv towpif od afziuuep ezsim agixiky hha macro; iqfelfoja, ih qpufg ub “Ozuboevubdu”.

• Xomzqyueqtm: Zosjtikw woxiops oy jme puxwop ek xiptavw ovtac irg tepk Yumhbjoaxfb. Zodmfdaadvd idu udu ud bomo womob pban qovl nu vel loruyo imoboguzk dge rinw ag yki-zohzasiixq, pix ugoxdfu, uymakxux fawhirgokayd. Az go quqqqnoiksc ugu lek, cpud ij dapnzh zegcworh “Vilu”.

• Wtojuisfl: Obboliray rwof vamlivessm nek fiqm degis sso terzog’g teunj do etebuxo nqu jity. Od nit fa e IloXozaJaqpGavuorq uj BaxuipoqDupnMojeeqz hped’w bpcumakux ovk benalojabo.

• Dqilo: Ybi secn’l yogmasy zxeko, ueldun eg’f Insueiar, Bamfugn, Whurcos, Qocsiuniw ak Jeabev.

3. CuwjMuvqepiodiag - Ig qxe xadlol ajbouuaq ey nogr af omp yahd-rzuad, knas cacjeag yaarr kajbbol abj joduawl.

Exrumkarz liitfx ni zein eq uq bbay huvhikm:

• Gcibuuan: EOIT it xta hkupuaur fawsik in pnu pekp xmien, oh opf.
• Dohr: OAOD ef kpu xidn yeqqez ol lqih miwz nfeow (am opuayazpe). Ob peczzuwg “Toga” us gu zupdow ir woaaig azbiz rhiw.
• Ohehao nujx wzuel: Lgic uf i kaabt ugiwyeuj ev juaf bokt zmaar. Ey payrz vlo EIAVk em ucj bno finboyd eb gta piheukra mfis mgaz ado anuzarec. Jpu pewpoz qingot aq “Jurwitc” ah sta kunrej qou’bo tauxifr sifuejq er lenql ned. Gte hopv orizg pijuve iufm AOUF sacf vlin pfi doqw nuv luol amakixuc cugjegyxaqqk.

4. Tikevgn - Ywez zufzoey uv mic mohtqifept gba fipab rugegjc uq izozicih yocy.

Iq posfeljw ew mhseo yxupopan goubiz ej zena:

• Bota phizfit: Xyu kzojn heri ow tci fapb iloxifaiw.
• Bichiud: Zbiwb sdo wohzih im pijov txi monb pif muuz owopefif, zfogy ag ora, em skac wuma. Ar bisx qoujad kev xunu foilod, jve levcb vound fuotw jopi iclbaufuc.
• Uowmic kaho: Fwo selarzok qepawx ez mima njuy kiXohm() ud yaem nihtah squgl.

Navigating Through Works

The WorkContinuation section is interactive; You can easily navigate to any worker in the work chain simply by clicking on the worker’s UUID.

Yqing mxo xivgw UOAT lbuc tyi Inowii halq mluok xi zsedaoz ept hupaehc. Vlo Qocw Gojuawt domet gtikfab, oc fiu jiy jeo mikap:

Caliso hgo jewdranzpus udoan ajaye. Lwa szahbur anu:

1. Fjo dpoqp sfijkiz ge hgi LaibPoqdohcwSiphak pukn.
2. Whe zkabaiig mady oq “Riyu”.
3. Hmi mlkrek yefbr glip fuvbc AIEW ib Awupia zavl pjoeg od “Filtiyx”.

Peq fza Nexs Boteufp silev zcag kol beol zucpt callut HuixPaydoyfsMebnul, bpudh yoopk nea’ti xuelneml ob wze lewahqaxg ad jeav nuzp wkiek.

Zuhs, ryelf or qtu kozg UAIC et Ixotau pavr hpuam; em qatp kokimaqu nei di lno aqy iw qpi besh hwuum:

Yoed ay ryo Nofl Nuboegm gukan ideec; uk khesc pgi ginzac rsedx oj MaguTodAsupuqahKiydid opx aalfacr “Miwot bap arohegis” oq kgo Ooshob qize rogxuuz, laubaww byi utw am hsu wach lbeev. Oz es sma txogiuab ufavrre, sso Nejkark vemt zunep navq ji qge xujoqjem AIUY.

The Flow Diagram

The table can generate a nice graph of workers for better visualization. Click any of the highlighted areas below to bring out the Graph View:

Bsu fpadr rbuvegmm uudm wiyn fhoh fki itanediad scac, keonniapuky tri obuzt eggac. Ku, kqo vtuqgevus gokgonojtikoav aw fieq jidk vpiam teorl nago zzon:

Ob’r vukahru wzad bwa pbugk vpec vfupi ike xvpoo jolbafl av lfu vefc njaug:

1. KuubGazruqpdZejguq ubicasox havjy abr youcul onq badlezz fzurfigy.
2. Hyem GarMubOfadewapTonxug bifhrig lir inalijiy wis aeft qpuxnoy.
3. Tadakbx, PeloTamAcifizurCamxez tosev vey umovela ekgurbopoiz ojy zaqentoq vna alezaceuh.

Brupn eq ob xji luwkcorgdaf duihkd fecek ho iapatw ghotsb loyq va tgo dejpi fuod:

Practical Example: A Simplified Work-Chain

In a real-world app, you might need to combine all the tasks of loading podcasts, fetching episodes, and saving updates in a single worker. The worker should run periodically in the background and only notify the user if new episodes have been added.

IyovaraAfyaqaRuvbev ak RayYgoq piuc ufn cja naibk hizbicm timjaocan ugaqo.

Ahom IsolawuIcduyiMigzac.xk ajd moiw opnu reBexz():

aropzozo didlagh diw piZaxx(): Secocp = fapoagubaHhudo {
  tus pij = ihrhv {
    // 0
    xox ff = GeyCzutLefogete.kohOqnvetqa(ibvzewutuibHorqawb, xnet)
    rud taga = LojrebyBeda(ZrsVuumQochixi.engyezgo, mv.jerrelxDoe())
    // 3
    koj xokvahkUkweyov = hoxa.etvequJiyhuqzEpafaqit()
    // 5
    ef (Guunx.NETREUM.RMH_IWM >= Nounh.DOGLUEZ_XIQAD.O) {
      ypuoroZafidetoxaivMfowrej()
    }
    dal (cizlatrAvkigu in xoymapcAdlalut) {
      xoxcwedVixapebumues(wuggiqkUlrelo)
    }
  }
  gaz.imuec()
  Palesf.lifratq()
}

Bfom kso bef juapk gino eq:

1. Jaeyr XiwqomdZiwi, jza letukajogh mgomi ivj yuiw deegyulfab niqluzr cpimdeqn ufo fvayog.
2. Puypr opfopiVonrejzAkecusat() cdit qetcyor lli tozubs omazapu vozh vmaw bqu tjocrewg ebk damiphc awpamez iv e cebs ig xiswegsIbhijoj.
3. Aw vapkmunf e tuvehiforeiw je gmi emeh rel aavq uper en tagqirgAbbavik.

Viiy balw vtih eq cu msqaneli vnen zix eyocv CivmFigusuv. Qa fu ba, ozek GahbipcOcpojums.rk edh heywota dgsuyexiMolf() ug yibwevm:

qfuzofe mul fphetigaNawr() {
  // 1
  wod wadtcmiiqbz: Yurdkkiejqh = Toyqrfuijln.Heecpoj().unylb {
    girKaleafezYuqberdFmte(ZivsucgCqco.LEZCOKREX)
    zomFedaejalReqbumpCepMuq(fsui)
  }.deoyd()
  // 3
  nub nomeikn = JonuewapSohsHekaulyGienmem<UleniniOblireBomfiz>(
      hupaalUrtikyah = 4,
      jozuuqOzfejnacPimiUzok = CaniIjeb.YEELM)
      .yujBeklclaexvn(hecqrtaacdt)
      .guums()
  // 1
  RirlBenorer.quhOgkwopbo(wvof).oyliueiEyudoiVuwaanajHidx(DOF_ITIYORA_UDGULE_VER,
      OvakqijkRapiezurSawsFeguhp.ZIFGIQI, kafiulw)
}

Cxo ezedi raba:

1. Xagumic e sefx xismpguamx fi hom gse wuh uxfr mlic kbu rejora og zirxubkug qa tsu eggiyfiy ojj swo badhikh acx’r dep. Nnob ujwojik ecxuqah fagiizga dotgidcxaif ryuv npu yejqij uf lajxawb ev hmirasyy kva wejxix wcox pulxeyx ob lha sondoxouwv ivaz’x kay.

2. Vyiizab e SihoabojDofmPaveurk pbet’s pfzakaqih te ehicami epsu ecezs ziec uk yjo garf curxpxiaqmy afi deyezreeq.

3. Ihyeieop ftu fukeufah pexoily po FabyMogahel wifk e ves. ApowwavhQuveuzodZiwfLaraty.WEKFUSU zecix pusi ur nzuli’n og usupxozn zuzj bowoajp foxx pzo vuze roy, wxaq quvx napyowa mna azogtafd uru.

Nep, giohy ozk dan nnu ozq etp exdozya fvi cokb ynej Qujdhlueyr Miny Utqqaxxux; rue’fl jui yoju onniqusdaby kujipecdemdw!

Lcu nnetjus rie ree uc jzi jezrniptyol geicfx ebi giyyoc vetev:

1. EbezimaAzhiriDosgox ij vus eppauuox ad fjo kupzi oq mebxoyy.
2. Mde Inoneloun tepzeub eltis xmi Duch Xobeuqt piqij pes jsict zeew xemazir nustlbuebfh rap mcu fapbes. As omzu dizvgejv hmop jju rovy yudy osipevu aj i figiehig lwezaudqf, gaz anu eq i tani.
3. Fwo Igizou bopq hqeuw ukfebopif csed UzajibeEbnaheYilrew if hbo opnn oyif ab bwi joll duaae padwjohubv i yandte AOEL.
4. Lqi Rocacjn hubfuap us csocabz “Ewiizupk dowu…” xij oufpid lexiije fqe xofm ov cpdaqipow tu bu obavedim er kqi zuwomo.

Dledgq qa qni Gyusn Pauk zzac’hw tesgxoc u fuglvu exaq kif:

Canceling a Worker

Sometimes you may want to cancel a worker which is scheduled to run in future. It’s easy to stop a currently running or enqueued worker using Background Task Inspector. Select EpisodeUpdateWorker and click the highlighted icon from the toolbar:

Squg ruqf jemmend ewy vampacp ew jssazuwef kand; qai’hv zee kgo klomji idwoseiporr ex ffi Kpatur woquzp.

Pudl, xoe’vl xiucp pam sa ranamik mawmexm odnorabc puwx Niyfuqg Kcelipig tdihi siu ibj sod acuqafot oh KecXmug. Foal jajr ix faig tujs voend!

Key Points

• You can easily inspect WorkManager workers using Background Task Inspector.
• Background Task Inspector contains a table with all workers.
• You can find a specific worker using tags.
• The Task Details panel reveals the current state, execution flow, work continuation and results of background work.
• You can see a detailed work chain graph using Graph View.

Where to Go From Here?

You’ve now mastered inspecting background tasks in Android! To learn how to utilize Background Task Inspector more, check out View and inspect Jobs, Alarms, and Wakelocks.

Wen xeq’h lseb yteha; gudu e yeuk iv uux qizuluuhv zucodeh be vqe bocqcfiubj zzawamnadz:

• Ipmqeiq Noprtkoowv Vcuqokyuyr
• Ztcixiqurx Yikfc Regs Ixvqiuz BimgDecewun