Skip to content

Commit

Permalink
Redact a secret
Browse files Browse the repository at this point in the history 
Note the key is used as part of the URL so it's currently still logged.

Refs #1834
  • Loading branch information
@thewilkybarkid
thewilkybarkid committed Jan 6, 2025
1 parent 16ea422 commit e1fd389
Show file tree
Hide file tree
Showing 15 changed files with 51 additions and 38 deletions.
2 changes: 1 addition & 1 deletion integration/base.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1321,7 +1321,7 @@ const appFixtures: Fixtures<AppFixtures, Record<never, never>, PlaywrightTestArg
useCrowdinInContext: false,
}),
),
Effect.provideService(GhostApi, { key: 'key' }),
Effect.provideService(GhostApi, { key: Redacted.make('key') }),
Effect.provide(Nodemailer.layer(nodemailer)),
Effect.provideService(PublicUrl, new URL(`http://localhost:${port}`)),
Effect.provideService(SessionSecret, Redacted.make('')),
Expand Down
10 changes: 6 additions & 4 deletions src/ghost.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { FetchHttpClient, HttpClient, HttpClientResponse } from '@effect/platform'
import { Context, Data, Effect, flow, identity, Match, Schema } from 'effect'
import { Context, Data, Effect, flow, identity, Match, Redacted, Schema } from 'effect'
import type * as F from 'fetch-fp-ts'
import * as E from 'fp-ts/lib/Either.js'
import * as R from 'fp-ts/lib/Reader.js'
Expand All @@ -11,7 +11,7 @@ import { type Html, rawHtml, sanitizeHtml } from './html.js'

export interface GhostApiEnv {
ghostApi: {
key: string
key: Redacted.Redacted
}
}

Expand Down Expand Up @@ -50,7 +50,7 @@ export const getPage = (
),
)

export class GhostApi extends Context.Tag('GhostApi')<GhostApi, { key: string }>() {}
export class GhostApi extends Context.Tag('GhostApi')<GhostApi, { key: Redacted.Redacted }>() {}

class GhostPageNotFound extends Data.TaggedError('GhostPageNotFound') {}

Expand All @@ -62,7 +62,9 @@ const getPageWithEffect = (id: string) =>
const ghostApi = yield* GhostApi

