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

TODO Audits - 1 #53604

Merged
merged 4 commits into from
Mar 31, 2020
Merged

TODO Audits - 1 #53604

merged 4 commits into from
Mar 31, 2020

Conversation

Piinks
Copy link
Contributor

@Piinks Piinks commented Mar 30, 2020

Description

This is the first of several TODO related PRs. I am auditing the codebase for TODOs that are associated with closed issues, or are no longer relevant.

If any of these TODOs are still accurate, they will need a new issue attributed to them.

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I signed the CLA.
  • I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I updated/added relevant documentation (doc comments with ///).
  • All existing and new tests are passing.
  • The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Did any tests fail when you ran them? Please read Handling breaking changes.

  • No, no existing tests failed, so this is not a breaking change.

@fluttergithubbot
Copy link
Contributor

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

@fluttergithubbot fluttergithubbot added the team Infra upgrades, team productivity, code health, technical debt. See also team: labels. label Mar 30, 2020
Copy link
Member

@jonahwilliams jonahwilliams left a comment

Choose a reason for hiding this comment

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

LGTM for my todos

Copy link
Member

@goderbauer goderbauer left a comment

Choose a reason for hiding this comment

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

LGTM for the TODO's with my name.

Three of @dnfield's TODO's are removed without code changes. Is that expected?

dev/devicelab/manifest.yaml Outdated Show resolved Hide resolved
@@ -96,10 +96,6 @@ RUN dpkg-query -L nodejs
# Install Firebase
# This is why we need nodejs installed.
RUN /usr/bin/npm --verbose install -g firebase-tools
# TODO(dnfield): Remove this once Firebase has a fix upstream for
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure if we should remove this (the linked issue was closed because uploads were stable WITH this patch), but if we should, we should delete the patch_firebase.sh script too. @dnfield

Copy link
Contributor

Choose a reason for hiding this comment

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

Firebase was going to patch this in, this was a manual hack until they did.

Copy link
Contributor

Choose a reason for hiding this comment

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

We've also mitigated this by just not uploading as much.

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's remove this and the patch. If docs start timing out we can add it back, but I'm pretty sure we're covered now. The underlying change is that we used to embed a git hash in every file in the docs, and now it's just in one file that's dynamically loaded by all the others.

Copy link
Contributor

Choose a reason for hiding this comment

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

(maybe in a separate change, in case it does cause problems it's more easily reverted)

@Piinks
Copy link
Contributor Author

Piinks commented Mar 30, 2020

Three of @dnfield's TODO's are removed without code changes. Is that expected?

I've left notes for each.

@@ -19,7 +19,7 @@ class Stock {
Stock(this.symbol, this.name, this.lastSale, this.marketCap, this.percentChange);

Stock.fromFields(List<String> fields) {
// FIXME: This class should only have static data, not lastSale, etc.
// TODO(jackson): This class should only have static data, not lastSale, etc.
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this really require a TODO? This code is really only used for benchmarking at this point. Maybe just leave the comment about how it would be a better design, but it's being left this way for simplicity?

/cc @collinjackson

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure thing if everyone is on board. :) There are a lot of TODOs like that.

Comment on lines 79 to 84
codegen_integration_win:
description: >
Runs codegeneration and verifies that it can execute
correctly.
stage: devicelab_win
required_agent_capabilities: ["windows/android"]
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: might be good to do this in a separate change so that it can be independently reverted more easily.

Copy link
Member

Choose a reason for hiding this comment

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

Maybe same for the docker change. I'm not familiar with the original docs issue, but I'm guessing it was a flake?

@Piinks Piinks changed the title TODO audit 1 of ? TODO Audits - 1 Mar 30, 2020
@Piinks
Copy link
Contributor Author

Piinks commented Mar 30, 2020

Thanks for the feedback, I'll update this and make the splits into separate PRs where requested. :)

This was referenced Mar 31, 2020
@Piinks
Copy link
Contributor Author

Piinks commented Mar 31, 2020

All cleaned up.

Copy link
Member

@christopherfujino christopherfujino left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
team Infra upgrades, team productivity, code health, technical debt. See also team: labels.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants