feat: generate code deprecation tags #1006

jkaster · 2022-02-25T04:05:53Z

adds (DEPRECATED) to deprecated method parameters that don't include the text "deprecated"
adds deprecated attributes for relevant Kotlin, Swift, Go, and C# methods
minor edits to readme
updated examples index
smoke tests for Kotlin and Swift pass

github-actions · 2022-02-25T04:13:47Z

Codegen Tests

    1 files   18 suites 27s ⏱️
414 tests 400 ✔️ 14 💤 0 ❌
415 runs 401 ✔️ 14 💤 0 ❌

Results for commit 774c499.

github-actions · 2022-02-25T04:14:50Z

APIX Tests

    1 files   78 suites 3m 39s ⏱️
313 tests 300 ✔️ 13 💤 0 ❌
329 runs 316 ✔️ 13 💤 0 ❌

Results for commit 774c499.

github-actions · 2022-02-25T04:18:45Z

Typescript Tests

    7 files   76 suites 3m 55s ⏱️
169 tests 165 ✔️   4 💤 0 ❌
588 runs 572 ✔️ 16 💤 0 ❌

Results for commit 774c499.

joeldodge79

Did you intentionally not regenerate TS-SDK and PY-SDK? Also, I didn't open examplesIndex.json but it looks like a big change so just making sure that was intentional.

The python and codegen stuff LGTM! But I don't feel qualified to review on the other languages or apix. Happy to approve if someone else can speak for those

josephaxisa

API Explorer related changes lgtm. Happy to approve once the questions around the typescript and python SDKs are answered.

github-actions · 2022-02-25T22:15:46Z

Codegen Tests

    1 files   18 suites 27s ⏱️
414 tests 400 ✔️ 14 💤 0 ❌
415 runs 401 ✔️ 14 💤 0 ❌

Results for commit a938a0b.

github-actions · 2022-02-25T22:17:16Z

APIX Tests

    1 files   78 suites 3m 19s ⏱️
313 tests 300 ✔️ 13 💤 0 ❌
329 runs 316 ✔️ 13 💤 0 ❌

Results for commit a938a0b.

github-actions · 2022-02-25T22:21:20Z

Python Tests

  10 files   10 suites 2m 27s ⏱️
140 tests 140 ✔️ 0 💤 0 ❌
788 runs 788 ✔️ 0 💤 0 ❌

Results for commit a938a0b.

github-actions · 2022-02-25T22:21:50Z

Typescript Tests

    7 files   76 suites 4m 18s ⏱️
169 tests 165 ✔️   4 💤 0 ❌
588 runs 572 ✔️ 16 💤 0 ❌

Results for commit a938a0b.

github-actions · 2022-02-25T22:37:28Z

APIX Tests

    1 files   78 suites 3m 36s ⏱️
313 tests 300 ✔️ 13 💤 0 ❌
329 runs 316 ✔️ 13 💤 0 ❌

Results for commit 40f821e.

github-actions · 2022-02-25T22:37:31Z

Codegen Tests

    1 files   18 suites 28s ⏱️
414 tests 400 ✔️ 14 💤 0 ❌
415 runs 401 ✔️ 14 💤 0 ❌

Results for commit 40f821e.

github-actions · 2022-02-25T22:40:58Z

Python Tests

  10 files ±0   10 suites ±0 2m 37s ⏱️ -2s
140 tests ±0 140 ✔️ ±0 0 💤 ±0 0 ❌ ±0
788 runs ±0 788 ✔️ ±0 0 💤 ±0 0 ❌ ±0

Results for commit 40f821e. ± Comparison against base commit 3ae42cd.

github-actions · 2022-02-25T22:42:05Z

Typescript Tests

    7 files   76 suites 3m 58s ⏱️
169 tests 165 ✔️   4 💤 0 ❌
588 runs 572 ✔️ 16 💤 0 ❌

Results for commit 40f821e.

github-actions · 2022-02-25T22:53:56Z

Codegen Tests

    1 files   18 suites 29s ⏱️
414 tests 400 ✔️ 14 💤 0 ❌
415 runs 401 ✔️ 14 💤 0 ❌

Results for commit e8eb24d.

github-actions · 2022-02-25T22:53:59Z

APIX Tests

    1 files   78 suites 3m 27s ⏱️
313 tests 300 ✔️ 13 💤 0 ❌
329 runs 316 ✔️ 13 💤 0 ❌

Results for commit e8eb24d.

github-actions · 2022-02-25T22:54:53Z

Python Tests

  10 files ±0   10 suites ±0 2m 42s ⏱️ +3s
140 tests ±0 140 ✔️ ±0 0 💤 ±0 0 ❌ ±0
788 runs ±0 788 ✔️ ±0 0 💤 ±0 0 ❌ ±0

