Introduce and rollout arbitraryUrl #3239

test/docmaps/docmap/construct-docmap-view-model.test.ts

@@ -1,4 +1,3 @@
-import { URL } from 'url';
 import * as E from 'fp-ts/Either';
 import * as TE from 'fp-ts/TaskEither';
 import { pipe } from 'fp-ts/function';
@@ -8,7 +7,7 @@ import { toExpressionDoi } from '../../../src/types/article-id';
 import * as DE from '../../../src/types/data-error';
 import { RecordEvaluationPublicationCommand } from '../../../src/write-side/commands';
 import { TestFramework, createTestFramework } from '../../framework';
-import { arbitraryUri } from '../../helpers';
+import { arbitraryUrl } from '../../helpers';
 import { arbitraryArticleId } from '../../types/article-id.helper';
 import { arbitraryDataError } from '../../types/data-error.helper';
 import { arbitraryEvaluationLocator } from '../../types/evaluation-locator.helper';
@@ -56,7 +55,7 @@ describe('construct-docmap-view-model', () => {
       });
 
       describe('when we can fetch a human readable original url for the evaluations', () => {
-        const humanReadableOriginalUrl = new URL(arbitraryUri());
+        const humanReadableOriginalUrl = arbitraryUrl();
 
         beforeEach(async () => {
           viewModel = await pipe(

test/docmaps/docmap/render-docmap.test.ts

@@ -9,7 +9,9 @@ import { anonymous } from '../../../src/docmaps/docmap/peer-reviewer';
 import { publisherAccountId } from '../../../src/docmaps/docmap/publisher-account-id';
 import { renderDocmap } from '../../../src/docmaps/docmap/render-docmap';
 import { ExpressionDoi } from '../../../src/types/expression-doi';
-import { arbitraryDate, arbitraryString, arbitraryUri } from '../../helpers';
+import {
+  arbitraryDate, arbitraryString, arbitraryUrl,
+} from '../../helpers';
 import { arbitraryEvaluationLocator } from '../../types/evaluation-locator.helper';
 import { arbitraryExpressionDoi } from '../../types/expression-doi.helper';
 import { arbitraryGroup } from '../../types/group.helper';
@@ -40,14 +42,14 @@ describe('render-docmap', () => {
       group,
       evaluations: [
         {
-          sourceUrl: new URL(arbitraryUri()),
+          sourceUrl: arbitraryUrl(),
           evaluationLocator: arbitraryEvaluationLocator(),
           recordedAt: earlierEvaluationRecordedDate,
           publishedAt: arbitraryDate(),
           authors: [],
         },
         {
-          sourceUrl: new URL(arbitraryUri()),
+          sourceUrl: arbitraryUrl(),
           evaluationLocator: arbitraryEvaluationLocator(),
           recordedAt: laterEvaluationRecordedDate,
           publishedAt: arbitraryDate(),
@@ -63,7 +65,7 @@ describe('render-docmap', () => {
         group,
         evaluations: [
           {
-            sourceUrl: new URL(arbitraryUri()),
+            sourceUrl: arbitraryUrl(),
             evaluationLocator: arbitraryEvaluationLocator(),
             recordedAt: arbitraryDate(),
             publishedAt: arbitraryDate(),

test/framework/happy-path-third-party-adapters.ts

@@ -1,4 +1,3 @@
-import { URL } from 'url';
 import * as E from 'fp-ts/Either';
 import * as O from 'fp-ts/Option';
 import * as T from 'fp-ts/Task';
@@ -12,7 +11,7 @@ import { toHtmlFragment } from '../../src/types/html-fragment';
 import * as PH from '../../src/types/publishing-history';
 import { sanitise } from '../../src/types/sanitised-html-fragment';
 import {
-  arbitraryDate, arbitrarySanitisedHtmlFragment, arbitraryString, arbitraryUri, arbitraryWord,
+  arbitraryDate, arbitrarySanitisedHtmlFragment, arbitraryString, arbitraryUrl, arbitraryWord,
 } from '../helpers';
 import { arbitraryArticleServer } from '../types/article-server.helper';
 import { arbitraryExpressionDoi } from '../types/expression-doi.helper';
@@ -27,7 +26,7 @@ export const createHappyPathThirdPartyAdapters = (): HappyPathThirdPartyAdapters
     abstract: O.some(sanitise(toHtmlFragment(arbitraryString()))),
     server: 'biorxiv' as ArticleServer,
   }),
-  fetchEvaluationHumanReadableOriginalUrl: () => TE.right(new URL(arbitraryUri())),
+  fetchEvaluationHumanReadableOriginalUrl: () => TE.right(arbitraryUrl()),
   fetchRecommendedPapers: () => TE.right([
     arbitraryExpressionDoi(),
     arbitraryExpressionDoi(),
@@ -42,7 +41,7 @@ export const createHappyPathThirdPartyAdapters = (): HappyPathThirdPartyAdapters
       {
         expressionType: 'preprint',
         expressionDoi,
-        publisherHtmlUrl: new URL(arbitraryUri()),
+        publisherHtmlUrl: arbitraryUrl(),
         publishedAt: arbitraryDate(),
         publishedTo: arbitraryWord(),
         server: O.some(arbitraryArticleServer()),

test/helpers.ts

@@ -1,3 +1,4 @@
+import { URL } from 'url';
 import * as A from 'fp-ts/Array';
 import { pipe } from 'fp-ts/function';
 import { HtmlFragment, toHtmlFragment } from '../src/types/html-fragment';
@@ -33,6 +34,8 @@ export const arbitrarySanitisedHtmlFragment = (): SanitisedHtmlFragment => pipe(
 
 export const arbitraryUri = (): string => `http://localhost/${arbitraryWord()}`;
 
+export const arbitraryUrl = (): URL => new URL(arbitraryUri());
+
 export const arbitraryTextLongerThan = (min: number): string => 'xy '.repeat(min);
 
 export const arbitraryDate = (): Date => (

test/read-side/html-pages/paper-activity-page/construct-view-model/feed-summary.test.ts

@@ -1,15 +1,16 @@
-import { URL } from 'url';
 import * as O from 'fp-ts/Option';
 import { pipe } from 'fp-ts/function';
 import { feedSummary } from '../../../../../src/read-side/html-pages/paper-activity-page/construct-view-model/feed-summary';
 import { ExpressionPublishedFeedItem } from '../../../../../src/read-side/html-pages/paper-activity-page/view-model';
-import { arbitraryDate, arbitraryString, arbitraryUri } from '../../../../helpers';
+import {
+  arbitraryDate, arbitraryString, arbitraryUrl,
+} from '../../../../helpers';
 import { arbitraryExpressionDoi } from '../../../../types/expression-doi.helper';
 import * as RFI from '../evaluation-feed-item.helper';
 
 const arbitraryPaperExpressionFeedItem = (publishedAt: Date = arbitraryDate()): ExpressionPublishedFeedItem => ({
   type: 'expression-published' as const,
-  source: new URL(arbitraryUri()),
+  source: arbitraryUrl(),
   publishedAt,
   server: O.some('biorxiv' as const),
   doi: arbitraryExpressionDoi(),

test/read-side/html-pages/paper-activity-page/construct-view-model/to-evaluation-published-feed-item.test.ts

@@ -1,12 +1,11 @@
-import { URL } from 'url';
 import * as O from 'fp-ts/Option';
 import * as T from 'fp-ts/Task';
 import * as TE from 'fp-ts/TaskEither';
 import { pipe } from 'fp-ts/function';
 import { toEvaluationPublishedFeedItem } from '../../../../../src/read-side/html-pages/paper-activity-page/construct-view-model/to-evaluation-published-feed-item';
 import { EvaluationPublishedFeedItem } from '../../../../../src/read-side/html-pages/paper-activity-page/view-model';
 import { TestFramework, createTestFramework } from '../../../../framework';
-import { arbitrarySanitisedHtmlFragment, arbitraryUri } from '../../../../helpers';
+import { arbitrarySanitisedHtmlFragment, arbitraryUrl } from '../../../../helpers';
 import { arbitraryDataError } from '../../../../types/data-error.helper';
 import { arbitraryRecordedEvaluation } from '../../../../types/recorded-evaluation.helper';
 
@@ -20,7 +19,7 @@ describe('to-evaluation-published-feed-item', () => {
   });
 
   describe('when the human readable original URL is available for the evaluation', () => {
-    const humanReadableOriginalUrl = new URL(arbitraryUri());
+    const humanReadableOriginalUrl = arbitraryUrl();
 
     beforeEach(async () => {
       sourceHref = await pipe(

test/read-side/html-pages/paper-activity-page/evaluation-feed-item.helper.ts

@@ -4,13 +4,15 @@ import { pipe } from 'fp-ts/function';
 import { EvaluationPublishedFeedItem } from '../../../../src/read-side/html-pages/paper-activity-page/view-model';
 import { toHtmlFragment } from '../../../../src/types/html-fragment';
 import { sanitise } from '../../../../src/types/sanitised-html-fragment';
-import { arbitraryString, arbitraryUri, arbitraryWord } from '../../../helpers';
+import {
+  arbitraryString, arbitraryUrl, arbitraryWord,
+} from '../../../helpers';
 import { arbitraryEvaluationLocator } from '../../../types/evaluation-locator.helper';
 
 export const arbitrary = (): EvaluationPublishedFeedItem => ({
   type: 'evaluation-published',
   id: arbitraryEvaluationLocator(),
-  sourceHref: O.some(new URL(arbitraryUri())),
+  sourceHref: O.some(arbitraryUrl()),
   publishedAt: new Date(),
   groupHref: arbitraryWord(),
   groupName: 'group 1',

test/third-parties/fetch-evaluation/prelights/fetch-prelights-highlight.test.ts

@@ -1,12 +1,11 @@
-import { URL } from 'url';
 import * as E from 'fp-ts/Either';
 import * as T from 'fp-ts/Task';
 import * as TE from 'fp-ts/TaskEither';
 import { flow, identity, pipe } from 'fp-ts/function';
 import { fetchPrelightsHighlight } from '../../../../src/third-parties/fetch-evaluation/prelights/fetch-prelights-highlight';
 import * as DE from '../../../../src/types/data-error';
 import { dummyLogger } from '../../../dummy-logger';
-import { arbitraryString, arbitraryUri } from '../../../helpers';
+import { arbitraryString, arbitraryUrl } from '../../../helpers';
 import { shouldNotBeCalled } from '../../../should-not-be-called';
 
 const makeDoc = (descriptions: Array<string>) => `
@@ -32,7 +31,7 @@ describe('fetch-prelights-highlight', () => {
     [[ogDescription]],
     [[ogDescription, arbitraryString()]],
   ])('returns the summary of the prelight', async (descriptions) => {
-    const guid = new URL(arbitraryUri());
+    const guid = arbitraryUrl();
     const queryExternalService = () => () => TE.right(makeDoc(descriptions));
     const fullText = await pipe(
       fetchPrelightsHighlight(queryExternalService, dummyLogger)(guid.toString()),
@@ -44,7 +43,7 @@ describe('fetch-prelights-highlight', () => {
 
   describe('cant find fullText', () => {
     it('returns unavailable', async () => {
-      const guid = new URL(arbitraryUri());
+      const guid = arbitraryUrl();
       const queryExternalService = () => () => TE.right(makeDoc([]));
       const fullText = await pipe(
         guid.toString(),

test/third-parties/fetch-evaluation/rapid-reviews/fetch-rapid-review.test.ts

@@ -1,4 +1,3 @@
-import { URL } from 'url';
 import * as E from 'fp-ts/Either';
 import * as T from 'fp-ts/Task';
 import * as TE from 'fp-ts/TaskEither';
@@ -7,7 +6,7 @@ import { fetchRapidReview } from '../../../../src/third-parties/fetch-evaluation
 import * as DE from '../../../../src/types/data-error';
 import { HtmlFragment } from '../../../../src/types/html-fragment';
 import { dummyLogger } from '../../../dummy-logger';
-import { arbitraryString, arbitraryUri } from '../../../helpers';
+import { arbitraryString, arbitraryUri, arbitraryUrl } from '../../../helpers';
 import { shouldNotBeCalled } from '../../../should-not-be-called';
 
 const rapidReviewResponseWith = (metaTags: ReadonlyArray<[string, string]>) => `
@@ -137,7 +136,7 @@ describe('fetch-rapid-review', () => {
 
   describe('queryExternalService fails', () => {
     it('return "unavailable"', async () => {
-      const guid = new URL(arbitraryUri());
+      const guid = arbitraryUrl();
       const queryExternalService = () => () => TE.left(DE.unavailable);
       const fullText = await pipe(
         guid.toString(),

test/types/paper-expression.helper.ts

@@ -1,14 +1,13 @@
-import { URL } from 'url';
 import * as O from 'fp-ts/Option';
 import { arbitraryArticleServer } from './article-server.helper';
 import { arbitraryExpressionDoi } from './expression-doi.helper';
 import { PaperExpression } from '../../src/types/paper-expression';
-import { arbitraryUri, arbitraryDate, arbitraryWord } from '../helpers';
+import { arbitraryDate, arbitraryWord, arbitraryUrl } from '../helpers';
 
 export const arbitraryPaperExpression = (): PaperExpression => ({
   expressionType: 'preprint',
   expressionDoi: arbitraryExpressionDoi(),
-  publisherHtmlUrl: new URL(arbitraryUri()),
+  publisherHtmlUrl: arbitraryUrl(),
   publishedAt: arbitraryDate(),
   publishedTo: arbitraryWord(),
   server: O.some(arbitraryArticleServer()),