1086179 - Add a format API to MozNFCTag

Status: RESOLVED FIXED

(Firefox OS Graveyard :: NFC, defect)

Description

[Yoshi Cheng-Hao Huang [:allstars.chh][:allstarschh][:yoshi]]

In bug 1074611 we can know if the tag is formatable or not.
We should add a API for 'formatting NDEF' on the tag, and if the tag is not formatable this method should throw.

Comment 1

[Jonathan Hao (inactive) [:jhao]]

Attachment: Working-in-progress patch

I have imitated the api "makeReadOnly" and fill corresponding code for format(). As I am not familiar with both WebIDL and NFC, I need Dimi to help me check if I'm on the right track.

Comment 2

[Dimi Lee [:dimi]]

Comment on attachment 8522861 [details] [diff] [review]
Working-in-progress patch

Review of attachment 8522861 [details] [diff] [review]:
-----------------------------------------------------------------

Hi Jonathan,
Looks good, thanks! I will provide nfcd for you to test later.
Once the test is complete, please find yoshi to review this patch.

::: dom/nfc/gonk/NfcGonkMessage.h
@@ +23,5 @@
>  enum NfcResponse {
>    GeneralRsp = 1000,
>    PowerRsp,
>    ReadNDEFRsp,
>  };

In this file, there is a define named NFCD_MINOR_VERSION, when the binary protocol is changed between
b2g process and nfcd, we will update it. You could increase it to 16 in this patch.

::: dom/nfc/nsINfcContentHelper.idl
@@ +77,5 @@
>  
>    nsIDOMDOMRequest readNDEF(in DOMString sessionToken);
>    nsIDOMDOMRequest writeNDEF(in nsIVariant records, in DOMString sessionToken);
>    nsIDOMDOMRequest makeReadOnly(in DOMString sessionToken);
> +  nsIDOMDOMRequest format(in DOMString sessionToken);

please also update the uuid

Comment 3

[Dimi Lee [:dimi]]

Attachment: test nfcd

Comment 4

[Jonathan Hao (inactive) [:jhao]]

Attachment: Add format API

I have tested with the following code in gaia/apps/system/js/nfc_handler.js

>  NfcHandler.prototype = {
>    start: function nh_start() {
>      if (window.navigator.mozNfc) {
>        window.navigator.mozNfc.onpeerready = this.handleEvent.bind(this);
>        window.navigator.mozNfc.ontagfound = function (evt) {
>          dump('ontagfound');
>          var req = evt.tag.format();
>          req.onsuccess = function () { dump('format successfully'); };
>          req.onerror = function () { dump('format error'); };
>        };
>      }
>    },

and in the log we can see the format is successful.

> I/GeckoDump(27614): format successfully

Comment 5

[Yoshi Cheng-Hao Huang [:allstars.chh][:allstarschh][:yoshi]]

Comment on attachment 8523797 [details] [diff] [review]
Add format API

Review of attachment 8523797 [details] [diff] [review]:
-----------------------------------------------------------------

Please update the patch subject.

Forward r? to smaug for WebIDL change in MozNFCTag.webidl.

Comment 6

[Olli Pettay [:smaug][[e-mail]]]

Comment on attachment 8523797 [details] [diff] [review]
Add format API

Would it be useful to have a boolean attribute which tells whether the Tag is formattable?

Comment 7

[Jonathan Hao (inactive) [:jhao]]

(In reply to Olli Pettay [:smaug] from comment #6)
> Comment on attachment 8523797 [details] [diff] [review]
> Add format API
> 
> Would it be useful to have a boolean attribute which tells whether the Tag
> is formattable?

Hi Olli, I think what you proposed is already in MozNFCTag.webidl.
http://dxr.mozilla.org/mozilla-central/source/dom/webidl/MozNFCTag.webidl?from=moznfctag.webidl#62

Comment 8

[Jonathan Hao (inactive) [:jhao]]

Attachment: Add format API

Add patch subject.

Comment 9

[Jonathan Hao (inactive) [:jhao]]

Attachment: Add format API

Add "return true;" in the end of NfcMessageHandler::FormatRequest()

Comment 10

[Olli Pettay [:smaug][[e-mail]]]

(In reply to Jonathan Hao [:jhao] from comment #7)
> 
> Hi Olli, I think what you proposed is already in MozNFCTag.webidl.
> http://dxr.mozilla.org/mozilla-central/source/dom/webidl/MozNFCTag.
> webidl?from=moznfctag.webidl#62
So it is!

Comment 11

[Jonathan Hao (inactive) [:jhao]]

Try server results:
https://tbpl.mozilla.org/?tree=Try&rev=5762a08562d0
https://treeherder.mozilla.org/ui/#/jobs?repo=try&revision=5762a08562d0

Comment 12

[Yoshi Cheng-Hao Huang [:allstars.chh][:allstarschh][:yoshi]]

https://hg.mozilla.org/integration/b2g-inbound/rev/5f4ab7ea04cd

Comment 13

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/5f4ab7ea04cd