Bug with matching/key replacement #672

ia-chyde · 2024-11-01T15:36:21Z

In v1.30.5 a bug was introduced with matching values. Pinning my portman version to 1.30.4 fixes the issue.
ATTN: @thim81

This is the OAS value being replaced - but in 1.30.5 it is replacing in some areas with the example, but in other areas it's replacing properly with the overridden value.

Example fail from html report:

Example of replacement setup from the portman config:

thim81 · 2024-11-01T15:43:10Z

hi @ia-chyde

We did improve some matching logic and added additional tests, so it seems to have caused some side-effects.

I'll look into it and add a test to cover this.

thim81 · 2024-11-01T16:14:31Z

hi @ia-chyde

Could you share the OpenAPI path (only the path is sufficient)? So we can run some manual validations?

ia-chyde · 2024-11-01T16:27:00Z

/workspace/portman/OASfromAPI.json (in a jenkins agent workspace)
If you want the full request url, it's above in the screenshots.

thim81 · 2024-11-01T16:35:39Z

hi @ia-chyde

We have a PR ready that should fix the reported issue.

The input

paths:
  /licenses/{licenseKey}/modules:
    delete:
      summary: Delete a license module
      operationId: deleteLicenseModule
      parameters:
        - $ref: '#/components/parameters/licenseKey'
        - name: modules
          in: query
          description: List of modules to delete, separated by commas
          required: true
          schema:
            type: string
            example: com.inductiveautomation.perspective,com.inductiveautomation.sqlbridge
      responses:
        '204':
          description: No Content - Successfully deleted the license module
        '400':
          description: Bad Request - Invalid license key or parameters
        '404':
          description: Not Found - License key not found
components:
  parameters:
    licenseKey:
      name: licenseKey
      in: path
      required: true
      description: The license key of the license
      schema:
        type: string
        minLength: 8
        example: хххххххХ

with the targeting

"overwrites": [
    {
      "openApiOperation": "DELETE::/licenses/{licenseKey}/modules*",
      "overwriteRequestPathVariables": [
        {
          "key": "licenseKey",
          "value": "{{licenseKey}}"
        }
      ]
    }
  ]

results in:

thim81 · 2024-11-01T17:14:47Z

hi @ia-chyde

We just release version 1.30.6 which should handle your reported issue.
If this solves your issue, feel free to close this.

If not, please provide more info so we can reproduce it and look further for a fix.

ia-chyde · 2024-11-01T18:54:02Z

Still one bug. Now there is a queryparam that's failing to replace. Seems it's not appending the query param to the URL:

Definition in OAS:

thim81 · 2024-11-01T19:56:02Z

How does the Portman config looks like?

ia-chyde · 2024-11-01T20:02:33Z

sorry, meant to include that

thim81 · 2024-11-01T20:56:58Z

hi @ia-chyde

This is the result, so it looks like it is working?

OpenAPI spec:

openapi: 3.0.3
info:
  title: 672 - License API2
  version: 1.0.0

paths:
  /licenses:
    get:
      summary: Get licenses
      description: |
        Returns a list of licenses that match the specified query. Valid query should either be origin and nativeId, or be licenseKeys.
      security:
        - GeneralRO: []
        - GeneralRW: []
      parameters:
        - in: query
          name: origin
          description: The origin of the license owner
          schema:
            $ref: '#/components/schemas/Origin'
          required: false
        - in: query
          name: nativeId
          description: The native ID of the license owner within the origin system
          schema:
            $ref: '#/components/schemas/NativeId'
          required: false
        - in: query
          name: licenseKeys
          description: Comma-separated list of one or more licenseKeys
          schema:
            type: string
            minLength: 1
          required: false
      responses:
        '200':
          description: No Content - Successfully deleted the license module
        '400':
          description: Bad Request - Invalid license key or parameters
        '404':
          description: Not Found - License key not found

components:
  schemas:
    Origin:
      type: string
      example: "example-origin"
    NativeId:
      type: string
      example: "example-native-id"

Portman config:

{
  "globals": {
    "stripResponseExamples": true
  },
  "overwrites": [
    {
      "openApiOperation": "GET::/licenses",
      "overwriteRequestQueryParams": [
        {
          "key": "licenseKeys",
          "value": "{{licenseKey}}",
          "disable": false,
          "overwrite": true
        }
      ]
    }
  ],
  "version": 1
}

ia-chyde · 2024-11-02T15:09:21Z

This is from the postman-generated collection. You can see it is not putting the path param in the request, and on the previous version, it was

thim81 · 2024-11-03T10:15:51Z

hi @ia-chyde

I used the following:

OpenAPI

openapi: 3.0.0
info:
  title: 672 - License API2
  version: 1.0.0

