Slow Documentation diff (and failure with timeouts)

[aschillio]

From time to time, the ci is failing on diff our API. (Not always). The error is not really explicit could you help ? Do you have options to debug ? Thanks.

The job:

on: pull_request
jobs:
  api-diff:
    name: Check API diff on Bump
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v3
        with:
          node-version: "16.x"
      - name: Cache dependencies...
        id: cache-deps
        uses: actions/cache@v3
        with:
          path: |
            node_modules
            packages/back/node_modules
            packages/shared/node_modules
            packages/web/node_modules
          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
      - name: Install packages...
        if: steps.cache-deps.outputs.cache-hit != 'true'
        run: yarn --prefer-offline --frozen-lockfile --ignore-scripts --silent
      - name: Generate swagger
        run: yarn api api:generate-swagger:internal
      - name: Comment pull request with API diff
        uses: bump-sh/github-action@v1
        with:
          doc: cmp
          token: ${{secrets.BUMP_TOKEN}}
          file: ./packages/back/dist/src/presentation/rest-api/v1/internal/swagger.json
          command: diff
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

[paulRbr]

Hi @aschillio,

Thanks for reporting your issue. To help the team investigate could you please share with us the timestamp of the run of your action which ended up with this error please?

If possible give use up to the second precision so we can investigate our logs.

Thank you very much and have a nice day!

[aschillio]

Thanks @paulRbr for the quick response. See below.

[aschillio]

Hello @paulRbr, were you able to investigate ? It's occurring again randomly. Is it a known issue ? Let me know if I can help 🥇

[paulRbr]

Hi @aschillio,

Thanks for your ping. We've been trying to investigate but couldn't pin-point the real problem yet.

It seems we have some randomly slow requests on our servers (The message you share means the GitHub Action didn't get a response from our servers within 30 seconds). In the meantime I hope it works to “retry” the failed job when this error occurs. We will try to spend more time on this next month when we have some resource available.

In the name of the Bump.sh team, we are sorry for the inconvenience and we will try to solve this as soon as possible !

[aschillio]

Hi @paulRbr, Ok thanks for your time. I would let you know if it occurs again. For the moment I don't retry the jobs, it's a good idea, but I would prefer the service we pay for works accordingly :-) Don't hesitate to ping me if you have news.

[usern3]

@paulRbr I've been running into this issue quite often, heres one of my latest outputs:

/usr/bin/git fetch origin ebced338330136aafbfc91c4164779f95805e952 254cdb16ada09e679e429dcb5a8dfc2d44ebb023
From https://github.com/lmwarehousing/connect3
 * branch              ebced338330136aafbfc91c4164779f95805e952 -> FETCH_HEAD
 * branch              254cdb16ada09e679e429dcb5a8dfc2d44ebb023 -> FETCH_HEAD
/usr/bin/git merge-base ebced338330[13](https://github.com/lmwarehousing/connect3/actions/runs/7981637387/job/21793704497?pr=580#step:3:14)6aafbfc91c4164779f95805e952 254cdb16ada09e679e429dcb5a8dfc2d44ebb023
ebced338330136aafbfc91c4164779f95805e952
/usr/bin/git --work-tree tmp/ restore -s ebced338330136aafbfc91c4[16](https://github.com/lmwarehousing/connect3/actions/runs/7981637387/job/21793704497?pr=580#step:3:17)4779f95805e952 .
/usr/bin/git restore -s 254cdb16ada09e679e429dcb5a8dfc2d44ebb023 .
Error: We were unable to compute your documentation diff. Sorry about that. Please try again later