Add remaining metadata #449

elharo · 2017-09-12T18:37:57Z

@briandealwis @loosebazooka @patflynn @etanshaul got a bit confused by the capitalization, but this is the current branch

codecov-io · 2017-09-12T18:41:02Z

Codecov Report

Merging #449 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #449   +/-   ##
=======================================
  Coverage   66.28%   66.28%           
=======================================
  Files          67       67           
  Lines        1815     1815           
  Branches      281      281           
=======================================
  Hits         1203     1203           
  Misses        489      489           
  Partials      123      123

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d86701f...da29668. Read the comment docs.

loosebazooka · 2017-09-12T18:44:31Z

I don't know enough about this api stuff, perhaps someone on the intellij team who might be using it can review?

patflynn · 2017-09-14T13:44:52Z

src/main/java/com/google/cloud/tools/libraries/libraries.json

+      "mavenCoordinates" : {
+         "groupId" : "com.google.cloud",
+         "artifactId" : "google-cloud-resourcemanager",
+         "version" : "0.23.0-alpha"


Should this be versions? how do we encode the BOM data?

These entries should be defined in relation to a common BOM: we don't want to mix-and-match between BOMs, right? The BOM definition could be be external (e.g., encoded in the file-name like libraries-0.22.json), or we could make that an outer element if you wanted a single library definition.

We could pull this from the google-cloud-java pom.xml though it's an extra lookup.
E.g. https://search.maven.org/remotecontent?filepath=com/google/cloud/google-cloud-pom/0.23.1-alpha/google-cloud-pom-0.23.1-alpha.pom

It would be worth having a test that pulls the dependencies for each and ensures there's no conflicting versions.

patflynn · 2017-09-14T13:45:32Z

src/main/java/com/google/cloud/tools/libraries/libraries.json

+      "apireference":"https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/dlp/v2beta1/package-summary.html",
+      "infotip":"The com.google.cloud.dlp.v2beta1 packages",
+      "launchStage" : "alpha",  
+      "packages" : ["com.google.cloud.dlp.v2beta1"],


what does packages represent?

The Java packages exported by the library. We can use them in quick-fixes to add a library on an unresolved symbol.

We have to manually manage this though. Couldn't you just build a package index from the library?

That would require downloading each of the libraries (and possibly dependencies) and process them. And it also doesn't help us avoid exposing shaded jars (e.g., *.repackaged.*).

Aha I see how this can be useful, but I'm still skeptical of our ability to maintain this data. Until we have concrete plans to use this data I'd prefer if we left it out.

I really like the idea of suggesting libraries based off of usage, but I'd like that feature designed first.

This is already a feature available for plugin development in Eclipse, where Eclipse PDE scans for the packages and classes offered by the available plugins and offers to configure the plugin classpath on an unresolved symbol:

That said, the real help is PDE recognizing class names, not package names. E.g., that BigtableDataClient → com.google.cloud.bigtable. So +1 to removing the package names.

@briandealwis thanks for the details and screenshot!

elharo · 2017-09-18T11:56:22Z

Ping

briandealwis

The only nit is that the spacing before and after ':' in the JSON is inconsistent.

briandealwis · 2017-09-18T13:14:53Z

src/main/java/com/google/cloud/tools/libraries/libraries.json

+      "mavenCoordinates" : {
+         "groupId" : "com.google.cloud",
+         "artifactId" : "google-cloud-resourcemanager",
+         "version" : "0.23.0-alpha"


These entries should be defined in relation to a common BOM: we don't want to mix-and-match between BOMs, right? The BOM definition could be be external (e.g., encoded in the file-name like libraries-0.22.json), or we could make that an outer element if you wanted a single library definition.

elharo · 2017-09-18T14:32:54Z

I'm checking with the internal Javascript stylists to see if they prefer "foo":"bar" or "foo" : "bar".

etanshaul · 2017-09-18T18:49:52Z

The PRD specifies that the selector should also include a link to the issue tracker for each library. Should we add this?

elharo · 2017-09-18T20:24:01Z

What's the purpose of the issue tracker link? Is this something we want to expose in the UI?

briandealwis · 2017-09-18T20:26:16Z

For making requests for changes or enhancements to the APIs? Saves the developer from having to hunt the right tracker down, and becoming confused by the com.google.api.* vs com.google.cloud.* repositories.

elharo · 2017-09-19T11:19:21Z

I'm very skeptical of exposing the API issue trackers in the IDEs. This is unlikely to appear at a place where the user might want it (on the code). It's more likely to collect random bugs that have nothing to do with the APIs or CT4E.

etanshaul · 2017-09-19T15:40:19Z

I think its convenient (and can't hurt) to have this link. At a minimum, it gives the user the ability to quickly view open issues & activity prior to adding the library. I do this sometimes myself.

However I'll defer to the PRD authors. @patflynn wdyt?

elharo · 2017-09-19T16:38:16Z

It's easier to add something later than take it out, so I default to leaving fields out until we have consensus that they're needed.

Also note that for these libraries there is exactly one issue tracker for all 23 APIs, not separate issue trackers for each.

patflynn · 2017-09-19T16:39:29Z

I think it's something we want eventually but I'm fine leaving it out for now. Like Elliotte said, for this first batch of libraries they're all in the same github tracker and the phase 0 UX would probably only display the tracker info way before the user has had a chance to find any issues.

* add translate metadata * stackdriver logging * pubsub * spanner * vision * languageLevel * better names * compute * 0.23.0 * 1.5.0 * data loss prevention * cloud DNS * error reporting * video intelligence * stackdriver trace * cloud speech * fix logo URLs * resource manager * monitoring * dlp URLs * assorted fixes * 1.5.1 * remove packages field

* Dependency version bumps: - Bump commons-io from 2.4 to 2.11.0 - Bump junit from 4.12 to 4.13 - Bump hamcrest-library from 1.3 to 2.2 - Bump mockito-core from 2.11.0 to 4.11.0 - Bump jacoco from 0.8.6 to 0.8.8 - Bump checkstyle from 8.18 to 8.37 * Have `verifyGoogleFormat` task run before checkstyle tasks (to suggest fixing via `./gradlew googleJavaFormat`)

Elliotte Harold added 22 commits September 8, 2017 13:28

add translate metadata

b934c6b

stackdriver logging

13666f8

pubsub

3748ff9

spanner

c3e2266

vision

b1521d7

languageLevel

7cbb3cc

better names

3f15264

compute

61eabaa

0.23.0

edc8390

1.5.0

0d66a7c

data loss prevention

fa3ac98

cloud DNS

bdf1b9d

error reproting

fc9b74c

video intelligence

541312f

stackdriver trace

2cdbd49

cloud speech

248bdaf

fix logo URLs

b262bdf

resource manager

a15a762

monitoring

7c71060

dlp URLs

fbc1f42

assorted fixes

586a1cb

assorted fixes

206bdbb

elharo changed the title ~~Beta metadata~~ Add remaining metadata Sep 12, 2017

elharo mentioned this pull request Sep 12, 2017

add remaining metadata #447

Closed

patflynn reviewed Sep 14, 2017

View reviewed changes

Merge branch 'master' into betaMetadata

aeb625e

googlebot added the cla: yes label Sep 18, 2017

briandealwis previously approved these changes Sep 18, 2017

View reviewed changes

1.5.1

3cdb052

elharo dismissed briandealwis’s stale review via 3cdb052 September 18, 2017 14:36

elharo requested a review from etanshaul September 18, 2017 18:10

remove packages field

da29668

etanshaul approved these changes Sep 19, 2017

View reviewed changes

elharo merged commit 552ae6c into master Sep 20, 2017

elharo deleted the betaMetadata branch September 20, 2017 12:07

release-please bot mentioned this pull request Dec 13, 2023

chore(main): release 0.11.0 #974

Closed

release-please bot mentioned this pull request Jan 17, 2024

chore(main): release 2.6.0 #980

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add remaining metadata #449

Add remaining metadata #449

elharo commented Sep 12, 2017 •

edited

codecov-io commented Sep 12, 2017 •

edited by codecov bot

loosebazooka commented Sep 12, 2017

patflynn Sep 14, 2017

briandealwis Sep 18, 2017

elharo Sep 18, 2017

briandealwis Sep 18, 2017

patflynn Sep 14, 2017

briandealwis Sep 14, 2017

patflynn Sep 14, 2017

briandealwis Sep 15, 2017

patflynn Sep 18, 2017

briandealwis Sep 18, 2017

patflynn Sep 18, 2017

elharo commented Sep 18, 2017

briandealwis left a comment

briandealwis Sep 18, 2017

elharo commented Sep 18, 2017

etanshaul commented Sep 18, 2017

elharo commented Sep 18, 2017

briandealwis commented Sep 18, 2017

elharo commented Sep 19, 2017

etanshaul commented Sep 19, 2017

elharo commented Sep 19, 2017

patflynn commented Sep 19, 2017

Add remaining metadata #449

Add remaining metadata #449

Conversation

elharo commented Sep 12, 2017 • edited

codecov-io commented Sep 12, 2017 • edited by codecov bot

Codecov Report

loosebazooka commented Sep 12, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elharo commented Sep 18, 2017

briandealwis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elharo commented Sep 18, 2017

etanshaul commented Sep 18, 2017

elharo commented Sep 18, 2017

briandealwis commented Sep 18, 2017

elharo commented Sep 19, 2017

etanshaul commented Sep 19, 2017

elharo commented Sep 19, 2017

patflynn commented Sep 19, 2017

elharo commented Sep 12, 2017 •

edited

codecov-io commented Sep 12, 2017 •

edited by codecov bot