paths:
  /licenses:
    get:
      summary: Get licenses
      description: |
        Returns a list of licenses that match the specified query. Valid query should either be origin and nativeId, or be licenseKeys.
      security:
        - GeneralRO: []
        - GeneralRW: []
      parameters:
        - in: query
          name: origin
          description: The origin of the license owner
          schema:
            $ref: '#/components/schemas/Origin'
          required: false
        - in: query
          name: nativeId
          description: The native ID of the license owner within the origin system
          schema:
            $ref: '#/components/schemas/NativeId'
          required: false
        - in: query
          name: licenseKeys
          description: Comma-separated list of one or more licenseKeys
          schema:
            type: string
            minLength: 1
          required: false
      responses:
        '200':
          description: No Content - Successfully deleted the license module
        '400':
          description: Bad Request - Invalid license key or parameters
        '404':
          description: Not Found - License key not found
  /licenses/{licenseKey}:
    get:
      summary: Get a single license
      description: Returns a single license by licenseKey.
      security:
        - GeneralRO: []
        - GeneralRW: []
      parameters:
        - in: path
          name: licenseKey
          description: The key of the license to retrieve
          schema:
            type: string
            minLength: 8
            example: хххххххХ
          required: true
      responses:
        '200':
          description: No Content - Successfully deleted the license module
        '400':
          description: Bad Request - Invalid license key or parameters
        '404':
          description: Not Found - License key not found
components:
  schemas:
    Origin:
      type: string
      example: "example-origin"
    NativeId:
      type: string
      example: "example-native-id"

With this Portman config:

{
  "globals": {
    "stripResponseExamples": true
  },
  "overwrites": [
    {
      "openApiOperation": "GET::/licenses",
      "overwriteRequestQueryParams": [
        {
          "key": "licenseKeys",
          "value": "{{licenseKey}}",
          "disable": false,
          "overwrite": true
        }
      ]
    },
    {
      "openApiOperation": "GET::/licenses/*",
      "overwriteRequestQueryParams": [
        {
          "key": "licenseKeys",
          "value": "{{licenseKey}}",
          "disable": false,
          "overwrite": true
        }
      ],
      "overwriteRequestPathVariables": [
        {
          "key": "licenseKey",
          "value": "{{licenseKey}}"
        }
      ]
    }
  ],
  "version": 1
}

Results in:

What did you had in your Portman Config?

ia-chyde · 2024-11-04T12:59:28Z

hi @ia-chyde

I used the following:

OpenAPI

openapi: 3.0.0
info:
  title: 672 - License API2
  version: 1.0.0

paths:
  /licenses:
    get:
      summary: Get licenses
      description: |
        Returns a list of licenses that match the specified query. Valid query should either be origin and nativeId, or be licenseKeys.
      security:
        - GeneralRO: []
        - GeneralRW: []
      parameters:
        - in: query
          name: origin
          description: The origin of the license owner
          schema:
            $ref: '#/components/schemas/Origin'
          required: false
        - in: query
          name: nativeId
          description: The native ID of the license owner within the origin system
          schema:
            $ref: '#/components/schemas/NativeId'
          required: false
        - in: query
          name: licenseKeys
          description: Comma-separated list of one or more licenseKeys
          schema:
            type: string
            minLength: 1
          required: false
      responses:
        '200':
          description: No Content - Successfully deleted the license module
        '400':
          description: Bad Request - Invalid license key or parameters
        '404':
          description: Not Found - License key not found
  /licenses/{licenseKey}:
    get:
      summary: Get a single license
      description: Returns a single license by licenseKey.
      security:
        - GeneralRO: []
        - GeneralRW: []
      parameters:
        - in: path
          name: licenseKey
          description: The key of the license to retrieve
          schema:
            type: string
            minLength: 8
            example: хххххххХ
          required: true
      responses:
        '200':
          description: No Content - Successfully deleted the license module
        '400':
          description: Bad Request - Invalid license key or parameters
        '404':
          description: Not Found - License key not found
components:
  schemas:
    Origin:
      type: string
      example: "example-origin"
    NativeId:
      type: string
      example: "example-native-id"

With this Portman config:

{
  "globals": {
    "stripResponseExamples": true
  },
  "overwrites": [
    {
      "openApiOperation": "GET::/licenses",
      "overwriteRequestQueryParams": [
        {
          "key": "licenseKeys",
          "value": "{{licenseKey}}",
          "disable": false,
          "overwrite": true
        }
      ]
    },
    {
      "openApiOperation": "GET::/licenses/*",
      "overwriteRequestQueryParams": [
        {
          "key": "licenseKeys",
          "value": "{{licenseKey}}",
          "disable": false,
          "overwrite": true
        }
      ],
      "overwriteRequestPathVariables": [
        {
          "key": "licenseKey",
          "value": "{{licenseKey}}"
        }
      ]
    }
  ],
  "version": 1
}

Results in:

What did you had in your Portman Config?

