1546411 - @IntDef and similar should not appear in the API

Status: RESOLVED FIXED

(GeckoView :: General, task, P3)

Description

[[ex-Mozilla] Agi Sferro | :agi]

@IntDef, @LongDef and @StringDef declaration don't do anything and add some confusion to the API. We should make sure that they never appear in the API.

apilint has support for this in: https://github.com/mozilla-mobile/gradle-apilint/pull/60

Comment 1

[[ex-Mozilla] Agi Sferro | :agi]

Attachment: Bug 1546411 - [geckoview] Hide all @IntDef and @StringDef.

Comment 2

[Eugen Sawin [:esawin]]

Where exactly is it adding confusion, in the API docs? Can't we just filter that out when creating the docs?
I think moving the declarations out of the supporting classes isn't ideal.

Comment 3

[[ex-Mozilla] Agi Sferro | :agi]

Funny story there's no way to hide stuff from default javadoc (we could move to a custom doclet that does this though).

However, they would still show up in the auto-complete in IDEs and stuff.

We don't necessarily need to move them, we could e.g. define them in subclasses.

I move them because anything defined in an interface is public by default and can't be made private, this is a problem in general, not just with @IntDefs.

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/a66f1ffd23ea
[geckoview] Hide all @IntDef and @StringDef. r=esawin

Comment 5

[Razvan Maries]

Backed out for build bustages.

Push with failure: https://treeherder.mozilla.org/#/jobs?repo=autoland&resultStatus=testfailed%2Cbusted%2Cexception&classifiedState=unclassified&revision=a66f1ffd23ea29db37a0f1b11141c1fe6699dddb&selectedJob=242180167

Failure log: https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=242180167&repo=autoland&lineNumber=35403

