Make default mwWikiPath as empty string

openzim · Nov 9, 2023 · c2f2b87 · c2f2b87
1 parent a3c98d0
commit c2f2b87
Show file tree

Hide file tree

Showing 22 changed files with 10 additions and 43 deletions.
diff --git a/src/MediaWiki.ts b/src/MediaWiki.ts
@@ -96,8 +96,7 @@ class MediaWiki {
   }
 
   set wikiPath(value: string) {
-    // Empty string is a valid parameter for the wikiPath
-    if (value !== null && typeof value !== 'undefined') {
+    if (value) {
       this.#wikiPath = value
       this.initApiURLDirector()
     }
@@ -135,7 +134,7 @@ class MediaWiki {
 
     this.#actionApiPath = 'w/api.php'
     this.#restApiPath = 'api/rest_v1'
-    this.#wikiPath = 'wiki/'
+    this.#wikiPath = ''
     this.#modulePathOpt = 'w/load.php'
 
     this.namespaces = {}

diff --git a/src/parameterList.ts b/src/parameterList.ts
@@ -16,7 +16,7 @@ export const parameterDescriptions = {
   format:
     'Specify a flavour for the scraping. If missing, scrape all article contents. Each --format argument will cause a new local file to be created but options can be combined. Supported options are:\n * novid: no video & audio content\n * nopic: no pictures (implies "novid")\n * nopdf: no PDF files\n * nodet: only the first/head paragraph (implies "novid")\nFormat names can also be aliased using a ":"\nExample: "... --format=nopic:mini --format=novid,nopdf"',
   keepEmptyParagraphs: 'Keep all paragraphs, even empty ones.',
-  mwWikiPath: 'Mediawiki wiki base path (per default "/wiki/")',
+  mwWikiPath: 'Mediawiki wiki base path (per default empty string)',
   mwActionApiPath: 'Mediawiki API path (per default "/w/api.php")',
   mwRestApiPath: 'Mediawiki Rest API path (per default "/api/rest_v1")',
   mwModulePath: 'Mediawiki module load path (per default "/w/load.php")',

diff --git a/src/sanitize-argument.ts b/src/sanitize-argument.ts
@@ -122,7 +122,8 @@ export async function sanitize_all(argv: any) {
 export function sanitizeWikiPath(mwWikiPath = '') {
   mwWikiPath = sanitizeApiPathParam(mwWikiPath)
 
-  if (mwWikiPath?.endsWith('/')) {
+  // Make sure wikiPath always has forward slash at the end for the correct URL building
+  if (!mwWikiPath?.endsWith('/')) {
     mwWikiPath += '/'
   }
 
@@ -134,6 +135,7 @@ export function sanitizeApiPathParam(apiPathParam: string) {
     return
   }
 
+  // No api params should start from forward slash
   if (apiPathParam.startsWith('/')) {
     apiPathParam = apiPathParam.slice(1)
   }

diff --git a/test/e2e/apiPathParamsSanitizing.e2e.test.ts b/test/e2e/apiPathParamsSanitizing.e2e.test.ts
@@ -3,7 +3,7 @@ import { zimcheck } from '../util.js'
 import 'dotenv/config.js'
 import { jest } from '@jest/globals'
 import rimraf from 'rimraf'
-import { sanitizeApiPathParam, sanitizeWikiPath } from '../../src/sanitize-argument.js'
+import { sanitizeApiPathParam } from '../../src/sanitize-argument.js'
 
 jest.setTimeout(60000)
 
@@ -14,7 +14,6 @@ const parameters = {
   mwActionApiPath: sanitizeApiPathParam('/w/api.php'),
   mwRestApiPath: sanitizeApiPathParam('/api/rest_v1'),
   mwModulePath: sanitizeApiPathParam('/w/load.php'),
-  mwWikiPath: sanitizeWikiPath('/'),
 }
 
 await testAllRenders(parameters, async (outFiles) => {
@@ -27,7 +26,7 @@ await testAllRenders(parameters, async (outFiles) => {
       expect(outFiles[0].mwMetaData.restApiPath).toBe('api/rest_v1')
     })
 
-    test('Mediawiki wikiPath option', () => {
+    test('Mediawiki default empty wikiPath option', () => {
       expect(outFiles[0].mwMetaData.wikiPath).toBe('')
     })
 

diff --git a/test/e2e/articleLists.test.ts b/test/e2e/articleLists.test.ts
@@ -16,8 +16,6 @@ const parameters = {
   articleListToIgnore,
   redis: process.env.REDIS,
   format: ['nopic'],
-  mwActionApiPath: 'w/api.php',
-  mwWikiPath: '/',
 }
 
 await testAllRenders(parameters, async (outFiles) => {

diff --git a/test/e2e/bm.e2e.test.ts b/test/e2e/bm.e2e.test.ts
@@ -12,8 +12,6 @@ const parameters = {
   adminEmail: '[email protected]',
   redis: process.env.REDIS,
   format: ['nopic'],
-  mwActionApiPath: 'w/api.php',
-  mwWikiPath: '/',
 }
 
 await testAllRenders(parameters, async (outFiles) => {

diff --git a/test/e2e/downloadImage.e2e.test.ts b/test/e2e/downloadImage.e2e.test.ts
@@ -16,8 +16,6 @@ const parameters = {
   articleList: 'Paris',
   format: ['nodet'],
   optimisationCacheUrl: process.env.S3_URL,
-  mwActionApiPath: 'w/api.php',
-  mwWikiPath: '/',
 }
 
 await testAllRenders(parameters, async (outFiles) => {

diff --git a/test/e2e/en.e2e.test.ts b/test/e2e/en.e2e.test.ts
@@ -23,8 +23,6 @@ const parameters = {
   mwUrl: 'https://en.wikipedia.org',
   articleList: 'BMW',
   adminEmail: '[email protected]',
-  mwActionApiPath: 'w/api.php',
-  mwWikiPath: '/',
 }
 
 await testAllRenders(parameters, async (outFiles) => {

diff --git a/test/e2e/en10.e2e.test.ts b/test/e2e/en10.e2e.test.ts
@@ -12,8 +12,6 @@ const parameters = {
   redis: process.env.REDIS,
   // format: ['nopic', 'novid', 'nopdf', 'nodet'],
   format: ['nopic', 'nopdf'],
-  mwActionApiPath: 'w/api.php',
-  mwWikiPath: '/',
 }
 
 await testAllRenders(parameters, async (outFiles) => {

diff --git a/test/e2e/extra.e2e.test.ts b/test/e2e/extra.e2e.test.ts
@@ -37,10 +37,6 @@ describe('Extra', () => {
         redis: process.env.REDIS,
         format: ['nopic'],
         forceRender: 'WikimediaDesktop',
-        mwActionApiPath: 'w/api.php',
-        mwWikiPath: '/',
-        mwRestApiPath: 'api/rest_v1',
-        mwModulePath: 'w/load.php',
       })
 
       // Created 1 outputs

diff --git a/test/e2e/forceRender.test.ts b/test/e2e/forceRender.test.ts
@@ -18,7 +18,6 @@ describe('forceRender', () => {
     format: ['nopic'],
     articleList: 'France',
     mwActionApiPath: 'w/api.php',
-    mwWikiPath: '/',
   }
 
   beforeAll(async () => {

diff --git a/test/e2e/formatParams.test.ts b/test/e2e/formatParams.test.ts
@@ -12,8 +12,6 @@ const parameters = {
   mwUrl: 'https://en.wikipedia.org',
   adminEmail: '[email protected]',
   redis: process.env.REDIS,
-  mwActionApiPath: 'w/api.php',
-  mwWikiPath: '/',
 }
 
 await testAllRenders({ ...parameters, format: 'nopic', articleList: 'BMW' }, async (outFiles) => {

diff --git a/test/e2e/multimediaContent.test.ts b/test/e2e/multimediaContent.test.ts
@@ -14,8 +14,6 @@ const parameters = {
   redis: process.env.REDIS,
   customZimDescription: 'Example of the description',
   forceRender: 'WikimediaDesktop',
-  mwActionApiPath: 'w/api.php',
-  mwWikiPath: '/',
 }
 
 await testAllRenders(

diff --git a/test/e2e/treatMedia.e2e.test.ts b/test/e2e/treatMedia.e2e.test.ts
@@ -12,8 +12,6 @@ const parameters = {
   adminEmail: '[email protected]',
   articleList: 'Read_my_lips:_no_new_taxes',
   redis: process.env.REDIS,
-  mwActionApiPath: 'w/api.php',
-  mwWikiPath: '/',
 }
 
 await testAllRenders(parameters, async (outFiles) => {

diff --git a/test/e2e/vikidia.e2e.test.ts b/test/e2e/vikidia.e2e.test.ts
@@ -13,8 +13,6 @@ const parameters = {
   redis: process.env.REDIS,
   articleList: 'Alaska',
   customZimDescription: 'Alaska article',
-  mwActionApiPath: 'w/api.php',
-  mwWikiPath: '/',
 }
 
 await testAllRenders(

diff --git a/test/e2e/wikisource.e2e.test.ts b/test/e2e/wikisource.e2e.test.ts
@@ -12,8 +12,6 @@ const parameters = {
   redis: process.env.REDIS,
   format: ['nopic'],
   noLocalParserFallback: true,
-  mwActionApiPath: 'w/api.php',
-  mwWikiPath: '/',
 }
 
 await testAllRenders(

diff --git a/test/e2e/zimMetadata.e2e.test.ts b/test/e2e/zimMetadata.e2e.test.ts
@@ -17,8 +17,6 @@ const parameters = {
   customZimLongDescription: 'Example of the long description',
   customZimTitle: 'Example of the title',
   publisher: 'Example of the publisher',
-  mwActionApiPath: 'w/api.php',
-  mwWikiPath: '/',
 }
 
 await testAllRenders(parameters, async (outFiles) => {

diff --git a/test/unit/downloader.test.ts b/test/unit/downloader.test.ts
@@ -29,7 +29,6 @@ describe('Downloader class', () => {
 
   beforeAll(async () => {
     MediaWiki.base = 'https://en.wikipedia.org'
-    MediaWiki.wikiPath = '/'
     MediaWiki.getCategories = true
 
     downloader = new Downloader({ uaString: `${config.userAgent} ([email protected])`, speed: 1, reqTimeout: 1000 * 60, webp: true, optimisationCacheUrl: '' })

diff --git a/test/unit/mwApi.test.ts b/test/unit/mwApi.test.ts
@@ -32,7 +32,6 @@ describe('mwApi', () => {
     await RedisStore.articleDetailXId.flush()
 
     MediaWiki.base = 'https://en.wikipedia.org'
-    MediaWiki.wikiPath = '/'
     MediaWiki.getCategories = true
     downloader = new Downloader({ uaString: `${config.userAgent} ([email protected])`, speed: 1, reqTimeout: 1000 * 60, webp: false, optimisationCacheUrl: '' })
 
@@ -103,7 +102,6 @@ describe('mwApi', () => {
   })
 
   test('extracting title from href', () => {
-    MediaWiki.wikiPath = '/wiki/'
     const titleWithWiki = MediaWiki.extractPageTitleFromHref('/wiki/Hades')
     // Title with hrefs contaning /wiki
     expect(titleWithWiki).toEqual('Hades')
@@ -133,7 +131,6 @@ describe('Test blacklisted NSs', () => {
     await RedisStore.articleDetailXId.flush()
 
     MediaWiki.base = 'https://id.wikipedia.org'
-    MediaWiki.wikiPath = '/'
     MediaWiki.getCategories = true
 
     downloader = new Downloader({ uaString: `${config.userAgent} ([email protected])`, speed: 1, reqTimeout: 1000 * 60, webp: false, optimisationCacheUrl: '' })

diff --git a/test/unit/treatments/media.treatment.test.ts b/test/unit/treatments/media.treatment.test.ts
@@ -29,7 +29,7 @@ describe('MediaTreatment', () => {
 
   describe('treatSubtitle', () => {
     test('treat one subtitle', async () => {
-      const { dump } = await setupScrapeClasses({ format: '', mwWikiPath: '/' })
+      const { dump } = await setupScrapeClasses({ format: '' })
 
       // Wikicode is taken from article "Mechanical energy" which has a video with subtitle
       const wikicode =

diff --git a/test/unit/webpAndRedirection.test.ts b/test/unit/webpAndRedirection.test.ts
@@ -35,8 +35,6 @@ Real-time computer graphics`
     outputDirectory: testId,
     redis: process.env.REDIS,
     webp: true,
-    mwActionApiPath: 'w/api.php',
-    mwWikiPath: '/',
   })
 
   const zimFile = new ZimReader(outFiles[0].outFile)

diff --git a/test/util.ts b/test/util.ts
@@ -30,7 +30,7 @@ export function makeLink($doc: Document, href: string, rel: string, title: strin
   return $link
 }
 
-export async function setupScrapeClasses({ mwUrl = 'https://en.wikipedia.org', format = '', mwWikiPath = '/wiki' } = {}) {
+export async function setupScrapeClasses({ mwUrl = 'https://en.wikipedia.org', format = '', mwWikiPath = '' } = {}) {
   MediaWiki.base = mwUrl
   MediaWiki.wikiPath = mwWikiPath