Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: HTML wrapping middleware is redundant with WAF enabled (#5197) #5210

Conversation

dsotirho-ucsc
Copy link
Contributor

@dsotirho-ucsc dsotirho-ucsc commented May 12, 2023

Connected issues: #5197

Checklist

Author

  • PR is a draft
  • Target branch is develop
  • Name of PR branch matches issues/<GitHub handle of author>/<issue#>-<slug>
  • PR title references all connected issues
  • PR title matches1 that of a connected issue or comment in PR explains why they're different
  • For each connected issue, there is at least one commit whose title references that issue
  • PR is connected to all connected issues via ZenHub
  • PR description links to connected issues
  • Added partial label to PR or this PR completely resolves all connected issues

1 when the issue title describes a problem, the corresponding PR
title is Fix: followed by the issue title

Author (reindex, API changes)

  • Added r tag to commit title or this PR does not require reindexing
  • Added reindex label to PR or this PR does not require reindexing
  • Added a (compatible changes) or A (incompatible ones) tag to commit title or this PR does not modify the Azul service API
  • Added API label to connected issues or this PR does not modify the Azul service API

Author (chains)

  • This PR is blocked by previous PR in the chain or this PR is not chained to another PR
  • Added base label to the blocking PR or this PR is not chained to another PR
  • Added chained label to this PR or this PR is not chained to another PR

Author (upgrading)

  • Documented upgrading of deployments in UPGRADING.rst or this PR does not require upgrading
  • Added u tag to commit title or this PR does not require upgrading
  • Added upgrade label to PR or this PR does not require upgrading

Author (operator tasks)

  • Added checklist items for additional operator tasks or this PR does not require additional tasks

Author (hotfixes)

  • Added F tag to main commit title or this PR does not include permanent fix for a temporary hotfix
  • Reverted the temporary hotfixes for any connected issues or the prod branch has no temporary hotfixes for any connected issues

Author (before every review)

  • Rebased PR branch on develop, squashed old fixups
  • Ran make requirements_update or this PR does not touch requirements*.txt, common.mk, Makefile and Dockerfile
  • Added R tag to commit title or this PR does not touch requirements*.txt
  • Added reqs label to PR or this PR does not touch requirements*.txt
  • make integration_test passes in personal deployment or this PR does not touch functionality that could break the IT

Peer reviewer (after requesting changes)

Uncheck the Author (before every review) checklists.

Peer reviewer (after approval)

  • PR is not a draft
  • Ticket is in Review requested column
  • Requested review from primary reviewer
  • Assigned PR to primary reviewer

Primary reviewer (after requesting changes)

Uncheck the before every review checklists. Update the N reviews label.

Primary reviewer (after approval)

  • Actually approved the PR
  • Labeled connected issues as demo or no demo
  • Commented on connected issues about demo expectations or all connected issues are labeled no demo
  • Decided if PR can be labeled no sandbox
  • PR title is appropriate as title of merge commit
  • N reviews label is accurate
  • Moved ticket to Approved column
  • Assigned PR to current operator

Operator (before pushing merge the commit)

  • Checked reindex label and r commit title tag
  • Checked that demo expectations are clear or all connected issues are labeled no demo
  • Squashed PR branch and rebased onto develop
  • Sanity-checked history
  • Pushed PR branch to GitHub
  • Pushed PR branch to GitLab dev and added sandbox label or PR is labeled no sandbox
  • Pushed PR branch to GitLab anvildev or PR is labeled no sandbox
  • Build passes in sandbox deployment or PR is labeled no sandbox
  • Build passes in anvilbox deployment or PR is labeled no sandbox
  • Reviewed build logs for anomalies in sandbox deployment or PR is labeled no sandbox
  • Reviewed build logs for anomalies in anvilbox deployment or PR is labeled no sandbox
  • Deleted unreferenced indices in sandbox or this PR does not remove catalogs or otherwise causes unreferenced indices
  • Deleted unreferenced indices in anvilbox or this PR does not remove catalogs or otherwise causes unreferenced indices
  • Started reindex in sandbox or this PR does not require reindexing sandbox
  • Started reindex in anvilbox or this PR does not require reindexing sandbox
  • Checked for failures in sandbox or this PR does not require reindexing sandbox
  • Checked for failures in anvilbox or this PR does not require reindexing sandbox
  • Added PR reference to merge commit title
  • Collected commit title tags in merge commit title
  • Moved connected issues to Merged column in ZenHub
  • Pushed merge commit to GitHub

Operator (after pushing the merge commit)

  • Shortened the PR chain or this PR is not labeled base
  • Pushed merge commit to GitLab dev or PR is labeled no sandbox
  • Pushed merge commit to GitLab anvildev or PR is labeled no sandbox
  • Build passes on GitLab dev1
  • Reviewed build logs for anomalies on GitLab dev1
  • Build passes on GitLab anvildev1
  • Reviewed build logs for anomalies on GitLab anvildev1
  • Deleted PR branch from GitHub
  • Deleted PR branch from GitLab dev
  • Deleted PR branch from GitLab anvildev

1 When pushing the merge commit is skipped due to the PR being
labelled no sandbox, the next build triggered by a PR whose merge commit is
pushed determines this checklist item.

Operator (reindex)

  • Deleted unreferenced indices in dev or this PR does not remove catalogs or otherwise causes unreferenced indices
  • Deleted unreferenced indices in anvildev or this PR does not remove catalogs or otherwise causes unreferenced indices
  • Started reindex in dev or this PR does not require reindexing
  • Started reindex in anvildev or this PR does not require reindexing
  • Checked for and triaged indexing failures in dev or this PR does not require reindexing
  • Checked for and triaged indexing failures in anvildev or this PR does not require reindexing
  • Emptied fail queues in dev deployment or this PR does not require reindexing
  • Emptied fail queues in anvildev deployment or this PR does not require reindexing

Operator

  • Unassigned PR

Shorthand for review comments

  • L line is too long
  • W line wrapping is wrong
  • Q bad quotes
  • F other formatting problem

@github-actions github-actions bot added the orange [process] Done by the Azul team label May 12, 2023
@coveralls
Copy link

coveralls commented May 13, 2023

Coverage Status

Coverage: 84.373% (-0.1%) from 84.484% when pulling 235b73c on issues/dsotirho-ucsc/5197-remove-html-wrapping-middleware into fd3608b on develop.

@codecov
Copy link

codecov bot commented May 13, 2023

Codecov Report

Merging #5210 (235b73c) into develop (fd3608b) will decrease coverage by 0.12%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop    #5210      +/-   ##
===========================================
- Coverage    84.46%   84.35%   -0.12%     
===========================================
  Files          149      148       -1     
  Lines        18415    18278     -137     
===========================================
- Hits         15554    15418     -136     
+ Misses        2861     2860       -1     
Impacted Files Coverage Δ
src/azul/chalice.py 89.14% <ø> (-0.70%) ⬇️
test/app_test_case.py 89.23% <ø> (-0.33%) ⬇️

Copy link
Contributor

@nadove-ucsc nadove-ucsc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes appear to be correct, but I think it would be a good idea to use git revert here to make it more clear that this is just removing a previous change. E.g.

$ git checkout develop
$ git revert d658544e

This yields the multi-line commit message

Revert "Fix: Frame Injection (azul-private#12)"

This reverts commit d658544ecd00813af9f2d07f1fbe14d822ca76fb.

Which I think is more informative that the current commit title.

@nadove-ucsc nadove-ucsc removed their assignment May 13, 2023
@dsotirho-ucsc dsotirho-ucsc force-pushed the issues/dsotirho-ucsc/5197-remove-html-wrapping-middleware branch from 0155bfe to 7a3bc89 Compare May 13, 2023 01:01
@dsotirho-ucsc
Copy link
Contributor Author

Changes appear to be correct, but I think it would be a good idea to use git revert here to make it more clear that this is just removing a previous change.

Excellent idea. I deleted my previous commit instead of trying to add a fixup on top.

Copy link
Contributor

@nadove-ucsc nadove-ucsc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch on including the issue ref in the commit title 👍

@nadove-ucsc nadove-ucsc marked this pull request as ready for review May 13, 2023 01:28
@nadove-ucsc nadove-ucsc requested a review from hannes-ucsc as a code owner May 13, 2023 01:28
@nadove-ucsc nadove-ucsc removed their assignment May 13, 2023
@hannes-ucsc hannes-ucsc added the 0 reviews [process] Lead didn't request any changes label May 18, 2023
@dsotirho-ucsc dsotirho-ucsc force-pushed the issues/dsotirho-ucsc/5197-remove-html-wrapping-middleware branch from 7a3bc89 to 235b73c Compare May 19, 2023 16:14
@dsotirho-ucsc dsotirho-ucsc added the sandbox [process] Resolution is being verified in sandbox deployment label May 19, 2023
@dsotirho-ucsc dsotirho-ucsc merged commit 688f0bc into develop May 19, 2023
@dsotirho-ucsc dsotirho-ucsc deleted the issues/dsotirho-ucsc/5197-remove-html-wrapping-middleware branch May 19, 2023 19:02
@dsotirho-ucsc dsotirho-ucsc removed their assignment May 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0 reviews [process] Lead didn't request any changes orange [process] Done by the Azul team sandbox [process] Resolution is being verified in sandbox deployment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants