[Typescript-Node] Mark deprecated endpoints #19770

gcatanese · 2024-10-03T11:12:35Z

Add @deprecated tag when processing deprecated operations in the OpenAPI file

@wing328 I have added a helper method (assertFileContains(Path path, String line, int lineNumber)) to verify a specific line (more effective than searching for the string in the file anywhere), let me know if this is ok or you see some drawbacks. Thanks.

PR checklist

Read the contribution guidelines.
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.x.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.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04) @joscha (2024/10)

joscha · 2024-10-03T11:19:18Z

modules/openapi-generator/src/test/java/org/openapitools/codegen/TestUtils.java

+            assertNotNull(lines);
+
+            String target = lines.get(lineNumber - 1);
+            assertTrue(target.contains(line), "File does not contain line [" + line + "] at lineNumber [" + lineNumber + "]");


If we make this a:

Suggested change

assertTrue(target.contains(line), "File does not contain line [" + line + "] at lineNumber [" + lineNumber + "]");

assertTrue(target.contains(line), "Expected "+ path + ":" + lineNumber + " to contain [" + line + "]");

Then links become clickable in the command line

joscha · 2024-10-03T11:20:20Z

...java/org/openapitools/codegen/typescript/typescriptnode/TypeScriptNodeClientCodegenTest.java

+        //files.forEach(File::deleteOnExit);
+
+        TestUtils.assertFileContains(Paths.get(output + "/api/defaultApi.ts"),
+                "* @deprecated", 118);


asserting on the line number feels very fragile to me. Any refactor in the mustache that changes any lines before the deprecated tag will require future contributors to update this assertion.

Agree. Now that I think about it, it isn't a great idea. I have removed it.

joscha · 2024-10-03T11:20:33Z

...java/org/openapitools/codegen/typescript/typescriptnode/TypeScriptNodeClientCodegenTest.java

+        final ClientOptInput clientOptInput = configurator.toClientOptInput();
+        DefaultGenerator generator = new DefaultGenerator();
+        List<File> files = generator.opts(clientOptInput).generate();
+        //files.forEach(File::deleteOnExit);


Suggested change

//files.forEach(File::deleteOnExit);

?
or put it in a finally block?

I have missed it. It is not fixed.

modules/openapi-generator/src/main/resources/typescript-node/api-single.mustache

joscha · 2024-10-03T11:21:33Z

samples/client/petstore/typescript-node/3_0/api/defaultApi.ts

@@ -114,6 +114,8 @@ export class DefaultApi {
     * @param strCode Code as header
     * @param strCode2 Code as header2
     * @param patchUsersUserIdRequest Patch user properties to update.
+     *
+	 * @deprecated


…pi-single.mustache Co-authored-by: Joscha Feth <[email protected]>

joscha · 2024-10-03T11:54:45Z

modules/openapi-generator/src/main/resources/typescript-node/api-single.mustache

@@ -155,7 +155,7 @@ export class {{classname}} {
     {{/allParams}}
     {{#isDeprecated}}
     *
-	 * @deprecated
+ * @deprecated


I think you had tabs. If you use spaces to indent it, it should work. My suggestion removed the tab.

joscha · 2024-10-03T11:56:19Z

modules/openapi-generator/src/main/resources/typescript-node/api-single.mustache

@@ -153,6 +153,10 @@ export class {{classname}} {
     {{#allParams}}
     * @param {{paramName}} {{description}}
     {{/allParams}}
+     {{#isDeprecated}}
+     *
+ * @deprecated


Suggested change

* @deprecated

* @deprecated

This should work, it's tricky in the webinterface :)

joscha

🎉

macjohnny · 2024-10-03T13:59:55Z

@gcatanese can you please re-generate the samples? then we can merge

joscha · 2024-10-03T14:01:22Z

@gcatanese can you please re-generate the samples? then we can merge

diff seems unrelated to this PR:

joscha · 2024-10-03T14:02:01Z

5f345c0 was just merged, which fixes the samples

macjohnny · 2024-10-03T14:08:39Z

@gcatanese can you rebase on the latest master branch?

joscha · 2024-10-03T14:52:39Z

38c5618 doesn't look quite right. You have to either fast forward or rebase your changes on top, so you don't get the diff between this branch and the merge target (master). If you revert the last commit and force push, then github should actually show an Update branch from master button that should do the right thing.

gcatanese added 4 commits October 3, 2024 12:02

Add @deprecated tag for deprecated operations

80e9aa8

Add test helper to verify a given line

545be33

Add test to verify deprecated method

32593b1

Regenerate samples

1894382

joscha reviewed Oct 3, 2024

View reviewed changes

gcatanese and others added 3 commits October 3, 2024 13:27

Delete tmp files after test

2453686

Remove assertFileContains on specific line

297ed4f

Update modules/openapi-generator/src/main/resources/typescript-node/a…

2e41247

…pi-single.mustache Co-authored-by: Joscha Feth <[email protected]>

joscha reviewed Oct 3, 2024

View reviewed changes

gcatanese added 2 commits October 3, 2024 15:01

Correct indentation

e4029a8

Regenerate samples

d68656a

joscha approved these changes Oct 3, 2024

View reviewed changes

gcatanese force-pushed the typescript-node-deprecated-operations branch from 38c5618 to d68656a Compare October 3, 2024 15:04

macjohnny merged commit 67942aa into OpenAPITools:master Oct 3, 2024
24 of 25 checks passed

wing328 added this to the 7.9.0 milestone Oct 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Typescript-Node] Mark deprecated endpoints #19770

[Typescript-Node] Mark deprecated endpoints #19770

gcatanese commented Oct 3, 2024

joscha Oct 3, 2024

joscha Oct 3, 2024

gcatanese Oct 3, 2024

joscha Oct 3, 2024

gcatanese Oct 3, 2024

joscha Oct 3, 2024

joscha Oct 3, 2024 •

edited

Loading

joscha Oct 3, 2024

joscha left a comment

macjohnny commented Oct 3, 2024

joscha commented Oct 3, 2024

joscha commented Oct 3, 2024

macjohnny commented Oct 3, 2024

joscha commented Oct 3, 2024

	assertTrue(target.contains(line), "File does not contain line [" + line + "] at lineNumber [" + lineNumber + "]");
	assertTrue(target.contains(line), "Expected "+ path + ":" + lineNumber + " to contain [" + line + "]");

[Typescript-Node] Mark deprecated endpoints #19770

[Typescript-Node] Mark deprecated endpoints #19770

Conversation

gcatanese commented Oct 3, 2024

PR checklist

joscha Oct 3, 2024

Choose a reason for hiding this comment

joscha Oct 3, 2024

Choose a reason for hiding this comment

gcatanese Oct 3, 2024

Choose a reason for hiding this comment

joscha Oct 3, 2024

Choose a reason for hiding this comment

gcatanese Oct 3, 2024

Choose a reason for hiding this comment

joscha Oct 3, 2024

Choose a reason for hiding this comment

joscha Oct 3, 2024 • edited Loading

Choose a reason for hiding this comment

joscha Oct 3, 2024

Choose a reason for hiding this comment

joscha left a comment

Choose a reason for hiding this comment

macjohnny commented Oct 3, 2024

joscha commented Oct 3, 2024

joscha commented Oct 3, 2024

macjohnny commented Oct 3, 2024

joscha commented Oct 3, 2024

joscha Oct 3, 2024 •

edited

Loading