Cache competitions list (#1433)

* better caching of competition list
* remove comments
* fix lint errors

* use client 0.2.64

* skip npm ci in travis

* undo travis skipping of test

* update endpoints, test_env

* silence warning for not having any genericschemergistry entries on xdai

* cache tweak

* some cleanup

* fix ens addresses in test

Co-authored-by: Tibet Sprague <[email protected]>

Author: jellegerbrandy

Diff for: Dockerfile

@@ -12,4 +12,4 @@ WORKDIR /alchemy
 RUN npm ci
 COPY . /alchemy
 
-ENTRYPOINT [ "/entry.sh"]
+CMD [ "/entry.sh"]

Diff for: package-lock.json

@@ -76,7 +76,7 @@
   "dependencies": {
     "3box": "^1.16.1",
     "@burner-wallet/burner-connect-provider": "^0.1.1",
-    "@daostack/client": "0.2.63",
+    "@daostack/client": "0.2.64",
     "@dorgtech/daocreator-ui-v1": "^0.2.0-rc.20",
     "@fortawesome/fontawesome-svg-core": "^1.2.10",
     "@fortawesome/free-brands-svg-icons": "^5.6.1",

Diff for: package.json

@@ -5,13 +5,13 @@ import RewardsString from "components/Proposal/RewardsString";
 import { IProfileState } from "reducers/profilesReducer";
 import { IRootState } from "reducers";
 import CountdownText from "components/Scheme/ContributionRewardExtRewarders/Competition/CountdownText";
-import StatusBlob from "./StatusBlob";
-import * as css from "./Competitions.scss";
-import { competitionStatus, CompetitionStatus } from "./utils";
 import { connect } from "react-redux";
 import { IDAOState, IProposalState } from "@daostack/client";
 import { Link } from "react-router-dom";
 import * as React from "react";
+import { competitionStatus, CompetitionStatus } from "./utils";
+import * as css from "./Competitions.scss";
+import StatusBlob from "./StatusBlob";
 
 interface IExternalStateProps {
   creatorProfile: IProfileState;

Diff for: src/components/Scheme/ContributionRewardExtRewarders/Competition/Card.tsx

@@ -16,7 +16,7 @@ import { checkTotalPercent } from "lib/util";
 import * as Datetime from "react-datetime";
 
 import moment = require("moment");
-import BN = require("bn.js")
+import BN = require("bn.js");
 
 interface IExternalProps {
   scheme: ISchemeState;

Diff for: src/components/Scheme/ContributionRewardExtRewarders/Competition/CreateProposal.tsx

@@ -414,16 +414,16 @@ export default withSubscription({
   errorComponent: (props) => <div>{ props.error.message }</div>,
   checkForUpdate: ["currentAccountAddress"],
   createObservable: async (props: IExternalProps & IExternalStateProps ) => {
-    // prime the cache before creating the observable...
+
+    // prime the cache and subscribe
     const cacheQuery = gql`query cacheSuggestions {
-      proposal (id: "${props.proposalState.id}") {
-        id
-        # ...ProposalFields
+      proposals (where: {id: "${props.proposalState.id}"}) {
+        ...ProposalFields
         competition {
           id
           suggestions {
             ...CompetitionSuggestionFields
-            }
+          }
         }
       }
     }
@@ -433,12 +433,16 @@ export default withSubscription({
     `;
 
     const arc = await getArc();
-    await arc.sendQuery(cacheQuery);
+    // sending the query before subscribing resolves a weird cache error - this would ideally be handled in the client
+    await arc.sendQuery(cacheQuery); 
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    await arc.getObservable(cacheQuery, {subscribe: true}).subscribe(() => {});
+    // end cache priming
+
     return combineLatest(
-      /**
-       * Passing `true` to create a subscription because we won't get one otherwise.
-       */
-      getProposalSubmissions(props.proposalState.id, true),
+      // we do not need to subscribe here (second argument = false), because we already subscribed in the line above
+      getProposalSubmissions(props.proposalState.id, false), 
+      // the next construction gets the suggestions for which the user has voted
       props.currentAccountAddress ? getCompetitionVotes(props.proposalState.id, props.currentAccountAddress, true)
         .pipe(
           map((votes: Array<CompetitionVote>) => {

Diff for: src/components/Scheme/ContributionRewardExtRewarders/Competition/Details.tsx

@@ -1,9 +1,12 @@
 import * as React from "react";
 import { BreadcrumbsItem } from "react-breadcrumbs-dynamic";
-import { ISchemeState, IDAOState, IProposalState } from "@daostack/client";
+import { ISchemeState, IDAOState, IProposalState, CompetitionSuggestion, CompetitionVote } from "@daostack/client";
 import { SortService } from "lib/sortService";
 import withSubscription, { ISubscriptionProps } from "components/Shared/withSubscription";
-import { CompetitionStatusEnum, CompetitionStatus, primeCacheForSubmissionsAndVotes } from "./utils";
+import { combineLatest, of } from "rxjs";
+import gql from "graphql-tag";
+import { getArc } from "arc";
+import { CompetitionStatusEnum, CompetitionStatus } from "./utils";
 import Card from "./Card";
 import * as css from "./Competitions.scss";
 
@@ -104,8 +107,44 @@ export default withSubscription({
   loadingComponent: null,
   errorComponent: (props) => <div>{ props.error.message }</div>,
   checkForUpdate: [],
-  createObservable: async (_props: IExternalProps) => {
-    return primeCacheForSubmissionsAndVotes();
+  createObservable: async (props: IExternalProps) => {
+    // prime the cache before creating the observable...
+    const cacheQuery = gql`query cacheSuggestions {
+      proposals (where: {scheme: "${props.scheme.id}"}) {
+        id
+        competition {
+          id
+          endTime
+          contract
+          suggestionsEndTime
+          createdAt
+          numberOfVotesPerVoters
+          numberOfWinners
+          rewardSplit
+          snapshotBlock
+          startTime
+          suggestions {
+            ...CompetitionSuggestionFields
+          }
+          votes { 
+            ...CompetitionVoteFields
+          }
+        }
+      }
+    }
+    ${CompetitionSuggestion.fragments.CompetitionSuggestionFields}
+    ${CompetitionVote.fragments.CompetitionVoteFields}
+    `;
+
+    const arc = await getArc();
+    await arc.sendQuery(cacheQuery, {subscribe: true});
+    // end cache priming
+
+    // TODO: next lines can use some cleanup up
+    return combineLatest(
+      of([]),
+      of([])
+    );
   },
 });
 

Diff for: src/components/Scheme/ContributionRewardExtRewarders/Competition/List.tsx

@@ -1,8 +1,8 @@
-import * as css from "./Competitions.scss";
-import { competitionStatus } from "./utils";
 import { ICompetitionProposalState } from "@daostack/client";
 import * as React from "react";
 import classNames from "classnames";
+import { competitionStatus } from "./utils";
+import * as css from "./Competitions.scss";
 
 export interface IExternalProps {
   competition: ICompetitionProposalState;

Diff for: src/components/Scheme/ContributionRewardExtRewarders/Competition/StatusBlob.tsx

@@ -6,7 +6,7 @@ import moment = require("moment");
 import { getArc } from "arc";
 import { operationNotifierObserver } from "actions/arcActions";
 import { IRootState } from "reducers";
-import { Observable, of, combineLatest } from "rxjs";
+import { Observable, of } from "rxjs";
 import { map, mergeMap, toArray, first } from "rxjs/operators";
 
 /**
@@ -160,7 +160,7 @@ export const redeemForSubmission = (options: IVoteSubmissionOptions ): ThunkActi
 export const getProposalSubmissions = (proposalId: string, subscribe = false): Observable<Array<ICompetitionSuggestionState>> => {
   // fetchAllData so .state() comes from cache
   const competition = new Competition(proposalId, getArc());
-  return competition.suggestions(undefined, { subscribe, fetchAllData: true })
+  return competition.suggestions({}, { subscribe, fetchAllData: true })
     .pipe(
       mergeMap(submissions => of(submissions).pipe(
         mergeMap(submissions => submissions),
@@ -198,9 +198,9 @@ export const getSubmissionVoterHasVoted = (submissionId: string, voterAddress: s
     .pipe(map((votes: Array<CompetitionVote>) => !!votes.length));
 };
 
-export const primeCacheForSubmissionsAndVotes = (): Observable<any> => {
-  return combineLatest(
-    CompetitionSuggestion.search(getArc(), {}, { subscribe: true, fetchAllData: true }),
-    CompetitionVote.search(getArc(), {}, { subscribe: true, fetchAllData: true })
-  );
-};
+// export const primeCacheForSubmissionsAndVotes = (): Observable<any> => {
+//   return combineLatest(
+//     CompetitionSuggestion.search(getArc(), {}, { subscribe: true, fetchAllData: true }),
+//     CompetitionVote.search(getArc(), {}, { subscribe: true, fetchAllData: true })
+//   );
+// };

Diff for: src/components/Scheme/ContributionRewardExtRewarders/Competition/utils.ts

@@ -199,6 +199,7 @@ const SubscribedSchemeContainer = withSubscription({
     await props.daoState.dao.proposals(
       // eslint-disable-next-line @typescript-eslint/camelcase
       {where: { stage_in: [IProposalStage.Boosted, IProposalStage.QuietEndingPeriod, IProposalStage.Queued, IProposalStage.PreBoosted, IProposalStage.Executed ]}},
+      // eslint-disable-next-line @typescript-eslint/no-empty-function
       { fetchAllData: true, subscribe: true }).subscribe(()=>{});
     // end cache priming
 

Diff for: src/components/Scheme/SchemeContainer.tsx

@@ -30,9 +30,7 @@ for (const schemeInfo of KNOWNSCHEMES) {
       for (const address of schemeInfo.addresses[network]) {
         SCHEMEADDRESSES[network][address.toLowerCase()] = schemeInfo;
       }
-    } else {
-      console.error(`No GenericScheme contract addresses in GenericSchemeRegistry defined for network ${network}`);
-    }
+    } 
   }
 }
 interface IABISpec {

Diff for: src/genericSchemeRegistry/index.ts

@@ -9,7 +9,7 @@
       "0x2396A687f75f1a13e3927F1841B291350b0ED977"
     ],
     "private": [
-      "0x60c1026e45fb5c987bca25ee4ad90eb98926cf04"
+      "0x6b85757e0a41f837dbe0b6b4b5157858b62d9a66"
     ]
   },
   "actions": [

Diff for: src/genericSchemeRegistry/schemes/ENSPublicResolver.json

@@ -12,7 +12,7 @@
       "0xf268dc803924f6d9d06c7ddbfc06bf7cc6daf7d4"
     ],
     "private": [
-      "0x5dce333f3aa83a0397721c36fe3058cd8f32379b"
+      "0x9e32124cbecc2460e54735d356c0cb5ca8c8aa44"
     ]
   },
   "actions": [