Add Code Search #120

robbecker-wf · 2018-11-06T21:32:06Z

Overview

This adds support for code search to finish the code search part of #92
https://developer.github.com/v3/search/#search-code

Testing

pub run build_runner serve example
http://localhost:8080/search.html
Test out different combinations of searches

Pacane · 2019-01-06T17:00:58Z

Is this ready to merge?

robbecker-wf · 2019-01-06T19:44:26Z

Not yet, I'd like to make a code search example and verify everything works as expected.

robbecker-wf · 2019-01-07T05:13:16Z

@Pacane @georgelesica-wf Ready for review and testing

lib/src/common/search_service.dart

robbecker-wf · 2019-01-07T20:59:00Z

don't merge yet .. reworking catching rate limit errors

robbecker-wf · 2019-01-07T22:13:10Z

example/index.html

+    <p>
+      Github Token: <input type="text" id="token" size="50">
+      <button id=removeTokenBtn>Clear Github Token</button>
+    </p>


Switched to localStorage to preserve your token longer and provide a clear button to remove it.

lib/src/common/model/search.dart

robbecker-wf · 2019-01-08T04:38:55Z

Ok, cleaned up and now using json_serializable. I tested rate limiting and searching with all the options. Ready for review again.

Pacane · 2019-01-08T12:17:48Z

lib/src/common/search_service.dart

