Skip to content

Feat/evidence search #1640

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

Merged
merged 3 commits into from
Jul 18, 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
3 changes: 3 additions & 0 deletions subgraph/core-neo/subgraph.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
specVersion: 0.0.4
schema:
file: ./schema.graphql
features:
- fullTextSearch

dataSources:
- kind: ethereum
name: KlerosCore
Expand Down
3 changes: 3 additions & 0 deletions subgraph/core-university/subgraph.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
specVersion: 0.0.4
schema:
file: ./schema.graphql
features:
- fullTextSearch

dataSources:
- kind: ethereum
name: KlerosCore
Expand Down
12 changes: 12 additions & 0 deletions subgraph/core/schema.graphql
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,9 @@ interface Evidence {
id: ID!
evidence: String!
evidenceGroup: EvidenceGroup!
evidenceIndex: String!
sender: User!
senderAddress: String!
timestamp: BigInt!
name: String
description: String
Expand Down Expand Up @@ -300,7 +302,9 @@ type ClassicEvidence implements Evidence @entity(immutable: true) {
id: ID! # classicEvidenceGroup.id-nextEvidenceIndex
evidence: String!
evidenceGroup: EvidenceGroup!
evidenceIndex: String!
sender: User!
senderAddress: String!
timestamp: BigInt!
name: String
description: String
Expand All @@ -319,3 +323,11 @@ type ClassicContribution implements Contribution @entity {
choice: BigInt!
rewardWithdrawn: Boolean!
}

type _Schema_
@fulltext(
name: "evidenceSearch"
language: en
algorithm: rank
include: [{ entity: "ClassicEvidence", fields: [{ name: "name" }, { name: "description" },{ name: "senderAddress"},{ name: "evidenceIndex"}] }]
)
2 changes: 2 additions & 0 deletions subgraph/core/src/EvidenceModule.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,13 @@ export function handleEvidenceEvent(event: EvidenceEvent): void {
evidenceGroup.save();
const evidenceId = `${evidenceGroupID}-${evidenceIndex.toString()}`;
const evidence = new ClassicEvidence(evidenceId);
evidence.evidenceIndex = evidenceIndex.plus(ONE).toString();
const userId = event.params._party.toHexString();
evidence.timestamp = event.block.timestamp;
evidence.evidence = event.params._evidence;
evidence.evidenceGroup = evidenceGroupID.toString();
evidence.sender = userId;
evidence.senderAddress = userId;
ensureUser(userId);

let jsonObjValueAndSuccess = json.try_fromString(event.params._evidence);
Expand Down
3 changes: 3 additions & 0 deletions subgraph/core/subgraph.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
specVersion: 0.0.4
schema:
file: ./schema.graphql
features:
- fullTextSearch

dataSources:
- kind: ethereum
name: KlerosCore
Expand Down
2 changes: 1 addition & 1 deletion subgraph/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@kleros/kleros-v2-subgraph",
"version": "0.6.2",
"version": "0.7.0",
"license": "MIT",
"scripts": {
"update:core:arbitrum-sepolia-devnet": "./scripts/update.sh arbitrumSepoliaDevnet arbitrum-sepolia core/subgraph.yaml",
Expand Down
10 changes: 10 additions & 0 deletions web/src/assets/svgs/icons/arrow-down.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 0 additions & 14 deletions web/src/components/EvidenceCard.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -62,20 +62,6 @@ const BottomShade = styled.div`
}
`;

const StyledA = styled.a`
display: flex;
margin-left: auto;
gap: ${responsiveSize(5, 6)};
${landscapeStyle(
() => css`
> svg {
width: 16px;
fill: ${({ theme }) => theme.primaryBlue};
}
`
)}
`;

const AccountContainer = styled.div`
display: flex;
flex-direction: row;
Expand Down
61 changes: 41 additions & 20 deletions web/src/hooks/queries/useEvidences.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,39 +4,60 @@ import { REFETCH_INTERVAL } from "consts/index";
import { useGraphqlBatcher } from "context/GraphqlBatcher";

import { graphql } from "src/graphql";
import { EvidencesQuery } from "src/graphql/graphql";
import { EvidenceDetailsFragment, EvidencesQuery } from "src/graphql/graphql";
export type { EvidencesQuery };

export const evidenceFragment = graphql(`
fragment EvidenceDetails on ClassicEvidence {
id
evidence
sender {
id
}
timestamp
name
description
fileURI
fileTypeExtension
evidenceIndex
}
`);

const evidencesQuery = graphql(`
query Evidences($evidenceGroupID: String) {
evidences(where: { evidenceGroup: $evidenceGroupID }, orderBy: timestamp, orderDirection: desc) {
id
evidence
sender {
id
}
timestamp
name
description
fileURI
fileTypeExtension
evidences(where: { evidenceGroup: $evidenceGroupID }, orderBy: timestamp, orderDirection: asc) {
...EvidenceDetails
}
}
`);

export const useEvidences = (evidenceGroup?: string) => {
const evidenceSearchQuery = graphql(`
query EvidenceSearch($keywords: String!, $evidenceGroupID: String) {
evidenceSearch(text: $keywords, where: { evidenceGroup: $evidenceGroupID }) {
...EvidenceDetails
}
}
`);

export const useEvidences = (evidenceGroup?: string, keywords?: string) => {
const isEnabled = evidenceGroup !== undefined;
const { graphqlBatcher } = useGraphqlBatcher();

return useQuery<EvidencesQuery>({
queryKey: [`evidencesQuery${evidenceGroup}`],
const document = keywords ? evidenceSearchQuery : evidencesQuery;
return useQuery<{ evidences: EvidenceDetailsFragment[] }>({
queryKey: [
keywords ? `evidenceSearchQuery${evidenceGroup}-${keywords}` : `evidencesQuery${evidenceGroup}`,
],
enabled: isEnabled,
refetchInterval: REFETCH_INTERVAL,
queryFn: async () =>
await graphqlBatcher.fetch({
queryFn: async () => {
const result = await graphqlBatcher.fetch({
id: crypto.randomUUID(),
document: evidencesQuery,
variables: { evidenceGroupID: evidenceGroup?.toString() },
}),
document: document,
variables: { evidenceGroupID: evidenceGroup?.toString(), keywords: keywords },
});

return keywords ? { evidences: [...result.evidenceSearch] } : result;
},
});
};
69 changes: 69 additions & 0 deletions web/src/pages/Cases/CaseDetails/Evidence/EvidenceSearch.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
import React, { useState } from "react";
import styled from "styled-components";

import { useAccount } from "wagmi";

import { Button, Searchbar } from "@kleros/ui-components-library";

import { isUndefined } from "src/utils";

import { responsiveSize } from "styles/responsiveSize";

import { EnsureChain } from "components/EnsureChain";

import SubmitEvidenceModal from "./SubmitEvidenceModal";

const SearchContainer = styled.div`
width: 100%;
display: flex;
flex-wrap: wrap;
align-items: center;
gap: ${responsiveSize(16, 28)};
`;

const StyledSearchBar = styled(Searchbar)`
min-width: 220px;
flex: 1;
`;

const StyledButton = styled(Button)`
align-self: flex-end;
`;

interface IEvidenceSearch {
search?: string;
setSearch: (search: string) => void;
evidenceGroup?: bigint;
}

const EvidenceSearch: React.FC<IEvidenceSearch> = ({ search, setSearch, evidenceGroup }) => {
const [isModalOpen, setIsModalOpen] = useState(false);
const { address } = useAccount();

return (
<>
{!isUndefined(evidenceGroup) && (
<SubmitEvidenceModal isOpen={isModalOpen} close={() => setIsModalOpen(false)} {...{ evidenceGroup }} />
)}

<SearchContainer>
<StyledSearchBar
placeholder="Search evidence by number, word, or submitter."
onChange={(e) => setSearch(e.target.value)}
value={search}
/>

<EnsureChain>
<StyledButton
text="Submit Evidence"
disabled={typeof address === "undefined" || isModalOpen}
isLoading={isModalOpen}
onClick={() => setIsModalOpen(true)}
/>
</EnsureChain>
</SearchContainer>
</>
);
};

export default EvidenceSearch;
75 changes: 46 additions & 29 deletions web/src/pages/Cases/CaseDetails/Evidence/index.tsx
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
import React, { useState } from "react";
import React, { useCallback, useRef, useState } from "react";
import styled from "styled-components";

import { useParams } from "react-router-dom";
import { useAccount } from "wagmi";
import { useDebounce } from "react-use";

import { Button, Searchbar } from "@kleros/ui-components-library";
import { Button } from "@kleros/ui-components-library";

import { isUndefined } from "utils/index";
import DownArrow from "svgs/icons/arrow-down.svg";

import { useEvidenceGroup } from "queries/useEvidenceGroup";
import { useEvidences } from "queries/useEvidences";

import { responsiveSize } from "styles/responsiveSize";

import { EnsureChain } from "components/EnsureChain";
import EvidenceCard from "components/EvidenceCard";
import { SkeletonEvidenceCard } from "components/StyledSkeleton";

import SubmitEvidenceModal from "./SubmitEvidenceModal";
import EvidenceSearch from "./EvidenceSearch";

const Container = styled.div`
width: 100%;
Expand All @@ -29,43 +28,61 @@ const Container = styled.div`
padding: ${responsiveSize(16, 32)};
`;

const StyledButton = styled(Button)`
align-self: flex-end;
`;

const StyledLabel = styled.label`
display: flex;
margin-top: 16px;
font-size: 16px;
`;

const ScrollButton = styled(Button)`
align-self: flex-end;
background-color: transparent;
padding: 0;
flex-direction: row-reverse;
margin: 0 0 18px;
gap: 8px;
.button-text {
color: ${({ theme }) => theme.primaryBlue};
font-weight: 400;
}
.button-svg {
margin: 0;
}
:focus,
:hover {
background-color: transparent;
}
`;

const Evidence: React.FC<{ arbitrable?: `0x${string}` }> = ({ arbitrable }) => {
const [isModalOpen, setIsModalOpen] = useState(false);
const { id } = useParams();
const { data: evidenceGroup } = useEvidenceGroup(id, arbitrable);
const { data } = useEvidences(evidenceGroup?.toString());
const { address } = useAccount();
const ref = useRef<HTMLDivElement>(null);
const [search, setSearch] = useState<string>();
const [debouncedSearch, setDebouncedSearch] = useState<string>();

const { data } = useEvidences(evidenceGroup?.toString(), debouncedSearch);

useDebounce(() => setDebouncedSearch(search), 500, [search]);

const scrollToLatest = useCallback(() => {
if (!ref.current) return;
const latestEvidence = ref.current.lastElementChild;

if (!latestEvidence) return;

latestEvidence.scrollIntoView({ behavior: "smooth" });
}, [ref]);

return (
<Container>
{!isUndefined(evidenceGroup) && (
<SubmitEvidenceModal isOpen={isModalOpen} close={() => setIsModalOpen(false)} {...{ evidenceGroup }} />
)}
<Searchbar />
<EnsureChain>
<StyledButton
small
text="Submit Evidence"
disabled={typeof address === "undefined" || isModalOpen}
isLoading={isModalOpen}
onClick={() => setIsModalOpen(true)}
/>
</EnsureChain>
<Container ref={ref}>
<EvidenceSearch {...{ search, setSearch, evidenceGroup }} />
<ScrollButton small Icon={DownArrow} text="Scroll to latest" onClick={scrollToLatest} />
{data ? (
data.evidences.map(({ evidence, sender, timestamp, name, description, fileURI }, i) => (
data.evidences.map(({ evidence, sender, timestamp, name, description, fileURI, evidenceIndex }) => (
<EvidenceCard
key={timestamp}
index={i + 1}
index={parseInt(evidenceIndex)}
sender={sender?.id}
{...{ evidence, timestamp, name, description, fileURI }}
/>
Expand Down
Loading