Results for commit e8eb24d. ± Comparison against base commit 3ae42cd.

github-actions · 2022-02-25T23:00:00Z

Typescript Tests

    7 files   76 suites 4m 14s ⏱️
169 tests 165 ✔️   4 💤 0 ❌
588 runs 572 ✔️ 16 💤 0 ❌

Results for commit e8eb24d.

github-actions · 2022-02-25T23:09:08Z

Go Tests

  5 files   5 suites 56s ⏱️
34 tests 34 ✔️ 0 💤 0 ❌
72 runs 72 ✔️ 0 💤 0 ❌

Results for commit 8bbe8cd.

jkaster · 2022-02-25T23:09:48Z

All SDKs have been updated where appropriate and regenerated. As mentioned in the PR description, the examples index is also updated. That should be something that runs as part of CI/CD or as part of the release process. And also whenever new examples are submitted. TODO

github-actions · 2022-02-25T23:12:36Z

Codegen Tests

    1 files   18 suites 27s ⏱️
415 tests 401 ✔️ 14 💤 0 ❌
416 runs 402 ✔️ 14 💤 0 ❌

Results for commit 8bbe8cd.

github-actions · 2022-02-25T23:13:56Z

APIX Tests

    1 files   78 suites 3m 46s ⏱️
313 tests 300 ✔️ 13 💤 0 ❌
329 runs 316 ✔️ 13 💤 0 ❌

Results for commit 8bbe8cd.

github-actions · 2022-02-25T23:15:48Z

Python Tests

  10 files ±0   10 suites ±0 2m 41s ⏱️ +2s
140 tests ±0 140 ✔️ ±0 0 💤 ±0 0 ❌ ±0
788 runs ±0 788 ✔️ ±0 0 💤 ±0 0 ❌ ±0

Results for commit 8bbe8cd. ± Comparison against base commit 3ae42cd.

github-actions · 2022-02-25T23:18:54Z

Typescript Tests

    7 files   76 suites 4m 9s ⏱️
169 tests 165 ✔️   4 💤 0 ❌
588 runs 572 ✔️ 16 💤 0 ❌

Results for commit 8bbe8cd.

joeldodge79 · 2022-03-01T15:45:04Z

I'm confused about why the generated csharp, go, kotlin, and swift SDKs all seem to have the deprecated stuff but typescript and python don't - even though I see the required changes in their generators. I assume this is still WIP @jkaster ?

jkaster · 2022-03-01T17:05:30Z

I'll have to look at it again, because the deprecated tags should be there.

…

On Tue, Mar 1, 2022, 7:45 AM Joel Dodge ***@***.***> wrote: I'm confused about why the generated csharp, go, kotlin, and swift SDKs all seem to have the deprecated stuff but typescript and python don't - even though I see the required changes in their generators. I assume this is still WIP @jkaster <https://github.com/jkaster> ? — Reply to this email directly, view it on GitHub <#1006 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABORGAQR4T6YXIUXOIO5EQTU5Y3Q3ANCNFSM5PJGI2MQ> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because you were mentioned.Message ID: ***@***.***>

jkaster · 2022-03-01T20:59:50Z

I'm confused about why the generated csharp, go, kotlin, and swift SDKs all seem to have the deprecated stuff but typescript and python don't - even though I see the required changes in their generators. I assume this is still WIP @jkaster ?

@joeldodge79 that's because the specification with deprecated parameters won't be available until Looker 22.4 is released. This change added deprecated params to the test specs used for testing the generator. This PR is done after adding new deprecation tags for some of the generators, and has new unit tests that verify tagging deprecated params as well as method deprecation attributes where appropriate. TypeScript already had @deprecated tags for methods.

joeldodge79 · 2022-03-02T18:01:36Z

packages/sdk-codegen/src/kotlin.gen.ts