return yield* pipe(
client.get(new URL(`https://content.prereview.org/ghost/api/content/pages/${id}?key=${ghostApi.key}`)),
client.get(
new URL(`https://content.prereview.org/ghost/api/content/pages/${id}?key=${Redacted.value(ghostApi.key)}`),
),
Effect.filterOrFail(response => response.status === 200, identity),
Effect.andThen(HttpClientResponse.schemaBodyJson(GhostPageSchema)),
Effect.scoped,
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ pipe(
Layer.scopedDiscard(Effect.addFinalizer(() => Effect.logDebug('Database disconnected'))),
),
),
Effect.provideServiceEffect(GhostApi, Config.all({ key: Config.string('GHOST_API_KEY') })),
Effect.provideServiceEffect(GhostApi, Config.all({ key: Config.redacted('GHOST_API_KEY') })),
Effect.provide(Nodemailer.layerConfig(Config.redacted(Config.url('SMTP_URI')))),
Effect.provide(Redis.layerConfig(Config.redacted(Config.url('REDIS_URI')))),
Effect.provideServiceEffect(
Expand Down
6 changes: 3 additions & 3 deletions test/AboutUsPage/AboutUsPage.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { FetchHttpClient } from '@effect/platform'
import { test } from '@fast-check/jest'
import { describe, expect } from '@jest/globals'
import { Effect, pipe, TestContext } from 'effect'
import { Effect, pipe, Redacted, TestContext } from 'effect'
import fetchMock from 'fetch-mock'
import { Status } from 'hyper-ts'
import * as _ from '../../src/AboutUsPage/index.js'
Expand Down Expand Up @@ -40,7 +40,7 @@ describe('AboutUsPage', () => {
})
}).pipe(
Effect.provideService(Locale, locale),
Effect.provideService(GhostApi, { key }),
Effect.provideService(GhostApi, { key: Redacted.make(key) }),
Effect.provide(TestContext.TestContext),
Effect.runPromise,
),
Expand Down Expand Up @@ -74,7 +74,7 @@ describe('AboutUsPage', () => {
expect(fetch.done()).toBeTruthy()
}).pipe(
Effect.provideService(Locale, locale),
Effect.provideService(GhostApi, { key }),
Effect.provideService(GhostApi, { key: Redacted.make(key) }),
Effect.provide(TestContext.TestContext),
Effect.runPromise,
),
Expand Down
5 changes: 3 additions & 2 deletions test/clubs.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { test } from '@fast-check/jest'
import { describe, expect } from '@jest/globals'
import { Redacted } from 'effect'
import fetchMock from 'fetch-mock'
import { format } from 'fp-ts-routing'
import { Status } from 'hyper-ts'
Expand All @@ -17,7 +18,7 @@ describe('clubs', () => {
{ body: { pages: [{ html: '<p>Foo<script>bar</script></p>' }] } },
)

const actual = await _.clubs({ fetch, ghostApi: { key } })()
const actual = await _.clubs({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand All @@ -42,7 +43,7 @@ describe('clubs', () => {
response,
)

const actual = await _.clubs({ fetch, ghostApi: { key } })()
const actual = await _.clubs({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand Down
5 changes: 3 additions & 2 deletions test/code-of-conduct.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { test } from '@fast-check/jest'
import { describe, expect } from '@jest/globals'
import { Redacted } from 'effect'
import fetchMock from 'fetch-mock'
import { format } from 'fp-ts-routing'
import { Status } from 'hyper-ts'
Expand All @@ -17,7 +18,7 @@ describe('codeOfConduct', () => {
{ body: { pages: [{ html: '<p>Foo<script>bar</script></p>' }] } },
)

const actual = await _.codeOfConduct({ fetch, ghostApi: { key } })()
const actual = await _.codeOfConduct({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand All @@ -42,7 +43,7 @@ describe('codeOfConduct', () => {
response,
)

const actual = await _.codeOfConduct({ fetch, ghostApi: { key } })()
const actual = await _.codeOfConduct({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand Down
5 changes: 3 additions & 2 deletions test/edia-statement.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { test } from '@fast-check/jest'
import { describe, expect } from '@jest/globals'
import { Redacted } from 'effect'
import fetchMock from 'fetch-mock'
import { format } from 'fp-ts-routing'
import { Status } from 'hyper-ts'
Expand All @@ -17,7 +18,7 @@ describe('ediaStatement', () => {
{ body: { pages: [{ html: '<p>Foo<script>bar</script></p>' }] } },
)

const actual = await _.ediaStatement({ fetch, ghostApi: { key } })()
const actual = await _.ediaStatement({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand All @@ -42,7 +43,7 @@ describe('ediaStatement', () => {
response,
)

const actual = await _.ediaStatement({ fetch, ghostApi: { key } })()
const actual = await _.ediaStatement({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand Down
5 changes: 3 additions & 2 deletions test/funding.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { test } from '@fast-check/jest'
import { describe, expect } from '@jest/globals'
import { Redacted } from 'effect'
import fetchMock from 'fetch-mock'
import { format } from 'fp-ts-routing'
import { Status } from 'hyper-ts'
Expand All @@ -17,7 +18,7 @@ describe('funding', () => {
{ body: { pages: [{ html: '<p>Foo<script>bar</script></p>' }] } },
)

const actual = await _.funding({ fetch, ghostApi: { key } })()
const actual = await _.funding({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand All @@ -42,7 +43,7 @@ describe('funding', () => {
response,
)

const actual = await _.funding({ fetch, ghostApi: { key } })()
const actual = await _.funding({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand Down
19 changes: 10 additions & 9 deletions test/ghost.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { test } from '@fast-check/jest'
import { describe, expect } from '@jest/globals'
import { Redacted } from 'effect'
import fetchMock from 'fetch-mock'
import * as E from 'fp-ts/lib/Either.js'
import { Status } from 'hyper-ts'
Expand All @@ -20,7 +21,7 @@ describe('getPage', () => {
{ url: `https://content.prereview.org/ghost/api/content/pages/${id}`, query: { key } },
{ body: { pages: [{ html: html.toString() }] } },
),
ghostApi: { key },
ghostApi: { key: Redacted.make(key) },
})()

expect(actual).toStrictEqual(E.right(html))
Expand All @@ -43,7 +44,7 @@ describe('getPage', () => {
},
},
),
ghostApi: { key },
ghostApi: { key: Redacted.make(key) },
})()

expect(actual).toStrictEqual(
Expand Down Expand Up @@ -72,7 +73,7 @@ describe('getPage', () => {
},
},
),
ghostApi: { key },
ghostApi: { key: Redacted.make(key) },
})()

expect(actual).toStrictEqual(
Expand Down Expand Up @@ -101,7 +102,7 @@ describe('getPage', () => {
},
},
),
ghostApi: { key },
ghostApi: { key: Redacted.make(key) },
})()

expect(actual).toStrictEqual(E.right(rawHtml('<a href="https://donorbox.org/prereview" class="button">Donate</a>')))
Expand All @@ -124,7 +125,7 @@ describe('getPage', () => {
},
},
),
ghostApi: { key },
ghostApi: { key: Redacted.make(key) },
})()

expect(actual).toStrictEqual(E.right(rawHtml('<h2 id="some-heading">Some heading</h2>')))
Expand All @@ -141,7 +142,7 @@ describe('getPage', () => {

const actual = await _.getPage(id)({
fetch,
ghostApi: { key },
ghostApi: { key: Redacted.make(key) },
})()

expect(actual).toStrictEqual(E.left('unavailable'))
Expand All @@ -158,7 +159,7 @@ describe('getPage', () => {

const actual = await _.getPage(id)({
fetch,
ghostApi: { key },
ghostApi: { key: Redacted.make(key) },
})()

expect(actual).toStrictEqual(E.left('not-found'))
Expand All @@ -175,7 +176,7 @@ describe('getPage', () => {

const actual = await _.getPage(id)({
fetch,
ghostApi: { key },
ghostApi: { key: Redacted.make(key) },
})()

expect(actual).toStrictEqual(E.left('unavailable'))
Expand All @@ -189,7 +190,7 @@ describe('getPage', () => {
])('when fetch throws an error', async (id, key, error) => {
const actual = await _.getPage(id)({
fetch: () => Promise.reject(error),
ghostApi: { key },
ghostApi: { key: Redacted.make(key) },
})()

expect(actual).toStrictEqual(E.left('unavailable'))
Expand Down
5 changes: 3 additions & 2 deletions test/how-to-use.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { test } from '@fast-check/jest'
import { describe, expect } from '@jest/globals'
import { Redacted } from 'effect'
import fetchMock from 'fetch-mock'
import { format } from 'fp-ts-routing'
import { Status } from 'hyper-ts'
Expand All @@ -17,7 +18,7 @@ describe('howToUse', () => {
{ body: { pages: [{ html: '<p>Foo<script>bar</script></p>' }] } },
)

const actual = await _.howToUse({ fetch, ghostApi: { key } })()
const actual = await _.howToUse({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand All @@ -42,7 +43,7 @@ describe('howToUse', () => {
response,
)

const actual = await _.howToUse({ fetch, ghostApi: { key } })()
const actual = await _.howToUse({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand Down
5 changes: 3 additions & 2 deletions test/live-reviews.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { test } from '@fast-check/jest'
import { describe, expect } from '@jest/globals'
import { Redacted } from 'effect'
import fetchMock from 'fetch-mock'
import { format } from 'fp-ts-routing'
import { Status } from 'hyper-ts'
Expand All @@ -17,7 +18,7 @@ describe('liveReviews', () => {
{ body: { pages: [{ html: '<p>Foo<script>bar</script></p>' }] } },
)

const actual = await _.liveReviews({ fetch, ghostApi: { key } })()
const actual = await _.liveReviews({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand All @@ -42,7 +43,7 @@ describe('liveReviews', () => {
response,
)

const actual = await _.liveReviews({ fetch, ghostApi: { key } })()
const actual = await _.liveReviews({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand Down
5 changes: 3 additions & 2 deletions test/people.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { test } from '@fast-check/jest'
import { describe, expect } from '@jest/globals'
import { Redacted } from 'effect'
import fetchMock from 'fetch-mock'
import { format } from 'fp-ts-routing'
import { Status } from 'hyper-ts'
Expand All @@ -17,7 +18,7 @@ describe('people', () => {
{ body: { pages: [{ html: '<p>Foo<script>bar</script></p>' }] } },
)

const actual = await _.people({ fetch, ghostApi: { key } })()
const actual = await _.people({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand All @@ -42,7 +43,7 @@ describe('people', () => {
response,
)

const actual = await _.people({ fetch, ghostApi: { key } })()
const actual = await _.people({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand Down
5 changes: 3 additions & 2 deletions test/privacy-policy.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { test } from '@fast-check/jest'
import { describe, expect } from '@jest/globals'
import { Redacted } from 'effect'
import fetchMock from 'fetch-mock'
import { format } from 'fp-ts-routing'
import { Status } from 'hyper-ts'
Expand All @@ -17,7 +18,7 @@ describe('privacyPolicy', () => {
{ body: { pages: [{ html: '<p>Foo<script>bar</script></p>' }] } },
)

const actual = await _.privacyPolicy({ fetch, ghostApi: { key } })()
const actual = await _.privacyPolicy({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand All @@ -42,7 +43,7 @@ describe('privacyPolicy', () => {
response,
)

const actual = await _.privacyPolicy({ fetch, ghostApi: { key } })()
const actual = await _.privacyPolicy({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand Down
5 changes: 3 additions & 2 deletions test/resources.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { test } from '@fast-check/jest'
import { describe, expect } from '@jest/globals'
import { Redacted } from 'effect'
import fetchMock from 'fetch-mock'
import { format } from 'fp-ts-routing'
import { Status } from 'hyper-ts'
Expand All @@ -17,7 +18,7 @@ describe('resources', () => {
{ body: { pages: [{ html: '<p>Foo<script>bar</script></p>' }] } },
)

const actual = await _.resources({ fetch, ghostApi: { key } })()
const actual = await _.resources({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand All @@ -42,7 +43,7 @@ describe('resources', () => {
response,
)

const actual = await _.resources({ fetch, ghostApi: { key } })()
const actual = await _.resources({ fetch, ghostApi: { key: Redacted.make(key) } })()

expect(actual).toStrictEqual({
_tag: 'PageResponse',
Expand Down
Loading

0 comments on commit e1fd389

Please sign in to comment.