feature/improved-article-content-loading #179

Merged
danysmall merged 7 commits from feature/improved-article-content-loading into develop 2022-11-12 23:19:40 +00:00
13 changed files with 153 additions and 114 deletions

View File

@ -12,7 +12,7 @@ dev: setup
test: setup
npm run test
container: setup
container:
docker build -t ${PROJECT_NAME} .
clean:

View File

@ -1,6 +1,9 @@
#! /bin/bash
# no verbose
set +x
# save env to file
printenv > .env.production
# config
envFilename='.env.production'
resolvingPath='/usr/share/nginx/html'

View File

@ -1,44 +1,42 @@
import type { ArticleStore } from "../domain/articleStore";
import { useCallback, useEffect } from "react";
import { getArticle } from "article/data/articleAPIService";
import { Article } from "article/domain/articleEntity";
import { GetArticleUseCase } from "article/useCases/getArticleUseCase";
import { FetchArticleUseCase } from "article/useCases/fetchArticleUseCase";
import { useParams } from "react-router-dom";
function useArticleViewModel(
store: ArticleStore,
fetchArticleUseCase: (
fetchArticleCallback: (id: string) => Promise<Article | null>,
setArticle: ArticleStore["setArticle"],
id: string,
) => Promise<Article | null>,
getArticleUseCase: (
getArticle: ArticleStore["getArticle"],
setArticle: ArticleStore["setArticle"],
id: Article["id"],
) => Promise<Article | null>,
id: string,
fetchArticleUseCase: FetchArticleUseCase,
getArticleUseCase: GetArticleUseCase,
) {
let article: Article | null | undefined;
const { id } = useParams();
const _getArticle = useCallback(
(id: string) => {
getArticleUseCase(store.getArticle, store.setArticle, id).then(async (value) => {
if (value == null) {
article = await fetchArticleUseCase(getArticle, store.setArticle, id);
return;
}
article = value;
});
const getArticle = useCallback(
(
articleID: string,
getArticleUseCase: GetArticleUseCase,
fetchArticleUseCase: FetchArticleUseCase
) => {
getArticleUseCase.call(articleID).catch((_) => fetchArticleUseCase.call(articleID));
},
[store.setArticle]
[]
);
useEffect(() => {
_getArticle(id);
}, [article]);
useEffect(
() => {
getArticle(id ?? '', getArticleUseCase, fetchArticleUseCase);
},
[
id,
getArticle,
getArticleUseCase,
fetchArticleUseCase
],
);
return {
article: store.article,
shouldShowLoading: typeof store.article === "undefined" || store.isLoading,
article: store.currentArticle,
shouldShowLoading: store.isLoading,
hasError: store.hasError,
};
}

View File

@ -7,7 +7,7 @@ import { integratorApiClient } from "core/httpClient";
const articleEndpoint = "/papers/"
async function getArticle(id: string): Promise<Article> {
async function fetchArticle(id: string): Promise<Article> {
try {
const response = await integratorApiClient.get<FetchArticleByIdDTO>(
// `https://run.mocky.io/v3/62cd4581-d864-4d46-b1d6-02b45b5d1994/${id}`
@ -33,4 +33,4 @@ async function getArticle(id: string): Promise<Article> {
}
}
export { getArticle };
export { fetchArticle };

View File

@ -1,22 +1,25 @@
import type { Article } from "../domain/articleEntity";
import { getArticle as getArticleAPI } from "./articleAPIService";
import * as actionTypes from "./articleActionTypes";
import { dispatchStatus } from "../../store/index";
const setArticleAction = (article: Article) => (dispatch: any) =>
dispatch({ type: actionTypes.SET_ARTICLE, article });
const setArticleAction = (article: Article, articlesList: Array<Article>) => (dispatch: any) => {
if (!articlesList.includes(article)) {
const updatedList = articlesList.concat([article]);
dispatch({ type: actionTypes.SET_ARTICLE, article, updatedList });
}
}
const getArticleAction = (id: string) => (dispatch: any) => {
return getArticleAPI(id)
.then((article) => {
const getArticleAction = (id: string, articles: Array<Article>) => (dispatch: any) => {
const filteredArray = articles.filter((e) => e.id == id);
if (filteredArray.length > 0) {
const article = filteredArray[0];
dispatchStatus(actionTypes.GET_ARTICLE, ".success", article)(dispatch);
return article;
})
.catch((reason) => {
}
const reason = 'Article not in the store';
dispatchStatus(actionTypes.GET_ARTICLE, ".failure", reason)(dispatch);
return reason;
});
return null;
};
export { setArticleAction, getArticleAction };

View File

@ -2,37 +2,58 @@ import React, { useCallback, useState } from "react";
import { useDispatch } from "react-redux";
import { ArticleStore } from "../domain/articleStore";
import type { Article } from "../domain/articleEntity";
import { getArticle as getArticleAPI } from "./articleAPIService";
const useArticleCommonStore = (): ArticleStore => {
const [isLoading, setLoading] = useState<boolean>(false);
const [hasError, setError] = useState<boolean>(false);
const [article, setArticleState] = useState<Article | undefined>();
const [currentArticle, setCurrentArticle] = useState<Article | null>(null);
const [articles, setArticlesState] = useState<Array<Article>>([]);
const dispatch = useDispatch();
const getArticle = useCallback(
async (id: string) => {
(id: string) => {
setLoading(true);
try {
const article = await getArticleAPI(id);
setArticleState(article);
setLoading(false);
return article;
} catch (error) {
if (typeof currentArticle === undefined) {
const fromStore = findArticleFromStore(id);
if (typeof fromStore === undefined) {
setError(true);
return null;
}
setCurrentArticle(fromStore);
setLoading(false);
return fromStore;
}
setLoading(false);
return currentArticle;
},
[dispatch]
);
const findArticleFromStore = (id: string): Article | null => {
const filteredArray = articles.filter((e) => e.id == id);
if (filteredArray.length > 0) {
return filteredArray[0];
}
return null;
}
const setNewArticle = (newArticle: Article) => {
setCurrentArticle(newArticle);
if (!articles.includes(newArticle)) {
setArticlesState(articles.concat([newArticle]));
} else if (articles.length == 0) {
setArticlesState([newArticle]);
}
}
return {
article: article,
articles: articles,
currentArticle: currentArticle,
isLoading,
hasError,
setArticle: setArticleState,
getArticle,
setArticle: setNewArticle,
getArticle: getArticle,
};
};

View File

@ -5,7 +5,8 @@ import * as actionTypes from "./articleActionTypes";
type ArticleStoreState = Omit<ArticleStore, "getArticle" | "setArticle">;
const INITIAL_STATE: ArticleStoreState = {
article: undefined,
articles: [],
currentArticle: null,
isLoading: false,
hasError: false,
};
@ -16,13 +17,13 @@ const articleReducer = (
): ArticleStoreState => {
switch (action.type) {
case actionTypes.SET_ARTICLE:
return { ...state, article: action.article };
return { ...state, articles: action.updatedList, currentArticle: action.article, hasError: typeof action.article === undefined, isLoading: false };
case actionTypes.GET_ARTICLE:
return { ...state, isLoading: true };
case actionTypes.GET_ARTICLE_SUCCESS:
return { ...state, isLoading: false, article: action.payload };
return { ...state, isLoading: false, currentArticle: action.payload };
case actionTypes.GET_ARTICLE_FAILURE:
return { ...state, hasError: true, isLoading: false };
return { ...state, hasError: false, isLoading: true };
default:
return state;
}

View File

@ -9,22 +9,23 @@ import { RootState, useAppSelector } from "store";
const articleSelector = (state: RootState): ArticleStoreState => state.article;
const useArticleStore = (): ArticleStore => {
const { isLoading, article, hasError } = useAppSelector(articleSelector);
const { isLoading, hasError, currentArticle, articles } = useAppSelector(articleSelector);
const dispatch = useDispatch();
const setArticle = useCallback(
(article: Article) => setArticleAction(article)(dispatch),
(article: Article) => setArticleAction(article, articles)(dispatch),
[dispatch]
);
const getArticle = useCallback(
(id: string) => getArticleAction(id)(dispatch),
(id: string) => getArticleAction(id, articles)(dispatch),
[dispatch]
);
return {
article: article,
articles: articles,
currentArticle: currentArticle,
isLoading,
hasError,
setArticle,

View File

@ -1,13 +1,14 @@
import { Article } from './articleEntity';
interface ArticleStore {
// State
article: Article | undefined;
articles: Array<Article>;
currentArticle: Article | null;
isLoading: boolean;
hasError: boolean;
// Actions
setArticle(article?: Article): void;
getArticle(identifier: string): Promise<Article | null>;
setArticle(article: Article): void;
getArticle(identifier: string): Article | null;
}
export type { ArticleStore };

View File

@ -1,16 +1,29 @@
import { Article } from "article/domain/articleEntity";
import { ArticleStore } from "article/domain/articleStore";
const fetchArticleUseCase = async (
fetchArticleCallback: (id: string) => Promise<Article | null>,
setArticle: ArticleStore["setArticle"],
id: string,
): Promise<Article | null> => {
const article = await fetchArticleCallback(id);
if (article) {
await setArticle(article);
class FetchArticleUseCase {
/* ------------------------------ Dependencies ------------------------------ */
_fetchArticleCallback: (id: string) => Promise<Article | null>;
_store: ArticleStore;
/* -------------------------------------------------------------------------- */
constructor(
fetchArticle: (id: string) => Promise<Article | null>,
store: ArticleStore,
) {
this._fetchArticleCallback = fetchArticle;
this._store = store;
}
/* ----------------------------- Implementation ----------------------------- */
async call(id: string): Promise<Article | null> {
return this._fetchArticleCallback(id).then((article) => {
if (article != null) {
this._store.setArticle(article);
}
return article;
};
})
}
/* -------------------------------------------------------------------------- */
}
export { fetchArticleUseCase };
export { FetchArticleUseCase };

View File

@ -1,16 +1,25 @@
import { Article } from "article/domain/articleEntity";
import type { ArticleStore } from "../domain/articleStore";
const getArticleUseCase = async (
getArticle: ArticleStore["getArticle"],
setArticle: ArticleStore["setArticle"],
id: Article["id"]
): Promise<Article | null> => {
const article = await getArticle(id);
if (article) {
await setArticle(article);
class GetArticleUseCase {
/* ------------------------------ Dependencies ------------------------------ */
_store: ArticleStore;
/* -------------------------------------------------------------------------- */
constructor(
store: ArticleStore,
) {
this._store = store;
}
return article;
};
/* ----------------------------- Implementation ----------------------------- */
async call(id: string): Promise<Article> {
const storedArticle = this._store.getArticle(id);
if (storedArticle != null) {
this._store.setArticle(storedArticle);
return storedArticle;
}
throw new Error('Article not found');
}
/* -------------------------------------------------------------------------- */
}
export { getArticleUseCase };
export { GetArticleUseCase };

View File

@ -10,27 +10,20 @@ import { SVGSearch } from "components/icons";
import BaseLayout from "components/BaseLayout";
import Typography from "components/typography/Typography";
import { useTranslation } from "react-i18next";
import { fetchArticleUseCase } from "article/useCases/fetchArticleUseCase";
import { getArticleUseCase } from "article/useCases/getArticleUseCase";
import { FetchArticleUseCase } from "article/useCases/fetchArticleUseCase";
import { GetArticleUseCase } from "article/useCases/getArticleUseCase";
import { fetchArticle } from "article/data/articleAPIService";
const AnArticle = () => {
const store = useArticleStore();
const { id } = useParams();
const { article, hasError, shouldShowLoading } = useArticleViewModel(
store,
fetchArticleUseCase,
getArticleUseCase,
id ?? '',
new FetchArticleUseCase(fetchArticle, store),
new GetArticleUseCase(store),
);
const { i18n, t } = useTranslation();
// const { id } = useParams();
// const newId = `${id}`;
// useEffect(() => {
// store.getArticle(newId);
// }, [id]);
if (hasError) {
return <NotFound />;
}

View File

@ -13,21 +13,17 @@ import BaseLayout from "components/BaseLayout";
import Container from "components/Container";
import NotFound from "./NotFound";
import Markdown from "components/Markdown";
import { fetchArticleUseCase } from "article/useCases/fetchArticleUseCase";
import { getArticleUseCase } from "article/useCases/getArticleUseCase";
import { FetchArticleUseCase } from "article/useCases/fetchArticleUseCase";
import { GetArticleUseCase } from "article/useCases/getArticleUseCase";
import { fetchArticle } from "article/data/articleAPIService";
const AnArticleBody = () => {
const store = useArticleStore();
const { id } = useParams();
const { article, hasError, shouldShowLoading } = useArticleViewModel(
store,
fetchArticleUseCase,
getArticleUseCase,
id ?? '',
new FetchArticleUseCase(fetchArticle, store),
new GetArticleUseCase(store),
);
// useEffect(() => {
// store.getArticle(newId);
// }, [id]);
if (hasError) <NotFound />;
return (
<BaseLayout>