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

Update server-communication.md #1207

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
4 participants
@angelism

angelism commented Nov 27, 2017

Updated the page.

Update server-communication.md
Updated the page.
@googlebot

This comment has been minimized.

Show comment
Hide comment
@googlebot

googlebot Nov 27, 2017

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If your company signed a CLA, they designated a Point of Contact who decides which employees are authorized to participate. You may need to contact the Point of Contact for your company and ask to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the project maintainer to go/cla#troubleshoot.
  • In order to pass this check, please resolve this problem and have the pull request author add another comment and the bot will run again.

googlebot commented Nov 27, 2017

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If your company signed a CLA, they designated a Point of Contact who decides which employees are authorized to participate. You may need to contact the Point of Contact for your company and ask to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the project maintainer to go/cla#troubleshoot.
  • In order to pass this check, please resolve this problem and have the pull request author add another comment and the bot will run again.

@googlebot googlebot added the cla: no label Nov 27, 2017

@sarahmaddox

Thank you for this lengthy copy edit! I've made a few comments in the review, which you can address by editing the file again and committing your changes again. Alternatively, if you run out of time, the repo owners may decide to do the edits in a follow-up pull request. I'm happy to do that follow-up PR. Let us know if you have time to take action on the edits in this review.
Many thank!

* [JSONP](https://en.wikipedia.org/wiki/JSONP)
Additionally, other browsers support [Fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).

This comment has been minimized.

@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

If we say "other browsers", we're implying that the modern browsers don't support Fetch. I'm not sure that's true. Recommendation: Change "other" to "some".

@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

If we say "other browsers", we're implying that the modern browsers don't support Fetch. I'm not sure that's true. Recommendation: Change "other" to "some".

The Dart `BrowserClient` client communicates with the server using a familiar HTTP request/response protocol.
The `BrowserClient` client is one of a family of services in the Dart [http][] library.
The Dart `BrowserClient` client communicates with the server through an HTTP request/response protocol.
The `BrowserClient` client is a group of services in the Dart [http][] library.

This comment has been minimized.

@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

Change "a group of services" to "one of a group of services".
Also, now that we've established that the BrowserClient is a client, perhaps we can remove the repetition of the client concept from here on down. So, change this:

The `BrowserClient` client is

to this:

The `BrowserClient` is
@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

Change "a group of services" to "one of a group of services".
Also, now that we've established that the BrowserClient is a client, perhaps we can remove the repetition of the client concept from here on down. So, change this:

The `BrowserClient` client is

to this:

The `BrowserClient` is
</div>
Register providers using the `bootstrap()` method:
The followin code shows how to use the `bootstrap()` method:

This comment has been minimized.

@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

There's a typo in "followin".
I think we should keep the fact that the bootstrap method is where they register the providers. How about this:

Register providers in the `bootstrap()` method, as shown in the following code:
@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

There's a typo in "followin".
I think we should keep the fact that the bootstrap method is where they register the providers. How about this:

Register providers in the `bootstrap()` method, as shown in the following code:
The app uses the Dart `BrowserClient` client to communicate via **XMLHttpRequest (XHR)**.
It works like this:
This demo is a shorter version of the [Tour of Heroes](/angular/tutorial) app. In this demo, the heroes are received from the server and displayed as a list. A user can add new heroes and save them to the server. The app uses the Dart `BrowserClient` client to communicate via **XMLHttpRequest (XHR)** .

This comment has been minimized.

@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

We aim to have a line length of 80 characters or shorter, which is easier to read in many code editors and diff tools. Please split the line like this:

This demo is a shorter version of the [Tour of Heroes](/angular/tutorial) app.
In this demo, the heroes are received from the server and displayed as a list.
A user can add new heroes and save them to the server. The app uses the Dart
`BrowserClient` client to communicate via **XMLHttpRequest (XHR)**.

(I've also removed the space before the final full stop.)

@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

We aim to have a line length of 80 characters or shorter, which is easier to read in many code editors and diff tools. Please split the line like this:

This demo is a shorter version of the [Tour of Heroes](/angular/tutorial) app.
In this demo, the heroes are received from the server and displayed as a list.
A user can add new heroes and save them to the server. The app uses the Dart
`BrowserClient` client to communicate via **XMLHttpRequest (XHR)**.

(I've also removed the space before the final full stop.)

<img class="image-display" src="{% asset_path 'ng/devguide/server-communication/http-toh.gif' %}" alt="ToH mini app" width="282">
This demo has a single component, the `HeroListComponent`. Here's its template:
The following code is the `HeroListComponent` component used in the demo:

This comment has been minimized.

@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

We need to keep the concept of the template:

The following example shows the template for the `HeroListComponent` component used in the demo:
@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

We need to keep the concept of the template:

The following example shows the template for the `HeroListComponent` component used in the demo:
Then the user backspaces over the last three letters, *lar*, and immediately re-types *lar* before pausing once more.
The search term is still _angular_. The app shouldn't make another request.
If the user deletes the last three letters, *lar*, and re-types *lar* before pausing again.
The search term is still _angular_. Therore, the app should not make another request.

This comment has been minimized.

@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

Typo: "Therore"

@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

Typo: "Therore"

no matter which response arrives first.
The user does not know which response was recorded first. When there are multiple requests in-flight, the app presents the responses in the original request order.
In this example, the app displays the results for the *http* search
irrespective of the order of the response.

This comment has been minimized.

@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

Let's keep the original wording in the above 5 lines, as it better reflects the division between the app and the user.

@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

Let's keep the original wording in the above 5 lines, as it better reflects the division between the app and the user.

with the help of some nifty Observable operators.
A user can make changes to the `WikipediaService` service. However, for a better
user experience, create a copy of the `WikiComponent`. This can be done through,
Observable operators.

This comment has been minimized.

@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

Here's some wording that addresses the reader as the developer:

You can make changes to the `WikipediaService` service. However, for a better
user experience, create a copy of the `WikiComponent` and make it smarter
with some Observable operators.
@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

Here's some wording that addresses the reader as the developer:

You can make changes to the `WikipediaService` service. However, for a better
user experience, create a copy of the `WikiComponent` and make it smarter
with some Observable operators.
there's a lot more RxJS in the "smart" version,
starting with `debounceTime`, `distinctUntilChanged`, and `switchMap` operators,
imported as [described above](#rxjs-library).
there are more RxJS such as, `debounceTime`, `distinctUntilChanged`, and `switchMap` operators in the new version.

This comment has been minimized.

@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

Change "are" to "is".

@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

Change "are" to "is".

re-arranges them in their original request order,
and delivers to subscribers only the most recent search results.
The `switchMap` returns Observable that _combines_ all `WikipediaService` responses. Observables,
re-arrange them in their original request order, and delivers only the most recent search results to subscribers.

This comment has been minimized.

@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

Let's keep the original wording in the above 3 lines, as it's technically more correct.

@sarahmaddox

sarahmaddox Nov 27, 2017

Contributor

Let's keep the original wording in the above 3 lines, as it's technically more correct.

@kwalrath

This comment has been minimized.

Show comment
Hide comment
@kwalrath

kwalrath Dec 6, 2017

Member

@angelism are you going to be able to (1) sign the CLA and (2) make Sarah's suggested changes?

Member

kwalrath commented Dec 6, 2017

@angelism are you going to be able to (1) sign the CLA and (2) make Sarah's suggested changes?

@angelism

This comment has been minimized.

Show comment
Hide comment
@angelism

angelism Dec 6, 2017

angelism commented Dec 6, 2017

@kwalrath

This comment has been minimized.

Show comment
Hide comment
@kwalrath

kwalrath Dec 6, 2017

Member

Oh no, sounds like you're having issues with your GitHub login! No worries, Sarah & I will make sure that your changes get in. Thanks very much for your contribution!

Member

kwalrath commented Dec 6, 2017

Oh no, sounds like you're having issues with your GitHub login! No worries, Sarah & I will make sure that your changes get in. Thanks very much for your contribution!

@angelism

This comment has been minimized.

Show comment
Hide comment
@angelism

angelism Dec 6, 2017

angelism commented Dec 6, 2017

@kwalrath

This comment has been minimized.

Show comment
Hide comment
@kwalrath

kwalrath Dec 11, 2017

Member

@sarahmaddox I wasn't able to use the SignCLA tool to confirm that the CLA is signed. Can you confirm? (I suspect @angelism has another email address.)

Member

kwalrath commented Dec 11, 2017

@sarahmaddox I wasn't able to use the SignCLA tool to confirm that the CLA is signed. Can you confirm? (I suspect @angelism has another email address.)

@sarahmaddox

This comment has been minimized.

Show comment
Hide comment
@sarahmaddox

sarahmaddox Dec 11, 2017

Contributor

@kwalrath I can confirm that @angelism sent me a screenshot, showing that the Google CLA tool says she has already signed the Google Individual CLA.

Does @angelism need to do any more? I've advised her by email that she could do one of the following, if she has 2 email addresses:

  • either sign in to the browser using the other email address, and sign the CLA with that address,
  • or add another email address to GitHub at https://github.com/settings/emails - I think this will work, though the first option is the most fail-safe.

Many thanks
Sarah

Contributor

sarahmaddox commented Dec 11, 2017

@kwalrath I can confirm that @angelism sent me a screenshot, showing that the Google CLA tool says she has already signed the Google Individual CLA.

Does @angelism need to do any more? I've advised her by email that she could do one of the following, if she has 2 email addresses:

  • either sign in to the browser using the other email address, and sign the CLA with that address,
  • or add another email address to GitHub at https://github.com/settings/emails - I think this will work, though the first option is the most fail-safe.

Many thanks
Sarah

@kwalrath

This comment has been minimized.

Show comment
Hide comment
@kwalrath

kwalrath Dec 11, 2017

Member

It'd be great if @angelism could fix the CLA situation using one of the solutions you proposed.

If that doesn't work out for some reason, could you send me her other email address (privately is fine)?

Member

kwalrath commented Dec 11, 2017

It'd be great if @angelism could fix the CLA situation using one of the solutions you proposed.

If that doesn't work out for some reason, could you send me her other email address (privately is fine)?

@kwalrath

This comment has been minimized.

Show comment
Hide comment
@kwalrath

kwalrath Dec 11, 2017

Member

Confirmed that the alternate email address has a signed CLA, so we can ignore the cla: no label.

Member

kwalrath commented Dec 11, 2017

Confirmed that the alternate email address has a signed CLA, so we can ignore the cla: no label.

@kwalrath

This comment has been minimized.

Show comment
Hide comment
@kwalrath

kwalrath Dec 27, 2017

Member

Closing in favor of its replacement, #1222.

Member

kwalrath commented Dec 27, 2017

Closing in favor of its replacement, #1222.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment