Move dependency from openapi-alps to azure-rest-api-specs #309

Activity

1. Mike Harder (mikeharder)

   self-assigned this

   on Mar 23, 2024
2. Mike Harder (mikeharder)

   added this to Azure SDK EngSys 🚀🌒🧑‍🚀on Mar 23, 2024
3. github-project-automation

   moved this to 🤔 Triage in Azure SDK EngSys 🚀🌒🧑‍🚀on Mar 23, 2024
4. Mike Harder (mikeharder)

   moved this from 🤔 Triage to 🐝 Dev in Azure SDK EngSys 🚀🌒🧑‍🚀on Mar 23, 2024
5. konrad-jamrozik commented on Mar 23, 2024

   

   Konrad Jamrozik (konrad-jamrozik)

   on Mar 23, 2024

   Last edited by konrad-jamrozik

   More actions

   Update all code in openapi-alps to call npm exec --no -- oad compare instead of importing @azure/oad

   Will it make somehow harder to pass arguments and capture output? Like, what if the code throws? We will have to manually parse exception from the stdout or stderr? I understand in case of API call this is easier.

   For reference, this is an example API call right now:

       oadCompareOutput = await oad.compareTags(oldSpec, oldTag, newSpec, newTag, {
         consoleLogLevel: "warn",
       });
   
6. konrad-jamrozik commented on Mar 23, 2024

   

   Konrad Jamrozik (konrad-jamrozik)

   on Mar 23, 2024

   Last edited by konrad-jamrozik

   More actions

   The only dependency on oad and/or openapi-diff in openapi-alps is in the Azure DevOps extension breaking-change.ts and its package.json.
7. mikeharder commented on Mar 23, 2024

   

   Mike Harder (mikeharder)

   on Mar 23, 2024

   Last edited by mikeharder

   ContributorAuthor

   More actions

   Update all code in openapi-alps to call npm exec --no -- oad compare instead of importing @azure/oad

   Will it make somehow harder to pass arguments and capture output? Like, what if the code throws? We will have to manually parse exception from the stdout or stderr? I understand in case of API call this is easier.

   For reference, this is an example API call right now:

       oadCompareOutput = await oad.compareTags(oldSpec, oldTag, newSpec, newTag, {
         consoleLogLevel: "warn",
       });
   

   I think our tools should move away from sharing code/APIs and towards sharing data over stdin/stdout. The https://en.wikipedia.org/wiki/Unix_philosophy. Because it allows interop between our own tools and third-party tools, and our own tools written in different langauges.

   But either way, I think pinning the version of @azure/oad directly in azure-rest-api-specs will simplify updates enough to be worth any tradeoffs. It's one small step to getting everything out of openapi-alps.

   👍React with 👍1Reacted by Konrad Jamrozik
8. Mike Harder (mikeharder)

   moved this from 🐝 Dev to 📋 Backlog in Azure SDK EngSys 🚀🌒🧑‍🚀on Mar 26, 2024