Answers -> Search 2: headless unique customer components #113

ElemelonWind · 2022-07-05T18:23:29Z

Renamed all new customer-facing components, updated package.json. Part 3 will be updating imports/exports from updated search-core

J=SLAP-2204
TEST=auto

yen-tt

we should point this to develop, or a feature branch like how Alex did for search-core!

src/index.ts

tests/unit/answers-headless.ts

src/index.ts

yen-tt · 2022-07-11T16:25:58Z

src/search-headless.ts

+  /**
+   * Common utility functions for manipulating Answers-related data.
+   */
+  public readonly utilities = answersUtilities;


lets rename to searchUtilities? (ignore this if you are planning on changing this in part 2..)

src/search-headless.ts

etc/search-headless.api.md

README.md

src/index.ts

coveralls · 2022-07-11T17:02:43Z

Pull Request Test Coverage Report for Build 2652011560

Details

4 of 7 (57.14%) changed or added relevant lines in 3 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.6%) to 92.111%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/deprecated.ts	0	3	0.0%

Totals
Change from base Build 2651690679:	-0.6%
Covered Lines:	325
Relevant Lines:	346

💛 - Coveralls

oshi97 · 2022-07-11T17:24:46Z

technically the imports/exports from updated search-core are also consumer facing, I would update the PR title!

oshi97 · 2022-07-11T17:26:54Z

I told this to Alex too - could we move the package.json changes to their own PR? Otherwise it's difficult to review a PR this large - github really struggles here. Changing the package.json package name also changes all of the doc links so that's why literally every doc file changes

ElemelonWind · 2022-07-11T17:29:04Z

I told this to Alex too - could we move the package.json changes to their own PR? Otherwise it's difficult to review a PR this large - github really struggles here. Changing the package.json package name also changes all of the doc links so that's why literally every doc file changes

Is there an easy way to split it into a new PR?

oshi97 · 2022-07-11T17:31:25Z