#672 (comment) from above - I see you also had one replacing for /licenses/* - I don't have this and before your changes, it was not necessary.

thim81 · 2024-11-04T19:06:11Z

Did you not had a * in the openApiOperation?

ia-chyde · 2024-11-04T19:11:24Z

that's right. only that one entry you see. Worked fine in previous version.

thim81 · 2024-11-04T19:42:14Z

Hmm 🤔 that should not have worked for the endpoints "/licenses/..." since there was no * wildcard character involved in the openApiOperation.

I have a PR that will allow matching with "GET: :/licenses*" would you be OK with that?

ia-chyde · 2024-11-04T20:43:57Z

sure, I could make a config update. I figured that might have been a bug too :-)

…

On Mon, Nov 4, 2024 at 2:42 PM Thim ***@***.***> wrote: Hmm 🤔 that should not have worked for "/licenses/..." since there was no * wildcard character involved. I have a PR that will allow "GET: :/licenses*" would you be OK with that? — Reply to this email directly, view it on GitHub <#672 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BEVEPQWUC7QXWLB2V67DHCLZ67E2XAVCNFSM6AAAAABRAPKFXGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINJVGU2TKMJWGA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

thim81 · 2024-11-05T18:56:21Z

hi @ia-chyde

We just release version v1.30.7, could you give a try?
You will have to update "openApiOperation": "GET::/licenses*" by adding an ending *

ia-chyde · 2024-11-06T19:29:00Z

seems to work well. I'll let you know if anything else comes up, but I think you can close this defect.

…

On Tue, Nov 5, 2024 at 1:56 PM Thim ***@***.***> wrote: hi @ia-chyde <https://github.com/ia-chyde> We just release version v1.30.7 <https://github.com/apideck-libraries/portman/releases/tag/v1.30.7>, could you give a try? You will have to update "openApiOperation": "GET::/licenses*" by adding an ending * — Reply to this email directly, view it on GitHub <#672 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BEVEPQVATHXCD24EIHJ4FCLZ7EIGZAVCNFSM6AAAAABRAPKFXGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINJXHEZTKMRTGQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

thim81 · 2024-11-06T21:58:38Z

@ia-chyde Thanks for the patience and the assistance during the validation

thim81 self-assigned this Nov 1, 2024

thim81 added the bug Something isn't working label Nov 1, 2024

thim81 mentioned this issue Nov 1, 2024

matchPath - Improved matching with ending wildcard #673

Merged

thim81 mentioned this issue Nov 3, 2024

matchPath - Improved matching with ending wildcard #674

Merged

ia-chyde closed this as completed Nov 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bug with matching/key replacement #672

Bug with matching/key replacement #672

ia-chyde commented Nov 1, 2024 •

edited

Loading

thim81 commented Nov 1, 2024

thim81 commented Nov 1, 2024

ia-chyde commented Nov 1, 2024 •

edited

Loading

thim81 commented Nov 1, 2024

thim81 commented Nov 1, 2024

ia-chyde commented Nov 1, 2024

thim81 commented Nov 1, 2024

ia-chyde commented Nov 1, 2024

thim81 commented Nov 1, 2024

ia-chyde commented Nov 2, 2024

thim81 commented Nov 3, 2024

ia-chyde commented Nov 4, 2024 •

edited

Loading

thim81 commented Nov 4, 2024

ia-chyde commented Nov 4, 2024

thim81 commented Nov 4, 2024 •

edited

Loading

ia-chyde commented Nov 4, 2024 via email

thim81 commented Nov 5, 2024

ia-chyde commented Nov 6, 2024 via email

thim81 commented Nov 6, 2024

Bug with matching/key replacement #672

Bug with matching/key replacement #672

Comments

ia-chyde commented Nov 1, 2024 • edited Loading

thim81 commented Nov 1, 2024

thim81 commented Nov 1, 2024

ia-chyde commented Nov 1, 2024 • edited Loading

thim81 commented Nov 1, 2024

thim81 commented Nov 1, 2024

ia-chyde commented Nov 1, 2024

thim81 commented Nov 1, 2024

ia-chyde commented Nov 1, 2024

thim81 commented Nov 1, 2024

ia-chyde commented Nov 2, 2024

thim81 commented Nov 3, 2024

ia-chyde commented Nov 4, 2024 • edited Loading

thim81 commented Nov 4, 2024

ia-chyde commented Nov 4, 2024

thim81 commented Nov 4, 2024 • edited Loading

ia-chyde commented Nov 4, 2024 via email

thim81 commented Nov 5, 2024

ia-chyde commented Nov 6, 2024 via email

thim81 commented Nov 6, 2024

ia-chyde commented Nov 1, 2024 •

edited

Loading

ia-chyde commented Nov 1, 2024 •

edited

Loading

ia-chyde commented Nov 4, 2024 •

edited

Loading

thim81 commented Nov 4, 2024 •

edited

Loading