[Scala] added new scala-cask generator for the cask framework #18046

aaronp · 2024-03-06T22:10:30Z

This change adds a new scala-cask generator for the cask framework.

Thanks in advance to scala committee reviewers @clasnake, @jimschubert, @shijinkui, @ramzimaalej, @chameleon82, @Bouillie and/or @Fish86

PR checklist

[ x] Read the contribution guidelines.
[ x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
Run the following to build the project and update samples:
```
./mvnw clean package 
./bin/generate-samples.sh ./bin/configs/*.yaml
./bin/utils/export_docs_generators.sh
```
(For Windows users, please run the script in Git BASH)
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

wing328 · 2024-03-09T06:42:41Z

.gitignore

@@ -282,3 +282,4 @@ samples/openapi3/client/petstore/go/privatekey.pem

 ## OCaml
 samples/client/petstore/ocaml/_build/
+samples


Thanks for the PR. Why add this line?

Ah - I think that's a hang over from what I was using as an output directory. I'll remove it. Thanks

wing328 · 2024-03-09T06:43:18Z

.run/CaskCodeGen.run.xml

+      <option name="Make" enabled="true" />
+    </method>
+  </configuration>
+</component>


what's the purpose of this file?

It was a run profile for testing -- something I can just take out

wing328 · 2024-03-09T06:44:18Z

thanks for the PR.

can you please also add the new sample folder to .github/workflows/samples-scala.yaml so that the CI can test it moving forward?

wing328 · 2024-03-13T07:18:22Z

please ping me via Slack if you need help with this PR.

https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g

thanks again for the PR

aaronp · 2024-03-21T22:20:11Z

I think I've addressed the comments in the PR - many thanks @wing328 for the review!

aaronp · 2024-03-22T07:41:35Z

How very exciting! Thanks all for your time and patience in reviewing -- very much appreciated!

aaronp · 2024-03-26T18:23:03Z

Thanks @wing328 for the review and help. I've just updated the branch and included server validation improvements, so hopefully is ready for another review?

wing328 · 2024-03-27T03:39:05Z

can you please take a look at the CI build failure when you've time?

https://github.com/OpenAPITools/openapi-generator/actions/runs/8440910756/job/23134572125?pr=18046

let me know if you need help to fix it.

wing328 · 2024-03-27T03:43:38Z

the scala cask tests also failed: https://github.com/OpenAPITools/openapi-generator/actions/runs/8440910764/job/23134573837?pr=18046

please take a look when you've time

wing328 · 2024-03-28T02:43:43Z

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

wing328 · 2024-03-30T13:27:34Z

the test failed. can you please take a look?

https://github.com/OpenAPITools/openapi-generator/actions/runs/8468026875/job/23262734520?pr=18046

aaronp · 2024-03-30T13:36:23Z

Thanks William - Looks like I’ve got some work to do! Thanks so much for the helpful comments 👍

…

On Sat, 30 Mar 2024 at 13:27, William Cheng ***@***.***> wrote: the test failed. can you please take a look? https://github.com/OpenAPITools/openapi-generator/actions/runs/8468026875/job/23262734520?pr=18046 — Reply to this email directly, view it on GitHub <#18046 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABMIOKYFZNRMO3SLDDLMU3Y224VZAVCNFSM6AAAAABEJ32LSOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMRYGA2TQNJTGY> . You are receiving this because you authored the thread.Message ID: ***@***.***>

aaronp · 2024-03-30T17:07:24Z

So, for the first failure <https://github.com/OpenAPITools/openapi-generator/actions/runs/8440910756/job/23134572125?pr=18046>, I have no idea what this is / where it comes from / if it's from my PR: java.lang.IllegalArgumentException: Null key for a Map not allowed in JSON (use a converting NullKeySerializer?) (through reference chain: java.util.LinkedHashMap["components"]->java.util.LinkedHashMap["schemas"]->java.util.LinkedHashMap["Good"]->java.util.LinkedHashMap["properties"]->java.util.LinkedHashMap["null"]) It seems to be innocuous / doesn't affect things now, though I can reproduce that / see that failure locally. I've added my ***@***.***' as a secondary email to my Github account -- thanks for that! It looks like a lot of these failures <https://github.com/OpenAPITools/openapi-generator/actions/runs/8468026875/job/23262734520?pr=18046> are for other scala projects (lagom, scalaz, finch). I'll double-check, but I can't see how my PR is affecting these other projects? [image: image.png] For the cask one I've introduced <https://github.com/OpenAPITools/openapi-generator/actions/runs/8468026875/job/23262735057?pr=18046#step:5:40>, I can't reproduce that locally. I've run the steps: ./mvnw clean package ./bin/generate-samples.sh ./bin/configs/*.yaml co At this point I've checked the code generated in /samples/server/petstore/scala/cask and it all builds ok for me / compiles and tests just fine? I should note, the compile step does reformat the code, so I'm not sure if that has an impact/makes a difference? I regularly sink my fork and rebuild. I'll double-check my changes if they can affect the other scala projects, but not quite sure where else to go from here. As ever, thanks so much for your time and help! Best, Aaron On Sat, Mar 30, 2024 at 1:36 PM Aaron Pritzlaff ***@***.***> wrote:

…

Thanks William - Looks like I’ve got some work to do! Thanks so much for the helpful comments 👍 On Sat, 30 Mar 2024 at 13:27, William Cheng ***@***.***> wrote: > the test failed. can you please take a look? > > > https://github.com/OpenAPITools/openapi-generator/actions/runs/8468026875/job/23262734520?pr=18046 > > — > Reply to this email directly, view it on GitHub > <#18046 (comment)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AABMIOKYFZNRMO3SLDDLMU3Y224VZAVCNFSM6AAAAABEJ32LSOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMRYGA2TQNJTGY> > . > You are receiving this because you authored the thread.Message ID: > ***@***.***> >

wing328 · 2024-03-30T17:39:04Z

can you review and fix: https://github.com/OpenAPITools/openapi-generator/actions/runs/8492216876/job/23265283400?pr=18046?

for test failures with other scala samles, please ignore those for the time being

wing328 · 2024-03-31T15:08:51Z

...enapi-generator/src/main/java/org/openapitools/codegen/languages/ScalaCaskServerCodegen.java

+        public OperationGroup(String httpMethod, String pathPrefix) {
+            this.httpMethod = httpMethod;
+            this.pathPrefix = pathPrefix;
+            caskAnnotation = "@cask." + httpMethod.toLowerCase();


for toLowerCase, you will need to use Locale.ROOT to address the build failure:

openapi-generator/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AdaCodegen.java

Line 125 in 1704ae1

additionalProperties.put("httpClientGprName", httpClientPackageName.toLowerCase(Locale.ROOT));

Boom! Smashing through these. Fixed - thanks

can you please also fix the rest?

Forbidden method invocation: java.lang.String#toUpperCase() [Uses default locale] Error: in org.openapitools.codegen.languages.ScalaCaskServerCodegen (ScalaCaskServerCodegen.java:376) Error: Forbidden method invocation: java.lang.String#toUpperCase() [Uses default locale] Error: in org.openapitools.codegen.languages.ScalaCaskServerCodegen (ScalaCaskServerCodegen.java:37[9](https://github.com/OpenAPITools/openapi-generator/actions/runs/8505836811/job/23295001534?pr=18046#step:5:10)) Error: Scanned 529 class file(s) for forbidden API invocations (in 1.00s), 2 error(s). Error: Failed to execute goal de.thetaphi:forbiddenapis:3.5.1:check (default) on project openapi-generator: Check for forbidden API calls failed, see log. -> [Help 1]

yepper - done

wing328 · 2024-04-01T10:39:45Z

can you please take a look at https://github.com/OpenAPITools/openapi-generator/actions/runs/8505982227/job/23295571166?pr=18046 ?

wing328 · 2024-04-01T10:40:28Z

samples seems not up-to-date: https://github.com/OpenAPITools/openapi-generator/actions/runs/8505982218/job/23295650385?pr=18046

please regenerate the samples

wing328 · 2024-04-02T10:51:44Z

...enapi-generator/src/main/java/org/openapitools/codegen/languages/ScalaCaskServerCodegen.java

+                array = pathPrefix.split(File.separator, -1);
+            } catch (PatternSyntaxException exp) {
+                throw new RuntimeException("For some reason, splitting >" + pathPrefix + "< on >" + File.separator + "< threw " + exp, exp);
+            }


looks like this line is throwing exception in windows?

what about using just / instead of File.separator, which is \ in windows?

good catch - done

wing328 · 2024-04-03T08:38:36Z

...enapi-generator/src/main/java/org/openapitools/codegen/languages/ScalaCaskServerCodegen.java

+    protected String gitUserId = env("GIT_USER", System.getProperty("user.name"));
+    protected String gitRepoId = env("GIT_REPO", artifactId);
+    protected String appName = env("APP_NAME", "Cask App");
+    protected String infoEmail = env("INFO_EMAIL", "[email protected]");


for gitUserId and gitRepoId, you can use these directly from default codegen.

please do not use environment variables, and use additional properties instead. e.g. https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ScalaAkkaHttpServerCodegen.java#L174-L224

infoEmail should be obtained from the spec so I don't think we need to set it here

Many thanks.

I've reworked these properties and cleaned up a lot of the debug code.

I've changed the sample properties and output destination -- I hope that's not too confusing to follow from the original PR

aaronp · 2024-04-05T10:49:57Z

@wing328, it looks like this might be good to go, unless I've missed something?

wing328 · 2024-04-05T16:05:40Z

.github/workflows/samples-scala.yaml

@@ -32,6 +32,7 @@ jobs:
          - samples/server/petstore/scalatra
          - samples/server/petstore/scala-finch # cannot be tested with jdk11
          - samples/server/petstore/scala-http4s-server
+          - samples/server/petstore/scala/cask


should it be samples/server/petstore/scala-cask instead?

yes - good catch. updated

wing328 · 2024-04-05T16:07:24Z

samples/server/petstore/scala-cask/src/main/scala/mo/del/pack/age/ApiResponse.scala

@@ -0,0 +1,53 @@
+/**


the "mo/del" folder looks a bit weird to me.
should it be simply just "model"?

I was just testing out weird/nested configs, but you're right. I've updated it now to be a more standard package structure

…which have been reformatted

Removed cask client samples

wing328 · 2024-04-10T09:11:53Z

i've filed #18344 based on this PR with some minor enhancements.

wing328 · 2024-04-10T10:51:04Z

merged #18344 (commits still authored by you).

thanks for the new generator 👍

wing328 reviewed Mar 9, 2024

View reviewed changes

wing328 added Enhancement: New generator Server: Scala labels Mar 9, 2024

wing328 modified the milestones: 7.4.0, 7.5.0 Mar 9, 2024

aaronp force-pushed the cask branch from b2f569f to c467389 Compare March 21, 2024 22:18

aaronp requested a review from jimschubert as a code owner March 21, 2024 22:18

aaronp force-pushed the cask branch from c467389 to 3a63710 Compare March 26, 2024 18:13

wing328 reviewed Mar 31, 2024

View reviewed changes

wing328 reviewed Apr 2, 2024

View reviewed changes

wing328 reviewed Apr 3, 2024

View reviewed changes

wing328 reviewed Apr 5, 2024

View reviewed changes

aaronp added 23 commits April 7, 2024 20:04

added scala cask to samples

2e7e7fa

splitting out validation and json

d16f683

Added GitHub workflow support

abd6364

regenerated cask samples

bc652b2

cask build fix for local builds

5285e14

regenerated samples

dba5541

trying to reproduce failed cask build. checking in compiles sources, …

98a8ce1

…which have been reformatted

reverted whaitespace change

cde668f

cask fix - adding gitignored files

634c9a8

scala cask toLowreCase fix

34d69b4

scala cask toUpperCase fix

b478983

cask regenerated samples

29c3838

improved exception handling for scala cask

bea0a28

File separator fix for windows

970299f

Noob fix for cask

d18143d

regenerated api package

c55ef71

Removed environment variable settings, debug code

ab0a627

Updated samples

f523fd8

moved scala-cask output

6c4906d

Regenerated samples

5156ce6

scala cask fix

a81a8da

Updated scala cask settings for more typical package structure

b1d0c1c

Removed cask client samples

cask - reran generate samples

a560b92

aaronp force-pushed the cask branch from 8012099 to a560b92 Compare April 7, 2024 19:04

Removed duplicate ScalaCaskServer entry

fd8f7a5

wing328 mentioned this pull request Apr 10, 2024

[Scala] added new scala-cask generator for the cask framework #18344

Merged

5 tasks

wing328 closed this Apr 10, 2024

aaronp deleted the cask branch April 24, 2024 10:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Scala] added new scala-cask generator for the cask framework #18046

[Scala] added new scala-cask generator for the cask framework #18046

aaronp commented Mar 6, 2024

wing328 Mar 9, 2024

aaronp Mar 21, 2024

wing328 Mar 9, 2024

aaronp Mar 21, 2024

wing328 commented Mar 9, 2024

wing328 commented Mar 13, 2024

aaronp commented Mar 21, 2024

aaronp commented Mar 22, 2024

aaronp commented Mar 26, 2024

wing328 commented Mar 27, 2024

wing328 commented Mar 27, 2024

wing328 commented Mar 28, 2024

wing328 commented Mar 30, 2024 •

edited

Loading

aaronp commented Mar 30, 2024 via email

aaronp commented Mar 30, 2024 via email

wing328 commented Mar 30, 2024

wing328 Mar 31, 2024

aaronp Apr 1, 2024

wing328 Apr 1, 2024

aaronp Apr 1, 2024

wing328 commented Apr 1, 2024

wing328 commented Apr 1, 2024

wing328 Apr 2, 2024

aaronp Apr 3, 2024

wing328 Apr 3, 2024

aaronp Apr 3, 2024

aaronp commented Apr 5, 2024

wing328 Apr 5, 2024

aaronp Apr 6, 2024

wing328 Apr 5, 2024

aaronp Apr 6, 2024

wing328 commented Apr 10, 2024

wing328 commented Apr 10, 2024

[Scala] added new scala-cask generator for the cask framework #18046

[Scala] added new scala-cask generator for the cask framework #18046

Conversation

aaronp commented Mar 6, 2024

PR checklist

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

wing328 commented Mar 9, 2024

wing328 commented Mar 13, 2024

aaronp commented Mar 21, 2024

aaronp commented Mar 22, 2024

aaronp commented Mar 26, 2024

wing328 commented Mar 27, 2024

wing328 commented Mar 27, 2024

wing328 commented Mar 28, 2024

wing328 commented Mar 30, 2024 • edited Loading

aaronp commented Mar 30, 2024 via email

aaronp commented Mar 30, 2024 via email

wing328 commented Mar 30, 2024

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

wing328 commented Apr 1, 2024

wing328 commented Apr 1, 2024

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

aaronp commented Apr 5, 2024

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

wing328 commented Apr 10, 2024

wing328 commented Apr 10, 2024

wing328 commented Mar 30, 2024 •

edited

Loading