I would still keep this PR/branch - after the package.json PR is merged in you can do a rebase with a theirs strategy (see: https://stackoverflow.com/questions/16825849/choose-git-merge-strategy-for-specific-files-ours-mine-theirs) or however you would like to merge things back up

oshi97 · 2022-07-11T17:32:25Z

I told this to Alex too - could we move the package.json changes to their own PR? Otherwise it's difficult to review a PR this large - github really struggles here. Changing the package.json package name also changes all of the doc links so that's why literally every doc file changes

Is there an easy way to split it into a new PR?

You can make a new branch, and git cherry-pick the changes you want into that new branch. I like to use sublime merge for this. You could also just copy paste the new package.json file since that should be the only change.
After that run npm install and the doc generation again

ElemelonWind · 2022-07-11T18:04:05Z

I told this to Alex too - could we move the package.json changes to their own PR? Otherwise it's difficult to review a PR this large - github really struggles here. Changing the package.json package name also changes all of the doc links so that's why literally every doc file changes

Is there an easy way to split it into a new PR?

You can make a new branch, and git cherry-pick the changes you want into that new branch. I like to use sublime merge for this. You could also just copy paste the new package.json file since that should be the only change. After that run npm install and the doc generation again

ok! new PR here: #115

src/index.ts

… into rename-search merge

yen-tt · 2022-07-11T20:56:33Z

src/deprecated.ts

@@ -0,0 +1,29 @@
+import { searchUtilities, provideHeadless } from ".";


eslint warnings, single quotes for import statements. (should add eslint github action to this repo...)

There were some other lint warnings like dual exports or something which is probably why it's not a github action :)

yen-tt · 2022-07-11T21:00:04Z

src/deprecated.ts

+ *
+ * @deprecated answersUtilities has been deprecated and renamed to searchUtilities
+ */
+ export const answersUtilities = searchUtilities;


remember to import these stuff into index.ts and export them there. Otherwise, user wouldn't have access to these deprecated stuff

yen-tt · 2022-07-11T21:01:41Z

src/deprecated.ts

+  *
+  * @deprecated provideAnswersHeadless has been deprecated and renamed to provideHeadless
+  */
+ export const provideAnswersHeadless = provideHeadless;


eslint warnings, extra space before export in this file, and in the line below here

tests/acceptance/provideSearchHeadless.ts

tests/mocks/createMockedAnswersHeadless.ts

oshi97 · 2022-07-12T15:07:05Z

tests/unit/answers-headless.ts

@@ -1,7 +1,7 @@
 import { Matcher, QuerySource, QueryTrigger } from '@yext/answers-core';


can we rename this file?

oshi97 · 2022-07-12T15:08:01Z

could you remove the tests/.DS_Store file and also add it to the gitignore (I think you can just add a line with .DS_Store?)

ElemelonWind · 2022-07-12T15:20:07Z

could you remove the tests/.DS_Store file and also add it to the gitignore (I think you can just add a line with .DS_Store?)

lmao I can't figure out how to remove it - the delete button is grayed out and it's not in VSCode even after I pull (?)

I added to gitignore though

oshi97 · 2022-07-12T16:31:11Z

.gitignore

+temp/
+.DS_STORE


the casing is off here! it's .DS_Store

oshi97 · 2022-07-12T16:34:20Z

src/search-headless.ts

  /**
-   * Common utility functions for manipulating Answers-related data.
+   * Common utility functions for manipulating Search-related data.
   */
  public readonly utilities = answersUtilities;


bumping yen's comment to rename to searchUtilities!

oshi97 · 2022-07-12T16:37:05Z

tests/unit/search-headless.ts

@@ -66,7 +66,7 @@ const mockedCore: any = {
  filterSearch: jest.fn(() => Promise.resolve({}))
 };

-const answers = new AnswersHeadless(mockedCore, mockedStateManager, new HttpManager());
+const answers = new SearchHeadless(mockedCore, mockedStateManager, new HttpManager());


Can we rename this variable too?

there's like a million variables named answers so Tom said we'd rename those in a later phase!

ooh gotcha!

oshi97 · 2022-07-12T16:37:37Z

src/models/slices/query.ts

@@ -19,7 +19,7 @@ export interface QueryState {
   */
  queryTrigger?: QueryTrigger,
  /**
-   * The source of the query (from a standard Answers integration, an Answers
+   * The source of the query (from a standard Search integration, an Search


oshi97 · 2022-07-12T16:37:53Z

src/models/state-manager.ts

@@ -3,7 +3,7 @@ import { State } from './state';
 import StateListener from './state-listener';

 /**
- * Manages the information contained in the state for an AnswersHeadless instance.
+ * Manages the information contained in the state for an SearchHeadless instance.


oshi97

lgtm!

ElemelonWind added 3 commits July 5, 2022 14:23

Customer facing renaming

ef60f29

API extracted

62ab52d

update test site

b0d8b7c

ElemelonWind marked this pull request as ready for review July 11, 2022 15:24

ElemelonWind requested a review from a team as a code owner July 11, 2022 15:24

ElemelonWind changed the title ~~Customer facing renaming~~ Answers -> Search 1: Customer facing renaming Jul 11, 2022

yen-tt reviewed Jul 11, 2022

View reviewed changes

src/index.ts Show resolved Hide resolved

Update index.ts

c96d42e

yen-tt reviewed Jul 11, 2022

View reviewed changes

tests/unit/answers-headless.ts Show resolved Hide resolved

yen-tt reviewed Jul 11, 2022

View reviewed changes

src/index.ts Outdated Show resolved Hide resolved

yen-tt reviewed Jul 11, 2022

View reviewed changes

src/index.ts Outdated Show resolved Hide resolved

yen-tt reviewed Jul 11, 2022

View reviewed changes

src/index.ts Outdated Show resolved Hide resolved

yen-tt reviewed Jul 11, 2022

View reviewed changes

src/search-headless.ts Outdated Show resolved Hide resolved

nmanu1 reviewed Jul 11, 2022

View reviewed changes

etc/search-headless.api.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

src/index.ts Outdated Show resolved Hide resolved

ElemelonWind changed the base branch from main to develop July 11, 2022 16:56

ElemelonWind added 2 commits July 11, 2022 12:57

Addressed comments

4b8fb1a

fix provideHeadless

0087780

API update for SearchHeadless

8d0e101

ElemelonWind changed the title ~~Answers -> Search 1: Customer facing renaming~~ Answers -> Search 1: headless unique customer components, package.json Jul 11, 2022

ElemelonWind changed the title ~~Answers -> Search 1: headless unique customer components, package.json~~ Answers -> Search 2: headless unique customer components Jul 11, 2022

ElemelonWind changed the base branch from develop to feature/answers-to-search July 11, 2022 18:42

ElemelonWind and others added 2 commits July 11, 2022 14:45

Merge branch 'feature/answers-to-search' into rename-search

ca69623

Automated update to repo's documentation from github action

50064d4

nmanu1 reviewed Jul 11, 2022

View reviewed changes

src/index.ts Outdated Show resolved Hide resolved

ElemelonWind added 2 commits July 11, 2022 15:41

update exports

6b6f8b7

Merge branch 'rename-search' of https://github.com/yext/search-headless…

2467704

… into rename-search merge

yen-tt reviewed Jul 11, 2022

View reviewed changes

export from deprecated

45581bf

oshi97 reviewed Jul 12, 2022

View reviewed changes

tests/acceptance/provideSearchHeadless.ts Outdated Show resolved Hide resolved

oshi97 reviewed Jul 12, 2022

View reviewed changes

tests/mocks/createMockedAnswersHeadless.ts Outdated Show resolved Hide resolved

renamed files

e201e47

oshi97 reviewed Jul 12, 2022

View reviewed changes

file edits

f01c210

oshi97 reviewed Jul 12, 2022

View reviewed changes

.gitignore Outdated

temp/

.DS_STORE

Copy link

Contributor

oshi97 Jul 12, 2022

Choose a reason for hiding this comment

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

the casing is off here! it's .DS_Store

ElemelonWind reacted with heart emoji

ElemelonWind added 2 commits July 12, 2022 12:32

rm ds store

040b3d0

gitignore fix

7386ab4

oshi97 reviewed Jul 12, 2022

View reviewed changes

ElemelonWind and others added 2 commits July 12, 2022 12:40

minor fixes

8b448ae

Automated update to repo's documentation from github action

ff0f326

oshi97 approved these changes Jul 12, 2022

View reviewed changes

ElemelonWind merged commit da871b1 into feature/answers-to-search Jul 12, 2022

ElemelonWind deleted the rename-search branch July 12, 2022 16:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Answers -> Search 2: headless unique customer components #113

Answers -> Search 2: headless unique customer components #113

ElemelonWind commented Jul 5, 2022 •

edited

Loading

yen-tt left a comment

yen-tt Jul 11, 2022

coveralls commented Jul 11, 2022 •

edited

Loading

oshi97 commented Jul 11, 2022

oshi97 commented Jul 11, 2022

ElemelonWind commented Jul 11, 2022

oshi97 commented Jul 11, 2022

oshi97 commented Jul 11, 2022 •

edited

Loading

ElemelonWind commented Jul 11, 2022

yen-tt Jul 11, 2022 •

edited

Loading

ElemelonWind Jul 12, 2022

yen-tt Jul 11, 2022 •

edited

Loading

yen-tt Jul 11, 2022

oshi97 Jul 12, 2022

oshi97 commented Jul 12, 2022 •

edited

Loading

ElemelonWind commented Jul 12, 2022

oshi97 Jul 12, 2022

oshi97 Jul 12, 2022

oshi97 Jul 12, 2022

ElemelonWind Jul 12, 2022

oshi97 Jul 12, 2022

oshi97 Jul 12, 2022 •

edited

Loading

oshi97 Jul 12, 2022

oshi97 left a comment

		@@ -0,0 +1,29 @@
		import { searchUtilities, provideHeadless } from ".";

		@@ -1,7 +1,7 @@
		import { Matcher, QuerySource, QueryTrigger } from '@yext/answers-core';

Answers -> Search 2: headless unique customer components #113

Answers -> Search 2: headless unique customer components #113

Conversation

ElemelonWind commented Jul 5, 2022 • edited Loading

yen-tt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Jul 11, 2022 • edited Loading

Pull Request Test Coverage Report for Build 2652011560

Details

💛 - Coveralls

oshi97 commented Jul 11, 2022

oshi97 commented Jul 11, 2022

ElemelonWind commented Jul 11, 2022

oshi97 commented Jul 11, 2022

oshi97 commented Jul 11, 2022 • edited Loading

ElemelonWind commented Jul 11, 2022

yen-tt Jul 11, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yen-tt Jul 11, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oshi97 commented Jul 12, 2022 • edited Loading

ElemelonWind commented Jul 12, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oshi97 Jul 12, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oshi97 left a comment

Choose a reason for hiding this comment

ElemelonWind commented Jul 5, 2022 •

edited

Loading

coveralls commented Jul 11, 2022 •

edited

Loading

oshi97 commented Jul 11, 2022 •

edited

Loading

yen-tt Jul 11, 2022 •

edited

Loading

yen-tt Jul 11, 2022 •

edited

Loading

oshi97 commented Jul 12, 2022 •

edited

Loading

oshi97 Jul 12, 2022 •

edited

Loading