Fix#20125: Correct Flake (Error Using Google Docs Viewer with Puppeteer) in Logged-In User Acceptance Tests.

rahat2134 commented 2 weeks ago

Overview

This PR fixes or fixes part of #20125
This PR does the following: There was an error in console occuring. When using Puppeteer to preview documents via Google Docs Viewer in Node.js, the browser throws an error. Despite the URL working well in a browser environment, attempting to access it through Puppeteer results in an error. Set that error to ignore because it was from external factors and breaking the tests.

Essential Checklist

Please follow the instructions for making a code change.

[X] I have linked the issue that this PR fixes in the "Development" section of the sidebar.
[X] I have checked the "Files Changed" tab and confirmed that the changes are what I want to make.
[ ] I have written tests for my code.
[X] The PR title starts with "Fix #bugnum: " or "Fix part of #bugnum: ...", followed by a short, clear summary of the changes.
[X] I have assigned the correct reviewers to this PR (or will leave a comment with the phrase "@{{reviewer_username}} PTAL" if I can't assign them directly).

Proof that changes are correct

PR Pointers

Never force push! If you do, your PR will be closed.
To reply to reviewers, follow these instructions: https://github.com/oppia/oppia/wiki/Make-a-pull-request#step-5-address-review-comments-until-all-reviewers-approve
Some e2e tests are flaky, and can fail for reasons unrelated to your PR. We are working on fixing this, but in the meantime, if you need to restart the tests, please check the "If your build fails" wiki page.
See the Code Owner's wiki page for what code owners will expect.

oppiabot[bot] commented 2 weeks ago

Assigning @StephenYu2018 for the first pass review of this PR. Thanks!

seanlip commented 2 weeks ago

@rahat2134 Please update the title of the PR to mention the name of the flake (synopsis of error message) and that it occurs in the "logged-in user acceptance tests". The current title is quite unclear. Thanks.

oppiabot[bot] commented 2 weeks ago

Assigning @StephenYu2018 for code owner reviews. Thanks!

seanlip commented 2 weeks ago

@rahat2134 "error message synopsis" means a summary of the error message, not the literal text "error message synopsis".

jnvtnguyen commented 2 weeks ago

@seanlip @rahat2134 FYI just wanted to note since I got notified on my repository that a google api key was detected, should use a regex here instead of the raw key since it can change. WDYT?

seanlip commented 2 weeks ago

Oh, I didn't realize the key can change ... I think a regex is a good idea, thanks @jnvtnguyen!

(I'm also kind of confused where this key is being generated from, tbh, since AFAIK no one is logged in during this test.)

@rahat2134 can you make the change please?

jnvtnguyen commented 2 weeks ago

Oh maybe it doesn't change since all of the keys are the same in the occurences but generally things like API keys should not be explicitly set in code IG.

rahat2134 commented 2 weeks ago

I initially considered using regex, but then I noticed that the error was consistent each time. Sure I will update it. @jnvtnguyen thanks for noticing.

oppia / oppia