refactor(scheduler-utils)!: accept GRAPHQL_URL instead of GATEWAY_URL #551

Author: TillaTheHun0

scheduler-utils/README.md

@@ -96,7 +96,7 @@ The default size of the cache is `100`. If you'd like a smaller or larger cache,
 If you would like to use config other than the defaults, you can
 specify those coonfigurations by providing their values `connect`. You can currently specify
 
-- The `GATEWAY_URL`
+- The `GRAPHQL_URL`
 - The In-Memory `cacheSize`
 - Following Redirects `followRedirects`, a boolean that optimizes scheduler routing if `true`
 

scheduler-utils/src/client/gateway.js

@@ -22,9 +22,9 @@ const findTransactionTags = (err) => pipe(
   defaultTo([])
 )
 
-function gatewayWith ({ fetch, GATEWAY_URL }) {
+function gatewayWith ({ fetch, GRAPHQL_URL }) {
   return async ({ query, variables }) => {
-    return fetch(`${GATEWAY_URL}/graphql`, {
+    return fetch(GRAPHQL_URL, {
       method: 'POST',
       headers: { 'Content-Type': 'application/json' },
       body: JSON.stringify({ query, variables })
@@ -33,9 +33,9 @@ function gatewayWith ({ fetch, GATEWAY_URL }) {
   }
 }
 
-export function loadProcessSchedulerWith ({ fetch, GATEWAY_URL }) {
-  const gateway = gatewayWith({ fetch, GATEWAY_URL })
-  const loadScheduler = loadSchedulerWith({ fetch, GATEWAY_URL })
+export function loadProcessSchedulerWith ({ fetch, GRAPHQL_URL }) {
+  const gateway = gatewayWith({ fetch, GRAPHQL_URL })
+  const loadScheduler = loadSchedulerWith({ fetch, GRAPHQL_URL })
 
   const GET_TRANSACTIONS_QUERY = `
     query GetTransactions ($transactionIds: [ID!]!) {
@@ -55,7 +55,7 @@ export function loadProcessSchedulerWith ({ fetch, GATEWAY_URL }) {
   return async (process) => {
     return gateway({ query: GET_TRANSACTIONS_QUERY, variables: { transactionIds: [process] } })
       .then(path(['data', 'transactions', 'edges', '0', 'node']))
-      .then(findTransactionTags(`Process ${process} was not found on gateway ${GATEWAY_URL}`))
+      .then(findTransactionTags(`Process ${process} was not found on gateway`))
       .then(findTagValue(SCHEDULER_TAG))
       .then((walletAddress) => {
         if (!walletAddress) throw new SchedulerTagNotFoundError('No "Scheduler" tag found on process')
@@ -64,8 +64,8 @@ export function loadProcessSchedulerWith ({ fetch, GATEWAY_URL }) {
   }
 }
 
-export function loadSchedulerWith ({ fetch, GATEWAY_URL }) {
-  const gateway = gatewayWith({ fetch, GATEWAY_URL })
+export function loadSchedulerWith ({ fetch, GRAPHQL_URL }) {
+  const gateway = gatewayWith({ fetch, GRAPHQL_URL })
 
   const GET_SCHEDULER_LOCATION = `
     query GetSchedulerLocation ($owner: String!) {

scheduler-utils/src/client/gateway.test.js

@@ -4,13 +4,13 @@ import * as assert from 'node:assert'
 import { InvalidSchedulerLocationError, SchedulerTagNotFoundError } from '../err.js'
 import { loadProcessSchedulerWith, loadSchedulerWith } from './gateway.js'
 
-const GATEWAY_URL = globalThis.GATEWAY_URL || 'https://arweave.net'
+const GRAPHQL_URL = globalThis.GRAPHQL_URL || 'https://arweave.net/graphql'
 const PROCESS = 'zc24Wpv_i6NNCEdxeKt7dcNrqL5w0hrShtSCcFGGL24'
 const SCHEDULER = 'gnVg6A6S8lfB10P38V7vOia52lEhTX3Uol8kbTGUT8w'
 const TWO_DAYS = 1000 * 60 * 60 * 48
 
 const mockFetch = async (url, options) => {
-  assert.equal(url, `${GATEWAY_URL}/graphql`)
+  assert.equal(url, GRAPHQL_URL)
   const body = JSON.parse(options.body)
   if (body.query.includes('GetTransactions')) return new Response(JSON.stringify(mockFetch.GetTransactions))
   if (body.query.includes('GetSchedulerLocation')) return new Response(JSON.stringify(mockFetch.GetSchedulerLocation))
@@ -62,7 +62,7 @@ describe('gateway', () => {
       }
 
       const loadProcessScheduler = loadProcessSchedulerWith({
-        GATEWAY_URL,
+        GRAPHQL_URL,
         fetch: mockFetch
       })
 
@@ -95,7 +95,7 @@ describe('gateway', () => {
       }
 
       const loadProcessScheduler = loadProcessSchedulerWith({
-        GATEWAY_URL,
+        GRAPHQL_URL,
         fetch: mockFetch
       })
 
@@ -130,7 +130,7 @@ describe('gateway', () => {
       }
 
       const loadScheduler = loadSchedulerWith({
-        GATEWAY_URL,
+        GRAPHQL_URL,
         fetch: mockFetch
       })
 
@@ -167,7 +167,7 @@ describe('gateway', () => {
       }
 
       const loadScheduler = loadSchedulerWith({
-        GATEWAY_URL,
+        GRAPHQL_URL,
         fetch: mockFetch
       })
 
@@ -203,7 +203,7 @@ describe('gateway', () => {
       }
 
       const loadScheduler = loadSchedulerWith({
-        GATEWAY_URL,
+        GRAPHQL_URL,
         fetch: mockFetch
       })
 

scheduler-utils/src/index.browser.js

@@ -2,10 +2,10 @@ import { connect } from './index.common.js'
 
 export * from './index.common.js'
 
-const GATEWAY_URL = globalThis.GATEWAY_URL || undefined
+const GRAPHQL_URL = globalThis.GRAPHQL_URL || undefined
 const CACHE_SIZE = globalThis.SCHEDULER_UTILS_CACHE_SIZE || undefined
 const FOLLOW_REDIRECTS = globalThis.SCHEDULER_UTILS_FOLLOW_REDIRECTS === 'true' || undefined
 
-const { locate, validate, raw } = connect({ GATEWAY_URL, cacheSize: CACHE_SIZE, followRedirects: FOLLOW_REDIRECTS })
+const { locate, validate, raw } = connect({ GRAPHQL_URL, cacheSize: CACHE_SIZE, followRedirects: FOLLOW_REDIRECTS })
 
 export { locate, validate, raw }

scheduler-utils/src/index.common.js

@@ -8,17 +8,17 @@ import { validateWith } from './validate.js'
 
 export * from './err.js'
 
-const DEFAULT_GATEWAY_URL = 'https://arweave.net'
+const DEFAULT_GRAPHQL_URL = 'https://arweave.net/graphql'
 
 /**
  * @typedef ConnectParams
  * @property {number} [cacheSize] - the size of the internal LRU cache
  * @property {boolean} [followRedirects] - whether to follow redirects and cache that url instead
- * @property {string} [GATEWAY_URL] - the url of the gateway to be used
+ * @property {string} [GRAPHQL_URL] - the url of the gateway to be used
  *
  * Build the apis using the provided configuration. You can currently specify
  *
- * - a GATEWAY_URL. Defaults to https://arweave.net
+ * - a GRAPHQL_URL. Defaults to https://arweave.net/graphql
  * - a cache size for the internal LRU cache. Defaults to 100
  * - whether or not to follow redirects when locating a scheduler. Defaults to false
  *
@@ -28,10 +28,10 @@ const DEFAULT_GATEWAY_URL = 'https://arweave.net'
  *
  * @param {ConnectParams} [params]
  */
-export function connect ({ cacheSize = 100, GATEWAY_URL = DEFAULT_GATEWAY_URL, followRedirects = false } = {}) {
+export function connect ({ cacheSize = 100, GRAPHQL_URL = DEFAULT_GRAPHQL_URL, followRedirects = false } = {}) {
   const _cache = InMemoryClient.createLruCache({ size: cacheSize })
 
-  const loadScheduler = GatewayClient.loadSchedulerWith({ fetch, GATEWAY_URL })
+  const loadScheduler = GatewayClient.loadSchedulerWith({ fetch, GRAPHQL_URL })
   const cache = {
     getByProcess: InMemoryClient.getByProcessWith({ cache: _cache }),
     getByOwner: InMemoryClient.getByOwnerWith({ cache: _cache }),
@@ -42,7 +42,7 @@ export function connect ({ cacheSize = 100, GATEWAY_URL = DEFAULT_GATEWAY_URL, f
    * Locate the scheduler for the given process.
    */
   const locate = locateWith({
-    loadProcessScheduler: GatewayClient.loadProcessSchedulerWith({ fetch, GATEWAY_URL }),
+    loadProcessScheduler: GatewayClient.loadProcessSchedulerWith({ fetch, GRAPHQL_URL }),
     loadScheduler,
     cache,
     followRedirects,

scheduler-utils/src/index.js

@@ -2,10 +2,10 @@ import { connect } from './index.common.js'
 
 export * from './index.common.js'
 
-const GATEWAY_URL = process.env.GATEWAY_URL || undefined
+const GRAPHQL_URL = process.env.GRAPHQL_URL || undefined
 const CACHE_SIZE = process.env.SCHEDULER_UTILS_CACHE_SIZE || undefined
 const FOLLOW_REDIRECTS = process.env.SCHEDULER_UTILS_FOLLOW_REDIRECTS === 'true' || undefined
 
-const { locate, validate, raw } = connect({ GATEWAY_URL, cacheSize: CACHE_SIZE, followRedirects: FOLLOW_REDIRECTS })
+const { locate, validate, raw } = connect({ GRAPHQL_URL, cacheSize: CACHE_SIZE, followRedirects: FOLLOW_REDIRECTS })
 
 export { locate, validate, raw }