[task 2019-04-23T23:38:41.209Z] 23:38:41 FATAL - Halting on failure while running ['/builds/worker/workspace/build/src/obj-x86_64-pc-linux-gnu/_virtualenvs/init/bin/python', 'mach', '--log-no-times', 'android', 'archive-geckoview']
[task 2019-04-23T23:38:41.209Z] 23:38:41 FATAL - Running post_fatal callback...
[task 2019-04-23T23:38:41.209Z] 23:38:41 FATAL - Exiting 2
[task 2019-04-23T23:38:41.209Z] 23:38:41 INFO - [mozharness: 2019-04-23 23:38:41.209264Z] Finished build step (failed)
[task 2019-04-23T23:38:41.209Z] 23:38:41 INFO - Running post-run listener: _parse_build_tests_ccov
[task 2019-04-23T23:38:41.209Z] 23:38:41 INFO - Running post-run listener: _shutdown_sccache
[task 2019-04-23T23:38:41.209Z] 23:38:41 INFO - Running command: ['/builds/worker/workspace/build/src/sccache2/sccache', '--stop-server'] in /builds/worker/workspace/build/src
[task 2019-04-23T23:38:41.209Z] 23:38:41 INFO - Copy/paste: /builds/worker/workspace/build/src/sccache2/sccache --stop-server
[task 2019-04-23T23:38:41.212Z] 23:38:41 INFO - Stopping sccache server...
[task 2019-04-23T23:38:41.213Z] 23:38:41 INFO - Compile requests 3733
[task 2019-04-23T23:38:41.213Z] 23:38:41 INFO - Compile requests executed 3458
[task 2019-04-23T23:38:41.213Z] 23:38:41 INFO - Cache hits 3453
[task 2019-04-23T23:38:41.213Z] 23:38:41 INFO - Cache hits (C/C++) 3111
[task 2019-04-23T23:38:41.213Z] 23:38:41 INFO - Cache hits (Rust) 342
[task 2019-04-23T23:38:41.213Z] 23:38:41 INFO - Cache misses 5
[task 2019-04-23T23:38:41.213Z] 23:38:41 INFO - Cache misses (C/C++) 2
[task 2019-04-23T23:38:41.213Z] 23:38:41 INFO - Cache misses (Rust) 3
[task 2019-04-23T23:38:41.213Z] 23:38:41 INFO - Cache timeouts 0
[task 2019-04-23T23:38:41.214Z] 23:38:41 INFO - Cache read errors 0
[task 2019-04-23T23:38:41.214Z] 23:38:41 INFO - Forced recaches 0
[task 2019-04-23T23:38:41.214Z] 23:38:41 INFO - Cache write errors 0
[task 2019-04-23T23:38:41.214Z] 23:38:41 INFO - Compilation failures 0
[task 2019-04-23T23:38:41.214Z] 23:38:41 INFO - Cache errors 0
[task 2019-04-23T23:38:41.214Z] 23:38:41 INFO - Non-cacheable compilations 0
[task 2019-04-23T23:38:41.214Z] 23:38:41 INFO - Non-cacheable calls 111
[task 2019-04-23T23:38:41.214Z] 23:38:41 INFO - Non-compilation calls 164
[task 2019-04-23T23:38:41.215Z] 23:38:41 INFO - Unsupported compiler calls 0
[task 2019-04-23T23:38:41.215Z] 23:38:41 INFO - Successful distributed compilations 0
[task 2019-04-23T23:38:41.215Z] 23:38:41 INFO - Failed distributed compilations 0
[task 2019-04-23T23:38:41.215Z] 23:38:41 INFO - Average cache write 0.202 s
[task 2019-04-23T23:38:41.215Z] 23:38:41 INFO - Average cache read miss 3.923 s
[task 2019-04-23T23:38:41.215Z] 23:38:41 INFO - Average cache read hit 0.125 s
[task 2019-04-23T23:38:41.215Z] 23:38:41 INFO - Non-cacheable reasons:
[task 2019-04-23T23:38:41.215Z] 23:38:41 INFO - crate-type 59
[task 2019-04-23T23:38:41.215Z] 23:38:41 INFO - -fsyntax-only 37
[task 2019-04-23T23:38:41.215Z] 23:38:41 INFO - - 8
[task 2019-04-23T23:38:41.215Z] 23:38:41 INFO - unknown source language 5
[task 2019-04-23T23:38:41.215Z] 23:38:41 INFO - -E 2
[task 2019-04-23T23:38:41.216Z] 23:38:41 INFO - Cache location S3, bucket: Bucket(name=taskcluster-level-3-sccache-us-west-2, base_url=http://taskcluster-level-3-sccache-us-west-2.s3.amazonaws.com/)
[task 2019-04-23T23:38:41.216Z] 23:38:41 INFO - Return code: 0
[task 2019-04-23T23:38:41.216Z] 23:38:41 INFO - Running post-run listener: _summarize
[task 2019-04-23T23:38:41.216Z] 23:38:41 ERROR - # TBPL FAILURE #
[task 2019-04-23T23:38:41.216Z] 23:38:41 INFO - [mozharness: 2019-04-23 23:38:41.216280Z] FxDesktopBuild summary:
[task 2019-04-23T23:38:41.216Z] 23:38:41 ERROR - # TBPL FAILURE #
[taskcluster 2019-04-23 23:38:41.863Z] === Task Finished ===
[taskcluster 2019-04-23 23:38:42.695Z] Artifact "public/android/maven" not found at "/builds/worker/workspace/build/src/obj-firefox/gradle/build/mobile/android/geckoview/maven/"
[taskcluster 2019-04-23 23:39:15.925Z] Unsuccessful task run with exit code: 2 completed in 1384.344 seconds

Backout: https://hg.mozilla.org/integration/autoland/rev/358171d00f9a1251fff6269ca343fbe9e8ece858

Comment 6

[[ex-Mozilla] Agi Sferro | :agi]

Weird I didn't see this build failure in try :/ should be fixed now, thanks!

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/1d714fde2048
[geckoview] Hide all @IntDef and @StringDef. r=esawin

Comment 8

[Noemi Erli[:noemi_erli]]

https://hg.mozilla.org/mozilla-central/rev/1d714fde2048