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

Add context when navigating to appearing proposition from MediaExcerpt #682

Merged
merged 5 commits into from
Jul 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion premiser-ui/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ import NavTabs from "./NavTabs";

import "./App.scss";
import "./fonts.js";
import { PrimaryContextTrailProvider } from "./components/contextTrail/PrimaryContextTrailProvider";

class App extends Component<Props> {
throttledOnWindowScroll: () => void;
Expand Down Expand Up @@ -464,7 +465,9 @@ class App extends Component<Props> {
{navDrawer}

<div id="page">
<Switch>{routes}</Switch>
<PrimaryContextTrailProvider>
<Switch>{routes}</Switch>
</PrimaryContextTrailProvider>
</div>

<div id="footer">
Expand Down
15 changes: 8 additions & 7 deletions premiser-ui/src/JustificationBranch.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ import { EditorTypes } from "./reducers/editors";
import { RootState } from "./setupStore";
import t from "./texts";
import { OnClickJustificationWritQuoteUrl } from "./types";
import { extendContextTrailItems } from "./viewModels";
import { makeContextTrailItems } from "./viewModels";

import "./JustificationBranch.scss";

Expand All @@ -69,7 +69,7 @@ function JustificationBranch({
isCondensed = false,
isUnCondensed = false,
showBasisUrls,
contextTrailItems = [],
contextTrailItems,
showStatusText,
onClickWritQuoteUrl,
}: Props) {
Expand Down Expand Up @@ -181,6 +181,11 @@ function JustificationBranch({

const doHideControls = !isOver;

const nextContextTrailItems = makeContextTrailItems(contextTrailItems, {
connectingEntityType: "JUSTIFICATION",
connectingEntity: justification,
});

const menu = (
<DropdownMenu
buttonType="icon"
Expand Down Expand Up @@ -347,10 +352,6 @@ function JustificationBranch({
return <div>Placeholder justification {j.id}</div>;
}
const id = `counter-justification-${j.id}-branch`;
const nextContextTrailItems = extendContextTrailItems(
contextTrailItems,
{ connectingEntityType: "JUSTIFICATION", connectingEntity: j }
);
return (
<div id={id} key={id} className="counter-justification-branch">
<ConnectedJustificationBranch
Expand Down Expand Up @@ -386,7 +387,7 @@ function JustificationBranch({
showBasisUrls={showBasisUrls}
showStatusText={showStatusText}
menu={menu}
contextTrailItems={contextTrailItems}
contextTrailItems={nextContextTrailItems}
actions={<div className="actions">{actions}</div>}
onMouseOver={onBubbleMouseOver}
onMouseLeave={onBubbleMouseLeave}
Expand Down
8 changes: 2 additions & 6 deletions premiser-ui/src/JustificationsTree.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {
import config from "./config";
import JustificationBranch from "./JustificationBranch";
import t, { ADD_JUSTIFICATION_CALL_TO_ACTION } from "./texts";
import { combineIds, extendContextTrailItems } from "./viewModels";
import { combineIds } from "./viewModels";
import { ComponentId, OnClickJustificationWritQuoteUrl } from "./types";
import { useAppSelector } from "./hooks";
import { selectIsWindowNarrow } from "./selectors";
Expand Down Expand Up @@ -53,10 +53,6 @@ export default function JustificationsTree({
}: Props) {
function toBranch(j: JustificationView) {
const treeId = combineIds(id, "justification-tree", j.id);
const nextContextTrailItems = extendContextTrailItems(contextTrailItems, {
connectingEntityType: "JUSTIFICATION",
connectingEntity: j,
});
return (
<FlipMoveWrapper key={treeId}>
<JustificationBranch
Expand All @@ -67,7 +63,7 @@ export default function JustificationsTree({
isUnCondensed={isUnCondensed}
showBasisUrls={showBasisUrls}
showStatusText={true}
contextTrailItems={nextContextTrailItems}
contextTrailItems={contextTrailItems}
onClickWritQuoteUrl={onClickWritQuoteUrl}
/>
</FlipMoveWrapper>
Expand Down
1 change: 1 addition & 0 deletions premiser-ui/src/components/contextTrail/ContextTrail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ function appearanceToCard(
) {
return (
<>
{/* TODO(684) split into MediaExcerptCard and AppearanceInfoCard ("has an appearance of") */}
<AppearanceCard
id={combineIds(id, "appearance", appearance.id)}
style={{ width: "100%" }}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import {
} from "howdju-common";

import {
makeRouteComponentProps,
renderWithProviders,
withFakeTimers,
withMockServer,
Expand Down Expand Up @@ -57,11 +56,10 @@ describe("PrimaryContextTrailProvider", () => {
})
);

const history = createMemoryHistory();
const { location, match } = makeRouteComponentProps("submit", {
searchParams: {
"context-trail": serializeContextTrail(contextTrailInfos),
},
const history = createMemoryHistory({
initialEntries: [
`/any-path?context-trail=${serializeContextTrail(contextTrailInfos)}`,
],
});

let contextValue: any;
Expand All @@ -72,11 +70,7 @@ describe("PrimaryContextTrailProvider", () => {

// Act
renderWithProviders(
<PrimaryContextTrailProvider
history={history}
location={location}
match={match}
>
<PrimaryContextTrailProvider>
<PrimaryContextTrail.Consumer>
{captureContextValue}
</PrimaryContextTrail.Consumer>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import React, { createContext, PropsWithChildren } from "react";
import React, { createContext, ReactNode } from "react";
import queryString from "query-string";
import { isArray, isEmpty, map, some } from "lodash";
import { RouteComponentProps } from "react-router";
import { useLocation } from "react-router";
import { Location } from "history";
import useDeepCompareEffect from "use-deep-compare-effect";
import { denormalize } from "normalizr";
Expand All @@ -20,15 +20,15 @@ import { api } from "@/apiActions";
import { RootState } from "@/setupStore";
import { normalizationSchemaByEntityType } from "@/normalizationSchemas";

interface Props extends RouteComponentProps {}

/**
* Obtains the context trail from the query params and API for the PrimaryContextTrail context.
*/
export function PrimaryContextTrailProvider({
location,
children,
}: PropsWithChildren<Props>) {
}: {
children: ReactNode;
}) {
const location = useLocation();
const { infos, hasInvalidInfos } =
contextTrailItemInfosFromLocation(location);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { MaterialSymbol } from "react-material-symbols";
import { Moment } from "moment";

import {
ContextTrailItem,
MediaExcerptView,
toUrlWithFragmentFromAnchors,
toUrlWithFragmentFromQuotation,
Expand All @@ -27,11 +28,13 @@ interface Props {
id: string;
mediaExcerpt: MediaExcerptView;
showApparitionCount?: boolean;
contextTrailItems?: ContextTrailItem[];
}

export default function MediaExcerptViewer({
mediaExcerpt,
showApparitionCount = true,
contextTrailItems,
}: Props) {
const dispatch = useAppDispatch();
const onClickUrlLocator =
Expand Down Expand Up @@ -69,7 +72,7 @@ export default function MediaExcerptViewer({
</span>
)}
<Link
to={paths.mediaExcerpt(mediaExcerpt)}
to={paths.mediaExcerpt(mediaExcerpt, contextTrailItems)}
title={`used in ${justificationBasisUsageCount} ${
justificationBasisUsageCount === 1
? "justification"
Expand Down
4 changes: 2 additions & 2 deletions premiser-ui/src/normalizationSchemas.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { schema } from "normalizr";

import {
AccountSettings,
AppearanceOut,
AppearanceView,
ContextTrailItem,
Domain,
JustificationView,
Expand Down Expand Up @@ -329,7 +329,7 @@ export const accountSettingsSchema = new schema.Entity<AccountSettings>(
"accountSettings"
);

export const appearanceSchema = new schema.Entity<AppearanceOut>(
export const appearanceSchema = new schema.Entity<AppearanceView>(
"appearances",
{
mediaExcerpt: mediaExcerptSchema,
Expand Down
4 changes: 4 additions & 0 deletions premiser-ui/src/pages/appearances/ApparitionCard.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import withEntityCard from "@/withEntityCard";
import AppearanceApparitionViewer from "./ApparitionViewer";

export default withEntityCard(AppearanceApparitionViewer, "appearance");
44 changes: 44 additions & 0 deletions premiser-ui/src/pages/appearances/ApparitionViewer.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
import React from "react";

import { AppearanceView, ContextTrailItem, EntityId } from "howdju-common";

import { logger } from "@/logger";
import PropositionEntityViewer from "@/PropositionEntityViewer";
import { makeContextTrailItems } from "@/viewModels";

interface Props {
id: EntityId;
appearance: AppearanceView;
contextTrailItems?: ContextTrailItem[];
}

/**
* Component for viewing the apparition of an appearance. This is useful on
* a page dedicated to the MediaExcerpt, since this component will not duplicate
* the MediaExcerpt information.
*/
export default function ApparitionViewer({
id,
appearance,
contextTrailItems,
}: Props) {
const nextContextTrailItems = makeContextTrailItems(contextTrailItems, {
connectingEntityType: "APPEARANCE",
connectingEntity: appearance,
});
switch (appearance.apparition.type) {
case "PROPOSITION":
return (
<PropositionEntityViewer
id={id}
proposition={appearance.apparition.entity}
contextTrailItems={nextContextTrailItems}
/>
);
default:
logger.error(
`"Unknown apparition type for ApparitionViewer ${appearance.apparition.type}`
);
return <div>Unknown apparition type</div>;
}
}
12 changes: 5 additions & 7 deletions premiser-ui/src/pages/appearances/AppearanceViewer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import React from "react";
import { AppearanceView, ContextTrailItem } from "howdju-common";

import CreationInfo from "@/components/creationInfo/CreationInfo";
import { combineIds, extendContextTrailItems } from "@/viewModels";
import { combineIds, makeContextTrailItems } from "@/viewModels";
import PropositionEntityViewer from "@/PropositionEntityViewer";
import MediaExcerptEntityViewer from "@/components/mediaExcerpts/MediaExcerptEntityViewer";

Expand All @@ -22,12 +22,10 @@ export default function AppearanceViewer({
contextTrailItems,
mode = "TOP_LEVEL",
}: Props) {
const nextContextTrailItems = contextTrailItems
? extendContextTrailItems(contextTrailItems, {
connectingEntityType: "APPEARANCE",
connectingEntity: appearance,
})
: undefined;
const nextContextTrailItems = makeContextTrailItems(contextTrailItems, {
connectingEntityType: "APPEARANCE",
connectingEntity: appearance,
});
if (mode === "CONTEXT_TRAIL") {
return (
<div className="appearance-viewer">
Expand Down
7 changes: 3 additions & 4 deletions premiser-ui/src/pages/mediaExcerpt/MediaExcerptUsages.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import React, { UIEvent, useEffect } from "react";
import isEmpty from "lodash/isEmpty";
import map from "lodash/map";
import { GridCell } from "@react-md/utils";

import { EntityId } from "howdju-common";
Expand All @@ -11,7 +10,7 @@ import {
} from "../../normalizationSchemas";
import JustificationCard from "../../JustificationCard";
import { useAppDispatch, useAppSelector, useAppEntitySelector } from "@/hooks";
import AppearanceCard from "../appearances/AppearanceCard";
import ApparitionCard from "../appearances/ApparitionCard";
import page from "./mediaExcerptUsagesSlice";
import FetchMoreButton from "@/components/button/FetchMoreButton";
import {
Expand Down Expand Up @@ -97,11 +96,11 @@ export default function MediaExcerptUsages({ mediaExcerptId }: Props) {

<h1>Appearances</h1>
<FlipGrid>
{map(appearances, (a) => {
{appearances.map((a) => {
const id = `appearance-card-${a.id}`;
return (
<GridCell key={id} {...appearanceCardColSpans}>
<AppearanceCard id={id} appearance={a} />
<ApparitionCard id={id} appearance={a} />
</GridCell>
);
})}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,6 @@ function ValidPropositionUsagesPage({ propositionId }: ValidProps) {
/>
</SingleColumnGrid>
)}

<h2>Direct Statements</h2>
<FlipGrid>
{map(directStatements, (s) => {
Expand All @@ -155,7 +154,6 @@ function ValidPropositionUsagesPage({ propositionId }: ValidProps) {
<CircularProgress id={`$justificationsSearchPage-Progress`} />
</div>
)}

<h2>Indirect Statements</h2>
<FlipGrid>
{map(indirectStatements, (s) => {
Expand All @@ -175,7 +173,6 @@ function ValidPropositionUsagesPage({ propositionId }: ValidProps) {
<CircularProgress id={`$justificationsSearchPage-Progress`} />
</div>
)}

<h2>Justifications</h2>
<FlipGrid>
{map(justifications, (j) => {
Expand All @@ -196,10 +193,9 @@ function ValidPropositionUsagesPage({ propositionId }: ValidProps) {
</div>
)}
<div>{fetchMoreJustificationsButton}</div>

<h2>Appearances</h2>
<FlipGrid>
{map(appearances, (a) => {
{appearances.map((a) => {
const id = `appearance-card-${a.id}`;
return (
<GridCell key={id} {...appearanceCardColSpans}>
Expand All @@ -214,7 +210,6 @@ function ValidPropositionUsagesPage({ propositionId }: ValidProps) {
<CircularProgress id={`appearances-progress`} />
</div>
)}

<h2>PropositionCompounds</h2>
<FlipGrid>
{map(propositionCompounds, (pc) => {
Expand Down
Loading
Loading