+${this.deprecated(indent, method)}${indent}${this.jvmOverloads(method)}fun ${
+      method.name
+    }(


This change was the source of my confusion. It's not related to deprecated method params - instead it's back-filling already existing functionality to deprecate a whole method. Typescript already had it and you added it in this PR kotlin, csharp, go, swift but not python.

When I saw deprecated showing up in generated code for some languages and not others I got really confused.

I'm ok with this as is, but I feel like had this bullet point in your PR description been a different PR I would have gotten through this one a lot quicker.

adds deprecated attributes for relevant Kotlin, Swift, Go, and C# methods

Did you add that description to the PR? I see it now. This PR was for adding deprecated tags where appropriate. Python has no deprecation attributes that I could find, so I didn't add deprecated tags to the method headers. This was to bring the other SDKs that support deprecated notation up to date with TypeScript, and add deprecation comments to method params for TypeScript, and to add deprecated comments for method parameters.

github-actions · 2022-03-02T20:35:35Z

Go Tests

  5 files   5 suites 1m 2s ⏱️
34 tests 34 ✔️ 0 💤 0 ❌
72 runs 72 ✔️ 0 💤 0 ❌

Results for commit 898b338.

github-actions · 2022-03-02T20:37:56Z

Codegen Tests

    1 files   18 suites 24s ⏱️
415 tests 401 ✔️ 14 💤 0 ❌
416 runs 402 ✔️ 14 💤 0 ❌

Results for commit 898b338.

github-actions · 2022-03-02T20:39:14Z

APIX Tests

    1 files   78 suites 3m 37s ⏱️
313 tests 300 ✔️ 13 💤 0 ❌
329 runs 316 ✔️ 13 💤 0 ❌

Results for commit 898b338.

github-actions · 2022-03-02T20:40:00Z

Python Tests

  10 files   10 suites 2m 33s ⏱️
140 tests 140 ✔️ 0 💤 0 ❌
788 runs 788 ✔️ 0 💤 0 ❌

Results for commit 898b338.

github-actions · 2022-03-02T20:44:31Z

Typescript Tests

    7 files   76 suites 4m 8s ⏱️
169 tests 165 ✔️   4 💤 0 ❌
588 runs 572 ✔️ 16 💤 0 ❌

Results for commit 898b338.

feat: generate code deprecation tags

774c499

jkaster requested review from bryans99, joeldodge79 and josephaxisa February 25, 2022 04:05

joeldodge79 reviewed Feb 25, 2022

View reviewed changes

josephaxisa reviewed Feb 25, 2022

View reviewed changes

joeldodge79 mentioned this pull request Feb 25, 2022

chore: release main #1007

Merged

joeldodge79 added 2 commits February 25, 2022 22:01

ran black on python files

951f32b

regenerated again, this time after a yarn build

a938a0b

Merge branch 'main' into jk/deprecated_params

40f821e

update specs to latest 22.2 build

e8eb24d

updated go gen deprecations

8bbe8cd

jkaster requested a review from joeldodge79 February 25, 2022 23:08

joeldodge79 mentioned this pull request Feb 28, 2022

chore: set version number for python #1009

Merged

joeldodge79 approved these changes Mar 2, 2022

View reviewed changes

Merge branch 'main' into jk/deprecated_params

898b338

jkaster merged commit afd4b66 into main Mar 2, 2022

jkaster deleted the jk/deprecated_params branch March 2, 2022 21:00

This comment has been minimized.

Sign in to view

looker-open-source-automation-bot mentioned this pull request Mar 23, 2022

chore: release main #1032

Closed

feat: generate code deprecation tags #1006

feat: generate code deprecation tags #1006

Conversation

jkaster commented Feb 25, 2022 • edited Loading

github-actions bot commented Feb 25, 2022

Codegen Tests

github-actions bot commented Feb 25, 2022

APIX Tests

github-actions bot commented Feb 25, 2022

Typescript Tests

joeldodge79 left a comment

Choose a reason for hiding this comment

josephaxisa left a comment

Choose a reason for hiding this comment

github-actions bot commented Feb 25, 2022

Codegen Tests

github-actions bot commented Feb 25, 2022

APIX Tests

github-actions bot commented Feb 25, 2022

Python Tests

github-actions bot commented Feb 25, 2022

Typescript Tests

github-actions bot commented Feb 25, 2022

APIX Tests

github-actions bot commented Feb 25, 2022

Codegen Tests

github-actions bot commented Feb 25, 2022

Python Tests

github-actions bot commented Feb 25, 2022

Typescript Tests

github-actions bot commented Feb 25, 2022

Codegen Tests

github-actions bot commented Feb 25, 2022

APIX Tests

github-actions bot commented Feb 25, 2022

Python Tests

github-actions bot commented Feb 25, 2022

Typescript Tests

github-actions bot commented Feb 25, 2022

Go Tests

jkaster commented Feb 25, 2022

github-actions bot commented Feb 25, 2022

Codegen Tests

github-actions bot commented Feb 25, 2022

APIX Tests

github-actions bot commented Feb 25, 2022

Python Tests

github-actions bot commented Feb 25, 2022

Typescript Tests

joeldodge79 commented Mar 1, 2022

jkaster commented Mar 1, 2022 via email

jkaster commented Mar 1, 2022

joeldodge79 Mar 2, 2022

Choose a reason for hiding this comment

jkaster Mar 2, 2022

Choose a reason for hiding this comment

github-actions bot commented Mar 2, 2022

Go Tests

github-actions bot commented Mar 2, 2022

Codegen Tests

github-actions bot commented Mar 2, 2022

APIX Tests

github-actions bot commented Mar 2, 2022

Python Tests

github-actions bot commented Mar 2, 2022

Typescript Tests

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

jkaster commented Feb 25, 2022 •

edited

Loading