+      // into the first CodeSearchResults and complete with the combined results
+      if (results.length > 1) {
+        for (int i = 1; i < results.length; i++) {
+          results[0].items.addAll(results[i].items);


I don't know much about the context, but this doesn't look right..?
You have a list of CodeSearchResults and you always add them to the same index. Does that mean we could return a single CodeSearchResult?

That's right. The code search results can be multiple pages of responses, so up on L123 each CodeSearchResults is added to a list. Then once all the page responses are done and added to the list, in this onDone handler it takes all of the items from each CodeSearchResults "page" and appends them onto the first one. Then we complete the future on L132 with just the first CodeSearchResult in the list. That's the one that has the complete list of items returned from all pages.
Maybe all this would make a good code comment? ^

Oh, you know what .. your question made me think more about this. Having it iterate and accumulate the responses internally means it will eagerly fetch all the pages. To be more consistent with other parts of the API, I think the code search should return Stream<CodeSearchResults> instead and leave it up to the consumer to pull as many responses from the stream as they want.

That's what I was thinking about. I was gonna write an example of how I'd see this done, but yeah.

robbecker-wf · 2019-01-08T16:04:04Z

@Pacane Another consideration is the default number of pages (2) and results per page (30) mean that, by default, you will only get 60 results even if there are more matches.

I'm not happy with the API at this point. Ideally, I'd like to not have to specify the number of pages up front and be limited in the results. I'd prefer to get back a controlling "search" object that you can simply ask for more results if you want them and cancel and bail if you don't .. but not have to start over with a whole new search.

robbecker-wf · 2019-01-09T18:08:13Z

@Pacane @georgelesica-wf I'm ok with this API. How do you feel about it?

Pacane

That looks much better! Great job

Pacane · 2019-01-09T20:21:33Z

Can this be merged or do you still have stuff to do on this PR?

kevmoo · 2019-01-09T20:35:03Z

We should squash-merge this so the history stays pretty 😄

kevmoo · 2019-01-09T20:35:59Z

@robbecker-wf – would you rebase and clean up this PR? you mixed some tweaks to the HTML example w/ the cod search changes

kevmoo · 2019-01-09T21:31:12Z

@robbecker-wf – you'll have to rebase anyway, since I pulled in pkg:meta, too 😄

robbecker-wf · 2019-01-09T21:58:34Z

Sure, I'll pull out the example changes to a new PR and squish things.

# Conflicts: # lib/src/common.dart # lib/src/common.g.dart # pubspec.yaml

- add changelog entry - remove example updates - un required pages and perPage

Don't do shenanigans with another stream controller, just map the stream from the pagination helper This helps to limit network requests until consumers pull values update the search example to use "await for"

kevmoo

Update version?

kevmoo · 2019-01-10T04:37:46Z

CHANGELOG.md

@@ -9,6 +9,10 @@
  - Made associated classes `ContributorStatistics` and 
    `ContributorWeekStatistics` immutable. Since these classes are only meant as
    return values, we're not treating this as a breaking change.
+- Added `Stream<CodeSearchResults> github.search.code(...)` search API


Since there are new changes, this should be 4.1, right?

Yeah, I suppose it should be 4.1. I'll bump the version in this PR.
Whoever merges are you ok using the github squash or rebase and merge functionality or would you rather I squash and forcepush?

kevmoo · 2019-01-10T04:44:26Z

Squash is best – or do the rebase locally to create one commit

…

On Wed, Jan 9, 2019 at 8:43 PM Rob Becker ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In CHANGELOG.md <#120 (comment)> : > @@ -9,6 +9,10 @@ - Made associated classes `ContributorStatistics` and `ContributorWeekStatistics` immutable. Since these classes are only meant as return values, we're not treating this as a breaking change. +- Added `Stream<CodeSearchResults> github.search.code(...)` search API Yeah, I suppose it should be 4.1. I'll bump the version in this PR. Whoever merges are you ok using the github squash or rebase and merge functionality or would you rather I squash and forcepush? [image: image] <https://user-images.githubusercontent.com/6053699/50946617-7b9b5b00-1457-11e9-98d4-f50d0d8d55cf.png> — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#120 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABCihKnBVlahjy9bZ6NahkwNfF-4O03ks5vBsTagaJpZM4YRUFC> .

kevmoo · 2019-01-10T04:48:55Z

pubspec.yaml

@@ -1,5 +1,5 @@
 name: github
-version: 4.0.2-dev
+version: 4.1.0


...and in the changelog!

🤦‍♂️

kevmoo · 2019-01-10T05:02:12Z

rock!

Pacane · 2019-01-10T13:31:19Z

Thank you!

clairesarsam-wf and others added 4 commits November 6, 2018 14:12

Add code search

4ce001e

Don't parse code search results as users

e8bb38c

additional fixes for dart 2

74c533e

update doc string, remove TODO

91497d0

robbecker-wf mentioned this pull request Nov 6, 2018

Add code search functionality #119

Closed

Merge remote-tracking branch 'origin/master' into code_search

49dac71

Merge remote-tracking branch 'origin/master' into code_search

975bd82

add a search example, use localstorage

da6ff5a

use consistent single quotes

16b2fd5

Pacane reviewed Jan 7, 2019

View reviewed changes

lib/src/common/search_service.dart Outdated Show resolved Hide resolved

Pacane approved these changes Jan 7, 2019

View reviewed changes

fix rate limit error handling

6f00137

robbecker-wf commented Jan 7, 2019

View reviewed changes

georgelesica-wf reviewed Jan 7, 2019

View reviewed changes

lib/src/common/model/search.dart Outdated Show resolved Hide resolved

robrbecker added 3 commits January 7, 2019 17:57

made json_serializable .. not quite working yet

b2a20c5

fix up remaining issues

2c006e0

simplify by using a completer, add comments

a6f829a

Pacane reviewed Jan 8, 2019

View reviewed changes

make the return type a stream and make pages and perPage required

931ec87

Pacane approved these changes Jan 9, 2019

View reviewed changes

robrbecker added 2 commits January 9, 2019 15:15

Merge remote-tracking branch 'origin/master' into code_search

e81caef

# Conflicts: # lib/src/common.dart # lib/src/common.g.dart # pubspec.yaml

cleanup

09f5baf

- add changelog entry - remove example updates - un required pages and perPage

Pacane approved these changes Jan 9, 2019

View reviewed changes

robrbecker added 2 commits January 9, 2019 20:46

simplify

37c06bc

Don't do shenanigans with another stream controller, just map the stream from the pagination helper This helps to limit network requests until consumers pull values update the search example to use "await for"

more cleaning, update changelog

f7d37bb

kevmoo approved these changes Jan 10, 2019

View reviewed changes

bump version to 4.1.0

3254c65

kevmoo reviewed Jan 10, 2019

View reviewed changes

update to 4.1.0 in the changelog too

72008fa

Pacane merged commit 32cc4f0 into master Jan 10, 2019

robbecker-wf deleted the code_search branch January 10, 2019 14:27

robbecker-wf mentioned this pull request Oct 7, 2019

SearchService lacks code and issue search support #92

Closed

2 tasks

Add Code Search #120

Add Code Search #120

Uh oh!

Conversation

robbecker-wf commented Nov 6, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Testing

Uh oh!

Pacane commented Jan 6, 2019

Uh oh!

robbecker-wf commented Jan 6, 2019

Uh oh!

robbecker-wf commented Jan 7, 2019

Uh oh!

Uh oh!

robbecker-wf commented Jan 7, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

robbecker-wf commented Jan 8, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

robbecker-wf commented Jan 8, 2019

Uh oh!

robbecker-wf commented Jan 9, 2019

Uh oh!

Pacane left a comment

Choose a reason for hiding this comment

Uh oh!

Pacane commented Jan 9, 2019

Uh oh!

kevmoo commented Jan 9, 2019

Uh oh!

kevmoo commented Jan 9, 2019

Uh oh!

kevmoo commented Jan 9, 2019

Uh oh!

robbecker-wf commented Jan 9, 2019

Uh oh!

kevmoo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kevmoo commented Jan 10, 2019 via email

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kevmoo commented Jan 10, 2019

Uh oh!

Pacane commented Jan 10, 2019

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

robbecker-wf commented Nov 6, 2018 •

edited

Loading