Core decompress body

[xiangyan99]

No description provided.

[check-enforcer]

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run python - [service] - ci

[xiangyan99]

/azp run python - translation - tests

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[xiangyan99]

/azp run python - translation - tests

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[xiangyan99]

/azp run python - search - tests

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[xiangyan99]

/azp run python - keyvault - tests

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[xiangyan99]

/azp run python - tables - tests

[xiangyan99]

/azp run python - translation - tests

[xiangyan99]

/azp run python - search - tests

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[johanste]

I suspect that @iscai-msft is (or should be) interested in this discussion.

[annatisch]

So this raises because we couldn't decompress because no header way found - is that right?

[xiangyan99]

Because there is no encoding header, we will not try to decompress it.

Here raises error because it fails to decode a compressed stream.

[annatisch]

What's the header that being returned here?
Is it raising because the header says it's gzip, but the content itself doesn't match?

[xiangyan99]

Right.

In this scenario, there is an encoding header and we pass in decompress=True. We will try to decompress the stream which is not in correct format. So the decompression will fail.

[annatisch]

Is this failing because the decompression algorithm mismatches the header? Or because the content itself mismatches the header?
I'm wondering because it's a zlib error, but the test name indicates a 'plain' content header.

[xiangyan99]

With encoding header "gzip" we will try to use "gzip" algorithm to decompress the stream.

But the content of the stream itself is not compressed (it is plain text).

What happens here is we try to decompress an un-compressed stream so we fail to decompress.

[annatisch]

Gotcha - perfect!

[xiangyan99]

python - autorest - pr failure is known.

[iscai-msft]

/azp run python - autorest - pr

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[johanste]

I would add a comment as to why we need this. I know I would be confused unless I knew the history...

[xiangyan99]

Added.

[johanste]

I do have some concerns about us not caching the decompressed body. Because we only need it once, right? Do we have any other access to self._body that requires us to keep the compressed data?

[xiangyan99]

I don't expect (as least I did not see) users need to get body twice.

If you want, we can update the code like:

    if enc in ("gzip", "deflate"):
        if self._decompressed_body:
                 return self._decompressed_body
        import zlib
        zlib_mode = 16 + zlib.MAX_WBITS if enc == "gzip" else zlib.MAX_WBITS
        decompressor = zlib.decompressobj(wbits=zlib_mode)
        self._decompressed_body = decompressor.decompress(self._body)
        return self._decompressed_body
    return self._body

But to be honest, I don't see lots of value for this.

[johanste]

The don't need to get the body more than once. And it would not be clear to me that getting the body and then the text will decompress the body twice.

I don't think we need to keep the compressed data around once it has been decompressed, right?

[xiangyan99]

Sounds fair. Updated. :)

[johanste]

I would suggest keeping a single copy of the body around. Unless you still need the compressed version for some reason...