Respec: Refactor biblio-db with idb dependency

[saschanaz]

We now have idb-keyval so we probably want to use it there, as the current code is a mixture of Promises and callbacks.

[NJnisarg]

Hello, I am new to this project and am trying to contribute. Since this was marked as good first issue I was trying to understand it. Can you guide me to work on this?

What I understood is biblio-db is a module which stores the data related to some kind of references and it seems to be built on top of indexedDB API. If I am not wrong it has its own functions that work as wrappers to the lower level indexedDB API. And this issue is possibly trying to replace/modify this module with the package idb-keyval from nodejs/npm.

[saschanaz]

@NJnisarg Hello, welcome to ReSpec! 🎉

Yes, this issue is to replace direct calls to raw IndexedDB API with the library idb-keyval. AFAIK most of the things should be straightforward for one who knows IDB well, but one of my concern is that idb-keyval is just a key-value store so it does not support onupgradeneeded event. Maybe we should upgrade to https://www.npmjs.com/package/idb for this.

Feel free to ask questions if you find any.

cc: @sidvishnoi who added the dependency 👍

[marcoscaceres]

@NJnisarg, just in case you haven't yet seen it, we have a dev guide to help people get started https://github.com/w3c/respec/wiki/Developers-Guide

[NJnisarg]

@marcoscaceres and @saschanaz Thanks! I have gone through the Developer Guide and am trying to work with what the issue suggests. I am understanding the codebase a little as of now and would like to take this up as my first issue. I would post questions that are relevant to the issue here. Thanks again and looking forward to contribute.

[sidvishnoi]

Maybe we should upgrade to https://www.npmjs.com/package/idb for this.

Certainly if it helps. Presently, the idb-keyval is being used just in core/xref (and its tests) and it should be trivial to replace. I'll send a PR tomorrow for that.

[NJnisarg]

@sidvishnoi Hello, by the way I am trying to work on this biblio-db issue, do you mind if I continue and generate a PR in a few days? I might reach out for help.

[sidvishnoi]

@NJnisarg Sure feel free to ask wherever needed. Happy to help.
And yes, we can wait on this biblio-db PR, no hurries. I'll just set up the idb dependency so you can import and use it later (and I'll fix the usage in xref module).

[aarondtaveras]

Hey everyone, I've been browsing through this project and I'm looking to contribute!

I see that this issue is still open and I'd like to take a crack at it if that's acceptable. I'll stay on this thread to keep asking any questions that I may have. Has there been any progress on this after setting up the idb dependency? Thank you, and I'm looking forward to helping out the team! 😄

[marcoscaceres]

@aarondtaveras, I think this is actually fixed, but #2154 needs some work if you’d like to help.

[aarondtaveras]

@marcoscaceres, I’d love to! #2154 is the PR for updating the idb version. Is updating the version to 4.0 what you’d like me to take a look at?

[marcoscaceres]

Yes please.

[sidvishnoi]

biblio-db.js still uses raw indexedDB instead of idb

[pradeepgangwar]

I guess this was fixed by #2191 . @marcoscaceres Does it require more work?

(I browse through issues and at some point of browsing/searching I find some merged PR 😆. Leaves me with a sad face xD)

[marcoscaceres]

Still open, but @Swapnilr1 is working on it.

@pradeepgangwar, will need to find another one for you.

[pradeepgangwar]

Yeah, no problem. I will look for other bugs. 😄

[saschanaz]

Pinging @Swapnilr1, are you still working on this? I found this would be helpful for my other branch.

[Swapnilr1]

@saschanaz Yeah I am working. Sorry didn't realise this was urgent, if I am not able to send in a PR tomorrow, you can do it if it's blocking something you are working on.

[saschanaz]

It’s not strictly blocking so no need to be sorry! Just wanted to be sure this is in progress 😁

---

From: Swapnil Rustagi [e-mail]
Sent: Wednesday, April 3, 2019 5:50:57 PM
To: w3c/respec
Cc: Kagami Sascha Rosylight; Mention
Subject: Re: [w3c/respec] Refactor biblio-db with idb dependency (#1955)

@saschanazhttps://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fsaschanaz&data=02%7C01%7C%7C4e447783c8ff486e2f2008d6b8117d7d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636898782583688504&sdata=0FfWSh4kcxXf324UW%2BcgME0iU%2FfYg%2FB3A9bLJ4WKuR4%3D&reserved=0 Yeah I am working. Sorry didn't realise this was urgent, if I am not able to send in a PR tomorrow, you can do it if it's blocking something you are working on.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHubhttps://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fw3c%2Frespec%2Fissues%2F1955%23issuecomment-479399565&data=02%7C01%7C%7C4e447783c8ff486e2f2008d6b8117d7d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636898782583698515&sdata=ADRTu0q5GcAo2uipS5Mag0Mcm%2B5dO9wYpHdDSTucQYs%3D&reserved=0, or mute the threadhttps://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FADPUTiVh5VXi0_Qnrvd1N-PwBebftj6rks5vdGtxgaJpZM4ZVFE1&data=02%7C01%7C%7C4e447783c8ff486e2f2008d6b8117d7d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636898782583708520&sdata=C5nD%2BAK8clnj6dtd9Qm0qxhqDg%2FeDAouf4%2BDdVZmx54%3D&reserved=0.

[Swapnilr1]

@saschanaz I have not been able to resolve issues with tests. So I need guidance on that and this might take some time to get completed. I hope it is OK.

[saschanaz]

Try open a draft PR so that others can see what the problem would be. Maybe @sidvishnoi can help?

---

From: Swapnil Rustagi [e-mail]
Sent: Thursday, April 4, 2019 6:09:37 PM
To: w3c/respec
Cc: Kagami Sascha Rosylight; Mention
Subject: Re: [w3c/respec] Refactor biblio-db with idb dependency (#1955)

@saschanazhttps://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fsaschanaz&data=02%7C01%7C%7Ce556daf31cb4492943af08d6b8dd4418%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636899657793983358&sdata=YNtNan7XNXCkr43fzArnCFj6r8A4CbOL9c9ipZXNAE0%3D&reserved=0 I have not been able to resolve issues with tests. So I need guidance on that and this might take some time to get completed. I hope it is OK.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHubhttps://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fw3c%2Frespec%2Fissues%2F1955%23issuecomment-479816082&data=02%7C01%7C%7Ce556daf31cb4492943af08d6b8dd4418%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636899657793983358&sdata=zBWoUhwmwFW4%2BejS%2FVy0%2BqDLU3ls35r2sTFrQ1A7rnI%3D&reserved=0, or mute the threadhttps://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FADPUTo2CpbMk0zoaUrKrJCX_naxDBKPTks5vdcFRgaJpZM4ZVFE1&data=02%7C01%7C%7Ce556daf31cb4492943af08d6b8dd4418%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636899657793993370&sdata=Icb0vPOo%2FCwa2RTKhZ9eB2wEVMEFY7Evmmud%2FR%2FeLqY%3D&reserved=0.

[Swapnilr1]

I have already opened #2228. Thanks for the suggestion, I will ping sidvishnoi